nautilus_trading/examples/strategies/orderbook_imbalance/
config.rs1use nautilus_core::datetime::secs_to_nanos;
19use nautilus_model::{
20 enums::{BookType, TimeInForce},
21 identifiers::{InstrumentId, StrategyId},
22 types::Quantity,
23};
24use rust_decimal::Decimal;
25
26use crate::strategy::StrategyConfig;
27
28#[derive(Debug, Clone, bon::Builder)]
30#[cfg_attr(
31 feature = "python",
32 pyo3::pyclass(module = "nautilus_trader.trading", from_py_object)
33)]
34#[cfg_attr(
35 feature = "python",
36 pyo3_stub_gen::derive::gen_stub_pyclass(module = "nautilus_trader.trading")
37)]
38pub struct OrderBookImbalanceConfig {
39 #[builder(default = StrategyConfig {
41 strategy_id: Some(StrategyId::from("OrderBookImbalance-000")),
42 order_id_tag: Some("000".to_string()),
43 ..Default::default()
44 })]
45 pub base: StrategyConfig,
46 pub instrument_id: InstrumentId,
48 pub max_trade_size: Quantity,
50 #[builder(default = Decimal::from(100))]
52 pub trigger_min_size: Decimal,
53 #[builder(default = Decimal::new(20, 2))]
55 pub trigger_imbalance_ratio: Decimal,
56 #[builder(default = 1.0)]
58 pub min_seconds_between_triggers: f64,
59 #[builder(default = BookType::L2_MBP)]
61 pub book_type: BookType,
62 #[builder(default = TimeInForce::Fok)]
64 pub time_in_force: TimeInForce,
65 #[builder(default)]
67 pub log_interval: u64,
68 #[builder(default)]
70 pub dry_run: bool,
71}
72
73impl OrderBookImbalanceConfig {
74 pub(crate) fn validate(&self) -> anyhow::Result<()> {
75 anyhow::ensure!(
76 matches!(self.time_in_force, TimeInForce::Fok | TimeInForce::Ioc),
77 "time_in_force must be FOK or IOC"
78 );
79 anyhow::ensure!(
80 self.max_trade_size.is_positive(),
81 "max_trade_size must be positive"
82 );
83 anyhow::ensure!(
84 self.trigger_min_size >= Decimal::ZERO,
85 "trigger_min_size must be non-negative"
86 );
87 anyhow::ensure!(
88 self.trigger_imbalance_ratio > Decimal::ZERO
89 && self.trigger_imbalance_ratio < Decimal::ONE,
90 "trigger_imbalance_ratio must be in (0, 1)"
91 );
92 anyhow::ensure!(
93 self.min_seconds_between_triggers >= 0.0
94 && secs_to_nanos(self.min_seconds_between_triggers).is_ok(),
95 "min_seconds_between_triggers must be finite, non-negative, and representable in nanoseconds"
96 );
97 anyhow::ensure!(
98 !self.dry_run
99 || !(self.base.manage_stop
100 || self.base.manage_gtd_expiry
101 || self.base.manage_contingent_orders),
102 "dry_run requires manage_stop, manage_gtd_expiry, and manage_contingent_orders=false"
103 );
104 Ok(())
105 }
106}