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

nautilus_serialization/arrow/instrument/
futures_contract.rs
