matchcore 0.4.0

A high-performance order book and price-time matching engine implemented as a single-threaded, deterministic, in-memory state machine
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
use super::{OrderFlags, OrderKind};
use crate::{LevelId, Price, Quantity, QuantityPolicy, SequenceNumber};

use std::{
    fmt,
    ops::{Deref, DerefMut},
};

/// Represents a limit order resting in the order book
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct RestingLimitOrder {
    /// The time priority of the order
    time_priority: SequenceNumber,
    /// The ID of the level the order is resting at
    level_id: LevelId,
    /// The limit order
    inner: LimitOrder,
}

impl RestingLimitOrder {
    /// Create a new resting limit order
    pub fn new(time_priority: SequenceNumber, level_id: LevelId, inner: LimitOrder) -> Self {
        Self {
            time_priority,
            level_id,
            inner,
        }
    }

    /// Get the time priority of the order
    pub fn time_priority(&self) -> SequenceNumber {
        self.time_priority
    }

    /// Update the time priority of the order
    pub(crate) fn update_time_priority(&mut self, new_time_priority: SequenceNumber) {
        self.time_priority = new_time_priority;
    }

    /// Get the ID of the level the order is resting at
    pub fn level_id(&self) -> LevelId {
        self.level_id
    }

    /// Update the ID of the level the order is resting at
    pub(crate) fn update_level_id(&mut self, new_level_id: LevelId) {
        self.level_id = new_level_id;
    }

    /// Get the limit order
    pub fn inner(&self) -> &LimitOrder {
        &self.inner
    }

    /// Convert the resting limit order into a limit order
    pub fn into_inner(self) -> LimitOrder {
        self.inner
    }
}

impl Deref for RestingLimitOrder {
    type Target = LimitOrder;

    fn deref(&self) -> &Self::Target {
        &self.inner
    }
}
impl DerefMut for RestingLimitOrder {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.inner
    }
}

/// Generic limit order with various configuration options
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct LimitOrder {
    /// The price of the order
    price: Price,
    /// The quantity policy of the order
    quantity_policy: QuantityPolicy,
    /// The flags of the order
    flags: OrderFlags,
}

impl LimitOrder {
    /// Create a new limit order
    pub fn new(price: Price, quantity_policy: QuantityPolicy, flags: OrderFlags) -> Self {
        Self {
            price,
            quantity_policy,
            flags,
        }
    }

    /// Get the kind of the order
    pub fn kind(&self) -> OrderKind {
        OrderKind::Limit
    }

    /// Get the price
    pub fn price(&self) -> Price {
        self.price
    }

    /// Update the price of the order
    pub(crate) fn update_price(&mut self, new_price: Price) {
        self.price = new_price;
    }

    /// Get the quantity policy
    pub fn quantity_policy(&self) -> QuantityPolicy {
        self.quantity_policy
    }

    /// Get the visible quantity
    pub fn visible_quantity(&self) -> Quantity {
        self.quantity_policy.visible_quantity()
    }

    /// Get the hidden quantity
    pub fn hidden_quantity(&self) -> Quantity {
        self.quantity_policy.hidden_quantity()
    }

    /// Get the replenish quantity
    pub fn replenish_quantity(&self) -> Quantity {
        self.quantity_policy.replenish_quantity()
    }

    /// Get the total quantity of the order
    pub fn total_quantity(&self) -> Quantity {
        self.quantity_policy.total_quantity()
    }

    /// Check if the order is filled
    pub fn is_filled(&self) -> bool {
        self.quantity_policy.is_filled()
    }

    /// Update the quantity policy of the order
    pub(crate) fn update_quantity_policy(&mut self, new_quantity_policy: QuantityPolicy) {
        self.quantity_policy = new_quantity_policy;
    }

    /// Get the flags of the order
    pub fn flags(&self) -> &OrderFlags {
        &self.flags
    }

    /// Match this order against an incoming quantity
    ///
    /// Returns a tuple containing:
    /// - The quantity consumed from the incoming order
    /// - The quantity that was replenished (for iceberg orders)
    pub(crate) fn match_against(&mut self, incoming_quantity: Quantity) -> (Quantity, Quantity) {
        match self.quantity_policy {
            QuantityPolicy::Standard { quantity } => {
                let new_quantity = quantity.saturating_sub(incoming_quantity);
                let consumed = quantity - new_quantity;

                self.quantity_policy.update_visible_quantity(new_quantity);
                (consumed, Quantity(0))
            }
            QuantityPolicy::Iceberg {
                visible_quantity, ..
            } => {
                let new_visible = visible_quantity.saturating_sub(incoming_quantity);
                let consumed = visible_quantity - new_visible;

                self.quantity_policy.update_visible_quantity(new_visible);
                if !new_visible.is_zero() {
                    (consumed, Quantity(0))
                } else {
                    // Try replenishing the order
                    let replenished = self.quantity_policy.replenish();
                    (consumed, replenished)
                }
            }
        }
    }
}

impl Deref for LimitOrder {
    type Target = OrderFlags;

    fn deref(&self) -> &Self::Target {
        &self.flags
    }
}
impl DerefMut for LimitOrder {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.flags
    }
}

impl fmt::Display for LimitOrder {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self.quantity_policy {
            QuantityPolicy::Standard { quantity } => {
                write!(
                    f,
                    "Standard: price={} quantity={} side={} post_only={} time_in_force={}",
                    self.price,
                    quantity,
                    self.side(),
                    self.post_only(),
                    self.time_in_force()
                )
            }
            QuantityPolicy::Iceberg {
                visible_quantity,
                hidden_quantity,
                replenish_quantity,
            } => {
                write!(
                    f,
                    "Iceberg: price={} visible_quantity={} hidden_quantity={} replenish_quantity={} side={} post_only={} time_in_force={}",
                    self.price,
                    visible_quantity,
                    hidden_quantity,
                    replenish_quantity,
                    self.side(),
                    self.post_only(),
                    self.time_in_force()
                )
            }
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{Quantity, QuantityPolicy, Side, TimeInForce, Timestamp, orders::OrderFlags};

    fn create_standard_order() -> LimitOrder {
        LimitOrder::new(
            Price(90),
            QuantityPolicy::Standard {
                quantity: Quantity(10),
            },
            OrderFlags::new(Side::Buy, true, TimeInForce::Gtc),
        )
    }

    fn create_iceberg_order() -> LimitOrder {
        LimitOrder::new(
            Price(100),
            QuantityPolicy::Iceberg {
                visible_quantity: Quantity(20),
                hidden_quantity: Quantity(40),
                replenish_quantity: Quantity(20),
            },
            OrderFlags::new(Side::Sell, false, TimeInForce::Gtc),
        )
    }

    #[test]
    fn test_time_priority() {
        let mut order = RestingLimitOrder::new(SequenceNumber(0), 0, create_standard_order());
        assert_eq!(order.time_priority(), SequenceNumber(0));

        order.update_time_priority(SequenceNumber(1));
        assert_eq!(order.time_priority(), SequenceNumber(1));
    }

    #[test]
    fn test_price() {
        let mut order = create_standard_order();
        assert_eq!(order.price(), Price(90));

        order.update_price(Price(95));
        assert_eq!(order.price(), Price(95));

        assert_eq!(create_iceberg_order().price(), Price(100));
    }

    #[test]
    fn test_quantity_policy() {
        {
            let mut order = create_standard_order();
            assert_eq!(order.visible_quantity(), Quantity(10));
            assert_eq!(order.hidden_quantity(), Quantity(0));
            assert_eq!(order.replenish_quantity(), Quantity(0));
            assert_eq!(order.total_quantity(), Quantity(10));
            assert!(!order.is_filled());

            order.update_quantity_policy(QuantityPolicy::Iceberg {
                visible_quantity: Quantity(1),
                hidden_quantity: Quantity(10),
                replenish_quantity: Quantity(1),
            });

            assert_eq!(order.visible_quantity(), Quantity(1));
            assert_eq!(order.hidden_quantity(), Quantity(10));
            assert_eq!(order.replenish_quantity(), Quantity(1));
            assert_eq!(order.total_quantity(), Quantity(11));
            assert!(!order.is_filled());
        }
        {
            let mut order = create_iceberg_order();
            assert_eq!(order.visible_quantity(), Quantity(20));
            assert_eq!(order.hidden_quantity(), Quantity(40));
            assert_eq!(order.replenish_quantity(), Quantity(20));
            assert_eq!(order.total_quantity(), Quantity(60));
            assert!(!order.is_filled());

            order.update_quantity_policy(QuantityPolicy::Standard {
                quantity: Quantity(100),
            });
            assert_eq!(order.visible_quantity(), Quantity(100));
            assert_eq!(order.hidden_quantity(), Quantity(0));
            assert_eq!(order.replenish_quantity(), Quantity(0));
            assert_eq!(order.total_quantity(), Quantity(100));
            assert!(!order.is_filled());
        }
    }

    #[test]
    fn test_side() {
        assert_eq!(create_standard_order().side(), Side::Buy);
        assert_eq!(create_iceberg_order().side(), Side::Sell);
    }

    #[test]
    fn test_post_only() {
        assert!(create_standard_order().post_only());
        assert!(!create_iceberg_order().post_only());
    }

    #[test]
    fn test_time_in_force() {
        let mut order = create_standard_order();
        assert_eq!(order.time_in_force(), TimeInForce::Gtc);
        assert!(!order.is_immediate());
        assert!(!order.has_expiry());
        assert!(!order.is_expired(Timestamp(1771180000)));

        order.update_time_in_force(TimeInForce::Ioc);
        assert!(order.is_immediate());
        assert!(!order.has_expiry());
        assert!(!order.is_expired(Timestamp(1771180000)));

        order.update_time_in_force(TimeInForce::Fok);
        assert!(order.is_immediate());
        assert!(!order.has_expiry());
        assert!(!order.is_expired(Timestamp(1771180000)));

        order.update_time_in_force(TimeInForce::Gtd(Timestamp(1771180000 + 1000)));
        assert!(!order.is_immediate());
        assert!(order.has_expiry());
        assert!(!order.is_expired(Timestamp(1771180000)));
        assert!(order.is_expired(Timestamp(1771180000 + 1000)));
    }

    #[test]
    fn test_match_against() {
        {
            let mut order = create_standard_order();
            assert_eq!(order.visible_quantity(), Quantity(10));
            assert_eq!(order.hidden_quantity(), Quantity(0));
            assert_eq!(order.replenish_quantity(), Quantity(0));

            let (consumed, replenished) = order.match_against(Quantity(2));
            assert_eq!(consumed, Quantity(2));
            assert_eq!(replenished, Quantity(0));
            assert_eq!(order.visible_quantity(), Quantity(8));
            assert_eq!(order.hidden_quantity(), Quantity(0));
            assert_eq!(order.replenish_quantity(), Quantity(0));

            let (consumed, replenished) = order.match_against(Quantity(10));
            assert_eq!(consumed, Quantity(8));
            assert_eq!(replenished, Quantity(0));
            assert_eq!(order.visible_quantity(), Quantity(0));
            assert_eq!(order.hidden_quantity(), Quantity(0));
            assert_eq!(order.replenish_quantity(), Quantity(0));

            let (consumed, replenished) = order.match_against(Quantity(10));
            assert_eq!(consumed, Quantity(0));
            assert_eq!(replenished, Quantity(0));
            assert_eq!(order.visible_quantity(), Quantity(0));
            assert_eq!(order.hidden_quantity(), Quantity(0));
            assert_eq!(order.replenish_quantity(), Quantity(0));
        }
        {
            let mut order = create_iceberg_order();
            assert_eq!(order.visible_quantity(), Quantity(20));
            assert_eq!(order.hidden_quantity(), Quantity(40));
            assert_eq!(order.replenish_quantity(), Quantity(20));

            let (consumed, replenished) = order.match_against(Quantity(5));
            assert_eq!(consumed, Quantity(5));
            assert_eq!(replenished, Quantity(0));
            assert_eq!(order.visible_quantity(), Quantity(15));
            assert_eq!(order.hidden_quantity(), Quantity(40));
            assert_eq!(order.replenish_quantity(), Quantity(20));

            let (consumed, replenished) = order.match_against(Quantity(20));
            assert_eq!(consumed, Quantity(15));
            assert_eq!(replenished, Quantity(20));
            assert_eq!(order.visible_quantity(), Quantity(20));
            assert_eq!(order.hidden_quantity(), Quantity(20));
            assert_eq!(order.replenish_quantity(), Quantity(20));

            let (consumed, replenished) = order.match_against(Quantity(20));
            assert_eq!(consumed, Quantity(20));
            assert_eq!(replenished, Quantity(20));
            assert_eq!(order.visible_quantity(), Quantity(20));
            assert_eq!(order.hidden_quantity(), Quantity(0));
            assert_eq!(order.replenish_quantity(), Quantity(20));

            let (consumed, replenished) = order.match_against(Quantity(1));
            assert_eq!(consumed, Quantity(1));
            assert_eq!(replenished, Quantity(0));
            assert_eq!(order.visible_quantity(), Quantity(19));
            assert_eq!(order.hidden_quantity(), Quantity(0));
            assert_eq!(order.replenish_quantity(), Quantity(20));

            let (consumed, replenished) = order.match_against(Quantity(19));
            assert_eq!(consumed, Quantity(19));
            assert_eq!(replenished, Quantity(0));
            assert_eq!(order.visible_quantity(), Quantity(0));
            assert_eq!(order.hidden_quantity(), Quantity(0));
            assert_eq!(order.replenish_quantity(), Quantity(20));

            let (consumed, replenished) = order.match_against(Quantity(1));
            assert_eq!(consumed, Quantity(0));
            assert_eq!(replenished, Quantity(0));
            assert_eq!(order.visible_quantity(), Quantity(0));
            assert_eq!(order.hidden_quantity(), Quantity(0));
            assert_eq!(order.replenish_quantity(), Quantity(20));
        }
    }

    #[test]
    fn test_display() {
        assert_eq!(
            create_standard_order().to_string(),
            "Standard: price=90 quantity=10 side=BUY post_only=true time_in_force=GTC"
        );
        assert_eq!(
            create_iceberg_order().to_string(),
            "Iceberg: price=100 visible_quantity=20 hidden_quantity=40 replenish_quantity=20 side=SELL post_only=false time_in_force=GTC"
        );
    }

    #[cfg(feature = "serde")]
    #[test]
    fn test_roundtrip_serialization() {
        for order in [create_standard_order(), create_iceberg_order()] {
            let serialized = serde_json::to_string(&order).unwrap();
            let deserialized: LimitOrder = serde_json::from_str(&serialized).unwrap();
            assert_eq!(order, deserialized);
        }
    }
}