Skip to main content

nautilus_serialization/arrow/instrument/
binary_option.rs

1// -------------------------------------------------------------------------------------------------
2//  Copyright (C) 2015-2026 Nautech Systems Pty Ltd. All rights reserved.
3//  https://nautechsystems.io
4//
5//  Licensed under the GNU Lesser General Public License Version 3.0 (the "License");
6//  You may not use this file except in compliance with the License.
7//  You may obtain a copy of the License at https://www.gnu.org/licenses/lgpl-3.0.en.html
8//
9//  Unless required by applicable law or agreed to in writing, software
10//  distributed under the License is distributed on an "AS IS" BASIS,
11//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12//  See the License for the specific language governing permissions and
13//  limitations under the License.
14// -------------------------------------------------------------------------------------------------
15
16//! Arrow serialization for BinaryOption instruments.
17
18use std::{borrow::Borrow, collections::HashMap, str::FromStr, sync::Arc};
19
20use arrow::{
21    array::{Array, StringArray, StringBuilder, UInt8Array, UInt64Array},
22    datatypes::{DataType, Field, Schema},
23    error::ArrowError,
24    record_batch::RecordBatch,
25};
26use nautilus_core::Params;
27use nautilus_model::{
28    enums::AssetClass,
29    identifiers::{InstrumentId, Symbol},
30    instruments::{
31        binary_option::BinaryOption,
32        tick_scheme::{
33            FixedTickScheme, TickScheme, TickSchemeError, TieredTickScheme, get_tick_scheme,
34            register_tick_scheme,
35        },
36    },
37    types::{money::Money, price::Price, quantity::Quantity},
38};
39use rust_decimal::Decimal;
40use serde::{Deserialize, Serialize};
41use ustr::Ustr;
42
43use super::validate_required_instrument_columns;
44use crate::arrow::{
45    ArrowSchemaProvider, EncodeToRecordBatch, EncodingError, KEY_INSTRUMENT_ID,
46    KEY_PRICE_PRECISION, KEY_SIZE_PRECISION, extract_column, extract_column_by_name,
47    extract_optional_string_column_by_name, json_string_field, metadata_with_type_name,
48    optional_ustr_value, record_batch_with_timestamps, record_batch_with_u64_timestamps,
49    timestamp_data_type,
50};
51
52impl ArrowSchemaProvider for BinaryOption {
53    fn get_schema(metadata: Option<HashMap<String, String>>) -> Schema {
54        let fields = vec![
55            Field::new("id", DataType::Utf8, false),
56            Field::new("raw_symbol", DataType::Utf8, false),
57            Field::new("asset_class", DataType::Utf8, false),
58            Field::new("currency", DataType::Utf8, 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("activation_ns", timestamp_data_type(), false),
64            Field::new("expiration_ns", timestamp_data_type(), false),
65            Field::new("outcome", DataType::Utf8, true), // nullable
66            Field::new("description", DataType::Utf8, true), // nullable
67            Field::new("max_quantity", DataType::Utf8, true), // nullable
68            Field::new("min_quantity", DataType::Utf8, true), // nullable
69            Field::new("max_notional", DataType::Utf8, true), // nullable
70            Field::new("min_notional", DataType::Utf8, true), // nullable
71            Field::new("max_price", DataType::Utf8, true), // nullable
72            Field::new("min_price", DataType::Utf8, true), // nullable
73            Field::new("margin_init", DataType::Utf8, false),
74            Field::new("margin_maint", DataType::Utf8, false),
75            Field::new("tick_scheme", DataType::Utf8, true),
76            json_string_field("info", true),
77            Field::new("ts_event", timestamp_data_type(), false),
78            Field::new("ts_init", timestamp_data_type(), false),
79            Field::new("event_id", DataType::Utf8, true),
80            json_string_field("tick_scheme_definition", true),
81        ];
82
83        Schema::new_with_metadata(fields, metadata_with_type_name("BinaryOption", metadata))
84    }
85}
86
87impl EncodeToRecordBatch for BinaryOption {
88    fn encode_batch<T>(
89        #[allow(unused)] metadata: &HashMap<String, String>,
90        data: &[T],
91    ) -> Result<RecordBatch, ArrowError>
92    where
93        T: std::borrow::Borrow<Self>,
94    {
95        let mut id_builder = StringBuilder::new();
96        let mut raw_symbol_builder = StringBuilder::new();
97        let mut asset_class_builder = StringBuilder::new();
98        let mut currency_builder = StringBuilder::new();
99        let mut price_precision_builder = UInt8Array::builder(data.len());
100        let mut size_precision_builder = UInt8Array::builder(data.len());
101        let mut price_increment_builder = StringBuilder::new();
102        let mut size_increment_builder = StringBuilder::new();
103        let mut activation_ns_builder = UInt64Array::builder(data.len());
104        let mut expiration_ns_builder = UInt64Array::builder(data.len());
105        let mut outcome_builder = StringBuilder::new();
106        let mut event_id_builder = StringBuilder::new();
107        let mut description_builder = StringBuilder::new();
108        let mut max_quantity_builder = StringBuilder::new();
109        let mut min_quantity_builder = StringBuilder::new();
110        let mut max_notional_builder = StringBuilder::new();
111        let mut min_notional_builder = StringBuilder::new();
112        let mut max_price_builder = StringBuilder::new();
113        let mut min_price_builder = StringBuilder::new();
114        let mut margin_init_builder = StringBuilder::new();
115        let mut margin_maint_builder = StringBuilder::new();
116        let mut tick_scheme_builder = StringBuilder::new();
117        let mut info_builder = StringBuilder::new();
118        let mut ts_event_builder = UInt64Array::builder(data.len());
119        let mut ts_init_builder = UInt64Array::builder(data.len());
120        let mut tick_scheme_definition_builder = StringBuilder::new();
121
122        for bo in data.iter().map(Borrow::borrow) {
123            id_builder.append_value(bo.id.to_string());
124            raw_symbol_builder.append_value(bo.raw_symbol);
125            asset_class_builder.append_value(bo.asset_class);
126            currency_builder.append_value(bo.currency.to_string());
127            price_precision_builder.append_value(bo.price_precision);
128            size_precision_builder.append_value(bo.size_precision);
129            price_increment_builder.append_value(bo.price_increment.to_string());
130            size_increment_builder.append_value(bo.size_increment.to_string());
131            activation_ns_builder.append_value(bo.activation_ns.as_u64());
132            expiration_ns_builder.append_value(bo.expiration_ns.as_u64());
133
134            if let Some(outcome) = bo.outcome {
135                outcome_builder.append_value(outcome);
136            } else {
137                outcome_builder.append_null();
138            }
139
140            if let Some(desc) = bo.description {
141                description_builder.append_value(desc);
142            } else {
143                description_builder.append_null();
144            }
145
146            if let Some(max_qty) = bo.max_quantity {
147                max_quantity_builder.append_value(max_qty.to_string());
148            } else {
149                max_quantity_builder.append_null();
150            }
151
152            if let Some(min_qty) = bo.min_quantity {
153                min_quantity_builder.append_value(min_qty.to_string());
154            } else {
155                min_quantity_builder.append_null();
156            }
157
158            if let Some(max_notional) = bo.max_notional {
159                max_notional_builder.append_value(max_notional.to_string());
160            } else {
161                max_notional_builder.append_null();
162            }
163
164            if let Some(min_notional) = bo.min_notional {
165                min_notional_builder.append_value(min_notional.to_string());
166            } else {
167                min_notional_builder.append_null();
168            }
169
170            if let Some(max_price) = bo.max_price {
171                max_price_builder.append_value(max_price.to_string());
172            } else {
173                max_price_builder.append_null();
174            }
175
176            if let Some(min_price) = bo.min_price {
177                min_price_builder.append_value(min_price.to_string());
178            } else {
179                min_price_builder.append_null();
180            }
181
182            margin_init_builder.append_value(bo.margin_init.to_string());
183            margin_maint_builder.append_value(bo.margin_maint.to_string());
184
185            if let Some(tick_scheme) = bo.tick_scheme {
186                tick_scheme_builder.append_value(tick_scheme);
187
188                let scheme = get_tick_scheme(tick_scheme.as_str()).ok_or_else(|| {
189                    ArrowError::InvalidArgumentError(format!("Unknown tick scheme {tick_scheme}"))
190                })?;
191
192                let definition = TickSchemeDefinition::from(scheme);
193                let json = serde_json::to_string(&definition)
194                    .map_err(|e| ArrowError::InvalidArgumentError(e.to_string()))?;
195                tick_scheme_definition_builder.append_value(json);
196            } else {
197                tick_scheme_builder.append_null();
198                tick_scheme_definition_builder.append_null();
199            }
200
201            event_id_builder.append_option(bo.event_id.as_ref().map(Ustr::as_str));
202
203            if let Some(ref info) = bo.info {
204                match serde_json::to_string(info) {
205                    Ok(json) => {
206                        info_builder.append_value(json);
207                    }
208                    Err(e) => {
209                        return Err(ArrowError::InvalidArgumentError(format!(
210                            "Failed to serialize info dict to JSON: {e}"
211                        )));
212                    }
213                }
214            } else {
215                info_builder.append_null();
216            }
217
218            ts_event_builder.append_value(bo.ts_event.as_u64());
219            ts_init_builder.append_value(bo.ts_init.as_u64());
220        }
221
222        record_batch_with_timestamps(
223            Self::get_schema(Some(metadata.clone())).into(),
224            vec![
225                Arc::new(id_builder.finish()),
226                Arc::new(raw_symbol_builder.finish()),
227                Arc::new(asset_class_builder.finish()),
228                Arc::new(currency_builder.finish()),
229                Arc::new(price_precision_builder.finish()),
230                Arc::new(size_precision_builder.finish()),
231                Arc::new(price_increment_builder.finish()),
232                Arc::new(size_increment_builder.finish()),
233                Arc::new(activation_ns_builder.finish()),
234                Arc::new(expiration_ns_builder.finish()),
235                Arc::new(outcome_builder.finish()),
236                Arc::new(description_builder.finish()),
237                Arc::new(max_quantity_builder.finish()),
238                Arc::new(min_quantity_builder.finish()),
239                Arc::new(max_notional_builder.finish()),
240                Arc::new(min_notional_builder.finish()),
241                Arc::new(max_price_builder.finish()),
242                Arc::new(min_price_builder.finish()),
243                Arc::new(margin_init_builder.finish()),
244                Arc::new(margin_maint_builder.finish()),
245                Arc::new(tick_scheme_builder.finish()),
246                Arc::new(info_builder.finish()),
247                Arc::new(ts_event_builder.finish()),
248                Arc::new(ts_init_builder.finish()),
249                Arc::new(event_id_builder.finish()),
250                Arc::new(tick_scheme_definition_builder.finish()),
251            ],
252        )
253    }
254
255    fn metadata(&self) -> HashMap<String, String> {
256        let mut metadata = HashMap::new();
257        metadata.insert(KEY_INSTRUMENT_ID.to_string(), self.id.to_string());
258        metadata.insert(
259            KEY_PRICE_PRECISION.to_string(),
260            self.price_precision.to_string(),
261        );
262        metadata.insert(
263            KEY_SIZE_PRECISION.to_string(),
264            self.size_precision.to_string(),
265        );
266        metadata
267    }
268}
269
270/// Decodes [`BinaryOption`] instruments from a record batch.
271///
272/// Not a [`DecodeFromRecordBatch`] implementation because that trait requires `Into<Data>`.
273///
274/// # Errors
275///
276/// Returns an error if the record batch cannot be decoded.
277///
278/// [`DecodeFromRecordBatch`]: crate::arrow::DecodeFromRecordBatch
279pub fn decode_binary_option_batch(
280    metadata: &HashMap<String, String>,
281    record_batch: &RecordBatch,
282) -> Result<Vec<BinaryOption>, EncodingError> {
283    validate_required_instrument_columns::<BinaryOption>(metadata, record_batch)?;
284    let record_batch = record_batch_with_u64_timestamps(record_batch)?;
285    let record_batch = &record_batch;
286    let event_id_values = extract_optional_string_column_by_name(record_batch, "event_id")?;
287    let tick_scheme_definition_values =
288        extract_optional_string_column_by_name(record_batch, "tick_scheme_definition")?;
289    let cols = record_batch.columns();
290    let num_rows = record_batch.num_rows();
291
292    let id_values = extract_column::<StringArray>(cols, "id", 0, DataType::Utf8)?;
293    let raw_symbol_values = extract_column::<StringArray>(cols, "raw_symbol", 1, DataType::Utf8)?;
294    let asset_class_values = extract_column::<StringArray>(cols, "asset_class", 2, DataType::Utf8)?;
295    let currency_values = extract_column::<StringArray>(cols, "currency", 3, DataType::Utf8)?;
296    let price_precision_values =
297        extract_column::<UInt8Array>(cols, "price_precision", 4, DataType::UInt8)?;
298    let size_precision_values =
299        extract_column::<UInt8Array>(cols, "size_precision", 5, DataType::UInt8)?;
300    let price_increment_values =
301        extract_column::<StringArray>(cols, "price_increment", 6, DataType::Utf8)?;
302    let size_increment_values =
303        extract_column::<StringArray>(cols, "size_increment", 7, DataType::Utf8)?;
304    let activation_ns_values =
305        extract_column::<UInt64Array>(cols, "activation_ns", 8, DataType::UInt64)?;
306    let expiration_ns_values =
307        extract_column::<UInt64Array>(cols, "expiration_ns", 9, DataType::UInt64)?;
308    let outcome_values = cols
309        .get(10)
310        .ok_or_else(|| EncodingError::MissingColumn("outcome", 10))?;
311    let description_values = cols
312        .get(11)
313        .ok_or_else(|| EncodingError::MissingColumn("description", 11))?;
314    let max_quantity_values = cols
315        .get(12)
316        .ok_or_else(|| EncodingError::MissingColumn("max_quantity", 12))?;
317    let min_quantity_values = cols
318        .get(13)
319        .ok_or_else(|| EncodingError::MissingColumn("min_quantity", 13))?;
320    let max_notional_values = extract_optional_string_column_by_name(record_batch, "max_notional")?;
321    let min_notional_values = extract_optional_string_column_by_name(record_batch, "min_notional")?;
322    let max_price_values = extract_optional_string_column_by_name(record_batch, "max_price")?;
323    let min_price_values = extract_optional_string_column_by_name(record_batch, "min_price")?;
324    let margin_init_values =
325        extract_column::<StringArray>(cols, "margin_init", 18, DataType::Utf8)?;
326    let margin_maint_values =
327        extract_column::<StringArray>(cols, "margin_maint", 19, DataType::Utf8)?;
328    let tick_scheme_values = extract_optional_string_column_by_name(record_batch, "tick_scheme")?;
329    let info_values = extract_column_by_name::<StringArray>(record_batch, "info", DataType::Utf8)?;
330    let ts_event_values =
331        extract_column_by_name::<UInt64Array>(record_batch, "ts_event", DataType::UInt64)?;
332    let ts_init_values =
333        extract_column_by_name::<UInt64Array>(record_batch, "ts_init", DataType::UInt64)?;
334
335    let mut result = Vec::with_capacity(num_rows);
336
337    for i in 0..num_rows {
338        let id = InstrumentId::from_str(id_values.value(i))
339            .map_err(|e| EncodingError::ParseError("id", format!("row {i}: {e}")))?;
340        let raw_symbol = Symbol::from(raw_symbol_values.value(i));
341        let asset_class = AssetClass::from_str(asset_class_values.value(i))
342            .map_err(|e| EncodingError::ParseError("asset_class", format!("row {i}: {e}")))?;
343        let currency = super::decode_currency(
344            currency_values.value(i),
345            "currency",
346            "binary_option.currency",
347            i,
348        )?;
349        let price_prec = price_precision_values.value(i);
350        let size_prec = size_precision_values.value(i);
351
352        let price_increment = Price::from_str(price_increment_values.value(i))
353            .map_err(|e| EncodingError::ParseError("price_increment", format!("row {i}: {e}")))?;
354        let size_increment = Quantity::from_str(size_increment_values.value(i))
355            .map_err(|e| EncodingError::ParseError("size_increment", format!("row {i}: {e}")))?;
356
357        let activation_ns = nautilus_core::UnixNanos::from(activation_ns_values.value(i));
358        let expiration_ns = nautilus_core::UnixNanos::from(expiration_ns_values.value(i));
359
360        let margin_init = Decimal::from_str(margin_init_values.value(i))
361            .map_err(|e| EncodingError::ParseError("margin_init", format!("row {i}: {e}")))?;
362        let margin_maint = Decimal::from_str(margin_maint_values.value(i))
363            .map_err(|e| EncodingError::ParseError("margin_maint", format!("row {i}: {e}")))?;
364
365        let max_quantity =
366            if max_quantity_values.is_null(i) {
367                None
368            } else {
369                let max_qty_str = max_quantity_values
370                    .as_any()
371                    .downcast_ref::<StringArray>()
372                    .ok_or_else(|| {
373                        EncodingError::ParseError("max_quantity", format!("row {i}: invalid type"))
374                    })?
375                    .value(i);
376                Some(Quantity::from_str(max_qty_str).map_err(|e| {
377                    EncodingError::ParseError("max_quantity", format!("row {i}: {e}"))
378                })?)
379            };
380
381        let min_quantity =
382            if min_quantity_values.is_null(i) {
383                None
384            } else {
385                let min_qty_str = min_quantity_values
386                    .as_any()
387                    .downcast_ref::<StringArray>()
388                    .ok_or_else(|| {
389                        EncodingError::ParseError("min_quantity", format!("row {i}: invalid type"))
390                    })?
391                    .value(i);
392                Some(Quantity::from_str(min_qty_str).map_err(|e| {
393                    EncodingError::ParseError("min_quantity", format!("row {i}: {e}"))
394                })?)
395            };
396
397        let outcome = if outcome_values.is_null(i) {
398            None
399        } else {
400            let outcome_str = outcome_values
401                .as_any()
402                .downcast_ref::<StringArray>()
403                .ok_or_else(|| {
404                    EncodingError::ParseError("outcome", format!("row {i}: invalid type"))
405                })?
406                .value(i);
407            Some(Ustr::from(outcome_str))
408        };
409
410        let description = if description_values.is_null(i) {
411            None
412        } else {
413            let desc_str = description_values
414                .as_any()
415                .downcast_ref::<StringArray>()
416                .ok_or_else(|| {
417                    EncodingError::ParseError("description", format!("row {i}: invalid type"))
418                })?
419                .value(i);
420            Some(Ustr::from(desc_str))
421        };
422
423        let info = if info_values.is_null(i) {
424            None
425        } else {
426            let info_json = info_values
427                .as_any()
428                .downcast_ref::<StringArray>()
429                .ok_or_else(|| EncodingError::ParseError("info", format!("row {i}: invalid type")))?
430                .value(i);
431
432            match serde_json::from_str::<Params>(info_json) {
433                Ok(info_dict) => Some(info_dict),
434                Err(e) => {
435                    return Err(EncodingError::ParseError(
436                        "info",
437                        format!("row {i}: failed to deserialize JSON: {e}"),
438                    ));
439                }
440            }
441        };
442
443        let ts_event = nautilus_core::UnixNanos::from(ts_event_values.value(i));
444        let ts_init = nautilus_core::UnixNanos::from(ts_init_values.value(i));
445
446        let tick_scheme = optional_ustr_value(tick_scheme_values, i);
447        tick_scheme_definition_values
448            .filter(|column| !column.is_null(i))
449            .map(|column| restore_tick_scheme(tick_scheme, column.value(i)))
450            .transpose()
451            .map_err(|e| {
452                EncodingError::ParseError("tick_scheme_definition", format!("row {i}: {e}"))
453            })?;
454
455        let max_notional = match max_notional_values {
456            Some(column) if !column.is_null(i) => {
457                Some(Money::from_str_exact(column.value(i)).map_err(|e| {
458                    EncodingError::ParseError("max_notional", format!("row {i}: {e}"))
459                })?)
460            }
461            _ => None,
462        };
463
464        let min_notional = match min_notional_values {
465            Some(column) if !column.is_null(i) => {
466                Some(Money::from_str_exact(column.value(i)).map_err(|e| {
467                    EncodingError::ParseError("min_notional", format!("row {i}: {e}"))
468                })?)
469            }
470            _ => None,
471        };
472
473        let binary_option = BinaryOption::builder()
474            .instrument_id(id)
475            .raw_symbol(raw_symbol)
476            .asset_class(asset_class)
477            .currency(currency)
478            .activation_ns(activation_ns)
479            .expiration_ns(expiration_ns)
480            .price_precision(price_prec)
481            .size_precision(size_prec)
482            .price_increment(price_increment)
483            .size_increment(size_increment)
484            .maybe_outcome(outcome)
485            .maybe_description(description)
486            .maybe_max_quantity(max_quantity)
487            .maybe_min_quantity(min_quantity)
488            .maybe_max_notional(max_notional)
489            .maybe_min_notional(min_notional)
490            .maybe_max_price(super::optional_price_value(
491                max_price_values,
492                "max_price",
493                i,
494            )?)
495            .maybe_min_price(super::optional_price_value(
496                min_price_values,
497                "min_price",
498                i,
499            )?)
500            .margin_init(margin_init)
501            .margin_maint(margin_maint)
502            .maybe_tick_scheme(tick_scheme)
503            .maybe_event_id(optional_ustr_value(event_id_values, i))
504            .maybe_info(info)
505            .ts_event(ts_event)
506            .ts_init(ts_init)
507            .build()
508            .map_err(|e| super::instrument_validation_error::<BinaryOption>(i, e))?;
509
510        result.push(binary_option);
511    }
512
513    Ok(result)
514}
515
516#[derive(Serialize, Deserialize)]
517#[serde(tag = "type", rename_all = "snake_case", deny_unknown_fields)]
518enum TickSchemeDefinition {
519    Fixed { tick: Price },
520    Tiered { ticks: Vec<Price>, precision: u8 },
521    Betfair,
522    Crypto,
523}
524
525impl From<TickScheme> for TickSchemeDefinition {
526    fn from(scheme: TickScheme) -> Self {
527        match scheme {
528            TickScheme::Fixed(scheme) => Self::Fixed {
529                tick: scheme.tick(),
530            },
531            TickScheme::Tiered(scheme) => Self::Tiered {
532                ticks: scheme.ticks(),
533                precision: scheme.precision(),
534            },
535            TickScheme::Betfair => Self::Betfair,
536            TickScheme::Crypto => Self::Crypto,
537        }
538    }
539}
540
541impl TryFrom<TickSchemeDefinition> for TickScheme {
542    type Error = TickSchemeError;
543
544    fn try_from(definition: TickSchemeDefinition) -> Result<Self, Self::Error> {
545        match definition {
546            TickSchemeDefinition::Fixed { tick } => FixedTickScheme::new(tick).map(Self::Fixed),
547            TickSchemeDefinition::Tiered { ticks, precision } => {
548                TieredTickScheme::from_ticks(ticks, precision).map(Self::Tiered)
549            }
550            TickSchemeDefinition::Betfair => Ok(Self::Betfair),
551            TickSchemeDefinition::Crypto => Ok(Self::Crypto),
552        }
553    }
554}
555
556fn restore_tick_scheme(name: Option<Ustr>, json: &str) -> anyhow::Result<()> {
557    let name = name.ok_or_else(|| anyhow::anyhow!("definition has no tick scheme name"))?;
558    let definition: TickSchemeDefinition = serde_json::from_str(json)?;
559    let scheme = TickScheme::try_from(definition)?;
560
561    if let Some(existing) = get_tick_scheme(name.as_str()) {
562        anyhow::ensure!(
563            existing == scheme,
564            "conflicting definition for tick scheme {name}"
565        );
566        return Ok(());
567    }
568
569    match register_tick_scheme(name.as_str(), scheme.clone()) {
570        Ok(()) => Ok(()),
571        Err(TickSchemeError::DuplicateName { .. }) => {
572            anyhow::ensure!(
573                get_tick_scheme(name.as_str()).as_ref() == Some(&scheme),
574                "conflicting definition for tick scheme {name}"
575            );
576            Ok(())
577        }
578        Err(e) => Err(e.into()),
579    }
580}