Struct eventify_idx::app::App

pub struct App<T, U>
where
    T: JsonRpcClient + Clone + Send + Sync,
    U: Storage + Auth + Clone + Send + Sync,
{
    pub src_block: BlockNumber,
    pub dst_block: BlockNumber,
    /* private fields */
}

The App struct represents an application with a JSON-RPC client (T) and storage (U). It manages the interaction between the blockchain and storage, keeping track of the source and destination block numbers for operations.

Type Parameters

• T: A JSON-RPC client that implements JsonRpcClient, Clone, Send, and Sync.
• U: A storage system that implements Storage, Auth, Clone, Send, and Sync.

Fields

src_block: BlockNumber

The starting block number from which the App operates.

dst_block: BlockNumber

The ending block number up to which the App operates.

Implementations

impl<T, U> App<T, U>

where T: JsonRpcClient + Clone + Send + Sync, U: Storage + Auth + Clone + Send + Sync,

pub fn new( transport_node: Option<NodeProvider<T>>, transport_storage: Option<U>, src_block: BlockNumber, dst_block: BlockNumber ) -> Self

Create a new instance of the indexer

pub fn with_src_block(self, src_block: BlockNumber) -> Self

pub fn with_dst_block(self, dst_block: BlockNumber) -> Self

pub fn with_node_conn(self, transport: NodeProvider<T>) -> Self

pub fn with_storage(self, url: &str) -> Self

pub fn src_block(&self) -> u64

pub fn dst_block(&self) -> u64

pub fn storage_conn(&self) -> Result<&U, Error>

pub async fn fetch_block_with_txs( &self, block: BlockId ) -> Result<Block<Transaction>, Error>

Retrieves block details along with full transaction objects for a given block ID.

Arguments

• block - The block ID for which to fetch details.

Returns

Returns a Result containing the block details on success, or an error if the block cannot be fetched or if the transport node is unavailable.

pub async fn fetch_block(&self, block: BlockId) -> Result<Block<TxHash>, Error>

Retrieves block details for a given block ID.

This function does not return transaction objects.

pub async fn fetch_logs( &self, criterias: &Criterias, block: BlockNumber ) -> Result<Vec<Log>, Error>

Fetches logs based on the specified filter.

Arguments

• criteria - The filter criteria used to fetch the logs.

Returns

Returns a Result containing a vector of logs on success, or an error if the logs cannot be fetched or if the transport node is unavailable.

pub async fn fetch_transactions( &self, block: BlockNumber ) -> Result<Vec<Transaction>, Error>

Fetches transactions for a specified block number.

pub async fn fetch_indexed_data( &self, block: BlockNumber ) -> Result<(IndexedBlock, Vec<IndexedTransaction>), Error>

Fetches indexed block and transaction objects for a specified block number.

Arguments

• block - The block number for which to fetch the data.

Returns

Returns a Result containing the indexed block and its transactions on success, or an error if the block cannot be fetched.

pub async fn get_latest_block(&self) -> Result<u64, Error>

Returns the latest finalized block number.

This function queries the underlying transport node for the current block number. If the transport node is not set, or if there is an error in fetching the block number, the function will return an appropriate error.

pub async fn is_latest_block(&self, block: u64) -> Result<bool, Error>

Checks whether the provided block number is the latest finalized block

impl<U: Storage + Auth + Clone + Send + Sync> App<Http, U>

pub fn with_http(self, node_url: &str) -> Result<Self, Error>

Configures the application to use an HTTP transport node.

Example

use ethers_providers::Http;
use eventify_idx::App;
use eventify_primitives::storage::Postgres;
let app: App<Http, Postgres> = App::default().with_http("http://localhost:8545")?;
// Use `app` for further operations...

Arguments

• node_url - The URL of the HTTP node.

Errors

Returns an error if the URL parsing fails or the HTTP transport cannot be created.

impl<U: Storage + Auth + Clone + Send + Sync> App<Ipc, U>

pub async fn with_ipc(self, node_url: &str) -> Result<Self, Error>

Creates a new instance of the App with the IPC transport.

Example

use ethers_providers::Ipc;
use eventify_idx::App;
use eventify_primitives::storage::Postgres;
let app: App<Ipc, Postgres> = App::default().with_ipc("ipc://path/to/socket").await?;
// use app...

Arguments

• node_url - The URL for the IPC node.

Errors

Returns an error if the IPC transport creation fails.

pub async fn subscribe_blocks( &self ) -> Result<SubscriptionStream<'_, Ipc, Block<TxHash>>, Error>

pub async fn subscribe_logs( &self, filter: Filter ) -> Result<SubscriptionStream<'_, Ipc, Log>, Error>

impl<U: Storage + Auth + Clone + Send + Sync> App<Ws, U>

pub async fn with_websocket(self, node_url: &str) -> Result<Self, Error>

Creates a new instance of the App with the WebSocket transport.

Example

use ethers_providers::Ws;
use eventify_idx::App;
use eventify_primitives::storage::Postgres;
let app: App<Ws, Postgres> = App::default().with_websocket("ws://localhost:8546").await?;
// Use `app` for further operations...

Arguments

• node_url - The URL for the WebSocket node.

Errors

Returns an error if the WebSocket transport creation fails.

pub async fn with_ws(self, node_url: &str) -> Result<Self, Error>

Creates a new instance of the App with the WebSocket transport

An alias for [with_websocket]

pub async fn subscribe_blocks( &self ) -> Result<SubscriptionStream<'_, Ws, Block<TxHash>>, Error>

pub async fn subscribe_logs( &self, filter: Filter ) -> Result<SubscriptionStream<'_, Ws, Log>, Error>

Trait Implementations

impl<T, U> Clone for App<T, U>

where T: JsonRpcClient + Clone + Send + Sync + Clone, U: Storage + Auth + Clone + Send + Sync + Clone,

fn clone(&self) -> App<T, U>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, U> Debug for App<T, U>

where T: JsonRpcClient + Clone + Send + Sync + Debug, U: Storage + Auth + Clone + Send + Sync + Debug,

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

Formats the value using the given formatter.

impl<T, U> Default for App<T, U>

where T: JsonRpcClient + Clone + Send + Sync, U: Storage + Auth + Clone + Send + Sync,

fn default() -> Self

Creates a new App instance with default values.

The src_block is set to 0, indicating the start of the blockchain, and dst_block is set to BlockNumber::MAX, representing the end of the blockchain.