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, check_display_qty, check_time_in_force};
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,
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", from_py_object)
46)]
47#[cfg_attr(
48 feature = "python",
49 pyo3_stub_gen::derive::gen_stub_pyclass(module = "nautilus_trader.model")
50)]
51pub struct MarketToLimitOrder {
52 core: OrderCore,
53 pub price: Option<Price>,
54 pub expire_time: Option<UnixNanos>,
55 pub is_post_only: bool,
56 pub display_qty: Option<Quantity>,
57}
58
59impl MarketToLimitOrder {
60 #[expect(clippy::too_many_arguments)]
69 pub fn new_checked(
70 trader_id: TraderId,
71 strategy_id: StrategyId,
72 instrument_id: InstrumentId,
73 client_order_id: ClientOrderId,
74 order_side: OrderSide,
75 quantity: Quantity,
76 time_in_force: TimeInForce,
77 expire_time: Option<UnixNanos>,
78 post_only: bool,
79 reduce_only: bool,
80 quote_quantity: bool,
81 display_qty: Option<Quantity>,
82 contingency_type: Option<ContingencyType>,
83 order_list_id: Option<OrderListId>,
84 linked_order_ids: Option<Vec<ClientOrderId>>,
85 parent_order_id: Option<ClientOrderId>,
86 exec_algorithm_id: Option<ExecAlgorithmId>,
87 exec_algorithm_params: Option<IndexMap<Ustr, Ustr>>,
88 exec_spawn_id: Option<ClientOrderId>,
89 tags: Option<Vec<Ustr>>,
90 init_id: UUID4,
91 ts_init: UnixNanos,
92 ) -> Result<Self, OrderError> {
93 check_positive_quantity(quantity, stringify!(quantity))?;
94 check_display_qty(display_qty, quantity)?;
95 check_time_in_force(time_in_force, expire_time)?;
96
97 let init_order = OrderInitialized::new(
98 trader_id,
99 strategy_id,
100 instrument_id,
101 client_order_id,
102 order_side,
103 OrderType::MarketToLimit,
104 quantity,
105 time_in_force,
106 post_only,
107 reduce_only,
108 quote_quantity,
109 false,
110 init_id,
111 ts_init,
112 ts_init,
113 None,
114 None,
115 None,
116 None,
117 None,
118 None,
119 expire_time,
120 display_qty,
121 Some(TriggerType::NoTrigger),
122 None,
123 contingency_type,
124 order_list_id,
125 linked_order_ids,
126 parent_order_id,
127 exec_algorithm_id,
128 exec_algorithm_params,
129 exec_spawn_id,
130 tags,
131 );
132
133 Ok(Self {
134 core: OrderCore::new(init_order),
135 price: None, expire_time,
137 is_post_only: post_only,
138 display_qty,
139 })
140 }
141
142 #[expect(clippy::too_many_arguments)]
148 #[must_use]
149 pub fn new(
150 trader_id: TraderId,
151 strategy_id: StrategyId,
152 instrument_id: InstrumentId,
153 client_order_id: ClientOrderId,
154 order_side: OrderSide,
155 quantity: Quantity,
156 time_in_force: TimeInForce,
157 expire_time: Option<UnixNanos>,
158 post_only: bool,
159 reduce_only: bool,
160 quote_quantity: bool,
161 display_qty: Option<Quantity>,
162 contingency_type: Option<ContingencyType>,
163 order_list_id: Option<OrderListId>,
164 linked_order_ids: Option<Vec<ClientOrderId>>,
165 parent_order_id: Option<ClientOrderId>,
166 exec_algorithm_id: Option<ExecAlgorithmId>,
167 exec_algorithm_params: Option<IndexMap<Ustr, Ustr>>,
168 exec_spawn_id: Option<ClientOrderId>,
169 tags: Option<Vec<Ustr>>,
170 init_id: UUID4,
171 ts_init: UnixNanos,
172 ) -> Self {
173 Self::new_checked(
174 trader_id,
175 strategy_id,
176 instrument_id,
177 client_order_id,
178 order_side,
179 quantity,
180 time_in_force,
181 expire_time,
182 post_only,
183 reduce_only,
184 quote_quantity,
185 display_qty,
186 contingency_type,
187 order_list_id,
188 linked_order_ids,
189 parent_order_id,
190 exec_algorithm_id,
191 exec_algorithm_params,
192 exec_spawn_id,
193 tags,
194 init_id,
195 ts_init,
196 )
197 .unwrap_or_else(|e| panic!("{FAILED}: {e}"))
198 }
199}
200
201impl PartialEq for MarketToLimitOrder {
202 fn eq(&self, other: &Self) -> bool {
203 self.client_order_id == other.client_order_id
204 }
205}
206
207impl Deref for MarketToLimitOrder {
208 type Target = OrderCore;
209
210 fn deref(&self) -> &Self::Target {
211 &self.core
212 }
213}
214
215impl DerefMut for MarketToLimitOrder {
216 fn deref_mut(&mut self) -> &mut Self::Target {
217 &mut self.core
218 }
219}
220
221impl Order for MarketToLimitOrder {
222 fn into_any(self) -> OrderAny {
223 OrderAny::MarketToLimit(self)
224 }
225
226 fn status(&self) -> OrderStatus {
227 self.status
228 }
229
230 fn trader_id(&self) -> TraderId {
231 self.trader_id
232 }
233
234 fn strategy_id(&self) -> StrategyId {
235 self.strategy_id
236 }
237
238 fn instrument_id(&self) -> InstrumentId {
239 self.instrument_id
240 }
241
242 fn symbol(&self) -> Symbol {
243 self.instrument_id.symbol
244 }
245
246 fn venue(&self) -> Venue {
247 self.instrument_id.venue
248 }
249
250 fn client_order_id(&self) -> ClientOrderId {
251 self.client_order_id
252 }
253
254 fn venue_order_id(&self) -> Option<VenueOrderId> {
255 self.venue_order_id
256 }
257
258 fn position_id(&self) -> Option<PositionId> {
259 self.position_id
260 }
261
262 fn account_id(&self) -> Option<AccountId> {
263 self.account_id
264 }
265
266 fn last_trade_id(&self) -> Option<TradeId> {
267 self.last_trade_id
268 }
269
270 fn order_side(&self) -> OrderSide {
271 self.side
272 }
273
274 fn order_type(&self) -> OrderType {
275 self.order_type
276 }
277
278 fn quantity(&self) -> Quantity {
279 self.quantity
280 }
281
282 fn time_in_force(&self) -> TimeInForce {
283 self.time_in_force
284 }
285
286 fn expire_time(&self) -> Option<UnixNanos> {
287 self.expire_time
288 }
289
290 fn price(&self) -> Option<Price> {
291 self.price
292 }
293
294 fn trigger_price(&self) -> Option<Price> {
295 None
296 }
297
298 fn trigger_type(&self) -> Option<TriggerType> {
299 None
300 }
301
302 fn liquidity_side(&self) -> Option<LiquiditySide> {
303 self.liquidity_side
304 }
305
306 fn is_post_only(&self) -> bool {
307 self.is_post_only
308 }
309
310 fn is_reduce_only(&self) -> bool {
311 self.is_reduce_only
312 }
313
314 fn is_quote_quantity(&self) -> bool {
315 self.is_quote_quantity
316 }
317
318 fn has_price(&self) -> bool {
319 self.price.is_some()
320 }
321
322 fn display_qty(&self) -> Option<Quantity> {
323 self.display_qty
324 }
325
326 fn limit_offset(&self) -> Option<Decimal> {
327 None
328 }
329
330 fn trailing_offset(&self) -> Option<Decimal> {
331 None
332 }
333
334 fn trailing_offset_type(&self) -> Option<TrailingOffsetType> {
335 None
336 }
337
338 fn emulation_trigger(&self) -> Option<TriggerType> {
339 None
340 }
341
342 fn trigger_instrument_id(&self) -> Option<InstrumentId> {
343 None
344 }
345
346 fn contingency_type(&self) -> Option<ContingencyType> {
347 self.contingency_type
348 }
349
350 fn order_list_id(&self) -> Option<OrderListId> {
351 self.order_list_id
352 }
353
354 fn linked_order_ids(&self) -> Option<&[ClientOrderId]> {
355 self.linked_order_ids.as_deref()
356 }
357
358 fn parent_order_id(&self) -> Option<ClientOrderId> {
359 self.parent_order_id
360 }
361
362 fn exec_algorithm_id(&self) -> Option<ExecAlgorithmId> {
363 self.exec_algorithm_id
364 }
365
366 fn exec_algorithm_params(&self) -> Option<&IndexMap<Ustr, Ustr>> {
367 self.exec_algorithm_params.as_ref()
368 }
369
370 fn exec_spawn_id(&self) -> Option<ClientOrderId> {
371 self.exec_spawn_id
372 }
373
374 fn tags(&self) -> Option<&[Ustr]> {
375 self.tags.as_deref()
376 }
377
378 fn filled_qty(&self) -> Quantity {
379 self.filled_qty
380 }
381
382 fn leaves_qty(&self) -> Quantity {
383 self.leaves_qty
384 }
385
386 fn overfill_qty(&self) -> Quantity {
387 self.overfill_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 let is_order_filled = matches!(event, OrderEventAny::Filled(_));
440
441 self.core.apply(event.clone())?;
442
443 if let OrderEventAny::Updated(ref event) = event {
444 self.update(event);
445 }
446
447 if is_order_filled && let Some(price) = self.price {
448 self.core.set_slippage(price);
449 }
450
451 Ok(())
452 }
453
454 fn update(&mut self, event: &OrderUpdated) {
455 assert!(
456 event.trigger_price.is_none(),
457 "{}",
458 OrderError::InvalidOrderEvent
459 );
460
461 if let Some(price) = event.price {
462 self.price = Some(price);
463 }
464
465 self.quantity = event.quantity;
466 self.leaves_qty = self.quantity.saturating_sub(self.filled_qty);
467 }
468
469 fn is_triggered(&self) -> Option<bool> {
470 None
471 }
472
473 fn set_position_id(&mut self, position_id: Option<PositionId>) {
474 self.position_id = position_id;
475 }
476
477 fn set_quantity(&mut self, quantity: Quantity) {
478 self.quantity = quantity;
479 }
480
481 fn set_leaves_qty(&mut self, leaves_qty: Quantity) {
482 self.leaves_qty = leaves_qty;
483 }
484
485 fn set_emulation_trigger(&mut self, emulation_trigger: Option<TriggerType>) {
486 self.emulation_trigger = emulation_trigger;
487 }
488
489 fn set_is_quote_quantity(&mut self, is_quote_quantity: bool) {
490 self.is_quote_quantity = is_quote_quantity;
491 }
492
493 fn set_liquidity_side(&mut self, liquidity_side: LiquiditySide) {
494 self.liquidity_side = Some(liquidity_side);
495 }
496
497 fn would_reduce_only(&self, side: PositionSide, position_qty: Quantity) -> bool {
498 self.core.would_reduce_only(side, position_qty)
499 }
500
501 fn previous_status(&self) -> Option<OrderStatus> {
502 self.core.previous_status
503 }
504}
505
506impl Display for MarketToLimitOrder {
507 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
508 write!(
509 f,
510 "MarketToLimitOrder(\
511 {} {} {} {} {}, \
512 status={}, \
513 client_order_id={}, \
514 venue_order_id={}, \
515 position_id={}, \
516 exec_algorithm_id={}, \
517 exec_spawn_id={}, \
518 tags={:?}\
519 )",
520 self.side,
521 self.quantity.to_formatted_string(),
522 self.instrument_id,
523 self.order_type,
524 self.time_in_force,
525 self.status,
526 self.client_order_id,
527 self.venue_order_id.map_or_else(
528 || "None".to_string(),
529 |venue_order_id| format!("{venue_order_id}")
530 ),
531 self.position_id.map_or_else(
532 || "None".to_string(),
533 |position_id| format!("{position_id}")
534 ),
535 self.exec_algorithm_id
536 .map_or_else(|| "None".to_string(), |id| format!("{id}")),
537 self.exec_spawn_id
538 .map_or_else(|| "None".to_string(), |id| format!("{id}")),
539 self.tags
540 )
541 }
542}
543
544impl TryFrom<OrderInitialized> for MarketToLimitOrder {
545 type Error = OrderError;
546
547 fn try_from(event: OrderInitialized) -> Result<Self, Self::Error> {
548 Self::new_checked(
549 event.trader_id,
550 event.strategy_id,
551 event.instrument_id,
552 event.client_order_id,
553 event.order_side,
554 event.quantity,
555 event.time_in_force,
556 event.expire_time,
557 event.post_only,
558 event.reduce_only,
559 event.quote_quantity,
560 event.display_qty,
561 event.contingency_type,
562 event.order_list_id,
563 event.linked_order_ids,
564 event.parent_order_id,
565 event.exec_algorithm_id,
566 event.exec_algorithm_params,
567 event.exec_spawn_id,
568 event.tags,
569 event.event_id,
570 event.ts_event,
571 )
572 }
573}
574
575#[cfg(test)]
576mod tests {
577 use rstest::rstest;
578
579 use super::*;
580 use crate::{
581 enums::{OrderSide, OrderType, TimeInForce},
582 events::order::spec::{OrderFilledSpec, OrderInitializedSpec},
583 identifiers::{InstrumentId, TradeId, VenueOrderId},
584 instruments::{CurrencyPair, stubs::*},
585 orders::{builder::OrderTestBuilder, stubs::TestOrderStubs},
586 types::{Price, Quantity},
587 };
588
589 #[rstest]
590 fn test_initialize(audusd_sim: CurrencyPair) {
591 let order = OrderTestBuilder::new(OrderType::MarketToLimit)
592 .instrument_id(audusd_sim.id)
593 .side(OrderSide::Buy)
594 .price(Price::from("0.68000"))
595 .quantity(Quantity::from(1))
596 .build();
597
598 assert_eq!(order.price(), None);
599 assert_eq!(order.is_triggered(), None);
600 assert_eq!(order.time_in_force(), TimeInForce::Gtc);
601 assert_eq!(order.is_triggered(), None);
602 assert_eq!(order.filled_qty(), Quantity::from(0));
603 assert_eq!(order.leaves_qty(), Quantity::from(1));
604 assert_eq!(order.trigger_instrument_id(), None);
605 assert_eq!(order.order_list_id(), None);
606 }
607
608 #[rstest]
609 fn test_display(audusd_sim: CurrencyPair) {
610 let order = OrderTestBuilder::new(OrderType::MarketToLimit)
611 .instrument_id(audusd_sim.id)
612 .side(OrderSide::Buy)
613 .quantity(Quantity::from(1))
614 .build();
615
616 assert_eq!(
617 order.to_string(),
618 "MarketToLimitOrder(BUY 1 AUD/USD.SIM MARKET_TO_LIMIT 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)"
619 );
620 }
621
622 #[rstest]
623 #[should_panic(
624 expected = "Condition failed: invalid `Quantity` for 'quantity' not positive, was 0"
625 )]
626 fn test_quantity_zero(audusd_sim: CurrencyPair) {
627 let _ = OrderTestBuilder::new(OrderType::MarketToLimit)
628 .instrument_id(audusd_sim.id)
629 .side(OrderSide::Buy)
630 .quantity(Quantity::from(0))
631 .build();
632 }
633
634 #[rstest]
635 #[should_panic(expected = "Condition failed: `expire_time` is required for `GTD` order")]
636 fn test_gtd_without_expire(audusd_sim: CurrencyPair) {
637 let _ = OrderTestBuilder::new(OrderType::MarketToLimit)
638 .instrument_id(audusd_sim.id)
639 .side(OrderSide::Buy)
640 .quantity(Quantity::from(1))
641 .time_in_force(TimeInForce::Gtd) .build();
643 }
644
645 #[rstest]
646 #[should_panic(expected = "`display_qty` may not exceed `quantity`")]
647 fn test_display_qty_gt_quantity(audusd_sim: CurrencyPair) {
648 let _ = OrderTestBuilder::new(OrderType::MarketToLimit)
649 .instrument_id(audusd_sim.id)
650 .side(OrderSide::Buy)
651 .quantity(Quantity::from(1))
652 .display_qty(Quantity::from(2)) .build();
654 }
655
656 #[rstest]
657 fn test_market_to_limit_order_update() {
658 let order = OrderTestBuilder::new(OrderType::MarketToLimit)
660 .instrument_id(InstrumentId::from("BTC-USDT.BINANCE"))
661 .quantity(Quantity::from(10))
662 .build();
663
664 let mut accepted_order = TestOrderStubs::make_accepted_order(&order);
665
666 let updated_price = Price::new(95.0, 2);
668 let updated_quantity = Quantity::from(5);
669
670 let event = OrderUpdated {
671 client_order_id: accepted_order.client_order_id(),
672 strategy_id: accepted_order.strategy_id(),
673 price: Some(updated_price),
674 quantity: updated_quantity,
675 ..Default::default()
676 };
677
678 accepted_order.apply(OrderEventAny::Updated(event)).unwrap();
679
680 assert_eq!(accepted_order.quantity(), updated_quantity);
682 assert_eq!(accepted_order.price(), Some(updated_price));
683 }
684
685 #[rstest]
686 fn test_market_to_limit_order_expire_time() {
687 let expire_time = UnixNanos::from(1_234_567_890);
689 let order = OrderTestBuilder::new(OrderType::MarketToLimit)
690 .instrument_id(InstrumentId::from("BTC-USDT.BINANCE"))
691 .quantity(Quantity::from(10))
692 .expire_time(expire_time)
693 .build();
694
695 assert_eq!(order.expire_time(), Some(expire_time));
697 }
698
699 #[rstest]
700 fn test_market_to_limit_order_from_order_initialized() {
701 let order_initialized = OrderInitializedSpec::builder()
703 .order_type(OrderType::MarketToLimit)
704 .build();
705
706 let order: MarketToLimitOrder = order_initialized.clone().try_into().unwrap();
708
709 assert_eq!(order.trader_id(), order_initialized.trader_id);
711 assert_eq!(order.strategy_id(), order_initialized.strategy_id);
712 assert_eq!(order.instrument_id(), order_initialized.instrument_id);
713 assert_eq!(order.client_order_id(), order_initialized.client_order_id);
714 assert_eq!(order.order_side(), order_initialized.order_side);
715 assert_eq!(order.quantity(), order_initialized.quantity);
716 }
717
718 #[rstest]
719 fn test_market_to_limit_order_sets_slippage_when_filled() {
720 let order = OrderTestBuilder::new(OrderType::MarketToLimit)
722 .instrument_id(InstrumentId::from("BTC-USDT.BINANCE"))
723 .quantity(Quantity::from(10))
724 .side(OrderSide::Buy)
725 .build();
726
727 let mut accepted_order = TestOrderStubs::make_accepted_order(&order);
729
730 let price = Price::new(90.0, 2);
732 let update_event = OrderUpdated {
733 client_order_id: accepted_order.client_order_id(),
734 strategy_id: accepted_order.strategy_id(),
735 price: Some(price),
736 quantity: accepted_order.quantity(),
737 ..Default::default()
738 };
739
740 accepted_order
742 .apply(OrderEventAny::Updated(update_event))
743 .unwrap();
744
745 assert_eq!(accepted_order.price(), Some(price));
747
748 let fill_quantity = accepted_order.quantity();
750 let fill_price = Price::new(98.50, 2);
751
752 let order_filled_event = OrderFilledSpec::builder()
753 .client_order_id(accepted_order.client_order_id())
754 .strategy_id(accepted_order.strategy_id())
755 .instrument_id(accepted_order.instrument_id())
756 .order_side(accepted_order.order_side())
757 .last_qty(fill_quantity)
758 .last_px(fill_price)
759 .venue_order_id(VenueOrderId::from("TEST-001"))
760 .trade_id(TradeId::from("TRADE-001"))
761 .build();
762
763 accepted_order
765 .apply(OrderEventAny::Filled(order_filled_event))
766 .unwrap();
767
768 assert!(accepted_order.slippage().is_some());
770
771 assert_eq!(accepted_order.slippage().unwrap(), 8.50);
774 }
775}