Struct HyperliquidExecClientConfig 

pub struct HyperliquidExecClientConfig {

    pub private_key: Option<String>,
    pub vault_address: Option<String>,
    pub account_address: Option<String>,
    pub base_url_ws: Option<String>,
    pub base_url_http: Option<String>,
    pub base_url_exchange: Option<String>,
    pub proxy_url: Option<String>,
    pub environment: HyperliquidEnvironment,
    pub http_timeout_secs: u64,
    pub max_retries: u32,
    pub retry_delay_initial_ms: u64,
    pub retry_delay_max_ms: u64,
    pub normalize_prices: bool,
    pub market_order_slippage_bps: u32,
    pub transport_backend: TransportBackend,
    pub ws_post_timeout_secs: u64,
    pub outcome_settlement_poll_secs: u64,
}

Configuration for the Hyperliquid execution client.

Fields

private_key: Option<String>

Private key for signing transactions.

If not provided, falls back to environment variable:

• Mainnet: HYPERLIQUID_PK
• Testnet: HYPERLIQUID_TESTNET_PK

vault_address: Option<String>

Optional vault address for vault operations.

If not provided, falls back to environment variable:

• Mainnet: HYPERLIQUID_VAULT
• Testnet: HYPERLIQUID_TESTNET_VAULT

account_address: Option<String>

Optional main account address when using an agent wallet (API sub-key). When set, used for balance queries, position reports, and WS subscriptions instead of the address derived from the private key.

If not provided and no explicit vault address is set, falls back to the HYPERLIQUID_ACCOUNT_ADDRESS environment variable.

base_url_ws: Option<String>

Override for the WebSocket URL.

base_url_http: Option<String>

Override for the HTTP info URL.

base_url_exchange: Option<String>

Override for the exchange API 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.

max_retries: u32

Maximum number of retry attempts for HTTP requests.

retry_delay_initial_ms: u64

Initial retry delay in milliseconds.

retry_delay_max_ms: u64

Maximum retry delay in milliseconds.

normalize_prices: bool

When true, normalize order prices to 5 significant figures before submission (Hyperliquid requirement).

market_order_slippage_bps: u32

Slippage buffer in basis points applied to MARKET orders and stop-to-limit trigger derivations. Can be overridden per-order via SubmitOrder.params["market_order_slippage_bps"].

transport_backend: TransportBackend

WebSocket transport backend (defaults to Tungstenite).

ws_post_timeout_secs: u64

Timeout in seconds for WebSocket post trading requests.

outcome_settlement_poll_secs: u64

Poll interval in seconds for outcomeMeta settlement detection. Disabled by default; venue Settlement fills drive HIP-4 settlement through the standard user-fills stream. Set to a non-zero value only when the venue fill stream is unavailable.

Implementations

impl HyperliquidExecClientConfig

pub fn builder() -> HyperliquidExecClientConfigBuilder

Create an instance of HyperliquidExecClientConfig using the builder syntax

impl HyperliquidExecClientConfig

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 HyperliquidExecClientConfig

fn as_any(&self) -> &dyn Any

Return the configuration as a trait object.

impl Clone for HyperliquidExecClientConfig

fn clone(&self) -> HyperliquidExecClientConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HyperliquidExecClientConfig

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

Formats the value using the given formatter.

impl Default for HyperliquidExecClientConfig

fn default() -> Self

Returns the “default value” for a type.

impl DerefToPyAny for HyperliquidExecClientConfig

impl<'de> Deserialize<'de> for HyperliquidExecClientConfig

where HyperliquidExecClientConfig: 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 HyperliquidExecClientConfig

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 HyperliquidExecClientConfig

type Target = HyperliquidExecClientConfig

The Python output type

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

const NAME: &str = "HyperliquidExecClientConfig"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for HyperliquidExecClientConfig

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

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

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 = Pyo3MethodsInventoryForHyperliquidExecClientConfig

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 HyperliquidExecClientConfig

const TEXT_SIGNATURE: &'static str = "(private_key=None, vault_address=None, account_address=None, environment=None, base_url_ws=None, base_url_http=None, base_url_exchange=None, proxy_url=None, http_timeout_secs=None, max_retries=None, retry_delay_initial_ms=None, retry_delay_max_ms=None, normalize_prices=None, market_order_slippage_bps=None, ws_post_timeout_secs=None)"

impl PyStubType for HyperliquidExecClientConfig

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 HyperliquidExecClientConfig

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 HyperliquidExecClientConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.