fin-primitives 2.12.0

Financial market primitives: validated types, order book, OHLCV aggregation, 550+ streaming technical indicators, position ledger, and risk monitoring.
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
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
//! # Module: orderbook
//!
//! ## Responsibility
//! Maintains a level-2 order book for a single symbol. Processes incremental
//! `BookDelta` updates with sequence-number validation, and provides best bid/ask,
//! spread, VWAP-to-fill, and top-N level queries.
//!
//! ## Guarantees
//! - Sequence numbers are validated: each delta must be exactly `self.sequence + 1`
//! - Bids are maintained in descending price order (best bid = highest price)
//! - Asks are maintained in ascending price order (best ask = lowest price)
//! - `vwap_for_qty` returns `InsufficientLiquidity` when the book cannot fill `qty`
//! - Thread-safe: `OrderBook` implements neither `Send` nor `Sync` by default (use `Arc<Mutex>` externally)
//!
//! ## NOT Responsible For
//! - Cross-symbol aggregation
//! - Persistence

use crate::error::FinError;
use crate::types::{Price, Quantity, Side, Symbol};
use rust_decimal::Decimal;
use std::collections::BTreeMap;

/// A single price level in the order book.
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct PriceLevel {
    /// The price of this level.
    pub price: Price,
    /// The resting quantity at this price.
    pub quantity: Quantity,
}

/// Whether a delta sets or removes a price level.
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub enum DeltaAction {
    /// Set the quantity at this price level.
    Set,
    /// Remove this price level entirely.
    Remove,
}

/// An incremental update to an order book.
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct BookDelta {
    /// Which side of the book this update applies to.
    pub side: Side,
    /// The price level being updated.
    pub price: Price,
    /// The new quantity (used for `Set`; ignored for `Remove`).
    pub quantity: Quantity,
    /// The action to take.
    pub action: DeltaAction,
    /// Must equal `book.sequence() + 1`.
    pub sequence: u64,
}

/// A level-2 order book for a single symbol.
#[derive(Debug, Clone)]
pub struct OrderBook {
    /// The instrument this book tracks.
    pub symbol: Symbol,
    /// Bid levels: price → quantity. Iterated in ascending key order by `BTreeMap`;
    /// we use `.iter().rev()` to get descending (best bid first).
    bids: BTreeMap<Decimal, Decimal>,
    /// Ask levels: price → quantity. Iterated in ascending key order (best ask first).
    asks: BTreeMap<Decimal, Decimal>,
    /// Last successfully applied sequence number.
    sequence: u64,
}

impl OrderBook {
    /// Constructs a new empty `OrderBook` for `symbol`. Sequence starts at 0.
    pub fn new(symbol: Symbol) -> Self {
        Self {
            symbol,
            bids: BTreeMap::new(),
            asks: BTreeMap::new(),
            sequence: 0,
        }
    }

    /// Applies a `BookDelta` to the order book.
    ///
    /// # Errors
    /// Returns [`FinError::SequenceMismatch`] if `delta.sequence != self.sequence + 1`.
    #[allow(clippy::needless_pass_by_value)]
    pub fn apply_delta(&mut self, delta: BookDelta) -> Result<(), FinError> {
        let expected = self.sequence + 1;
        if delta.sequence != expected {
            return Err(FinError::SequenceMismatch {
                expected,
                got: delta.sequence,
            });
        }
        // Save the pre-mutation value for potential rollback of a Remove action.
        let prev_val = match delta.side {
            Side::Bid => self.bids.get(&delta.price.value()).copied(),
            Side::Ask => self.asks.get(&delta.price.value()).copied(),
        };

        let book_side = match delta.side {
            Side::Bid => &mut self.bids,
            Side::Ask => &mut self.asks,
        };
        match delta.action {
            DeltaAction::Set => {
                book_side.insert(delta.price.value(), delta.quantity.value());
            }
            DeltaAction::Remove => {
                book_side.remove(&delta.price.value());
            }
        }
        self.sequence = delta.sequence;

        // Guard against inverted spreads that would corrupt VWAP and mid-price.
        // Copy the prices out before any mutable borrow.
        let maybe_inversion = {
            let best_bid_p = self.bids.keys().next_back().copied();
            let best_ask_p = self.asks.keys().next().copied();
            match (best_bid_p, best_ask_p) {
                (Some(b), Some(a)) if b >= a => Some((b, a)),
                _ => None,
            }
        };
        if let Some((best_bid_p, best_ask_p)) = maybe_inversion {
            // Roll back the mutation to keep the book consistent.
            match delta.action {
                DeltaAction::Set => match delta.side {
                    Side::Bid => {
                        self.bids.remove(&delta.price.value());
                    }
                    Side::Ask => {
                        self.asks.remove(&delta.price.value());
                    }
                },
                // Restore the level to its prior quantity (not delta.quantity, which is
                // zero by convention for Remove deltas and would corrupt the book).
                DeltaAction::Remove => match delta.side {
                    Side::Bid => {
                        if let Some(qty) = prev_val {
                            self.bids.insert(delta.price.value(), qty);
                        }
                    }
                    Side::Ask => {
                        if let Some(qty) = prev_val {
                            self.asks.insert(delta.price.value(), qty);
                        }
                    }
                },
            }
            self.sequence = expected - 1;
            return Err(FinError::InvertedSpread {
                best_bid: best_bid_p,
                best_ask: best_ask_p,
            });
        }

        Ok(())
    }

    /// Returns the best bid (highest price) or `None` if the bid side is empty.
    ///
    /// Returns `None` if the book is empty or if the stored price is somehow
    /// non-positive (which is structurally prevented by `apply_delta`).
    pub fn best_bid(&self) -> Option<PriceLevel> {
        self.bids.iter().next_back().and_then(|(p, q)| {
            Some(PriceLevel {
                price: Price::new(*p).ok()?,
                quantity: Quantity::new(*q).unwrap_or_else(|_| Quantity::zero()),
            })
        })
    }

    /// Returns `(best_bid, best_ask)` as a tuple, or `None` if either side is empty.
    ///
    /// Convenience wrapper for accessing both sides of the top-of-book in one call.
    pub fn best_quote(&self) -> Option<(PriceLevel, PriceLevel)> {
        Some((self.best_bid()?, self.best_ask()?))
    }

    /// Returns the best ask (lowest price) or `None` if the ask side is empty.
    ///
    /// Returns `None` if the book is empty or if the stored price is somehow
    /// non-positive (which is structurally prevented by `apply_delta`).
    pub fn best_ask(&self) -> Option<PriceLevel> {
        self.asks.iter().next().and_then(|(p, q)| {
            Some(PriceLevel {
                price: Price::new(*p).ok()?,
                quantity: Quantity::new(*q).unwrap_or_else(|_| Quantity::zero()),
            })
        })
    }

    /// Returns the mid-price `(best_ask + best_bid) / 2`, or `None` if either side is empty.
    pub fn mid_price(&self) -> Option<Decimal> {
        let bid = self.best_bid()?.price.value();
        let ask = self.best_ask()?.price.value();
        Some((bid + ask) / Decimal::TWO)
    }

    /// Returns the spread `best_ask - best_bid`, or `None` if either side is empty.
    pub fn spread(&self) -> Option<Decimal> {
        let bid = self.best_bid()?.price.value();
        let ask = self.best_ask()?.price.value();
        Some(ask - bid)
    }

    /// Returns the spread as a percentage of the mid-price: `spread / mid * 100`.
    ///
    /// Returns `None` when either side is empty or mid-price is zero.
    pub fn spread_pct(&self) -> Option<Decimal> {
        let mid = self.mid_price()?;
        if mid.is_zero() {
            return None;
        }
        let spread = self.spread()?;
        Some(spread / mid * Decimal::ONE_HUNDRED)
    }

    /// Returns the resting quantity at a specific price level, or `None` if the level is absent.
    pub fn depth_at(&self, side: Side, price: Price) -> Option<Decimal> {
        let key = price.value();
        match side {
            Side::Bid => self.bids.get(&key).copied(),
            Side::Ask => self.asks.get(&key).copied(),
        }
    }

    /// Returns the top `n` bid levels in descending price order.
    pub fn top_bids(&self, n: usize) -> Vec<PriceLevel> {
        self.bids
            .iter()
            .rev()
            .take(n)
            .filter_map(|(p, q)| {
                let price = Price::new(*p).ok()?;
                let quantity = Quantity::new(*q).ok()?;
                Some(PriceLevel { price, quantity })
            })
            .collect()
    }

    /// Returns the top `n` ask levels in ascending price order.
    pub fn top_asks(&self, n: usize) -> Vec<PriceLevel> {
        self.asks
            .iter()
            .take(n)
            .filter_map(|(p, q)| {
                let price = Price::new(*p).ok()?;
                let quantity = Quantity::new(*q).ok()?;
                Some(PriceLevel { price, quantity })
            })
            .collect()
    }

    /// Computes the volume-weighted average price to fill `qty` on `side`.
    ///
    /// Walks levels from best to worst until `qty` is filled.
    ///
    /// # Errors
    /// Returns [`FinError::InsufficientLiquidity`] if the book cannot fill `qty`.
    pub fn vwap_for_qty(&self, side: Side, qty: Quantity) -> Result<Decimal, FinError> {
        let target = qty.value();
        if target <= Decimal::ZERO {
            return Ok(Decimal::ZERO);
        }
        match side {
            Side::Bid => Self::vwap_fill(self.bids.iter().rev(), target),
            Side::Ask => Self::vwap_fill(self.asks.iter(), target),
        }
    }

    fn vwap_fill<'a>(
        levels: impl Iterator<Item = (&'a Decimal, &'a Decimal)>,
        target: Decimal,
    ) -> Result<Decimal, FinError> {
        let mut remaining = target;
        let mut total_cost = Decimal::ZERO;

        for (price, avail_qty) in levels {
            let fill = remaining.min(*avail_qty);
            total_cost += fill * price;
            remaining -= fill;
            if remaining <= Decimal::ZERO {
                break;
            }
        }

        if remaining > Decimal::ZERO {
            return Err(FinError::InsufficientLiquidity(target));
        }

        Ok(total_cost / target)
    }

    /// Returns the last successfully applied sequence number.
    pub fn sequence(&self) -> u64 {
        self.sequence
    }

    /// Returns the top `n` bid and ask levels as a snapshot.
    ///
    /// Returns `(bids, asks)` where bids are in descending price order and
    /// asks are in ascending price order.
    pub fn snapshot(&self, n: usize) -> (Vec<PriceLevel>, Vec<PriceLevel>) {
        (self.top_bids(n), self.top_asks(n))
    }

    /// Returns the number of bid price levels.
    pub fn bid_count(&self) -> usize {
        self.bids.len()
    }

    /// Returns the number of ask price levels.
    pub fn ask_count(&self) -> usize {
        self.asks.len()
    }

    /// Returns the number of price levels on the given `side`.
    pub fn level_count(&self, side: Side) -> usize {
        match side {
            Side::Bid => self.bids.len(),
            Side::Ask => self.asks.len(),
        }
    }

    /// Removes all price levels from both sides of the book, resetting sequence to 0.
    pub fn clear(&mut self) {
        self.bids.clear();
        self.asks.clear();
        self.sequence = 0;
    }

    /// Removes all resting levels from `side`, leaving the opposite side intact.
    ///
    /// Useful when a snapshot update arrives for one side only (e.g., bid-side snapshot).
    pub fn remove_all(&mut self, side: crate::types::Side) {
        use crate::types::Side;
        match side {
            Side::Bid => self.bids.clear(),
            Side::Ask => self.asks.clear(),
        }
    }

    /// Returns `true` if the book is currently in a crossed (inverted) state.
    ///
    /// A book is crossed when `best_bid >= best_ask`. Under normal operation this
    /// is always `false` since `apply_delta` rejects crossing deltas.
    /// Provided for diagnostic / assertion use.
    pub fn is_crossed(&self) -> bool {
        match (self.best_bid(), self.best_ask()) {
            (Some(bid), Some(ask)) => bid.price >= ask.price,
            _ => false,
        }
    }

    /// Returns `true` if both sides of the book have no resting quantity.
    pub fn is_empty(&self) -> bool {
        self.bids.is_empty() && self.asks.is_empty()
    }

    /// Returns the total number of distinct price levels across both sides.
    pub fn total_levels(&self) -> usize {
        self.bids.len() + self.asks.len()
    }

    /// Returns the total resting quantity available on `side` up to and including `price`.
    ///
    /// For bids: sums all bid levels at prices `>= price` (levels at or above the given price).
    /// For asks: sums all ask levels at prices `<= price` (levels at or below the given price).
    ///
    /// Returns `Decimal::ZERO` when there are no matching levels.
    pub fn cumulative_depth(&self, side: Side, price: Price) -> Decimal {
        let p = price.value();
        match side {
            Side::Bid => self
                .bids
                .range(p..)
                .map(|(_, qty)| *qty)
                .sum(),
            Side::Ask => self
                .asks
                .range(..=p)
                .map(|(_, qty)| *qty)
                .sum(),
        }
    }

    /// Returns the total resting quantity on the bid side.
    pub fn total_bid_volume(&self) -> Decimal {
        self.bids.values().copied().sum()
    }

    /// Returns the total resting quantity on the ask side.
    pub fn total_ask_volume(&self) -> Decimal {
        self.asks.values().copied().sum()
    }

    /// Returns the best bid price, or `None` if the bid side is empty.
    pub fn best_bid_price(&self) -> Option<Price> {
        self.bids.keys().next_back().and_then(|p| Price::new(*p).ok())
    }

    /// Returns the best ask price, or `None` if the ask side is empty.
    pub fn best_ask_price(&self) -> Option<Price> {
        self.asks.keys().next().and_then(|p| Price::new(*p).ok())
    }

    /// Returns the resting quantity at the best bid, or `None` if the bid side is empty.
    pub fn best_bid_qty(&self) -> Option<Quantity> {
        self.bids
            .values()
            .next_back()
            .and_then(|q| Quantity::new(*q).ok())
    }

    /// Returns the resting quantity at the best ask, or `None` if the ask side is empty.
    pub fn best_ask_qty(&self) -> Option<Quantity> {
        self.asks
            .values()
            .next()
            .and_then(|q| Quantity::new(*q).ok())
    }

    /// Returns the total resting quantity on `side` within `pct_from_mid` percent of the mid-price.
    ///
    /// For example, `liquidity_at_pct(Side::Ask, dec!(0.5))` returns all ask volume
    /// within 0.5% above the mid-price. Returns `None` when the book has no mid-price.
    pub fn liquidity_at_pct(&self, side: Side, pct_from_mid: Decimal) -> Option<Decimal> {
        let mid = self.mid_price()?;
        let band = mid * pct_from_mid / Decimal::ONE_HUNDRED;
        let (lo, hi) = match side {
            Side::Bid => (mid - band, mid),
            Side::Ask => (mid, mid + band),
        };
        let qty: Decimal = match side {
            Side::Bid => self
                .bids
                .range(lo..=hi)
                .map(|(_, q)| *q)
                .sum(),
            Side::Ask => self
                .asks
                .range(lo..=hi)
                .map(|(_, q)| *q)
                .sum(),
        };
        Some(qty)
    }

    /// Returns `true` if `price` is present in the given `side` of the book.
    pub fn has_price(&self, side: Side, price: Price) -> bool {
        let key = price.value();
        match side {
            Side::Bid => self.bids.contains_key(&key),
            Side::Ask => self.asks.contains_key(&key),
        }
    }

    /// Returns the quantity-weighted midpoint (micro-price).
    ///
    /// Weights best-bid by ask quantity and best-ask by bid quantity:
    /// `(bid_price × ask_qty + ask_price × bid_qty) / (bid_qty + ask_qty)`.
    /// Returns `None` when either side is empty.
    pub fn weighted_mid(&self) -> Option<Decimal> {
        let bid = self.best_bid()?;
        let ask = self.best_ask()?;
        let bid_qty = bid.quantity.value();
        let ask_qty = ask.quantity.value();
        let total = bid_qty + ask_qty;
        if total.is_zero() {
            return None;
        }
        Some((bid.price.value() * ask_qty + ask.price.value() * bid_qty) / total)
    }

    /// Returns the order-book imbalance: `(bid_vol - ask_vol) / (bid_vol + ask_vol)`.
    ///
    /// Returns `None` when both sides are empty (division by zero).
    /// Range is `(-1, 1)`: positive = bid-heavy, negative = ask-heavy.
    pub fn imbalance(&self) -> Option<Decimal> {
        let bid_vol = self.total_bid_volume();
        let ask_vol = self.total_ask_volume();
        let total = bid_vol + ask_vol;
        if total == Decimal::ZERO {
            return None;
        }
        Some((bid_vol - ask_vol) / total)
    }

    /// Returns the depth ratio `top_n_bid_vol / top_n_ask_vol` for the best `n` levels.
    ///
    /// A ratio > 1 indicates more buying pressure at the top of book; < 1 more selling pressure.
    /// Returns `None` when either side has no levels in the top-`n` or ask volume is zero.
    pub fn depth_ratio(&self, n: usize) -> Option<Decimal> {
        let bid_vol: Decimal = self.bids.values().rev().take(n).copied().sum();
        let ask_vol: Decimal = self.asks.values().take(n).copied().sum();
        if ask_vol.is_zero() {
            return None;
        }
        Some(bid_vol / ask_vol)
    }

    /// Returns the weighted mid price: `(best_bid * ask_qty + best_ask * bid_qty) / (bid_qty + ask_qty)`.
    ///
    /// Weights the midpoint by the opposite side's quantity, so a thick ask pulls the WMP toward bid.
    ///
    /// Alias for [`weighted_mid`](Self::weighted_mid).
    #[deprecated(since = "2.1.0", note = "Use `weighted_mid` instead")]
    pub fn weighted_mid_price(&self) -> Option<Decimal> {
        self.weighted_mid()
    }

    /// Returns all price levels on `side` whose price falls within `[lo, hi]` (inclusive).
    ///
    /// Useful for computing the available liquidity within a price band.
    pub fn price_levels_between(&self, side: Side, lo: Price, hi: Price) -> Vec<PriceLevel> {
        let lo_val = lo.value();
        let hi_val = hi.value();
        match side {
            Side::Bid => self
                .bids
                .range(lo_val..=hi_val)
                .map(|(p, q)| PriceLevel {
                    price: Price::new(*p).unwrap_or(lo),
                    quantity: crate::types::Quantity::new(*q).unwrap_or_else(|_| crate::types::Quantity::zero()),
                })
                .collect(),
            Side::Ask => self
                .asks
                .range(lo_val..=hi_val)
                .map(|(p, q)| PriceLevel {
                    price: Price::new(*p).unwrap_or(lo),
                    quantity: crate::types::Quantity::new(*q).unwrap_or_else(|_| crate::types::Quantity::zero()),
                })
                .collect(),
        }
    }

    /// Returns the smallest price increment between adjacent levels on either side.
    ///
    /// Useful for estimating the instrument's native tick size from live book data.
    /// Returns `None` when both sides have fewer than 2 levels.
    pub fn tick_size(&self) -> Option<Decimal> {
        let bid_tick = self
            .bids
            .keys()
            .collect::<Vec<_>>()
            .windows(2)
            .map(|w| (*w[1] - *w[0]).abs())
            .filter(|d| !d.is_zero())
            .reduce(Decimal::min);
        let ask_tick = self
            .asks
            .keys()
            .collect::<Vec<_>>()
            .windows(2)
            .map(|w| (*w[1] - *w[0]).abs())
            .filter(|d| !d.is_zero())
            .reduce(Decimal::min);
        match (bid_tick, ask_tick) {
            (Some(b), Some(a)) => Some(b.min(a)),
            (Some(b), None) => Some(b),
            (None, Some(a)) => Some(a),
            (None, None) => None,
        }
    }

    /// Returns the bid-to-ask volume ratio: `total_bid_volume / total_ask_volume`.
    ///
    /// Values > 1 indicate more buy-side depth; values < 1 indicate more sell-side depth.
    /// Returns `None` if either side is empty (to avoid division by zero).
    pub fn bid_ask_ratio(&self) -> Option<Decimal> {
        let bid = self.total_bid_volume();
        let ask = self.total_ask_volume();
        if ask.is_zero() || bid.is_zero() {
            return None;
        }
        Some(bid / ask)
    }

    /// Estimates the average fill price for a market order of `qty` on `side`.
    ///
    /// Walks the book levels in price-time priority and returns the volume-weighted
    /// average price. Returns `None` if `qty` is zero or the book cannot fill `qty`
    /// in full (insufficient depth).
    pub fn price_impact(&self, side: crate::types::Side, qty: crate::types::Quantity) -> Option<Decimal> {
        use crate::types::Side;
        if qty.is_zero() {
            return None;
        }
        let levels: Vec<_> = match side {
            Side::Bid => {
                // Buying: walk asks from lowest to highest price
                let mut asks: Vec<_> = self.asks.iter().collect();
                asks.sort_by(|a, b| a.0.cmp(b.0));
                asks.into_iter().map(|(p, q)| (*p, *q)).collect()
            }
            Side::Ask => {
                // Selling: walk bids from highest to lowest price
                let mut bids: Vec<_> = self.bids.iter().collect();
                bids.sort_by(|a, b| b.0.cmp(a.0));
                bids.into_iter().map(|(p, q)| (*p, *q)).collect()
            }
        };
        let target = qty.value();
        let mut remaining = target;
        let mut notional = Decimal::ZERO;
        for (price, level_qty) in levels {
            let fill = level_qty.min(remaining);
            notional += price * fill;
            remaining -= fill;
            if remaining <= Decimal::ZERO {
                break;
            }
        }
        if remaining > Decimal::ZERO {
            None // insufficient depth
        } else {
            Some(notional / target)
        }
    }

    /// Returns the top `n` bid levels in descending price order (best bid first).
    ///
    /// Returns fewer than `n` levels if the bid side has fewer entries.
    pub fn bid_depth(&self, n: usize) -> Vec<PriceLevel> {
        self.bids
            .iter()
            .rev()
            .take(n)
            .map(|(price, qty)| PriceLevel {
                price: Price::new(*price).unwrap(),
                quantity: Quantity::new(*qty).unwrap(),
            })
            .collect()
    }

    /// Returns the top `n` ask levels in ascending price order (best ask first).
    ///
    /// Returns fewer than `n` levels if the ask side has fewer entries.
    pub fn ask_depth(&self, n: usize) -> Vec<PriceLevel> {
        self.asks
            .iter()
            .take(n)
            .map(|(price, qty)| PriceLevel {
                price: Price::new(*price).unwrap(),
                quantity: Quantity::new(*qty).unwrap(),
            })
            .collect()
    }

    /// Returns the depth imbalance ratio: `(bid_qty - ask_qty) / (bid_qty + ask_qty)`.
    ///
    /// Result is in `[-1.0, 1.0]`:
    /// - Positive → more bid-side depth (buying pressure)
    /// - Negative → more ask-side depth (selling pressure)
    /// - `None` when both sides are empty (total depth is zero)
    pub fn depth_imbalance(&self) -> Option<Decimal> {
        let bid_qty: Decimal = self.bids.values().sum();
        let ask_qty: Decimal = self.asks.values().sum();
        let total = bid_qty + ask_qty;
        if total.is_zero() {
            return None;
        }
        Some((bid_qty - ask_qty) / total)
    }

    /// Returns the ask-to-bid quantity ratio: `total_ask_qty / total_bid_qty`.
    ///
    /// Values above 1 indicate more supply than demand at visible depth levels.
    /// Returns `None` when total bid quantity is zero (avoid division by zero).
    pub fn ask_bid_ratio(&self) -> Option<Decimal> {
        let bid_qty: Decimal = self.bids.values().sum();
        let ask_qty: Decimal = self.asks.values().sum();
        if bid_qty.is_zero() {
            return None;
        }
        Some(ask_qty / bid_qty)
    }

    /// Returns the total quantity across all bid price levels.
    pub fn total_bid_depth(&self) -> Decimal {
        self.bids.values().sum()
    }

    /// Returns the total quantity across all ask price levels.
    pub fn total_ask_depth(&self) -> Decimal {
        self.asks.values().sum()
    }

    /// Walks the book on `side` to find the price level reached after consuming `target_qty`.
    ///
    /// For `Side::Ask` walks ascending (cheapest ask first).
    /// For `Side::Bid` walks descending (highest bid first).
    ///
    /// Returns the price of the level where `target_qty` is fully absorbed, or the last
    /// available level if the book lacks sufficient depth.
    /// Returns `None` when the side has no levels or `target_qty` is zero.
    pub fn price_at_volume(&self, side: Side, target_qty: Decimal) -> Option<Price> {
        if target_qty.is_zero() {
            return None;
        }
        let mut remaining = target_qty;
        let mut last_price: Option<Price> = None;

        match side {
            Side::Ask => {
                for (&px, &qty) in &self.asks {
                    last_price = Price::new(px).ok();
                    if qty >= remaining {
                        return last_price;
                    }
                    remaining -= qty;
                }
            }
            Side::Bid => {
                for (&px, &qty) in self.bids.iter().rev() {
                    last_price = Price::new(px).ok();
                    if qty >= remaining {
                        return last_price;
                    }
                    remaining -= qty;
                }
            }
        }
        last_price
    }

    /// Returns up to `n` best bid levels in descending price order (best bid first).
    ///
    /// Returns an empty `Vec` when the bid side is empty or `n == 0`.
    pub fn top_n_bid_levels(&self, n: usize) -> Vec<PriceLevel> {
        if n == 0 {
            return vec![];
        }
        self.bids
            .iter()
            .rev()
            .take(n)
            .filter_map(|(&px, &qty)| {
                let price = Price::new(px).ok()?;
                let quantity = Quantity::new(qty).ok()?;
                Some(PriceLevel { price, quantity })
            })
            .collect()
    }

    /// Returns up to `n` best ask levels in ascending price order (best ask first).
    ///
    /// Returns an empty `Vec` when the ask side is empty or `n == 0`.
    pub fn top_n_ask_levels(&self, n: usize) -> Vec<PriceLevel> {
        if n == 0 {
            return vec![];
        }
        self.asks
            .iter()
            .take(n)
            .filter_map(|(&px, &qty)| {
                let price = Price::new(px).ok()?;
                let quantity = Quantity::new(qty).ok()?;
                Some(PriceLevel { price, quantity })
            })
            .collect()
    }

    /// Returns the total quantity across the top `n` bid levels.
    ///
    /// Sweeps from the best (highest) bid downwards and sums quantities.
    /// Returns zero when the bid side is empty or `n == 0`.
    pub fn cumulative_bid_qty(&self, n: usize) -> Decimal {
        if n == 0 {
            return Decimal::ZERO;
        }
        self.bids.iter().rev().take(n).map(|(_, &qty)| qty).sum()
    }

    /// Returns the bid-to-ask depth skew across the top `n` levels on each side.
    ///
    /// `bid_depth_skew = cumulative_bid_qty(n) / (cumulative_bid_qty(n) + cumulative_ask_qty(n))`.
    /// Range: 0.0 (all ask-side depth) to 1.0 (all bid-side depth).
    /// Returns `None` if both sides are empty or `n == 0`.
    pub fn bid_depth_skew(&self, n: usize) -> Option<Decimal> {
        if n == 0 {
            return None;
        }
        let bid_qty = self.cumulative_bid_qty(n);
        let ask_qty = self.cumulative_ask_qty(n);
        let total = bid_qty + ask_qty;
        if total.is_zero() {
            return None;
        }
        bid_qty.checked_div(total)
    }

    /// Returns the bid-ask spread in basis points.
    ///
    /// `spread_bps = (best_ask - best_bid) / mid_price * 10_000`.
    /// Returns `None` if either side is empty or mid-price is zero.
    pub fn spread_bps(&self) -> Option<Decimal> {
        let bid = self.best_bid()?.price.value();
        let ask = self.best_ask()?.price.value();
        let mid = (bid + ask) / Decimal::TWO;
        if mid.is_zero() {
            return None;
        }
        let spread = ask - bid;
        spread.checked_div(mid).map(|r| r * Decimal::from(10_000u32))
    }

    /// Returns the total quantity across the top `n` ask levels.
    ///
    /// Sweeps from the best (lowest) ask upwards and sums quantities.
    /// Returns zero when the ask side is empty or `n == 0`.
    pub fn cumulative_ask_qty(&self, n: usize) -> Decimal {
        if n == 0 {
            return Decimal::ZERO;
        }
        self.asks.iter().take(n).map(|(_, &qty)| qty).sum()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use rust_decimal_macros::dec;

    fn make_book() -> OrderBook {
        OrderBook::new(Symbol::new("AAPL").unwrap())
    }

    fn set_delta(side: Side, price: &str, qty: &str, seq: u64) -> BookDelta {
        BookDelta {
            side,
            price: Price::new(price.parse().unwrap()).unwrap(),
            quantity: Quantity::new(qty.parse().unwrap()).unwrap(),
            action: DeltaAction::Set,
            sequence: seq,
        }
    }

    fn remove_delta(side: Side, price: &str, seq: u64) -> BookDelta {
        BookDelta {
            side,
            price: Price::new(price.parse().unwrap()).unwrap(),
            quantity: Quantity::zero(),
            action: DeltaAction::Remove,
            sequence: seq,
        }
    }

    #[test]
    fn test_orderbook_apply_delta_updates_bid() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Bid, "100", "10", 1))
            .unwrap();
        let best = book.best_bid().unwrap();
        assert_eq!(best.price.value(), dec!(100));
        assert_eq!(best.quantity.value(), dec!(10));
    }

    #[test]
    fn test_orderbook_apply_delta_updates_ask() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Ask, "101", "5", 1))
            .unwrap();
        let best = book.best_ask().unwrap();
        assert_eq!(best.price.value(), dec!(101));
        assert_eq!(best.quantity.value(), dec!(5));
    }

    #[test]
    fn test_orderbook_sequence_mismatch_returns_error() {
        let mut book = make_book();
        let result = book.apply_delta(set_delta(Side::Bid, "100", "10", 2));
        assert!(matches!(
            result,
            Err(FinError::SequenceMismatch {
                expected: 1,
                got: 2
            })
        ));
    }

    #[test]
    fn test_orderbook_sequence_advances_correctly() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Bid, "100", "10", 1))
            .unwrap();
        assert_eq!(book.sequence(), 1);
        book.apply_delta(set_delta(Side::Ask, "101", "5", 2))
            .unwrap();
        assert_eq!(book.sequence(), 2);
    }

    #[test]
    fn test_orderbook_best_bid_max_price() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Bid, "99", "10", 1))
            .unwrap();
        book.apply_delta(set_delta(Side::Bid, "100", "5", 2))
            .unwrap();
        book.apply_delta(set_delta(Side::Bid, "98", "20", 3))
            .unwrap();
        let best = book.best_bid().unwrap();
        assert_eq!(best.price.value(), dec!(100));
    }

    #[test]
    fn test_orderbook_best_ask_min_price() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Ask, "102", "10", 1))
            .unwrap();
        book.apply_delta(set_delta(Side::Ask, "101", "5", 2))
            .unwrap();
        book.apply_delta(set_delta(Side::Ask, "103", "20", 3))
            .unwrap();
        let best = book.best_ask().unwrap();
        assert_eq!(best.price.value(), dec!(101));
    }

    #[test]
    fn test_orderbook_spread_positive() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Bid, "100", "10", 1))
            .unwrap();
        book.apply_delta(set_delta(Side::Ask, "101", "5", 2))
            .unwrap();
        let spread = book.spread().unwrap();
        assert_eq!(spread, dec!(1));
        assert!(spread > Decimal::ZERO);
    }

    #[test]
    fn test_orderbook_mid_price() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Bid, "100", "10", 1))
            .unwrap();
        book.apply_delta(set_delta(Side::Ask, "102", "5", 2))
            .unwrap();
        let mid = book.mid_price().unwrap();
        assert_eq!(mid, dec!(101));
    }

    #[test]
    fn test_orderbook_spread_none_when_empty() {
        let book = make_book();
        assert!(book.spread().is_none());
    }

    #[test]
    fn test_orderbook_vwap_insufficient_liquidity() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Ask, "101", "5", 1))
            .unwrap();
        let result = book.vwap_for_qty(Side::Ask, Quantity::new(dec!(100)).unwrap());
        assert!(matches!(result, Err(FinError::InsufficientLiquidity(_))));
    }

    #[test]
    fn test_orderbook_vwap_single_level() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Ask, "100", "10", 1))
            .unwrap();
        let vwap = book
            .vwap_for_qty(Side::Ask, Quantity::new(dec!(5)).unwrap())
            .unwrap();
        assert_eq!(vwap, dec!(100));
    }

    #[test]
    fn test_orderbook_vwap_multi_level() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Ask, "100", "5", 1))
            .unwrap();
        book.apply_delta(set_delta(Side::Ask, "101", "5", 2))
            .unwrap();
        // 5 @ 100 + 5 @ 101 = 1005 / 10 = 100.5
        let vwap = book
            .vwap_for_qty(Side::Ask, Quantity::new(dec!(10)).unwrap())
            .unwrap();
        assert_eq!(vwap, dec!(100.5));
    }

    #[test]
    fn test_orderbook_remove_level_delta() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Bid, "100", "10", 1))
            .unwrap();
        book.apply_delta(remove_delta(Side::Bid, "100", 2)).unwrap();
        assert!(book.best_bid().is_none());
    }

    #[test]
    fn test_orderbook_top_bids_order() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Bid, "98", "10", 1))
            .unwrap();
        book.apply_delta(set_delta(Side::Bid, "100", "5", 2))
            .unwrap();
        book.apply_delta(set_delta(Side::Bid, "99", "20", 3))
            .unwrap();
        let top = book.top_bids(2);
        assert_eq!(top[0].price.value(), dec!(100));
        assert_eq!(top[1].price.value(), dec!(99));
    }

    #[test]
    fn test_orderbook_top_asks_order() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Ask, "103", "10", 1))
            .unwrap();
        book.apply_delta(set_delta(Side::Ask, "101", "5", 2))
            .unwrap();
        book.apply_delta(set_delta(Side::Ask, "102", "20", 3))
            .unwrap();
        let top = book.top_asks(2);
        assert_eq!(top[0].price.value(), dec!(101));
        assert_eq!(top[1].price.value(), dec!(102));
    }

    #[test]
    fn test_orderbook_bid_count_ask_count() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Bid, "100", "1", 1))
            .unwrap();
        book.apply_delta(set_delta(Side::Ask, "101", "1", 2))
            .unwrap();
        assert_eq!(book.bid_count(), 1);
        assert_eq!(book.ask_count(), 1);
    }

    #[test]
    fn test_orderbook_vwap_zero_qty_returns_zero() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Ask, "100", "10", 1))
            .unwrap();
        let vwap = book.vwap_for_qty(Side::Ask, Quantity::zero()).unwrap();
        assert_eq!(vwap, Decimal::ZERO);
    }

    // ── Inverted spread guard ─────────────────────────────────────────────────

    #[test]
    fn test_apply_delta_rejects_inverted_spread() {
        let mut book = make_book();
        // Set ask at 100
        book.apply_delta(set_delta(Side::Ask, "100", "5", 1))
            .unwrap();
        // Try to set bid at 101 (would cross the ask): must fail
        let result = book.apply_delta(set_delta(Side::Bid, "101", "5", 2));
        assert!(
            matches!(result, Err(FinError::InvertedSpread { .. })),
            "expected InvertedSpread, got {:?}",
            result
        );
    }

    #[test]
    fn test_apply_delta_inverted_spread_rolls_back_sequence() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Ask, "100", "5", 1))
            .unwrap();
        assert_eq!(book.sequence(), 1);
        // This should fail and leave sequence unchanged
        let _ = book.apply_delta(set_delta(Side::Bid, "101", "5", 2));
        assert_eq!(
            book.sequence(),
            1,
            "sequence must not advance on rejected delta"
        );
    }

    #[test]
    fn test_apply_delta_inverted_spread_rolled_back_book_state() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Ask, "100", "5", 1))
            .unwrap();
        // Rejected bid at 101 must not persist in the book
        let _ = book.apply_delta(set_delta(Side::Bid, "101", "5", 2));
        assert!(
            book.best_bid().is_none(),
            "rejected bid must not appear in book"
        );
    }

    /// Empty book mid_price returns None.
    #[test]
    fn test_empty_book_mid_price_returns_none() {
        let book = make_book();
        assert!(
            book.mid_price().is_none(),
            "empty book mid_price must be None"
        );
    }

    /// Empty book best_bid returns None.
    #[test]
    fn test_empty_book_best_bid_returns_none() {
        let book = make_book();
        assert!(book.best_bid().is_none());
    }

    /// Empty book best_ask returns None.
    #[test]
    fn test_empty_book_best_ask_returns_none() {
        let book = make_book();
        assert!(book.best_ask().is_none());
    }

    /// Best bid/ask after many inserts and removes reflects only surviving levels.
    #[test]
    fn test_best_bid_after_many_inserts_and_removes() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Bid, "100", "10", 1))
            .unwrap();
        book.apply_delta(set_delta(Side::Bid, "105", "5", 2))
            .unwrap();
        book.apply_delta(set_delta(Side::Bid, "103", "8", 3))
            .unwrap();
        // Remove 105 (was best bid)
        book.apply_delta(remove_delta(Side::Bid, "105", 4)).unwrap();
        let best = book.best_bid().unwrap();
        assert_eq!(
            best.price.value(),
            dec!(103),
            "best bid after removing top level must be 103"
        );
    }

    #[test]
    fn test_best_ask_after_many_inserts_and_removes() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Ask, "110", "10", 1))
            .unwrap();
        book.apply_delta(set_delta(Side::Ask, "108", "5", 2))
            .unwrap();
        book.apply_delta(set_delta(Side::Ask, "109", "8", 3))
            .unwrap();
        // Remove 108 (was best ask)
        book.apply_delta(remove_delta(Side::Ask, "108", 4)).unwrap();
        let best = book.best_ask().unwrap();
        assert_eq!(
            best.price.value(),
            dec!(109),
            "best ask after removing top level must be 109"
        );
    }

    /// Crossed book detection: ask <= bid must return InvertedSpread.
    #[test]
    fn test_crossed_book_ask_at_bid_price_rejected() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Bid, "100", "10", 1))
            .unwrap();
        let result = book.apply_delta(set_delta(Side::Ask, "100", "5", 2));
        assert!(
            matches!(result, Err(FinError::InvertedSpread { .. })),
            "ask at bid price must produce InvertedSpread"
        );
    }

    /// Empty book spread returns None.
    #[test]
    fn test_empty_book_spread_returns_none() {
        let book = make_book();
        assert!(book.spread().is_none());
    }

    #[test]
    fn test_orderbook_snapshot_returns_top_n_both_sides() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Bid, "99", "10", 1)).unwrap();
        book.apply_delta(set_delta(Side::Bid, "100", "5", 2)).unwrap();
        book.apply_delta(set_delta(Side::Ask, "101", "3", 3)).unwrap();
        book.apply_delta(set_delta(Side::Ask, "102", "7", 4)).unwrap();
        let (bids, asks) = book.snapshot(2);
        assert_eq!(bids.len(), 2);
        assert_eq!(asks.len(), 2);
        assert_eq!(bids[0].price.value(), dec!(100));
        assert_eq!(asks[0].price.value(), dec!(101));
    }

    #[test]
    fn test_orderbook_snapshot_empty_book() {
        let book = make_book();
        let (bids, asks) = book.snapshot(5);
        assert!(bids.is_empty());
        assert!(asks.is_empty());
    }

    #[test]
    fn test_orderbook_clear_removes_all_levels() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Bid, "99", "10", 1)).unwrap();
        book.apply_delta(set_delta(Side::Ask, "101", "5", 2)).unwrap();
        assert_eq!(book.bid_count(), 1);
        assert_eq!(book.ask_count(), 1);
        book.clear();
        assert_eq!(book.bid_count(), 0);
        assert_eq!(book.ask_count(), 0);
        assert_eq!(book.sequence(), 0);
    }

    #[test]
    fn test_orderbook_clear_allows_fresh_deltas() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Bid, "100", "5", 1)).unwrap();
        book.clear();
        // After clear, sequence resets to 0, so next delta must be seq=1
        assert!(book.apply_delta(set_delta(Side::Bid, "100", "5", 1)).is_ok());
    }

    #[test]
    fn test_orderbook_total_bid_volume() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Bid, "100", "5", 1)).unwrap();
        book.apply_delta(set_delta(Side::Bid, "99", "3", 2)).unwrap();
        assert_eq!(book.total_bid_volume(), dec!(8));
    }

    #[test]
    fn test_orderbook_total_ask_volume() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Ask, "101", "4", 1)).unwrap();
        book.apply_delta(set_delta(Side::Ask, "102", "6", 2)).unwrap();
        assert_eq!(book.total_ask_volume(), dec!(10));
    }

    #[test]
    fn test_orderbook_total_bid_volume_empty() {
        let book = make_book();
        assert_eq!(book.total_bid_volume(), dec!(0));
    }

    #[test]
    fn test_orderbook_imbalance_balanced() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Bid, "100", "5", 1)).unwrap();
        book.apply_delta(set_delta(Side::Ask, "101", "5", 2)).unwrap();
        assert_eq!(book.imbalance().unwrap(), dec!(0));
    }

    #[test]
    fn test_orderbook_imbalance_bid_heavy() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Bid, "100", "9", 1)).unwrap();
        book.apply_delta(set_delta(Side::Ask, "101", "1", 2)).unwrap();
        // (9 - 1) / 10 = 0.8
        assert_eq!(book.imbalance().unwrap(), dec!(0.8));
    }

    #[test]
    fn test_orderbook_imbalance_ask_heavy() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Bid, "100", "1", 1)).unwrap();
        book.apply_delta(set_delta(Side::Ask, "101", "9", 2)).unwrap();
        // (1 - 9) / 10 = -0.8
        assert_eq!(book.imbalance().unwrap(), dec!(-0.8));
    }

    #[test]
    fn test_orderbook_imbalance_empty_returns_none() {
        let book = make_book();
        assert!(book.imbalance().is_none());
    }

    #[test]
    fn test_orderbook_has_price_bid_present() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Bid, "100", "5", 1)).unwrap();
        let price = Price::new(dec!(100)).unwrap();
        assert!(book.has_price(Side::Bid, price));
        assert!(!book.has_price(Side::Ask, price));
    }

    #[test]
    fn test_orderbook_has_price_ask_present() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Ask, "101", "3", 1)).unwrap();
        let price = Price::new(dec!(101)).unwrap();
        assert!(book.has_price(Side::Ask, price));
        assert!(!book.has_price(Side::Bid, price));
    }

    #[test]
    fn test_orderbook_has_price_absent() {
        let book = make_book();
        let price = Price::new(dec!(100)).unwrap();
        assert!(!book.has_price(Side::Bid, price));
        assert!(!book.has_price(Side::Ask, price));
    }

    #[test]
    fn test_orderbook_has_price_false_after_remove() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Bid, "100", "5", 1)).unwrap();
        book.apply_delta(BookDelta {
            side: Side::Bid,
            price: Price::new(dec!(100)).unwrap(),
            quantity: Quantity::zero(),
            action: DeltaAction::Remove,
            sequence: 2,
        })
        .unwrap();
        let price = Price::new(dec!(100)).unwrap();
        assert!(!book.has_price(Side::Bid, price));
    }

    #[test]
    fn test_orderbook_level_count_bids() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Bid, "100", "10", 1)).unwrap();
        book.apply_delta(set_delta(Side::Bid, "99", "5", 2)).unwrap();
        assert_eq!(book.level_count(Side::Bid), 2);
        assert_eq!(book.level_count(Side::Ask), 0);
    }

    #[test]
    fn test_orderbook_level_count_asks() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Ask, "101", "3", 1)).unwrap();
        assert_eq!(book.level_count(Side::Ask), 1);
        assert_eq!(book.level_count(Side::Bid), 0);
    }

    #[test]
    fn test_orderbook_weighted_mid_equal_qty() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Bid, "100", "5", 1)).unwrap();
        book.apply_delta(set_delta(Side::Ask, "102", "5", 2)).unwrap();
        // Equal qty → simple midpoint
        assert_eq!(book.weighted_mid().unwrap(), dec!(101));
    }

    #[test]
    fn test_orderbook_weighted_mid_bid_heavy() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Bid, "100", "9", 1)).unwrap();
        book.apply_delta(set_delta(Side::Ask, "110", "1", 2)).unwrap();
        // (100*1 + 110*9) / (9+1) = (100 + 990) / 10 = 109
        assert_eq!(book.weighted_mid().unwrap(), dec!(109));
    }

    #[test]
    fn test_orderbook_weighted_mid_empty_returns_none() {
        let book = make_book();
        assert!(book.weighted_mid().is_none());
    }

    #[test]
    fn test_orderbook_bid_ask_ratio_equal_volumes() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Bid, "100", "10", 1)).unwrap();
        book.apply_delta(set_delta(Side::Ask, "101", "10", 2)).unwrap();
        assert_eq!(book.bid_ask_ratio().unwrap(), dec!(1));
    }

    #[test]
    fn test_orderbook_bid_ask_ratio_bid_heavy() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Bid, "100", "20", 1)).unwrap();
        book.apply_delta(set_delta(Side::Ask, "101", "10", 2)).unwrap();
        assert_eq!(book.bid_ask_ratio().unwrap(), dec!(2));
    }

    #[test]
    fn test_orderbook_bid_ask_ratio_empty_returns_none() {
        let book = make_book();
        assert!(book.bid_ask_ratio().is_none());
    }

    #[test]
    fn test_orderbook_price_impact_buy_single_level() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Ask, "101", "10", 1)).unwrap();
        let qty = Quantity::new(dec!(5)).unwrap();
        let avg = book.price_impact(Side::Bid, qty).unwrap();
        assert_eq!(avg, dec!(101));
    }

    #[test]
    fn test_orderbook_price_impact_buy_spans_two_levels() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Ask, "100", "5", 1)).unwrap();
        book.apply_delta(set_delta(Side::Ask, "102", "5", 2)).unwrap();
        // 5 @ 100 + 5 @ 102 = 1010 / 10 = 101
        let qty = Quantity::new(dec!(10)).unwrap();
        let avg = book.price_impact(Side::Bid, qty).unwrap();
        assert_eq!(avg, dec!(101));
    }

    #[test]
    fn test_orderbook_price_impact_insufficient_depth_returns_none() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Ask, "101", "3", 1)).unwrap();
        let qty = Quantity::new(dec!(10)).unwrap();
        assert!(book.price_impact(Side::Bid, qty).is_none());
    }

    #[test]
    fn test_orderbook_price_impact_zero_qty_returns_none() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Ask, "101", "10", 1)).unwrap();
        let qty = Quantity::zero();
        assert!(book.price_impact(Side::Bid, qty).is_none());
    }

    #[test]
    fn test_orderbook_depth_at_existing_bid_level() {
        let mut book = make_book();
        // make_book sets seq=0; add a bid at 99 qty=5 with seq=1
        book.apply_delta(set_delta(Side::Bid, "99", "5", 1)).unwrap();
        let price = Price::new(dec!(99)).unwrap();
        assert_eq!(book.depth_at(Side::Bid, price), Some(dec!(5)));
    }

    #[test]
    fn test_orderbook_depth_at_absent_level_returns_none() {
        let book = make_book();
        let price = Price::new(dec!(50)).unwrap();
        assert!(book.depth_at(Side::Bid, price).is_none());
        assert!(book.depth_at(Side::Ask, price).is_none());
    }

    #[test]
    fn test_orderbook_bid_depth_returns_top_n_descending() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Bid, "100", "10", 1)).unwrap();
        book.apply_delta(set_delta(Side::Bid, "99", "5", 2)).unwrap();
        book.apply_delta(set_delta(Side::Bid, "98", "3", 3)).unwrap();
        let levels = book.bid_depth(2);
        assert_eq!(levels.len(), 2);
        assert_eq!(levels[0].price.value(), dec!(100)); // best bid first
        assert_eq!(levels[1].price.value(), dec!(99));
    }

    #[test]
    fn test_orderbook_ask_depth_returns_top_n_ascending() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Ask, "101", "10", 1)).unwrap();
        book.apply_delta(set_delta(Side::Ask, "102", "5", 2)).unwrap();
        book.apply_delta(set_delta(Side::Ask, "103", "3", 3)).unwrap();
        let levels = book.ask_depth(2);
        assert_eq!(levels.len(), 2);
        assert_eq!(levels[0].price.value(), dec!(101)); // best ask first
        assert_eq!(levels[1].price.value(), dec!(102));
    }

    #[test]
    fn test_orderbook_bid_depth_fewer_than_n() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Bid, "100", "10", 1)).unwrap();
        let levels = book.bid_depth(5);
        assert_eq!(levels.len(), 1);
    }

    #[test]
    fn test_orderbook_ask_depth_empty_book() {
        let book = make_book();
        assert!(book.ask_depth(3).is_empty());
    }

    #[test]
    fn test_orderbook_remove_all_bids_clears_bid_side() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Bid, "100", "10", 1)).unwrap();
        book.apply_delta(set_delta(Side::Bid, "99", "5", 2)).unwrap();
        book.remove_all(Side::Bid);
        assert!(book.best_bid().is_none());
    }

    #[test]
    fn test_orderbook_remove_all_bids_leaves_asks_intact() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Bid, "100", "10", 1)).unwrap();
        book.apply_delta(set_delta(Side::Ask, "101", "5", 2)).unwrap();
        book.remove_all(Side::Bid);
        assert!(book.best_bid().is_none());
        assert!(book.best_ask().is_some());
    }

    #[test]
    fn test_orderbook_remove_all_asks_clears_ask_side() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Ask, "101", "5", 1)).unwrap();
        book.apply_delta(set_delta(Side::Ask, "102", "3", 2)).unwrap();
        book.remove_all(Side::Ask);
        assert!(book.best_ask().is_none());
    }

    #[test]
    fn test_orderbook_total_levels_sums_both_sides() {
        let mut book = make_book();
        book.apply_delta(set_delta(Side::Bid, "100", "10", 1)).unwrap();
        book.apply_delta(set_delta(Side::Bid, "99", "5", 2)).unwrap();
        book.apply_delta(set_delta(Side::Ask, "101", "8", 3)).unwrap();
        assert_eq!(book.total_levels(), 3);
    }

    #[test]
    fn test_orderbook_total_levels_empty_book() {
        let book = make_book();
        assert_eq!(book.total_levels(), 0);
    }
}