matchina 0.1.3

Minimalistic matching engine designed for a trading exchange
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
use std::{cmp::Ordering, fmt::Display};

use compact_str::CompactString;
use rust_decimal::Decimal;
use serde::{Deserialize, Serialize};
use thiserror::Error;

#[derive(Clone, Copy, Debug, Hash, Serialize, Deserialize, PartialEq, Eq)]
pub struct OrderId(u64);

impl OrderId {
    #[inline]
    pub fn new(order_id: u64) -> Self {
        Self(order_id)
    }
}

impl From<u64> for OrderId {
    fn from(value: u64) -> OrderId {
        OrderId::new(value)
    }
}

impl Display for OrderId {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "order_id:{}", self.0)
    }
}

// TODO use struct to give behavior (see OrderId)
pub type OrderPrice = Decimal;
pub type OrderQuantity = Decimal;

#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "UPPERCASE", tag = "order_request")]
pub enum OrderRequest {
    Create {
        account_id: CompactString,
        order_id: u64,
        pair: CompactString,
        side: OrderSide,
        limit_price: Option<Decimal>, // for market orders use None
        quantity: Decimal,
    },
    Cancel {
        order_id: u64,
    },
}

impl Display for OrderRequest {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            OrderRequest::Create {
                account_id: _,
                order_id,
                pair: _,
                side,
                limit_price,
                quantity,
            } => match limit_price {
                Some(limit_price) => write!(f, "ORDER[{order_id}] {side} {quantity}@{limit_price}"),
                None => write!(f, "ORDER[{order_id}] {side} {quantity}@MARKET"),
            },
            OrderRequest::Cancel { order_id } => write!(f, "[CANCEL] order_id: {order_id}"),
        }
    }
}

#[derive(Clone, Copy, Debug, Serialize, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "UPPERCASE")]
pub enum OrderSide {
    Ask,
    Bid,
}

impl Display for OrderSide {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            OrderSide::Ask => write!(f, "SELL"),
            OrderSide::Bid => write!(f, "BUY"),
        }
    }
}

impl std::ops::Not for OrderSide {
    type Output = OrderSide;

    #[inline]
    fn not(self) -> Self::Output {
        match self {
            Self::Ask => Self::Bid,
            Self::Bid => Self::Ask,
        }
    }
}

#[derive(Clone, Copy, Debug, Serialize, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "UPPERCASE", tag = "order_type")]
pub enum OrderType {
    Limit {
        limit_price: OrderPrice,
        #[serde(default)]
        time_in_force: TimeInForce,
    },

    Market {
        #[serde(default, skip_serializing_if = "core::ops::Not::not")]
        fill_or_kill: bool,
    },
}

#[derive(Clone, Copy, Debug, Serialize, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "UPPERCASE", tag = "time_in_force")]
pub enum TimeInForce {
    #[serde(rename = "GTC")]
    GoodTilCancel {
        #[serde(default, skip_serializing_if = "core::ops::Not::not")]
        post_only: bool,
    },
    #[serde(rename = "IOC")]
    ImmediateOrCancel {
        #[serde(default, skip_serializing_if = "core::ops::Not::not")]
        fill_or_kill: bool,
    },
}

impl Default for TimeInForce {
    fn default() -> Self {
        Self::GoodTilCancel { post_only: false }
    }
}

#[derive(Clone, Copy, Debug, Default, Serialize, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "UPPERCASE")]
pub enum OrderStatus {
    #[default]
    Open,
    Partial,
    Cancelled,
    Closed,
    Completed,
}

#[derive(Clone, Copy, Debug, Serialize, Deserialize)]
pub struct Order {
    id: OrderId,
    side: OrderSide,
    //#[serde(flatten)]
    type_: OrderType,
    order_quantity: OrderQuantity,
    //#[serde(default)]
    filled_quantity: OrderQuantity,
    status: OrderStatus,
}

impl Order {
    #[inline]
    pub fn limit_order(id: OrderId, side: OrderSide, quantity: OrderQuantity, limit_price: OrderPrice) -> Self {
        Self {
            id,
            side,
            type_: OrderType::Limit {
                limit_price,
                time_in_force: Default::default(),
            },
            order_quantity: quantity,
            filled_quantity: 0.into(),
            status: OrderStatus::Open,
        }
    }

    #[inline]
    pub fn market_order(id: OrderId, side: OrderSide, quantity: OrderQuantity) -> Self {
        Self {
            id,
            side,
            type_: OrderType::Market {
                fill_or_kill: Default::default(),
            },
            order_quantity: quantity,
            filled_quantity: 0.into(),
            status: OrderStatus::Open,
        }
    }

    #[inline]
    pub fn id(&self) -> OrderId {
        self.id
    }

    #[inline]
    pub fn side(&self) -> OrderSide {
        self.side
    }

    #[inline]
    pub fn remaining(&self) -> OrderQuantity {
        self.order_quantity - self.filled_quantity
    }

    #[inline]
    fn status(&self) -> OrderStatus {
        self.status
    }

    #[inline]
    pub fn limit_price(&self) -> Option<OrderPrice> {
        match self.type_ {
            OrderType::Limit { limit_price, .. } => Some(limit_price),
            OrderType::Market { .. } => None,
        }
    }

    pub fn can_trade(&self, order: &Order) -> OrderQuantity {
        self.remaining().min(order.remaining())
    }

    #[inline]
    pub fn is_bookable(&self) -> bool {
        match self.type_ {
            OrderType::Limit { .. } => true,
            OrderType::Market { .. } => false,
        }
    }

    #[inline]
    pub fn is_closed(&self) -> bool {
        matches!(
            self.status(),
            OrderStatus::Cancelled | OrderStatus::Closed | OrderStatus::Completed
        )
    }

    #[inline]
    pub fn matches(&self, maker: &Self) -> bool {
        let taker = self;

        if taker.is_closed() || maker.is_closed() || maker.limit_price().is_none() {
            // the last condition should never happen (...)
            return false;
        }

        match taker.type_ {
            OrderType::Limit { .. } => match (taker.side(), maker.side()) {
                (OrderSide::Ask, OrderSide::Bid) => taker <= maker,
                (OrderSide::Bid, OrderSide::Ask) => taker >= maker,
                _ => false,
            },
            OrderType::Market { .. } => true,
        }
    }

    #[inline]
    pub fn fill(&mut self, quantity: OrderQuantity) -> Result<(), OrderError> {
        if quantity > self.remaining() {
            return Err(OrderError::Overfill {
                fill: quantity,
                remaining: self.remaining(),
            });
        }

        self.filled_quantity += quantity;
        self.status = if self.filled_quantity == self.order_quantity {
            OrderStatus::Completed
        } else {
            OrderStatus::Partial
        };

        Ok(())
    }

    #[inline]
    pub fn cancel(&mut self) {
        match self.status() {
            OrderStatus::Open => self.status = OrderStatus::Cancelled,
            OrderStatus::Partial => self.status = OrderStatus::Closed,
            _ => (),
        }
    }

    // allow this mutation but only for unit tests
    #[cfg(test)]
    pub fn mutate_type(&mut self, order_type: OrderType) {
        self.type_ = order_type;
    }
}

impl PartialEq for Order {
    #[inline]
    fn eq(&self, other: &Self) -> bool {
        self.id.eq(&other.id)
    }
}
impl Eq for Order {}

impl PartialOrd for Order {
    #[inline]
    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
        let ord = if self.id.eq(&other.id) {
            Ordering::Equal
        } else {
            self.limit_price().cmp(&other.limit_price())
        };

        Some(ord)
    }
}

impl Display for Order {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let order_id = self.id;
        let side = self.side;
        let quantity = self.order_quantity;
        match self.limit_price() {
            Some(limit_price) => write!(f, "ORDER[{order_id}] {side} {quantity}@{limit_price}"),
            None => write!(f, "ORDER[{order_id}] {side} {quantity}@MARKET"),
        }
    }
}

pub trait OrderFeatures {
    fn is_fill_or_kill(&self) -> bool;

    fn is_immediate_or_cancel(&self) -> bool;

    fn is_post_only(&self) -> bool;
}

impl OrderFeatures for Order {
    fn is_fill_or_kill(&self) -> bool {
        matches!(
            self.type_,
            OrderType::Limit {
                time_in_force: TimeInForce::ImmediateOrCancel { fill_or_kill: true },
                ..
            } | OrderType::Market { fill_or_kill: true }
        )
    }

    fn is_post_only(&self) -> bool {
        matches!(
            self.type_,
            OrderType::Limit {
                time_in_force: TimeInForce::GoodTilCancel { post_only: true },
                ..
            }
        )
    }

    fn is_immediate_or_cancel(&self) -> bool {
        matches!(
            self.type_,
            OrderType::Limit {
                time_in_force: TimeInForce::ImmediateOrCancel { .. },
                ..
            } | OrderType::Market { .. }
        )
    }
}

#[derive(Debug, Error, PartialEq)]
pub enum OrderError {
    #[error("fill exceeds remaning amount (fill={}, remaining={})", .fill, .remaining)]
    Overfill {
        fill: OrderQuantity,
        remaining: OrderQuantity,
    },
}

pub mod util {
    use compact_str::{format_compact, CompactString};
    use rand::{rngs::ThreadRng, Rng};
    use rust_decimal::Decimal;

    use super::{OrderRequest, OrderSide};

    pub const DEFAULT_PAIR: &str = "ETH/USDT";

    pub fn generate(range: impl Iterator<Item = usize>) -> impl Iterator<Item = OrderRequest> {
        let mut rng = rand::thread_rng();

        range.map(move |i| {
            if rng.gen_bool(1.0 / 1000.0) {
                OrderRequest::Cancel {
                    order_id: rng.gen_range(1..=i as u64),
                }
            } else {
                OrderRequest::Create {
                    account_id: format_compact!("{}", rng.gen_range(1..10)),
                    order_id: i as u64,
                    pair: CompactString::new_inline(DEFAULT_PAIR),
                    side: if rng.gen_bool(0.5) {
                        OrderSide::Ask
                    } else {
                        OrderSide::Bid
                    },
                    limit_price: if rng.gen_bool(0.8) {
                        Some(random_decimal(&mut rng))
                    } else {
                        None
                    },
                    quantity: random_decimal(&mut rng),
                }
            }
        })
    }

    pub fn random_decimal(rng: &mut ThreadRng) -> Decimal {
        Decimal::new(rng.gen_range(10000..1_000_000), 2)
    }
}

#[cfg(test)]
mod test {
    use rstest::{fixture, rstest};

    use super::*;

    // convention for order ids: 3-digit side (bid = 900, ask = 901), 3-digit quantity, 3-digit price (for market orders always 999)

    #[fixture]
    fn ask_050_at_013() -> Order {
        let order_id = OrderId::new(901_050_013);
        Order::limit_order(order_id, OrderSide::Ask, 50.into(), 13.into())
    }

    #[fixture]
    fn ask_070_at_014() -> Order {
        let order_id = OrderId::new(901_070_014);
        Order::limit_order(order_id, OrderSide::Ask, 70.into(), 14.into())
    }

    #[fixture]
    fn ask_070_at_market() -> Order {
        let order_id = OrderId::new(901_070_999);
        Order::market_order(order_id, OrderSide::Ask, 70.into())
    }

    #[fixture]
    fn bid_020_at_014() -> Order {
        let order_id = OrderId::new(900_020_014);
        Order::limit_order(order_id, OrderSide::Bid, 20.into(), 14.into())
    }

    #[fixture]
    fn bid_040_at_013() -> Order {
        let order_id = OrderId::new(900_040_013);
        Order::limit_order(order_id, OrderSide::Bid, 40.into(), 13.into())
    }

    #[fixture]
    fn bid_040_at_market() -> Order {
        let order_id = OrderId::new(900_040_999);
        Order::market_order(order_id, OrderSide::Bid, 40.into())
    }

    mod limit_orders {
        use super::*;

        fn assert_opposite_side(ask: &Order, bid: &Order, cmp: Ordering) {
            assert_ne!(ask.side(), bid.side());
            assert_eq!(ask.side(), OrderSide::Ask);
            assert_eq!(bid.side(), OrderSide::Bid);

            let ask_price = ask.limit_price().unwrap();
            let bid_price = bid.limit_price().unwrap();

            assert_eq!(ask_price.cmp(&bid_price), cmp);
        }

        #[rstest]
        fn match_same_price(ask_070_at_014: Order, bid_020_at_014: Order) {
            // first confirm prices are the same and then confirm orders are matching
            assert_opposite_side(&ask_070_at_014, &bid_020_at_014, Ordering::Equal);
            assert!(ask_070_at_014.matches(&bid_020_at_014));
        }

        #[rstest]
        fn match_crossing_price(ask_050_at_013: Order, bid_020_at_014: Order) {
            // first confirm prices are the same and then confirm orders are matching
            assert_opposite_side(&ask_050_at_013, &bid_020_at_014, Ordering::Less);
            assert!(ask_050_at_013.matches(&bid_020_at_014));
        }

        #[rstest]
        fn no_match(ask_070_at_014: Order, bid_040_at_013: Order) {
            // first confirm ask price is higher than bid price and then confirm orders are not matching
            assert_opposite_side(&ask_070_at_014, &bid_040_at_013, Ordering::Greater);
            assert!(!ask_070_at_014.matches(&bid_040_at_013));
        }
    }

    mod market_orders {
        use super::*;

        #[rstest]
        fn match_bid(ask_070_at_014: Order, bid_040_at_market: Order) {
            // the ask is the limit order, the bid is the market order
            assert_ne!(ask_070_at_014.limit_price(), None);
            assert_eq!(bid_040_at_market.limit_price(), None);

            // if the market order is the taker then it should match
            assert!(bid_040_at_market.matches(&ask_070_at_014));
            // if the market order is the maker then it should not match (this should never happen)
            assert!(!ask_070_at_014.matches(&bid_040_at_market));
        }

        #[rstest]
        fn match_ask(ask_070_at_market: Order, bid_040_at_013: Order) {
            // the bid is the limit order, the ask is the market order
            assert_ne!(bid_040_at_013.limit_price(), None);
            assert_eq!(ask_070_at_market.limit_price(), None);

            // if the market order is the taker then it should match
            assert!(ask_070_at_market.matches(&bid_040_at_013));
            // if the market order is the maker then it should not match (this should never happen)
            assert!(!bid_040_at_013.matches(&ask_070_at_market));
        }
    }

    mod features {
        use super::*;

        #[rstest]
        fn check_defaults() {
            // the default time in force is GTC
            let gtc = TimeInForce::GoodTilCancel { post_only: false };
            assert_eq!(TimeInForce::default(), gtc);
        }

        #[rstest]
        fn is_fill_or_kill(ask_070_at_market: Order, bid_040_at_013: Order) {
            // this market order is not FOK by default, first confirm that then mutate to make it FOK
            let mut market_order = ask_070_at_market;
            assert!(!market_order.is_fill_or_kill());

            let fok = OrderType::Market { fill_or_kill: true };
            market_order.type_ = fok;
            assert!(market_order.is_fill_or_kill());

            // this limit order is not FOK by default, first confirm that then mutate to make it FOK
            let mut limit_order = bid_040_at_013;
            assert!(!limit_order.is_fill_or_kill());

            let fok = TimeInForce::ImmediateOrCancel { fill_or_kill: true };
            limit_order.type_ = OrderType::Limit {
                limit_price: Decimal::ZERO,
                time_in_force: fok,
            };
            assert!(limit_order.is_fill_or_kill());
        }

        #[rstest]
        fn is_post_only(ask_070_at_market: Order, bid_040_at_013: Order) {
            // market orders cannot be GTC
            assert_eq!(ask_070_at_market.type_, OrderType::Market { fill_or_kill: false });
            assert!(!ask_070_at_market.is_post_only());

            // this limit order is not GTC by default, first confirm that then mutate to make it GTC
            let mut limit_order = bid_040_at_013;
            assert!(!limit_order.is_post_only());

            // change the limit order to GTC but without enforcing post_only
            let gtc = TimeInForce::GoodTilCancel { post_only: false };
            limit_order.type_ = OrderType::Limit {
                limit_price: Decimal::ZERO,
                time_in_force: gtc,
            };
            assert!(!limit_order.is_post_only());

            // change the limit order to GTC but enforcing post_only
            let gtc = TimeInForce::GoodTilCancel { post_only: true };
            limit_order.type_ = OrderType::Limit {
                limit_price: Decimal::ZERO,
                time_in_force: gtc,
            };
            assert!(limit_order.is_post_only());
        }

        #[rstest]
        fn is_immediate_or_cancel(ask_070_at_market: Order, bid_040_at_013: Order) {
            // market orders are IOC
            assert_eq!(ask_070_at_market.type_, OrderType::Market { fill_or_kill: false });
            assert!(ask_070_at_market.is_immediate_or_cancel());

            // this limit order is not IOC by default, first confirm that then mutate to make it IOC
            let mut limit_order = bid_040_at_013;
            assert!(!limit_order.is_immediate_or_cancel());

            let ioc = TimeInForce::ImmediateOrCancel { fill_or_kill: false };
            limit_order.type_ = OrderType::Limit {
                limit_price: Decimal::ZERO,
                time_in_force: ioc,
            };
            assert!(limit_order.is_immediate_or_cancel());
        }
    }
}