crypto-msg-parser 2.9.2

Parse websocket messages from cryptocurreny exchanges
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
use crypto_market_type::MarketType;
use crypto_msg_type::MessageType;

use crate::exchanges::utils::calc_quantity_and_volume;
use crypto_message::{BboMsg, CandlestickMsg, Order, OrderBookMsg, TradeMsg, TradeSide};

use serde::{Deserialize, Serialize};
use serde_json::Value;
use simple_error::SimpleError;
use std::collections::HashMap;

const EXCHANGE_NAME: &str = "kraken";

// https://docs.kraken.com/websockets/#message-trade
#[derive(Serialize, Deserialize)]
struct SpotTradeMsg {
    #[serde(rename = "type")]
    type_: String,
    trade_id: i64,
    sequence: i64,
    maker_order_id: String,
    taker_order_id: String,
    time: String,
    product_id: String,
    size: String,
    price: String,
    side: String, // b, s
    #[serde(flatten)]
    extra: HashMap<String, Value>,
}

// https://docs.kraken.com/websockets/#message-book
#[derive(Serialize, Deserialize)]
struct OrderbookSnapshot {
    #[serde(rename = "as")]
    asks: Vec<[String; 3]>,
    #[serde(rename = "bs")]
    bids: Vec<[String; 3]>,
    #[serde(flatten)]
    extra: HashMap<String, Value>,
}

// https://docs.kraken.com/websockets/#message-book
#[derive(Serialize, Deserialize)]
struct OrderbookUpdate {
    a: Option<Vec<Vec<String>>>,
    b: Option<Vec<Vec<String>>>,
    #[serde(flatten)]
    extra: HashMap<String, Value>,
}

#[derive(Serialize, Deserialize)]
struct RestResp {
    error: Vec<Value>,
    result: HashMap<String, Value>,
    #[serde(flatten)]
    extra: HashMap<String, Value>,
}

pub(super) fn extract_symbol(msg: &str) -> Result<String, SimpleError> {
    if let Ok(rest_resp) = serde_json::from_str::<RestResp>(msg) {
        // RESTful API
        if !rest_resp.error.is_empty() {
            Err(SimpleError::new(format!("Error http response {msg}")))
        } else if rest_resp.result.len() > 1 {
            Ok("ALL".to_string())
        } else {
            Ok(rest_resp.result.keys().next().unwrap().to_string())
        }
    } else {
        // websocket
        let arr = serde_json::from_str::<Vec<Value>>(msg)
            .map_err(|_e| SimpleError::new(format!("Failed to deserialize {msg} to Vec<Value>")))?;
        let symbol = arr[arr.len() - 1].as_str().unwrap();
        Ok(symbol.to_string())
    }
}

pub(super) fn extract_timestamp(msg: &str) -> Result<Option<i64>, SimpleError> {
    if msg.contains("error") && msg.contains("result") {
        // RESTful API
        return Ok(None);
    }
    let arr = serde_json::from_str::<Vec<Value>>(msg)
        .map_err(|_e| SimpleError::new(format!("Failed to deserialize {msg} to Vec<Value>")))?;
    debug_assert_eq!(arr.len(), 4);
    let channel = arr[arr.len() - 2].as_str().unwrap();
    if channel == "trade" {
        let raw_trades: Vec<Vec<String>> =
            serde_json::from_value(arr[1].clone()).map_err(|_e| {
                SimpleError::new(format!("Failed to deserialize {} to Vec<Vec<String>>", arr[1]))
            })?;
        Ok(Some((raw_trades[0][2].parse::<f64>().unwrap() * 1000.0) as i64))
    } else if channel == "spread" {
        let arr: Vec<String> = serde_json::from_value(arr[1].clone()).map_err(SimpleError::from)?;
        Ok(Some((arr[2].parse::<f64>().unwrap() * 1000.0) as i64))
    } else if channel == "ticker" {
        Ok(None)
    } else if channel.starts_with("ohlc-") {
        let timestamp = (arr[1][0].as_str().unwrap().parse::<f64>().unwrap() * 1000.0) as i64;
        Ok(Some(timestamp))
    } else if channel.starts_with("book-") {
        let snapshot = {
            let obj = arr[1].as_object().unwrap();
            obj.contains_key("as") || obj.contains_key("bs")
        };
        if snapshot {
            let orderbook_snapshot = serde_json::from_value::<OrderbookSnapshot>(arr[1].clone())
                .map_err(|_e| {
                    SimpleError::new(format!(
                        "Failed to deserialize {} to OrderbookSnapshot",
                        arr[1]
                    ))
                })?;
            let mut timestamp = std::i64::MIN;
            {
                for ask in orderbook_snapshot.asks.iter() {
                    let t = (ask[2].parse::<f64>().unwrap() * 1000.0) as i64;
                    if t > timestamp {
                        timestamp = t;
                    }
                }
                for bid in orderbook_snapshot.bids.iter() {
                    let t = (bid[2].parse::<f64>().unwrap() * 1000.0) as i64;
                    if t > timestamp {
                        timestamp = t;
                    }
                }
            };
            if timestamp == std::i64::MIN {
                // as and bs can be both empty, e.g.,
                // [6960,{"as":[],"bs":[]},"book-25","LINK/JPY"]
                Ok(None)
            } else {
                Ok(Some(timestamp))
            }
        } else {
            let mut timestamp = std::i64::MIN;
            let mut process_update = |update: OrderbookUpdate| {
                if let Some(a) = update.a {
                    for raw_order in a.iter() {
                        let t = (raw_order[2].parse::<f64>().unwrap() * 1000.0) as i64;
                        if t > timestamp {
                            timestamp = t;
                        }
                    }
                }
                if let Some(b) = update.b {
                    for raw_order in b.iter() {
                        let t = (raw_order[2].parse::<f64>().unwrap() * 1000.0) as i64;
                        if t > timestamp {
                            timestamp = t;
                        }
                    }
                }
            };
            if arr.len() == 4 {
                let update =
                    serde_json::from_value::<OrderbookUpdate>(arr[1].clone()).map_err(|_e| {
                        SimpleError::new(format!(
                            "Failed to deserialize {} to OrderbookUpdate",
                            arr[1]
                        ))
                    })?;
                process_update(update);
            } else if arr.len() == 5 {
                let update =
                    serde_json::from_value::<OrderbookUpdate>(arr[1].clone()).map_err(|_e| {
                        SimpleError::new(format!(
                            "Failed to deserialize {} to OrderbookUpdate",
                            arr[1]
                        ))
                    })?;
                process_update(update);
                let update =
                    serde_json::from_value::<OrderbookUpdate>(arr[2].clone()).map_err(|_e| {
                        SimpleError::new(format!(
                            "Failed to deserialize {} to OrderbookUpdate",
                            arr[2]
                        ))
                    })?;
                process_update(update);
            } else {
                return Err(SimpleError::new(format!("Unknown message format {msg}")));
            };

            if timestamp == std::i64::MIN {
                Err(SimpleError::new(format!("Neither a nor b exists in {msg}")))
            } else {
                Ok(Some(timestamp))
            }
        }
    } else {
        Err(SimpleError::new(format!("Unknown channel: {channel}")))
    }
}

pub(crate) fn parse_trade(msg: &str) -> Result<Vec<TradeMsg>, SimpleError> {
    let arr = serde_json::from_str::<Vec<Value>>(msg)
        .map_err(|_e| SimpleError::new(format!("Failed to deserialize {msg} to Vec<Value>")))?;
    debug_assert_eq!(arr[2].as_str().unwrap(), "trade");
    debug_assert_eq!(arr.len(), 4);
    let symbol = arr[arr.len() - 1].as_str().unwrap();
    let pair = crypto_pair::normalize_pair(symbol, EXCHANGE_NAME)
        .ok_or_else(|| SimpleError::new(format!("Failed to normalize {symbol} from {msg}")))?;
    let raw_trades: Vec<Vec<String>> = serde_json::from_value(arr[1].clone()).map_err(|_e| {
        SimpleError::new(format!("Failed to deserialize {} to Vec<Vec<String>>", arr[1]))
    })?;

    // trade format https://docs.kraken.com/websockets/#message-trade
    let mut trades: Vec<TradeMsg> = raw_trades
        .into_iter()
        .map(|raw_trade| {
            let price = raw_trade[0].parse::<f64>().unwrap();
            let quantity = raw_trade[1].parse::<f64>().unwrap();
            let timestamp = (raw_trade[2].parse::<f64>().unwrap() * 1000.0) as i64;

            TradeMsg {
                exchange: EXCHANGE_NAME.to_string(),
                market_type: MarketType::Spot,
                symbol: symbol.to_string(),
                pair: pair.clone(),
                msg_type: MessageType::Trade,
                timestamp,
                price,
                quantity_base: quantity,
                quantity_quote: price * quantity,
                quantity_contract: None,
                side: if raw_trade[3] == "s" { TradeSide::Sell } else { TradeSide::Buy },
                trade_id: timestamp.to_string(),
                json: serde_json::to_string(&raw_trade).unwrap(),
            }
        })
        .collect();

    if trades.len() == 1 {
        trades[0].json = msg.to_string();
    }
    Ok(trades)
}

pub(crate) fn parse_l2(msg: &str) -> Result<Vec<OrderBookMsg>, SimpleError> {
    let arr = serde_json::from_str::<Vec<Value>>(msg)
        .map_err(|_e| SimpleError::new(format!("Failed to deserialize {msg} to Vec<Value>")))?;
    debug_assert_eq!(arr[arr.len() - 2].as_str().unwrap(), "book-25");
    let symbol = arr[arr.len() - 1].as_str().unwrap().to_string();
    let pair = crypto_pair::normalize_pair(&symbol, EXCHANGE_NAME)
        .ok_or_else(|| SimpleError::new(format!("Failed to normalize {symbol} from {msg}")))?;
    let snapshot = {
        let obj = arr[1].as_object().unwrap();
        obj.contains_key("as") || obj.contains_key("bs")
    };

    let parse_order = |raw_order: &[String]| -> Order {
        let price = raw_order[0].parse::<f64>().unwrap();
        let quantity_base = raw_order[1].parse::<f64>().unwrap();

        Order {
            price,
            quantity_base,
            quantity_quote: price * quantity_base,
            quantity_contract: None,
        }
    };

    let orderbooks = if snapshot {
        let orderbook_snapshot = serde_json::from_value::<OrderbookSnapshot>(arr[1].clone())
            .map_err(|_e| {
                SimpleError::new(format!("Failed to deserialize {} to OrderbookSnapshot", arr[1]))
            })?;

        let timestamp = {
            let mut timestamps: Vec<i64> = Vec::new();
            for ask in orderbook_snapshot.asks.iter() {
                let t = (ask[2].parse::<f64>().unwrap() * 1000.0) as i64;
                timestamps.push(t);
            }
            for bid in orderbook_snapshot.bids.iter() {
                let t = (bid[2].parse::<f64>().unwrap() * 1000.0) as i64;
                timestamps.push(t);
            }
            if timestamps.is_empty() {
                None
            } else {
                let max = *timestamps.iter().max().unwrap();
                Some(max)
            }
        };

        if let Some(timestamp) = timestamp {
            vec![OrderBookMsg {
                exchange: EXCHANGE_NAME.to_string(),
                market_type: MarketType::Spot,
                symbol,
                pair,
                msg_type: MessageType::L2Event,
                timestamp,
                seq_id: None,
                prev_seq_id: None,
                asks: orderbook_snapshot.asks.iter().map(|x| parse_order(x)).collect(),
                bids: orderbook_snapshot.bids.iter().map(|x| parse_order(x)).collect(),
                snapshot,
                json: msg.to_string(),
            }]
        } else {
            vec![]
        }
    } else {
        let mut asks: Vec<Order> = Vec::new();
        let mut bids: Vec<Order> = Vec::new();
        let mut timestamps: Vec<i64> = Vec::new();
        let mut process_update = |update: OrderbookUpdate| {
            if let Some(a) = update.a {
                for raw_order in a.iter() {
                    let order = parse_order(raw_order);
                    asks.push(order);
                    let t = (raw_order[2].parse::<f64>().unwrap() * 1000.0) as i64;
                    timestamps.push(t);
                }
            }
            if let Some(b) = update.b {
                for raw_order in b.iter() {
                    let order = parse_order(raw_order);
                    bids.push(order);
                    let t = (raw_order[2].parse::<f64>().unwrap() * 1000.0) as i64;
                    timestamps.push(t);
                }
            }
        };
        if arr.len() == 4 {
            let update =
                serde_json::from_value::<OrderbookUpdate>(arr[1].clone()).map_err(|_e| {
                    SimpleError::new(format!("Failed to deserialize {} to OrderbookUpdate", arr[1]))
                })?;
            process_update(update);
        } else if arr.len() == 5 {
            let update =
                serde_json::from_value::<OrderbookUpdate>(arr[1].clone()).map_err(|_e| {
                    SimpleError::new(format!("Failed to deserialize {} to OrderbookUpdate", arr[1]))
                })?;
            process_update(update);
            let update =
                serde_json::from_value::<OrderbookUpdate>(arr[2].clone()).map_err(|_e| {
                    SimpleError::new(format!("Failed to deserialize {} to OrderbookUpdate", arr[2]))
                })?;
            process_update(update);
        } else {
            return Err(SimpleError::new(format!("Unknown message format {msg}")));
        };

        let timestamp = if timestamps.is_empty() {
            None
        } else {
            let max = *timestamps.iter().max().unwrap();
            Some(max)
        };
        if let Some(timestamp) = timestamp {
            vec![OrderBookMsg {
                exchange: EXCHANGE_NAME.to_string(),
                market_type: MarketType::Spot,
                symbol,
                pair,
                msg_type: MessageType::L2Event,
                timestamp,
                seq_id: None,
                prev_seq_id: None,
                asks,
                bids,
                snapshot,
                json: msg.to_string(),
            }]
        } else {
            vec![]
        }
    };

    Ok(orderbooks)
}

#[derive(Serialize, Deserialize)]
struct RawBboMsgSpot {
    bid_price: String,
    ask_price: String,
    timestamp: String,
    bid_volume: String,
    ask_volume: String,
}

pub(super) fn parse_bbo(msg: &str, _received_at: Option<i64>) -> Result<Vec<BboMsg>, SimpleError> {
    let ws_msg = serde_json::from_str::<Vec<Value>>(msg).map_err(SimpleError::from)?;

    let raw_bbo_msg_spot = serde_json::from_value::<RawBboMsgSpot>(ws_msg[1].clone()).unwrap();
    let timestamp = (ws_msg[1][2].as_str().unwrap().parse::<f64>().unwrap() * 1000.0) as i64;

    let symbol = ws_msg[ws_msg.len() - 1].as_str().unwrap();

    let pair = crypto_pair::normalize_pair(symbol, EXCHANGE_NAME).unwrap();

    let (ask_quantity_base, ask_quantity_quote, ask_quantity_contract) = calc_quantity_and_volume(
        EXCHANGE_NAME,
        MarketType::Spot,
        &pair,
        raw_bbo_msg_spot.ask_price.parse::<f64>().unwrap(),
        raw_bbo_msg_spot.ask_volume.parse::<f64>().unwrap(),
    );

    let (bid_quantity_base, bid_quantity_quote, bid_quantity_contract) = calc_quantity_and_volume(
        EXCHANGE_NAME,
        MarketType::Spot,
        &pair,
        raw_bbo_msg_spot.bid_price.parse::<f64>().unwrap(),
        raw_bbo_msg_spot.bid_volume.parse::<f64>().unwrap(),
    );

    let bbo_msg = BboMsg {
        exchange: EXCHANGE_NAME.to_string(),
        market_type: MarketType::Spot,
        symbol: symbol.to_string(),
        pair,
        msg_type: MessageType::BBO,
        timestamp,
        ask_price: raw_bbo_msg_spot.ask_price.parse::<f64>().unwrap(),
        ask_quantity_base,
        ask_quantity_quote,
        ask_quantity_contract,
        bid_price: raw_bbo_msg_spot.bid_price.parse::<f64>().unwrap(),
        bid_quantity_base,
        bid_quantity_quote,
        bid_quantity_contract,
        id: None,
        json: msg.to_string(),
    };

    Ok(vec![bbo_msg])
}

// https://docs.kraken.com/websockets/#message-ohlc
#[derive(Serialize, Deserialize)]
struct RawCandlestickMsg {
    time: String,
    etime: String,
    open: String,
    high: String,
    low: String,
    close: String,
    vwap: String,
    volume: String,
    count: i64,
}

pub(super) fn parse_candlestick(msg: &str) -> Result<Vec<CandlestickMsg>, SimpleError> {
    let arr = serde_json::from_str::<Vec<Value>>(msg).map_err(SimpleError::from)?;

    let raw_candlestick_msg = serde_json::from_value::<RawCandlestickMsg>(arr[1].clone()).unwrap();
    let timestamp = (raw_candlestick_msg.time.parse::<f64>().unwrap() * 1000.0) as i64;

    let end_time = (raw_candlestick_msg.etime.parse::<f64>().unwrap()) as i64;
    let period = arr[arr.len() - 2].as_str().unwrap().strip_prefix("ohlc-").unwrap();
    let begin_time = end_time - period.parse::<i64>().unwrap() * 60;

    let symbol = arr[arr.len() - 1].as_str().unwrap();
    let pair = crypto_pair::normalize_pair(symbol, EXCHANGE_NAME).unwrap();

    let vwap = raw_candlestick_msg.vwap.parse::<f64>().unwrap();
    let volume = raw_candlestick_msg.volume.parse::<f64>().unwrap();

    let candlestick_msg = CandlestickMsg {
        exchange: EXCHANGE_NAME.to_string(),
        market_type: MarketType::Spot,
        msg_type: MessageType::Candlestick,
        symbol: symbol.to_string(),
        pair,
        timestamp,
        period: period.to_string(),
        begin_time,
        open: raw_candlestick_msg.open.parse::<f64>().unwrap(),
        high: raw_candlestick_msg.high.parse::<f64>().unwrap(),
        low: raw_candlestick_msg.low.parse::<f64>().unwrap(),
        close: raw_candlestick_msg.close.parse::<f64>().unwrap(),
        volume,
        quote_volume: Some(vwap * volume),
        json: msg.to_string(),
    };

    Ok(vec![candlestick_msg])
}