Struct LighterExecClientConfig 

pub struct LighterExecClientConfig {

    pub trader_id: TraderId,
    pub account_id: AccountId,
    pub account_index: Option<u64>,
    pub api_key_index: Option<u8>,
    pub private_key: Option<String>,
    pub base_url_http: Option<String>,
    pub base_url_ws: Option<String>,
    pub proxy_url: Option<String>,
    pub environment: LighterEnvironment,
    pub http_timeout_secs: u64,
    pub ws_timeout_secs: u64,
    pub market_order_slippage_bps: u32,
    pub rest_quota_per_min: Option<u32>,
    pub sendtx_quota_per_min: Option<u32>,
    pub transport_backend: TransportBackend,
}

Configuration for the Lighter execution client.

Fields

trader_id: TraderId

Trader identifier.

account_id: AccountId

Account identifier on the venue.

account_index: Option<u64>

Lighter account index (numeric, assigned at registration). Falls back to LIGHTER_ACCOUNT_INDEX / LIGHTER_TESTNET_ACCOUNT_INDEX when resolved through common::credential.

api_key_index: Option<u8>

API key index for a user-created Lighter key. Low indexes are reserved for Lighter clients; 255 is the apikeys all-keys sentinel. Falls back to LIGHTER_API_KEY_INDEX / LIGHTER_TESTNET_API_KEY_INDEX when resolved through common::credential.

private_key: Option<String>

Hex-encoded private key for the API key (Schnorr / ecgfp5). Falls back to LIGHTER_API_SECRET / LIGHTER_TESTNET_API_SECRET when resolved through common::credential.

base_url_http: Option<String>

Optional REST URL override.

base_url_ws: Option<String>

Optional WebSocket URL override.

proxy_url: Option<String>

Optional proxy URL for HTTP and WebSocket transports.

environment: LighterEnvironment

Target environment.

http_timeout_secs: u64

HTTP request timeout in seconds.

ws_timeout_secs: u64

WebSocket connect timeout in seconds.

market_order_slippage_bps: u32

Slippage buffer in basis points for market-style orders.

rest_quota_per_min: Option<u32>

Optional REST read-bucket quota override in requests per minute; unset keeps the conservative 60 req/min default (raising it requires venue IP registration).

sendtx_quota_per_min: Option<u32>

Optional transaction quota override (req/min), independent of rest_quota_per_min; unset keeps 60. Enforced across the HTTP and WebSocket sendTx paths (execution only).

transport_backend: TransportBackend

WebSocket transport backend.

Implementations

impl LighterExecClientConfig

pub fn builder() -> LighterExecClientConfigBuilder

Create an instance of LighterExecClientConfig using the builder syntax

impl LighterExecClientConfig

pub fn has_credentials(&self) -> bool

Returns true when all fields required to sign and submit authenticated transactions are configured.

Lighter signing requires the private key, the account index, and the API key index together; any missing field invalidates the credential.

pub fn http_url(&self) -> String

Returns the resolved REST base URL.

pub fn ws_url(&self) -> String

Returns the resolved WebSocket URL.

Trait Implementations

impl ClientConfig for LighterExecClientConfig

fn as_any(&self) -> &dyn Any

Return the configuration as a trait object.

impl Clone for LighterExecClientConfig

fn clone(&self) -> LighterExecClientConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LighterExecClientConfig

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

Formats the value using the given formatter.

impl Default for LighterExecClientConfig

fn default() -> Self

Returns the “default value” for a type.

impl DerefToPyAny for LighterExecClientConfig

impl<'de> Deserialize<'de> for LighterExecClientConfig

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

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 LighterExecClientConfig

type Target = LighterExecClientConfig

The Python output type

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

const NAME: &str = "LighterExecClientConfig"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for LighterExecClientConfig

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

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

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 LighterExecClientConfig

const TEXT_SIGNATURE: &'static str = "(trader_id, account_id, account_index=None, api_key_index=None, private_key=None, base_url_http=None, base_url_ws=None, proxy_url=None, environment=None, http_timeout_secs=None, ws_timeout_secs=None, market_order_slippage_bps=None, rest_quota_per_min=None, sendtx_quota_per_min=None)"

impl PyStubType for LighterExecClientConfig

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 LighterExecClientConfig

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 LighterExecClientConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.