nautilus-model 0.55.0

Domain model for the Nautilus trading engine
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
// -------------------------------------------------------------------------------------------------
//  Copyright (C) 2015-2026 Nautech Systems Pty Ltd. All rights reserved.
//  https://nautechsystems.io
//
//  Licensed under the GNU Lesser General Public License Version 3.0 (the "License");
//  You may not use this file except in compliance with the License.
//  You may obtain a copy of the License at https://www.gnu.org/licenses/lgpl-3.0.en.html
//
//  Unless required by applicable law or agreed to in writing, software
//  distributed under the License is distributed on an "AS IS" BASIS,
//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//  See the License for the specific language governing permissions and
//  limitations under the License.
// -------------------------------------------------------------------------------------------------

//! An `OrderBookDeltas` container type to carry a bulk of `OrderBookDelta` records.

use std::{
    fmt::Display,
    hash::{Hash, Hasher},
    ops::{Deref, DerefMut},
};

use nautilus_core::{
    UnixNanos,
    correctness::{FAILED, check_predicate_true},
};
use serde::{Deserialize, Serialize};

use super::{HasTsInit, OrderBookDelta};
use crate::identifiers::InstrumentId;

/// Represents a grouped batch of `OrderBookDelta` updates for an `OrderBook`.
///
/// This type cannot be `repr(C)` due to the `deltas` vec.
#[derive(Clone, Debug, Serialize, Deserialize)]
#[cfg_attr(
    feature = "python",
    pyo3::pyclass(module = "nautilus_trader.core.nautilus_pyo3.model", from_py_object)
)]
#[cfg_attr(
    feature = "python",
    pyo3_stub_gen::derive::gen_stub_pyclass(module = "nautilus_trader.model")
)]
pub struct OrderBookDeltas {
    /// The instrument ID for the book.
    pub instrument_id: InstrumentId,
    /// The order book deltas.
    pub deltas: Vec<OrderBookDelta>,
    /// The record flags bit field, indicating event end and data information.
    pub flags: u8,
    /// The message sequence number assigned at the venue.
    pub sequence: u64,
    /// UNIX timestamp (nanoseconds) when the book event occurred.
    pub ts_event: UnixNanos,
    /// UNIX timestamp (nanoseconds) when the instance was created.
    pub ts_init: UnixNanos,
}

impl OrderBookDeltas {
    /// Creates a new [`OrderBookDeltas`] instance.
    ///
    /// # Panics
    ///
    /// Panics if `deltas` is empty and correctness check fails.
    #[must_use]
    #[allow(clippy::too_many_arguments)]
    pub fn new(instrument_id: InstrumentId, deltas: Vec<OrderBookDelta>) -> Self {
        Self::new_checked(instrument_id, deltas).expect(FAILED)
    }

    /// Creates a new [`OrderBookDeltas`] instance with correctness checking.
    ///
    /// # Notes
    ///
    /// PyO3 requires a `Result` type for proper error handling and stacktrace printing in Python.
    #[allow(clippy::too_many_arguments)]
    /// Creates a new [`OrderBookDeltas`] instance with correctness checking.
    ///
    /// # Errors
    ///
    /// Returns an error if `deltas` is empty.
    #[allow(clippy::missing_panics_doc)] // Guarded by predicate check above
    pub fn new_checked(
        instrument_id: InstrumentId,
        deltas: Vec<OrderBookDelta>,
    ) -> anyhow::Result<Self> {
        check_predicate_true(!deltas.is_empty(), "`deltas` cannot be empty")?;
        let last = deltas.last().expect("deltas not empty");
        let flags = last.flags;
        let sequence = last.sequence;
        let ts_event = last.ts_event;
        let ts_init = last.ts_init;
        Ok(Self {
            instrument_id,
            deltas,
            flags,
            sequence,
            ts_event,
            ts_init,
        })
    }
}

impl PartialEq<Self> for OrderBookDeltas {
    fn eq(&self, other: &Self) -> bool {
        self.instrument_id == other.instrument_id && self.sequence == other.sequence
    }
}

impl Eq for OrderBookDeltas {}

impl Hash for OrderBookDeltas {
    fn hash<H: Hasher>(&self, state: &mut H) {
        self.instrument_id.hash(state);
        self.sequence.hash(state);
    }
}

// TODO: Implement
// impl Serializable for OrderBookDeltas {}

// TODO: Exact format for Debug and Display TBD
impl Display for OrderBookDeltas {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(
            f,
            "{},len={},flags={},sequence={},ts_event={},ts_init={}",
            self.instrument_id,
            self.deltas.len(),
            self.flags,
            self.sequence,
            self.ts_event,
            self.ts_init
        )
    }
}

impl HasTsInit for OrderBookDeltas {
    fn ts_init(&self) -> UnixNanos {
        self.ts_init
    }
}

/// C compatible Foreign Function Interface (FFI) for an underlying [`OrderBookDeltas`].
///
/// This struct wraps `OrderBookDeltas` in a way that makes it compatible with C function
/// calls, enabling interaction with `OrderBookDeltas` in a C environment.
///
/// It implements the `Deref` trait, allowing instances of `OrderBookDeltas_API` to be
/// dereferenced to `OrderBookDeltas`, providing access to `OrderBookDeltas`'s methods without
/// having to manually access the underlying `OrderBookDeltas` instance.
#[repr(C)]
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[allow(non_camel_case_types)]
pub struct OrderBookDeltas_API(Box<OrderBookDeltas>);

// TODO: This wrapper will go along with Cython
impl OrderBookDeltas_API {
    #[must_use]
    pub fn new(deltas: OrderBookDeltas) -> Self {
        Self(Box::new(deltas))
    }

    /// Consumes the wrapper and returns the inner `OrderBookDeltas`.
    #[must_use]
    pub fn into_inner(self) -> OrderBookDeltas {
        *self.0
    }
}

impl Deref for OrderBookDeltas_API {
    type Target = OrderBookDeltas;

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl DerefMut for OrderBookDeltas_API {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.0
    }
}

#[cfg(test)]
mod tests {
    use std::{
        collections::hash_map::DefaultHasher,
        hash::{Hash, Hasher},
    };

    use rstest::rstest;
    use serde_json;

    use super::*;
    use crate::{
        data::{order::BookOrder, stubs::stub_deltas},
        enums::{BookAction, OrderSide},
        types::{Price, Quantity},
    };

    fn create_test_delta() -> OrderBookDelta {
        let instrument_id = InstrumentId::from("EURUSD.SIM");
        OrderBookDelta::new(
            instrument_id,
            BookAction::Add,
            BookOrder::new(
                OrderSide::Buy,
                Price::from("1.0500"),
                Quantity::from("100000"),
                1,
            ),
            0,
            123,
            UnixNanos::from(1_000_000_000),
            UnixNanos::from(2_000_000_000),
        )
    }

    fn create_test_deltas() -> OrderBookDeltas {
        let instrument_id = InstrumentId::from("EURUSD.SIM");
        let flags = 32;
        let sequence = 123;
        let ts_event = UnixNanos::from(1_000_000_000);
        let ts_init = UnixNanos::from(2_000_000_000);

        let delta1 = OrderBookDelta::new(
            instrument_id,
            BookAction::Add,
            BookOrder::new(
                OrderSide::Sell,
                Price::from("1.0520"),
                Quantity::from("50000"),
                1,
            ),
            flags,
            sequence,
            ts_event,
            ts_init,
        );
        let delta2 = OrderBookDelta::new(
            instrument_id,
            BookAction::Add,
            BookOrder::new(
                OrderSide::Buy,
                Price::from("1.0500"),
                Quantity::from("75000"),
                2,
            ),
            flags,
            sequence,
            ts_event,
            ts_init,
        );

        OrderBookDeltas::new(instrument_id, vec![delta1, delta2])
    }

    fn create_test_deltas_multiple() -> OrderBookDeltas {
        let instrument_id = InstrumentId::from("GBPUSD.SIM");
        let flags = 16;
        let sequence = 456;
        let ts_event = UnixNanos::from(3_000_000_000);
        let ts_init = UnixNanos::from(4_000_000_000);

        let deltas = vec![
            OrderBookDelta::clear(instrument_id, sequence, ts_event, ts_init),
            OrderBookDelta::new(
                instrument_id,
                BookAction::Add,
                BookOrder::new(
                    OrderSide::Sell,
                    Price::from("1.2550"),
                    Quantity::from("100000"),
                    1,
                ),
                flags,
                sequence,
                ts_event,
                ts_init,
            ),
            OrderBookDelta::new(
                instrument_id,
                BookAction::Update,
                BookOrder::new(
                    OrderSide::Buy,
                    Price::from("1.2530"),
                    Quantity::from("200000"),
                    2,
                ),
                flags,
                sequence,
                ts_event,
                ts_init,
            ),
            OrderBookDelta::new(
                instrument_id,
                BookAction::Delete,
                BookOrder::new(
                    OrderSide::Sell,
                    Price::from("1.2560"),
                    Quantity::from("0"),
                    3,
                ),
                flags,
                sequence,
                ts_event,
                ts_init,
            ),
        ];

        OrderBookDeltas::new(instrument_id, deltas)
    }

    #[rstest]
    fn test_order_book_deltas_new() {
        let deltas = create_test_deltas();

        assert_eq!(deltas.instrument_id, InstrumentId::from("EURUSD.SIM"));
        assert_eq!(deltas.deltas.len(), 2);
        assert_eq!(deltas.flags, 32);
        assert_eq!(deltas.sequence, 123);
        assert_eq!(deltas.ts_event, UnixNanos::from(1_000_000_000));
        assert_eq!(deltas.ts_init, UnixNanos::from(2_000_000_000));
    }

    #[rstest]
    fn test_order_book_deltas_new_checked_valid() {
        let instrument_id = InstrumentId::from("EURUSD.SIM");
        let delta = create_test_delta();

        let result = OrderBookDeltas::new_checked(instrument_id, vec![delta]);

        assert!(result.is_ok());
        let deltas = result.unwrap();
        assert_eq!(deltas.instrument_id, instrument_id);
        assert_eq!(deltas.deltas.len(), 1);
    }

    #[rstest]
    fn test_order_book_deltas_new_checked_empty_deltas() {
        let instrument_id = InstrumentId::from("EURUSD.SIM");

        let result = OrderBookDeltas::new_checked(instrument_id, vec![]);

        assert!(result.is_err());
        assert!(
            result
                .unwrap_err()
                .to_string()
                .contains("`deltas` cannot be empty")
        );
    }

    #[rstest]
    #[should_panic(expected = "Condition failed")]
    fn test_order_book_deltas_new_empty_deltas_panics() {
        let instrument_id = InstrumentId::from("EURUSD.SIM");
        let _ = OrderBookDeltas::new(instrument_id, vec![]);
    }

    #[rstest]
    fn test_order_book_deltas_uses_last_delta_properties() {
        let instrument_id = InstrumentId::from("EURUSD.SIM");

        let delta1 = OrderBookDelta::new(
            instrument_id,
            BookAction::Add,
            BookOrder::new(
                OrderSide::Buy,
                Price::from("1.0500"),
                Quantity::from("100000"),
                1,
            ),
            16,                             // Different flags
            100,                            // Different sequence
            UnixNanos::from(500_000_000),   // Different ts_event
            UnixNanos::from(1_000_000_000), // Different ts_init
        );

        let delta2 = OrderBookDelta::new(
            instrument_id,
            BookAction::Add,
            BookOrder::new(
                OrderSide::Sell,
                Price::from("1.0520"),
                Quantity::from("50000"),
                2,
            ),
            32,                             // Final flags
            200,                            // Final sequence
            UnixNanos::from(1_500_000_000), // Final ts_event
            UnixNanos::from(2_000_000_000), // Final ts_init
        );

        let deltas = OrderBookDeltas::new(instrument_id, vec![delta1, delta2]);

        // Should use properties from the last delta
        assert_eq!(deltas.flags, 32);
        assert_eq!(deltas.sequence, 200);
        assert_eq!(deltas.ts_event, UnixNanos::from(1_500_000_000));
        assert_eq!(deltas.ts_init, UnixNanos::from(2_000_000_000));
    }

    #[rstest]
    fn test_order_book_deltas_hash_different_objects() {
        let deltas1 = create_test_deltas();
        let deltas2 = create_test_deltas_multiple();

        let mut hasher1 = DefaultHasher::new();
        let mut hasher2 = DefaultHasher::new();

        deltas1.hash(&mut hasher1);
        deltas2.hash(&mut hasher2);

        assert_ne!(hasher1.finish(), hasher2.finish()); // Different objects should have different hashes
    }

    #[rstest]
    fn test_order_book_deltas_hash_uses_instrument_id_and_sequence() {
        let instrument_id = InstrumentId::from("EURUSD.SIM");
        let sequence = 123u64;

        // Create separate hasher to verify what's being hashed
        let mut expected_hasher = DefaultHasher::new();
        instrument_id.hash(&mut expected_hasher);
        sequence.hash(&mut expected_hasher);
        let expected_hash = expected_hasher.finish();

        let delta = OrderBookDelta::new(
            instrument_id,
            BookAction::Add,
            BookOrder::new(
                OrderSide::Buy,
                Price::from("1.0500"),
                Quantity::from("100000"),
                1,
            ),
            0,
            sequence,
            UnixNanos::from(1_000_000_000),
            UnixNanos::from(2_000_000_000),
        );

        let deltas = OrderBookDeltas::new(instrument_id, vec![delta]);

        let mut deltas_hasher = DefaultHasher::new();
        deltas.hash(&mut deltas_hasher);

        assert_eq!(deltas_hasher.finish(), expected_hash);
    }

    #[rstest]
    fn test_order_book_deltas_display() {
        let deltas = create_test_deltas();
        let display_str = format!("{deltas}");

        assert!(display_str.contains("EURUSD.SIM"));
        assert!(display_str.contains("len=2"));
        assert!(display_str.contains("flags=32"));
        assert!(display_str.contains("sequence=123"));
        assert!(display_str.contains("ts_event=1000000000"));
        assert!(display_str.contains("ts_init=2000000000"));
    }

    #[rstest]
    fn test_order_book_deltas_display_format() {
        let deltas = create_test_deltas();
        let expected =
            "EURUSD.SIM,len=2,flags=32,sequence=123,ts_event=1000000000,ts_init=2000000000";

        assert_eq!(format!("{deltas}"), expected);
    }

    #[rstest]
    fn test_order_book_deltas_has_ts_init() {
        let deltas = create_test_deltas();

        assert_eq!(deltas.ts_init(), UnixNanos::from(2_000_000_000));
    }

    #[rstest]
    fn test_order_book_deltas_clone() {
        let deltas1 = create_test_deltas();
        let deltas2 = deltas1.clone();

        assert_eq!(deltas1.instrument_id, deltas2.instrument_id);
        assert_eq!(deltas1.deltas.len(), deltas2.deltas.len());
        assert_eq!(deltas1.flags, deltas2.flags);
        assert_eq!(deltas1.sequence, deltas2.sequence);
        assert_eq!(deltas1.ts_event, deltas2.ts_event);
        assert_eq!(deltas1.ts_init, deltas2.ts_init);
        assert_eq!(deltas1, deltas2);
    }

    #[rstest]
    fn test_order_book_deltas_debug() {
        let deltas = create_test_deltas();
        let debug_str = format!("{deltas:?}");

        assert!(debug_str.contains("OrderBookDeltas"));
        assert!(debug_str.contains("EURUSD.SIM"));
        assert!(debug_str.contains("flags: 32"));
        assert!(debug_str.contains("sequence: 123"));
    }

    #[rstest]
    fn test_order_book_deltas_serialization() {
        let deltas = create_test_deltas();

        // Test JSON serialization
        let json = serde_json::to_string(&deltas).unwrap();
        let deserialized: OrderBookDeltas = serde_json::from_str(&json).unwrap();

        assert_eq!(deltas.instrument_id, deserialized.instrument_id);
        assert_eq!(deltas.deltas.len(), deserialized.deltas.len());
        assert_eq!(deltas.flags, deserialized.flags);
        assert_eq!(deltas.sequence, deserialized.sequence);
        assert_eq!(deltas.ts_event, deserialized.ts_event);
        assert_eq!(deltas.ts_init, deserialized.ts_init);
    }

    #[rstest]
    fn test_order_book_deltas_single_delta() {
        let instrument_id = InstrumentId::from("BTCUSD.CRYPTO");
        let delta = create_test_delta();

        let deltas = OrderBookDeltas::new(instrument_id, vec![delta]);

        assert_eq!(deltas.instrument_id, instrument_id);
        assert_eq!(deltas.deltas.len(), 1);
        assert_eq!(deltas.flags, delta.flags);
        assert_eq!(deltas.sequence, delta.sequence);
        assert_eq!(deltas.ts_event, delta.ts_event);
        assert_eq!(deltas.ts_init, delta.ts_init);
    }

    #[rstest]
    fn test_order_book_deltas_large_number_of_deltas() {
        let instrument_id = InstrumentId::from("ETHUSD.CRYPTO");
        let mut delta_vec = Vec::new();

        // Create 100 deltas
        for i in 0..100 {
            let delta = OrderBookDelta::new(
                instrument_id,
                BookAction::Add,
                BookOrder::new(
                    OrderSide::Buy,
                    Price::from(&format!("1000.{i:02}")),
                    Quantity::from("1000"),
                    i as u64,
                ),
                0,
                i as u64,
                UnixNanos::from(1_000_000_000 + i as u64),
                UnixNanos::from(2_000_000_000 + i as u64),
            );
            delta_vec.push(delta);
        }

        let deltas = OrderBookDeltas::new(instrument_id, delta_vec);

        assert_eq!(deltas.deltas.len(), 100);
        assert_eq!(deltas.sequence, 99); // Last delta's sequence
        assert_eq!(deltas.ts_event, UnixNanos::from(1_000_000_000 + 99));
        assert_eq!(deltas.ts_init, UnixNanos::from(2_000_000_000 + 99));
    }

    #[rstest]
    fn test_order_book_deltas_different_action_types() {
        let deltas = create_test_deltas_multiple();

        assert_eq!(deltas.deltas.len(), 4);

        // Verify different action types are preserved
        assert_eq!(deltas.deltas[0].action, BookAction::Clear);
        assert_eq!(deltas.deltas[1].action, BookAction::Add);
        assert_eq!(deltas.deltas[2].action, BookAction::Update);
        assert_eq!(deltas.deltas[3].action, BookAction::Delete);
    }

    #[rstest]
    fn test_order_book_deltas_api_new() {
        let deltas = create_test_deltas();
        let api_wrapper = OrderBookDeltas_API::new(deltas.clone());

        assert_eq!(api_wrapper.instrument_id, deltas.instrument_id);
        assert_eq!(api_wrapper.deltas.len(), deltas.deltas.len());
        assert_eq!(api_wrapper.flags, deltas.flags);
        assert_eq!(api_wrapper.sequence, deltas.sequence);
    }

    #[rstest]
    fn test_order_book_deltas_api_into_inner() {
        let deltas = create_test_deltas();
        let api_wrapper = OrderBookDeltas_API::new(deltas.clone());
        let inner_deltas = api_wrapper.into_inner();

        assert_eq!(inner_deltas, deltas);
    }

    #[rstest]
    fn test_order_book_deltas_api_deref() {
        let deltas = create_test_deltas();
        let api_wrapper = OrderBookDeltas_API::new(deltas.clone());

        // Test Deref functionality
        assert_eq!(api_wrapper.instrument_id, deltas.instrument_id);
        assert_eq!(api_wrapper.ts_init(), deltas.ts_init());

        // Test accessing methods through Deref
        let display_str = format!("{}", &*api_wrapper);
        assert!(display_str.contains("EURUSD.SIM"));
    }

    #[rstest]
    fn test_order_book_deltas_api_deref_mut() {
        let deltas = create_test_deltas();
        let mut api_wrapper = OrderBookDeltas_API::new(deltas);

        // Test DerefMut functionality by modifying through the wrapper
        let original_flags = api_wrapper.flags;
        api_wrapper.flags = 64;

        assert_ne!(api_wrapper.flags, original_flags);
        assert_eq!(api_wrapper.flags, 64);
    }

    #[rstest]
    fn test_order_book_deltas_api_clone() {
        let deltas = create_test_deltas();
        let api_wrapper1 = OrderBookDeltas_API::new(deltas);
        let api_wrapper2 = api_wrapper1.clone();

        assert_eq!(api_wrapper1.instrument_id, api_wrapper2.instrument_id);
        assert_eq!(api_wrapper1.sequence, api_wrapper2.sequence);
        assert_eq!(api_wrapper1, api_wrapper2);
    }

    #[rstest]
    fn test_order_book_deltas_api_debug() {
        let deltas = create_test_deltas();
        let api_wrapper = OrderBookDeltas_API::new(deltas);
        let debug_str = format!("{api_wrapper:?}");

        assert!(debug_str.contains("OrderBookDeltas_API"));
        assert!(debug_str.contains("EURUSD.SIM"));
    }

    #[rstest]
    fn test_order_book_deltas_api_serialization() {
        let deltas = create_test_deltas();
        let api_wrapper = OrderBookDeltas_API::new(deltas);

        // Test JSON serialization
        let json = serde_json::to_string(&api_wrapper).unwrap();
        let deserialized: OrderBookDeltas_API = serde_json::from_str(&json).unwrap();

        assert_eq!(api_wrapper.instrument_id, deserialized.instrument_id);
        assert_eq!(api_wrapper.sequence, deserialized.sequence);
        assert_eq!(api_wrapper, deserialized);
    }

    #[rstest]
    fn test_order_book_deltas_with_stub(stub_deltas: OrderBookDeltas) {
        let deltas = stub_deltas;

        assert_eq!(deltas.instrument_id, InstrumentId::from("AAPL.XNAS"));
        assert_eq!(deltas.deltas.len(), 7);
        assert_eq!(deltas.flags, 32);
        assert_eq!(deltas.sequence, 0);
        assert_eq!(deltas.ts_event, UnixNanos::from(1));
        assert_eq!(deltas.ts_init, UnixNanos::from(2));
    }

    #[rstest]
    fn test_display_with_stub(stub_deltas: OrderBookDeltas) {
        let deltas = stub_deltas;
        assert_eq!(
            format!("{deltas}"),
            "AAPL.XNAS,len=7,flags=32,sequence=0,ts_event=1,ts_init=2".to_string()
        );
    }

    #[rstest]
    fn test_order_book_deltas_zero_sequence() {
        let instrument_id = InstrumentId::from("ZERO.TEST");
        let delta = OrderBookDelta::new(
            instrument_id,
            BookAction::Add,
            BookOrder::new(
                OrderSide::Buy,
                Price::from("100.0"),
                Quantity::from("1000"),
                1,
            ),
            0,
            0,                  // Zero sequence
            UnixNanos::from(0), // Zero timestamp
            UnixNanos::from(0),
        );

        let deltas = OrderBookDeltas::new(instrument_id, vec![delta]);

        assert_eq!(deltas.sequence, 0);
        assert_eq!(deltas.ts_event, UnixNanos::from(0));
        assert_eq!(deltas.ts_init, UnixNanos::from(0));
    }

    #[rstest]
    fn test_order_book_deltas_max_values() {
        let instrument_id = InstrumentId::from("MAX.TEST");
        let delta = OrderBookDelta::new(
            instrument_id,
            BookAction::Add,
            BookOrder::new(
                OrderSide::Buy,
                Price::from("999999.99"),
                Quantity::from("999999999"),
                u64::MAX,
            ),
            u8::MAX,
            u64::MAX,
            UnixNanos::from(u64::MAX),
            UnixNanos::from(u64::MAX),
        );

        let deltas = OrderBookDeltas::new(instrument_id, vec![delta]);

        assert_eq!(deltas.flags, u8::MAX);
        assert_eq!(deltas.sequence, u64::MAX);
        assert_eq!(deltas.ts_event, UnixNanos::from(u64::MAX));
        assert_eq!(deltas.ts_init, UnixNanos::from(u64::MAX));
    }

    #[rstest]
    fn test_new() {
        let instrument_id = InstrumentId::from("AAPL.XNAS");
        let flags = 32; // Snapshot flag
        let sequence = 0;
        let ts_event = 1;
        let ts_init = 2;

        let delta0 =
            OrderBookDelta::clear(instrument_id, sequence, ts_event.into(), ts_init.into());
        let delta1 = OrderBookDelta::new(
            instrument_id,
            BookAction::Add,
            BookOrder::new(
                OrderSide::Sell,
                Price::from("102.00"),
                Quantity::from("300"),
                1,
            ),
            flags,
            sequence,
            ts_event.into(),
            ts_init.into(),
        );
        let delta2 = OrderBookDelta::new(
            instrument_id,
            BookAction::Add,
            BookOrder::new(
                OrderSide::Sell,
                Price::from("101.00"),
                Quantity::from("200"),
                2,
            ),
            flags,
            sequence,
            ts_event.into(),
            ts_init.into(),
        );
        let delta3 = OrderBookDelta::new(
            instrument_id,
            BookAction::Add,
            BookOrder::new(
                OrderSide::Sell,
                Price::from("100.00"),
                Quantity::from("100"),
                3,
            ),
            flags,
            sequence,
            ts_event.into(),
            ts_init.into(),
        );
        let delta4 = OrderBookDelta::new(
            instrument_id,
            BookAction::Add,
            BookOrder::new(
                OrderSide::Buy,
                Price::from("99.00"),
                Quantity::from("100"),
                4,
            ),
            flags,
            sequence,
            ts_event.into(),
            ts_init.into(),
        );
        let delta5 = OrderBookDelta::new(
            instrument_id,
            BookAction::Add,
            BookOrder::new(
                OrderSide::Buy,
                Price::from("98.00"),
                Quantity::from("200"),
                5,
            ),
            flags,
            sequence,
            ts_event.into(),
            ts_init.into(),
        );
        let delta6 = OrderBookDelta::new(
            instrument_id,
            BookAction::Add,
            BookOrder::new(
                OrderSide::Buy,
                Price::from("97.00"),
                Quantity::from("300"),
                6,
            ),
            flags,
            sequence,
            ts_event.into(),
            ts_init.into(),
        );

        let deltas = OrderBookDeltas::new(
            instrument_id,
            vec![delta0, delta1, delta2, delta3, delta4, delta5, delta6],
        );

        assert_eq!(deltas.instrument_id, instrument_id);
        assert_eq!(deltas.deltas.len(), 7);
        assert_eq!(deltas.flags, flags);
        assert_eq!(deltas.sequence, sequence);
        assert_eq!(deltas.ts_event, ts_event);
        assert_eq!(deltas.ts_init, ts_init);
    }
}