nautilus_model/python/instruments/
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
16use std::{
17    collections::hash_map::DefaultHasher,
18    hash::{Hash, Hasher},
19};
20
21use nautilus_core::{
22    from_pydict,
23    python::{IntoPyObjectNautilusExt, serialization::from_dict_pyo3, to_pyvalue_err},
24};
25use pyo3::{basic::CompareOp, prelude::*, types::PyDict};
26use rust_decimal::Decimal;
27use ustr::Ustr;
28
29use crate::{
30    enums::AssetClass,
31    identifiers::{InstrumentId, Symbol},
32    instruments::FuturesContract,
33    types::{Currency, Price, Quantity},
34};
35
36#[pymethods]
37#[pyo3_stub_gen::derive::gen_stub_pymethods]
38impl FuturesContract {
39    /// Represents a generic deliverable futures contract instrument.
40    #[expect(clippy::too_many_arguments)]
41    #[new]
42    #[pyo3(signature = (instrument_id, raw_symbol, asset_class, underlying, activation_ns, expiration_ns, currency, price_precision, price_increment, multiplier, lot_size, ts_event, ts_init, max_quantity=None, min_quantity=None, max_price=None, min_price=None, margin_init=None, margin_maint=None, maker_fee=None, taker_fee=None, exchange=None, info=None))]
43    fn py_new(
44        instrument_id: InstrumentId,
45        raw_symbol: Symbol,
46        asset_class: AssetClass,
47        underlying: String,
48        activation_ns: u64,
49        expiration_ns: u64,
50        currency: Currency,
51        price_precision: u8,
52        price_increment: Price,
53        multiplier: Quantity,
54        lot_size: Quantity,
55        ts_event: u64,
56        ts_init: u64,
57        max_quantity: Option<Quantity>,
58        min_quantity: Option<Quantity>,
59        max_price: Option<Price>,
60        min_price: Option<Price>,
61        margin_init: Option<Decimal>,
62        margin_maint: Option<Decimal>,
63        maker_fee: Option<Decimal>,
64        taker_fee: Option<Decimal>,
65        exchange: Option<String>,
66        info: Option<Py<PyDict>>,
67    ) -> PyResult<Self> {
68        // Convert Python dict to Params
69        let info_map = if let Some(info_dict) = info {
70            Python::attach(|py| from_pydict(py, info_dict))?
71        } else {
72            None
73        };
74
75        Self::new_checked(
76            instrument_id,
77            raw_symbol,
78            asset_class,
79            exchange.map(|x| Ustr::from(&x)),
80            underlying.into(),
81            activation_ns.into(),
82            expiration_ns.into(),
83            currency,
84            price_precision,
85            price_increment,
86            multiplier,
87            lot_size,
88            max_quantity,
89            min_quantity,
90            max_price,
91            min_price,
92            margin_init,
93            margin_maint,
94            maker_fee,
95            taker_fee,
96            info_map,
97            ts_event.into(),
98            ts_init.into(),
99        )
100        .map_err(to_pyvalue_err)
101    }
102
103    fn __richcmp__(&self, other: &Self, op: CompareOp, py: Python<'_>) -> Py<PyAny> {
104        match op {
105            CompareOp::Eq => self.eq(other).into_py_any_unwrap(py),
106            CompareOp::Ne => self.ne(other).into_py_any_unwrap(py),
107            _ => py.NotImplemented(),
108        }
109    }
110
111    fn __hash__(&self) -> isize {
112        let mut hasher = DefaultHasher::new();
113        self.hash(&mut hasher);
114        hasher.finish() as isize
115    }
116
117    #[getter]
118    fn type_name(&self) -> &'static str {
119        stringify!(FuturesContract)
120    }
121
122    #[getter]
123    #[pyo3(name = "id")]
124    fn py_id(&self) -> InstrumentId {
125        self.id
126    }
127
128    #[getter]
129    #[pyo3(name = "raw_symbol")]
130    fn py_raw_symbol(&self) -> Symbol {
131        self.raw_symbol
132    }
133
134    #[getter]
135    #[pyo3(name = "asset_class")]
136    fn py_asset_class(&self) -> AssetClass {
137        self.asset_class
138    }
139
140    #[getter]
141    #[pyo3(name = "exchange")]
142    fn py_exchange(&self) -> Option<String> {
143        self.exchange.map(|e| e.to_string())
144    }
145
146    #[getter]
147    #[pyo3(name = "underlying")]
148    fn py_underlying(&self) -> &str {
149        self.underlying.as_str()
150    }
151
152    #[getter]
153    #[pyo3(name = "activation_ns")]
154    fn py_activation_ns(&self) -> u64 {
155        self.activation_ns.as_u64()
156    }
157
158    #[getter]
159    #[pyo3(name = "expiration_ns")]
160    fn py_expiration_ns(&self) -> u64 {
161        self.expiration_ns.as_u64()
162    }
163
164    #[getter]
165    #[pyo3(name = "currency")]
166    fn py_currency(&self) -> Currency {
167        self.currency
168    }
169
170    #[getter]
171    #[pyo3(name = "price_precision")]
172    fn py_price_precision(&self) -> u8 {
173        self.price_precision
174    }
175
176    #[getter]
177    #[pyo3(name = "price_increment")]
178    fn py_price_increment(&self) -> Price {
179        self.price_increment
180    }
181
182    #[getter]
183    #[pyo3(name = "multiplier")]
184    fn py_multiplier(&self) -> Quantity {
185        self.multiplier
186    }
187
188    #[getter]
189    #[pyo3(name = "lot_size")]
190    fn py_lot_size(&self) -> Quantity {
191        self.lot_size
192    }
193
194    #[getter]
195    #[pyo3(name = "max_quantity")]
196    fn py_max_quantity(&self) -> Option<Quantity> {
197        self.max_quantity
198    }
199
200    #[getter]
201    #[pyo3(name = "min_quantity")]
202    fn py_min_quantity(&self) -> Option<Quantity> {
203        self.min_quantity
204    }
205
206    #[getter]
207    #[pyo3(name = "max_price")]
208    fn py_max_price(&self) -> Option<Price> {
209        self.max_price
210    }
211
212    #[getter]
213    #[pyo3(name = "min_price")]
214    fn py_min_price(&self) -> Option<Price> {
215        self.min_price
216    }
217
218    #[getter]
219    #[pyo3(name = "size_increment")]
220    fn py_size_increment(&self) -> Quantity {
221        self.size_increment
222    }
223
224    #[getter]
225    #[pyo3(name = "size_precision")]
226    fn py_size_precision(&self) -> u8 {
227        self.size_precision
228    }
229
230    #[getter]
231    #[pyo3(name = "ts_event")]
232    fn py_ts_event(&self) -> u64 {
233        self.ts_event.as_u64()
234    }
235
236    #[getter]
237    #[pyo3(name = "ts_init")]
238    fn py_ts_init(&self) -> u64 {
239        self.ts_init.as_u64()
240    }
241
242    #[getter]
243    #[pyo3(name = "margin_init")]
244    fn py_margin_init(&self) -> Decimal {
245        self.margin_init
246    }
247
248    #[getter]
249    #[pyo3(name = "margin_maint")]
250    fn py_margin_maint(&self) -> Decimal {
251        self.margin_maint
252    }
253
254    #[getter]
255    #[pyo3(name = "maker_fee")]
256    fn py_maker_fee(&self) -> Decimal {
257        self.maker_fee
258    }
259
260    #[getter]
261    #[pyo3(name = "taker_fee")]
262    fn py_taker_fee(&self) -> Decimal {
263        self.taker_fee
264    }
265
266    #[getter]
267    #[pyo3(name = "info")]
268    fn py_info(&self, py: Python<'_>) -> PyResult<Py<PyDict>> {
269        // Convert HashMap<String, serde_json::Value> back to Python dict
270        if let Some(ref info_map) = self.info {
271            let py_dict = PyDict::new(py);
272
273            for (key, value) in info_map {
274                // Convert serde_json::Value back to Python object via JSON
275                let json_str = serde_json::to_string(value).map_err(to_pyvalue_err)?;
276                let py_value =
277                    PyModule::import(py, "json")?.call_method("loads", (json_str,), None)?;
278                py_dict.set_item(key, py_value)?;
279            }
280            Ok(py_dict.unbind())
281        } else {
282            Ok(PyDict::new(py).unbind())
283        }
284    }
285
286    #[staticmethod]
287    #[pyo3(name = "from_dict")]
288    fn py_from_dict(py: Python<'_>, values: Py<PyDict>) -> PyResult<Self> {
289        from_dict_pyo3(py, values)
290    }
291
292    #[pyo3(name = "to_dict")]
293    fn py_to_dict(&self, py: Python<'_>) -> PyResult<Py<PyAny>> {
294        let dict = PyDict::new(py);
295        dict.set_item("type", stringify!(FuturesContract))?;
296        dict.set_item("id", self.id.to_string())?;
297        dict.set_item("raw_symbol", self.raw_symbol.to_string())?;
298        dict.set_item("asset_class", self.asset_class.to_string())?;
299        dict.set_item("underlying", self.underlying.to_string())?;
300        dict.set_item("activation_ns", self.activation_ns.as_u64())?;
301        dict.set_item("expiration_ns", self.expiration_ns.as_u64())?;
302        dict.set_item("currency", self.currency.code.to_string())?;
303        dict.set_item("price_precision", self.price_precision)?;
304        dict.set_item("price_increment", self.price_increment.to_string())?;
305        dict.set_item("size_increment", self.size_increment.to_string())?;
306        dict.set_item("size_precision", self.size_precision)?;
307        dict.set_item("multiplier", self.multiplier.to_string())?;
308        dict.set_item("lot_size", self.lot_size.to_string())?;
309        dict.set_item("margin_init", self.margin_init.to_string())?;
310        dict.set_item("margin_maint", self.margin_maint.to_string())?;
311        dict.set_item("maker_fee", self.maker_fee.to_string())?;
312        dict.set_item("taker_fee", self.taker_fee.to_string())?;
313        // Serialize info dict
314        if let Some(ref info_map) = self.info {
315            let info_dict = PyDict::new(py);
316
317            for (key, value) in info_map {
318                let json_str = serde_json::to_string(value).map_err(to_pyvalue_err)?;
319                let py_value =
320                    PyModule::import(py, "json")?.call_method("loads", (json_str,), None)?;
321                info_dict.set_item(key, py_value)?;
322            }
323            dict.set_item("info", info_dict)?;
324        } else {
325            dict.set_item("info", PyDict::new(py))?;
326        }
327        dict.set_item("ts_event", self.ts_event.as_u64())?;
328        dict.set_item("ts_init", self.ts_init.as_u64())?;
329        match self.max_quantity {
330            Some(value) => dict.set_item("max_quantity", value.to_string())?,
331            None => dict.set_item("max_quantity", py.None())?,
332        }
333
334        match self.min_quantity {
335            Some(value) => dict.set_item("min_quantity", value.to_string())?,
336            None => dict.set_item("min_quantity", py.None())?,
337        }
338
339        match self.max_price {
340            Some(value) => dict.set_item("max_price", value.to_string())?,
341            None => dict.set_item("max_price", py.None())?,
342        }
343
344        match self.min_price {
345            Some(value) => dict.set_item("min_price", value.to_string())?,
346            None => dict.set_item("min_price", py.None())?,
347        }
348
349        match self.exchange {
350            Some(value) => dict.set_item("exchange", value.to_string())?,
351            None => dict.set_item("exchange", py.None())?,
352        }
353        Ok(dict.into())
354    }
355}
nautilus_model/python/instruments/futures_contract.rs

nautilus_model/python/instruments/
futures_contract.rs
