nautilus_model/events/order/
released.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::fmt::{Debug, Display};
17
18use nautilus_core::{UUID4, UnixNanos};
19use rust_decimal::Decimal;
20use serde::{Deserialize, Serialize};
21use ustr::Ustr;
22
23use crate::{
24    enums::{
25        ContingencyType, LiquiditySide, OrderSide, OrderType, TimeInForce, TrailingOffsetType,
26        TriggerType,
27    },
28    events::OrderEvent,
29    identifiers::{
30        AccountId, ClientOrderId, ExecAlgorithmId, InstrumentId, OrderListId, PositionId,
31        StrategyId, TradeId, TraderId, VenueOrderId,
32    },
33    types::{Currency, Money, Price, Quantity},
34};
35
36/// Represents an event where an order was released from the `OrderEmulated` by the Nautilus system.
37#[repr(C)]
38#[derive(Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
39#[serde(tag = "type")]
40#[cfg_attr(
41    feature = "python",
42    pyo3::pyclass(module = "nautilus_trader.core.nautilus_pyo3.model", from_py_object)
43)]
44#[cfg_attr(
45    feature = "python",
46    pyo3_stub_gen::derive::gen_stub_pyclass(module = "nautilus_trader.model")
47)]
48pub struct OrderReleased {
49    /// The trader ID associated with the event.
50    pub trader_id: TraderId,
51    /// The strategy ID associated with the event.
52    pub strategy_id: StrategyId,
53    /// The instrument ID associated with the event.
54    pub instrument_id: InstrumentId,
55    /// The client order ID associated with the event.
56    pub client_order_id: ClientOrderId,
57    pub released_price: Price,
58    /// The unique identifier for the event.
59    pub event_id: UUID4,
60    /// UNIX timestamp (nanoseconds) when the event occurred.
61    pub ts_event: UnixNanos,
62    /// UNIX timestamp (nanoseconds) when the event was initialized.
63    pub ts_init: UnixNanos,
64    /// The causation ID associated with the event.
65    #[serde(default, skip_serializing_if = "Option::is_none")]
66    pub causation_id: Option<UUID4>,
67}
68
69impl OrderReleased {
70    /// Creates a new [`OrderReleased`] instance.
71    #[expect(clippy::too_many_arguments)]
72    #[must_use]
73    pub fn new(
74        trader_id: TraderId,
75        strategy_id: StrategyId,
76        instrument_id: InstrumentId,
77        client_order_id: ClientOrderId,
78        released_price: Price,
79        event_id: UUID4,
80        ts_event: UnixNanos,
81        ts_init: UnixNanos,
82    ) -> Self {
83        Self {
84            trader_id,
85            strategy_id,
86            instrument_id,
87            client_order_id,
88            released_price,
89            event_id,
90            ts_event,
91            ts_init,
92            causation_id: None,
93        }
94    }
95}
96
97impl Debug for OrderReleased {
98    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
99        write!(
100            f,
101            "{}(trader_id={}, strategy_id={}, instrument_id={}, client_order_id={}, released_price={}, event_id={}, ts_init={})",
102            stringify!(OrderReleased),
103            self.trader_id,
104            self.strategy_id,
105            self.instrument_id,
106            self.client_order_id,
107            self.released_price.to_formatted_string(),
108            self.event_id,
109            self.ts_init
110        )
111    }
112}
113
114impl Display for OrderReleased {
115    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
116        write!(
117            f,
118            "{}(instrument_id={}, client_order_id={}, released_price={})",
119            stringify!(OrderReleased),
120            self.instrument_id,
121            self.client_order_id,
122            self.released_price.to_formatted_string(),
123        )
124    }
125}
126
127impl OrderEvent for OrderReleased {
128    fn id(&self) -> UUID4 {
129        self.event_id
130    }
131
132    fn type_name(&self) -> &'static str {
133        stringify!(OrderReleased)
134    }
135
136    fn order_type(&self) -> Option<OrderType> {
137        None
138    }
139
140    fn order_side(&self) -> Option<OrderSide> {
141        None
142    }
143
144    fn trader_id(&self) -> TraderId {
145        self.trader_id
146    }
147
148    fn strategy_id(&self) -> StrategyId {
149        self.strategy_id
150    }
151
152    fn instrument_id(&self) -> InstrumentId {
153        self.instrument_id
154    }
155
156    fn trade_id(&self) -> Option<TradeId> {
157        None
158    }
159
160    fn currency(&self) -> Option<Currency> {
161        None
162    }
163
164    fn client_order_id(&self) -> ClientOrderId {
165        self.client_order_id
166    }
167
168    fn reason(&self) -> Option<Ustr> {
169        None
170    }
171
172    fn quantity(&self) -> Option<Quantity> {
173        None
174    }
175
176    fn time_in_force(&self) -> Option<TimeInForce> {
177        None
178    }
179
180    fn liquidity_side(&self) -> Option<LiquiditySide> {
181        None
182    }
183
184    fn post_only(&self) -> Option<bool> {
185        None
186    }
187
188    fn reduce_only(&self) -> Option<bool> {
189        None
190    }
191
192    fn quote_quantity(&self) -> Option<bool> {
193        None
194    }
195
196    fn reconciliation(&self) -> bool {
197        false
198    }
199
200    fn price(&self) -> Option<Price> {
201        None
202    }
203
204    fn last_px(&self) -> Option<Price> {
205        None
206    }
207
208    fn last_qty(&self) -> Option<Quantity> {
209        None
210    }
211
212    fn trigger_price(&self) -> Option<Price> {
213        None
214    }
215
216    fn trigger_type(&self) -> Option<TriggerType> {
217        None
218    }
219
220    fn limit_offset(&self) -> Option<Decimal> {
221        None
222    }
223
224    fn trailing_offset(&self) -> Option<Decimal> {
225        None
226    }
227
228    fn trailing_offset_type(&self) -> Option<TrailingOffsetType> {
229        None
230    }
231
232    fn expire_time(&self) -> Option<UnixNanos> {
233        None
234    }
235
236    fn display_qty(&self) -> Option<Quantity> {
237        None
238    }
239
240    fn emulation_trigger(&self) -> Option<TriggerType> {
241        None
242    }
243
244    fn trigger_instrument_id(&self) -> Option<InstrumentId> {
245        None
246    }
247
248    fn contingency_type(&self) -> Option<ContingencyType> {
249        None
250    }
251
252    fn order_list_id(&self) -> Option<OrderListId> {
253        None
254    }
255
256    fn linked_order_ids(&self) -> Option<Vec<ClientOrderId>> {
257        None
258    }
259
260    fn parent_order_id(&self) -> Option<ClientOrderId> {
261        None
262    }
263
264    fn exec_algorithm_id(&self) -> Option<ExecAlgorithmId> {
265        None
266    }
267
268    fn exec_spawn_id(&self) -> Option<ClientOrderId> {
269        None
270    }
271
272    fn venue_order_id(&self) -> Option<VenueOrderId> {
273        None
274    }
275
276    fn account_id(&self) -> Option<AccountId> {
277        None
278    }
279
280    fn position_id(&self) -> Option<PositionId> {
281        None
282    }
283
284    fn commission(&self) -> Option<Money> {
285        None
286    }
287
288    fn ts_event(&self) -> UnixNanos {
289        self.ts_event
290    }
291
292    fn ts_init(&self) -> UnixNanos {
293        self.ts_init
294    }
295}
296
297#[cfg(test)]
298mod tests {
299    use rstest::rstest;
300
301    use crate::events::order::{released::OrderReleased, stubs::*};
302    #[rstest]
303    fn test_order_released_display(order_released: OrderReleased) {
304        let display = format!("{order_released}");
305        assert_eq!(
306            display,
307            "OrderReleased(instrument_id=BTCUSDT.COINBASE, client_order_id=O-19700101-000000-001-001-1, released_price=22_000)"
308        );
309    }
310
311    #[rstest]
312    fn test_order_released_serialization() {
313        let original = OrderReleased::default();
314        let json = serde_json::to_string(&original).unwrap();
315        let deserialized: OrderReleased = serde_json::from_str(&json).unwrap();
316        assert_eq!(original, deserialized);
317    }
318}
nautilus_model/events/order/released.rs

nautilus_model/events/order/
released.rs
