1use std::{borrow::Borrow, collections::HashMap, str::FromStr, sync::Arc};
19
20use arrow::{
21 array::{
22 Array, BooleanArray, BooleanBuilder, StringArray, StringBuilder, UInt8Array, UInt64Array,
23 },
24 datatypes::{DataType, Field, Schema},
25 error::ArrowError,
26 record_batch::RecordBatch,
27};
28use nautilus_core::Params;
29use nautilus_model::{
30 enums::OptionKind,
31 identifiers::{InstrumentId, Symbol},
32 instruments::crypto_option::CryptoOption,
33 types::{money::Money, price::Price, quantity::Quantity},
34};
35use rust_decimal::Decimal;
36
37use super::{optional_parsed_value, validate_required_instrument_columns};
38use crate::arrow::{
39 ArrowSchemaProvider, EncodeToRecordBatch, EncodingError, KEY_INSTRUMENT_ID,
40 KEY_PRICE_PRECISION, KEY_SIZE_PRECISION, extract_column, extract_column_by_name,
41 extract_optional_string_column_by_name, json_string_field, metadata_with_type_name,
42 optional_ustr_value, record_batch_with_timestamps, record_batch_with_u64_timestamps,
43 timestamp_data_type,
44};
45
46impl ArrowSchemaProvider for CryptoOption {
47 fn get_schema(metadata: Option<HashMap<String, String>>) -> Schema {
48 let fields = vec![
49 Field::new("id", DataType::Utf8, false),
50 Field::new("raw_symbol", DataType::Utf8, false),
51 Field::new("underlying", DataType::Utf8, false),
52 Field::new("quote_currency", DataType::Utf8, false),
53 Field::new("settlement_currency", DataType::Utf8, false),
54 Field::new("is_inverse", DataType::Boolean, false),
55 Field::new("option_kind", DataType::Utf8, false),
56 Field::new("strike_price", DataType::Utf8, false),
57 Field::new("activation_ns", timestamp_data_type(), false),
58 Field::new("expiration_ns", timestamp_data_type(), false),
59 Field::new("price_precision", DataType::UInt8, false),
60 Field::new("size_precision", DataType::UInt8, false),
61 Field::new("price_increment", DataType::Utf8, false),
62 Field::new("size_increment", DataType::Utf8, false),
63 Field::new("multiplier", DataType::Utf8, false),
64 Field::new("lot_size", DataType::Utf8, true),
65 Field::new("max_quantity", DataType::Utf8, true), Field::new("min_quantity", DataType::Utf8, true), Field::new("max_notional", DataType::Utf8, true), Field::new("min_notional", DataType::Utf8, true), Field::new("max_price", DataType::Utf8, true), Field::new("min_price", DataType::Utf8, true), Field::new("margin_init", DataType::Utf8, false),
72 Field::new("margin_maint", DataType::Utf8, false),
73 Field::new("tick_scheme", DataType::Utf8, true),
74 json_string_field("info", true),
75 Field::new("ts_event", timestamp_data_type(), false),
76 Field::new("ts_init", timestamp_data_type(), false),
77 Field::new("underlying_instrument_id", DataType::Utf8, true),
78 Field::new("exercise_style", DataType::Utf8, true),
79 Field::new("settlement_type", DataType::Utf8, true),
80 ];
81
82 Schema::new_with_metadata(fields, metadata_with_type_name("CryptoOption", metadata))
83 }
84}
85
86impl EncodeToRecordBatch for CryptoOption {
87 fn encode_batch<T>(
88 #[allow(unused)] metadata: &HashMap<String, String>,
89 data: &[T],
90 ) -> Result<RecordBatch, ArrowError>
91 where
92 T: std::borrow::Borrow<Self>,
93 {
94 let mut id_builder = StringBuilder::new();
95 let mut raw_symbol_builder = StringBuilder::new();
96 let mut underlying_builder = StringBuilder::new();
97 let mut quote_currency_builder = StringBuilder::new();
98 let mut settlement_currency_builder = StringBuilder::new();
99 let mut is_inverse_builder = BooleanBuilder::new();
100 let mut option_kind_builder = StringBuilder::new();
101 let mut strike_price_builder = StringBuilder::new();
102 let mut activation_ns_builder = UInt64Array::builder(data.len());
103 let mut expiration_ns_builder = UInt64Array::builder(data.len());
104 let mut price_precision_builder = UInt8Array::builder(data.len());
105 let mut size_precision_builder = UInt8Array::builder(data.len());
106 let mut price_increment_builder = StringBuilder::new();
107 let mut size_increment_builder = StringBuilder::new();
108 let mut multiplier_builder = StringBuilder::new();
109 let mut lot_size_builder = StringBuilder::new();
110 let mut max_quantity_builder = StringBuilder::new();
111 let mut min_quantity_builder = StringBuilder::new();
112 let mut max_notional_builder = StringBuilder::new();
113 let mut min_notional_builder = StringBuilder::new();
114 let mut max_price_builder = StringBuilder::new();
115 let mut min_price_builder = StringBuilder::new();
116 let mut margin_init_builder = StringBuilder::new();
117 let mut margin_maint_builder = StringBuilder::new();
118 let mut tick_scheme_builder = StringBuilder::new();
119 let mut info_builder = StringBuilder::new();
120 let mut ts_event_builder = UInt64Array::builder(data.len());
121 let mut ts_init_builder = UInt64Array::builder(data.len());
122 let mut underlying_instrument_id_builder = StringBuilder::new();
123 let mut exercise_style_builder = StringBuilder::new();
124 let mut settlement_type_builder = StringBuilder::new();
125
126 for co in data.iter().map(Borrow::borrow) {
127 id_builder.append_value(co.id.to_string());
128 raw_symbol_builder.append_value(co.raw_symbol);
129 underlying_builder.append_value(co.underlying.to_string());
130 quote_currency_builder.append_value(co.quote_currency.to_string());
131 settlement_currency_builder.append_value(co.settlement_currency.to_string());
132 is_inverse_builder.append_value(co.is_inverse);
133 option_kind_builder.append_value(co.option_kind);
134 strike_price_builder.append_value(co.strike_price.to_string());
135 activation_ns_builder.append_value(co.activation_ns.as_u64());
136 expiration_ns_builder.append_value(co.expiration_ns.as_u64());
137 price_precision_builder.append_value(co.price_precision);
138 size_precision_builder.append_value(co.size_precision);
139 price_increment_builder.append_value(co.price_increment.to_string());
140 size_increment_builder.append_value(co.size_increment.to_string());
141 multiplier_builder.append_value(co.multiplier.to_string());
142 lot_size_builder.append_value(co.lot_size.to_string());
143
144 if let Some(max_qty) = co.max_quantity {
145 max_quantity_builder.append_value(max_qty.to_string());
146 } else {
147 max_quantity_builder.append_null();
148 }
149
150 if let Some(min_qty) = co.min_quantity {
151 min_quantity_builder.append_value(min_qty.to_string());
152 } else {
153 min_quantity_builder.append_null();
154 }
155
156 if let Some(max_not) = co.max_notional {
157 max_notional_builder.append_value(max_not.to_string());
158 } else {
159 max_notional_builder.append_null();
160 }
161
162 if let Some(min_not) = co.min_notional {
163 min_notional_builder.append_value(min_not.to_string());
164 } else {
165 min_notional_builder.append_null();
166 }
167
168 if let Some(max_p) = co.max_price {
169 max_price_builder.append_value(max_p.to_string());
170 } else {
171 max_price_builder.append_null();
172 }
173
174 if let Some(min_p) = co.min_price {
175 min_price_builder.append_value(min_p.to_string());
176 } else {
177 min_price_builder.append_null();
178 }
179
180 margin_init_builder.append_value(co.margin_init.to_string());
181 margin_maint_builder.append_value(co.margin_maint.to_string());
182
183 if let Some(tick_scheme) = co.tick_scheme {
184 tick_scheme_builder.append_value(tick_scheme);
185 } else {
186 tick_scheme_builder.append_null();
187 }
188
189 if let Some(ref info) = co.info {
190 match serde_json::to_string(info) {
191 Ok(json) => {
192 info_builder.append_value(json);
193 }
194 Err(e) => {
195 return Err(ArrowError::InvalidArgumentError(format!(
196 "Failed to serialize info dict to JSON: {e}"
197 )));
198 }
199 }
200 } else {
201 info_builder.append_null();
202 }
203
204 ts_event_builder.append_value(co.ts_event.as_u64());
205 ts_init_builder.append_value(co.ts_init.as_u64());
206 underlying_instrument_id_builder
207 .append_option(co.underlying_instrument_id.map(|id| id.to_string()));
208 exercise_style_builder.append_option(co.exercise_style.map(|style| style.to_string()));
209 settlement_type_builder.append_option(co.settlement_type.map(|kind| kind.to_string()));
210 }
211
212 record_batch_with_timestamps(
213 Self::get_schema(Some(metadata.clone())).into(),
214 vec![
215 Arc::new(id_builder.finish()),
216 Arc::new(raw_symbol_builder.finish()),
217 Arc::new(underlying_builder.finish()),
218 Arc::new(quote_currency_builder.finish()),
219 Arc::new(settlement_currency_builder.finish()),
220 Arc::new(is_inverse_builder.finish()),
221 Arc::new(option_kind_builder.finish()),
222 Arc::new(strike_price_builder.finish()),
223 Arc::new(activation_ns_builder.finish()),
224 Arc::new(expiration_ns_builder.finish()),
225 Arc::new(price_precision_builder.finish()),
226 Arc::new(size_precision_builder.finish()),
227 Arc::new(price_increment_builder.finish()),
228 Arc::new(size_increment_builder.finish()),
229 Arc::new(multiplier_builder.finish()),
230 Arc::new(lot_size_builder.finish()),
231 Arc::new(max_quantity_builder.finish()),
232 Arc::new(min_quantity_builder.finish()),
233 Arc::new(max_notional_builder.finish()),
234 Arc::new(min_notional_builder.finish()),
235 Arc::new(max_price_builder.finish()),
236 Arc::new(min_price_builder.finish()),
237 Arc::new(margin_init_builder.finish()),
238 Arc::new(margin_maint_builder.finish()),
239 Arc::new(tick_scheme_builder.finish()),
240 Arc::new(info_builder.finish()),
241 Arc::new(ts_event_builder.finish()),
242 Arc::new(ts_init_builder.finish()),
243 Arc::new(underlying_instrument_id_builder.finish()),
244 Arc::new(exercise_style_builder.finish()),
245 Arc::new(settlement_type_builder.finish()),
246 ],
247 )
248 }
249
250 fn metadata(&self) -> HashMap<String, String> {
251 let mut metadata = HashMap::new();
252 metadata.insert(KEY_INSTRUMENT_ID.to_string(), self.id.to_string());
253 metadata.insert(
254 KEY_PRICE_PRECISION.to_string(),
255 self.price_precision.to_string(),
256 );
257 metadata.insert(
258 KEY_SIZE_PRECISION.to_string(),
259 self.size_precision.to_string(),
260 );
261 metadata
262 }
263}
264
265pub fn decode_crypto_option_batch(
275 metadata: &HashMap<String, String>,
276 record_batch: &RecordBatch,
277) -> Result<Vec<CryptoOption>, EncodingError> {
278 validate_required_instrument_columns::<CryptoOption>(metadata, record_batch)?;
279 let record_batch = record_batch_with_u64_timestamps(record_batch)?;
280 let record_batch = &record_batch;
281 let cols = record_batch.columns();
282 let num_rows = record_batch.num_rows();
283
284 let id_values = extract_column::<StringArray>(cols, "id", 0, DataType::Utf8)?;
285 let raw_symbol_values = extract_column::<StringArray>(cols, "raw_symbol", 1, DataType::Utf8)?;
286 let underlying_values = extract_column::<StringArray>(cols, "underlying", 2, DataType::Utf8)?;
287 let quote_currency_values =
288 extract_column::<StringArray>(cols, "quote_currency", 3, DataType::Utf8)?;
289 let settlement_currency_values =
290 extract_column::<StringArray>(cols, "settlement_currency", 4, DataType::Utf8)?;
291 let is_inverse_values =
292 extract_column::<BooleanArray>(cols, "is_inverse", 5, DataType::Boolean)?;
293 let option_kind_values = extract_column::<StringArray>(cols, "option_kind", 6, DataType::Utf8)?;
294 let strike_price_values =
295 extract_column::<StringArray>(cols, "strike_price", 7, DataType::Utf8)?;
296 let activation_ns_values =
297 extract_column::<UInt64Array>(cols, "activation_ns", 8, DataType::UInt64)?;
298 let expiration_ns_values =
299 extract_column::<UInt64Array>(cols, "expiration_ns", 9, DataType::UInt64)?;
300 let price_precision_values =
301 extract_column::<UInt8Array>(cols, "price_precision", 10, DataType::UInt8)?;
302 let size_precision_values =
303 extract_column::<UInt8Array>(cols, "size_precision", 11, DataType::UInt8)?;
304 let price_increment_values =
305 extract_column::<StringArray>(cols, "price_increment", 12, DataType::Utf8)?;
306 let size_increment_values =
307 extract_column::<StringArray>(cols, "size_increment", 13, DataType::Utf8)?;
308 let multiplier_values = extract_column::<StringArray>(cols, "multiplier", 14, DataType::Utf8)?;
309 let lot_size_values = record_batch
310 .schema()
311 .index_of("lot_size")
312 .ok()
313 .map(|index| extract_column::<StringArray>(cols, "lot_size", index, DataType::Utf8))
314 .transpose()?;
315 let lot_size_offset = usize::from(lot_size_values.is_some());
316 let max_quantity_values = cols
317 .get(15 + lot_size_offset)
318 .ok_or_else(|| EncodingError::MissingColumn("max_quantity", 15 + lot_size_offset))?;
319 let min_quantity_values = cols
320 .get(16 + lot_size_offset)
321 .ok_or_else(|| EncodingError::MissingColumn("min_quantity", 16 + lot_size_offset))?;
322 let max_notional_values = cols
323 .get(17 + lot_size_offset)
324 .ok_or_else(|| EncodingError::MissingColumn("max_notional", 17 + lot_size_offset))?;
325 let min_notional_values = cols
326 .get(18 + lot_size_offset)
327 .ok_or_else(|| EncodingError::MissingColumn("min_notional", 18 + lot_size_offset))?;
328 let max_price_values = cols
329 .get(19 + lot_size_offset)
330 .ok_or_else(|| EncodingError::MissingColumn("max_price", 19 + lot_size_offset))?;
331 let min_price_values = cols
332 .get(20 + lot_size_offset)
333 .ok_or_else(|| EncodingError::MissingColumn("min_price", 20 + lot_size_offset))?;
334 let margin_init_values =
335 extract_column::<StringArray>(cols, "margin_init", 21 + lot_size_offset, DataType::Utf8)?;
336 let margin_maint_values =
337 extract_column::<StringArray>(cols, "margin_maint", 22 + lot_size_offset, DataType::Utf8)?;
338 let tick_scheme_values = extract_optional_string_column_by_name(record_batch, "tick_scheme")?;
339 let info_values = extract_column_by_name::<StringArray>(record_batch, "info", DataType::Utf8)?;
340 let ts_event_values =
341 extract_column_by_name::<UInt64Array>(record_batch, "ts_event", DataType::UInt64)?;
342 let ts_init_values =
343 extract_column_by_name::<UInt64Array>(record_batch, "ts_init", DataType::UInt64)?;
344
345 let underlying_instrument_id_values =
346 extract_optional_string_column_by_name(record_batch, "underlying_instrument_id")?;
347 let exercise_style_values =
348 extract_optional_string_column_by_name(record_batch, "exercise_style")?;
349 let settlement_type_values =
350 extract_optional_string_column_by_name(record_batch, "settlement_type")?;
351
352 let mut result = Vec::with_capacity(num_rows);
353
354 for i in 0..num_rows {
355 let id = InstrumentId::from_str(id_values.value(i))
356 .map_err(|e| EncodingError::ParseError("id", format!("row {i}: {e}")))?;
357 let raw_symbol = Symbol::from(raw_symbol_values.value(i));
358 let underlying = super::decode_currency(
359 underlying_values.value(i),
360 "underlying",
361 "crypto_option.underlying",
362 i,
363 )?;
364 let quote_currency = super::decode_currency(
365 quote_currency_values.value(i),
366 "quote_currency",
367 "crypto_option.quote_currency",
368 i,
369 )?;
370 let settlement_currency = super::decode_currency(
371 settlement_currency_values.value(i),
372 "settlement_currency",
373 "crypto_option.settlement_currency",
374 i,
375 )?;
376 let is_inverse = is_inverse_values.value(i);
377 let underlying_instrument_id = optional_parsed_value(
378 underlying_instrument_id_values,
379 "underlying_instrument_id",
380 i,
381 )?;
382
383 let exercise_style = optional_parsed_value(exercise_style_values, "exercise_style", i)?;
384
385 let settlement_type = optional_parsed_value(settlement_type_values, "settlement_type", i)?;
386
387 let option_kind = OptionKind::from_str(option_kind_values.value(i))
388 .map_err(|e| EncodingError::ParseError("option_kind", format!("row {i}: {e}")))?;
389 let strike_price = Price::from_str(strike_price_values.value(i))
390 .map_err(|e| EncodingError::ParseError("strike_price", format!("row {i}: {e}")))?;
391 let activation_ns = nautilus_core::UnixNanos::from(activation_ns_values.value(i));
392 let expiration_ns = nautilus_core::UnixNanos::from(expiration_ns_values.value(i));
393 let price_prec = price_precision_values.value(i);
394 let size_prec = size_precision_values.value(i);
395
396 let price_increment = Price::from_str(price_increment_values.value(i))
397 .map_err(|e| EncodingError::ParseError("price_increment", format!("row {i}: {e}")))?;
398 let size_increment = Quantity::from_str(size_increment_values.value(i))
399 .map_err(|e| EncodingError::ParseError("size_increment", format!("row {i}: {e}")))?;
400 let multiplier = Quantity::from_str(multiplier_values.value(i))
401 .map_err(|e| EncodingError::ParseError("multiplier", format!("row {i}: {e}")))?;
402 let lot_size =
403 if let Some(values) = lot_size_values {
404 if values.is_null(i) {
405 None
406 } else {
407 Some(Quantity::from_str(values.value(i)).map_err(|e| {
408 EncodingError::ParseError("lot_size", format!("row {i}: {e}"))
409 })?)
410 }
411 } else {
412 None
413 };
414
415 let max_quantity =
416 if max_quantity_values.is_null(i) {
417 None
418 } else {
419 let max_qty_str = max_quantity_values
420 .as_any()
421 .downcast_ref::<StringArray>()
422 .ok_or_else(|| {
423 EncodingError::ParseError("max_quantity", format!("row {i}: invalid type"))
424 })?
425 .value(i);
426 Some(Quantity::from_str(max_qty_str).map_err(|e| {
427 EncodingError::ParseError("max_quantity", format!("row {i}: {e}"))
428 })?)
429 };
430
431 let min_quantity =
432 if min_quantity_values.is_null(i) {
433 None
434 } else {
435 let min_qty_str = min_quantity_values
436 .as_any()
437 .downcast_ref::<StringArray>()
438 .ok_or_else(|| {
439 EncodingError::ParseError("min_quantity", format!("row {i}: invalid type"))
440 })?
441 .value(i);
442 Some(Quantity::from_str(min_qty_str).map_err(|e| {
443 EncodingError::ParseError("min_quantity", format!("row {i}: {e}"))
444 })?)
445 };
446
447 let max_notional =
448 if max_notional_values.is_null(i) {
449 None
450 } else {
451 let max_not_str = max_notional_values
452 .as_any()
453 .downcast_ref::<StringArray>()
454 .ok_or_else(|| {
455 EncodingError::ParseError("max_notional", format!("row {i}: invalid type"))
456 })?
457 .value(i);
458
459 Some(Money::from_str_exact(max_not_str).map_err(|e| {
460 EncodingError::ParseError("max_notional", format!("row {i}: {e}"))
461 })?)
462 };
463
464 let min_notional =
465 if min_notional_values.is_null(i) {
466 None
467 } else {
468 let min_not_str = min_notional_values
469 .as_any()
470 .downcast_ref::<StringArray>()
471 .ok_or_else(|| {
472 EncodingError::ParseError("min_notional", format!("row {i}: invalid type"))
473 })?
474 .value(i);
475
476 Some(Money::from_str_exact(min_not_str).map_err(|e| {
477 EncodingError::ParseError("min_notional", format!("row {i}: {e}"))
478 })?)
479 };
480
481 let max_price = if max_price_values.is_null(i) {
482 None
483 } else {
484 let max_p_str = max_price_values
485 .as_any()
486 .downcast_ref::<StringArray>()
487 .ok_or_else(|| {
488 EncodingError::ParseError("max_price", format!("row {i}: invalid type"))
489 })?
490 .value(i);
491 Some(
492 Price::from_str(max_p_str)
493 .map_err(|e| EncodingError::ParseError("max_price", format!("row {i}: {e}")))?,
494 )
495 };
496
497 let min_price = if min_price_values.is_null(i) {
498 None
499 } else {
500 let min_p_str = min_price_values
501 .as_any()
502 .downcast_ref::<StringArray>()
503 .ok_or_else(|| {
504 EncodingError::ParseError("min_price", format!("row {i}: invalid type"))
505 })?
506 .value(i);
507 Some(
508 Price::from_str(min_p_str)
509 .map_err(|e| EncodingError::ParseError("min_price", format!("row {i}: {e}")))?,
510 )
511 };
512
513 let margin_init = Decimal::from_str(margin_init_values.value(i))
514 .map_err(|e| EncodingError::ParseError("margin_init", format!("row {i}: {e}")))?;
515 let margin_maint = Decimal::from_str(margin_maint_values.value(i))
516 .map_err(|e| EncodingError::ParseError("margin_maint", format!("row {i}: {e}")))?;
517
518 let info = if info_values.is_null(i) {
519 None
520 } else {
521 let info_json = info_values
522 .as_any()
523 .downcast_ref::<StringArray>()
524 .ok_or_else(|| EncodingError::ParseError("info", format!("row {i}: invalid type")))?
525 .value(i);
526
527 match serde_json::from_str::<Params>(info_json) {
528 Ok(info_dict) => Some(info_dict),
529 Err(e) => {
530 return Err(EncodingError::ParseError(
531 "info",
532 format!("row {i}: failed to deserialize JSON: {e}"),
533 ));
534 }
535 }
536 };
537
538 let ts_event = nautilus_core::UnixNanos::from(ts_event_values.value(i));
539 let ts_init = nautilus_core::UnixNanos::from(ts_init_values.value(i));
540
541 let tick_scheme = optional_ustr_value(tick_scheme_values, i);
542 let crypto_option = CryptoOption::builder()
543 .instrument_id(id)
544 .raw_symbol(raw_symbol)
545 .underlying(underlying)
546 .quote_currency(quote_currency)
547 .settlement_currency(settlement_currency)
548 .is_inverse(is_inverse)
549 .option_kind(option_kind)
550 .maybe_underlying_instrument_id(underlying_instrument_id)
551 .maybe_exercise_style(exercise_style)
552 .maybe_settlement_type(settlement_type)
553 .strike_price(strike_price)
554 .activation_ns(activation_ns)
555 .expiration_ns(expiration_ns)
556 .price_precision(price_prec)
557 .size_precision(size_prec)
558 .price_increment(price_increment)
559 .size_increment(size_increment)
560 .multiplier(multiplier)
561 .maybe_lot_size(lot_size)
562 .maybe_max_quantity(max_quantity)
563 .maybe_min_quantity(min_quantity)
564 .maybe_max_notional(max_notional)
565 .maybe_min_notional(min_notional)
566 .maybe_max_price(max_price)
567 .maybe_min_price(min_price)
568 .margin_init(margin_init)
569 .margin_maint(margin_maint)
570 .maybe_tick_scheme(tick_scheme)
571 .maybe_info(info)
572 .ts_event(ts_event)
573 .ts_init(ts_init)
574 .build()
575 .map_err(|e| super::instrument_validation_error::<CryptoOption>(i, e))?;
576
577 result.push(crypto_option);
578 }
579
580 Ok(result)
581}