Struct HyperSyncClient 

pub struct HyperSyncClient { /* private fields */ }

A client for interacting with a HyperSync API to retrieve blockchain data.

Implementations

impl HyperSyncClient

pub fn new( chain: SharedChain, tx: Option<UnboundedSender<BlockchainMessage>>, cancellation_token: CancellationToken, ) -> Self

Creates a new HyperSyncClient instance for the given chain and message sender.

Panics

Panics if:

• The chain’s hypersync_url is invalid.
• The ENVIO_API_TOKEN environment variable is not set or invalid.
• The underlying client cannot be initialized.

pub fn get_pool_address(&self, instrument_id: InstrumentId) -> Option<&Address>

pub async fn update_dex_event_stream( &mut self, dex: DexType, contract_addresses: Vec<Address>, event_signatures: Vec<String>, )

Starts, refreshes, or stops the live DEX event stream for one DEX.

The stream query is open-ended (to_block = None) and the background task resumes from the last HyperSync next_block whenever the SDK stream reaches the current indexed tip.

pub async fn request_contract_events_stream( &self, from_block: u64, to_block: Option<u64>, contract_address: &Address, topics: Vec<&str>, ) -> impl Stream<Item = PoolEventStreamItem> + use<>

Creates a stream of contract event logs matching the specified criteria.

Panics

Panics if the contract address cannot be parsed as a valid Ethereum address.

pub async fn disconnect(&mut self)

Disconnects from the HyperSync service and stops all background tasks.

pub async fn current_block(&self) -> u64

Returns the current block

Panics

Panics if the client height request fails.

pub async fn request_blocks_stream( &self, from_block: u64, to_block: Option<u64>, ) -> impl Stream<Item = Block>

Creates a stream that yields blockchain blocks within the specified range.

Panics

Panics if the stream creation or block transformation fails.

pub fn subscribe_blocks(&mut self)

Starts a background task that continuously polls for new blockchain blocks.

Panics

Panics if client height requests or block transformations fail.

pub async fn unsubscribe_blocks(&mut self)

Unsubscribes from new blocks by stopping the background watch task.

Trait Implementations

impl Debug for HyperSyncClient

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

Formats the value using the given formatter.

impl Drop for HyperSyncClient

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.