pub struct HyperliquidExecClientConfig {Show 14 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 http_proxy_url: Option<String>,
pub ws_proxy_url: Option<String>,
pub is_testnet: bool,
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,
}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.
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.
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.
http_proxy_url: Option<String>Optional HTTP proxy URL.
ws_proxy_url: Option<String>Optional WebSocket proxy URL.
Note: WebSocket proxy support is not yet implemented. This field is reserved
for future functionality. Use http_proxy_url for REST API proxy support.
is_testnet: boolWhen true the client will use Hyperliquid testnet endpoints.
http_timeout_secs: u64HTTP timeout in seconds.
max_retries: u32Maximum number of retry attempts for HTTP requests.
retry_delay_initial_ms: u64Initial retry delay in milliseconds.
retry_delay_max_ms: u64Maximum retry delay in milliseconds.
normalize_prices: boolWhen true, normalize order prices to 5 significant figures before submission (Hyperliquid requirement).
Implementations§
Source§impl HyperliquidExecClientConfig
impl HyperliquidExecClientConfig
Sourcepub fn builder() -> HyperliquidExecClientConfigBuilder
pub fn builder() -> HyperliquidExecClientConfigBuilder
Create an instance of HyperliquidExecClientConfig using the builder syntax
Source§impl HyperliquidExecClientConfig
impl HyperliquidExecClientConfig
Sourcepub fn new(private_key: Option<String>) -> Self
pub fn new(private_key: Option<String>) -> Self
Creates a new configuration with the provided private key.
Sourcepub fn has_credentials(&self) -> bool
pub fn has_credentials(&self) -> bool
Returns true when private key is populated and non-empty.
Trait Implementations§
Source§impl Clone for HyperliquidExecClientConfig
impl Clone for HyperliquidExecClientConfig
Source§fn clone(&self) -> HyperliquidExecClientConfig
fn clone(&self) -> HyperliquidExecClientConfig
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for HyperliquidExecClientConfig
impl Debug for HyperliquidExecClientConfig
Source§impl<'a, 'py> FromPyObject<'a, 'py> for HyperliquidExecClientConfigwhere
Self: Clone,
impl<'a, 'py> FromPyObject<'a, 'py> for HyperliquidExecClientConfigwhere
Self: Clone,
Source§impl<'py> IntoPyObject<'py> for HyperliquidExecClientConfig
impl<'py> IntoPyObject<'py> for HyperliquidExecClientConfig
Source§type Target = HyperliquidExecClientConfig
type Target = HyperliquidExecClientConfig
Source§type Output = Bound<'py, <HyperliquidExecClientConfig as IntoPyObject<'py>>::Target>
type Output = Bound<'py, <HyperliquidExecClientConfig as IntoPyObject<'py>>::Target>
Source§fn into_pyobject(
self,
py: Python<'py>,
) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>
fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>
Source§impl PyClassImpl for HyperliquidExecClientConfig
impl PyClassImpl for HyperliquidExecClientConfig
Source§const IS_BASETYPE: bool = false
const IS_BASETYPE: bool = false
Source§const IS_SUBCLASS: bool = false
const IS_SUBCLASS: bool = false
Source§const IS_MAPPING: bool = false
const IS_MAPPING: bool = false
Source§const IS_SEQUENCE: bool = false
const IS_SEQUENCE: bool = false
Source§const IS_IMMUTABLE_TYPE: bool = false
const IS_IMMUTABLE_TYPE: bool = false
Source§const RAW_DOC: &'static CStr = /// Configuration for the Hyperliquid execution client.
const RAW_DOC: &'static CStr = /// Configuration for the Hyperliquid execution client.
Source§const DOC: &'static CStr
const DOC: &'static CStr
text_signature if a constructor is defined. Read moreSource§type Layout = <<HyperliquidExecClientConfig as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<HyperliquidExecClientConfig>
type Layout = <<HyperliquidExecClientConfig as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<HyperliquidExecClientConfig>
Source§type ThreadChecker = NoopThreadChecker
type ThreadChecker = NoopThreadChecker
type Inventory = Pyo3MethodsInventoryForHyperliquidExecClientConfig
Source§type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild
type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild
Source§type BaseNativeType = PyAny
type BaseNativeType = PyAny
PyAny by default, and when you declare
#[pyclass(extends=PyDict)], it’s PyDict.fn items_iter() -> PyClassItemsIter
fn lazy_type_object() -> &'static LazyTypeObject<Self>
Source§fn dict_offset() -> Option<PyObjectOffset>
fn dict_offset() -> Option<PyObjectOffset>
Source§fn weaklist_offset() -> Option<PyObjectOffset>
fn weaklist_offset() -> Option<PyObjectOffset>
Source§impl PyClassNewTextSignature for HyperliquidExecClientConfig
impl PyClassNewTextSignature for HyperliquidExecClientConfig
const TEXT_SIGNATURE: &'static str = "(private_key=None, vault_address=None, account_address=None, is_testnet=None, base_url_ws=None, base_url_http=None, base_url_exchange=None, http_proxy_url=None, http_timeout_secs=None, max_retries=None, retry_delay_initial_ms=None, retry_delay_max_ms=None, normalize_prices=None)"
Source§impl PyStubType for HyperliquidExecClientConfig
impl PyStubType for HyperliquidExecClientConfig
Source§fn type_output() -> TypeInfo
fn type_output() -> TypeInfo
Source§fn type_input() -> TypeInfo
fn type_input() -> TypeInfo
Source§impl PyTypeInfo for HyperliquidExecClientConfig
impl PyTypeInfo for HyperliquidExecClientConfig
Source§const NAME: &str = <Self as ::pyo3::PyClass>::NAME
const NAME: &str = <Self as ::pyo3::PyClass>::NAME
prefer using ::type_object(py).name() to get the correct runtime value
Source§const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE
const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE
prefer using ::type_object(py).module() to get the correct runtime value
Source§fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
Source§fn type_object(py: Python<'_>) -> Bound<'_, PyType>
fn type_object(py: Python<'_>) -> Bound<'_, PyType>
impl DerefToPyAny for HyperliquidExecClientConfig
Auto Trait Implementations§
impl Freeze for HyperliquidExecClientConfig
impl RefUnwindSafe for HyperliquidExecClientConfig
impl Send for HyperliquidExecClientConfig
impl Sync for HyperliquidExecClientConfig
impl Unpin for HyperliquidExecClientConfig
impl UnsafeUnpin for HyperliquidExecClientConfig
impl UnwindSafe for HyperliquidExecClientConfig
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<'py, T> IntoPyObjectExt<'py> for Twhere
T: IntoPyObject<'py>,
impl<'py, T> IntoPyObjectExt<'py> for Twhere
T: IntoPyObject<'py>,
Source§fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>
fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>
self into an owned Python object, dropping type information.Source§impl<'py, T> IntoPyObjectNautilusExt<'py> for Twhere
T: IntoPyObjectExt<'py>,
impl<'py, T> IntoPyObjectNautilusExt<'py> for Twhere
T: IntoPyObjectExt<'py>,
Source§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
Source§impl<T> PyErrArguments for T
impl<T> PyErrArguments for T
Source§impl<T> PyTypeCheck for Twhere
T: PyTypeInfo,
impl<T> PyTypeCheck for Twhere
T: PyTypeInfo,
Source§const NAME: &'static str = T::NAME
const NAME: &'static str = T::NAME
Use ::classinfo_object() instead and format the type name at runtime. Note that using built-in cast features is often better than manual PyTypeCheck usage.