Skip to main content

OKXExecutionClientConfigBuilder

nautilus_okx::config

Struct OKXExecutionClientConfigBuilder 

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

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

Implementations§

Source§

impl<S: State> OKXExecutionClientConfigBuilder<S>

Source

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

Finish building and return the requested object

Source

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

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

The account ID for the client.

Source

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

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

The account ID for the client.

Source

pub fn api_key( self, value: String, ) -> OKXExecutionClientConfigBuilder<SetApiKey<S>>
where S::ApiKey: IsUnset,

Optional (Some / Option setters). Optional API key for authenticated endpoints.

Source

pub fn maybe_api_key( self, value: Option<String>, ) -> OKXExecutionClientConfigBuilder<SetApiKey<S>>
where S::ApiKey: IsUnset,

Optional (Some / Option setters). Optional API key for authenticated endpoints.

Source

pub fn api_secret( self, value: String, ) -> OKXExecutionClientConfigBuilder<SetApiSecret<S>>
where S::ApiSecret: IsUnset,

Optional (Some / Option setters). Optional API secret for authenticated endpoints.

Source

pub fn maybe_api_secret( self, value: Option<String>, ) -> OKXExecutionClientConfigBuilder<SetApiSecret<S>>
where S::ApiSecret: IsUnset,

Optional (Some / Option setters). Optional API secret for authenticated endpoints.

Source

pub fn api_passphrase( self, value: String, ) -> OKXExecutionClientConfigBuilder<SetApiPassphrase<S>>
where S::ApiPassphrase: IsUnset,

Optional (Some / Option setters). Optional API passphrase for authenticated endpoints.

Source

pub fn maybe_api_passphrase( self, value: Option<String>, ) -> OKXExecutionClientConfigBuilder<SetApiPassphrase<S>>
where S::ApiPassphrase: IsUnset,

Optional (Some / Option setters). Optional API passphrase for authenticated endpoints.

Source

pub fn instrument_types( self, value: Vec<OKXInstrumentType>, ) -> OKXExecutionClientConfigBuilder<SetInstrumentTypes<S>>
where S::InstrumentTypes: IsUnset,

Optional (Some / Option setters). Default: vec![OKXInstrumentType::Spot].

Instrument types the execution client should support.

Source

pub fn maybe_instrument_types( self, value: Option<Vec<OKXInstrumentType>>, ) -> OKXExecutionClientConfigBuilder<SetInstrumentTypes<S>>
where S::InstrumentTypes: IsUnset,

Optional (Some / Option setters). Default: vec![OKXInstrumentType::Spot].

Instrument types the execution client should support.

Source

pub fn contract_types( self, value: Vec<OKXContractType>, ) -> OKXExecutionClientConfigBuilder<SetContractTypes<S>>
where S::ContractTypes: IsUnset,

Optional (Some / Option setters). Contract type filter applied to operations.

Source

pub fn maybe_contract_types( self, value: Option<Vec<OKXContractType>>, ) -> OKXExecutionClientConfigBuilder<SetContractTypes<S>>
where S::ContractTypes: IsUnset,

Optional (Some / Option setters). Contract type filter applied to operations.

Source

pub fn instrument_families( self, value: Vec<String>, ) -> OKXExecutionClientConfigBuilder<SetInstrumentFamilies<S>>
where S::InstrumentFamilies: IsUnset,

Optional (Some / Option setters). Instrument families to load (e.g., “BTC-USD”, “ETH-USD”). Required for OPTIONS. Optional for FUTURES/SWAP. Not applicable for SPOT/MARGIN.

Source

pub fn maybe_instrument_families( self, value: Option<Vec<String>>, ) -> OKXExecutionClientConfigBuilder<SetInstrumentFamilies<S>>
where S::InstrumentFamilies: IsUnset,

Optional (Some / Option setters). Instrument families to load (e.g., “BTC-USD”, “ETH-USD”). Required for OPTIONS. Optional for FUTURES/SWAP. Not applicable for SPOT/MARGIN.

Source

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

Optional (Some / Option setters). Optional override for the HTTP base URL.

Source

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

Optional (Some / Option setters). Optional override for the HTTP base URL.

Source

pub fn base_url_ws_private( self, value: String, ) -> OKXExecutionClientConfigBuilder<SetBaseUrlWsPrivate<S>>
where S::BaseUrlWsPrivate: IsUnset,

Optional (Some / Option setters). Optional override for the private WebSocket URL.

Source

pub fn maybe_base_url_ws_private( self, value: Option<String>, ) -> OKXExecutionClientConfigBuilder<SetBaseUrlWsPrivate<S>>
where S::BaseUrlWsPrivate: IsUnset,

Optional (Some / Option setters). Optional override for the private WebSocket URL.

Source

pub fn base_url_ws_business( self, value: String, ) -> OKXExecutionClientConfigBuilder<SetBaseUrlWsBusiness<S>>
where S::BaseUrlWsBusiness: IsUnset,

Optional (Some / Option setters). Optional override for the business WebSocket URL.

Source

pub fn maybe_base_url_ws_business( self, value: Option<String>, ) -> OKXExecutionClientConfigBuilder<SetBaseUrlWsBusiness<S>>
where S::BaseUrlWsBusiness: IsUnset,

Optional (Some / Option setters). Optional override for the business WebSocket URL.

Source

pub fn proxy_url( self, value: String, ) -> OKXExecutionClientConfigBuilder<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>, ) -> OKXExecutionClientConfigBuilder<SetProxyUrl<S>>
where S::ProxyUrl: IsUnset,

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

Source

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

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

The API environment (live or demo).

Source

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

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

The API environment (live or demo).

Source

pub fn region( self, value: OKXRegion, ) -> OKXExecutionClientConfigBuilder<SetRegion<S>>
where S::Region: IsUnset,

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

The API region (global, EEA, or US).

Source

pub fn maybe_region( self, value: Option<OKXRegion>, ) -> OKXExecutionClientConfigBuilder<SetRegion<S>>
where S::Region: IsUnset,

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

The API region (global, EEA, or US).

Source

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

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

HTTP timeout in seconds.

Source

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

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

HTTP timeout in seconds.

Source

pub fn load_spreads( self, value: bool, ) -> OKXExecutionClientConfigBuilder<SetLoadSpreads<S>>
where S::LoadSpreads: IsUnset,

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

Whether to subscribe to spread order updates from the separate spread channel.

Source

pub fn maybe_load_spreads( self, value: Option<bool>, ) -> OKXExecutionClientConfigBuilder<SetLoadSpreads<S>>
where S::LoadSpreads: IsUnset,

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

Whether to subscribe to spread order updates from the separate spread channel.

Source

pub fn use_mm_mass_cancel( self, value: bool, ) -> OKXExecutionClientConfigBuilder<SetUseMmMassCancel<S>>
where S::UseMmMassCancel: IsUnset,

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

Enables mass-cancel support when true.

Source

pub fn maybe_use_mm_mass_cancel( self, value: Option<bool>, ) -> OKXExecutionClientConfigBuilder<SetUseMmMassCancel<S>>
where S::UseMmMassCancel: IsUnset,

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

Enables mass-cancel support when true.

Source

pub fn max_retries( self, value: u32, ) -> OKXExecutionClientConfigBuilder<SetMaxRetries<S>>
where S::MaxRetries: IsUnset,

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

Maximum retry attempts for requests.

Source

pub fn maybe_max_retries( self, value: Option<u32>, ) -> OKXExecutionClientConfigBuilder<SetMaxRetries<S>>
where S::MaxRetries: IsUnset,

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

Maximum retry attempts for requests.

Source

pub fn retry_delay_initial_ms( self, value: u64, ) -> OKXExecutionClientConfigBuilder<SetRetryDelayInitialMs<S>>
where S::RetryDelayInitialMs: IsUnset,

Optional (Some / Option setters). Default: 1_000.

Initial retry delay in milliseconds.

Source

pub fn maybe_retry_delay_initial_ms( self, value: Option<u64>, ) -> OKXExecutionClientConfigBuilder<SetRetryDelayInitialMs<S>>
where S::RetryDelayInitialMs: IsUnset,

Optional (Some / Option setters). Default: 1_000.

Initial retry delay in milliseconds.

Source

pub fn retry_delay_max_ms( self, value: u64, ) -> OKXExecutionClientConfigBuilder<SetRetryDelayMaxMs<S>>
where S::RetryDelayMaxMs: IsUnset,

Optional (Some / Option setters). Default: 10_000.

Maximum retry delay in milliseconds.

Source

pub fn maybe_retry_delay_max_ms( self, value: Option<u64>, ) -> OKXExecutionClientConfigBuilder<SetRetryDelayMaxMs<S>>
where S::RetryDelayMaxMs: IsUnset,

Optional (Some / Option setters). Default: 10_000.

Maximum retry delay in milliseconds.

Source

pub fn margin_mode( self, value: OKXMarginMode, ) -> OKXExecutionClientConfigBuilder<SetMarginMode<S>>
where S::MarginMode: IsUnset,

Optional (Some / Option setters). Optional margin mode (CROSS or ISOLATED) for margin/derivative accounts.

Source

pub fn maybe_margin_mode( self, value: Option<OKXMarginMode>, ) -> OKXExecutionClientConfigBuilder<SetMarginMode<S>>
where S::MarginMode: IsUnset,

Optional (Some / Option setters). Optional margin mode (CROSS or ISOLATED) for margin/derivative accounts.

Source

pub fn use_spot_margin( self, value: bool, ) -> OKXExecutionClientConfigBuilder<SetUseSpotMargin<S>>
where S::UseSpotMargin: IsUnset,

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

Enables margin/leverage for SPOT trading when true.

Source

pub fn maybe_use_spot_margin( self, value: Option<bool>, ) -> OKXExecutionClientConfigBuilder<SetUseSpotMargin<S>>
where S::UseSpotMargin: IsUnset,

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

Enables margin/leverage for SPOT trading when true.

Source

pub fn auth_timeout_secs( self, value: u64, ) -> OKXExecutionClientConfigBuilder<SetAuthTimeoutSecs<S>>
where S::AuthTimeoutSecs: IsUnset,

Optional (Some / Option setters). Optional WebSocket authentication timeout (seconds), defaulting to AUTHENTICATION_TIMEOUT_SECS when unset.

Source

pub fn maybe_auth_timeout_secs( self, value: Option<u64>, ) -> OKXExecutionClientConfigBuilder<SetAuthTimeoutSecs<S>>
where S::AuthTimeoutSecs: IsUnset,

Optional (Some / Option setters). Optional WebSocket authentication timeout (seconds), defaulting to AUTHENTICATION_TIMEOUT_SECS when unset.

Source

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

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

WebSocket transport backend (defaults to Tungstenite).

Source

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

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

WebSocket transport backend (defaults to Tungstenite).

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