Struct LighterExecutionClientConfig 

pub struct LighterExecutionClientConfig {

    pub environment: LighterEnvironment,
    pub deployment: LighterDeployment,
    pub venue: Option<Venue>,
    pub account_id: AccountId,
    pub account_index: Option<u64>,
    pub api_key_index: Option<u8>,
    pub private_key: Option<SecretString>,
    pub base_url_http: Option<String>,
    pub base_url_ws: Option<String>,
    pub proxy_url: Option<SecretString>,
    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,
    pub use_gtd: bool,
    pub scheduled_cancel_timeout_secs: Option<u64>,
}

Configuration for the Lighter execution client.

Fields

environment: LighterEnvironment

Target environment within the selected deployment.

deployment: LighterDeployment

Lighter protocol deployment, which controls endpoint defaults and protocol settings.

venue: Option<Venue>

Optional Nautilus venue identifier override.

This scopes instruments, cache entries, and execution routing without changing the deployment’s signing, settlement, or protocol behavior.

account_id: AccountId

Account identifier on the venue. Its issuer must match the resolved venue.

account_index: Option<u64>

Lighter account index (numeric, assigned at registration). Falls back to the environment variable selected by deployment and environment.

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 the environment variable selected by deployment and environment.

private_key: Option<SecretString>

Hex-encoded private key for the API key (Schnorr / ecgfp5). Falls back to the environment variable selected by deployment and environment.

base_url_http: Option<String>

Optional REST URL override.

base_url_ws: Option<String>

Optional WebSocket URL override.

proxy_url: Option<SecretString>

Optional proxy URL for HTTP and WebSocket transports.

http_timeout_secs: u64

HTTP request timeout in seconds.

ws_timeout_secs: u64

WebSocket connection and reconnection 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.

use_gtd: bool

Whether to use Lighter-native GTD orders.

The current Lighter venue validation requires a GoodTillTime expiry of at least five minutes, so a shorter strategy GTD lifetime cannot be represented as an explicit venue expiry. Set to false only when the strategy manages GTD expiry locally. Lighter then uses a 28-day fallback expiry and the strategy must enable manage_gtd_expiry so the local expiry timer sends the cancel. Local strategy expiries beyond 28 days are denied because the fallback would expire first; use native GTD for those orders.

scheduled_cancel_timeout_secs: Option<u64>

Arms and renews account-wide scheduled cancellation with this timeout in seconds.

Valid values are [420, 1_295_940]. None leaves the venue schedule untouched. Connection fails if arming does not execute within 30 seconds after account streams are ready. Shutdown stops renewal and preserves the last deadline. Scheduled cancellation does not close positions.

Implementations

impl LighterExecutionClientConfig

pub fn builder() -> LighterExecutionClientConfigBuilder

Create an instance of LighterExecutionClientConfig using the builder syntax

impl LighterExecutionClientConfig

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.

pub fn resolved_venue(&self) -> Venue

Returns the configured venue or the deployment default.

pub fn settlement_currency(&self) -> Currency

Returns the deployment settlement currency.

pub const fn chain_id(&self) -> u32

Returns the L2 signing-domain chain ID for the deployment and environment.

Trait Implementations

impl ClientConfig for LighterExecutionClientConfig

fn as_any(&self) -> &dyn Any

Return the configuration as a trait object.

impl Clone for LighterExecutionClientConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LighterExecutionClientConfig

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

Formats the value using the given formatter.

impl Default for LighterExecutionClientConfig

fn default() -> Self

Returns the “default value” for a type.

impl DerefToPyAny for LighterExecutionClientConfig

impl<'de> Deserialize<'de> for LighterExecutionClientConfig

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

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 LighterExecutionClientConfig

type Target = LighterExecutionClientConfig

The Python output type

type Output = Bound<'py, LighterExecutionClientConfig>

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>) -> PyResult<Bound<'py, Self>>

Performs the conversion.

impl PyClass for LighterExecutionClientConfig

const NAME: &str = "LighterExecutionClientConfig"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for LighterExecutionClientConfig

const MODULE: Option<&str>

Module which the class will be associated with.

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

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

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 __traverse__(&self, visit: PyVisit<'_>) -> Result<(), PyTraverseError>

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)]

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 LighterExecutionClientConfig

const TEXT_SIGNATURE: &'static str = "(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, transport_backend=None, deployment=None, venue=None, use_gtd=True, scheduled_cancel_timeout_secs=None)"

impl PyStubType for LighterExecutionClientConfig

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 LighterExecutionClientConfig

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 LighterExecutionClientConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.