Struct HyperliquidClient 

pub struct HyperliquidClient { /* private fields */ }

Implementations

impl HyperliquidClient

pub fn new() -> Self

pub fn with_auth(user_address: Address, private_key: String) -> Self

Trait Implementations

impl GetAccountSnapshot for HyperliquidClient

async fn get_positions(&self) -> Result<Vec<Position>, String>

Returns open positions from clearinghouseState. Requires with_auth. Zero-size positions are filtered out. Positive szi = long, negative = short.

async fn get_open_orders(&self) -> Result<Vec<OpenOrder>, String>

Returns resting orders from Hyperliquid’s openOrders endpoint. Requires with_auth. filled_quantity is derived as origSz - sz (original size minus remaining size).

async fn get_collateral(&self) -> Result<Decimal, String>

Returns total account value (collateral) from clearinghouseState. Requires with_auth.

impl GetMarketData for HyperliquidClient

async fn get_symbol(&self) -> Result<Vec<String>, String>

Returns all perpetual asset names from Hyperliquid’s meta endpoint.

async fn get_open_interest(&self, symbol: String) -> Result<Decimal, String>

Returns the current open interest for symbol from metaAndAssetCtxs.

async fn get_asset_context( &self, symbol: String, ) -> Result<AssetContext, String>

Returns a full AssetContext snapshot for symbol from metaAndAssetCtxs.

async fn get_predicted_fundings(&self) -> Result<Vec<PredictedFunding>, String>

Returns predicted funding rates for all symbols across all venues.

async fn get_l2_orderbook( &self, symbol: String, ) -> Result<Vec<L2Update>, String>

Returns a full L2 orderbook snapshot for symbol from the l2Book REST endpoint. Levels are returned as individual L2Update items; all share the same sequence (timestamp).

async fn get_price(&self, symbol: String) -> Result<Decimal, String>

Returns the mid-price of symbol (e.g. “BTC”) from allMids.

impl ManageOrder for HyperliquidClient

async fn place_order( &self, symbol: String, side: OrderSide, price: Decimal, volume: Decimal, order_type: OrderType, time_in_force: TimeInForce, ) -> Result<OrderPlacement, String>

Places an order on Hyperliquid. Requires with_auth. Returns an OrderPlacement with the exchange-assigned order ID. Market orders are submitted as aggressive limit orders (IOC).

async fn change_order_by_cloid( &self, cloid: i64, price: Decimal, volume: Decimal, ) -> Result<i64, String>

Modifies price and size of an existing order by its order ID. Requires with_auth. Fetches the order’s current coin and side before submitting the modify action.

async fn cancel_order(&self, cloid: i64) -> Result<i64, String>

Cancels a single order by its order ID. Requires with_auth. Fetches open orders to resolve the coin/asset before cancelling.

async fn cancel_all_order(&self) -> Result<bool, String>

Cancels all open orders. Requires with_auth. Fetches all open orders and submits a batch cancel in a single signed request.

impl SubscribeMarketData for HyperliquidClient

fn subscribe_l2_update(&self, symbol: String) -> BoxStream<L2Update>

Streams L2 orderbook updates for symbol. Each message from Hyperliquid is a full-depth snapshot; every level is emitted as an individual L2Update event. All levels in the same snapshot share the same sequence value.

fn subscribe_asset_context(&self, symbol: String) -> BoxStream<AssetContext>

Streams asset context updates for symbol via Hyperliquid’s activeAssetCtx subscription.

fn subscribe_liquidation(&self, user: String) -> BoxStream<Liquidation>

Streams liquidation events for a user address via Hyperliquid’s userEvents subscription. Hyperliquid’s liquidation event is account-level; symbol is empty and side is Sell.

fn subscribe_fill(&self, symbol: String) -> BoxStream<Fill>

Streams public trade fills for symbol. “B” (buyer aggressor) → Buy, otherwise → Sell.

impl SubscribeUserEvents for HyperliquidClient

fn subscribe_user_fills(&self) -> BoxStream<UserFill>

Streams the user’s own order executions via the userEvents WS subscription. Requires with_auth (streams are empty if no user address is set).

fn subscribe_order_updates(&self) -> BoxStream<OrderUpdate>

Streams order lifecycle events via the orderUpdates WS subscription. Requires with_auth.

fn subscribe_funding_payments(&self) -> BoxStream<FundingPayment>

Streams funding payments applied to positions via the userEvents WS subscription. Requires with_auth.

fn subscribe_deposits(&self) -> BoxStream<Deposit>

stream account deposit events

fn subscribe_withdrawals(&self) -> BoxStream<Withdrawal>

stream account withdrawal events

impl TestServer for HyperliquidClient

async fn ping(&self) -> Result<bool, String>

Sends a lightweight allMids request; returns true if the server responds 200 OK.

async fn get_server_time(&self) -> Result<i64, String>

Hyperliquid has no dedicated server-time endpoint; returns local UTC ms.