Skip to main content

HyperliquidExecClientConfig

Struct HyperliquidExecClientConfig 

Source
pub struct HyperliquidExecClientConfig {
Show 18 fields 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 include_builder_attribution: bool, pub transport_backend: TransportBackend, pub ws_post_timeout_secs: u64, pub outcome_settlement_poll_secs: u64,
}
Expand description

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

§include_builder_attribution: bool

If true, attach Nautilus builder attribution to eligible mainnet orders.

§transport_backend: TransportBackend

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

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

Source§

impl HyperliquidExecClientConfig

Source

pub fn builder() -> HyperliquidExecClientConfigBuilder

Create an instance of HyperliquidExecClientConfig using the builder syntax

Source§

impl HyperliquidExecClientConfig

Source

pub fn has_credentials(&self) -> bool

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

Source

pub fn ws_url(&self) -> String

Returns the WebSocket URL, respecting the environment and overrides.

Source

pub fn http_url(&self) -> String

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

Trait Implementations§

Source§

impl ClientConfig for HyperliquidExecClientConfig

Source§

fn as_any(&self) -> &dyn Any

Return the configuration as a trait object.
Source§

impl Clone for HyperliquidExecClientConfig

Source§

fn clone(&self) -> HyperliquidExecClientConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for HyperliquidExecClientConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for HyperliquidExecClientConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

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

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for HyperliquidExecClientConfig

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<'de, T> BorrowedRpcObject<'de> for T
where T: RpcBorrow<'de> + RpcSend,

Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<'de, T> RpcBorrow<'de> for T
where T: Deserialize<'de> + Debug + Send + Sync + Unpin,

Source§

impl<T> RpcObject for T
where T: RpcSend + RpcRecv,

Source§

impl<T> RpcRecv for T
where T: DeserializeOwned + Debug + Send + Sync + Unpin + 'static,

Source§

impl<T> RpcSend for T
where T: Serialize + Clone + Debug + Send + Sync + Unpin,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more