roshar-types 0.1.25

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

use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct BitgetWssArg {
    #[serde(rename = "instType")]
    pub inst_type: String,
    pub channel: String,
    #[serde(rename = "instId")]
    pub inst_id: String,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct BitgetWssMessage {
    pub op: String,
    pub args: Vec<BitgetWssArg>,
}

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

    /// Bitget uses a plain text "ping" (server responds with "pong")
    pub fn ping() -> String {
        "ping".to_string()
    }

    /// Full orderbook (books channel) for a USDT-margined perpetual
    pub fn depth(symbol: &str) -> Self {
        Self {
            op: "subscribe".to_string(),
            args: vec![BitgetWssArg {
                inst_type: "USDT-FUTURES".to_string(),
                channel: "books".to_string(),
                inst_id: symbol.to_string(),
            }],
        }
    }

    pub fn depth_unsub(symbol: &str) -> Self {
        Self {
            op: "unsubscribe".to_string(),
            args: vec![BitgetWssArg {
                inst_type: "USDT-FUTURES".to_string(),
                channel: "books".to_string(),
                inst_id: symbol.to_string(),
            }],
        }
    }

    pub fn trades(symbol: &str) -> Self {
        Self {
            op: "subscribe".to_string(),
            args: vec![BitgetWssArg {
                inst_type: "USDT-FUTURES".to_string(),
                channel: "trade".to_string(),
                inst_id: symbol.to_string(),
            }],
        }
    }

    pub fn trades_unsub(symbol: &str) -> Self {
        Self {
            op: "unsubscribe".to_string(),
            args: vec![BitgetWssArg {
                inst_type: "USDT-FUTURES".to_string(),
                channel: "trade".to_string(),
                inst_id: symbol.to_string(),
            }],
        }
    }

    pub fn tickers(symbol: &str) -> Self {
        Self {
            op: "subscribe".to_string(),
            args: vec![BitgetWssArg {
                inst_type: "USDT-FUTURES".to_string(),
                channel: "ticker".to_string(),
                inst_id: symbol.to_string(),
            }],
        }
    }
}

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

    #[test]
    fn test_ping_is_text() {
        assert_eq!(BitgetWssMessage::ping(), "ping");
    }

    #[test]
    fn test_depth_subscribe() {
        let msg = BitgetWssMessage::depth("BTCUSDT");
        let json = msg.to_json();
        let parsed: serde_json::Value = serde_json::from_str(&json).unwrap();
        assert_eq!(parsed["op"], "subscribe");
        assert_eq!(parsed["args"][0]["channel"], "books");
        assert_eq!(parsed["args"][0]["instId"], "BTCUSDT");
        assert_eq!(parsed["args"][0]["instType"], "USDT-FUTURES");
    }

    #[test]
    fn test_trades_subscribe() {
        let msg = BitgetWssMessage::trades("BTCUSDT");
        let json = msg.to_json();
        let parsed: serde_json::Value = serde_json::from_str(&json).unwrap();
        assert_eq!(parsed["op"], "subscribe");
        assert_eq!(parsed["args"][0]["channel"], "trade");
        assert_eq!(parsed["args"][0]["instId"], "BTCUSDT");
    }
}