patisson-binance-sdk 0.1.8

Unofficial Rust SDK for the Binance exchange API
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
use rust_decimal::Decimal;
use serde::Deserialize;

use crate::{
    Timestamp,
    spot::{
        KlineInterval,
        http::OrderLevel,
        ws::{MessageID, StreamName},
    },
    ws::ReceivedMessage,
};

#[derive(PartialEq, Deserialize, Debug)]
#[serde(untagged)]
#[allow(clippy::large_enum_variant)]
pub enum IncomingMessage {
    CombinedStream(CombinedStreamMessage<StreamMessage>),
    Stream(StreamMessage),
    Error(ErrorMessage),
    Response(ResponseMessage), // last.
}

impl ReceivedMessage for IncomingMessage {
    fn server_shutdown_event_time(&self) -> Option<u64> {
        match self {
            IncomingMessage::Stream(StreamMessage::ServerShutdown(ServerShutdownMsg {
                event_time,
            })) => Some(*event_time),
            IncomingMessage::CombinedStream(CombinedStreamMessage {
                data: StreamMessage::ServerShutdown(ServerShutdownMsg { event_time }),
                ..
            }) => Some(*event_time),
            _ => None,
        }
    }
}

#[derive(PartialEq, Deserialize, Debug)]
pub struct ResponseMessage {
    pub id: Option<MessageID>,
    pub status: Option<i64>,
    pub result: Option<serde_json::Value>,
    pub rate_limits: Option<Vec<serde_json::Value>>,
}

#[derive(Debug, Deserialize, PartialEq)]
pub struct CombinedStreamMessage<T> {
    pub stream: StreamName,
    pub data: T,
}

#[derive(PartialEq, Deserialize, Debug)]
#[serde(tag = "e")]
pub enum StreamMessage {
    #[serde(rename = "aggTrade")]
    AggTrade(AggTradeMsg),
    #[serde(rename = "trade")]
    Trade(TradeMsg),
    #[serde(rename = "kline")]
    Kline(KlineMsg),
    #[serde(rename = "24hrMiniTicker")]
    MiniTicker24(MiniTicker24Msg),
    #[serde(rename = "depthUpdate")]
    DepthUpdate(DepthUpdateMsg),
    #[serde(rename = "serverShutdown")]
    ServerShutdown(ServerShutdownMsg),
}

/// The Aggregate Trade Streams push trade information that is aggregated for a single taker order.
#[derive(PartialEq, Deserialize, Debug)]
pub struct AggTradeMsg {
    /// Event time
    #[serde(rename = "E")]
    pub event_time: Timestamp,
    /// Symbol
    #[serde(rename = "s")]
    pub symbol: String,
    /// Aggregate trade ID
    #[serde(rename = "a")]
    pub trade_id: i64,
    /// Price
    #[serde(rename = "p")]
    pub price: Decimal,
    /// Quantity
    #[serde(rename = "q")]
    pub qty: Decimal,
    /// First trade ID
    #[serde(rename = "f")]
    pub first_trade_id: i64,
    /// Last trade ID
    #[serde(rename = "l")]
    pub last_trade_id: i64,
    /// Trade time
    #[serde(rename = "T")]
    pub trade_time: Timestamp,
    /// Is the buyer the market maker?
    #[serde(rename = "m")]
    pub is_buyer_maker: bool,
}

/// The Trade Streams push raw trade information; each trade has a unique buyer and seller.
#[derive(PartialEq, Deserialize, Debug)]
pub struct TradeMsg {
    /// Event time
    #[serde(rename = "E")]
    pub event_time: Timestamp,
    /// Symbol
    #[serde(rename = "s")]
    pub symbol: String,
    /// Trade ID
    #[serde(rename = "t")]
    pub trade_id: i64,
    /// Price
    #[serde(rename = "p")]
    pub price: Decimal,
    /// Quantity
    #[serde(rename = "q")]
    pub qty: Decimal,
    /// Trade time
    #[serde(rename = "T")]
    pub trade_time: Timestamp,
    /// Is the buyer the market maker?
    #[serde(rename = "m")]
    pub is_buyer_maker: bool,
}

/// The Kline/Candlestick Stream push updates to the current klines/candlestick every second in UTC+0 timezone
#[derive(PartialEq, Deserialize, Debug)]
pub struct KlineMsg {
    /// Event time
    #[serde(rename = "E")]
    pub event_time: Timestamp,
    /// Symbol
    #[serde(rename = "s")]
    pub symbol: String,
    #[serde(rename = "k")]
    pub kline: Kline,
}
#[derive(PartialEq, Deserialize, Debug)]
pub struct Kline {
    /// Kline start time
    #[serde(rename = "t")]
    pub start_time: Timestamp,
    /// Kline close time
    #[serde(rename = "T")]
    pub close_time: Timestamp,
    /// Symbol
    #[serde(rename = "s")]
    pub symbol: String,
    /// Interval
    #[serde(rename = "i")]
    pub interval: KlineInterval,
    /// First trade ID
    #[serde(rename = "f")]
    pub first_trade_id: i64,
    /// Last trade ID
    #[serde(rename = "L")]
    pub last_trade_id: i64,
    /// Open price
    #[serde(rename = "o")]
    pub open_price: Decimal,
    /// Close price
    #[serde(rename = "c")]
    pub close_price: Decimal,
    /// High price
    #[serde(rename = "h")]
    pub high_price: Decimal,
    /// Low price
    #[serde(rename = "l")]
    pub low_price: Decimal,
    /// Base asset volume
    #[serde(rename = "v")]
    pub base_asset_volume: Decimal,
    /// Number of trades
    #[serde(rename = "n")]
    pub trade_number: i64,
    /// Is this kline closed?
    #[serde(rename = "x")]
    pub is_closed: bool,
    /// Quote asset volume
    #[serde(rename = "q")]
    pub quote_asset_volume: Decimal,
    /// Taker buy base asset volume
    #[serde(rename = "V")]
    pub taker_buy_base_asset_volume: Decimal,
    /// Taker buy quote asset volume
    #[serde(rename = "Q")]
    pub taker_buy_quote_asset_volume: Decimal,
}

/// 24hr rolling window mini-ticker statistics. These are NOT the statistics of the UTC day, but a 24hr rolling window for the previous 24hrs.
#[derive(PartialEq, Deserialize, Debug)]
pub struct MiniTicker24Msg {
    /// Event time
    #[serde(rename = "E")]
    pub event_time: Timestamp,
    /// Symbol
    #[serde(rename = "s")]
    pub symbol: String,
    /// Open price
    #[serde(rename = "o")]
    pub open_price: Decimal,
    /// Close price
    #[serde(rename = "c")]
    pub close_price: Decimal,
    /// High price
    #[serde(rename = "h")]
    pub high_price: Decimal,
    /// Low price
    #[serde(rename = "l")]
    pub low_price: Decimal,
    /// Total traded base asset volume
    #[serde(rename = "v")]
    pub total_base_asset_volume: Decimal,
    /// Total traded quote asset volume
    #[serde(rename = "q")]
    pub total_quote_asset_volume: Decimal,
}

#[derive(PartialEq, Deserialize, Debug)]
pub struct DepthUpdateMsg {
    /// Event time
    #[serde(rename = "E")]
    pub event_time: Timestamp,
    /// Symbol
    #[serde(rename = "s")]
    pub symbol: String,
    /// First update ID in event
    #[serde(rename = "U")]
    pub first_update_id: i64,
    /// Final update ID in event
    #[serde(rename = "u")]
    pub final_update_id: i64,
    /// Bids to be updated (price + qty pairs).
    #[serde(rename = "b")]
    pub bids: Vec<OrderLevel>,
    /// Asks to be updated (price + qty pairs).
    #[serde(rename = "a")]
    pub asks: Vec<OrderLevel>,
}

#[derive(PartialEq, Deserialize, Debug)]
pub struct ServerShutdownMsg {
    /// Event time
    #[serde(rename = "E")]
    pub event_time: Timestamp,
}

#[derive(PartialEq, Deserialize, Debug)]
pub struct ErrorMessage {
    pub error: ErrorValueMessage,
    pub id: Option<MessageID>,
}

#[derive(PartialEq, Deserialize, Debug)]
pub struct ErrorValueMessage {
    pub code: i64,
    pub msg: String,
}

#[cfg(test)]
mod tests {
    use rust_decimal::dec;

    use crate::serde::deserialize_json;

    use super::*;

    #[test]
    fn test_deserialize_combined_stream_event() {
        let json = r#"{
            "stream": "bnbbtc@trade",
            "data": "DATA"
        }"#;
        let expected = CombinedStreamMessage {
            stream: StreamName::Trade {
                symbol: String::from("BNBBTC").to_lowercase(),
            },
            data: String::from("DATA"),
        };

        let current = deserialize_json(json).unwrap();

        assert_eq!(expected, current);
    }

    #[test]
    fn test_deserialize_stream_message_agg_trade() {
        let json = r#"{
            "e": "aggTrade",
            "E": 1672515782136,
            "s": "BNBBTC",
            "a": 12345,
            "p": "0.001",
            "q": "100",
            "f": 100,
            "l": 105,
            "T": 1672515782136,
            "m": true,
            "M": true
        }"#;
        let expected = AggTradeMsg {
            event_time: 1672515782136,
            symbol: String::from("BNBBTC"),
            trade_id: 12345,
            price: dec!(0.001),
            qty: dec!(100),
            first_trade_id: 100,
            last_trade_id: 105,
            trade_time: 1672515782136,
            is_buyer_maker: true,
        };

        let current = deserialize_json(json).unwrap();

        assert_eq!(expected, current);
    }

    #[test]
    fn test_deserialize_stream_message_trade() {
        let json = r#"{
            "e": "trade",
            "E": 1672515782136,
            "s": "BNBBTC",
            "t": 12345,
            "p": "0.001",
            "q": "100",
            "T": 1672515782136,
            "m": true,
            "M": true
        }"#;
        let expected = TradeMsg {
            event_time: 1672515782136,
            symbol: String::from("BNBBTC"),
            trade_id: 12345,
            price: dec!(0.001),
            qty: dec!(100),
            trade_time: 1672515782136,
            is_buyer_maker: true,
        };

        let current = deserialize_json(json).unwrap();

        assert_eq!(expected, current);
    }

    #[test]
    fn test_deserialize_stream_message_kline() {
        let json = r#"{
            "e": "kline",
            "E": 1672515782136,
            "s": "BNBBTC",
            "k": {
                "t": 1672515780000,
                "T": 1672515839999,
                "s": "BNBBTC",
                "i": "1m",
                "f": 100,
                "L": 200,
                "o": "0.0010",
                "c": "0.0020",
                "h": "0.0025",
                "l": "0.0015",
                "v": "1000",
                "n": 100,
                "x": false,
                "q": "1.0000",
                "V": "500",
                "Q": "0.500",
                "B": "123456"
            }
        }"#;
        let symbol = String::from("BNBBTC");
        let expected = KlineMsg {
            event_time: 1672515782136,
            symbol: symbol.clone(),
            kline: Kline {
                start_time: 1672515780000,
                close_time: 1672515839999,
                symbol,
                interval: KlineInterval::Minute1,
                first_trade_id: 100,
                last_trade_id: 200,
                open_price: dec!(0.0010),
                close_price: dec!(0.0020),
                high_price: dec!(0.0025),
                low_price: dec!(0.0015),
                base_asset_volume: dec!(1000),
                trade_number: 100,
                is_closed: false,
                quote_asset_volume: dec!(1.0000),
                taker_buy_base_asset_volume: dec!(500),
                taker_buy_quote_asset_volume: dec!(0.500),
            },
        };

        let current = deserialize_json(json).unwrap();

        assert_eq!(expected, current);
    }

    #[test]
    fn test_deserialize_stream_message_mini_ticker24() {
        let json = r#"{
            "e": "24hrMiniTicker",
            "E": 1672515782136,
            "s": "BNBBTC",
            "c": "0.0025",
            "o": "0.0010",
            "h": "0.0025",
            "l": "0.0010",
            "v": "10000",
            "q": "18"
        }"#;
        let expected = MiniTicker24Msg {
            event_time: 1672515782136,
            symbol: String::from("BNBBTC"),
            open_price: dec!(0.0010),
            close_price: dec!(0.0025),
            high_price: dec!(0.0025),
            low_price: dec!(0.0010),
            total_base_asset_volume: dec!(10000),
            total_quote_asset_volume: dec!(18),
        };

        let current = deserialize_json(json).unwrap();

        assert_eq!(expected, current);
    }

    #[test]
    fn test_deserialize_stream_message_response() {
        let json = r#"{"result":null,"id":"message-id"}"#;
        let parsed: IncomingMessage = deserialize_json(json).unwrap();
        assert!(
            matches!(parsed, IncomingMessage::Response(_)),
            "expected Response variant, got {parsed:?}",
        );
    }
}