Struct hypersync_client::Client

pub struct Client { /* private fields */ }

Internal client to handle http requests and retries.

Implementations

impl Client

pub fn new(cfg: ClientConfig) -> Result<Self>

Creates a new client with the given configuration.

pub async fn collect( self: Arc<Self>, query: Query, config: StreamConfig, ) -> Result<QueryResponse>

Retrieves blocks, transactions, traces, and logs through a stream using the provided query and stream configuration.

Implementation

Runs multiple queries simultaneously based on config.concurrency.

Each query runs until it reaches query.to, server height, any max_num_* query param, or execution timed out by server.

pub async fn collect_events( self: Arc<Self>, query: Query, config: StreamConfig, ) -> Result<QueryResponse<Vec<Vec<Event>>>>

Retrieves events through a stream using the provided query and stream configuration.

pub async fn collect_arrow( self: Arc<Self>, query: Query, config: StreamConfig, ) -> Result<ArrowResponse>

Retrieves blocks, transactions, traces, and logs in Arrow format through a stream using the provided query and stream configuration.

pub async fn collect_parquet( self: Arc<Self>, path: &str, query: Query, config: StreamConfig, ) -> Result<()>

Writes parquet file getting data through a stream using the provided path, query, and stream configuration.

pub async fn get_height(&self) -> Result<u64>

Get the height of the Client instance with retries.

pub async fn health(&self) -> Result<u64>

Get the height of the Client instance for health checks.

pub async fn get(&self, query: &Query) -> Result<QueryResponse>

Executes query with retries and returns the response.

pub async fn get_events( &self, query: Query, ) -> Result<QueryResponse<Vec<Vec<Event>>>>

Add block, transaction and log fields selection to the query, executes it with retries and returns the response.

pub async fn get_arrow(&self, query: &Query) -> Result<ArrowResponse>

Executes query with retries and returns the response in Arrow format.

pub async fn stream( self: Arc<Self>, query: Query, config: StreamConfig, ) -> Result<Receiver<Result<QueryResponse>>>

Spawns task to execute query and return data via a channel.

pub async fn stream_events( self: Arc<Self>, query: Query, config: StreamConfig, ) -> Result<Receiver<Result<QueryResponse<Vec<Vec<Event>>>>>>

Add block, transaction and log fields selection to the query and spawns task to execute it, returning data via a channel.

pub async fn stream_arrow( self: Arc<Self>, query: Query, config: StreamConfig, ) -> Result<Receiver<Result<ArrowResponse>>>

Spawns task to execute query and return data via a channel in Arrow format.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.