Struct ProviderFactory 

pub struct ProviderFactory<N: NodeTypesWithDB> { /* private fields */ }

A common provider that fetches data from a database or static file.

This provider implements most provider or provider factory traits.

Implementations

impl<N: NodeTypesForProvider> ProviderFactory<NodeTypesWithDBAdapter<N, Arc<DatabaseEnv>>>

pub fn builder() -> ProviderFactoryBuilder<N>

Instantiates the builder for this type

impl<N: ProviderNodeTypes> ProviderFactory<N>

pub fn new( db: N::DB, chain_spec: Arc<N::ChainSpec>, static_file_provider: StaticFileProvider<N::Primitives>, ) -> ProviderResult<Self>

Create new database provider factory.

impl<N: NodeTypesWithDB> ProviderFactory<N>

pub fn with_prune_modes(self, prune_modes: PruneModes) -> Self

Sets the pruning configuration for an existing ProviderFactory.

pub const fn db_ref(&self) -> &N::DB

Returns reference to the underlying database.

pub fn into_db(self) -> N::DB

Available on crate features test-utils only.

Consumes Self and returns DB

impl<N: ProviderNodeTypes<DB = Arc<DatabaseEnv>>> ProviderFactory<N>

pub fn new_with_database_path<P: AsRef<Path>>( path: P, chain_spec: Arc<N::ChainSpec>, args: DatabaseArguments, static_file_provider: StaticFileProvider<N::Primitives>, ) -> RethResult<Self>

Create new database provider by passing a path. ProviderFactory will own the database instance.

impl<N: ProviderNodeTypes> ProviderFactory<N>

pub fn provider(&self) -> ProviderResult<DatabaseProviderRO<N::DB, N>>

Returns a provider with a created DbTx inside, which allows fetching data from the database using different types of providers. Example: HeaderProvider BlockHashReader. This may fail if the inner read database transaction fails to open.

This sets the PruneModes to None, because they should only be relevant for writing data.

pub fn provider_rw(&self) -> ProviderResult<DatabaseProviderRW<N::DB, N>>

Returns a provider with a created DbTxMut inside, which allows fetching and updating data from the database using different types of providers. Example: HeaderProvider BlockHashReader. This may fail if the inner read/write database transaction fails to open.

pub fn latest(&self) -> ProviderResult<StateProviderBox>

State provider for latest block

pub fn history_by_block_number( &self, block_number: BlockNumber, ) -> ProviderResult<StateProviderBox>

Storage provider for state at that given block

pub fn history_by_block_hash( &self, block_hash: BlockHash, ) -> ProviderResult<StateProviderBox>

Storage provider for state at that given block hash

Trait Implementations

impl<N: ProviderNodeTypes> BlockBodyIndicesProvider for ProviderFactory<N>

fn block_body_indices( &self, number: BlockNumber, ) -> ProviderResult<Option<StoredBlockBodyIndices>>

Returns the block body indices with matching number from database.

fn block_body_indices_range( &self, range: RangeInclusive<BlockNumber>, ) -> ProviderResult<Vec<StoredBlockBodyIndices>>

Returns the block body indices within the requested range matching number from storage.

impl<N: ProviderNodeTypes> BlockHashReader for ProviderFactory<N>

fn block_hash(&self, number: u64) -> ProviderResult<Option<B256>>

Get the hash of the block with the given number. Returns None if no block with this number exists.

fn canonical_hashes_range( &self, start: BlockNumber, end: BlockNumber, ) -> ProviderResult<Vec<B256>>

Get headers in range of block hashes or numbers

fn convert_block_hash( &self, hash_or_number: HashOrNumber, ) -> Result<Option<FixedBytes<32>>, ProviderError>

Get the hash of the block with the given number. Returns None if no block with this number exists.

impl<N: ProviderNodeTypes> BlockNumReader for ProviderFactory<N>

fn chain_info(&self) -> ProviderResult<ChainInfo>

Returns the current info for the chain.

fn best_block_number(&self) -> ProviderResult<BlockNumber>

Returns the best block number in the chain.

fn last_block_number(&self) -> ProviderResult<BlockNumber>

Returns the last block number associated with the last canonical header in the database.

fn earliest_block_number(&self) -> ProviderResult<BlockNumber>

Returns earliest block number to keep track of the expired block range.

fn block_number(&self, hash: B256) -> ProviderResult<Option<BlockNumber>>

Gets the BlockNumber for the given hash. Returns None if no block with this hash exists.

fn convert_hash_or_number( &self, id: HashOrNumber, ) -> Result<Option<u64>, ProviderError>

Gets the block number for the given BlockHashOrNumber. Returns None if no block with this hash exists. If the BlockHashOrNumber is a Number, it is returned as is.

fn convert_number( &self, id: HashOrNumber, ) -> Result<Option<FixedBytes<32>>, ProviderError>

Gets the block hash for the given BlockHashOrNumber. Returns None if no block with this number exists. If the BlockHashOrNumber is a Hash, it is returned as is.

impl<N: ProviderNodeTypes> BlockReader for ProviderFactory<N>

type Block = <<N as NodeTypes>::Primitives as NodePrimitives>::Block

The block type this provider reads.

fn find_block_by_hash( &self, hash: B256, source: BlockSource, ) -> ProviderResult<Option<Self::Block>>

Tries to find in the given block source.

fn block(&self, id: BlockHashOrNumber) -> ProviderResult<Option<Self::Block>>

Returns the block with given id from the database.

fn pending_block(&self) -> ProviderResult<Option<RecoveredBlock<Self::Block>>>

Returns the pending block if available

fn pending_block_and_receipts( &self, ) -> ProviderResult<Option<(RecoveredBlock<Self::Block>, Vec<Self::Receipt>)>>

Returns the pending block and receipts if available.

fn recovered_block( &self, id: BlockHashOrNumber, transaction_kind: TransactionVariant, ) -> ProviderResult<Option<RecoveredBlock<Self::Block>>>

Returns the block with senders with matching number or hash from database.

fn sealed_block_with_senders( &self, id: BlockHashOrNumber, transaction_kind: TransactionVariant, ) -> ProviderResult<Option<RecoveredBlock<Self::Block>>>

Returns the sealed block with senders with matching number or hash from database.

fn block_range( &self, range: RangeInclusive<BlockNumber>, ) -> ProviderResult<Vec<Self::Block>>

Returns all blocks in the given inclusive range.

fn block_with_senders_range( &self, range: RangeInclusive<BlockNumber>, ) -> ProviderResult<Vec<RecoveredBlock<Self::Block>>>

Returns a range of blocks from the database, along with the senders of each transaction in the blocks.

fn recovered_block_range( &self, range: RangeInclusive<BlockNumber>, ) -> ProviderResult<Vec<RecoveredBlock<Self::Block>>>

Returns a range of sealed blocks from the database, along with the senders of each transaction in the blocks.

fn block_by_transaction_id( &self, id: TxNumber, ) -> ProviderResult<Option<BlockNumber>>

Returns the block number that contains the given transaction.

fn block_by_hash( &self, hash: FixedBytes<32>, ) -> Result<Option<Self::Block>, ProviderError>

Returns the block with matching hash from the database.

fn block_by_number( &self, num: u64, ) -> Result<Option<Self::Block>, ProviderError>

Returns the block with matching number from database.

impl<N: NodeTypesWithDB> ChainSpecProvider for ProviderFactory<N>

type ChainSpec = <N as NodeTypes>::ChainSpec

The chain spec type.

fn chain_spec(&self) -> Arc<N::ChainSpec>

Get an Arc to the chainspec.

impl<N: NodeTypesWithDB> Clone for ProviderFactory<N>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<N: ProviderNodeTypes> DatabaseProviderFactory for ProviderFactory<N>

type DB = <N as NodeTypesWithDB>::DB

Database this factory produces providers for.

type Provider = DatabaseProvider<<<N as NodeTypesWithDB>::DB as Database>::TX, N>

Provider type returned by the factory.

type ProviderRW = DatabaseProvider<<<N as NodeTypesWithDB>::DB as Database>::TXMut, N>

Read-write provider type returned by the factory.

fn database_provider_ro(&self) -> ProviderResult<Self::Provider>

Create new read-only database provider.

fn database_provider_rw(&self) -> ProviderResult<Self::ProviderRW>

Create new read-write database provider.

impl<N> Debug for ProviderFactory<N>

where N: NodeTypesWithDB<DB: Debug, ChainSpec: Debug, Storage: Debug>,

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

Formats the value using the given formatter.

impl<N: ProviderNodeTypes> HashedPostStateProvider for ProviderFactory<N>

fn hashed_post_state(&self, bundle_state: &BundleState) -> HashedPostState

Returns the HashedPostState of the provided [BundleState].

impl<N: ProviderNodeTypes> HeaderProvider for ProviderFactory<N>

type Header = <<N as NodeTypes>::Primitives as NodePrimitives>::BlockHeader

The header type this provider supports.

fn header(&self, block_hash: BlockHash) -> ProviderResult<Option<Self::Header>>

Get header by block hash

fn header_by_number( &self, num: BlockNumber, ) -> ProviderResult<Option<Self::Header>>

Get header by block number

fn headers_range( &self, range: impl RangeBounds<BlockNumber>, ) -> ProviderResult<Vec<Self::Header>>

Get headers in range of block numbers

fn sealed_header( &self, number: BlockNumber, ) -> ProviderResult<Option<SealedHeader<Self::Header>>>

Get a single sealed header by block number.

fn sealed_headers_range( &self, range: impl RangeBounds<BlockNumber>, ) -> ProviderResult<Vec<SealedHeader<Self::Header>>>

Get headers in range of block numbers.

fn sealed_headers_while( &self, range: impl RangeBounds<BlockNumber>, predicate: impl FnMut(&SealedHeader<Self::Header>) -> bool, ) -> ProviderResult<Vec<SealedHeader<Self::Header>>>

Get sealed headers while predicate returns true or the range is exhausted.

fn is_known(&self, block_hash: FixedBytes<32>) -> Result<bool, ProviderError>

Check if block is known

fn sealed_header_by_hash( &self, block_hash: FixedBytes<32>, ) -> Result<Option<SealedHeader<Self::Header>>, ProviderError>

Retrieves the header sealed by the given block hash.

fn header_by_hash_or_number( &self, hash_or_num: HashOrNumber, ) -> Result<Option<Self::Header>, ProviderError>

Get header by block number or hash

impl<N: ProviderNodeTypes> HeaderSyncGapProvider for ProviderFactory<N>

type Header = <<N as NodeTypes>::Primitives as NodePrimitives>::BlockHeader

The header type.

fn local_tip_header( &self, highest_uninterrupted_block: BlockNumber, ) -> ProviderResult<SealedHeader<Self::Header>>

Returns the local tip header for the given highest uninterrupted block.

impl<N: ProviderNodeTypes> MetadataProvider for ProviderFactory<N>

fn get_metadata(&self, key: &str) -> ProviderResult<Option<Vec<u8>>>

Get a metadata value by key

fn storage_settings(&self) -> Result<Option<StorageSettings>, ProviderError>

Get storage settings for this node

impl<N: NodeTypesWithDB> NodePrimitivesProvider for ProviderFactory<N>

type Primitives = <N as NodeTypes>::Primitives

The node primitive types.

impl<N: ProviderNodeTypes> PruneCheckpointReader for ProviderFactory<N>

fn get_prune_checkpoint( &self, segment: PruneSegment, ) -> ProviderResult<Option<PruneCheckpoint>>

Fetch the prune checkpoint for the given segment.

fn get_prune_checkpoints( &self, ) -> ProviderResult<Vec<(PruneSegment, PruneCheckpoint)>>

Fetch all the prune checkpoints.

impl<N: ProviderNodeTypes> ReceiptProvider for ProviderFactory<N>

type Receipt = <<N as NodeTypes>::Primitives as NodePrimitives>::Receipt

The receipt type.

fn receipt(&self, id: TxNumber) -> ProviderResult<Option<Self::Receipt>>

Get receipt by transaction number

fn receipt_by_hash(&self, hash: TxHash) -> ProviderResult<Option<Self::Receipt>>

Get receipt by transaction hash.

fn receipts_by_block( &self, block: BlockHashOrNumber, ) -> ProviderResult<Option<Vec<Self::Receipt>>>

Get receipts by block num or hash.

fn receipts_by_tx_range( &self, range: impl RangeBounds<TxNumber>, ) -> ProviderResult<Vec<Self::Receipt>>

Get receipts by tx range.

fn receipts_by_block_range( &self, block_range: RangeInclusive<BlockNumber>, ) -> ProviderResult<Vec<Vec<Self::Receipt>>>

Get receipts by block range.

impl<N: ProviderNodeTypes> StageCheckpointReader for ProviderFactory<N>

fn get_stage_checkpoint( &self, id: StageId, ) -> ProviderResult<Option<StageCheckpoint>>

Fetch the checkpoint for the given stage.

fn get_stage_checkpoint_progress( &self, id: StageId, ) -> ProviderResult<Option<Vec<u8>>>

Get stage checkpoint progress.

fn get_all_checkpoints(&self) -> ProviderResult<Vec<(String, StageCheckpoint)>>

Reads all stage checkpoints and returns a list with the name of the stage and the checkpoint data.

impl<N: NodeTypesWithDB> StaticFileProviderFactory for ProviderFactory<N>

fn static_file_provider(&self) -> StaticFileProvider<Self::Primitives>

Returns static file provider

fn get_static_file_writer( &self, block: BlockNumber, segment: StaticFileSegment, ) -> ProviderResult<StaticFileProviderRWRefMut<'_, Self::Primitives>>

Returns a mutable reference to a StaticFileProviderRW of a StaticFileSegment.

impl<N: NodeTypesWithDB> StorageSettingsCache for ProviderFactory<N>

fn cached_storage_settings(&self) -> StorageSettings

Gets the cached storage settings.

fn set_storage_settings_cache(&self, settings: StorageSettings)

Sets the storage settings of this ProviderFactory.

impl<N: ProviderNodeTypes> TransactionsProvider for ProviderFactory<N>

type Transaction = <<N as NodeTypes>::Primitives as NodePrimitives>::SignedTx

The transaction type this provider reads.

fn transaction_id(&self, tx_hash: TxHash) -> ProviderResult<Option<TxNumber>>

Get internal transaction identifier by transaction hash.

fn transaction_by_id( &self, id: TxNumber, ) -> ProviderResult<Option<Self::Transaction>>

Get transaction by id, computes hash every time so more expensive.

fn transaction_by_id_unhashed( &self, id: TxNumber, ) -> ProviderResult<Option<Self::Transaction>>

Get transaction by id without computing the hash.

fn transaction_by_hash( &self, hash: TxHash, ) -> ProviderResult<Option<Self::Transaction>>

Get transaction by transaction hash.

fn transaction_by_hash_with_meta( &self, tx_hash: TxHash, ) -> ProviderResult<Option<(Self::Transaction, TransactionMeta)>>

Get transaction by transaction hash and additional metadata of the block the transaction was mined in

fn transactions_by_block( &self, id: BlockHashOrNumber, ) -> ProviderResult<Option<Vec<Self::Transaction>>>

Get transactions by block id.

fn transactions_by_block_range( &self, range: impl RangeBounds<BlockNumber>, ) -> ProviderResult<Vec<Vec<Self::Transaction>>>

Get transactions by block range.

fn transactions_by_tx_range( &self, range: impl RangeBounds<TxNumber>, ) -> ProviderResult<Vec<Self::Transaction>>

Get transactions by tx range.

fn senders_by_tx_range( &self, range: impl RangeBounds<TxNumber>, ) -> ProviderResult<Vec<Address>>

Get Senders from a tx range.

fn transaction_sender(&self, id: TxNumber) -> ProviderResult<Option<Address>>

Get transaction sender.

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.