Skip to main content

rustrade_data/exchange/kraken/
market.rs

1use super::Kraken;
2use crate::{Identifier, instrument::MarketInstrumentData, subscription::Subscription};
3use rustrade_instrument::{
4    Keyed, asset::name::AssetNameInternal, instrument::market_data::MarketDataInstrument,
5};
6use serde::{Deserialize, Serialize};
7use smol_str::{SmolStr, StrExt, format_smolstr};
8
9/// Type that defines how to translate a Barter [`Subscription`] into a
10/// [`Kraken`] market that can be subscribed to.
11///
12/// Kraken's WebSocket v2 symbol: `BASE/QUOTE` in upper case, eg/ `BTC/USD`. A
13/// [`MarketInstrumentData`] subscription uses its `name_exchange` verbatim, so it must be spelled
14/// the same way; v1 spellings such as `XBT/USD` are refused.
15///
16/// See docs: <https://docs.kraken.com/exchange/api-reference/spot-websocket-v2/trade>
17#[derive(Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Deserialize, Serialize)]
18pub struct KrakenMarket(pub SmolStr);
19
20impl<Kind> Identifier<KrakenMarket> for Subscription<Kraken, MarketDataInstrument, Kind> {
21    fn id(&self) -> KrakenMarket {
22        kraken_market(&self.instrument.base, &self.instrument.quote)
23    }
24}
25
26impl<InstrumentKey, Kind> Identifier<KrakenMarket>
27    for Subscription<Kraken, Keyed<InstrumentKey, MarketDataInstrument>, Kind>
28{
29    fn id(&self) -> KrakenMarket {
30        kraken_market(&self.instrument.value.base, &self.instrument.value.quote)
31    }
32}
33
34impl<InstrumentKey, Kind> Identifier<KrakenMarket>
35    for Subscription<Kraken, MarketInstrumentData<InstrumentKey>, Kind>
36{
37    fn id(&self) -> KrakenMarket {
38        KrakenMarket(self.instrument.name_exchange.name().clone())
39    }
40}
41
42impl AsRef<str> for KrakenMarket {
43    fn as_ref(&self) -> &str {
44        &self.0
45    }
46}
47
48fn kraken_market(base: &AssetNameInternal, quote: &AssetNameInternal) -> KrakenMarket {
49    KrakenMarket(format_smolstr!("{base}/{quote}").to_uppercase_smolstr())
50}
51
52#[cfg(test)]
53mod tests {
54    use super::*;
55    use crate::subscription::trade::PublicTrades;
56    use rustrade_instrument::instrument::market_data::kind::MarketDataInstrumentKind;
57
58    #[test]
59    fn a_base_and_quote_subscription_is_spelled_as_a_v2_symbol() {
60        let subscription: Subscription<Kraken, MarketDataInstrument, PublicTrades> =
61            Subscription::new(
62                Kraken,
63                ("btc", "usd", MarketDataInstrumentKind::Spot),
64                PublicTrades,
65            );
66
67        let market: KrakenMarket = subscription.id();
68        assert_eq!(market, KrakenMarket("BTC/USD".into()));
69    }
70}