Struct Client

pub struct Client { /* private fields */ }

Implementations

impl Client

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

Create a new client with given config

pub async fn create_parquet_folder( &self, query: Query, config: ParquetConfig, ) -> Result<()>

Create a parquet file by executing a query.

Path should point to a folder that will contain the parquet files in the end.

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

Get the height of the source hypersync instance

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

Get the height of the source hypersync instance Internally calls get_height. On an error from the source hypersync instance, sleeps for 1 second (increasing by 1 each failure up to max of 5 seconds) and retries query until success.

pub async fn stream<Format: TransportFormat>( &self, query: Query, config: StreamConfig, ) -> Result<Receiver<Result<QueryResponse>>>

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

Send a query request to the source hypersync instance.

Returns a query response which contains block, tx and log data. Format can be ArrowIpc or Parquet.

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

Send a query request to the source hypersync instance. Internally calls send. On an error from the source hypersync instance, sleeps for 1 second (increasing by 1 each failure up to max of 5 seconds) and retries query until success.

Returns a query response which contains block, tx and log data. Format can be ArrowIpc or Parquet.

pub fn preset_query_blocks_and_transactions( from_block: u64, to_block: Option<u64>, ) -> Query

Returns a query for all Blocks and Transactions within the block range (from_block, to_block] If to_block is None then query runs to the head of the chain. Note: this is only for quickstart purposes. For the best performance, create a custom query that only includes the fields you’ll use in field_selection.

pub fn preset_query_blocks_and_transaction_hashes( from_block: u64, to_block: Option<u64>, ) -> Query

Returns a query object for all Blocks and hashes of the Transactions within the block range (from_block, to_block]. Also returns the block_hash and block_number fields on each Transaction so it can be mapped to a block. If to_block is None then query runs to the head of the chain. Note: this is only for quickstart purposes. For the best performance, create a custom query that only includes the fields you’ll use in field_selection.

pub fn preset_query_logs<A>( from_block: u64, to_block: Option<u64>, address: A, ) -> Result<Query>

where A: TryInto<Address>, <A as TryInto<Address>>::Error: Error + Send + Sync + 'static,

Returns a query object for all Logs within the block range (from_block, to_block] from the given address. If to_block is None then query runs to the head of the chain. Note: this is only for quickstart purposes. For the best performance, create a custom query that only includes the fields you’ll use in field_selection.

pub fn preset_query_logs_of_event<A, T>( from_block: u64, to_block: Option<u64>, topic0: T, address: A, ) -> Result<Query>

where A: TryInto<Address>, <A as TryInto<Address>>::Error: Error + Send + Sync + 'static, T: TryInto<LogArgument>, <T as TryInto<LogArgument>>::Error: Error + Send + Sync + 'static,

Returns a query for all Logs within the block range (from_block, to_block] from the given address with a matching topic0 event signature. Topic0 is the keccak256 hash of the event signature. If to_block is None then query runs to the head of the chain. Note: this is only for quickstart purposes. For the best performance, create a custom query that only includes the fields you’ll use in field_selection.

pub fn preset_query_transactions( from_block: u64, to_block: Option<u64>, ) -> Query

Returns a query object for all transactions within the block range (from_block, to_block]. If to_block is None then query runs to the head of the chain. Note: this is only for quickstart purposes. For the best performance, create a custom query that only includes the fields you’ll use in field_selection.

pub fn preset_query_transactions_from_address<A>( from_block: u64, to_block: Option<u64>, address: A, ) -> Result<Query>

where A: TryInto<Address>, <A as TryInto<Address>>::Error: Error + Send + Sync + 'static,

Returns a query object for all transactions from an address within the block range (from_block, to_block]. If to_block is None then query runs to the head of the chain. Note: this is only for quickstart purposes. For the best performance, create a custom query that only includes the fields you’ll use in field_selection.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.