Struct StorageRoot 

pub struct StorageRoot<T, H> {
    pub trie_cursor_factory: T,
    pub hashed_cursor_factory: H,
    pub hashed_address: B256,
    pub prefix_set: PrefixSet,
    /* private fields */
}

StorageRoot is used to compute the root node of an account storage trie.

Fields

trie_cursor_factory: T

A reference to the database transaction.

hashed_cursor_factory: H

The factory for hashed cursors.

hashed_address: B256

The hashed address of an account.

prefix_set: PrefixSet

The set of storage slot prefixes that have changed.

Implementations

impl<T, H> StorageRoot<T, H>

pub fn new( trie_cursor_factory: T, hashed_cursor_factory: H, address: Address, prefix_set: PrefixSet, metrics: TrieRootMetrics, ) -> Self

Creates a new storage root calculator given a raw address.

pub const fn new_hashed( trie_cursor_factory: T, hashed_cursor_factory: H, hashed_address: B256, prefix_set: PrefixSet, metrics: TrieRootMetrics, ) -> Self

Creates a new storage root calculator given a hashed address.

pub fn with_prefix_set(self, prefix_set: PrefixSet) -> Self

Set the changed prefixes.

pub const fn with_walk_all_changed_branch_children(self, enabled: bool) -> Self

Configures the storage root walker to visit all children of changed branch paths.

When updates are retained, also removes stored descendants hidden by a changed branch’s tree mask. Regenerated branch updates take precedence over these deletions.

pub const fn with_threshold(self, threshold: u64) -> Self

Set the threshold.

pub const fn with_no_threshold(self) -> Self

Set the threshold to maximum value so that intermediate progress is not returned.

pub fn with_intermediate_state( self, state: Option<IntermediateRootState>, ) -> Self

Set the previously recorded intermediate state.

pub fn with_hashed_cursor_factory<HF>( self, hashed_cursor_factory: HF, ) -> StorageRoot<T, HF>

Set the hashed cursor factory.

pub fn with_trie_cursor_factory<TF>( self, trie_cursor_factory: TF, ) -> StorageRoot<TF, H>

Set the trie cursor factory.

impl<T, H> StorageRoot<T, H>

where T: TrieCursorFactory, H: HashedCursorFactory,

pub fn root_with_progress(self) -> Result<StorageRootProgress, StorageRootError>

Walks the intermediate nodes of existing storage trie (if any) and hashed entries. Feeds the nodes into the hash builder. Collects the updates in the process.

Returns

The intermediate progress of state root computation.

pub fn root_with_updates( self, ) -> Result<(B256, usize, StorageTrieUpdates), StorageRootError>

Walks the hashed storage table entries for a given address and calculates the storage root.

Returns

The storage root and storage trie updates for a given address.

pub fn root(self) -> Result<B256, StorageRootError>

Walks the hashed storage table entries for a given address and calculates the storage root.

Returns

The storage root.

pub fn calculate( self, retain_updates: bool, ) -> Result<StorageRootProgress, StorageRootError>

Walks the hashed storage table entries for a given address and calculates the storage root.

Returns

The storage root, number of walked entries and trie updates for a given address if requested.

pub fn calculate_with_cursor( self, hashed_storage_cursor: &mut H::StorageCursor<'_>, retain_updates: bool, ) -> Result<StorageRootProgress, StorageRootError>

Walks the hashed storage table entries for a given address and calculates the storage root using a pre-created cursor. The cursor will be repositioned to the given hashed address.

This method allows reusing a single cursor across multiple storage root calculations, reducing overhead when computing storage roots for many accounts.

Trait Implementations

impl<T: Debug, H: Debug> Debug for StorageRoot<T, H>

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

Formats the value using the given formatter.

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.