Struct BlockchainDataClientConfig 

pub struct BlockchainDataClientConfig {
    pub chain: SharedChain,
    pub dex_ids: Vec<DexType>,
    pub use_hypersync_for_live_data: bool,
    pub http_rpc_url: String,
    pub rpc_requests_per_second: Option<u32>,
    pub multicall_calls_per_rpc_request: u32,
    pub wss_rpc_url: Option<String>,
    pub proxy_url: Option<String>,
    pub from_block: Option<u64>,
    pub pool_filters: DexPoolFilters,
    pub postgres_cache_database_config: Option<PostgresConnectOptions>,
    pub transport_backend: TransportBackend,
}

Configuration for blockchain data clients.

Fields

chain: SharedChain

The blockchain chain configuration.

dex_ids: Vec<DexType>

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

use_hypersync_for_live_data: bool

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

http_rpc_url: String

The HTTP URL for the blockchain RPC endpoint.

rpc_requests_per_second: Option<u32>

The maximum number of RPC requests allowed per second.

multicall_calls_per_rpc_request: u32

The maximum number of Multicall calls per one RPC request.

wss_rpc_url: Option<String>

The WebSocket secure URL for the blockchain RPC endpoint.

proxy_url: Option<String>

Optional proxy URL for HTTP and WebSocket transports.

from_block: Option<u64>

The block from which to sync historical data.

pool_filters: DexPoolFilters

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

postgres_cache_database_config: Option<PostgresConnectOptions>

Optional configuration for data client’s Postgres cache database

transport_backend: TransportBackend

WebSocket transport backend (defaults to Tungstenite).

Implementations

impl BlockchainDataClientConfig

pub fn builder() -> BlockchainDataClientConfigBuilder

Create an instance of BlockchainDataClientConfig using the builder syntax

Trait Implementations

impl ClientConfig for BlockchainDataClientConfig

fn as_any(&self) -> &dyn Any

Return the configuration as a trait object.

impl Clone for BlockchainDataClientConfig

fn clone(&self) -> BlockchainDataClientConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BlockchainDataClientConfig

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

Formats the value using the given formatter.

impl<'a, 'py> FromPyObject<'a, 'py> for BlockchainDataClientConfig

where Self: Clone,

type Error = PyClassGuardError<'a, 'py>

The type returned in the event of a conversion error.

fn extract( obj: Borrowed<'a, 'py, PyAny>, ) -> Result<Self, <Self as FromPyObject<'a, 'py>>::Error>

Extracts Self from the bound smart pointer obj.

impl<'py> IntoPyObject<'py> for BlockchainDataClientConfig

type Target = BlockchainDataClientConfig

The Python output type

type Output = Bound<'py, <BlockchainDataClientConfig as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for BlockchainDataClientConfig

const NAME: &str = "BlockchainDataClientConfig"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for BlockchainDataClientConfig

const MODULE: Option<&str>

Module which the class will be associated with.

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// Configuration for blockchain data clients.

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type Layout = <<BlockchainDataClientConfig as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<BlockchainDataClientConfig>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForBlockchainDataClientConfig

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<PyObjectOffset>

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyClassNewTextSignature for BlockchainDataClientConfig

const TEXT_SIGNATURE: &'static str = "(chain, dex_ids, http_rpc_url, rpc_requests_per_second=None, multicall_calls_per_rpc_request=None, wss_rpc_url=None, use_hypersync_for_live_data=True, from_block=None, pool_filters=None, postgres_cache_database_config=None, proxy_url=None)"

impl PyStubType for BlockchainDataClientConfig

fn type_output() -> TypeInfo

The type to be used in the output signature, i.e. return type of the Python function or methods.

fn type_input() -> TypeInfo

The type to be used in the input signature, i.e. the arguments of the Python function or methods.

impl PyTypeInfo for BlockchainDataClientConfig

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl DerefToPyAny for BlockchainDataClientConfig