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

nautilus_model/python/instruments/
currency_pair.rs
