Skip to main content

LighterExecutionClientConfigBuilder

nautilus_lighter::config

Struct LighterExecutionClientConfigBuilder 

Source 
pub struct LighterExecutionClientConfigBuilder<S: State = Empty> { /* private fields */ }
Expand description

Use builder syntax to set the inputs and finish with build().

Implementations§

Source§

impl<S: State> LighterExecutionClientConfigBuilder<S>

Source

pub fn build(self) -> LighterExecutionClientConfig
where S: IsComplete,

Finish building and return the requested object

Source

pub fn environment( self, value: LighterEnvironment, ) -> LighterExecutionClientConfigBuilder<SetEnvironment<S>>
where S::Environment: IsUnset,

Optional (Some / Option setters). Default: <LighterEnvironment as Default>::default().

Target environment within the selected deployment.

Source

pub fn maybe_environment( self, value: Option<LighterEnvironment>, ) -> LighterExecutionClientConfigBuilder<SetEnvironment<S>>
where S::Environment: IsUnset,

Optional (Some / Option setters). Default: <LighterEnvironment as Default>::default().

Target environment within the selected deployment.

Source

pub fn deployment( self, value: LighterDeployment, ) -> LighterExecutionClientConfigBuilder<SetDeployment<S>>
where S::Deployment: IsUnset,

Optional (Some / Option setters). Default: <LighterDeployment as Default>::default().

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

Source

pub fn maybe_deployment( self, value: Option<LighterDeployment>, ) -> LighterExecutionClientConfigBuilder<SetDeployment<S>>
where S::Deployment: IsUnset,

Optional (Some / Option setters). Default: <LighterDeployment as Default>::default().

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

Source

pub fn venue( self, value: Venue, ) -> LighterExecutionClientConfigBuilder<SetVenue<S>>
where S::Venue: IsUnset,

Optional (Some / Option setters). Optional Nautilus venue identifier override.

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

Source

pub fn maybe_venue( self, value: Option<Venue>, ) -> LighterExecutionClientConfigBuilder<SetVenue<S>>
where S::Venue: IsUnset,

Optional (Some / Option setters). Optional Nautilus venue identifier override.

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

Source

pub fn account_id( self, value: AccountId, ) -> LighterExecutionClientConfigBuilder<SetAccountId<S>>
where S::AccountId: IsUnset,

Optional (Some / Option setters). Default: AccountId::from("LIGHTER-001").

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

Source

pub fn maybe_account_id( self, value: Option<AccountId>, ) -> LighterExecutionClientConfigBuilder<SetAccountId<S>>
where S::AccountId: IsUnset,

Optional (Some / Option setters). Default: AccountId::from("LIGHTER-001").

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

Source

pub fn account_index( self, value: u64, ) -> LighterExecutionClientConfigBuilder<SetAccountIndex<S>>
where S::AccountIndex: IsUnset,

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

Source

pub fn maybe_account_index( self, value: Option<u64>, ) -> LighterExecutionClientConfigBuilder<SetAccountIndex<S>>
where S::AccountIndex: IsUnset,

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

Source

pub fn api_key_index( self, value: u8, ) -> LighterExecutionClientConfigBuilder<SetApiKeyIndex<S>>
where S::ApiKeyIndex: IsUnset,

Optional (Some / Option setters). 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.

Source

pub fn maybe_api_key_index( self, value: Option<u8>, ) -> LighterExecutionClientConfigBuilder<SetApiKeyIndex<S>>
where S::ApiKeyIndex: IsUnset,

Optional (Some / Option setters). 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.

Source

pub fn private_key( self, value: String, ) -> LighterExecutionClientConfigBuilder<SetPrivateKey<S>>
where S::PrivateKey: IsUnset,

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

Source

pub fn maybe_private_key( self, value: Option<String>, ) -> LighterExecutionClientConfigBuilder<SetPrivateKey<S>>
where S::PrivateKey: IsUnset,

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

Source

pub fn base_url_http( self, value: String, ) -> LighterExecutionClientConfigBuilder<SetBaseUrlHttp<S>>
where S::BaseUrlHttp: IsUnset,

Optional (Some / Option setters). Optional REST URL override.

Source

pub fn maybe_base_url_http( self, value: Option<String>, ) -> LighterExecutionClientConfigBuilder<SetBaseUrlHttp<S>>
where S::BaseUrlHttp: IsUnset,

Optional (Some / Option setters). Optional REST URL override.

Source

pub fn base_url_ws( self, value: String, ) -> LighterExecutionClientConfigBuilder<SetBaseUrlWs<S>>
where S::BaseUrlWs: IsUnset,

Optional (Some / Option setters). Optional WebSocket URL override.

Source

pub fn maybe_base_url_ws( self, value: Option<String>, ) -> LighterExecutionClientConfigBuilder<SetBaseUrlWs<S>>
where S::BaseUrlWs: IsUnset,

Optional (Some / Option setters). Optional WebSocket URL override.

Source

pub fn proxy_url( self, value: String, ) -> LighterExecutionClientConfigBuilder<SetProxyUrl<S>>
where S::ProxyUrl: IsUnset,

Optional (Some / Option setters). Optional proxy URL for HTTP and WebSocket transports.

Source

pub fn maybe_proxy_url( self, value: Option<String>, ) -> LighterExecutionClientConfigBuilder<SetProxyUrl<S>>
where S::ProxyUrl: IsUnset,

Optional (Some / Option setters). Optional proxy URL for HTTP and WebSocket transports.

Source

pub fn http_timeout_secs( self, value: u64, ) -> LighterExecutionClientConfigBuilder<SetHttpTimeoutSecs<S>>
where S::HttpTimeoutSecs: IsUnset,

Optional (Some / Option setters). Default: 60.

HTTP request timeout in seconds.

Source

pub fn maybe_http_timeout_secs( self, value: Option<u64>, ) -> LighterExecutionClientConfigBuilder<SetHttpTimeoutSecs<S>>
where S::HttpTimeoutSecs: IsUnset,

Optional (Some / Option setters). Default: 60.

HTTP request timeout in seconds.

Source

pub fn ws_timeout_secs( self, value: u64, ) -> LighterExecutionClientConfigBuilder<SetWsTimeoutSecs<S>>
where S::WsTimeoutSecs: IsUnset,

Optional (Some / Option setters). Default: 30.

WebSocket connection and reconnection timeout in seconds.

Source

pub fn maybe_ws_timeout_secs( self, value: Option<u64>, ) -> LighterExecutionClientConfigBuilder<SetWsTimeoutSecs<S>>
where S::WsTimeoutSecs: IsUnset,

Optional (Some / Option setters). Default: 30.

WebSocket connection and reconnection timeout in seconds.

Source

pub fn market_order_slippage_bps( self, value: u32, ) -> LighterExecutionClientConfigBuilder<SetMarketOrderSlippageBps<S>>
where S::MarketOrderSlippageBps: IsUnset,

Optional (Some / Option setters). Default: 50.

Slippage buffer in basis points for market-style orders.

Source

pub fn maybe_market_order_slippage_bps( self, value: Option<u32>, ) -> LighterExecutionClientConfigBuilder<SetMarketOrderSlippageBps<S>>
where S::MarketOrderSlippageBps: IsUnset,

Optional (Some / Option setters). Default: 50.

Slippage buffer in basis points for market-style orders.

Source

pub fn rest_quota_per_min( self, value: u32, ) -> LighterExecutionClientConfigBuilder<SetRestQuotaPerMin<S>>
where S::RestQuotaPerMin: IsUnset,

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

Source

pub fn maybe_rest_quota_per_min( self, value: Option<u32>, ) -> LighterExecutionClientConfigBuilder<SetRestQuotaPerMin<S>>
where S::RestQuotaPerMin: IsUnset,

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

Source

pub fn sendtx_quota_per_min( self, value: u32, ) -> LighterExecutionClientConfigBuilder<SetSendtxQuotaPerMin<S>>
where S::SendtxQuotaPerMin: IsUnset,

Optional (Some / Option setters). 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).

Source

pub fn maybe_sendtx_quota_per_min( self, value: Option<u32>, ) -> LighterExecutionClientConfigBuilder<SetSendtxQuotaPerMin<S>>
where S::SendtxQuotaPerMin: IsUnset,

Optional (Some / Option setters). 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).

Source

pub fn transport_backend( self, value: TransportBackend, ) -> LighterExecutionClientConfigBuilder<SetTransportBackend<S>>
where S::TransportBackend: IsUnset,

Optional (Some / Option setters). Default: <TransportBackend as Default>::default().

WebSocket transport backend.

Source

pub fn maybe_transport_backend( self, value: Option<TransportBackend>, ) -> LighterExecutionClientConfigBuilder<SetTransportBackend<S>>
where S::TransportBackend: IsUnset,

Optional (Some / Option setters). Default: <TransportBackend as Default>::default().

WebSocket transport backend.

Auto Trait Implementations§

Blanket Implementations§

§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> Ungil for T
where T: Send,

§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more