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, formatter: &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 DerefToPyAny for HyperliquidDataClientConfig

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<'a, 'py> FromPyObject<'a, 'py> for HyperliquidDataClientConfig

where Self: Clone,

type Error = PyClassGuardError<'a, 'py>

The type returned in the event of a conversion error.

fn extract( obj: Borrowed<'a, 'py, PyAny>, ) -> Result<Self, <Self as FromPyObject<'a, 'py>>::Error>

Extracts Self from the bound smart pointer obj.

impl<'py> IntoPyObject<'py> for HyperliquidDataClientConfig

type Target = HyperliquidDataClientConfig

The Python output type

type Output = Bound<'py, <HyperliquidDataClientConfig 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 HyperliquidDataClientConfig

const NAME: &str = "HyperliquidDataClientConfig"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for HyperliquidDataClientConfig

const MODULE: Option<&str>

Module which the class will be associated with.

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 = /// 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.

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 Layout = <<HyperliquidDataClientConfig as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<HyperliquidDataClientConfig>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForHyperliquidDataClientConfig

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<PyObjectOffset>

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyClassNewTextSignature for HyperliquidDataClientConfig

const TEXT_SIGNATURE: &'static str = "(environment=None, private_key=None, base_url_ws=None, base_url_http=None, proxy_url=None, http_timeout_secs=None, ws_timeout_secs=None, update_instruments_interval_mins=None, transport_backend=None, stale_stream_receive_timeout_secs=None, stream_health_check_interval_secs=None, stale_stream_warning_cooldown_secs=None, stale_stream_recovery_enabled=None, stale_stream_recovery_cooldown_secs=None, stale_stream_max_targeted_resubscribes=None)"

impl PyStubType for HyperliquidDataClientConfig

fn type_output() -> TypeInfo

The type to be used in the output signature, i.e. return type of the Python function or methods.

fn type_input() -> TypeInfo

The type to be used in the input signature, i.e. the arguments of the Python function or methods.

impl PyTypeInfo for HyperliquidDataClientConfig

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

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 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.