roshar-types 0.1.20

Type definitions for cryptocurrency exchange websocket messages
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
use chrono::DateTime;
use serde::{Deserialize, Serialize};

use crate::{LocalOrderBook, LocalOrderBookError, OrderBookState, Trade, Venue};

// Hyperliquid Book Structures
#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct HyperliquidBookLevel {
    pub n: u32,
    pub px: String,
    pub sz: String,
}

#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct HyperliquidBook {
    pub coin: String,
    pub levels: Vec<Vec<HyperliquidBookLevel>>,
    pub time: u64,
}

#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct HyperliquidBookMessage {
    pub channel: String,
    pub data: HyperliquidBook,
}

impl HyperliquidBookMessage {
    pub fn to_order_book_state(&self) -> OrderBookState {
        let mut book = OrderBookState::new(50);

        for level in &self.data.levels[0] {
            if let Ok(px) = level.px.parse::<f64>() {
                if let Err(e) = book.set_bid(px, &level.sz) {
                    log::error!(
                        "Hyperliquid: failed to set bid for {} at price {}: {}",
                        self.data.coin,
                        px,
                        e
                    );
                }
            }
        }

        for level in &self.data.levels[1] {
            if let Ok(px) = level.px.parse::<f64>() {
                if let Err(e) = book.set_ask(px, &level.sz) {
                    log::error!(
                        "Hyperliquid: failed to set ask for {} at price {}: {}",
                        self.data.coin,
                        px,
                        e
                    );
                }
            }
        }

        // Trim after all updates are processed
        book.trim();

        book
    }

    pub fn to_depth_updates(&self) -> Vec<crate::DepthUpdateData> {
        let mut res = Vec::new();

        if let Some(bids) = self.data.levels.first() {
            for bid in bids {
                res.push(crate::DepthUpdateData {
                    px: bid.px.clone(),
                    qty: bid.sz.clone(),
                    time: self.data.time,
                    time_ts: DateTime::from_timestamp_millis(self.data.time as i64)
                        .unwrap_or_default(),
                    ticker: self.data.coin.clone(),
                    meta: format!("{{\"n\": {}}}", bid.n),
                    side: false,
                    venue: Venue::Hyperliquid,
                });
            }
        }

        if let Some(asks) = self.data.levels.get(1) {
            for ask in asks {
                res.push(crate::DepthUpdateData {
                    px: ask.px.clone(),
                    qty: ask.sz.clone(),
                    time: self.data.time,
                    time_ts: DateTime::from_timestamp_millis(self.data.time as i64)
                        .unwrap_or_default(),
                    ticker: self.data.coin.clone(),
                    meta: format!("{{\"n\": {}}}", ask.n),
                    side: true,
                    venue: Venue::Hyperliquid,
                });
            }
        }

        res
    }
}

// Hyperliquid Trade Structures
#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct HyperliquidTrade {
    pub coin: String,
    pub hash: String,
    pub px: String,         // Price as a string to preserve precision
    pub side: String,       // "B" for buy, "A" for sell
    pub sz: String,         // Size as a string to preserve precision
    pub tid: u64,           // Trade ID
    pub time: u64,          // Trade timestamp in milliseconds
    pub users: Vec<String>, // List of users involved in the trade
}

#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct HyperliquidTradesMessage {
    pub channel: String,
    pub data: Vec<HyperliquidTrade>,
}

impl HyperliquidTradesMessage {
    pub fn to_trades(&self) -> Vec<Trade> {
        let mut vals = Vec::with_capacity(self.data.len());

        for trade in &self.data {
            let px = match trade.px.parse::<f64>() {
                Ok(price) => price,
                Err(_) => continue,
            };

            let sz = match trade.sz.parse::<f64>() {
                Ok(size) => size,
                Err(_) => continue,
            };

            vals.push(Trade {
                time: trade.time as i64,
                exchange: Venue::Hyperliquid.to_string(),
                side: trade.side == "A",
                coin: trade.coin.clone(),
                px,
                sz,
            });
        }
        vals
    }

    pub fn to_trade_data(&self) -> Vec<crate::TradeData> {
        self.data
            .iter()
            .map(|trade| crate::TradeData {
                px: trade.px.clone(),
                qty: trade.sz.clone(),
                time: trade.time,
                time_ts: DateTime::from_timestamp_millis(trade.time as i64).unwrap_or_default(),
                ticker: trade.coin.clone(),
                meta: format!(
                    "{{\"tid\": {}, \"hash\": \"{}\", \"users\": {:?}}}",
                    trade.tid, trade.hash, trade.users
                ),
                side: trade.side == "A",
                venue: Venue::Hyperliquid,
            })
            .collect()
    }
}

#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct HyperliquidCandleData {
    #[serde(rename = "T")]
    pub close_time: u64, // Close time (epoch in millis)
    pub c: String, // Close price
    pub h: String, // High price
    pub i: String, // Interval (e.g., "1m")
    pub l: String, // Low price
    pub n: u32,    // Number of trades
    pub o: String, // Open price
    pub s: String, // Symbol (e.g., "ETH")
    pub t: u64,    // Open time (epoch in millis)
    pub v: String, // Volume
}

#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct HyperliquidCandleMessage {
    pub channel: String,
    pub data: HyperliquidCandleData,
}

impl HyperliquidCandleMessage {
    pub fn to_candle(&self) -> crate::Candle {
        crate::Candle {
            open: self.data.o.clone(),
            high: self.data.h.clone(),
            low: self.data.l.clone(),
            close: self.data.c.clone(),
            volume: self.data.v.clone(),
            exchange: Venue::Hyperliquid.to_string(),
            time: DateTime::from_timestamp_millis(self.data.t as i64).unwrap_or_default(),
            close_time: DateTime::from_timestamp_millis(self.data.close_time as i64)
                .unwrap_or_default(),
            coin: self.data.s.clone(),
        }
    }
}

// Hyperliquid User Fills Structures
#[derive(Serialize, Deserialize, Debug, Clone)]
#[serde(rename_all = "camelCase")]
pub struct HyperliquidUserFill {
    pub coin: String,
    pub px: String,
    pub sz: String,
    pub side: String,
    pub time: u64,
    pub start_position: String,
    pub dir: String,
    pub closed_pnl: String,
    pub hash: String,
    pub oid: u64,
    pub crossed: bool,
    pub fee: String,
    pub tid: u64,
    pub fee_token: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub liquidation: Option<serde_json::Value>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub builder_fee: Option<String>,
}

#[derive(Serialize, Deserialize, Debug, Clone)]
#[serde(rename_all = "camelCase")]
pub struct HyperliquidUserFillsData {
    #[serde(default)]
    pub is_snapshot: Option<bool>,
    pub user: String,
    pub fills: Vec<HyperliquidUserFill>,
}

#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct HyperliquidUserFillsMessage {
    pub channel: String,
    pub data: HyperliquidUserFillsData,
}

// Hyperliquid Order Updates Structures
#[derive(Serialize, Deserialize, Debug, Clone)]
#[serde(rename_all = "camelCase")]
pub struct WsBasicOrder {
    pub coin: String,
    pub side: String,
    #[serde(rename = "limitPx")]
    pub limit_px: String,
    pub sz: String,
    pub oid: u64,
    pub timestamp: u64,
    #[serde(rename = "origSz")]
    pub orig_sz: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub cloid: Option<String>,
}

#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct WsOrder {
    pub order: WsBasicOrder,
    pub status: String,
    #[serde(rename = "statusTimestamp")]
    pub status_timestamp: u64,
}

#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct HyperliquidOrderUpdatesMessage {
    pub channel: String,
    pub data: Vec<WsOrder>,
}

// Hyperliquid BBO Structures
#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct WsLevel {
    pub px: String,
    pub sz: String,
    pub n: u32,
}

#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct HyperliquidBbo {
    pub coin: String,
    pub time: u64,
    pub bbo: [Option<WsLevel>; 2], // [bid, ask]
}

#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct HyperliquidBboMessage {
    pub channel: String,
    pub data: HyperliquidBbo,
}

#[derive(Debug, Deserialize, Serialize, Clone)]
pub struct HyperliquidWssSubscription {
    #[serde(rename = "type")]
    pub typ: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub interval: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub coin: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub user: Option<String>,
}

// Hyperliquid WebSocket Message Types
#[derive(Debug, Deserialize, Serialize, Clone)]
pub struct HyperliquidWssMessage {
    pub method: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub subscription: Option<HyperliquidWssSubscription>,
}

impl HyperliquidWssMessage {
    pub fn to_json(&self) -> String {
        serde_json::to_string(self).expect("failed to serialize HyperliquidWssMessage")
    }

    pub fn ping() -> Self {
        Self {
            method: "ping".to_string(),
            subscription: None,
        }
    }

    pub fn all_mids() -> Self {
        Self {
            method: "subscribe".to_string(),
            subscription: Some(HyperliquidWssSubscription {
                typ: "allMids".into(),
                interval: None,
                coin: None,
                user: None,
            }),
        }
    }

    pub fn l2_book(coin: &str) -> Self {
        Self {
            method: "subscribe".to_string(),
            subscription: Some(HyperliquidWssSubscription {
                typ: "l2Book".into(),
                interval: None,
                coin: Some(coin.into()),
                user: None,
            }),
        }
    }

    pub fn l2_book_unsub(coin: &str) -> Self {
        Self {
            method: "unsubscribe".to_string(),
            subscription: Some(HyperliquidWssSubscription {
                typ: "l2Book".into(),
                interval: None,
                coin: Some(coin.into()),
                user: None,
            }),
        }
    }

    pub fn candle(coin: &str) -> Self {
        Self {
            method: "subscribe".to_string(),
            subscription: Some(HyperliquidWssSubscription {
                typ: "candle".into(),
                interval: Some("1m".into()),
                coin: Some(coin.into()),
                user: None,
            }),
        }
    }

    pub fn candle_unsub(coin: &str) -> Self {
        Self {
            method: "unsubscribe".to_string(),
            subscription: Some(HyperliquidWssSubscription {
                typ: "candle".into(),
                interval: Some("1m".into()),
                coin: Some(coin.into()),
                user: None,
            }),
        }
    }

    pub fn trades(coin: &str) -> Self {
        Self {
            method: "subscribe".to_string(),
            subscription: Some(HyperliquidWssSubscription {
                typ: "trades".into(),
                interval: None,
                coin: Some(coin.into()),
                user: None,
            }),
        }
    }

    pub fn trades_unsub(coin: &str) -> Self {
        Self {
            method: "unsubscribe".to_string(),
            subscription: Some(HyperliquidWssSubscription {
                typ: "trades".into(),
                interval: None,
                coin: Some(coin.into()),
                user: None,
            }),
        }
    }

    pub fn user_fills(user_address: &str) -> Self {
        Self {
            method: "subscribe".to_string(),
            subscription: Some(HyperliquidWssSubscription {
                typ: "userFills".into(),
                interval: None,
                coin: None,
                user: Some(user_address.into()),
            }),
        }
    }

    pub fn user_fills_unsub(user_address: &str) -> Self {
        Self {
            method: "unsubscribe".to_string(),
            subscription: Some(HyperliquidWssSubscription {
                typ: "userFills".into(),
                interval: None,
                coin: None,
                user: Some(user_address.into()),
            }),
        }
    }

    pub fn order_updates(user_address: &str) -> Self {
        Self {
            method: "subscribe".to_string(),
            subscription: Some(HyperliquidWssSubscription {
                typ: "orderUpdates".into(),
                interval: None,
                coin: None,
                user: Some(user_address.into()),
            }),
        }
    }

    pub fn order_updates_unsub(user_address: &str) -> Self {
        Self {
            method: "unsubscribe".to_string(),
            subscription: Some(HyperliquidWssSubscription {
                typ: "orderUpdates".into(),
                interval: None,
                coin: None,
                user: Some(user_address.into()),
            }),
        }
    }

    pub fn bbo(coin: &str) -> Self {
        Self {
            method: "subscribe".to_string(),
            subscription: Some(HyperliquidWssSubscription {
                typ: "bbo".into(),
                interval: None,
                coin: Some(coin.into()),
                user: None,
            }),
        }
    }

    pub fn bbo_unsub(coin: &str) -> Self {
        Self {
            method: "unsubscribe".to_string(),
            subscription: Some(HyperliquidWssSubscription {
                typ: "bbo".into(),
                interval: None,
                coin: Some(coin.into()),
                user: None,
            }),
        }
    }
}

pub struct HlOrderBook {
    pub symbol: String,
    pub book: Option<OrderBookState>,
}

impl HlOrderBook {
    pub fn new(symbol: String) -> Self {
        Self { symbol, book: None }
    }

    /// Get a read-only view of the order book for calculations
    pub fn as_view(&self) -> Option<LocalOrderBook<'_>> {
        self.book.as_ref().map(|b| b.as_view())
    }

    pub fn new_message(&mut self, msg: &HyperliquidBookMessage) -> Result<(), LocalOrderBookError> {
        if msg.data.coin != self.symbol {
            return Err(LocalOrderBookError::WrongSymbol(
                self.symbol.clone(),
                msg.data.coin.clone(),
            ));
        }

        self.book = Some(msg.to_order_book_state());
        Ok(())
    }
}

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

    #[test]
    fn test_wss_message_ping() {
        let msg = HyperliquidWssMessage::ping();
        let json = msg.to_json();
        let parsed: serde_json::Value = serde_json::from_str(&json).unwrap();

        assert_eq!(parsed["method"], "ping");
        assert!(parsed["subscription"].is_null());
    }

    #[test]
    fn test_wss_message_candle() {
        let coin = "ETH";
        let msg = HyperliquidWssMessage::candle(coin);
        let json = msg.to_json();
        let parsed: serde_json::Value = serde_json::from_str(&json).unwrap();

        assert_eq!(parsed["method"], "subscribe");
        assert_eq!(parsed["subscription"]["type"], "candle");
        assert_eq!(parsed["subscription"]["coin"], coin);
        assert_eq!(parsed["subscription"]["interval"], "1m");
    }

    #[test]
    fn test_wss_message_l2_book() {
        let coin = "BTC";
        let msg = HyperliquidWssMessage::l2_book(coin);
        let json = msg.to_json();
        let parsed: serde_json::Value = serde_json::from_str(&json).unwrap();

        assert_eq!(parsed["method"], "subscribe");
        assert_eq!(parsed["subscription"]["type"], "l2Book");
        assert_eq!(parsed["subscription"]["coin"], coin);
        assert!(parsed["subscription"]["interval"].is_null());
    }

    #[test]
    fn test_wss_message_trades() {
        let coin = "SOL";
        let msg = HyperliquidWssMessage::trades(coin);
        let json = msg.to_json();
        let parsed: serde_json::Value = serde_json::from_str(&json).unwrap();

        assert_eq!(parsed["method"], "subscribe");
        assert_eq!(parsed["subscription"]["type"], "trades");
        assert_eq!(parsed["subscription"]["coin"], coin);
        assert!(parsed["subscription"]["interval"].is_null());
    }

    #[test]
    fn test_wss_message_all_mids() {
        let msg = HyperliquidWssMessage::all_mids();
        assert_eq!(msg.method, "subscribe");
        let sub = msg.subscription.unwrap();
        assert_eq!(sub.typ, "allMids");
        assert!(sub.coin.is_none());
        assert!(sub.interval.is_none());
    }

    #[test]
    fn test_book_message_to_local_order_book() {
        let book_msg = HyperliquidBookMessage {
            channel: "book".to_string(),
            data: HyperliquidBook {
                coin: "ETH".to_string(),
                levels: vec![
                    vec![HyperliquidBookLevel {
                        n: 1,
                        px: "2000.50".to_string(),
                        sz: "1.5".to_string(),
                    }],
                    vec![HyperliquidBookLevel {
                        n: 1,
                        px: "2001.00".to_string(),
                        sz: "2.0".to_string(),
                    }],
                ],
                time: 1640995200000,
            },
        };

        let book_state = book_msg.to_order_book_state();
        let view = book_state.as_view();
        assert_eq!(view.bid_prices().len(), 1);
        assert_eq!(view.ask_prices().len(), 1);
        assert_eq!(view.bid_prices()[0], "2000.5");
        assert_eq!(view.ask_prices()[0], "2001");
    }

    #[test]
    fn test_hyperliquid_trades_message_to_trades() {
        let trades_msg = HyperliquidTradesMessage {
            channel: "trades".to_string(),
            data: vec![HyperliquidTrade {
                coin: "BTC".to_string(),
                hash: "abc123".to_string(),
                px: "50000.00".to_string(),
                side: "B".to_string(),
                sz: "0.1".to_string(),
                tid: 12345,
                time: 1640995200000,
                users: vec!["user1".to_string()],
            }],
        };

        let trades = trades_msg.to_trades();
        assert_eq!(trades.len(), 1);

        let trade = &trades[0];
        assert_eq!(trade.coin, "BTC");
        assert_eq!(trade.exchange, Venue::Hyperliquid.to_string());
        assert_eq!(trade.px, 50000.00);
        assert_eq!(trade.sz, 0.1);
        assert!(!trade.side); // "B" for buy = false in our side convention
        assert_eq!(trade.time, 1640995200000);
    }

    #[test]
    fn test_hl_order_book_new() {
        let order_book = HlOrderBook::new("BTC".to_string());
        assert!(order_book.book.is_none());
    }

    #[test]
    fn test_hl_order_book_new_message() {
        let mut order_book = HlOrderBook::new("BTC".to_string());

        let book_msg = HyperliquidBookMessage {
            channel: "book".to_string(),
            data: HyperliquidBook {
                coin: "BTC".to_string(),
                levels: vec![
                    vec![HyperliquidBookLevel {
                        n: 1,
                        px: "50000.00".to_string(),
                        sz: "1.0".to_string(),
                    }],
                    vec![HyperliquidBookLevel {
                        n: 1,
                        px: "50100.00".to_string(),
                        sz: "0.5".to_string(),
                    }],
                ],
                time: 1640995200000,
            },
        };

        assert!(order_book.new_message(&book_msg).is_ok());
        assert!(order_book.book.is_some());

        let view = order_book.as_view().unwrap();
        let bbo = view.get_bbo();
        assert_eq!(bbo.0, "50000");
        assert_eq!(bbo.1, "50100");
    }

    #[test]
    fn test_hl_order_book_wrong_symbol() {
        let mut order_book = HlOrderBook::new("BTC".to_string());

        let book_msg = HyperliquidBookMessage {
            channel: "book".to_string(),
            data: HyperliquidBook {
                coin: "ETH".to_string(),
                levels: vec![
                    vec![HyperliquidBookLevel {
                        n: 1,
                        px: "50000.00".to_string(),
                        sz: "1.0".to_string(),
                    }],
                    vec![HyperliquidBookLevel {
                        n: 1,
                        px: "50100.00".to_string(),
                        sz: "0.5".to_string(),
                    }],
                ],
                time: 1640995200000,
            },
        };

        let result = order_book.new_message(&book_msg);
        assert!(result.is_err());
        if let Err(crate::LocalOrderBookError::WrongSymbol(expected, received)) = result {
            assert_eq!(expected, "BTC");
            assert_eq!(received, "ETH");
        } else {
            panic!("Expected WrongSymbol error");
        }
    }
}