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
use crate::{
    exchange::{datetime_utc_from_epoch_duration, extract_next},
    model::{DataKind, PublicTrade},
    ExchangeId, MarketEvent, Validator,
};
use barter_integration::{
    error::SocketError,
    model::{Exchange, Instrument, Side, SubscriptionId},
};
use chrono::{DateTime, Utc};
use serde::{de, Deserialize, Deserializer, Serialize};
use std::time::Duration;

/// `Kraken` message received in response to WebSocket subscription requests.
///
/// eg/ KrakenSubResponse::Subscribed {
///     "channelID":337,
///     "channelName":"trade",
///     "event":"subscriptionStatus",
///     "pair":"XBT/USD",
///     "status":"subscribed",
///     "subscription":{"name":"trade"}
/// }
/// eg/ KrakenSubResponse::Error {
///     "errorMessage":"Subscription name invalid",
///     "event":"subscriptionStatus",
///     "pair":"ETH/USD",
///     "status":"error",
///     "subscription":{"name":"trades"}
/// }
///
/// See docs: <https://docs.kraken.com/websockets/#message-subscriptionStatus>
#[derive(Clone, Eq, PartialEq, Debug, Deserialize, Serialize)]
#[serde(tag = "status", rename_all = "camelCase")]
pub enum KrakenSubResponse {
    Subscribed {
        #[serde(rename = "channelID")]
        channel_id: u64,
        #[serde(rename = "channelName")]
        channel_name: String,
        pair: String,
    },
    Error(KrakenError),
}

/// `Kraken` generic error message String received over the WebSocket.
///
/// Note that since the [`KrakenError`] is only made up of a renamed message String field, it can
/// be used flexible as a [`KrakenSubResponse::Error`](KrakenSubResponse) or as a generic error
/// received over the WebSocket while subscriptions are active.
///
/// See docs generic: <https://docs.kraken.com/websockets/#errortypes>
/// See docs subscription failed: <https://docs.kraken.com/websockets/#message-subscriptionStatus>
#[derive(Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Deserialize, Serialize)]
pub struct KrakenError {
    #[serde(rename = "errorMessage")]
    pub message: String,
}

impl Validator for KrakenSubResponse {
    fn validate(self) -> Result<Self, SocketError>
    where
        Self: Sized,
    {
        match &self {
            KrakenSubResponse::Subscribed { .. } => Ok(self),
            KrakenSubResponse::Error(error) => Err(SocketError::Subscribe(format!(
                "received failure subscription response: {}",
                error.message
            ))),
        }
    }
}

/// `Kraken` message variants that can be received over [`WebSocket`].
///
/// See docs: <https://docs.kraken.com/websockets/#overview>
#[derive(Clone, PartialEq, PartialOrd, Debug, Deserialize, Serialize)]
#[serde(untagged, rename_all = "snake_case")]
pub enum KrakenMessage {
    Trades(KrakenTrades),
    KrakenEvent(KrakenEvent),
}

/// Collection of [`KrakenTrade`] items with an associated [`SubscriptionId`] (eg/ "trade|XBT/USD").
///
/// See docs: <https://docs.kraken.com/websockets/#message-trade>
#[derive(Clone, PartialEq, PartialOrd, Debug, Serialize)]
pub struct KrakenTrades {
    pub subscription_id: SubscriptionId,
    pub trades: Vec<KrakenTrade>,
}

/// `Kraken` trade message.
///
/// See docs: <https://docs.kraken.com/websockets/#message-trade>
#[derive(Clone, Copy, PartialEq, PartialOrd, Debug, Serialize)]
pub struct KrakenTrade {
    pub price: f64,
    pub quantity: f64,
    pub time: DateTime<Utc>,
    pub side: Side,
}

/// `Kraken` messages received over the WebSocket which are not subscription data.
///
/// eg/ `Kraken` sends a `KrakenEvent::Heartbeat` if no subscription traffic has been sent
/// within the last second.
///
/// See docs: <https://docs.kraken.com/websockets/#message-heartbeat>
#[derive(Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Deserialize, Serialize)]
#[serde(tag = "event", rename_all = "camelCase")]
pub enum KrakenEvent {
    Heartbeat,
    Error(KrakenError),
}

impl From<(ExchangeId, Instrument, KrakenTrade)> for MarketEvent {
    fn from((exchange_id, instrument, trade): (ExchangeId, Instrument, KrakenTrade)) -> Self {
        // kraken trades do not come with a unique identifier, so generated a custom one
        let custom_trade_id = format!(
            "{}_{:?}_{}_{}",
            trade.time, trade.side, trade.price, trade.quantity
        );

        Self {
            exchange_time: trade.time,
            received_time: Utc::now(),
            exchange: Exchange::from(exchange_id),
            instrument,
            kind: DataKind::Trade(PublicTrade {
                id: custom_trade_id,
                price: trade.price,
                quantity: trade.quantity,
                side: trade.side,
            }),
        }
    }
}

impl<'de> Deserialize<'de> for KrakenTrades {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        struct SeqVisitor;

        impl<'de> de::Visitor<'de> for SeqVisitor {
            type Value = KrakenTrades;

            fn expecting(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
                formatter.write_str("KrakenTrades struct from the Kraken WebSocket API")
            }

            fn visit_seq<SeqAccessor>(
                self,
                mut seq: SeqAccessor,
            ) -> Result<Self::Value, SeqAccessor::Error>
            where
                SeqAccessor: de::SeqAccess<'de>,
            {
                // KrakenTrades Sequence Format:
                // [channelID, [[price, volume, time, side, orderType, misc]], channelName, pair]
                // <https://docs.kraken.com/websockets/#message-trade>

                // Extract deprecated channelID & ignore
                let _: de::IgnoredAny = extract_next(&mut seq, "channelID")?;

                // Extract Vec<KrakenTrade>
                let trades = extract_next(&mut seq, "Vec<KrakenTrade>")?;

                // Extract channelName (eg/ "trade") & ignore
                let _: de::IgnoredAny = extract_next(&mut seq, "channelName")?;

                // Extract pair (eg/ "XBT/USD") & map to SubscriptionId (ie/ "trade|{pair}")
                let subscription_id = extract_next::<SeqAccessor, String>(&mut seq, "pair")
                    .map(|pair| SubscriptionId::from(format!("trade|{pair}")))?;

                // Ignore any additional elements or SerDe will fail
                //  '--> Exchange may add fields without warning
                while seq.next_element::<de::IgnoredAny>()?.is_some() {}

                Ok(KrakenTrades {
                    subscription_id,
                    trades,
                })
            }
        }

        // Use Visitor implementation to deserialise the KrakenTrades WebSocket message
        deserializer.deserialize_seq(SeqVisitor)
    }
}

impl<'de> Deserialize<'de> for KrakenTrade {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        struct SeqVisitor;

        impl<'de> de::Visitor<'de> for SeqVisitor {
            type Value = KrakenTrade;

            fn expecting(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
                formatter.write_str("KrakenTrade struct from the Kraken WebSocket API")
            }

            fn visit_seq<SeqAccessor>(
                self,
                mut seq: SeqAccessor,
            ) -> Result<Self::Value, SeqAccessor::Error>
            where
                SeqAccessor: de::SeqAccess<'de>,
            {
                // KrakenTrade Sequence Format:
                // [price, volume, time, side, orderType, misc]
                // <https://docs.kraken.com/websockets/#message-trade>

                // Extract String price & parse to f64
                let price = extract_next::<SeqAccessor, String>(&mut seq, "price")?
                    .parse()
                    .map_err(de::Error::custom)?;

                // Extract String quantity & parse to f64
                let quantity = extract_next::<SeqAccessor, String>(&mut seq, "quantity")?
                    .parse()
                    .map_err(de::Error::custom)?;

                // Extract String price, parse to f64, map to DateTime<Utc>
                let time = extract_next::<SeqAccessor, String>(&mut seq, "time")?
                    .parse()
                    .map(|time| datetime_utc_from_epoch_duration(Duration::from_secs_f64(time)))
                    .map_err(de::Error::custom)?;

                // Extract Side
                let side: Side = extract_next(&mut seq, "side")?;

                // Ignore any additional elements or SerDe will fail
                //  '--> Exchange may add fields without warning
                while seq.next_element::<de::IgnoredAny>()?.is_some() {}

                Ok(KrakenTrade {
                    price,
                    quantity,
                    time,
                    side,
                })
            }
        }

        // Use Visitor implementation to deserialise the KrakenTrade
        deserializer.deserialize_seq(SeqVisitor)
    }
}

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

    #[test]
    fn test_deserialise_kraken_subscription_response() {
        struct TestCase {
            input: &'static str,
            expected: Result<KrakenSubResponse, SocketError>,
        }

        let cases = vec![
            TestCase {
                // TC0: input response is Subscribed
                input: r#"{"channelID":10001, "channelName":"trade", "event":"subscriptionStatus", "pair":"XBT/EUR", "status":"subscribed", "subscription":{"name":"ticker"}}"#,
                expected: Ok(KrakenSubResponse::Subscribed {
                    channel_id: 10001,
                    channel_name: "trade".to_owned(),
                    pair: "XBT/EUR".to_owned(),
                }),
            },
            TestCase {
                // TC1: input response is Error
                input: r#"{"errorMessage":"Subscription depth not supported","event":"subscriptionStatus","pair":"XBT/USD","status":"error","subscription":{"depth":42,"name":"book"}}"#,
                expected: Ok(KrakenSubResponse::Error(KrakenError {
                    message: "Subscription depth not supported".to_string(),
                })),
            },
            TestCase {
                // TC2: input response is malformed gibberish
                input: r#"{"type": "gibberish", "help": "please"}"#,
                expected: Err(SocketError::Serde {
                    error: serde_json::Error::custom(""),
                    payload: "".to_owned(),
                }),
            },
        ];

        for (index, test) in cases.into_iter().enumerate() {
            let actual = serde_json::from_str::<KrakenSubResponse>(test.input);
            match (actual, test.expected) {
                (Ok(actual), Ok(expected)) => {
                    assert_eq!(actual, expected, "TC{} failed", index)
                }
                (Err(_), Err(_)) => {
                    // Test passed
                }
                (actual, expected) => {
                    // Test failed
                    panic!("TC{index} failed because actual != expected. \nActual: {actual:?}\nExpected: {expected:?}\n");
                }
            }
        }
    }

    #[test]
    fn test_validate_kraken_subscription_response() {
        struct TestCase {
            input_response: KrakenSubResponse,
            is_valid: bool,
        }

        let cases = vec![
            TestCase {
                // TC0: input response is Subscribed
                input_response: KrakenSubResponse::Subscribed {
                    channel_name: "trade".to_owned(),
                    pair: "XBT/EUR".to_owned(),
                    channel_id: 10001,
                },
                is_valid: true,
            },
            TestCase {
                // TC1: input response is Error
                input_response: KrakenSubResponse::Error(KrakenError {
                    message: "error message".to_string(),
                }),
                is_valid: false,
            },
        ];

        for (index, test) in cases.into_iter().enumerate() {
            let actual = test.input_response.validate().is_ok();
            assert_eq!(actual, test.is_valid, "TestCase {} failed", index);
        }
    }

    #[test]
    fn test_deserialise_kraken_messages() {
        struct TestCase {
            input: &'static str,
            expected: Result<KrakenMessage, SocketError>,
        }

        let cases = vec![
            TestCase {
                // TC0: valid KrakenMessage Spot trades
                input: r#"[337,[["20180.30000","0.00010000","1661978265.280067","s","l",""],["20180.20000","0.00012340","1661978265.281568","s","l",""]],"trade","XBT/USD"]"#,
                expected: Ok(KrakenMessage::Trades(KrakenTrades {
                    trades: vec![
                        KrakenTrade {
                            price: 20180.30000,
                            quantity: 0.00010000,
                            time: datetime_utc_from_epoch_duration(Duration::from_secs_f64(
                                1661978265.280067,
                            )),
                            side: Side::Sell,
                        },
                        KrakenTrade {
                            price: 20180.20000,
                            quantity: 0.00012340,
                            time: datetime_utc_from_epoch_duration(Duration::from_secs_f64(
                                1661978265.281568,
                            )),
                            side: Side::Sell,
                        },
                    ],
                    subscription_id: SubscriptionId::from("trade|XBT/USD"),
                })),
            },
            TestCase {
                // TC1: valid KrakenMessage Spot trades w/ unexpected extra array fields
                input: r#"[337,[["3.30000","1000.00010000","1661978265.280067","b","l","", "", "", ""]],"trade","XBT/USD", "", ""]"#,
                expected: Ok(KrakenMessage::Trades(KrakenTrades {
                    trades: vec![KrakenTrade {
                        price: 3.30000,
                        quantity: 1000.00010000,
                        time: datetime_utc_from_epoch_duration(Duration::from_secs_f64(
                            1661978265.280067,
                        )),
                        side: Side::Buy,
                    }],
                    subscription_id: SubscriptionId::from("trade|XBT/USD"),
                })),
            },
            TestCase {
                // TC2: valid KrakenMessage Heartbeat
                input: r#"{"event": "heartbeat"}"#,
                expected: Ok(KrakenMessage::KrakenEvent(KrakenEvent::Heartbeat)),
            },
            TestCase {
                // TC3: valid KrakenMessage Error
                input: r#"{"errorMessage": "Malformed request", "event": "error"}"#,
                expected: Ok(KrakenMessage::KrakenEvent(KrakenEvent::Error(
                    KrakenError {
                        message: "Malformed request".to_string(),
                    },
                ))),
            },
            TestCase {
                // TC4: invalid KrakenMessage gibberish
                input: r#"{"type": "gibberish", "help": "please"}"#,
                expected: Err(SocketError::Serde {
                    error: serde_json::Error::custom(""),
                    payload: "".to_owned(),
                }),
            },
        ];

        for (index, test) in cases.into_iter().enumerate() {
            let actual = serde_json::from_str::<KrakenMessage>(test.input);
            match (actual, test.expected) {
                (Ok(actual), Ok(expected)) => {
                    assert_eq!(actual, expected, "TC{} failed", index)
                }
                (Err(_), Err(_)) => {
                    // Test passed
                }
                (actual, expected) => {
                    // Test failed
                    panic!("TC{index} failed because actual != expected. \nActual: {actual:?}\nExpected: {expected:?}\n");
                }
            }
        }
    }

    #[test]
    fn test_deserialise_kraken_trade() {
        struct TestCase {
            input: &'static str,
            expected: Result<KrakenTrade, SocketError>,
        }

        let cases = vec![
            TestCase {
                // TC0: KrakenTrade is valid
                input: r#"["20180.30000","0.00010000","1661978265.280067","s","l",""]"#,
                expected: Ok(KrakenTrade {
                    price: 20180.30000,
                    quantity: 0.00010000,
                    time: datetime_utc_from_epoch_duration(Duration::from_secs_f64(
                        1661978265.280067,
                    )),
                    side: Side::Sell,
                }),
            },
            TestCase {
                // TC1: KrakenTrade is valid w/ unexpected additional sequence elements
                input: r#"["1000.0","1000.00010000","1661978265.0","b","l","", "", "", "", ""]"#,
                expected: Ok(KrakenTrade {
                    price: 1000.0,
                    quantity: 1000.00010000,
                    time: datetime_utc_from_epoch_duration(Duration::from_secs_f64(1661978265.0)),
                    side: Side::Buy,
                }),
            },
            TestCase {
                // TC2: KrakenTrade is invalid w/ non-string price
                input: r#"[1000.0,"1000.00010000","1661978265.0","b","l",""]"#,
                expected: Err(SocketError::Serde {
                    error: serde_json::Error::custom(""),
                    payload: "".to_owned(),
                }),
            },
        ];

        for (index, test) in cases.into_iter().enumerate() {
            let actual = serde_json::from_str::<KrakenTrade>(test.input);
            match (actual, test.expected) {
                (Ok(actual), Ok(expected)) => {
                    assert_eq!(actual, expected, "TC{} failed", index)
                }
                (Err(_), Err(_)) => {
                    // Test passed
                }
                (actual, expected) => {
                    // Test failed
                    panic!("TC{index} failed because actual != expected. \nActual: {actual:?}\nExpected: {expected:?}\n");
                }
            }
        }
    }
}