Enum SparseTrie

Source
pub enum SparseTrie<P = DefaultBlindedProvider> {
    Blind,
    Revealed(Box<RevealedSparseTrie<P>>),
}
Expand description

A sparse trie that is either in a “blind” state (no nodes are revealed, root node hash is unknown) or in a “revealed” state (root node has been revealed and the trie can be updated).

In blind mode the trie does not contain any decoded node data, which saves memory but prevents direct access to node contents. The revealed mode stores decoded nodes along with additional information such as values, allowing direct manipulation.

The sparse trie design is optimised for:

  1. Memory efficiency - only revealed nodes are loaded into memory
  2. Update tracking - changes to the trie structure can be tracked and selectively persisted
  3. Incremental operations - nodes can be revealed as needed without loading the entire trie. This is what gives rise to the notion of a “sparse” trie.

Variants§

§

Blind

The trie is blind – no nodes have been revealed

This is the default state. In this state, the trie cannot be directly queried or modified until nodes are revealed.

§

Revealed(Box<RevealedSparseTrie<P>>)

Some nodes in the Trie have been revealed.

In this state, the trie can be queried and modified for the parts that have been revealed. Other parts remain blind and require revealing before they can be accessed.

Implementations§

Source§

impl SparseTrie

Source

pub const fn blind() -> Self

Creates a new blind sparse trie.

§Examples
use reth_trie_sparse::{blinded::DefaultBlindedProvider, SparseTrie};

let trie: SparseTrie<DefaultBlindedProvider> = SparseTrie::blind();
assert!(trie.is_blind());
let trie: SparseTrie<DefaultBlindedProvider> = SparseTrie::default();
assert!(trie.is_blind());
Source

pub fn revealed_empty() -> Self

Creates a new revealed but empty sparse trie with SparseNode::Empty as root node.

§Examples
use reth_trie_sparse::{blinded::DefaultBlindedProvider, SparseTrie};

let trie: SparseTrie<DefaultBlindedProvider> = SparseTrie::revealed_empty();
assert!(!trie.is_blind());
Source

pub fn reveal_root( &mut self, root: TrieNode, masks: TrieMasks, retain_updates: bool, ) -> SparseTrieResult<&mut RevealedSparseTrie>

Reveals the root node, converting a blind trie into a revealed one.

If the trie is blinded, its root node is replaced with root.

The masks are used to determine how the node’s children are stored. The retain_updates flag controls whether changes to the trie structure should be tracked.

§Returns

A mutable reference to the underlying RevealedSparseTrie.

Source§

impl<P> SparseTrie<P>

Source

pub const fn is_blind(&self) -> bool

Returns true if the sparse trie has no revealed nodes.

Source

pub const fn as_revealed_ref(&self) -> Option<&RevealedSparseTrie<P>>

Returns an immutable reference to the underlying revealed sparse trie.

Returns None if the trie is blinded.

Source

pub fn as_revealed_mut(&mut self) -> Option<&mut RevealedSparseTrie<P>>

Returns a mutable reference to the underlying revealed sparse trie.

Returns None if the trie is blinded.

Source

pub fn reveal_root_with_provider( &mut self, provider: P, root: TrieNode, masks: TrieMasks, retain_updates: bool, ) -> SparseTrieResult<&mut RevealedSparseTrie<P>>

Reveals the root node using a specified provider.

This function is similar to Self::reveal_root but allows the caller to provide a custom provider for fetching blinded nodes.

§Returns

Mutable reference to RevealedSparseTrie.

Source

pub fn wipe(&mut self) -> SparseTrieResult<()>

Wipes the trie by removing all nodes and values, and resetting the trie to only contain an empty root node.

Note: This method will error if the trie is blinded.

Source

pub fn root(&mut self) -> Option<B256>

Calculates the root hash of the trie.

This will update any remaining dirty nodes before computing the root hash. “dirty” nodes are nodes that need their hashes to be recomputed because one or more of their children’s hashes have changed.

§Returns
  • Some(B256) with the calculated root hash if the trie is revealed.
  • None if the trie is still blind.
Source

pub fn root_with_updates(&mut self) -> Option<(B256, SparseTrieUpdates)>

Returns the root hash along with any accumulated update information.

This is useful for when you need both the root hash and information about what nodes were modified, which can be used to efficiently update an external database.

§Returns

An Option tuple consisting of:

  • The trie root hash (B256).
  • A SparseTrieUpdates structure containing information about updated nodes.
  • None if the trie is still blind.
Source§

impl<P: BlindedProvider> SparseTrie<P>

Source

pub fn update_leaf( &mut self, path: Nibbles, value: Vec<u8>, is_private: bool, ) -> SparseTrieResult<()>

Update the leaf node.

Source

pub fn remove_leaf(&mut self, path: &Nibbles) -> SparseTrieResult<()>

Removes a leaf node at the specified key path.

§Errors

Returns an error if the trie is still blind, or if the leaf cannot be removed

Trait Implementations§

Source§

impl<P> Debug for SparseTrie<P>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<P> Default for SparseTrie<P>

Source§

fn default() -> SparseTrie<P>

Returns the “default value” for a type. Read more
Source§

impl<P: PartialEq> PartialEq for SparseTrie<P>

Source§

fn eq(&self, other: &SparseTrie<P>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<P: Eq> Eq for SparseTrie<P>

Source§

impl<P> StructuralPartialEq for SparseTrie<P>

Auto Trait Implementations§

§

impl<P> Freeze for SparseTrie<P>

§

impl<P> RefUnwindSafe for SparseTrie<P>
where P: RefUnwindSafe,

§

impl<P> Send for SparseTrie<P>
where P: Send,

§

impl<P> Sync for SparseTrie<P>
where P: Sync,

§

impl<P> Unpin for SparseTrie<P>

§

impl<P> UnwindSafe for SparseTrie<P>
where P: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<TxEnv, T> FromRecoveredTx<&T> for TxEnv
where TxEnv: FromRecoveredTx<T>,

§

fn from_recovered_tx(tx: &&T, sender: Address) -> TxEnv

Builds a TxEnv from a transaction and a sender address.
§

impl<TxEnv, T> FromTxWithEncoded<&T> for TxEnv
where TxEnv: FromTxWithEncoded<T>,

§

fn from_encoded_tx(tx: &&T, sender: Address, encoded: Bytes) -> TxEnv

Builds a TxEnv from a transaction, its sender, and encoded transaction bytes.
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 T
where T: ?Sized,

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows 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) -> R
where R: 'a,

Mutably borrows 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
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows 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
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows 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
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .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
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .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
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeDebug for T
where T: Debug,

§

impl<T> MaybeSend for T
where T: Send,

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

Size for each variant:

  • Blind: 0 bytes
  • Revealed: 8 bytes