Skip to main content

HyperliquidExecClientConfigBuilder

nautilus_hyperliquid::config

Struct HyperliquidExecClientConfigBuilder 

Source 
pub struct HyperliquidExecClientConfigBuilder<S: State = Empty> { /* private fields */ }
Expand description

Use builder syntax to set the inputs and finish with build().

Implementations§

Source§

impl<S: State> HyperliquidExecClientConfigBuilder<S>

Source

pub fn build(self) -> HyperliquidExecClientConfig
where S: IsComplete,

Finish building and return the requested object

Source

pub fn private_key( self, value: String, ) -> HyperliquidExecClientConfigBuilder<SetPrivateKey<S>>
where S::PrivateKey: IsUnset,

Optional (Some / Option setters). Private key for signing transactions.

If not provided, falls back to environment variable:

  • Mainnet: HYPERLIQUID_PK
  • Testnet: HYPERLIQUID_TESTNET_PK
Source

pub fn maybe_private_key( self, value: Option<String>, ) -> HyperliquidExecClientConfigBuilder<SetPrivateKey<S>>
where S::PrivateKey: IsUnset,

Optional (Some / Option setters). Private key for signing transactions.

If not provided, falls back to environment variable:

  • Mainnet: HYPERLIQUID_PK
  • Testnet: HYPERLIQUID_TESTNET_PK
Source

pub fn vault_address( self, value: String, ) -> HyperliquidExecClientConfigBuilder<SetVaultAddress<S>>
where S::VaultAddress: IsUnset,

Optional (Some / Option setters). Optional vault address for vault operations.

Source

pub fn maybe_vault_address( self, value: Option<String>, ) -> HyperliquidExecClientConfigBuilder<SetVaultAddress<S>>
where S::VaultAddress: IsUnset,

Optional (Some / Option setters). Optional vault address for vault operations.

Source

pub fn account_address( self, value: String, ) -> HyperliquidExecClientConfigBuilder<SetAccountAddress<S>>
where S::AccountAddress: IsUnset,

Optional (Some / Option setters). 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.

Source

pub fn maybe_account_address( self, value: Option<String>, ) -> HyperliquidExecClientConfigBuilder<SetAccountAddress<S>>
where S::AccountAddress: IsUnset,

Optional (Some / Option setters). 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.

Source

pub fn base_url_ws( self, value: String, ) -> HyperliquidExecClientConfigBuilder<SetBaseUrlWs<S>>
where S::BaseUrlWs: IsUnset,

Optional (Some / Option setters). Override for the WebSocket URL.

Source

pub fn maybe_base_url_ws( self, value: Option<String>, ) -> HyperliquidExecClientConfigBuilder<SetBaseUrlWs<S>>
where S::BaseUrlWs: IsUnset,

Optional (Some / Option setters). Override for the WebSocket URL.

Source

pub fn base_url_http( self, value: String, ) -> HyperliquidExecClientConfigBuilder<SetBaseUrlHttp<S>>
where S::BaseUrlHttp: IsUnset,

Optional (Some / Option setters). Override for the HTTP info URL.

Source

pub fn maybe_base_url_http( self, value: Option<String>, ) -> HyperliquidExecClientConfigBuilder<SetBaseUrlHttp<S>>
where S::BaseUrlHttp: IsUnset,

Optional (Some / Option setters). Override for the HTTP info URL.

Source

pub fn base_url_exchange( self, value: String, ) -> HyperliquidExecClientConfigBuilder<SetBaseUrlExchange<S>>
where S::BaseUrlExchange: IsUnset,

Optional (Some / Option setters). Override for the exchange API URL.

Source

pub fn maybe_base_url_exchange( self, value: Option<String>, ) -> HyperliquidExecClientConfigBuilder<SetBaseUrlExchange<S>>
where S::BaseUrlExchange: IsUnset,

Optional (Some / Option setters). Override for the exchange API URL.

Source

pub fn proxy_url( self, value: String, ) -> HyperliquidExecClientConfigBuilder<SetProxyUrl<S>>
where S::ProxyUrl: IsUnset,

Optional (Some / Option setters). Optional proxy URL for HTTP and WebSocket transports.

Source

pub fn maybe_proxy_url( self, value: Option<String>, ) -> HyperliquidExecClientConfigBuilder<SetProxyUrl<S>>
where S::ProxyUrl: IsUnset,

Optional (Some / Option setters). Optional proxy URL for HTTP and WebSocket transports.

Source

pub fn environment( self, value: HyperliquidEnvironment, ) -> HyperliquidExecClientConfigBuilder<SetEnvironment<S>>
where S::Environment: IsUnset,

Optional (Some / Option setters). Default: <HyperliquidEnvironment as Default>::default().

The target environment (mainnet or testnet).

Source

pub fn maybe_environment( self, value: Option<HyperliquidEnvironment>, ) -> HyperliquidExecClientConfigBuilder<SetEnvironment<S>>
where S::Environment: IsUnset,

Optional (Some / Option setters). Default: <HyperliquidEnvironment as Default>::default().

The target environment (mainnet or testnet).

Source

pub fn http_timeout_secs( self, value: u64, ) -> HyperliquidExecClientConfigBuilder<SetHttpTimeoutSecs<S>>
where S::HttpTimeoutSecs: IsUnset,

Optional (Some / Option setters). Default: 60.

HTTP timeout in seconds.

Source

pub fn maybe_http_timeout_secs( self, value: Option<u64>, ) -> HyperliquidExecClientConfigBuilder<SetHttpTimeoutSecs<S>>
where S::HttpTimeoutSecs: IsUnset,

Optional (Some / Option setters). Default: 60.

HTTP timeout in seconds.

Source

pub fn max_retries( self, value: u32, ) -> HyperliquidExecClientConfigBuilder<SetMaxRetries<S>>
where S::MaxRetries: IsUnset,

Optional (Some / Option setters). Default: 3.

Maximum number of retry attempts for HTTP requests.

Source

pub fn maybe_max_retries( self, value: Option<u32>, ) -> HyperliquidExecClientConfigBuilder<SetMaxRetries<S>>
where S::MaxRetries: IsUnset,

Optional (Some / Option setters). Default: 3.

Maximum number of retry attempts for HTTP requests.

Source

pub fn retry_delay_initial_ms( self, value: u64, ) -> HyperliquidExecClientConfigBuilder<SetRetryDelayInitialMs<S>>
where S::RetryDelayInitialMs: IsUnset,

Optional (Some / Option setters). Default: 100.

Initial retry delay in milliseconds.

Source

pub fn maybe_retry_delay_initial_ms( self, value: Option<u64>, ) -> HyperliquidExecClientConfigBuilder<SetRetryDelayInitialMs<S>>
where S::RetryDelayInitialMs: IsUnset,

Optional (Some / Option setters). Default: 100.

Initial retry delay in milliseconds.

Source

pub fn retry_delay_max_ms( self, value: u64, ) -> HyperliquidExecClientConfigBuilder<SetRetryDelayMaxMs<S>>
where S::RetryDelayMaxMs: IsUnset,

Optional (Some / Option setters). Default: 5000.

Maximum retry delay in milliseconds.

Source

pub fn maybe_retry_delay_max_ms( self, value: Option<u64>, ) -> HyperliquidExecClientConfigBuilder<SetRetryDelayMaxMs<S>>
where S::RetryDelayMaxMs: IsUnset,

Optional (Some / Option setters). Default: 5000.

Maximum retry delay in milliseconds.

Source

pub fn normalize_prices( self, value: bool, ) -> HyperliquidExecClientConfigBuilder<SetNormalizePrices<S>>
where S::NormalizePrices: IsUnset,

Optional (Some / Option setters). Default: true.

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

Source

pub fn maybe_normalize_prices( self, value: Option<bool>, ) -> HyperliquidExecClientConfigBuilder<SetNormalizePrices<S>>
where S::NormalizePrices: IsUnset,

Optional (Some / Option setters). Default: true.

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

Source

pub fn market_order_slippage_bps( self, value: u32, ) -> HyperliquidExecClientConfigBuilder<SetMarketOrderSlippageBps<S>>
where S::MarketOrderSlippageBps: IsUnset,

Optional (Some / Option setters). Default: 50.

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

Source

pub fn maybe_market_order_slippage_bps( self, value: Option<u32>, ) -> HyperliquidExecClientConfigBuilder<SetMarketOrderSlippageBps<S>>
where S::MarketOrderSlippageBps: IsUnset,

Optional (Some / Option setters). Default: 50.

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

Source

pub fn transport_backend( self, value: TransportBackend, ) -> HyperliquidExecClientConfigBuilder<SetTransportBackend<S>>
where S::TransportBackend: IsUnset,

Optional (Some / Option setters). Default: <TransportBackend as Default>::default().

WebSocket transport backend (defaults to Tungstenite).

Source

pub fn maybe_transport_backend( self, value: Option<TransportBackend>, ) -> HyperliquidExecClientConfigBuilder<SetTransportBackend<S>>
where S::TransportBackend: IsUnset,

Optional (Some / Option setters). Default: <TransportBackend as Default>::default().

WebSocket transport backend (defaults to Tungstenite).

Auto Trait Implementations§

Blanket Implementations§

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<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: 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> Same for T

Source§

type Output = T

Should always be Self
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.
§

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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

§

impl<T> Ungil for T
where T: Send,