nautilus_tardis/machine/
types.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 jiff::civil::Date;
17use nautilus_model::identifiers::InstrumentId;
18use serde::{Deserialize, Serialize};
19use ustr::Ustr;
20
21use crate::common::enums::TardisExchange;
22pub use crate::machine::client::TardisMachineClient;
23
24/// Instrument definition information necessary for stream parsing.
25#[derive(Clone, Debug, Serialize, Deserialize)]
26#[cfg_attr(
27    feature = "python",
28    pyo3::pyclass(module = "nautilus_trader.adapters.tardis", from_py_object)
29)]
30#[cfg_attr(
31    feature = "python",
32    pyo3_stub_gen::derive::gen_stub_pyclass(module = "nautilus_trader.adapters.tardis")
33)]
34pub struct TardisInstrumentMiniInfo {
35    /// The instrument ID with optionally Nautilus normalized symbol.
36    pub instrument_id: InstrumentId,
37    /// The Tardis symbol.
38    pub raw_symbol: Ustr,
39    /// The Tardis exchange.
40    pub exchange: TardisExchange,
41    /// The price precision for the instrument.
42    pub price_precision: u8,
43    /// The size precision for the instrument.
44    pub size_precision: u8,
45}
46
47impl TardisInstrumentMiniInfo {
48    /// Creates a new [`TardisInstrumentMiniInfo`] instance.
49    ///
50    /// If `raw_instrument_id` is `None` then the `instrument_id` value will be assigned.
51    #[must_use]
52    pub fn new(
53        instrument_id: InstrumentId,
54        raw_symbol: Option<Ustr>,
55        exchange: TardisExchange,
56        price_precision: u8,
57        size_precision: u8,
58    ) -> Self {
59        Self {
60            instrument_id,
61            raw_symbol: raw_symbol.unwrap_or(instrument_id.symbol.inner()),
62            exchange,
63            price_precision,
64            size_precision,
65        }
66    }
67
68    #[must_use]
69    pub const fn as_tardis_instrument_key(&self) -> TardisInstrumentKey {
70        TardisInstrumentKey::new(self.raw_symbol, self.exchange)
71    }
72}
73
74/// Instrument definition information necessary for stream parsing.
75#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
76#[cfg_attr(
77    feature = "python",
78    pyo3::pyclass(module = "nautilus_trader.adapters.tardis", from_py_object)
79)]
80pub struct TardisInstrumentKey {
81    /// The Tardis raw symbol.
82    pub raw_symbol: Ustr,
83    /// The Tardis exchange.
84    pub exchange: TardisExchange,
85}
86
87impl TardisInstrumentKey {
88    /// Creates a new [`TardisInstrumentKey`] instance.
89    #[must_use]
90    pub const fn new(raw_symbol: Ustr, exchange: TardisExchange) -> Self {
91        Self {
92            raw_symbol,
93            exchange,
94        }
95    }
96}
97
98/// The options that can be specified for calling Tardis Machine Server's replay-normalized.
99#[derive(Debug, Clone, Serialize, Deserialize)]
100#[serde(rename_all = "camelCase")]
101#[cfg_attr(
102    feature = "python",
103    pyo3::pyclass(module = "nautilus_trader.adapters.tardis", from_py_object)
104)]
105#[cfg_attr(
106    feature = "python",
107    pyo3_stub_gen::derive::gen_stub_pyclass(module = "nautilus_trader.adapters.tardis")
108)]
109pub struct ReplayNormalizedRequestOptions {
110    /// Requested [`TardisExchange`].
111    pub exchange: TardisExchange,
112    /// Optional symbols of requested historical data feed.
113    /// Use /exchanges/:exchange HTTP API to get allowed symbols for requested exchange.
114    #[serde(skip_serializing_if = "Option::is_none")]
115    #[serde(default)]
116    pub symbols: Option<Vec<String>>,
117    /// Replay period start date (UTC) in a ISO 8601 format, e.g., 2019-10-01.
118    pub from: Date,
119    /// Replay period start date (UTC) in a ISO 8601 format, e.g., 2019-10-02.
120    pub to: Date,
121    /// Array of normalized [data types](https://docs.tardis.dev/api/tardis-machine#normalized-data-types)
122    /// for which real-time data will be provided.
123    #[serde(alias = "data_types")]
124    pub data_types: Vec<String>,
125    /// When set to true, sends also disconnect messages that mark events when real-time WebSocket
126    /// connection that was used to collect the historical data got disconnected.
127    #[serde(skip_serializing_if = "Option::is_none")]
128    #[serde(default)]
129    #[serde(alias = "with_disconnect_messages")]
130    pub with_disconnect_messages: Option<bool>,
131}
132
133/// The options that can be specified for calling Tardis Machine Server's stream-normalized.
134#[derive(Debug, Clone, Serialize, Deserialize)]
135#[serde(rename_all = "camelCase")]
136#[cfg_attr(
137    feature = "python",
138    pyo3::pyclass(module = "nautilus_trader.adapters.tardis", from_py_object)
139)]
140#[cfg_attr(
141    feature = "python",
142    pyo3_stub_gen::derive::gen_stub_pyclass(module = "nautilus_trader.adapters.tardis")
143)]
144pub struct StreamNormalizedRequestOptions {
145    /// Requested [`TardisExchange`].
146    pub exchange: TardisExchange,
147    /// Optional symbols of requested real-time data feed.
148    #[serde(skip_serializing_if = "Option::is_none")]
149    #[serde(default)]
150    pub symbols: Option<Vec<String>>,
151    /// Array of normalized [data types](https://docs.tardis.dev/api/tardis-machine#normalized-data-types)
152    /// for which real-time data will be provided.
153    #[serde(alias = "data_types")]
154    pub data_types: Vec<String>,
155    /// When set to true, sends disconnect messages anytime underlying exchange real-time WebSocket
156    /// connection(s) gets disconnected.
157    #[serde(skip_serializing_if = "Option::is_none")]
158    #[serde(default)]
159    pub with_disconnect_messages: Option<bool>,
160    /// Specifies time in milliseconds after which connection to real-time exchanges' WebSocket API
161    /// is restarted if no message has been received.
162    #[serde(skip_serializing_if = "Option::is_none")]
163    #[serde(default, rename = "timeoutIntervalMS")]
164    pub timeout_interval_ms: Option<u64>,
165}
nautilus_tardis/machine/types.rs

nautilus_tardis/machine/
types.rs
