Struct Indexer 

pub struct Indexer<T, U, Db>
where
    T: HoprIndexerRpcOperations + Send + 'static,
    U: ChainLogHandler + Send + 'static,
    Db: HoprDbGeneralModelOperations + HoprDbInfoOperations + HoprDbLogOperations + Clone + Send + Sync + 'static,
{ /* private fields */ }

Indexer

Accepts the RPC operational functionality hopr_chain_rpc::HoprIndexerRpcOperations and provides the indexing operation resulting in and output of hopr_chain_types::chain_events::SignificantChainEvent streamed outside the indexer by the unbounded channel.

The roles of the indexer:

1. prime the RPC endpoint
2. request an RPC stream of changes to process
3. process block and log stream
4. ensure finalization by postponing processing until the head is far enough
5. store relevant data into the DB
6. pass the processing on to the business logic

Implementations

impl<T, U, Db> Indexer<T, U, Db>

where T: HoprIndexerRpcOperations + Sync + Send + 'static, U: ChainLogHandler + Send + Sync + 'static, Db: HoprDbGeneralModelOperations + HoprDbInfoOperations + HoprDbLogOperations + Clone + Send + Sync + 'static,

pub fn new( rpc: T, db_processor: U, db: Db, cfg: IndexerConfig, egress: Sender<SignificantChainEvent>, ) -> Self

pub fn without_panic_on_completion(self) -> Self

Disables the panic on completion.

pub async fn start(self) -> Result<AbortHandle>

where T: HoprIndexerRpcOperations + 'static, U: ChainLogHandler + 'static, Db: HoprDbGeneralModelOperations + HoprDbInfoOperations + HoprDbLogOperations + Clone + Send + Sync + 'static,

pub async fn pre_start(&self) -> Result<()>

pub async fn download_snapshot(&self) -> Result<SnapshotInfo>

Downloads and installs a database snapshot for faster initial synchronization.

This method coordinates the snapshot download process by:

1. Validating the indexer configuration
2. Creating a snapshot manager instance
3. Downloading and extracting the snapshot to the data directory

Snapshots allow new nodes to quickly synchronize with the network by downloading pre-built database files instead of fetching all historical logs from scratch.

Returns

• Ok(SnapshotInfo) containing details about the downloaded snapshot
• Err(CoreEthereumIndexerError::SnapshotError) if validation or download fails

Prerequisites

• Configuration must be valid (proper URL format, data directory set)
• Sufficient disk space must be available
• Network connectivity to the snapshot URL

Trait Implementations

impl<T, U, Db> Clone for Indexer<T, U, Db>

where T: HoprIndexerRpcOperations + Send + 'static + Clone, U: ChainLogHandler + Send + 'static + Clone, Db: HoprDbGeneralModelOperations + HoprDbInfoOperations + HoprDbLogOperations + Clone + Send + Sync + 'static + Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T, U, Db> Debug for Indexer<T, U, Db>

where T: HoprIndexerRpcOperations + Send + 'static + Debug, U: ChainLogHandler + Send + 'static + Debug, Db: HoprDbGeneralModelOperations + HoprDbInfoOperations + HoprDbLogOperations + Clone + Send + Sync + 'static + Debug,

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

Formats the value using the given formatter.