deribit-websocket 0.3.0

//! Constants for WebSocket client

/// Default heartbeat interval in seconds
pub const DEFAULT_HEARTBEAT_INTERVAL: u64 = 30;

/// Maximum reconnection attempts
pub const MAX_RECONNECT_ATTEMPTS: u32 = 5;

/// WebSocket URLs
pub const PRODUCTION_WS_URL: &str = "wss://www.deribit.com/ws/api/v2";
/// WebSocket URL for Deribit testnet
pub const TESTNET_WS_URL: &str = "wss://test.deribit.com/ws/api/v2";

/// JSON-RPC methods
pub mod methods {
    // Authentication
    /// Public authentication method
    pub const PUBLIC_AUTH: &str = "public/auth";
    /// Private logout method
    pub const PRIVATE_LOGOUT: &str = "private/logout";

    // Subscriptions
    /// Public subscription method
    pub const PUBLIC_SUBSCRIBE: &str = "public/subscribe";
    /// Public unsubscription method
    pub const PUBLIC_UNSUBSCRIBE: &str = "public/unsubscribe";
    /// Public unsubscribe from all channels
    pub const PUBLIC_UNSUBSCRIBE_ALL: &str = "public/unsubscribe_all";
    /// Private subscription method
    pub const PRIVATE_SUBSCRIBE: &str = "private/subscribe";
    /// Private unsubscription method
    pub const PRIVATE_UNSUBSCRIBE: &str = "private/unsubscribe";
    /// Private unsubscribe from all channels
    pub const PRIVATE_UNSUBSCRIBE_ALL: &str = "private/unsubscribe_all";

    // Session management
    /// Set heartbeat interval
    pub const PUBLIC_SET_HEARTBEAT: &str = "public/set_heartbeat";
    /// Disable heartbeat
    pub const PUBLIC_DISABLE_HEARTBEAT: &str = "public/disable_heartbeat";

    // Market data
    /// Get ticker information
    pub const PUBLIC_GET_TICKER: &str = "public/ticker";
    /// Get order book data
    pub const PUBLIC_GET_ORDERBOOK: &str = "public/get_order_book";
    /// Get trade history
    pub const PUBLIC_GET_TRADES: &str = "public/get_last_trades_by_instrument";
    /// Get instrument information
    pub const PUBLIC_GET_INSTRUMENTS: &str = "public/get_instruments";

    // Trading
    /// Place buy order
    pub const PRIVATE_BUY: &str = "private/buy";
    /// Place sell order
    pub const PRIVATE_SELL: &str = "private/sell";
    /// Cancel specific order
    pub const PRIVATE_CANCEL: &str = "private/cancel";
    /// Cancel all orders
    pub const PRIVATE_CANCEL_ALL: &str = "private/cancel_all";
    /// Cancel all orders by currency
    pub const PRIVATE_CANCEL_ALL_BY_CURRENCY: &str = "private/cancel_all_by_currency";
    /// Cancel all orders by instrument
    pub const PRIVATE_CANCEL_ALL_BY_INSTRUMENT: &str = "private/cancel_all_by_instrument";
    /// Edit an existing order
    pub const PRIVATE_EDIT: &str = "private/edit";
    /// Get open orders
    pub const PRIVATE_GET_OPEN_ORDERS: &str = "private/get_open_orders";

    // Account
    /// Get account summary
    pub const PRIVATE_GET_ACCOUNT_SUMMARY: &str = "private/get_account_summary";
    /// Get positions
    pub const PRIVATE_GET_POSITIONS: &str = "private/get_positions";
    /// Get subaccounts
    pub const PRIVATE_GET_SUBACCOUNTS: &str = "private/get_subaccounts";
    /// Get order state
    pub const PRIVATE_GET_ORDER_STATE: &str = "private/get_order_state";
    /// Get order history by currency
    pub const PRIVATE_GET_ORDER_HISTORY_BY_CURRENCY: &str = "private/get_order_history_by_currency";

    // Position management
    /// Close an existing position
    pub const PRIVATE_CLOSE_POSITION: &str = "private/close_position";
    /// Move positions between subaccounts
    pub const PRIVATE_MOVE_POSITIONS: &str = "private/move_positions";

    // Cancel-on-disconnect
    /// Enable cancel-on-disconnect
    pub const PRIVATE_ENABLE_CANCEL_ON_DISCONNECT: &str = "private/enable_cancel_on_disconnect";
    /// Disable cancel-on-disconnect
    pub const PRIVATE_DISABLE_CANCEL_ON_DISCONNECT: &str = "private/disable_cancel_on_disconnect";
    /// Get cancel-on-disconnect status
    pub const PRIVATE_GET_CANCEL_ON_DISCONNECT: &str = "private/get_cancel_on_disconnect";

    // Test
    /// Test connection
    pub const PUBLIC_TEST: &str = "public/test";
    /// Get server time
    pub const PUBLIC_GET_TIME: &str = "public/get_time";
    /// Hello message
    pub const PUBLIC_HELLO: &str = "public/hello";
}

/// Subscription channels
pub mod channels {
    /// Ticker channel
    pub const TICKER: &str = "ticker";
    /// Order book channel
    pub const ORDERBOOK: &str = "book";
    /// Trades channel
    pub const TRADES: &str = "trades";
    /// User orders channel
    pub const USER_ORDERS: &str = "user.orders";
    /// User trades channel
    pub const USER_TRADES: &str = "user.trades";
    /// User portfolio channel
    pub const USER_PORTFOLIO: &str = "user.portfolio";
    /// Incremental ticker channel
    pub const INCREMENTAL_TICKER: &str = "incremental_ticker";
    /// Price ranking channel
    pub const PRICE_RANKING: &str = "deribit_price_ranking";
    /// Price statistics channel
    pub const PRICE_STATISTICS: &str = "deribit_price_statistics";
    /// Volatility index channel
    pub const VOLATILITY_INDEX: &str = "deribit_volatility_index";
    /// Platform state channel
    pub const PLATFORM_STATE: &str = "platform_state";
    /// Platform state public methods channel
    pub const PLATFORM_STATE_PUBLIC_METHODS: &str = "platform_state.public_methods_state";
    /// Instrument state channel
    pub const INSTRUMENT_STATE: &str = "instrument.state";
    /// Perpetual channel
    pub const PERPETUAL: &str = "perpetual";
    /// Mark price options channel
    pub const MARKPRICE_OPTIONS: &str = "markprice.options";
    /// Quote channel
    pub const QUOTE: &str = "quote";
    /// Block RFQ trades channel
    pub const BLOCK_RFQ_TRADES: &str = "block_rfq.trades";
    /// Block trade confirmations channel
    pub const BLOCK_TRADE_CONFIRMATIONS: &str = "block_trade_confirmations";
    /// User MMP trigger channel
    pub const USER_MMP_TRIGGER: &str = "user.mmp_trigger";
    /// User access log channel
    pub const USER_ACCESS_LOG: &str = "user.access_log";
    /// User lock channel
    pub const USER_LOCK: &str = "user.lock";
}

#[cfg(test)]
#[allow(clippy::unwrap_used, clippy::expect_used)]
mod tests {
    use super::*;
    use url::Url;

    /// Locks the invariant that [`WebSocketConfig::default`] relies on in
    /// `config.rs`: parsing [`PRODUCTION_WS_URL`] must succeed. If this test
    /// ever fails, the `.expect` in `Default::default` becomes a panic.
    #[test]
    fn test_production_ws_url_parses() {
        let url = Url::parse(PRODUCTION_WS_URL).expect("PRODUCTION_WS_URL must parse");
        assert_eq!(url.scheme(), "wss");
        assert_eq!(url.host_str(), Some("www.deribit.com"));
        assert_eq!(url.path(), "/ws/api/v2");
    }

    #[test]
    fn test_testnet_ws_url_parses() {
        let url = Url::parse(TESTNET_WS_URL).expect("TESTNET_WS_URL must parse");
        assert_eq!(url.scheme(), "wss");
        assert_eq!(url.host_str(), Some("test.deribit.com"));
        assert_eq!(url.path(), "/ws/api/v2");
    }
}