Skip to main content

BlockchainDataClientConfigBuilder

nautilus_blockchain::config

Struct BlockchainDataClientConfigBuilder 

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

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

Implementations§

Source§

impl<S: State> BlockchainDataClientConfigBuilder<S>

Source

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

Finish building and return the requested object

Source

pub fn chain( self, value: SharedChain, ) -> BlockchainDataClientConfigBuilder<SetChain<S>>
where S::Chain: IsUnset,

Required.

The blockchain chain configuration.

Source

pub fn dex_ids( self, value: Vec<DexType>, ) -> BlockchainDataClientConfigBuilder<SetDexIds<S>>
where S::DexIds: IsUnset,

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

List of decentralized exchange IDs to register and sync during connection.

Source

pub fn maybe_dex_ids( self, value: Option<Vec<DexType>>, ) -> BlockchainDataClientConfigBuilder<SetDexIds<S>>
where S::DexIds: IsUnset,

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

List of decentralized exchange IDs to register and sync during connection.

Source

pub fn use_hypersync_for_live_data( self, value: bool, ) -> BlockchainDataClientConfigBuilder<SetUseHypersyncForLiveData<S>>
where S::UseHypersyncForLiveData: IsUnset,

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

Determines if the client should use Hypersync for live data streaming.

Source

pub fn maybe_use_hypersync_for_live_data( self, value: Option<bool>, ) -> BlockchainDataClientConfigBuilder<SetUseHypersyncForLiveData<S>>
where S::UseHypersyncForLiveData: IsUnset,

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

Determines if the client should use Hypersync for live data streaming.

Source

pub fn http_rpc_url( self, value: String, ) -> BlockchainDataClientConfigBuilder<SetHttpRpcUrl<S>>
where S::HttpRpcUrl: IsUnset,

Required.

The HTTP URL for the blockchain RPC endpoint.

Source

pub fn rpc_requests_per_second( self, value: u32, ) -> BlockchainDataClientConfigBuilder<SetRpcRequestsPerSecond<S>>
where S::RpcRequestsPerSecond: IsUnset,

Optional (Some / Option setters). The maximum number of RPC requests allowed per second.

Source

pub fn maybe_rpc_requests_per_second( self, value: Option<u32>, ) -> BlockchainDataClientConfigBuilder<SetRpcRequestsPerSecond<S>>
where S::RpcRequestsPerSecond: IsUnset,

Optional (Some / Option setters). The maximum number of RPC requests allowed per second.

Source

pub fn multicall_calls_per_rpc_request( self, value: u32, ) -> BlockchainDataClientConfigBuilder<SetMulticallCallsPerRpcRequest<S>>
where S::MulticallCallsPerRpcRequest: IsUnset,

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

The maximum number of Multicall calls per one RPC request.

Source

pub fn maybe_multicall_calls_per_rpc_request( self, value: Option<u32>, ) -> BlockchainDataClientConfigBuilder<SetMulticallCallsPerRpcRequest<S>>
where S::MulticallCallsPerRpcRequest: IsUnset,

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

The maximum number of Multicall calls per one RPC request.

Source

pub fn wss_rpc_url( self, value: String, ) -> BlockchainDataClientConfigBuilder<SetWssRpcUrl<S>>
where S::WssRpcUrl: IsUnset,

Optional (Some / Option setters). The WebSocket secure URL for the blockchain RPC endpoint.

Source

pub fn maybe_wss_rpc_url( self, value: Option<String>, ) -> BlockchainDataClientConfigBuilder<SetWssRpcUrl<S>>
where S::WssRpcUrl: IsUnset,

Optional (Some / Option setters). The WebSocket secure URL for the blockchain RPC endpoint.

Source

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

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

Source

pub fn from_block( self, value: u64, ) -> BlockchainDataClientConfigBuilder<SetFromBlock<S>>
where S::FromBlock: IsUnset,

Optional (Some / Option setters). The block from which to sync historical data.

Source

pub fn maybe_from_block( self, value: Option<u64>, ) -> BlockchainDataClientConfigBuilder<SetFromBlock<S>>
where S::FromBlock: IsUnset,

Optional (Some / Option setters). The block from which to sync historical data.

Source

pub fn pool_filters( self, value: DexPoolFilters, ) -> BlockchainDataClientConfigBuilder<SetPoolFilters<S>>
where S::PoolFilters: IsUnset,

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

Filtering criteria that define which DEX pools to include in the data universe.

Source

pub fn maybe_pool_filters( self, value: Option<DexPoolFilters>, ) -> BlockchainDataClientConfigBuilder<SetPoolFilters<S>>
where S::PoolFilters: IsUnset,

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

Filtering criteria that define which DEX pools to include in the data universe.

Source

pub fn postgres_cache_database_config( self, value: PostgresConnectOptions, ) -> BlockchainDataClientConfigBuilder<SetPostgresCacheDatabaseConfig<S>>
where S::PostgresCacheDatabaseConfig: IsUnset,

Optional (Some / Option setters). Optional configuration for data client’s Postgres cache database

Source

pub fn maybe_postgres_cache_database_config( self, value: Option<PostgresConnectOptions>, ) -> BlockchainDataClientConfigBuilder<SetPostgresCacheDatabaseConfig<S>>
where S::PostgresCacheDatabaseConfig: IsUnset,

Optional (Some / Option setters). Optional configuration for data client’s Postgres cache database

Source

pub fn transport_backend( self, value: TransportBackend, ) -> BlockchainDataClientConfigBuilder<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>, ) -> BlockchainDataClientConfigBuilder<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§

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
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> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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: 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
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 = Infallible

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<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
§

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

§

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

§

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