barter_data/exchange/okx/
mod.rs

1use self::{
2    channel::OkxChannel, market::OkxMarket, subscription::OkxSubResponse, trade::OkxTrades,
3};
4use crate::{
5    ExchangeWsStream, NoInitialSnapshots,
6    exchange::{Connector, ExchangeSub, PingInterval, StreamSelector},
7    instrument::InstrumentData,
8    subscriber::{WebSocketSubscriber, validator::WebSocketSubValidator},
9    subscription::trade::PublicTrades,
10    transformer::stateless::StatelessTransformer,
11};
12use barter_instrument::exchange::ExchangeId;
13use barter_integration::{error::SocketError, protocol::websocket::WsMessage};
14use barter_macro::{DeExchange, SerExchange};
15use derive_more::Display;
16use serde_json::json;
17use std::time::Duration;
18use url::Url;
19
20/// Defines the type that translates a Barter [`Subscription`](crate::subscription::Subscription)
21/// into an exchange [`Connector`] specific channel used for generating [`Connector::requests`].
22pub mod channel;
23
24/// Defines the type that translates a Barter [`Subscription`](crate::subscription::Subscription)
25/// into an exchange [`Connector`] specific market used for generating [`Connector::requests`].
26pub mod market;
27
28/// [`Subscription`](crate::subscription::Subscription) response type and response
29/// [`Validator`](barter_integration::Validator) for [`Okx`].
30pub mod subscription;
31
32/// Public trade types for [`Okx`].
33pub mod trade;
34
35/// [`Okx`] server base url.
36///
37/// See docs: <https://www.okx.com/docs-v5/en/#overview-api-resources-and-support>
38pub const BASE_URL_OKX: &str = "wss://ws.okx.com:8443/ws/v5/public";
39
40/// [`Okx`] server [`PingInterval`] duration.
41///
42/// See docs: <https://www.okx.com/docs-v5/en/#websocket-api-connect>
43pub const PING_INTERVAL_OKX: Duration = Duration::from_secs(29);
44
45/// [`Okx`] exchange.
46///
47/// See docs: <https://www.okx.com/docs-v5/en/#websocket-api>
48#[derive(
49    Copy,
50    Clone,
51    Eq,
52    PartialEq,
53    Ord,
54    PartialOrd,
55    Hash,
56    Debug,
57    Default,
58    Display,
59    DeExchange,
60    SerExchange,
61)]
62pub struct Okx;
63
64impl Connector for Okx {
65    const ID: ExchangeId = ExchangeId::Okx;
66    type Channel = OkxChannel;
67    type Market = OkxMarket;
68    type Subscriber = WebSocketSubscriber;
69    type SubValidator = WebSocketSubValidator;
70    type SubResponse = OkxSubResponse;
71
72    fn url() -> Result<Url, SocketError> {
73        Url::parse(BASE_URL_OKX).map_err(SocketError::UrlParse)
74    }
75
76    fn ping_interval() -> Option<PingInterval> {
77        Some(PingInterval {
78            interval: tokio::time::interval(PING_INTERVAL_OKX),
79            ping: || WsMessage::text("ping"),
80        })
81    }
82
83    fn requests(exchange_subs: Vec<ExchangeSub<Self::Channel, Self::Market>>) -> Vec<WsMessage> {
84        vec![WsMessage::text(
85            json!({
86                "op": "subscribe",
87                "args": &exchange_subs,
88            })
89            .to_string(),
90        )]
91    }
92}
93
94impl<Instrument> StreamSelector<Instrument, PublicTrades> for Okx
95where
96    Instrument: InstrumentData,
97{
98    type SnapFetcher = NoInitialSnapshots;
99    type Stream =
100        ExchangeWsStream<StatelessTransformer<Self, Instrument::Key, PublicTrades, OkxTrades>>;
101}
barter_data/exchange/okx/mod.rs

barter_data/exchange/okx/
mod.rs
