Struct HyperliquidWebSocketClient 

pub struct HyperliquidWebSocketClient { /* private fields */ }

High-level Hyperliquid WebSocket client that provides standardized domain methods.

This client uses Arc<RwLock<>> for internal state to support Clone and safe sharing across async tasks, following the same pattern as other exchange adapters (OKX, Bitmex, Bybit).

Implementations

impl HyperliquidWebSocketClient

pub fn new(url: String) -> Self

Creates a new Hyperliquid WebSocket client without connecting. The connection will be established when ensure_connected() is called.

pub fn add_instrument(&self, instrument: InstrumentAny)

Adds an instrument to the cache for parsing WebSocket messages.

pub fn get_instrument(&self, id: &InstrumentId) -> Option<InstrumentAny>

Gets an instrument from the cache by ID.

pub fn get_instrument_by_symbol(&self, symbol: &Ustr) -> Option<InstrumentAny>

Gets an instrument from the cache by symbol.

pub async fn connect(url: &str) -> Result<Self>

Creates a new Hyperliquid WebSocket client and establishes connection.

pub async fn ensure_connected(&self) -> Result<()>

Establishes the WebSocket connection if not already connected.

pub async fn is_connected(&self) -> bool

Returns true if the WebSocket is connected.

pub fn url(&self) -> &str

Returns the URL of this WebSocket client.

pub async fn subscribe_order_updates(&self, user: &str) -> Result<()>

Subscribe to order updates for a specific user address.

Ensures connection is established before subscribing.

pub async fn subscribe_user_events(&self, user: &str) -> Result<()>

Subscribe to user events (fills, funding, liquidations) for a specific user address.

Ensures connection is established before subscribing.

pub async fn subscribe_all_user_channels(&self, user: &str) -> Result<()>

Subscribe to all user channels (order updates + user events) for convenience.

pub async fn subscribe_trades(&self, coin: Ustr) -> Result<()>

Subscribe to trades for a specific coin.

Ensures connection is established before subscribing.

pub async fn unsubscribe_trades(&self, coin: Ustr) -> Result<()>

Unsubscribe from trades for a specific coin.

Ensures connection is established before unsubscribing.

pub async fn subscribe_book(&self, coin: Ustr) -> Result<()>

Subscribe to L2 order book for a specific coin.

Ensures connection is established before subscribing.

pub async fn unsubscribe_book(&self, coin: Ustr) -> Result<()>

Unsubscribe from L2 order book for a specific coin.

Ensures connection is established before unsubscribing.

pub async fn subscribe_bbo(&self, coin: Ustr) -> Result<()>

Subscribe to BBO (best bid/offer) for a specific coin.

Ensures connection is established before subscribing.

pub async fn unsubscribe_bbo(&self, coin: Ustr) -> Result<()>

Unsubscribe from BBO (best bid/offer) for a specific coin.

Ensures connection is established before unsubscribing.

pub async fn subscribe_candle(&self, coin: Ustr, interval: String) -> Result<()>

Subscribe to candlestick data for a specific coin and interval.

Ensures connection is established before subscribing.

pub async fn unsubscribe_candle( &self, coin: Ustr, interval: String, ) -> Result<()>

Unsubscribe from candlestick data for a specific coin and interval.

Ensures connection is established before unsubscribing.

pub async fn next_event(&self) -> Option<HyperliquidWsMessage>

Get the next event from the WebSocket stream. Returns None when the connection is closed or the receiver is exhausted.

pub async fn is_active(&self) -> bool

Returns true if the WebSocket connection is active.

pub async fn is_reconnecting(&self) -> bool

Returns true if the WebSocket is reconnecting.

pub async fn is_disconnecting(&self) -> bool

Returns true if the WebSocket is disconnecting.

pub async fn is_closed(&self) -> bool

Returns true if the WebSocket is closed.

pub async fn disconnect(&self) -> Result<()>

Disconnect the WebSocket client.

pub async fn send_raw(&self, request: &HyperliquidWsRequest) -> Result<()>

Escape hatch: send raw requests for tests/power users.

Ensures connection is established before sending.

pub async fn info_l2_book( &self, coin: &str, timeout: Duration, ) -> HyperliquidResult<HyperliquidL2Book>

High-level: call info l2Book (WS post)

Ensures connection is established before making the request.

pub async fn post_info_raw( &self, payload: Value, timeout: Duration, ) -> HyperliquidResult<PostResponsePayload>

High-level: fire arbitrary info (WS post) returning raw payload.

Ensures connection is established before making the request.

pub async fn post_action_raw( &self, action: ActionPayload, timeout: Duration, ) -> HyperliquidResult<PostResponsePayload>

High-level: fire action (already signed ActionPayload)

Ensures connection is established before making the request.

impl HyperliquidWebSocketClient

pub fn py_url(&self) -> String

Trait Implementations

impl Clone for HyperliquidWebSocketClient

fn clone(&self) -> HyperliquidWebSocketClient

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HyperliquidWebSocketClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'py> IntoPyObject<'py> for HyperliquidWebSocketClient

type Target = HyperliquidWebSocketClient

The Python output type

type Output = Bound<'py, <HyperliquidWebSocketClient as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for HyperliquidWebSocketClient

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for HyperliquidWebSocketClient

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// High-level Hyperliquid WebSocket client that provides standardized domain methods. /// /// This client uses Arc<RwLock<>> for internal state to support Clone and safe sharing /// across async tasks, following the same pattern as other exchange adapters (OKX, Bitmex, Bybit).

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<HyperliquidWebSocketClient>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature for HyperliquidWebSocketClient

const TEXT_SIGNATURE: &'static str = "(url)"

impl<'a, 'holder, 'py> PyFunctionArgument<'a, 'holder, 'py, false> for &'holder HyperliquidWebSocketClient

type Holder = Option<PyClassGuard<'a, HyperliquidWebSocketClient>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'holder mut Self::Holder, ) -> PyResult<Self>

impl<'a, 'holder, 'py> PyFunctionArgument<'a, 'holder, 'py, false> for &'holder mut HyperliquidWebSocketClient

type Holder = Option<PyClassGuardMut<'a, HyperliquidWebSocketClient>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'holder mut Self::Holder, ) -> PyResult<Self>

impl PyMethods<HyperliquidWebSocketClient> for PyClassImplCollector<HyperliquidWebSocketClient>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for HyperliquidWebSocketClient

const NAME: &'static str = "HyperliquidWebSocketClient"

Class name.

const MODULE: Option<&'static str>

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl DerefToPyAny for HyperliquidWebSocketClient