Struct LighterExecutionClient 

pub struct LighterExecutionClient { /* private fields */ }

Implementations

impl LighterExecutionClient

pub fn new( core: ExecutionClientCore, config: LighterExecClientConfig, ) -> Result<Self>

Creates a new LighterExecutionClient instance.

Resolves credentials from config or the matching environment variables (see crate::common::credential). Missing credentials degrade to an unauthenticated client that can bootstrap instruments but cannot submit transactions; the constructor returns an error if supplied values are malformed.

Errors

Returns an error if the HTTP client fails to initialize or if any supplied credential value cannot be parsed.

pub fn config(&self) -> &LighterExecClientConfig

Returns a reference to the configuration.

pub fn has_credentials(&self) -> bool

Returns true when the client holds resolved Lighter credentials.

pub fn pending_tasks_all_finished(&self) -> bool

Returns true when every background task spawned by this client has completed. Useful in tests to wait for fire-and-forget HTTP work.

Panics

Panics if the internal mutex is poisoned, which can only occur if a task holding the lock previously panicked.

pub fn update_leverage( &self, instrument_id: InstrumentId, initial_margin_fraction: u16, margin_mode: LighterPositionMarginMode, ) -> Result<()>

Submit Lighter’s native UpdateLeverage tx (tx_type = 20).

Changes the initial margin fraction and the position margin mode for the given market. initial_margin_fraction is in venue ticks (1e-4 fraction): 500 = 5% initial margin = 20x leverage, 1000 = 10% = 10x, etc. Valid range is 1..=10_000 (the upstream MarginFractionTick cap).

Nautilus does not expose a set_leverage command on the execution trait, so this method is callable directly from strategy or bootstrap code.

Errors

Returns an error if credentials are missing, the instrument is not registered, initial_margin_fraction is outside 1..=10_000, or the dispatch pre-flight (nonce allocation, signing) fails. Transport errors after dispatch are logged but not returned synchronously.

Trait Implementations

impl Debug for LighterExecutionClient

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

Formats the value using the given formatter.

impl ExecutionClient for LighterExecutionClient

fn is_connected(&self) -> bool

fn client_id(&self) -> ClientId

fn account_id(&self) -> AccountId

fn venue(&self) -> Venue

fn oms_type(&self) -> OmsType

fn get_account(&self) -> Option<AccountAny>

fn generate_account_state( &self, balances: Vec<AccountBalance>, margins: Vec<MarginBalance>, reported: bool, ts_event: UnixNanos, ) -> Result<()>

Generates and publishes the account state event.

fn start(&mut self) -> Result<()>

Starts the execution client.

fn stop(&mut self) -> Result<()>

Stops the execution client.

fn connect<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<()>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Connects the client to the execution venue.

fn disconnect<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<()>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Disconnects the client from the execution venue.

fn submit_order(&self, cmd: SubmitOrder) -> Result<()>

Submits a single order command to the execution venue.

fn submit_order_list(&self, cmd: SubmitOrderList) -> Result<()>

Submits a list of orders to the execution venue.

fn modify_order(&self, cmd: ModifyOrder) -> Result<()>

Modifies an existing order.

fn cancel_order(&self, cmd: CancelOrder) -> Result<()>

Cancels a specific order.

fn cancel_all_orders(&self, cmd: CancelAllOrders) -> Result<()>

Cancels all orders.

fn batch_cancel_orders(&self, cmd: BatchCancelOrders) -> Result<()>

Cancels a batch of orders.

fn query_account(&self, _cmd: QueryAccount) -> Result<()>

Queries the status of an account.

fn query_order(&self, cmd: QueryOrder) -> Result<()>

Queries the status of an order.

fn generate_order_status_report<'life0, 'life1, 'async_trait>( &'life0 self, cmd: &'life1 GenerateOrderStatusReport, ) -> Pin<Box<dyn Future<Output = Result<Option<OrderStatusReport>>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Generates a single order status report.

fn generate_order_status_reports<'life0, 'life1, 'async_trait>( &'life0 self, cmd: &'life1 GenerateOrderStatusReports, ) -> Pin<Box<dyn Future<Output = Result<Vec<OrderStatusReport>>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Generates multiple order status reports.

fn generate_fill_reports<'life0, 'async_trait>( &'life0 self, cmd: GenerateFillReports, ) -> Pin<Box<dyn Future<Output = Result<Vec<FillReport>>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Generates fill reports based on execution results.

fn generate_position_status_reports<'life0, 'life1, 'async_trait>( &'life0 self, cmd: &'life1 GeneratePositionStatusReports, ) -> Pin<Box<dyn Future<Output = Result<Vec<PositionStatusReport>>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Generates position status reports.

fn generate_mass_status<'life0, 'async_trait>( &'life0 self, lookback_mins: Option<u64>, ) -> Pin<Box<dyn Future<Output = Result<Option<ExecutionMassStatus>>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Generates mass status for executions.

fn handles_order_venue(&self, venue: Venue) -> bool

Returns whether this client can execute orders for the given instrument venue.

fn reset(&mut self) -> Result<(), Error>

Resets the execution client to its initial state.

fn dispose(&mut self) -> Result<(), Error>

Disposes of client resources and cleans up.

fn batch_modify_orders(&self, cmd: BatchModifyOrders) -> Result<(), Error>

Modifies a batch of orders.

fn register_external_order( &self, _client_order_id: ClientOrderId, _venue_order_id: VenueOrderId, _instrument_id: InstrumentId, _strategy_id: StrategyId, _ts_init: UnixNanos, )

Registers an external order for tracking by the execution client.

fn on_instrument(&mut self, _instrument: InstrumentAny)

Handles an instrument update received via the message bus.

fn calculate_commission( &self, instrument: &InstrumentAny, last_qty: Quantity, last_px: Price, liquidity_side: LiquiditySide, ) -> Option<Money>

Calculates the commission for a reconciliation fill.