Skip to main content

nautilus_serialization/arrow/instrument/
option_contract.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 OptionContract 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, OptionKind},
29    identifiers::{InstrumentId, Symbol},
30    instruments::option_contract::OptionContract,
31    types::{price::Price, quantity::Quantity},
32};
33use rust_decimal::Decimal;
34use ustr::Ustr;
35
36use super::{optional_parsed_value, validate_required_instrument_columns};
37use crate::arrow::{
38    ArrowSchemaProvider, EncodeToRecordBatch, EncodingError, KEY_INSTRUMENT_ID,
39    KEY_PRICE_PRECISION, KEY_SIZE_PRECISION, extract_column, extract_column_by_name,
40    extract_optional_string_column_by_name, json_string_field, metadata_with_type_name,
41    optional_ustr_value, record_batch_with_timestamps, record_batch_with_u64_timestamps,
42    timestamp_data_type,
43};
44
45impl ArrowSchemaProvider for OptionContract {
46    fn get_schema(metadata: Option<HashMap<String, String>>) -> Schema {
47        let fields = vec![
48            Field::new("id", DataType::Utf8, false),
49            Field::new("raw_symbol", DataType::Utf8, false),
50            Field::new("underlying", DataType::Utf8, false),
51            Field::new("asset_class", DataType::Utf8, false),
52            Field::new("exchange", DataType::Utf8, true), // nullable
53            Field::new("option_kind", DataType::Utf8, false),
54            Field::new("strike_price", DataType::Utf8, false),
55            Field::new("currency", DataType::Utf8, false),
56            Field::new("activation_ns", timestamp_data_type(), false),
57            Field::new("expiration_ns", timestamp_data_type(), false),
58            Field::new("price_precision", DataType::UInt8, false),
59            Field::new("size_precision", DataType::UInt8, false),
60            Field::new("price_increment", DataType::Utf8, false),
61            Field::new("size_increment", DataType::Utf8, false),
62            Field::new("multiplier", DataType::Utf8, false),
63            Field::new("lot_size", DataType::Utf8, false),
64            Field::new("max_quantity", DataType::Utf8, true), // nullable
65            Field::new("min_quantity", DataType::Utf8, true), // nullable
66            Field::new("max_price", DataType::Utf8, true),    // nullable
67            Field::new("min_price", DataType::Utf8, true),    // nullable
68            Field::new("margin_init", DataType::Utf8, false),
69            Field::new("margin_maint", DataType::Utf8, false),
70            Field::new("tick_scheme", DataType::Utf8, true),
71            json_string_field("info", true),
72            Field::new("ts_event", timestamp_data_type(), false),
73            Field::new("ts_init", timestamp_data_type(), false),
74            Field::new("underlying_instrument_id", DataType::Utf8, true),
75            Field::new("exercise_style", DataType::Utf8, true),
76            Field::new("settlement_type", DataType::Utf8, true),
77        ];
78
79        Schema::new_with_metadata(fields, metadata_with_type_name("OptionContract", metadata))
80    }
81}
82
83impl EncodeToRecordBatch for OptionContract {
84    fn encode_batch<T>(
85        #[allow(unused)] metadata: &HashMap<String, String>,
86        data: &[T],
87    ) -> Result<RecordBatch, ArrowError>
88    where
89        T: std::borrow::Borrow<Self>,
90    {
91        let mut id_builder = StringBuilder::new();
92        let mut raw_symbol_builder = StringBuilder::new();
93        let mut underlying_builder = StringBuilder::new();
94        let mut asset_class_builder = StringBuilder::new();
95        let mut exchange_builder = StringBuilder::new();
96        let mut option_kind_builder = StringBuilder::new();
97        let mut strike_price_builder = StringBuilder::new();
98        let mut currency_builder = StringBuilder::new();
99        let mut activation_ns_builder = UInt64Array::builder(data.len());
100        let mut expiration_ns_builder = UInt64Array::builder(data.len());
101        let mut price_precision_builder = UInt8Array::builder(data.len());
102        let mut size_precision_builder = UInt8Array::builder(data.len());
103        let mut price_increment_builder = StringBuilder::new();
104        let mut size_increment_builder = StringBuilder::new();
105        let mut multiplier_builder = StringBuilder::new();
106        let mut lot_size_builder = StringBuilder::new();
107        let mut max_quantity_builder = StringBuilder::new();
108        let mut min_quantity_builder = StringBuilder::new();
109        let mut max_price_builder = StringBuilder::new();
110        let mut min_price_builder = StringBuilder::new();
111        let mut margin_init_builder = StringBuilder::new();
112        let mut margin_maint_builder = StringBuilder::new();
113        let mut tick_scheme_builder = StringBuilder::new();
114        let mut info_builder = StringBuilder::new();
115        let mut ts_event_builder = UInt64Array::builder(data.len());
116        let mut ts_init_builder = UInt64Array::builder(data.len());
117        let mut underlying_instrument_id_builder = StringBuilder::new();
118        let mut exercise_style_builder = StringBuilder::new();
119        let mut settlement_type_builder = StringBuilder::new();
120
121        for oc in data.iter().map(Borrow::borrow) {
122            id_builder.append_value(oc.id.to_string());
123            raw_symbol_builder.append_value(oc.raw_symbol);
124            underlying_builder.append_value(oc.underlying);
125            asset_class_builder.append_value(oc.asset_class);
126
127            if let Some(exchange) = oc.exchange {
128                exchange_builder.append_value(exchange);
129            } else {
130                exchange_builder.append_null();
131            }
132
133            option_kind_builder.append_value(oc.option_kind);
134            strike_price_builder.append_value(oc.strike_price.to_string());
135            currency_builder.append_value(oc.currency.to_string());
136            activation_ns_builder.append_value(oc.activation_ns.as_u64());
137            expiration_ns_builder.append_value(oc.expiration_ns.as_u64());
138            price_precision_builder.append_value(oc.price_precision);
139            size_precision_builder.append_value(oc.size_precision);
140            price_increment_builder.append_value(oc.price_increment.to_string());
141            size_increment_builder.append_value(oc.size_increment.to_string());
142            multiplier_builder.append_value(oc.multiplier.to_string());
143            lot_size_builder.append_value(oc.lot_size.to_string());
144
145            if let Some(max_quantity) = oc.max_quantity {
146                max_quantity_builder.append_value(max_quantity.to_string());
147            } else {
148                max_quantity_builder.append_null();
149            }
150
151            if let Some(min_quantity) = oc.min_quantity {
152                min_quantity_builder.append_value(min_quantity.to_string());
153            } else {
154                min_quantity_builder.append_null();
155            }
156
157            if let Some(max_price) = oc.max_price {
158                max_price_builder.append_value(max_price.to_string());
159            } else {
160                max_price_builder.append_null();
161            }
162
163            if let Some(min_price) = oc.min_price {
164                min_price_builder.append_value(min_price.to_string());
165            } else {
166                min_price_builder.append_null();
167            }
168
169            margin_init_builder.append_value(oc.margin_init.to_string());
170            margin_maint_builder.append_value(oc.margin_maint.to_string());
171
172            if let Some(tick_scheme) = oc.tick_scheme {
173                tick_scheme_builder.append_value(tick_scheme);
174            } else {
175                tick_scheme_builder.append_null();
176            }
177
178            if let Some(ref info) = oc.info {
179                match serde_json::to_string(info) {
180                    Ok(json) => {
181                        info_builder.append_value(json);
182                    }
183                    Err(e) => {
184                        return Err(ArrowError::InvalidArgumentError(format!(
185                            "Failed to serialize info dict to JSON: {e}"
186                        )));
187                    }
188                }
189            } else {
190                info_builder.append_null();
191            }
192
193            ts_event_builder.append_value(oc.ts_event.as_u64());
194            ts_init_builder.append_value(oc.ts_init.as_u64());
195            underlying_instrument_id_builder
196                .append_option(oc.underlying_instrument_id.map(|id| id.to_string()));
197            exercise_style_builder.append_option(oc.exercise_style.map(|style| style.to_string()));
198            settlement_type_builder.append_option(oc.settlement_type.map(|kind| kind.to_string()));
199        }
200
201        record_batch_with_timestamps(
202            Self::get_schema(Some(metadata.clone())).into(),
203            vec![
204                Arc::new(id_builder.finish()),
205                Arc::new(raw_symbol_builder.finish()),
206                Arc::new(underlying_builder.finish()),
207                Arc::new(asset_class_builder.finish()),
208                Arc::new(exchange_builder.finish()),
209                Arc::new(option_kind_builder.finish()),
210                Arc::new(strike_price_builder.finish()),
211                Arc::new(currency_builder.finish()),
212                Arc::new(activation_ns_builder.finish()),
213                Arc::new(expiration_ns_builder.finish()),
214                Arc::new(price_precision_builder.finish()),
215                Arc::new(size_precision_builder.finish()),
216                Arc::new(price_increment_builder.finish()),
217                Arc::new(size_increment_builder.finish()),
218                Arc::new(multiplier_builder.finish()),
219                Arc::new(lot_size_builder.finish()),
220                Arc::new(max_quantity_builder.finish()),
221                Arc::new(min_quantity_builder.finish()),
222                Arc::new(max_price_builder.finish()),
223                Arc::new(min_price_builder.finish()),
224                Arc::new(margin_init_builder.finish()),
225                Arc::new(margin_maint_builder.finish()),
226                Arc::new(tick_scheme_builder.finish()),
227                Arc::new(info_builder.finish()),
228                Arc::new(ts_event_builder.finish()),
229                Arc::new(ts_init_builder.finish()),
230                Arc::new(underlying_instrument_id_builder.finish()),
231                Arc::new(exercise_style_builder.finish()),
232                Arc::new(settlement_type_builder.finish()),
233            ],
234        )
235    }
236
237    fn metadata(&self) -> HashMap<String, String> {
238        let mut metadata = HashMap::new();
239        metadata.insert(KEY_INSTRUMENT_ID.to_string(), self.id.to_string());
240        metadata.insert(
241            KEY_PRICE_PRECISION.to_string(),
242            self.price_precision.to_string(),
243        );
244        metadata.insert(
245            KEY_SIZE_PRECISION.to_string(),
246            self.size_precision.to_string(),
247        );
248        metadata
249    }
250}
251
252/// Decodes [`OptionContract`] instruments from a record batch.
253///
254/// Not a [`DecodeFromRecordBatch`] implementation because that trait requires `Into<Data>`.
255///
256/// # Errors
257///
258/// Returns an error if the record batch cannot be decoded.
259///
260/// [`DecodeFromRecordBatch`]: crate::arrow::DecodeFromRecordBatch
261pub fn decode_option_contract_batch(
262    metadata: &HashMap<String, String>,
263    record_batch: &RecordBatch,
264) -> Result<Vec<OptionContract>, EncodingError> {
265    validate_required_instrument_columns::<OptionContract>(metadata, record_batch)?;
266    let record_batch = record_batch_with_u64_timestamps(record_batch)?;
267    let record_batch = &record_batch;
268    let cols = record_batch.columns();
269    let num_rows = record_batch.num_rows();
270
271    let id_values = extract_column::<StringArray>(cols, "id", 0, DataType::Utf8)?;
272    let raw_symbol_values = extract_column::<StringArray>(cols, "raw_symbol", 1, DataType::Utf8)?;
273    let underlying_values = extract_column::<StringArray>(cols, "underlying", 2, DataType::Utf8)?;
274    let asset_class_values = extract_column::<StringArray>(cols, "asset_class", 3, DataType::Utf8)?;
275    let exchange_values = cols
276        .get(4)
277        .ok_or_else(|| EncodingError::MissingColumn("exchange", 4))?;
278    let option_kind_values = extract_column::<StringArray>(cols, "option_kind", 5, DataType::Utf8)?;
279    let strike_price_values =
280        extract_column::<StringArray>(cols, "strike_price", 6, DataType::Utf8)?;
281    let currency_values = extract_column::<StringArray>(cols, "currency", 7, DataType::Utf8)?;
282    let activation_ns_values =
283        extract_column::<UInt64Array>(cols, "activation_ns", 8, DataType::UInt64)?;
284    let expiration_ns_values =
285        extract_column::<UInt64Array>(cols, "expiration_ns", 9, DataType::UInt64)?;
286    let price_precision_values =
287        extract_column::<UInt8Array>(cols, "price_precision", 10, DataType::UInt8)?;
288    let size_precision_values =
289        extract_column::<UInt8Array>(cols, "size_precision", 11, DataType::UInt8)?;
290    let price_increment_values =
291        extract_column::<StringArray>(cols, "price_increment", 12, DataType::Utf8)?;
292    let size_increment_values =
293        extract_column::<StringArray>(cols, "size_increment", 13, DataType::Utf8)?;
294    let multiplier_values = extract_column::<StringArray>(cols, "multiplier", 14, DataType::Utf8)?;
295    let lot_size_values = extract_column::<StringArray>(cols, "lot_size", 15, DataType::Utf8)?;
296    let max_quantity_values = extract_optional_string_column_by_name(record_batch, "max_quantity")?;
297    let min_quantity_values = extract_optional_string_column_by_name(record_batch, "min_quantity")?;
298    let max_price_values = extract_optional_string_column_by_name(record_batch, "max_price")?;
299    let min_price_values = extract_optional_string_column_by_name(record_batch, "min_price")?;
300    let margin_init_values =
301        extract_column::<StringArray>(cols, "margin_init", 20, DataType::Utf8)?;
302    let margin_maint_values =
303        extract_column::<StringArray>(cols, "margin_maint", 21, DataType::Utf8)?;
304    let tick_scheme_values = extract_optional_string_column_by_name(record_batch, "tick_scheme")?;
305    let info_values = extract_column_by_name::<StringArray>(record_batch, "info", DataType::Utf8)?;
306    let ts_event_values =
307        extract_column_by_name::<UInt64Array>(record_batch, "ts_event", DataType::UInt64)?;
308    let ts_init_values =
309        extract_column_by_name::<UInt64Array>(record_batch, "ts_init", DataType::UInt64)?;
310
311    let underlying_instrument_id_values =
312        extract_optional_string_column_by_name(record_batch, "underlying_instrument_id")?;
313    let exercise_style_values =
314        extract_optional_string_column_by_name(record_batch, "exercise_style")?;
315    let settlement_type_values =
316        extract_optional_string_column_by_name(record_batch, "settlement_type")?;
317
318    let mut result = Vec::with_capacity(num_rows);
319
320    for i in 0..num_rows {
321        let id = InstrumentId::from_str(id_values.value(i))
322            .map_err(|e| EncodingError::ParseError("id", format!("row {i}: {e}")))?;
323        let raw_symbol = Symbol::from(raw_symbol_values.value(i));
324        let underlying = Ustr::from(underlying_values.value(i));
325        let asset_class = AssetClass::from_str(asset_class_values.value(i))
326            .map_err(|e| EncodingError::ParseError("asset_class", format!("row {i}: {e}")))?;
327
328        let exchange = if exchange_values.is_null(i) {
329            None
330        } else {
331            let exchange_str = exchange_values
332                .as_any()
333                .downcast_ref::<StringArray>()
334                .ok_or_else(|| {
335                    EncodingError::ParseError("exchange", format!("row {i}: invalid type"))
336                })?
337                .value(i);
338            Some(Ustr::from(exchange_str))
339        };
340
341        let underlying_instrument_id = optional_parsed_value(
342            underlying_instrument_id_values,
343            "underlying_instrument_id",
344            i,
345        )?;
346
347        let exercise_style = optional_parsed_value(exercise_style_values, "exercise_style", i)?;
348
349        let settlement_type = optional_parsed_value(settlement_type_values, "settlement_type", i)?;
350
351        let option_kind = OptionKind::from_str(option_kind_values.value(i))
352            .map_err(|e| EncodingError::ParseError("option_kind", format!("row {i}: {e}")))?;
353        let strike_price = Price::from_str(strike_price_values.value(i))
354            .map_err(|e| EncodingError::ParseError("strike_price", format!("row {i}: {e}")))?;
355        let currency = super::decode_currency(
356            currency_values.value(i),
357            "currency",
358            "option_contract.currency",
359            i,
360        )?;
361        let activation_ns = nautilus_core::UnixNanos::from(activation_ns_values.value(i));
362        let expiration_ns = nautilus_core::UnixNanos::from(expiration_ns_values.value(i));
363        let price_prec = price_precision_values.value(i);
364        let _size_prec = size_precision_values.value(i); // Not used in constructor, set to default
365
366        let price_increment = Price::from_str(price_increment_values.value(i))
367            .map_err(|e| EncodingError::ParseError("price_increment", format!("row {i}: {e}")))?;
368        let _size_increment = Quantity::from_str(size_increment_values.value(i))
369            .map_err(|e| EncodingError::ParseError("size_increment", format!("row {i}: {e}")))?; // Not used in constructor, set to default
370        let multiplier = Quantity::from_str(multiplier_values.value(i))
371            .map_err(|e| EncodingError::ParseError("multiplier", format!("row {i}: {e}")))?;
372        let lot_size = Quantity::from_str(lot_size_values.value(i))
373            .map_err(|e| EncodingError::ParseError("lot_size", format!("row {i}: {e}")))?;
374
375        let margin_init = Decimal::from_str(margin_init_values.value(i))
376            .map_err(|e| EncodingError::ParseError("margin_init", format!("row {i}: {e}")))?;
377        let margin_maint = Decimal::from_str(margin_maint_values.value(i))
378            .map_err(|e| EncodingError::ParseError("margin_maint", format!("row {i}: {e}")))?;
379
380        let info = if info_values.is_null(i) {
381            None
382        } else {
383            let info_json = info_values
384                .as_any()
385                .downcast_ref::<StringArray>()
386                .ok_or_else(|| EncodingError::ParseError("info", format!("row {i}: invalid type")))?
387                .value(i);
388
389            match serde_json::from_str::<Params>(info_json) {
390                Ok(info_dict) => Some(info_dict),
391                Err(e) => {
392                    return Err(EncodingError::ParseError(
393                        "info",
394                        format!("row {i}: failed to deserialize JSON: {e}"),
395                    ));
396                }
397            }
398        };
399
400        let ts_event = nautilus_core::UnixNanos::from(ts_event_values.value(i));
401        let ts_init = nautilus_core::UnixNanos::from(ts_init_values.value(i));
402
403        let tick_scheme = optional_ustr_value(tick_scheme_values, i);
404        let option_contract = OptionContract::builder()
405            .instrument_id(id)
406            .raw_symbol(raw_symbol)
407            .asset_class(asset_class)
408            .maybe_exchange(exchange)
409            .underlying(underlying)
410            .option_kind(option_kind)
411            .maybe_underlying_instrument_id(underlying_instrument_id)
412            .maybe_exercise_style(exercise_style)
413            .maybe_settlement_type(settlement_type)
414            .strike_price(strike_price)
415            .currency(currency)
416            .activation_ns(activation_ns)
417            .expiration_ns(expiration_ns)
418            .price_precision(price_prec)
419            .price_increment(price_increment)
420            .multiplier(multiplier)
421            .lot_size(lot_size)
422            .maybe_max_quantity(super::optional_quantity_value(
423                max_quantity_values,
424                "max_quantity",
425                i,
426            )?)
427            .maybe_min_quantity(super::optional_quantity_value(
428                min_quantity_values,
429                "min_quantity",
430                i,
431            )?)
432            .maybe_max_price(super::optional_price_value(
433                max_price_values,
434                "max_price",
435                i,
436            )?)
437            .maybe_min_price(super::optional_price_value(
438                min_price_values,
439                "min_price",
440                i,
441            )?)
442            .margin_init(margin_init)
443            .margin_maint(margin_maint)
444            .maybe_tick_scheme(tick_scheme)
445            .maybe_info(info)
446            .ts_event(ts_event)
447            .ts_init(ts_init)
448            .build()
449            .map_err(|e| super::instrument_validation_error::<OptionContract>(i, e))?;
450
451        result.push(option_contract);
452    }
453
454    Ok(result)
455}