Struct HyperliquidDataClientConfig 

pub struct HyperliquidDataClientConfig {

    pub private_key: Option<String>,
    pub base_url_ws: Option<String>,
    pub base_url_http: Option<String>,
    pub proxy_url: Option<String>,
    pub environment: HyperliquidEnvironment,
    pub http_timeout_secs: u64,
    pub ws_timeout_secs: u64,
    pub stale_stream_receive_timeout_secs: u64,
    pub stream_health_check_interval_secs: u64,
    pub stale_stream_warning_cooldown_secs: u64,
    pub stale_stream_recovery_enabled: bool,
    pub stale_stream_recovery_cooldown_secs: u64,
    pub stale_stream_max_targeted_resubscribes: u32,
    pub update_instruments_interval_mins: u64,
    pub transport_backend: TransportBackend,
}

Configuration for the Hyperliquid data client.

The stale_stream_* options control the stream health monitor. With recovery enabled, a stale stream is warned about first, targeted-resubscribed once per recovery cooldown (preserving its original l2Book options), and escalated to a full WebSocket reconnect after stale_stream_max_targeted_resubscribes failed attempts; fresh data resets the ladder. See the Hyperliquid integration guide (“Stream health and recovery”) for details.

Fields

private_key: Option<String>

Optional private key for authenticated endpoints.

base_url_ws: Option<String>

Override for the WebSocket URL.

base_url_http: Option<String>

Override for the HTTP info URL.

proxy_url: Option<String>

Optional proxy URL for HTTP and WebSocket transports.

environment: HyperliquidEnvironment

The target environment (mainnet or testnet).

http_timeout_secs: u64

HTTP timeout in seconds.

ws_timeout_secs: u64

WebSocket timeout in seconds.

stale_stream_receive_timeout_secs: u64

Receive-age threshold in seconds for warning about stale market-data streams. Choose a value above the instrument’s expected quiet period. Set to 0 to disable the stream health monitor.

stream_health_check_interval_secs: u64

Interval in seconds for running market-data stream health checks. Set to 0 to disable the stream health monitor.

stale_stream_warning_cooldown_secs: u64

Cooldown in seconds between stale warnings for the same market-data stream.

stale_stream_recovery_enabled: bool

Enables automated stale-stream recovery. Off by default: the stream health monitor warns only and never changes subscriptions.

stale_stream_recovery_cooldown_secs: u64

Cooldown in seconds between recovery actions for the same market-data stream. Must be positive for recovery to run.

stale_stream_max_targeted_resubscribes: u32

Targeted resubscribe attempts for a stale stream before escalating to a full WebSocket reconnect.

update_instruments_interval_mins: u64

Interval for refreshing instruments in minutes.

transport_backend: TransportBackend

WebSocket transport backend (Sockudo by default; Tungstenite when the transport-sockudo feature is disabled).

Implementations

impl HyperliquidDataClientConfig

pub fn builder() -> HyperliquidDataClientConfigBuilder

Create an instance of HyperliquidDataClientConfig using the builder syntax

impl HyperliquidDataClientConfig

pub fn new() -> Self

Creates a new configuration with default settings.

pub fn has_credentials(&self) -> bool

Returns true when private key is populated and non-empty.

pub fn ws_url(&self) -> String

Returns the WebSocket URL, respecting the environment and overrides.

pub fn http_url(&self) -> String

Returns the HTTP info URL, respecting the environment and overrides.

Trait Implementations

impl ClientConfig for HyperliquidDataClientConfig

fn as_any(&self) -> &dyn Any

Return the configuration as a trait object.

impl Clone for HyperliquidDataClientConfig

fn clone(&self) -> HyperliquidDataClientConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HyperliquidDataClientConfig

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

Formats the value using the given formatter.

impl Default for HyperliquidDataClientConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HyperliquidDataClientConfig

where HyperliquidDataClientConfig: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for HyperliquidDataClientConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.