Struct StaticFileProvider

pub struct StaticFileProvider<N>(/* private fields */);

StaticFileProvider manages all existing StaticFileJarProvider.

Implementations

impl<N: NodePrimitives> StaticFileProvider<N>

pub fn read_only( path: impl AsRef<Path>, watch_directory: bool, ) -> ProviderResult<Self>

Creates a new StaticFileProvider with read-only access.

Set watch_directory to true to track the most recent changes in static files. Otherwise, new data won’t be detected or queryable.

pub fn read_write(path: impl AsRef<Path>) -> ProviderResult<Self>

Creates a new StaticFileProvider with read-write access.

pub fn watch_directory(&self)

Watches the directory for changes and updates the in-memory index when modifications are detected.

This may be necessary, since a non-node process that owns a StaticFileProvider does not receive update_index notifications from a node that appends/truncates data.

impl<N: NodePrimitives> StaticFileProvider<N>

pub fn with_custom_blocks_per_file(self, blocks_per_file: u64) -> Self

Available on crate feature test-utils only.

Set a custom number of blocks per file.

pub fn with_metrics(self) -> Self

Enables metrics on the StaticFileProvider.

pub fn report_metrics(&self) -> ProviderResult<()>

Reports metrics for the static files.

pub fn get_segment_provider_from_block( &self, segment: StaticFileSegment, block: BlockNumber, path: Option<&Path>, ) -> ProviderResult<StaticFileJarProvider<'_, N>>

Gets the StaticFileJarProvider of the requested segment and block.

pub fn get_segment_provider_from_transaction( &self, segment: StaticFileSegment, tx: TxNumber, path: Option<&Path>, ) -> ProviderResult<StaticFileJarProvider<'_, N>>

Gets the StaticFileJarProvider of the requested segment and transaction.

pub fn get_segment_provider( &self, segment: StaticFileSegment, fn_range: impl Fn() -> Option<SegmentRangeInclusive>, path: Option<&Path>, ) -> ProviderResult<Option<StaticFileJarProvider<'_, N>>>

Gets the StaticFileJarProvider of the requested segment and block or transaction.

fn_range should make sure the range goes through find_fixed_range.

pub fn remove_cached_provider( &self, segment: StaticFileSegment, fixed_block_range_end: BlockNumber, )

Given a segment and block range it removes the cached provider from the map.

CAUTION: cached provider should be dropped before calling this or IT WILL deadlock.

pub fn delete_jar( &self, segment: StaticFileSegment, block: BlockNumber, ) -> ProviderResult<()>

Given a segment and block, it deletes the jar and all files from the respective block range.

CAUTION: destructive. Deletes files on disk.

pub fn update_index( &self, segment: StaticFileSegment, segment_max_block: Option<BlockNumber>, ) -> ProviderResult<()>

Updates the inner transaction and block indexes alongside the internal cached providers in self.map.

Any entry higher than segment_max_block will be deleted from the previous structures.

If segment_max_block is None it means there’s no static file for this segment.

pub fn initialize_index(&self) -> ProviderResult<()>

Initializes the inner transaction and block index

pub fn check_consistency<Provider>( &self, provider: &Provider, has_receipt_pruning: bool, ) -> ProviderResult<Option<PipelineTarget>>

where Provider: DBProvider + BlockReader + StageCheckpointReader + ChainSpecProvider,

Ensures that any broken invariants which cannot be healed on the spot return a pipeline target to unwind to.

Two types of consistency checks are done for:

1. When a static file fails to commit but the underlying data was changed.
2. When a static file was committed, but the required database transaction was not.

For 1) it can self-heal if self.access.is_read_only() is set to false. Otherwise, it will return an error. For 2) the invariants below are checked, and if broken, might require a pipeline unwind to heal.

For each static file segment:

• the corresponding database table should overlap or have continuity in their keys ([TxNumber] or [BlockNumber]).
• its highest block should match the stage checkpoint block number if it’s equal or higher than the corresponding database table last entry.

Returns a Option of PipelineTarget::Unwind if any healing is further required.

WARNING: No static file writer should be held before calling this function, otherwise it will deadlock.

pub fn check_segment_consistency( &self, segment: StaticFileSegment, ) -> ProviderResult<()>

Checks consistency of the latest static file segment and throws an error if at fault. Read-only.

pub fn get_highest_static_file_block( &self, segment: StaticFileSegment, ) -> Option<BlockNumber>

Gets the highest static file block if it exists for a static file segment.

If there is nothing on disk for the given segment, this will return None.

pub fn get_highest_static_file_tx( &self, segment: StaticFileSegment, ) -> Option<TxNumber>

Gets the highest static file transaction.

If there is nothing on disk for the given segment, this will return None.

pub fn get_highest_static_files(&self) -> HighestStaticFiles

Gets the highest static file block for all segments.

pub fn find_static_file<T>( &self, segment: StaticFileSegment, func: impl Fn(StaticFileJarProvider<'_, N>) -> ProviderResult<Option<T>>, ) -> ProviderResult<Option<T>>

Iterates through segment static_files in reverse order, executing a function until it returns some object. Useful for finding objects by [TxHash] or [BlockHash].

pub fn fetch_range_with_predicate<T, F, P>( &self, segment: StaticFileSegment, range: Range<u64>, get_fn: F, predicate: P, ) -> ProviderResult<Vec<T>>

where F: FnMut(&mut StaticFileCursor<'_>, u64) -> ProviderResult<Option<T>>, P: FnMut(&T) -> bool,

Fetches data within a specified range across multiple static files.

This function iteratively retrieves data using get_fn for each item in the given range. It continues fetching until the end of the range is reached or the provided predicate returns false.

pub fn fetch_range_iter<'a, T, F>( &'a self, segment: StaticFileSegment, range: Range<u64>, get_fn: F, ) -> ProviderResult<impl Iterator<Item = ProviderResult<T>> + 'a>

where F: Fn(&mut StaticFileCursor<'_>, u64) -> ProviderResult<Option<T>> + 'a, T: Debug,

Fetches data within a specified range across multiple static files.

Returns an iterator over the data

pub fn directory(&self) -> &Path

Returns directory where static_files are located.

pub fn get_with_static_file_or_database<T, FS, FD>( &self, segment: StaticFileSegment, number: u64, fetch_from_static_file: FS, fetch_from_database: FD, ) -> ProviderResult<Option<T>>

where FS: Fn(&Self) -> ProviderResult<Option<T>>, FD: Fn() -> ProviderResult<Option<T>>,

Retrieves data from the database or static file, wherever it’s available.

Arguments

• segment - The segment of the static file to check against.
• index_key - Requested index key, usually a block or transaction number.
• fetch_from_static_file - A closure that defines how to fetch the data from the static file provider.
• fetch_from_database - A closure that defines how to fetch the data from the database when the static file doesn’t contain the required data or is not available.

pub fn get_range_with_static_file_or_database<T, P, FS, FD>( &self, segment: StaticFileSegment, block_or_tx_range: Range<u64>, fetch_from_static_file: FS, fetch_from_database: FD, predicate: P, ) -> ProviderResult<Vec<T>>

where FS: Fn(&Self, Range<u64>, &mut P) -> ProviderResult<Vec<T>>, FD: FnMut(Range<u64>, P) -> ProviderResult<Vec<T>>, P: FnMut(&T) -> bool,

Gets data within a specified range, potentially spanning different static_files and database.

Arguments

• segment - The segment of the static file to query.
• block_range - The range of data to fetch.
• fetch_from_static_file - A function to fetch data from the static_file.
• fetch_from_database - A function to fetch data from the database.
• predicate - A function used to evaluate each item in the fetched data. Fetching is terminated when this function returns false, thereby filtering the data based on the provided condition.

pub fn path(&self) -> &Path

Available on crate feature test-utils only.

Returns static_files directory

pub fn tx_index( &self, ) -> &RwLock<HashMap<StaticFileSegment, BTreeMap<TxNumber, SegmentRangeInclusive>>>

Available on crate feature test-utils only.

Returns static_files transaction index

Trait Implementations

impl<N: Send + Sync> BlockBodyIndicesProvider for StaticFileProvider<N>

fn block_body_indices( &self, _num: u64, ) -> ProviderResult<Option<StoredBlockBodyIndices>>

Returns the block body indices with matching number from database.

impl<N: NodePrimitives> BlockHashReader for StaticFileProvider<N>

fn block_hash(&self, num: 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: NodePrimitives> BlockNumReader for StaticFileProvider<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 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: FullNodePrimitives<SignedTx: Value, Receipt: Value, BlockHeader: Value>> BlockReader for StaticFileProvider<N>

type Block = <N 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<SealedBlockFor<Self::Block>>>

Returns the pending block if available

fn pending_block_with_senders( &self, ) -> ProviderResult<Option<SealedBlockWithSenders<Self::Block>>>

Returns the pending block if available

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

Returns the pending block and receipts if available.

fn block_with_senders( &self, _id: BlockHashOrNumber, _transaction_kind: TransactionVariant, ) -> ProviderResult<Option<BlockWithSenders<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<SealedBlockWithSenders<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<BlockWithSenders<Self::Block>>>

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

fn sealed_block_with_senders_range( &self, _range: RangeInclusive<BlockNumber>, ) -> ProviderResult<Vec<SealedBlockWithSenders<Self::Block>>>

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

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> Clone for StaticFileProvider<N>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N: Debug> Debug for StaticFileProvider<N>

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

Formats the value using the given formatter.

impl<N: NodePrimitives> Deref for StaticFileProvider<N>

type Target = StaticFileProviderInner<N>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<N: NodePrimitives<BlockHeader: Value>> HeaderProvider for StaticFileProvider<N>

type Header = <N 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 header_td(&self, block_hash: &BlockHash) -> ProviderResult<Option<U256>>

Get total difficulty by block hash.

fn header_td_by_number(&self, num: BlockNumber) -> ProviderResult<Option<U256>>

Get total difficulty 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, num: BlockNumber, ) -> ProviderResult<Option<SealedHeader<Self::Header>>>

Get a single sealed header by block number.

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

fn sealed_headers_range( &self, range: impl RangeBounds<u64>, ) -> Result<Vec<SealedHeader<Self::Header>>, ProviderError>

Get headers in range of block numbers.

impl<N: FullNodePrimitives<BlockHeader: Value>> OmmersProvider for StaticFileProvider<N>

fn ommers( &self, _id: BlockHashOrNumber, ) -> ProviderResult<Option<Vec<Self::Header>>>

Returns the ommers/uncle headers of the given block from the database.

impl<N: NodePrimitives<SignedTx: Value + SignedTransaction, Receipt: Value>> ReceiptProvider for StaticFileProvider<N>

type Receipt = <N as NodePrimitives>::Receipt

The receipt type.

fn receipt(&self, num: 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.

impl<N: NodePrimitives> StaticFileWriter for StaticFileProvider<N>

type Primitives = N

The primitives type used by the static file provider.

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

Returns a mutable reference to a StaticFileProviderRW of a [StaticFileSegment].

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

Returns a mutable reference to a StaticFileProviderRW of the latest [StaticFileSegment].

fn commit(&self) -> ProviderResult<()>

Commits all changes of all StaticFileProviderRW of all [StaticFileSegment].

impl<N: NodePrimitives> StatsReader for StaticFileProvider<N>

fn count_entries<T: Table>(&self) -> ProviderResult<usize>

Fetch the number of entries in the corresponding Table. Depending on the provider, it may route to different data sources other than Table.

impl<N: NodePrimitives<SignedTx: Decompress + SignedTransaction>> TransactionsProvider for StaticFileProvider<N>

type Transaction = <N 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, num: TxNumber, ) -> ProviderResult<Option<Self::Transaction>>

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

fn transaction_by_id_unhashed( &self, num: 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, _hash: TxHash, ) -> ProviderResult<Option<(Self::Transaction, TransactionMeta)>>

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

fn transaction_block( &self, _id: TxNumber, ) -> ProviderResult<Option<BlockNumber>>

Get transaction block number

fn transactions_by_block( &self, _block_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.

impl<N: FullNodePrimitives<SignedTx: Value, Receipt: Value, BlockHeader: Value>> TransactionsProviderExt for StaticFileProvider<N>

fn transaction_hashes_by_range( &self, tx_range: Range<TxNumber>, ) -> ProviderResult<Vec<(TxHash, TxNumber)>>

Get transaction hashes from a transaction range.

fn transaction_range_by_block_range( &self, block_range: RangeInclusive<u64>, ) -> Result<RangeInclusive<u64>, ProviderError>

Get transactions range by block range.

impl<N: NodePrimitives> WithdrawalsProvider for StaticFileProvider<N>

fn withdrawals_by_block( &self, _id: BlockHashOrNumber, _timestamp: u64, ) -> ProviderResult<Option<Withdrawals>>

Get withdrawals by block id.

fn latest_withdrawal(&self) -> ProviderResult<Option<Withdrawal>>

Get latest withdrawal from this block or earlier .

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 8 bytes