Struct DeriveExecutionClientConfig 

pub struct DeriveExecutionClientConfig {

    pub account_id: AccountId,
    pub wallet_address: Option<String>,
    pub session_key: Option<String>,
    pub subaccount_id: Option<u64>,
    pub base_url_rest: Option<String>,
    pub base_url_ws: Option<String>,
    pub proxy_url: Option<String>,
    pub environment: DeriveEnvironment,
    pub http_timeout_secs: u64,
    pub max_retries: u32,
    pub retry_delay_initial_ms: u64,
    pub retry_delay_max_ms: u64,
    pub ws_timeout_secs: Option<u64>,
    pub max_fee_per_contract: Option<Decimal>,
    pub transport_backend: TransportBackend,
    pub domain_separator: Option<String>,
    pub action_typehash: Option<String>,
    pub trade_module_address: Option<String>,
    pub signature_expiry_secs: u64,
    pub market_order_slippage_bps: u32,
    pub max_matching_requests_per_second: Option<u32>,
    pub max_per_instrument_matching_requests_per_second: Option<u32>,
}

Configuration for the Derive execution client.

Debug is implemented manually so that session_key is redacted; the derived Debug would leak the raw secret through any logger or Python __repr__.

Fields

account_id: AccountId

Account identifier for the execution client.

wallet_address: Option<String>

Derive Chain smart-contract wallet address (X-LYRAWALLET). Falls back to DERIVE_WALLET_ADDRESS (or DERIVE_TESTNET_WALLET_ADDRESS on testnet) when unset.

session_key: Option<String>

secp256k1 session-key private key in hex (with or without 0x prefix). Falls back to DERIVE_SESSION_PRIVATE_KEY (or DERIVE_TESTNET_SESSION_PRIVATE_KEY on testnet) when unset.

subaccount_id: Option<u64>

Subaccount identifier. Falls back to DERIVE_SUBACCOUNT_ID (or DERIVE_TESTNET_SUBACCOUNT_ID on testnet) when unset.

base_url_rest: Option<String>

Override for the REST API base URL.

base_url_ws: Option<String>

Override for the WebSocket URL.

proxy_url: Option<String>

Optional proxy URL for HTTP and WebSocket transports.

environment: DeriveEnvironment

The Derive environment to connect to.

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.

ws_timeout_secs: Option<u64>

Optional per-operation WebSocket timeout in seconds (login, subscribe, reads, writes). When unset, the low-level WS_REQUEST_TIMEOUT applies.

max_fee_per_contract: Option<Decimal>

Per-contract USDC fee cap signed into every order. Required for execution and must be greater than zero.

transport_backend: TransportBackend

WebSocket transport backend (defaults to Sockudo when that feature is enabled).

domain_separator: Option<String>

Override for the EIP-712 domain separator. Falls back to the constant for the configured environment when unset. The shipped constants are placeholders that must be replaced or overridden before signing.

action_typehash: Option<String>

Override for the EIP-712 action typehash. Falls back to the shipped crate::common::consts::ACTION_TYPEHASH when unset.

trade_module_address: Option<String>

Override for the Trade module contract address. Falls back to the shipped per-environment constant when unset.

signature_expiry_secs: u64

Signature expiry TTL in seconds for normal orders and replaces (added to the wall clock before signing). Must be greater than the venue minimum (crate::common::consts::MIN_SIGNATURE_TTL, 300s).

market_order_slippage_bps: u32

Slippage bound applied to market orders when deriving a worst-acceptable limit price from the cached top-of-book quote. Expressed in basis points (1 bp = 0.01%). Defaults to 50 bp = 0.5%.

max_matching_requests_per_second: Option<u32>

Maximum matching-engine requests per second for order writes sent over the WebSocket (create/cancel/replace). Defaults to the Trader-tier limit of 1 when unset; raise it for Market Maker accounts with higher negotiated limits. See https://docs.derive.xyz/reference/rate-limits.

max_per_instrument_matching_requests_per_second: Option<u32>

Maximum per-instrument matching requests per second for instrument- scoped order writes sent over the WebSocket. Defaults to the Trader-tier limit of 1 when unset; raise it for Market Maker accounts with higher negotiated per-instrument limits. This allowance is independent of max_matching_requests_per_second, which never inflates it. See https://docs.derive.xyz/reference/rate-limits.

Implementations

impl DeriveExecutionClientConfig

pub fn builder() -> DeriveExecutionClientConfigBuilder

Create an instance of DeriveExecutionClientConfig using the builder syntax

impl DeriveExecutionClientConfig

pub fn new() -> Self

pub fn has_credentials(&self) -> bool

Returns true when wallet, session-key, and subaccount are all populated in this config. Environment-variable fallbacks documented on the individual fields are resolved at factory-construction time, not here; callers that need a “credentials available anywhere” check should inspect both this method and the relevant env vars.

pub fn validate(&self) -> Result<()>

Validates execution configuration invariants.

Errors

Returns an error when max_fee_per_contract is missing or not greater than zero.

pub fn rest_url(&self) -> String

Returns the REST API base URL, respecting environment and overrides.

pub fn ws_url(&self) -> String

Returns the WebSocket URL, respecting environment and overrides.

Trait Implementations

impl ClientConfig for DeriveExecutionClientConfig

fn as_any(&self) -> &dyn Any

Return the configuration as a trait object.

impl Clone for DeriveExecutionClientConfig

fn clone(&self) -> DeriveExecutionClientConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DeriveExecutionClientConfig

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

Formats the value using the given formatter.

impl Default for DeriveExecutionClientConfig

fn default() -> Self

Returns the “default value” for a type.

impl DerefToPyAny for DeriveExecutionClientConfig

impl<'de> Deserialize<'de> for DeriveExecutionClientConfig

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

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 DeriveExecutionClientConfig

type Target = DeriveExecutionClientConfig

The Python output type

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

const NAME: &str = "DeriveExecutionClientConfig"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for DeriveExecutionClientConfig

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 Derive execution client. /// /// `Debug` is implemented manually so that `session_key` is redacted; the /// derived `Debug` would leak the raw secret through any logger or Python /// `__repr__`.

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

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

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 DeriveExecutionClientConfig

const TEXT_SIGNATURE: &'static str = "(account_id=None, wallet_address=None, session_key=None, subaccount_id=None, base_url_rest=None, base_url_ws=None, proxy_url=None, environment=None, http_timeout_secs=None, max_retries=None, retry_delay_initial_ms=None, retry_delay_max_ms=None, ws_timeout_secs=None, max_fee_per_contract=None, domain_separator=None, action_typehash=None, trade_module_address=None, signature_expiry_secs=None, market_order_slippage_bps=None, max_matching_requests_per_second=None, max_per_instrument_matching_requests_per_second=None, transport_backend=None)"

impl PyStubType for DeriveExecutionClientConfig

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 DeriveExecutionClientConfig

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 DeriveExecutionClientConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.