Struct LighterExecutionClient 

pub struct LighterExecutionClient { /* private fields */ }

Implementations

impl LighterExecutionClient

pub fn new( core: ExecutionClientCore, config: LighterExecutionClientConfig, ) -> 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 configuration or supplied credentials are invalid, or if the HTTP client fails to initialize.

pub fn config(&self) -> &LighterExecutionClientConfig

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 retained background task has completed. Useful in tests to wait for fire-and-forget HTTP work.

pub async fn cancel_all_orders_account(&self) -> Result<String>

Cancels all open orders across the account’s markets and strategies, including uncached orders.

Does not close positions or change instrument-scoped CancelAllOrders.

Submission

Returns an accepted transaction hash; venue updates confirm cancellation. Dropping the future does not stop submission, even while rate limited. Shutdown can discard unsent work. Transport, confirmation, or shutdown failures can leave the outcome unknown.

Errors

Returns an error if:

• Credentials or nonce readiness are unavailable, or signing fails.
• Submission or confirmation fails, including shutdown or venue rejection.

pub async fn schedule_cancel(&self, time: Option<u64>) -> Result<String>

Arms, replaces, or revokes account-wide scheduled cancellation of open orders.

Deadline

Some(time) sets or replaces a Unix timestamp in milliseconds, five minutes to fifteen days ahead of the local clock. Allow headroom for latency, rate limits, and clock skew. None revokes it. Armed schedules survive disconnect or exit, without automatic renewal.

Submission

Returns an accepted hash, not proof of arming, replacement, or revocation. Account scope and submission behavior follow Self::cancel_all_orders_account, including when the future is dropped.

Errors

Returns an error if:

• The deadline is outside the supported window.
• Preparation, submission, or confirmation fails.

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, info: Option<Params>, ) -> 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 reset(&mut self) -> Result<()>

Resets the execution client to its initial state.

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

Disposes of client resources and cleans up.

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 batch_modify_orders(&self, cmd: BatchModifyOrders) -> Result<()>

Modifies a batch of orders.

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_task( &self, cmd: &GenerateOrderStatusReport, ) -> Option<ExecutionReportTask<Option<OrderStatusReport>>>

Prepares worker-safe single-order collection, or uses inline collection.

fn generate_order_status_reports_task( &self, cmd: &GenerateOrderStatusReports, ) -> Option<ExecutionReportTask<Vec<OrderStatusReport>>>

Prepares worker-safe bulk order collection, or uses inline collection.

fn generate_fill_reports_task( &self, cmd: &GenerateFillReports, ) -> Option<ExecutionReportTask<Vec<FillReport>>>

Prepares worker-safe fill collection, or uses inline collection.

fn generate_position_status_reports_task( &self, cmd: &GeneratePositionStatusReports, ) -> Option<ExecutionReportTask<Vec<PositionStatusReport>>>

Prepares worker-safe position collection, or uses inline collection.

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 retain_unresolved_submissions(&self) -> bool

Returns whether unacknowledged orders require venue evidence before local closure.

fn venue_order_ids( &self, _mass_status: &ExecutionMassStatus, ) -> Option<IndexMap<ClientOrderId, Vec<VenueOrderId>>>

Returns venue order ID histories for startup reconciliation, keyed by client order ID.

fn position_reconciliation_tolerance(&self) -> Decimal

Returns the maximum absolute position difference tolerated during reconciliation.

fn allows_reconciliation_overfill( &self, _order: &OrderAny, _report: &FillReport, ) -> bool

Returns whether reconciliation may raise the order quantity so this fill can apply.

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

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

fn provides_bulk_position_coverage(&self, _instrument_id: InstrumentId) -> bool

Returns whether a bulk position status report request provides complete coverage for the given instrument, so that an absent report is evidence the position is flat.

fn settles_contract_expirations(&self) -> bool

Returns whether this client’s venue settles expiring contracts itself, such as a simulated venue that closes positions with expiration fills.

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, ) -> Result<Option<Money>, Error>

Calculates the commission for a reconciliation fill.