nautilus_model/orders/
stop_market.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    fmt::Display,
18    ops::{Deref, DerefMut},
19};
20
21use indexmap::IndexMap;
22use nautilus_core::{
23    UUID4, UnixNanos,
24    correctness::{CorrectnessError, FAILED},
25};
26use rust_decimal::Decimal;
27use serde::{Deserialize, Serialize};
28use ustr::Ustr;
29
30use super::{Order, OrderAny, OrderCore};
31use crate::{
32    enums::{
33        ContingencyType, LiquiditySide, OrderSide, OrderStatus, OrderType, PositionSide,
34        TimeInForce, TrailingOffsetType, TriggerType,
35    },
36    events::{OrderEventAny, OrderInitialized, OrderUpdated},
37    identifiers::{
38        AccountId, ClientOrderId, ExecAlgorithmId, InstrumentId, OrderListId, PositionId,
39        StrategyId, Symbol, TradeId, TraderId, Venue, VenueOrderId,
40    },
41    orders::{OrderError, check_display_qty, check_time_in_force},
42    types::{Currency, Money, Price, Quantity, quantity::check_positive_quantity},
43};
44
45#[derive(Clone, Debug, Serialize, Deserialize)]
46#[cfg_attr(
47    feature = "python",
48    pyo3::pyclass(module = "nautilus_trader.model", from_py_object)
49)]
50#[cfg_attr(
51    feature = "python",
52    pyo3_stub_gen::derive::gen_stub_pyclass(module = "nautilus_trader.model")
53)]
54pub struct StopMarketOrder {
55    pub trigger_price: Price,
56    pub trigger_type: TriggerType,
57    pub expire_time: Option<UnixNanos>,
58    pub display_qty: Option<Quantity>,
59    pub trigger_instrument_id: Option<InstrumentId>,
60    pub is_triggered: bool,
61    pub ts_triggered: Option<UnixNanos>,
62    pub protection_price: Option<Price>,
63    core: OrderCore,
64}
65
66impl StopMarketOrder {
67    /// Creates a new [`StopMarketOrder`] instance.
68    ///
69    /// # Errors
70    ///
71    /// Returns an error if:
72    /// - The `quantity` is not positive.
73    /// - The `display_qty` (when provided) exceeds `quantity`.
74    /// - The `time_in_force` is `GTD` **and** `expire_time` is `None` or zero.
75    /// - The order metadata violates an [`OrderInitialized::new_checked`] invariant.
76    #[expect(clippy::too_many_arguments)]
77    pub fn new_checked(
78        trader_id: TraderId,
79        strategy_id: StrategyId,
80        instrument_id: InstrumentId,
81        client_order_id: ClientOrderId,
82        order_side: OrderSide,
83        quantity: Quantity,
84        trigger_price: Price,
85        trigger_type: TriggerType,
86        time_in_force: TimeInForce,
87        expire_time: Option<UnixNanos>,
88        reduce_only: bool,
89        quote_quantity: bool,
90        display_qty: Option<Quantity>,
91        emulation_trigger: Option<TriggerType>,
92        trigger_instrument_id: Option<InstrumentId>,
93        contingency_type: Option<ContingencyType>,
94        order_list_id: Option<OrderListId>,
95        linked_order_ids: Option<Vec<ClientOrderId>>,
96        parent_order_id: Option<ClientOrderId>,
97        exec_algorithm_id: Option<ExecAlgorithmId>,
98        exec_algorithm_params: Option<IndexMap<Ustr, Ustr>>,
99        exec_spawn_id: Option<ClientOrderId>,
100        tags: Option<Vec<Ustr>>,
101        init_id: UUID4,
102        ts_init: UnixNanos,
103    ) -> Result<Self, OrderError> {
104        check_positive_quantity(quantity, stringify!(quantity))?;
105        check_display_qty(display_qty, quantity)?;
106        check_time_in_force(time_in_force, expire_time)?;
107
108        let init_order = OrderInitialized::new_checked(
109            trader_id,
110            strategy_id,
111            instrument_id,
112            client_order_id,
113            order_side,
114            OrderType::StopMarket,
115            quantity,
116            time_in_force,
117            false,
118            reduce_only,
119            quote_quantity,
120            false,
121            init_id,
122            ts_init,
123            ts_init,
124            None,
125            None,
126            Some(trigger_price),
127            Some(trigger_type),
128            None,
129            None,
130            None,
131            expire_time,
132            display_qty,
133            emulation_trigger,
134            trigger_instrument_id,
135            contingency_type,
136            order_list_id,
137            linked_order_ids,
138            parent_order_id,
139            exec_algorithm_id,
140            exec_algorithm_params,
141            exec_spawn_id,
142            tags,
143        )?;
144
145        Ok(Self {
146            core: OrderCore::new(init_order),
147            trigger_price,
148            trigger_type,
149            expire_time,
150            display_qty,
151            trigger_instrument_id,
152            is_triggered: false,
153            ts_triggered: None,
154            protection_price: None,
155        })
156    }
157
158    /// Creates a new [`StopMarketOrder`] instance.
159    ///
160    /// # Panics
161    ///
162    /// Panics if any order validation fails (see [`StopMarketOrder::new_checked`]).
163    #[expect(clippy::too_many_arguments)]
164    #[must_use]
165    pub fn new(
166        trader_id: TraderId,
167        strategy_id: StrategyId,
168        instrument_id: InstrumentId,
169        client_order_id: ClientOrderId,
170        order_side: OrderSide,
171        quantity: Quantity,
172        trigger_price: Price,
173        trigger_type: TriggerType,
174        time_in_force: TimeInForce,
175        expire_time: Option<UnixNanos>,
176        reduce_only: bool,
177        quote_quantity: bool,
178        display_qty: Option<Quantity>,
179        emulation_trigger: Option<TriggerType>,
180        trigger_instrument_id: Option<InstrumentId>,
181        contingency_type: Option<ContingencyType>,
182        order_list_id: Option<OrderListId>,
183        linked_order_ids: Option<Vec<ClientOrderId>>,
184        parent_order_id: Option<ClientOrderId>,
185        exec_algorithm_id: Option<ExecAlgorithmId>,
186        exec_algorithm_params: Option<IndexMap<Ustr, Ustr>>,
187        exec_spawn_id: Option<ClientOrderId>,
188        tags: Option<Vec<Ustr>>,
189        init_id: UUID4,
190        ts_init: UnixNanos,
191    ) -> Self {
192        Self::new_checked(
193            trader_id,
194            strategy_id,
195            instrument_id,
196            client_order_id,
197            order_side,
198            quantity,
199            trigger_price,
200            trigger_type,
201            time_in_force,
202            expire_time,
203            reduce_only,
204            quote_quantity,
205            display_qty,
206            emulation_trigger,
207            trigger_instrument_id,
208            contingency_type,
209            order_list_id,
210            linked_order_ids,
211            parent_order_id,
212            exec_algorithm_id,
213            exec_algorithm_params,
214            exec_spawn_id,
215            tags,
216            init_id,
217            ts_init,
218        )
219        .unwrap_or_else(|e| panic!("{FAILED}: {e}"))
220    }
221}
222
223impl PartialEq for StopMarketOrder {
224    fn eq(&self, other: &Self) -> bool {
225        self.client_order_id == other.client_order_id
226    }
227}
228
229impl Deref for StopMarketOrder {
230    type Target = OrderCore;
231
232    fn deref(&self) -> &Self::Target {
233        &self.core
234    }
235}
236
237impl DerefMut for StopMarketOrder {
238    fn deref_mut(&mut self) -> &mut Self::Target {
239        &mut self.core
240    }
241}
242
243impl Order for StopMarketOrder {
244    fn into_any(self) -> OrderAny {
245        OrderAny::StopMarket(self)
246    }
247
248    fn status(&self) -> OrderStatus {
249        self.status
250    }
251
252    fn trader_id(&self) -> TraderId {
253        self.trader_id
254    }
255
256    fn strategy_id(&self) -> StrategyId {
257        self.strategy_id
258    }
259
260    fn instrument_id(&self) -> InstrumentId {
261        self.instrument_id
262    }
263
264    fn symbol(&self) -> Symbol {
265        self.instrument_id.symbol
266    }
267
268    fn venue(&self) -> Venue {
269        self.instrument_id.venue
270    }
271
272    fn client_order_id(&self) -> ClientOrderId {
273        self.client_order_id
274    }
275
276    fn venue_order_id(&self) -> Option<VenueOrderId> {
277        self.venue_order_id
278    }
279
280    fn position_id(&self) -> Option<PositionId> {
281        self.position_id
282    }
283
284    fn account_id(&self) -> Option<AccountId> {
285        self.account_id
286    }
287
288    fn last_trade_id(&self) -> Option<TradeId> {
289        self.last_trade_id
290    }
291
292    fn order_side(&self) -> OrderSide {
293        self.side
294    }
295
296    fn order_type(&self) -> OrderType {
297        self.order_type
298    }
299
300    fn quantity(&self) -> Quantity {
301        self.quantity
302    }
303
304    fn time_in_force(&self) -> TimeInForce {
305        self.time_in_force
306    }
307
308    fn expire_time(&self) -> Option<UnixNanos> {
309        self.expire_time
310    }
311
312    fn price(&self) -> Option<Price> {
313        self.protection_price
314    }
315
316    fn trigger_price(&self) -> Option<Price> {
317        Some(self.trigger_price)
318    }
319
320    fn trigger_type(&self) -> Option<TriggerType> {
321        Some(self.trigger_type)
322    }
323
324    fn liquidity_side(&self) -> Option<LiquiditySide> {
325        self.liquidity_side
326    }
327
328    fn is_post_only(&self) -> bool {
329        false
330    }
331
332    fn is_reduce_only(&self) -> bool {
333        self.is_reduce_only
334    }
335
336    fn is_quote_quantity(&self) -> bool {
337        self.is_quote_quantity
338    }
339
340    fn has_price(&self) -> bool {
341        self.protection_price.is_some()
342    }
343
344    fn display_qty(&self) -> Option<Quantity> {
345        self.display_qty
346    }
347
348    fn limit_offset(&self) -> Option<Decimal> {
349        None
350    }
351
352    fn trailing_offset(&self) -> Option<Decimal> {
353        None
354    }
355
356    fn trailing_offset_type(&self) -> Option<TrailingOffsetType> {
357        None
358    }
359
360    fn emulation_trigger(&self) -> Option<TriggerType> {
361        self.emulation_trigger
362    }
363
364    fn trigger_instrument_id(&self) -> Option<InstrumentId> {
365        self.trigger_instrument_id
366    }
367
368    fn contingency_type(&self) -> Option<ContingencyType> {
369        self.contingency_type
370    }
371
372    fn order_list_id(&self) -> Option<OrderListId> {
373        self.order_list_id
374    }
375
376    fn linked_order_ids(&self) -> Option<&[ClientOrderId]> {
377        self.linked_order_ids.as_deref()
378    }
379
380    fn parent_order_id(&self) -> Option<ClientOrderId> {
381        self.parent_order_id
382    }
383
384    fn exec_algorithm_id(&self) -> Option<ExecAlgorithmId> {
385        self.exec_algorithm_id
386    }
387
388    fn exec_algorithm_params(&self) -> Option<&IndexMap<Ustr, Ustr>> {
389        self.exec_algorithm_params.as_ref()
390    }
391
392    fn exec_spawn_id(&self) -> Option<ClientOrderId> {
393        self.exec_spawn_id
394    }
395
396    fn tags(&self) -> Option<&[Ustr]> {
397        self.tags.as_deref()
398    }
399
400    fn filled_qty(&self) -> Quantity {
401        self.filled_qty
402    }
403
404    fn voided_qty(&self) -> Quantity {
405        self.voided_qty
406    }
407
408    fn leaves_qty(&self) -> Quantity {
409        self.leaves_qty
410    }
411
412    fn overfill_qty(&self) -> Quantity {
413        self.overfill_qty
414    }
415
416    fn avg_px(&self) -> Option<Decimal> {
417        self.avg_px
418    }
419
420    fn slippage(&self) -> Option<Decimal> {
421        self.slippage
422    }
423
424    fn init_id(&self) -> UUID4 {
425        self.init_id
426    }
427
428    fn ts_init(&self) -> UnixNanos {
429        self.ts_init
430    }
431
432    fn ts_submitted(&self) -> Option<UnixNanos> {
433        self.ts_submitted
434    }
435
436    fn ts_accepted(&self) -> Option<UnixNanos> {
437        self.ts_accepted
438    }
439
440    fn ts_closed(&self) -> Option<UnixNanos> {
441        self.ts_closed
442    }
443
444    fn ts_last(&self) -> UnixNanos {
445        self.ts_last
446    }
447
448    fn events(&self) -> Vec<&OrderEventAny> {
449        self.events.iter().collect()
450    }
451
452    fn venue_order_ids(&self) -> Vec<&VenueOrderId> {
453        self.venue_order_ids.iter().collect()
454    }
455
456    fn trade_ids(&self) -> Vec<&TradeId> {
457        self.trade_ids.iter().collect()
458    }
459
460    fn commissions(&self) -> &IndexMap<Currency, Money> {
461        &self.commissions
462    }
463
464    fn apply(&mut self, event: OrderEventAny) -> Result<(), OrderError> {
465        let updates_slippage = matches!(
466            event,
467            OrderEventAny::Filled(_) | OrderEventAny::FillVoided(_),
468        );
469        let is_order_triggered = matches!(event, OrderEventAny::Triggered(_));
470        let ts_event = if is_order_triggered {
471            Some(event.ts_event())
472        } else {
473            None
474        };
475
476        self.core.apply(event.clone())?;
477
478        if let OrderEventAny::Updated(ref event) = event {
479            self.update(event);
480        }
481
482        if is_order_triggered {
483            self.is_triggered = true;
484            self.ts_triggered = ts_event;
485        }
486
487        if updates_slippage {
488            self.core.set_slippage(self.trigger_price);
489        }
490
491        Ok(())
492    }
493
494    fn update(&mut self, event: &OrderUpdated) {
495        assert!(event.price.is_none(), "{}", OrderError::InvalidOrderEvent);
496
497        if let Some(trigger_price) = event.trigger_price {
498            self.trigger_price = trigger_price;
499        }
500
501        if let Some(protection_price) = event.protection_price {
502            self.protection_price = Some(protection_price);
503        }
504        self.quantity = event.quantity;
505        self.leaves_qty = self.quantity.saturating_sub(self.filled_qty);
506    }
507
508    fn is_triggered(&self) -> Option<bool> {
509        Some(self.is_triggered)
510    }
511
512    fn set_position_id(&mut self, position_id: Option<PositionId>) {
513        self.position_id = position_id;
514    }
515
516    fn set_quantity(&mut self, quantity: Quantity) {
517        self.quantity = quantity;
518    }
519
520    fn set_leaves_qty(&mut self, leaves_qty: Quantity) {
521        self.leaves_qty = leaves_qty;
522    }
523
524    fn set_emulation_trigger(&mut self, emulation_trigger: Option<TriggerType>) {
525        self.emulation_trigger = emulation_trigger;
526    }
527
528    fn set_is_quote_quantity(&mut self, is_quote_quantity: bool) {
529        self.is_quote_quantity = is_quote_quantity;
530    }
531
532    fn set_liquidity_side(&mut self, liquidity_side: LiquiditySide) {
533        self.liquidity_side = Some(liquidity_side);
534    }
535
536    fn would_reduce_only(&self, side: PositionSide, position_qty: Quantity) -> bool {
537        self.core.would_reduce_only(side, position_qty)
538    }
539
540    fn previous_status(&self) -> Option<OrderStatus> {
541        self.core.previous_status
542    }
543}
544
545impl Display for StopMarketOrder {
546    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
547        write!(
548            f,
549            "StopMarketOrder(\
550            {} {} {} {} {}, \
551            status={}, \
552            client_order_id={}, \
553            venue_order_id={}, \
554            position_id={}, \
555            exec_algorithm_id={}, \
556            exec_spawn_id={}, \
557            tags={:?}\
558            )",
559            self.side,
560            self.quantity.to_formatted_string(),
561            self.instrument_id,
562            self.order_type,
563            self.time_in_force,
564            self.status,
565            self.client_order_id,
566            self.venue_order_id.map_or_else(
567                || "None".to_string(),
568                |venue_order_id| format!("{venue_order_id}")
569            ),
570            self.position_id.map_or_else(
571                || "None".to_string(),
572                |position_id| format!("{position_id}")
573            ),
574            self.exec_algorithm_id
575                .map_or_else(|| "None".to_string(), |id| format!("{id}")),
576            self.exec_spawn_id
577                .map_or_else(|| "None".to_string(), |id| format!("{id}")),
578            self.tags
579        )
580    }
581}
582
583impl TryFrom<OrderInitialized> for StopMarketOrder {
584    type Error = OrderError;
585
586    fn try_from(event: OrderInitialized) -> Result<Self, Self::Error> {
587        let trigger_price =
588            event
589                .trigger_price
590                .ok_or_else(|| CorrectnessError::PredicateViolation {
591                    message: "`trigger_price` is required for `StopMarketOrder` initialization"
592                        .to_string(),
593                })?;
594        let trigger_type =
595            event
596                .trigger_type
597                .ok_or_else(|| CorrectnessError::PredicateViolation {
598                    message: "`trigger_type` is required for `StopMarketOrder` initialization"
599                        .to_string(),
600                })?;
601        Self::new_checked(
602            event.trader_id,
603            event.strategy_id,
604            event.instrument_id,
605            event.client_order_id,
606            event.order_side,
607            event.quantity,
608            trigger_price,
609            trigger_type,
610            event.time_in_force,
611            event.expire_time,
612            event.reduce_only,
613            event.quote_quantity,
614            event.display_qty,
615            event.emulation_trigger,
616            event.trigger_instrument_id,
617            event.contingency_type,
618            event.order_list_id,
619            event.linked_order_ids,
620            event.parent_order_id,
621            event.exec_algorithm_id,
622            event.exec_algorithm_params,
623            event.exec_spawn_id,
624            event.tags,
625            event.event_id,
626            event.ts_event,
627        )
628    }
629}
630
631#[cfg(test)]
632mod tests {
633    use rstest::rstest;
634
635    use super::*;
636    use crate::{
637        enums::{TimeInForce, TriggerType},
638        events::order::spec::OrderInitializedSpec,
639        identifiers::InstrumentId,
640        instruments::{CurrencyPair, stubs::*},
641        orders::{builder::OrderTestBuilder, stubs::TestOrderStubs},
642        types::{Price, Quantity},
643    };
644
645    #[rstest]
646    fn test_initialize(audusd_sim: CurrencyPair) {
647        let order = OrderTestBuilder::new(OrderType::StopMarket)
648            .instrument_id(audusd_sim.id)
649            .side(OrderSide::Buy)
650            .trigger_price(Price::from("0.68000"))
651            .trigger_type(TriggerType::LastPrice)
652            .quantity(Quantity::from(1))
653            .build();
654
655        assert_eq!(order.trigger_price(), Some(Price::from("0.68000")));
656        assert_eq!(order.price(), None);
657
658        assert_eq!(order.time_in_force(), TimeInForce::Gtc);
659
660        assert_eq!(order.is_triggered(), Some(false));
661        assert_eq!(order.filled_qty(), Quantity::from(0));
662        assert_eq!(order.leaves_qty(), Quantity::from(1));
663
664        assert_eq!(order.display_qty(), None);
665        assert_eq!(order.trigger_instrument_id(), None);
666        assert_eq!(order.order_list_id(), None);
667    }
668
669    #[rstest]
670    fn test_display(audusd_sim: CurrencyPair) {
671        let order = OrderTestBuilder::new(OrderType::StopMarket)
672            .instrument_id(audusd_sim.id)
673            .side(OrderSide::Buy)
674            .trigger_price(Price::from("0.68000"))
675            .trigger_type(TriggerType::LastPrice)
676            .quantity(Quantity::from(1))
677            .build();
678
679        assert_eq!(
680            order.to_string(),
681            "StopMarketOrder(BUY 1 AUD/USD.SIM STOP_MARKET GTC, status=INITIALIZED, client_order_id=O-19700101-000000-001-001-1, venue_order_id=None, position_id=None, exec_algorithm_id=None, exec_spawn_id=None, tags=None)"
682        );
683    }
684
685    #[rstest]
686    #[should_panic(expected = "Condition failed: `display_qty` may not exceed `quantity`")]
687    fn test_display_qty_gt_quantity_err(audusd_sim: CurrencyPair) {
688        let _ = OrderTestBuilder::new(OrderType::StopMarket)
689            .instrument_id(audusd_sim.id)
690            .side(OrderSide::Buy)
691            .trigger_price(Price::from("0.68000"))
692            .trigger_type(TriggerType::LastPrice)
693            .quantity(Quantity::from(1))
694            .display_qty(Quantity::from(2))
695            .build();
696    }
697
698    #[rstest]
699    #[should_panic(
700        expected = "Condition failed: invalid `Quantity` for 'quantity' not positive, was 0"
701    )]
702    fn test_quantity_zero_err(audusd_sim: CurrencyPair) {
703        let _ = OrderTestBuilder::new(OrderType::StopMarket)
704            .instrument_id(audusd_sim.id)
705            .side(OrderSide::Buy)
706            .trigger_price(Price::from("0.68000"))
707            .trigger_type(TriggerType::LastPrice)
708            .quantity(Quantity::from(0))
709            .build();
710    }
711
712    #[rstest]
713    #[should_panic(expected = "Condition failed: `expire_time` is required for `GTD` order")]
714    fn test_gtd_without_expire_err(audusd_sim: CurrencyPair) {
715        let _ = OrderTestBuilder::new(OrderType::StopMarket)
716            .instrument_id(audusd_sim.id)
717            .side(OrderSide::Buy)
718            .trigger_price(Price::from("0.68000"))
719            .trigger_type(TriggerType::LastPrice)
720            .time_in_force(TimeInForce::Gtd)
721            .quantity(Quantity::from(1))
722            .build();
723    }
724
725    #[rstest]
726    fn test_stop_market_order_update() {
727        // Create and accept a basic stop market order
728        let order = OrderTestBuilder::new(OrderType::StopMarket)
729            .instrument_id(InstrumentId::from("BTC-USDT.BINANCE"))
730            .quantity(Quantity::from(10))
731            .trigger_price(Price::new(100.0, 2))
732            .build();
733
734        let mut accepted_order = TestOrderStubs::make_accepted_order(&order);
735
736        // Update with new values
737        let updated_trigger_price = Price::new(95.0, 2);
738        let updated_quantity = Quantity::from(5);
739
740        let event = OrderUpdated {
741            client_order_id: accepted_order.client_order_id(),
742            strategy_id: accepted_order.strategy_id(),
743            trigger_price: Some(updated_trigger_price),
744            quantity: updated_quantity,
745            ..Default::default()
746        };
747
748        accepted_order.apply(OrderEventAny::Updated(event)).unwrap();
749
750        // Verify updates were applied correctly
751        assert_eq!(accepted_order.quantity(), updated_quantity);
752        assert_eq!(accepted_order.trigger_price(), Some(updated_trigger_price));
753    }
754
755    #[rstest]
756    fn test_stop_market_order_rejects_invalid_update_atomically() {
757        let order = OrderTestBuilder::new(OrderType::StopMarket)
758            .instrument_id(InstrumentId::from("BTC-USDT.BINANCE"))
759            .quantity(Quantity::from(10))
760            .trigger_price(Price::new(100.0, 2))
761            .build();
762        let mut accepted_order = TestOrderStubs::make_accepted_order(&order);
763        let state = (
764            accepted_order.status(),
765            accepted_order.previous_status(),
766            accepted_order.ts_last(),
767            accepted_order.events().len(),
768        );
769        let event = OrderUpdated {
770            client_order_id: accepted_order.client_order_id(),
771            strategy_id: accepted_order.strategy_id(),
772            price: Some(Price::new(95.0, 2)),
773            ..Default::default()
774        };
775
776        let result = accepted_order.apply(OrderEventAny::Updated(event));
777
778        assert!(matches!(result, Err(OrderError::InvalidOrderEvent)));
779        assert_eq!(accepted_order.status(), state.0);
780        assert_eq!(accepted_order.previous_status(), state.1);
781        assert_eq!(accepted_order.ts_last(), state.2);
782        assert_eq!(accepted_order.events().len(), state.3);
783    }
784
785    #[rstest]
786    fn test_stop_market_order_expire_time() {
787        // Create a stop market order with an expire time
788        let expire_time = UnixNanos::from(1_234_567_890);
789        let order = OrderTestBuilder::new(OrderType::StopMarket)
790            .instrument_id(InstrumentId::from("BTC-USDT.BINANCE"))
791            .quantity(Quantity::from(10))
792            .trigger_price(Price::new(100.0, 2))
793            .expire_time(expire_time)
794            .build();
795
796        // Assert that the expire time is set correctly
797        assert_eq!(order.expire_time(), Some(expire_time));
798    }
799
800    #[rstest]
801    fn test_stop_market_order_trigger_instrument_id() {
802        // Create a stop market order with a trigger instrument ID
803        let trigger_instrument_id = InstrumentId::from("ETH-USDT.BINANCE");
804        let order = OrderTestBuilder::new(OrderType::StopMarket)
805            .instrument_id(InstrumentId::from("BTC-USDT.BINANCE"))
806            .quantity(Quantity::from(10))
807            .trigger_price(Price::new(100.0, 2))
808            .trigger_instrument_id(trigger_instrument_id)
809            .build();
810
811        // Assert that the trigger instrument ID is set correctly
812        assert_eq!(order.trigger_instrument_id(), Some(trigger_instrument_id));
813    }
814
815    #[rstest]
816    fn test_stop_market_order_from_order_initialized() {
817        // Create an OrderInitialized event with required fields
818        let order_initialized = OrderInitializedSpec::builder()
819            .order_type(OrderType::StopMarket)
820            .quantity(Quantity::from(10))
821            .trigger_price(Price::new(100.0, 2))
822            .trigger_type(TriggerType::Default)
823            .build();
824
825        // Convert the OrderInitialized event into a StopMarketOrder
826        let order: StopMarketOrder = order_initialized.clone().try_into().unwrap();
827
828        // Assert fields match the OrderInitialized event
829        assert_eq!(order.trader_id(), order_initialized.trader_id);
830        assert_eq!(order.strategy_id(), order_initialized.strategy_id);
831        assert_eq!(order.instrument_id(), order_initialized.instrument_id);
832        assert_eq!(order.client_order_id(), order_initialized.client_order_id);
833        assert_eq!(order.quantity(), order_initialized.quantity);
834        assert_eq!(order.trigger_price(), order_initialized.trigger_price);
835        assert_eq!(order.trigger_type(), order_initialized.trigger_type);
836    }
837
838    #[rstest]
839    fn test_stop_market_order_is_triggered() {
840        // Create a stop market order
841        let order = OrderTestBuilder::new(OrderType::StopMarket)
842            .instrument_id(InstrumentId::from("BTC-USDT.BINANCE"))
843            .quantity(Quantity::from(10))
844            .trigger_price(Price::new(100.0, 2))
845            .build();
846
847        // Assert that the is_triggered flag is initially false
848        assert_eq!(order.is_triggered(), Some(false));
849    }
850
851    #[rstest]
852    fn test_stop_market_order_protection_price_update() {
853        // Create and accept a basic stop market order
854        let order = OrderTestBuilder::new(OrderType::StopMarket)
855            .instrument_id(InstrumentId::from("BTC-USDT.BINANCE"))
856            .quantity(Quantity::from(10))
857            .trigger_price(Price::new(100.0, 2))
858            .build();
859
860        let mut accepted_order = TestOrderStubs::make_accepted_order(&order);
861
862        // Update with new values
863        let calculated_protection_price = Price::new(95.0, 2);
864
865        let event = OrderUpdated {
866            client_order_id: accepted_order.client_order_id(),
867            strategy_id: accepted_order.strategy_id(),
868            protection_price: Some(calculated_protection_price),
869            ..Default::default()
870        };
871
872        assert_eq!(accepted_order.price(), None);
873        assert!(!accepted_order.has_price());
874
875        accepted_order.apply(OrderEventAny::Updated(event)).unwrap();
876
877        // Verify updates were applied correctly
878        assert_eq!(accepted_order.price(), Some(calculated_protection_price));
879        assert!(accepted_order.has_price());
880    }
881
882    #[rstest]
883    fn test_stop_market_order_update_preserves_protection_price_when_omitted() {
884        let order = OrderTestBuilder::new(OrderType::StopMarket)
885            .instrument_id(InstrumentId::from("BTC-USDT.BINANCE"))
886            .quantity(Quantity::from(10))
887            .trigger_price(Price::new(100.0, 2))
888            .build();
889        let mut accepted_order = TestOrderStubs::make_accepted_order(&order);
890        let protection_price = Price::new(95.0, 2);
891
892        let set_protection_event = OrderUpdated {
893            client_order_id: accepted_order.client_order_id(),
894            strategy_id: accepted_order.strategy_id(),
895            quantity: accepted_order.quantity(),
896            protection_price: Some(protection_price),
897            ..Default::default()
898        };
899        accepted_order
900            .apply(OrderEventAny::Updated(set_protection_event))
901            .unwrap();
902
903        let updated_quantity = Quantity::from(5);
904        let updated_trigger_price = Price::new(105.0, 2);
905        let omitted_protection_event = OrderUpdated {
906            client_order_id: accepted_order.client_order_id(),
907            strategy_id: accepted_order.strategy_id(),
908            quantity: updated_quantity,
909            trigger_price: Some(updated_trigger_price),
910            protection_price: None,
911            ..Default::default()
912        };
913        accepted_order
914            .apply(OrderEventAny::Updated(omitted_protection_event))
915            .unwrap();
916
917        assert_eq!(accepted_order.quantity(), updated_quantity);
918        assert_eq!(accepted_order.trigger_price(), Some(updated_trigger_price));
919        assert_eq!(accepted_order.price(), Some(protection_price));
920        assert!(accepted_order.has_price());
921
922        let updated_protection_price = Price::new(90.0, 2);
923        let overwrite_protection_event = OrderUpdated {
924            client_order_id: accepted_order.client_order_id(),
925            strategy_id: accepted_order.strategy_id(),
926            quantity: accepted_order.quantity(),
927            protection_price: Some(updated_protection_price),
928            ..Default::default()
929        };
930        accepted_order
931            .apply(OrderEventAny::Updated(overwrite_protection_event))
932            .unwrap();
933
934        assert_eq!(accepted_order.price(), Some(updated_protection_price));
935        assert!(accepted_order.has_price());
936    }
937}
nautilus_model/orders/stop_market.rs

nautilus_model/orders/
stop_market.rs
