1use std::{
17 fmt::Display,
18 ops::{Deref, DerefMut},
19};
20
21use indexmap::IndexMap;
22use nautilus_core::{UUID4, UnixNanos, correctness::FAILED};
23use rust_decimal::Decimal;
24use serde::{Deserialize, Serialize};
25use ustr::Ustr;
26
27use super::{Order, OrderAny, OrderCore};
28use crate::{
29 enums::{
30 ContingencyType, LiquiditySide, OrderSide, OrderStatus, OrderType, PositionSide,
31 TimeInForce, TrailingOffsetType, TriggerType,
32 },
33 events::{OrderEventAny, OrderInitialized, OrderUpdated},
34 identifiers::{
35 AccountId, ClientOrderId, ExecAlgorithmId, InstrumentId, OrderListId, PositionId,
36 StrategyId, Symbol, TradeId, TraderId, Venue, VenueOrderId,
37 },
38 orders::{OrderError, check_display_qty, check_time_in_force},
39 types::{Currency, Money, Price, Quantity, quantity::check_positive_quantity},
40};
41
42#[derive(Clone, Debug, Serialize, Deserialize)]
43#[cfg_attr(
44 feature = "python",
45 pyo3::pyclass(module = "nautilus_trader.core.nautilus_pyo3.model")
46)]
47pub struct StopMarketOrder {
48 pub trigger_price: Price,
49 pub trigger_type: TriggerType,
50 pub expire_time: Option<UnixNanos>,
51 pub display_qty: Option<Quantity>,
52 pub trigger_instrument_id: Option<InstrumentId>,
53 pub is_triggered: bool,
54 pub ts_triggered: Option<UnixNanos>,
55 core: OrderCore,
56}
57
58impl StopMarketOrder {
59 #[allow(clippy::too_many_arguments)]
68 pub fn new_checked(
69 trader_id: TraderId,
70 strategy_id: StrategyId,
71 instrument_id: InstrumentId,
72 client_order_id: ClientOrderId,
73 order_side: OrderSide,
74 quantity: Quantity,
75 trigger_price: Price,
76 trigger_type: TriggerType,
77 time_in_force: TimeInForce,
78 expire_time: Option<UnixNanos>,
79 reduce_only: bool,
80 quote_quantity: bool,
81 display_qty: Option<Quantity>,
82 emulation_trigger: Option<TriggerType>,
83 trigger_instrument_id: Option<InstrumentId>,
84 contingency_type: Option<ContingencyType>,
85 order_list_id: Option<OrderListId>,
86 linked_order_ids: Option<Vec<ClientOrderId>>,
87 parent_order_id: Option<ClientOrderId>,
88 exec_algorithm_id: Option<ExecAlgorithmId>,
89 exec_algorithm_params: Option<IndexMap<Ustr, Ustr>>,
90 exec_spawn_id: Option<ClientOrderId>,
91 tags: Option<Vec<Ustr>>,
92 init_id: UUID4,
93 ts_init: UnixNanos,
94 ) -> anyhow::Result<Self> {
95 check_positive_quantity(quantity, stringify!(quantity))?;
96 check_display_qty(display_qty, quantity)?;
97 check_time_in_force(time_in_force, expire_time)?;
98
99 let init_order = OrderInitialized::new(
100 trader_id,
101 strategy_id,
102 instrument_id,
103 client_order_id,
104 order_side,
105 OrderType::StopMarket,
106 quantity,
107 time_in_force,
108 false,
109 reduce_only,
110 quote_quantity,
111 false,
112 init_id,
113 ts_init,
114 ts_init,
115 None,
116 Some(trigger_price),
117 Some(trigger_type),
118 None,
119 None,
120 None,
121 expire_time,
122 display_qty,
123 emulation_trigger,
124 trigger_instrument_id,
125 contingency_type,
126 order_list_id,
127 linked_order_ids,
128 parent_order_id,
129 exec_algorithm_id,
130 exec_algorithm_params,
131 exec_spawn_id,
132 tags,
133 );
134
135 Ok(Self {
136 core: OrderCore::new(init_order),
137 trigger_price,
138 trigger_type,
139 expire_time,
140 display_qty,
141 trigger_instrument_id,
142 is_triggered: false,
143 ts_triggered: None,
144 })
145 }
146
147 #[allow(clippy::too_many_arguments)]
153 pub fn new(
154 trader_id: TraderId,
155 strategy_id: StrategyId,
156 instrument_id: InstrumentId,
157 client_order_id: ClientOrderId,
158 order_side: OrderSide,
159 quantity: Quantity,
160 trigger_price: Price,
161 trigger_type: TriggerType,
162 time_in_force: TimeInForce,
163 expire_time: Option<UnixNanos>,
164 reduce_only: bool,
165 quote_quantity: bool,
166 display_qty: Option<Quantity>,
167 emulation_trigger: Option<TriggerType>,
168 trigger_instrument_id: Option<InstrumentId>,
169 contingency_type: Option<ContingencyType>,
170 order_list_id: Option<OrderListId>,
171 linked_order_ids: Option<Vec<ClientOrderId>>,
172 parent_order_id: Option<ClientOrderId>,
173 exec_algorithm_id: Option<ExecAlgorithmId>,
174 exec_algorithm_params: Option<IndexMap<Ustr, Ustr>>,
175 exec_spawn_id: Option<ClientOrderId>,
176 tags: Option<Vec<Ustr>>,
177 init_id: UUID4,
178 ts_init: UnixNanos,
179 ) -> Self {
180 Self::new_checked(
181 trader_id,
182 strategy_id,
183 instrument_id,
184 client_order_id,
185 order_side,
186 quantity,
187 trigger_price,
188 trigger_type,
189 time_in_force,
190 expire_time,
191 reduce_only,
192 quote_quantity,
193 display_qty,
194 emulation_trigger,
195 trigger_instrument_id,
196 contingency_type,
197 order_list_id,
198 linked_order_ids,
199 parent_order_id,
200 exec_algorithm_id,
201 exec_algorithm_params,
202 exec_spawn_id,
203 tags,
204 init_id,
205 ts_init,
206 )
207 .expect(FAILED)
208 }
209}
210
211impl Deref for StopMarketOrder {
212 type Target = OrderCore;
213
214 fn deref(&self) -> &Self::Target {
215 &self.core
216 }
217}
218
219impl DerefMut for StopMarketOrder {
220 fn deref_mut(&mut self) -> &mut Self::Target {
221 &mut self.core
222 }
223}
224
225impl Order for StopMarketOrder {
226 fn into_any(self) -> OrderAny {
227 OrderAny::StopMarket(self)
228 }
229
230 fn status(&self) -> OrderStatus {
231 self.status
232 }
233
234 fn trader_id(&self) -> TraderId {
235 self.trader_id
236 }
237
238 fn strategy_id(&self) -> StrategyId {
239 self.strategy_id
240 }
241
242 fn instrument_id(&self) -> InstrumentId {
243 self.instrument_id
244 }
245
246 fn symbol(&self) -> Symbol {
247 self.instrument_id.symbol
248 }
249
250 fn venue(&self) -> Venue {
251 self.instrument_id.venue
252 }
253
254 fn client_order_id(&self) -> ClientOrderId {
255 self.client_order_id
256 }
257
258 fn venue_order_id(&self) -> Option<VenueOrderId> {
259 self.venue_order_id
260 }
261
262 fn position_id(&self) -> Option<PositionId> {
263 self.position_id
264 }
265
266 fn account_id(&self) -> Option<AccountId> {
267 self.account_id
268 }
269
270 fn last_trade_id(&self) -> Option<TradeId> {
271 self.last_trade_id
272 }
273
274 fn order_side(&self) -> OrderSide {
275 self.side
276 }
277
278 fn order_type(&self) -> OrderType {
279 self.order_type
280 }
281
282 fn quantity(&self) -> Quantity {
283 self.quantity
284 }
285
286 fn time_in_force(&self) -> TimeInForce {
287 self.time_in_force
288 }
289
290 fn expire_time(&self) -> Option<UnixNanos> {
291 self.expire_time
292 }
293
294 fn price(&self) -> Option<Price> {
295 None
296 }
297
298 fn trigger_price(&self) -> Option<Price> {
299 Some(self.trigger_price)
300 }
301
302 fn trigger_type(&self) -> Option<TriggerType> {
303 Some(self.trigger_type)
304 }
305
306 fn liquidity_side(&self) -> Option<LiquiditySide> {
307 self.liquidity_side
308 }
309
310 fn is_post_only(&self) -> bool {
311 false
312 }
313
314 fn is_reduce_only(&self) -> bool {
315 self.is_reduce_only
316 }
317
318 fn is_quote_quantity(&self) -> bool {
319 self.is_quote_quantity
320 }
321
322 fn has_price(&self) -> bool {
323 false
324 }
325
326 fn display_qty(&self) -> Option<Quantity> {
327 self.display_qty
328 }
329
330 fn limit_offset(&self) -> Option<Decimal> {
331 None
332 }
333
334 fn trailing_offset(&self) -> Option<Decimal> {
335 None
336 }
337
338 fn trailing_offset_type(&self) -> Option<TrailingOffsetType> {
339 None
340 }
341
342 fn emulation_trigger(&self) -> Option<TriggerType> {
343 self.emulation_trigger
344 }
345
346 fn trigger_instrument_id(&self) -> Option<InstrumentId> {
347 self.trigger_instrument_id
348 }
349
350 fn contingency_type(&self) -> Option<ContingencyType> {
351 self.contingency_type
352 }
353
354 fn order_list_id(&self) -> Option<OrderListId> {
355 self.order_list_id
356 }
357
358 fn linked_order_ids(&self) -> Option<&[ClientOrderId]> {
359 self.linked_order_ids.as_deref()
360 }
361
362 fn parent_order_id(&self) -> Option<ClientOrderId> {
363 self.parent_order_id
364 }
365
366 fn exec_algorithm_id(&self) -> Option<ExecAlgorithmId> {
367 self.exec_algorithm_id
368 }
369
370 fn exec_algorithm_params(&self) -> Option<&IndexMap<Ustr, Ustr>> {
371 self.exec_algorithm_params.as_ref()
372 }
373
374 fn exec_spawn_id(&self) -> Option<ClientOrderId> {
375 self.exec_spawn_id
376 }
377
378 fn tags(&self) -> Option<&[Ustr]> {
379 self.tags.as_deref()
380 }
381
382 fn filled_qty(&self) -> Quantity {
383 self.filled_qty
384 }
385
386 fn leaves_qty(&self) -> Quantity {
387 self.leaves_qty
388 }
389
390 fn avg_px(&self) -> Option<f64> {
391 self.avg_px
392 }
393
394 fn slippage(&self) -> Option<f64> {
395 self.slippage
396 }
397
398 fn init_id(&self) -> UUID4 {
399 self.init_id
400 }
401
402 fn ts_init(&self) -> UnixNanos {
403 self.ts_init
404 }
405
406 fn ts_submitted(&self) -> Option<UnixNanos> {
407 self.ts_submitted
408 }
409
410 fn ts_accepted(&self) -> Option<UnixNanos> {
411 self.ts_accepted
412 }
413
414 fn ts_closed(&self) -> Option<UnixNanos> {
415 self.ts_closed
416 }
417
418 fn ts_last(&self) -> UnixNanos {
419 self.ts_last
420 }
421
422 fn events(&self) -> Vec<&OrderEventAny> {
423 self.events.iter().collect()
424 }
425
426 fn venue_order_ids(&self) -> Vec<&VenueOrderId> {
427 self.venue_order_ids.iter().collect()
428 }
429
430 fn trade_ids(&self) -> Vec<&TradeId> {
431 self.trade_ids.iter().collect()
432 }
433
434 fn commissions(&self) -> &IndexMap<Currency, Money> {
435 &self.commissions
436 }
437
438 fn apply(&mut self, event: OrderEventAny) -> Result<(), OrderError> {
439 if let OrderEventAny::Updated(ref event) = event {
440 self.update(event);
441 };
442
443 let is_order_filled = matches!(event, OrderEventAny::Filled(_));
444 let is_order_triggered = matches!(event, OrderEventAny::Triggered(_));
445 let ts_event = if is_order_triggered {
446 Some(event.ts_event())
447 } else {
448 None
449 };
450
451 self.core.apply(event)?;
452
453 if is_order_triggered {
454 self.is_triggered = true;
455 self.ts_triggered = ts_event;
456 }
457
458 if is_order_filled {
459 self.core.set_slippage(self.trigger_price);
460 };
461
462 Ok(())
463 }
464
465 fn update(&mut self, event: &OrderUpdated) {
466 assert!(event.price.is_none(), "{}", OrderError::InvalidOrderEvent);
467
468 if let Some(trigger_price) = event.trigger_price {
469 self.trigger_price = trigger_price;
470 }
471
472 self.quantity = event.quantity;
473 self.leaves_qty = self.quantity.saturating_sub(self.filled_qty);
474 }
475
476 fn is_triggered(&self) -> Option<bool> {
477 Some(self.is_triggered)
478 }
479
480 fn set_position_id(&mut self, position_id: Option<PositionId>) {
481 self.position_id = position_id;
482 }
483
484 fn set_quantity(&mut self, quantity: Quantity) {
485 self.quantity = quantity;
486 }
487
488 fn set_leaves_qty(&mut self, leaves_qty: Quantity) {
489 self.leaves_qty = leaves_qty;
490 }
491
492 fn set_emulation_trigger(&mut self, emulation_trigger: Option<TriggerType>) {
493 self.emulation_trigger = emulation_trigger;
494 }
495
496 fn set_is_quote_quantity(&mut self, is_quote_quantity: bool) {
497 self.is_quote_quantity = is_quote_quantity;
498 }
499
500 fn set_liquidity_side(&mut self, liquidity_side: LiquiditySide) {
501 self.liquidity_side = Some(liquidity_side)
502 }
503
504 fn would_reduce_only(&self, side: PositionSide, position_qty: Quantity) -> bool {
505 self.core.would_reduce_only(side, position_qty)
506 }
507
508 fn previous_status(&self) -> Option<OrderStatus> {
509 self.core.previous_status
510 }
511}
512
513impl Display for StopMarketOrder {
514 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
515 write!(
516 f,
517 "StopMarketOrder(\
518 {} {} {} {} {}, \
519 status={}, \
520 client_order_id={}, \
521 venue_order_id={}, \
522 position_id={}, \
523 exec_algorithm_id={}, \
524 exec_spawn_id={}, \
525 tags={:?}\
526 )",
527 self.side,
528 self.quantity.to_formatted_string(),
529 self.instrument_id,
530 self.order_type,
531 self.time_in_force,
532 self.status,
533 self.client_order_id,
534 self.venue_order_id.map_or_else(
535 || "None".to_string(),
536 |venue_order_id| format!("{venue_order_id}")
537 ),
538 self.position_id.map_or_else(
539 || "None".to_string(),
540 |position_id| format!("{position_id}")
541 ),
542 self.exec_algorithm_id
543 .map_or_else(|| "None".to_string(), |id| format!("{id}")),
544 self.exec_spawn_id
545 .map_or_else(|| "None".to_string(), |id| format!("{id}")),
546 self.tags
547 )
548 }
549}
550
551impl From<OrderInitialized> for StopMarketOrder {
552 fn from(event: OrderInitialized) -> Self {
553 Self::new(
554 event.trader_id,
555 event.strategy_id,
556 event.instrument_id,
557 event.client_order_id,
558 event.order_side,
559 event.quantity,
560 event.trigger_price.expect(
561 "Error initializing order: `trigger_price` was `None` for `StopMarketOrder`",
562 ),
563 event.trigger_type.expect(
564 "Error initializing order: `trigger_type` was `None` for `StopMarketOrder`",
565 ),
566 event.time_in_force,
567 event.expire_time,
568 event.reduce_only,
569 event.quote_quantity,
570 event.display_qty,
571 event.emulation_trigger,
572 event.trigger_instrument_id,
573 event.contingency_type,
574 event.order_list_id,
575 event.linked_order_ids,
576 event.parent_order_id,
577 event.exec_algorithm_id,
578 event.exec_algorithm_params,
579 event.exec_spawn_id,
580 event.tags,
581 event.event_id,
582 event.ts_event,
583 )
584 }
585}
586
587#[cfg(test)]
591mod tests {
592 use rstest::rstest;
593
594 use super::*;
595 use crate::{
596 enums::{TimeInForce, TriggerType},
597 events::order::initialized::OrderInitializedBuilder,
598 identifiers::InstrumentId,
599 instruments::{CurrencyPair, stubs::*},
600 orders::{builder::OrderTestBuilder, stubs::TestOrderStubs},
601 types::{Price, Quantity},
602 };
603
604 #[rstest]
605 fn test_initialize(_audusd_sim: CurrencyPair) {
606 let order = OrderTestBuilder::new(OrderType::StopMarket)
607 .instrument_id(_audusd_sim.id)
608 .side(OrderSide::Buy)
609 .trigger_price(Price::from("0.68000"))
610 .trigger_type(TriggerType::LastPrice)
611 .quantity(Quantity::from(1))
612 .build();
613
614 assert_eq!(order.trigger_price(), Some(Price::from("0.68000")));
615 assert_eq!(order.price(), None);
616
617 assert_eq!(order.time_in_force(), TimeInForce::Gtc);
618
619 assert_eq!(order.is_triggered(), Some(false));
620 assert_eq!(order.filled_qty(), Quantity::from(0));
621 assert_eq!(order.leaves_qty(), Quantity::from(1));
622
623 assert_eq!(order.display_qty(), None);
624 assert_eq!(order.trigger_instrument_id(), None);
625 assert_eq!(order.order_list_id(), None);
626 }
627
628 #[rstest]
629 fn test_display(_audusd_sim: CurrencyPair) {
630 let order = OrderTestBuilder::new(OrderType::StopMarket)
631 .instrument_id(_audusd_sim.id)
632 .side(OrderSide::Buy)
633 .trigger_price(Price::from("0.68000"))
634 .trigger_type(TriggerType::LastPrice)
635 .quantity(Quantity::from(1))
636 .build();
637
638 assert_eq!(
639 order.to_string(),
640 "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)"
641 );
642 }
643
644 #[rstest]
645 #[should_panic(expected = "Condition failed: `display_qty` may not exceed `quantity`")]
646 fn test_display_qty_gt_quantity_err(audusd_sim: CurrencyPair) {
647 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 .display_qty(Quantity::from(2))
654 .build();
655 }
656
657 #[rstest]
658 #[should_panic(
659 expected = "Condition failed: invalid `Quantity` for 'quantity' not positive, was 0"
660 )]
661 fn test_quantity_zero_err(audusd_sim: CurrencyPair) {
662 OrderTestBuilder::new(OrderType::StopMarket)
663 .instrument_id(audusd_sim.id)
664 .side(OrderSide::Buy)
665 .trigger_price(Price::from("0.68000"))
666 .trigger_type(TriggerType::LastPrice)
667 .quantity(Quantity::from(0))
668 .build();
669 }
670
671 #[rstest]
672 #[should_panic(expected = "Condition failed: `expire_time` is required for `GTD` order")]
673 fn test_gtd_without_expire_err(audusd_sim: CurrencyPair) {
674 OrderTestBuilder::new(OrderType::StopMarket)
675 .instrument_id(audusd_sim.id)
676 .side(OrderSide::Buy)
677 .trigger_price(Price::from("0.68000"))
678 .trigger_type(TriggerType::LastPrice)
679 .time_in_force(TimeInForce::Gtd)
680 .quantity(Quantity::from(1))
681 .build();
682 }
683
684 #[rstest]
685 fn test_stop_market_order_update() {
686 let order = OrderTestBuilder::new(OrderType::StopMarket)
688 .instrument_id(InstrumentId::from("BTC-USDT.BINANCE"))
689 .quantity(Quantity::from(10))
690 .trigger_price(Price::new(100.0, 2))
691 .build();
692
693 let mut accepted_order = TestOrderStubs::make_accepted_order(&order);
694
695 let updated_trigger_price = Price::new(95.0, 2);
697 let updated_quantity = Quantity::from(5);
698
699 let event = OrderUpdated {
700 client_order_id: accepted_order.client_order_id(),
701 strategy_id: accepted_order.strategy_id(),
702 trigger_price: Some(updated_trigger_price),
703 quantity: updated_quantity,
704 ..Default::default()
705 };
706
707 accepted_order.apply(OrderEventAny::Updated(event)).unwrap();
708
709 assert_eq!(accepted_order.quantity(), updated_quantity);
711 assert_eq!(accepted_order.trigger_price(), Some(updated_trigger_price));
712 }
713
714 #[rstest]
715 fn test_stop_market_order_expire_time() {
716 let expire_time = UnixNanos::from(1234567890);
718 let order = OrderTestBuilder::new(OrderType::StopMarket)
719 .instrument_id(InstrumentId::from("BTC-USDT.BINANCE"))
720 .quantity(Quantity::from(10))
721 .trigger_price(Price::new(100.0, 2))
722 .expire_time(expire_time)
723 .build();
724
725 assert_eq!(order.expire_time(), Some(expire_time));
727 }
728
729 #[rstest]
730 fn test_stop_market_order_trigger_instrument_id() {
731 let trigger_instrument_id = InstrumentId::from("ETH-USDT.BINANCE");
733 let order = OrderTestBuilder::new(OrderType::StopMarket)
734 .instrument_id(InstrumentId::from("BTC-USDT.BINANCE"))
735 .quantity(Quantity::from(10))
736 .trigger_price(Price::new(100.0, 2))
737 .trigger_instrument_id(trigger_instrument_id)
738 .build();
739
740 assert_eq!(order.trigger_instrument_id(), Some(trigger_instrument_id));
742 }
743
744 #[rstest]
745 fn test_stop_market_order_from_order_initialized() {
746 let order_initialized = OrderInitializedBuilder::default()
748 .order_type(OrderType::StopMarket)
749 .quantity(Quantity::from(10))
750 .trigger_price(Some(Price::new(100.0, 2)))
751 .trigger_type(Some(TriggerType::Default))
752 .build()
753 .unwrap();
754
755 let order: StopMarketOrder = order_initialized.clone().into();
757
758 assert_eq!(order.trader_id(), order_initialized.trader_id);
760 assert_eq!(order.strategy_id(), order_initialized.strategy_id);
761 assert_eq!(order.instrument_id(), order_initialized.instrument_id);
762 assert_eq!(order.client_order_id(), order_initialized.client_order_id);
763 assert_eq!(order.quantity(), order_initialized.quantity);
764 assert_eq!(order.trigger_price(), order_initialized.trigger_price);
765 assert_eq!(order.trigger_type(), order_initialized.trigger_type);
766 }
767
768 #[rstest]
769 fn test_stop_market_order_is_triggered() {
770 let order = OrderTestBuilder::new(OrderType::StopMarket)
772 .instrument_id(InstrumentId::from("BTC-USDT.BINANCE"))
773 .quantity(Quantity::from(10))
774 .trigger_price(Price::new(100.0, 2))
775 .build();
776
777 assert_eq!(order.is_triggered(), Some(false));
779 }
780}