pub struct RevealedSparseTrie<P = DefaultBlindedProvider> { /* private fields */ }
Expand description
The representation of revealed sparse trie.
The revealed sparse trie contains the actual trie structure with nodes, values, and tracking for changes. It supports operations like inserting, updating, and removing nodes.
§Invariants
- The root node is always present in
nodes
collection. - Each leaf entry in
nodes
collection must have a corresponding entry invalues
collection. The opposite is also true. - All keys in
values
collection are full leaf paths.
Implementations§
Source§impl RevealedSparseTrie
impl RevealedSparseTrie
Sourcepub fn from_root(
root: TrieNode,
masks: TrieMasks,
retain_updates: bool,
) -> SparseTrieResult<Self>
pub fn from_root( root: TrieNode, masks: TrieMasks, retain_updates: bool, ) -> SparseTrieResult<Self>
Creates a new revealed sparse trie from the given root node.
This function initializes the internal structures and then reveals the root.
It is a convenient method to create a RevealedSparseTrie
when you already have
the root node available.
§Returns
A RevealedSparseTrie
if successful, or an error if revealing fails.
Source§impl<P> RevealedSparseTrie<P>
impl<P> RevealedSparseTrie<P>
Sourcepub fn from_provider_and_root(
provider: P,
node: TrieNode,
masks: TrieMasks,
retain_updates: bool,
) -> SparseTrieResult<Self>
pub fn from_provider_and_root( provider: P, node: TrieNode, masks: TrieMasks, retain_updates: bool, ) -> SparseTrieResult<Self>
Creates a new revealed sparse trie from the given provider and root node.
Similar to from_root
, but allows specifying a custom provider for
retrieving blinded nodes.
§Returns
A RevealedSparseTrie
if successful, or an error if revealing fails.
Sourcepub fn with_provider<BP>(self, provider: BP) -> RevealedSparseTrie<BP>
pub fn with_provider<BP>(self, provider: BP) -> RevealedSparseTrie<BP>
Replaces the current provider with a new provider.
This allows changing how blinded nodes are retrieved without rebuilding the entire trie structure.
§Returns
A new RevealedSparseTrie
with the updated provider.
Sourcepub fn with_updates(self, retain_updates: bool) -> Self
pub fn with_updates(self, retain_updates: bool) -> Self
Configures the trie to retain information about updates.
If retain_updates
is true, the trie will record branch node updates and deletions.
This information can then be used to efficiently update an external database.
Sourcepub fn updates_ref(&self) -> Cow<'_, SparseTrieUpdates>
pub fn updates_ref(&self) -> Cow<'_, SparseTrieUpdates>
Returns a reference to the current sparse trie updates.
If no updates have been made/recorded, returns an empty update set.
Sourcepub const fn nodes_ref(&self) -> &HashMap<Nibbles, SparseNode>
pub const fn nodes_ref(&self) -> &HashMap<Nibbles, SparseNode>
Returns an immutable reference to all nodes in the sparse trie.
Sourcepub fn get_leaf_value(&self, path: &Nibbles) -> Option<&Vec<u8>>
pub fn get_leaf_value(&self, path: &Nibbles) -> Option<&Vec<u8>>
Retrieves a reference to the leaf value stored at the given key path, if it is revealed.
This method efficiently retrieves values from the trie without traversing the entire node structure, as values are stored in a separate map.
Note: a value can exist in the full trie and this function still returns None
because the value has not been revealed.
Hence a None
indicates two possibilities:
- The value does not exists in the trie, so it cannot be revealed
- The value has not yet been revealed. In order to determine which is true, one would need an exclusion proof.
Sourcepub fn take_updates(&mut self) -> SparseTrieUpdates
pub fn take_updates(&mut self) -> SparseTrieUpdates
Consumes and returns the currently accumulated trie updates.
This is useful when you want to apply the updates to an external database, and then start tracking a new set of updates.
Sourcepub fn reserve_nodes(&mut self, additional: usize)
pub fn reserve_nodes(&mut self, additional: usize)
Reserves capacity in the nodes map for at least additional
more nodes.
Sourcepub fn reveal_node(
&mut self,
path: Nibbles,
node: TrieNode,
masks: TrieMasks,
) -> SparseTrieResult<()>
pub fn reveal_node( &mut self, path: Nibbles, node: TrieNode, masks: TrieMasks, ) -> SparseTrieResult<()>
Reveals a trie node if it has not been revealed before.
This internal function decodes a trie node and inserts it into the nodes map. It handles different node types (leaf, extension, branch) by appropriately adding them to the trie structure and recursively revealing their children.
§Returns
Ok(())
if successful, or an error if node was not revealed.
Sourcepub fn wipe(&mut self)
pub fn wipe(&mut self)
Removes all nodes and values from the trie, resetting it to a blank state with only an empty root node.
Note: All previously tracked changes to the trie are also removed.
Sourcepub fn root(&mut self) -> B256
pub fn root(&mut self) -> B256
Calculates and returns the root hash of the trie.
Before computing the hash, this function processes any remaining (dirty) nodes by updating their RLP encodings. The root hash is either:
- The cached hash (if no dirty nodes were found)
- The keccak256 hash of the root node’s RLP representation
Sourcepub fn update_rlp_node_level(&mut self, depth: usize)
pub fn update_rlp_node_level(&mut self, depth: usize)
Recalculates and updates the RLP hashes of nodes deeper than or equal to the specified
depth
.
The root node is considered to be at level 0. This method is useful for optimizing hash recalculations after localized changes to the trie structure:
This function identifies all nodes that have changed (based on the prefix set) at the given depth and recalculates their RLP representation.
Sourcepub fn rlp_node_allocate(&mut self, prefix_set: &mut PrefixSet) -> RlpNode
pub fn rlp_node_allocate(&mut self, prefix_set: &mut PrefixSet) -> RlpNode
Look up or calculate the RLP of the node at the root path.
§Panics
If the node at provided path does not exist.
Sourcepub fn rlp_node(
&mut self,
prefix_set: &mut PrefixSet,
buffers: &mut RlpNodeBuffers,
rlp_buf: &mut Vec<u8>,
) -> RlpNode
pub fn rlp_node( &mut self, prefix_set: &mut PrefixSet, buffers: &mut RlpNodeBuffers, rlp_buf: &mut Vec<u8>, ) -> RlpNode
Looks up or computes the RLP encoding of the node specified by the current path in the provided buffers.
The function uses a stack (RlpNodeBuffers::path_stack
) to track the traversal and
accumulate RLP encodings.
§Parameters
prefix_set
: The set of trie paths that need their nodes updated.buffers
: The reusable buffers for stack management and temporary RLP values.
§Panics
If the node at provided path does not exist.
Source§impl<P: BlindedProvider> RevealedSparseTrie<P>
impl<P: BlindedProvider> RevealedSparseTrie<P>
Sourcepub fn clear(&mut self)
pub fn clear(&mut self)
This clears all data structures in the sparse trie, keeping the backing data structures allocated.
This is useful for reusing the trie without needing to reallocate memory.
Sourcepub fn find_leaf(
&self,
path: &Nibbles,
expected_value: Option<&Vec<u8>>,
) -> Result<LeafLookup, LeafLookupError>
pub fn find_leaf( &self, path: &Nibbles, expected_value: Option<&Vec<u8>>, ) -> Result<LeafLookup, LeafLookupError>
Attempts to find a leaf node at the specified path.
This method traverses the trie from the root down to the given path, checking if a leaf exists at that path. It can be used to verify the existence of a leaf or to generate an exclusion proof (proof that a leaf does not exist).
§Parameters
path
: The path to search for.expected_value
: Optional expected value. If provided, will verify the leaf value matches.
§Returns
Ok(LeafLookup::Exists)
if the leaf exists with the expected value.Ok(LeafLookup::NonExistent)
if the leaf definitely does not exist (exclusion proof).Err(LeafLookupError)
if the search encountered a blinded node or found a different value.
Sourcepub fn update_leaf(
&mut self,
path: Nibbles,
value: Vec<u8>,
is_private: bool,
) -> SparseTrieResult<()>
pub fn update_leaf( &mut self, path: Nibbles, value: Vec<u8>, is_private: bool, ) -> SparseTrieResult<()>
Updates or inserts a leaf node at the specified key path with the provided RLP-encoded value.
This method updates the internal prefix set and, if the leaf did not previously exist, adjusts the trie structure by inserting new leaf nodes, splitting branch nodes, or collapsing extension nodes as needed.
§Returns
Returns Ok(())
if the update is successful.
Note: If an update requires revealing a blinded node, an error is returned if the blinded provider returns an error.
Sourcepub fn remove_leaf(&mut self, path: &Nibbles) -> SparseTrieResult<()>
pub fn remove_leaf(&mut self, path: &Nibbles) -> SparseTrieResult<()>
Removes a leaf node from the trie at the specified key path.
This function removes the leaf value from the internal values map and then traverses the trie to remove or adjust intermediate nodes, merging or collapsing them as necessary.
§Returns
Returns Ok(())
if the leaf is successfully removed, otherwise returns an error
if the leaf is not present or if a blinded node prevents removal.
Trait Implementations§
Source§impl<P: Clone> Clone for RevealedSparseTrie<P>
impl<P: Clone> Clone for RevealedSparseTrie<P>
Source§fn clone(&self) -> RevealedSparseTrie<P>
fn clone(&self) -> RevealedSparseTrie<P>
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl<P> Debug for RevealedSparseTrie<P>
impl<P> Debug for RevealedSparseTrie<P>
Source§impl Default for RevealedSparseTrie
impl Default for RevealedSparseTrie
Source§impl<P: BlindedProvider> Display for RevealedSparseTrie<P>
impl<P: BlindedProvider> Display for RevealedSparseTrie<P>
Source§impl<P: PartialEq> PartialEq for RevealedSparseTrie<P>
impl<P: PartialEq> PartialEq for RevealedSparseTrie<P>
impl<P: Eq> Eq for RevealedSparseTrie<P>
impl<P> StructuralPartialEq for RevealedSparseTrie<P>
Auto Trait Implementations§
impl<P> Freeze for RevealedSparseTrie<P>where
P: Freeze,
impl<P> RefUnwindSafe for RevealedSparseTrie<P>where
P: RefUnwindSafe,
impl<P> Send for RevealedSparseTrie<P>where
P: Send,
impl<P> Sync for RevealedSparseTrie<P>where
P: Sync,
impl<P> Unpin for RevealedSparseTrie<P>where
P: Unpin,
impl<P> UnwindSafe for RevealedSparseTrie<P>where
P: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Conv for T
impl<T> Conv for T
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
§impl<TxEnv, T> FromRecoveredTx<&T> for TxEnvwhere
TxEnv: FromRecoveredTx<T>,
impl<TxEnv, T> FromRecoveredTx<&T> for TxEnvwhere
TxEnv: FromRecoveredTx<T>,
§fn from_recovered_tx(tx: &&T, sender: Address) -> TxEnv
fn from_recovered_tx(tx: &&T, sender: Address) -> TxEnv
TxEnv
from a transaction and a sender address.§impl<TxEnv, T> FromTxWithEncoded<&T> for TxEnvwhere
TxEnv: FromTxWithEncoded<T>,
impl<TxEnv, T> FromTxWithEncoded<&T> for TxEnvwhere
TxEnv: FromTxWithEncoded<T>,
§fn from_encoded_tx(tx: &&T, sender: Address, encoded: Bytes) -> TxEnv
fn from_encoded_tx(tx: &&T, sender: Address, encoded: Bytes) -> TxEnv
TxEnv
from a transaction, its sender, and encoded transaction bytes.§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.§impl<T> TryConv for T
impl<T> TryConv for T
§impl<T> WithSubscriber for T
impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
impl<T> ErasedDestructor for Twhere
T: 'static,
impl<T> MaybeDebug for Twhere
T: Debug,
impl<T> MaybeSend for Twhere
T: Send,
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.