Struct BlockchainDataClient

Source
pub struct BlockchainDataClient {
    pub chain: SharedChain,
    pub config: BlockchainDataClientConfig,
    /* private fields */
}
Expand description

A comprehensive client for interacting with blockchain data from multiple sources.

The BlockchainDataClient serves as a facade that coordinates between different blockchain data providers, caching mechanisms, and contract interactions. It provides a unified interface for retrieving and processing blockchain data, particularly focused on DeFi protocols.

This client supports two primary data sources:

  1. Direct RPC connections to blockchain nodes (via WebSocket).
  2. HyperSync API for efficient historical data queries.

Fields§

§chain: SharedChain

The blockchain being targeted by this client instance.

§config: BlockchainDataClientConfig

The configuration for the data client.

Implementations§

Source§

impl BlockchainDataClient

Source

pub fn new(config: BlockchainDataClientConfig) -> Self

Creates a new BlockchainDataClient instance for the specified configuration.

§Panics

Panics if use_hypersync_for_live_data is false and wss_rpc_url is None in the provided config.

Source

pub async fn initialize_cache_database( &mut self, pg_connect_options: Option<PostgresConnectOptions>, )

Initializes the database connection for the blockchain cache.

Source

pub async fn sync_blocks(&mut self, from_block: Option<u64>) -> Result<()>

Synchronizes blockchain data by fetching and caching all blocks from the starting block to the current chain head.

Source

pub async fn sync_pool_swaps( &mut self, dex_id: &str, pool_address: String, from_block: Option<u64>, to_block: Option<u64>, ) -> Result<()>

Fetches and caches all swap events for a specific liquidity pool within the given block range.

Source

pub async fn sync_pool_mints( &self, dex_id: &str, pool_address: String, from_block: Option<u64>, to_block: Option<u64>, ) -> Result<()>

Fetches and caches all mint events for a specific liquidity pool within the given block range.

Source

pub async fn sync_pool_burns( &self, dex_id: &str, pool_address: String, from_block: Option<u64>, to_block: Option<u64>, ) -> Result<()>

Fetches and caches all burn events for a specific liquidity pool within the given block range.

Source

pub async fn sync_exchange_pools( &mut self, dex_id: &str, from_block: Option<u64>, to_block: Option<u64>, ) -> Result<()>

Synchronizes token and pool data for a specific DEX from the specified block.

Source

pub async fn process_token(&mut self, token_address: String) -> Result<()>

Processes a token by address, fetching and caching its metadata if not already cached.

§Errors

Returns an error if fetching token info or adding to cache fails.

Source

pub async fn register_exchange(&mut self, dex: DexExtended) -> Result<()>

Registers a decentralized exchange with the client.

Source

pub async fn process_hypersync_messages(&mut self)

Processes incoming messages from the HyperSync client.

Source

pub async fn process_rpc_messages(&mut self)

Processes incoming messages from the RPC client.

Source

pub async fn subscribe_blocks_async(&mut self) -> Result<()>

Subscribes to new blockchain blocks from the available data source.

Source

pub async fn subscribe_pool_swaps_async(&mut self) -> Result<()>

Subscribes to new blockchain blocks from the available data source.

Source

pub async fn unsubscribe_blocks_async(&mut self) -> Result<()>

Unsubscribes from block events.

Source

pub async fn unsubscribe_pool_swaps_async(&mut self) -> Result<()>

Unsubscribes from swap events.

Trait Implementations§

Source§

impl DataClient for BlockchainDataClient

Source§

fn client_id(&self) -> ClientId

Returns the unique identifier for this data client.
Source§

fn venue(&self) -> Option<Venue>

Returns the optional venue this client is associated with.
Source§

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

Starts the data client. Read more
Source§

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

Stops the data client. Read more
Source§

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

Resets the data client to its initial state. Read more
Source§

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

Disposes of client resources and cleans up. Read more
Source§

fn connect<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Connects external API’s if needed. Read more
Source§

fn disconnect<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Disconnects external API’s if needed. Read more
Source§

fn is_connected(&self) -> bool

Returns true if the client is currently connected.
Source§

fn is_disconnected(&self) -> bool

Returns true if the client is currently disconnected.
Source§

fn subscribe_blocks(&mut self, cmd: &SubscribeBlocks) -> Result<()>

Subscribes to blocks for a specified blockchain. Read more
Source§

fn subscribe_pool(&mut self, cmd: &SubscribePool) -> Result<()>

Subscribes to pool definition updates for a specified AMM pool. Read more
Source§

fn subscribe_pool_swaps(&mut self, cmd: &SubscribePoolSwaps) -> Result<()>

Subscribes to pool swaps for a specified AMM pool. Read more
Source§

fn subscribe_pool_liquidity_updates( &mut self, cmd: &SubscribePoolLiquidityUpdates, ) -> Result<()>

Subscribes to pool liquidity updates for a specified AMM pool. Read more
Source§

fn unsubscribe_blocks(&mut self, cmd: &UnsubscribeBlocks) -> Result<()>

Unsubscribes from blocks for a specified blockchain. Read more
Source§

fn unsubscribe_pool(&mut self, cmd: &UnsubscribePool) -> Result<()>

Unsubscribes from pool definition updates for a specified AMM pool. Read more
Source§

fn unsubscribe_pool_swaps(&mut self, cmd: &UnsubscribePoolSwaps) -> Result<()>

Unsubscribes from swaps for a specified AMM pool. Read more
Source§

fn unsubscribe_pool_liquidity_updates( &mut self, cmd: &UnsubscribePoolLiquidityUpdates, ) -> Result<()>

Unsubscribes from pool liquidity updates for a specified AMM pool. Read more
§

fn subscribe(&mut self, cmd: &SubscribeCustomData) -> Result<(), Error>

Subscribes to custom data types according to the command. Read more
§

fn subscribe_instruments( &mut self, cmd: &SubscribeInstruments, ) -> Result<(), Error>

Subscribes to instruments list for the specified venue. Read more
§

fn subscribe_instrument( &mut self, cmd: &SubscribeInstrument, ) -> Result<(), Error>

Subscribes to data for a single instrument. Read more
§

fn subscribe_book_deltas( &mut self, cmd: &SubscribeBookDeltas, ) -> Result<(), Error>

Subscribes to order book delta updates for the specified instrument. Read more
§

fn subscribe_book_depth10( &mut self, cmd: &SubscribeBookDepth10, ) -> Result<(), Error>

Subscribes to top 10 order book depth updates for the specified instrument. Read more
§

fn subscribe_book_snapshots( &mut self, cmd: &SubscribeBookSnapshots, ) -> Result<(), Error>

Subscribes to periodic order book snapshots for the specified instrument. Read more
§

fn subscribe_quotes(&mut self, cmd: &SubscribeQuotes) -> Result<(), Error>

Subscribes to quote updates for the specified instrument. Read more
§

fn subscribe_trades(&mut self, cmd: &SubscribeTrades) -> Result<(), Error>

Subscribes to trade updates for the specified instrument. Read more
§

fn subscribe_mark_prices( &mut self, cmd: &SubscribeMarkPrices, ) -> Result<(), Error>

Subscribes to mark price updates for the specified instrument. Read more
§

fn subscribe_index_prices( &mut self, cmd: &SubscribeIndexPrices, ) -> Result<(), Error>

Subscribes to index price updates for the specified instrument. Read more
§

fn subscribe_bars(&mut self, cmd: &SubscribeBars) -> Result<(), Error>

Subscribes to bar updates of the specified bar type. Read more
§

fn subscribe_instrument_status( &mut self, cmd: &SubscribeInstrumentStatus, ) -> Result<(), Error>

Subscribes to status updates for the specified instrument. Read more
§

fn subscribe_instrument_close( &mut self, cmd: &SubscribeInstrumentClose, ) -> Result<(), Error>

Subscribes to instrument close events for the specified instrument. Read more
§

fn unsubscribe(&mut self, cmd: &UnsubscribeCustomData) -> Result<(), Error>

Unsubscribes from custom data types according to the command. Read more
§

fn unsubscribe_instruments( &mut self, cmd: &UnsubscribeInstruments, ) -> Result<(), Error>

Unsubscribes from instruments list for the specified venue. Read more
§

fn unsubscribe_instrument( &mut self, cmd: &UnsubscribeInstrument, ) -> Result<(), Error>

Unsubscribes from data for the specified instrument. Read more
§

fn unsubscribe_book_deltas( &mut self, cmd: &UnsubscribeBookDeltas, ) -> Result<(), Error>

Unsubscribes from order book delta updates for the specified instrument. Read more
§

fn unsubscribe_book_depth10( &mut self, cmd: &UnsubscribeBookDepth10, ) -> Result<(), Error>

Unsubscribes from top 10 order book depth updates for the specified instrument. Read more
§

fn unsubscribe_book_snapshots( &mut self, cmd: &UnsubscribeBookSnapshots, ) -> Result<(), Error>

Unsubscribes from periodic order book snapshots for the specified instrument. Read more
§

fn unsubscribe_quotes(&mut self, cmd: &UnsubscribeQuotes) -> Result<(), Error>

Unsubscribes from quote updates for the specified instrument. Read more
§

fn unsubscribe_trades(&mut self, cmd: &UnsubscribeTrades) -> Result<(), Error>

Unsubscribes from trade updates for the specified instrument. Read more
§

fn unsubscribe_mark_prices( &mut self, cmd: &UnsubscribeMarkPrices, ) -> Result<(), Error>

Unsubscribes from mark price updates for the specified instrument. Read more
§

fn unsubscribe_index_prices( &mut self, cmd: &UnsubscribeIndexPrices, ) -> Result<(), Error>

Unsubscribes from index price updates for the specified instrument. Read more
§

fn unsubscribe_bars(&mut self, cmd: &UnsubscribeBars) -> Result<(), Error>

Unsubscribes from bar updates of the specified bar type. Read more
§

fn unsubscribe_instrument_status( &mut self, cmd: &UnsubscribeInstrumentStatus, ) -> Result<(), Error>

Unsubscribes from instrument status updates for the specified instrument. Read more
§

fn unsubscribe_instrument_close( &mut self, cmd: &UnsubscribeInstrumentClose, ) -> Result<(), Error>

Unsubscribes from instrument close events for the specified instrument. Read more
§

fn request_data(&self, request: &RequestCustomData) -> Result<(), Error>

Sends a custom data request to the provider. Read more
§

fn request_instruments(&self, request: &RequestInstruments) -> Result<(), Error>

Requests a list of instruments from the provider for a given venue. Read more
§

fn request_instrument(&self, request: &RequestInstrument) -> Result<(), Error>

Requests detailed data for a single instrument. Read more
§

fn request_book_snapshot( &self, request: &RequestBookSnapshot, ) -> Result<(), Error>

Requests a snapshot of the order book for a specified instrument. Read more
§

fn request_quotes(&self, request: &RequestQuotes) -> Result<(), Error>

Requests historical or streaming quote data for a specified instrument. Read more
§

fn request_trades(&self, request: &RequestTrades) -> Result<(), Error>

Requests historical or streaming trade data for a specified instrument. Read more
§

fn request_bars(&self, request: &RequestBars) -> Result<(), Error>

Requests historical or streaming bar data for a specified instrument and bar type. Read more
Source§

impl Debug for BlockchainDataClient

Source§

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

Formats the value using the given formatter. Read more

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

Source§

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

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

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

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> ErasedDestructor for T
where T: 'static,

§

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