Skip to main content

Module trie

Module trie 

Source
Available on crate feature trie only.
Expand description

Re-exported reth trie types

Modules§

arrayrayon
Parallel iterator types for arrays ([T; N])
changesets
Trie changeset computation. Trie changeset computation.
collectionsrayon
Parallel iterator types for standard collections
forward_cursor
The implementation of forward-only in-memory cursor.
hash_builder
The implementation of hash builder. MPT hash builder implementation.
hashed_cursor
The cursor implementations for navigating hashed state.
iterrayon
Traits for writing parallel programs using an iterator-style interface
metricsmetrics
Trie calculation metrics.
mocktest-utils
Collection of mock types for testing.
node_iter
The iterators for traversing existing intermediate hashes and updated trie leaves.
optionrayon
Parallel iterator types for options
ordered_root
Incremental ordered trie root computation. Incremental ordered trie root computation for append-only streams.
prefix_set
The implementation of a container for storing intermediate changes to a trie. The container indicates when the trie has been modified.
preluderayon
The rayon prelude imports the various ParallelIterator traits. The intention is that one can include use rayon::prelude::* and have easy access to the various traits and methods you will need.
proof
Merkle proof generation.
proof_v2
Merkle proof generation v2 (leaf-only implementation). Proof calculation version 2: Leaf-only implementation.
rangerayon
Parallel iterator types for ranges, the type for values created by a..b expressions
range_inclusiverayon
Parallel iterator types for inclusive ranges, the type for values created by a..=b expressions
range_proof
Merkle Patricia trie range-proof verification. Merkle Patricia trie range-proof verification.
resultrayon
Parallel iterator types for results
root
Common root computation functions.
serde_bincode_compatserde-bincode-compat and serde
Bincode-compatible serde implementations for trie types.
slicerayon
Parallel iterator types for slices
stats
Trie calculation stats.
strrayon
Parallel iterator types for strings
stringrayon
This module contains the parallel iterator types for owned strings (String). You will rarely need to interact with it directly unless you have need to name one of the iterator types.
target_v2
V2 proof targets and chunking. V2 proof targets and chunking.
test_utilstest-utils
Collection of trie-related test utilities.
trie_cursor
The cursor implementations for navigating account and storage tries.
triehashtest-utils
Implementation of hasher using our keccak256 hashing function for compatibility with triehash crate.
updates
Buffer for trie updates.
vecrayon
Parallel iterator types for vectors (Vec<T>)
verify
Verification of existing stored trie nodes against state data.
walker
The trie walker for iterating over the trie nodes.
witness
Trie witness generation.

Macros§

with_adaptertrie-db
Dispatches a trie operation using the correct TrieKeyAdapter based on storage settings.

Structs§

AccountProof
The merkle proof with the relevant account info.
BlockTrieData
Trie data for a block, with hashed-state sorting allowed to finish in the background.
BranchNode
Re-export A branch node in an Ethereum Merkle Patricia Trie.
BranchNodeCompact
Re-export A struct representing a branch node in an Ethereum trie.
BranchNodeMasks
Branch node masks containing hash_mask and tree_mask.
BranchNodeRef
Re-export A reference to BranchNode and its state mask. NOTE: The stack may contain more items that specified in the state mask.
BranchNodeV2
A branch node in an Ethereum Merkle Patricia Trie.
BroadcastContextrayon
Provides context to a closure called by broadcast.
ChunkedHashedPostState
An iterator that yields chunks of the state updates of at most size account and storage targets.
ChunkedMultiProofTargets
An iterator that yields chunks of the proof targets of at most size account and storage targets.
ChunkedMultiProofTargetsV2
An iterator that yields chunks of V2 proof targets of at most size account and storage targets.
DatabaseAccountTrieCursortrie-db
A cursor over the account trie.
DatabaseHashedAccountCursortrie-db
A struct wrapping database cursor over hashed accounts implementing HashedCursor for iterating over accounts.
DatabaseHashedCursorFactorytrie-db
A struct wrapping database transaction that implements HashedCursorFactory.
DatabaseHashedStorageCursortrie-db
The structure wrapping a database cursor for hashed storage and a target hashed address. Implements HashedCursor and HashedStorageCursor for iterating over hashed storage.
DatabaseStorageTrieCursortrie-db
A cursor over the storage tries stored in the database.
DatabaseTrieCursorFactorytrie-db
Wrapper struct for database transaction implementing trie cursor factory trait.
DecodedAccountProof
The merkle proof with the relevant account info.
DecodedMultiProof
This is a type of MultiProof that uses decoded proofs, meaning these proofs are stored as a collection of TrieNodes instead of RLP-encoded bytes.
DecodedMultiProofV2
V2 decoded multiproof which contains the results of both account and storage V2 proof calculations.
DecodedStorageMultiProof
The decoded merkle multiproof for a storage trie.
DecodedStorageProof
The merkle proof of the storage entry, using decoded proofs.
ExtensionNode
Re-export An extension node in an Ethereum Merkle Patricia Trie.
ExtensionNodeRef
Re-export Reference to the extension node. See ExtensionNode from more information.
FnContextrayon
Provides the calling context to a closure called by join_context.
HashBuilder
Re-export A component used to construct the root hash of the trie.
HashedPostState
In-memory hashed state that stores account and storage changes with keccak256-hashed keys in hash maps.
HashedPostStateSorted
Sorted hashed post state optimized for iterating during state trie calculation.
HashedPostStateSortedProducer
Sorts hashed state and publishes it to waiting handles.
HashedStorage
Representation of in-memory hashed storage.
HashedStorageSorted
Sorted hashed storage optimized for iterating during state trie calculation.
IntermediateStateRootState
The intermediate state of the state root computation.
IntermediateStorageRootState
The intermediate state of a storage root computation along with the account.
KeccakKeyHasher
A key hasher that uses the Keccak-256 hash function.
LazyHashedPostStateSorted
Shared sorted hashed state, available immediately or published by a background task. Clones share the same result and wait for the producer when it is still pending.
LeafNode
Re-export A leaf node represents the endpoint or terminal node in the trie. In other words, a leaf node is where actual values are stored.
LeafNodeRef
Re-export Reference to the leaf node. See LeafNode from more information.
LegacyKeyAdaptertrie-db
Legacy (v1) nibble encoding: 1 nibble per byte, 65-byte subkeys.
MultiProof
The state multiproof of target accounts and multiproofs of their storage tries. Multiproof is effectively a state subtrie that only contains the nodes in the paths of target accounts.
MultiProofTargets
Proof targets map.
MultiProofTargetsV2
A set of account and storage V2 proof targets. The account and storage targets do not need to necessarily overlap.
Nibbles
Structure representing a sequence of nibbles.
PackedAccountsTrietrie-db
Packed-encoding view of the AccountsTrie table.
PackedKeyAdaptertrie-db
Packed (v2) nibble encoding: 2 nibbles per byte, 33-byte subkeys.
PackedStorageTrieEntry
Account storage trie node with packed nibble encoding (storage v2).
PackedStoragesTrietrie-db
Packed-encoding view of the StoragesTrie table.
PackedStoredNibbles
Packed representation of nibbles for the AccountsTrie (storage v2).
PackedStoredNibblesSubKey
Packed representation of nibbles as a DupSort subkey for StoragesTrie (storage v2).
ProofTrieNode
Carries all information needed by a sparse trie to reveal a particular node.
ProofTrieNodeV2
Carries all information needed by a sparse trie to reveal a particular node.
ProofV2Target
Target describes a proof target. For every proof target given, a proof calculator will calculate and return all nodes whose path is a prefix of the target’s key_nibbles.
ProofV2TargetParent
The already-revealed parent branch of a ProofV2Target.
RlpNode
Re-export An RLP-encoded node.
Scoperayon
Represents a fork-join scope which can be used to spawn any number of tasks. See scope() for more information.
ScopeFiforayon
Represents a fork-join scope which can be used to spawn any number of tasks. Those spawned from the same thread are prioritized in relative FIFO order. See scope_fifo() for more information.
StateRoot
StateRoot is used to compute the root node of a state trie.
StorageMultiProof
The merkle multiproof of storage trie.
StorageProof
The merkle proof of the storage entry.
StorageRoot
StorageRoot is used to compute the root node of an account storage trie.
StorageTrieEntry
Account storage trie node.
StoredNibbles
The representation of nibbles of the merkle trie stored in the database.
StoredNibblesSubKey
The representation of nibbles of the merkle trie stored in the database.
StoredSubNode
Walker sub node for storing intermediate state root calculation state in the database.
ThreadBuilderrayon
Thread builder used for customization via ThreadPoolBuilder::spawn_handler().
ThreadPoolrayon
Represents a user-created thread pool.
ThreadPoolBuildErrorrayon
Error when initializing a thread pool.
ThreadPoolBuilderrayon
Used to create a new ThreadPool or to configure the global rayon thread pool.
TrieAccountethereum
Re-export for convenience. Represents an TrieAccount in the account trie.
TrieInput
Inputs for trie-related computations.
TrieInputSorted
Sorted variant of TrieInput for efficient proof generation.
TrieMask
Re-export A struct representing a mask of 16 bits, used for Ethereum trie operations.
TrieMaskIter
Re-export An iterator over the set bit indices of a TrieMask.

Enums§

ExecutionWitnessMode
Controls how execution witnesses are generated.
StateRootProgress
The progress of the state root computation.
StorageRootProgress
The progress of a storage root calculation.
TrieNode
Re-export Enum representing an MPT trie node.
TrieNodeV2
Enum representing an MPT trie node.
TrieType
Trie type for differentiating between various trie calculations.
Yieldrayon
Result of yield_now() or yield_local().

Constants§

CHILD_INDEX_RANGE
Re-export The range of valid child indexes.
EMPTY_ROOT_HASH
Re-export Root hash of an empty trie.
TRIE_ACCOUNT_RLP_MAX_SIZE
The maximum size of RLP encoded trie account in bytes. 2 (header) + 4 * 1 (field lens) + 8 (nonce) + 32 * 3 (balance, storage root, code hash)

Traits§

DatabaseHashedPostStatetrie-db
Extends HashedPostStateSorted with operations specific for working with a database transaction.
DatabaseProoftrie-db
Extends Proof with operations specific for working with a database transaction.
DatabaseStateRoottrie-db
Extends StateRoot with operations specific for working with a database transaction.
DatabaseStorageProoftrie-db
Extends StorageProof with operations specific for working with a database transaction.
DatabaseStorageRoottrie-db
Extends StorageRoot with operations specific for working with a database transaction.
KeyHasher
Trait for hashing keys in state.
StorageTrieEntryLiketrie-db
Trait for storage trie entry types that carry a subkey and node.
TrieKeyAdaptertrie-db
Trait abstracting nibble encoding for trie keys.
TrieTableAdaptertrie-db
Helper trait to map a TrieKeyAdapter to the correct table types.

Functions§

broadcastrayon
Executes op within every thread in the current thread pool. If this is called from a non-Rayon thread, it will execute in the global thread pool. Any attempts to use join, scope, or parallel iterators will then operate within that thread pool. When the call has completed on each thread, returns a vector containing all of their return values.
compute_block_trie_changesetstrie-db
Computes trie changesets for a block.
compute_range_trie_changesetstrie-db
Computes aggregate trie changesets for an inclusive block range.
current_num_threadsrayon
Returns the number of threads in the current registry. If this code is executing within a Rayon thread pool, then this will be the number of threads for the thread pool of the current thread. Otherwise, it will be the number of threads for the global thread pool.
current_thread_indexrayon
If called from a Rayon worker thread, returns the index of that thread within its current pool; if not called from a Rayon thread, returns None.
depth_first_cmp
Compares two Nibbles in depth-first order.
encode_path_leaf
Re-export Encodes a given path leaf as a compact array of bytes.
hashed_storage_from_reverts_with_providertrie-db
Initializes HashedStorage from reverts using a provider.
in_place_scoperayon
Creates a “fork-join” scope s and invokes the closure with a reference to s. This closure can then spawn asynchronous tasks into s. Those tasks may run asynchronously with respect to the closure; they may themselves spawn additional tasks into s. When the closure returns, it will block until all tasks that have been spawned into s complete.
in_place_scope_fiforayon
Creates a “fork-join” scope s with FIFO order, and invokes the closure with a reference to s. This closure can then spawn asynchronous tasks into s. Those tasks may run asynchronously with respect to the closure; they may themselves spawn additional tasks into s. When the closure returns, it will block until all tasks that have been spawned into s complete.
joinrayon
Takes two closures and potentially runs them in parallel. It returns a pair of the results from those closures.
join_contextrayon
Identical to join, except that the closures have a parameter that provides context for the way the closure has been called, especially indicating whether they’re executing on a different thread than where join_context was called. This will occur if the second job is stolen by a different thread, or if join_context was called from outside the thread pool to begin with.
load_prefix_sets_with_providertrie-db
Load prefix sets using a provider that implements ChangeSetReader. This function can read changesets from both static files and database.
max_num_threadsrayon
Returns the maximum number of threads that Rayon supports in a single thread pool.
rlp_nodeDeprecated
Re-export Given an RLP-encoded node, returns it either as rlp(node) or rlp(keccak(rlp(node))).
scoperayon
Creates a “fork-join” scope s and invokes the closure with a reference to s. This closure can then spawn asynchronous tasks into s. Those tasks may run asynchronously with respect to the closure; they may themselves spawn additional tasks into s. When the closure returns, it will block until all tasks that have been spawned into s complete.
scope_fiforayon
Creates a “fork-join” scope s with FIFO order, and invokes the closure with a reference to s. This closure can then spawn asynchronous tasks into s. Those tasks may run asynchronously with respect to the closure; they may themselves spawn additional tasks into s. When the closure returns, it will block until all tasks that have been spawned into s complete.
spawnrayon
Puts the task into the Rayon thread pool’s job queue in the “static” or “global” scope. Just like a standard thread, this task is not tied to the current stack frame, and hence it cannot hold any references other than those with 'static lifetime. If you want to spawn a task that references stack data, use the scope() function to create a scope.
spawn_broadcastrayon
Spawns an asynchronous task on every thread in this thread pool. This task will run in the implicit, global scope, which means that it may outlast the current stack frame – therefore, it cannot capture any references onto the stack (you will likely need a move closure).
spawn_fiforayon
Fires off a task into the Rayon thread pool in the “static” or “global” scope. Just like a standard thread, this task is not tied to the current stack frame, and hence it cannot hold any references other than those with 'static lifetime. If you want to spawn a task that references stack data, use the scope_fifo() function to create a scope.
word_rlpDeprecated
Re-export Optimization for quick RLP-encoding of a 32-byte word.
yield_localrayon
Cooperatively yields execution to local Rayon work.
yield_nowrayon
Cooperatively yields execution to Rayon.

Type Aliases§

BranchNodeMasksMap
Map from nibble path to branch node masks.