pub struct Smt { /* private fields */ }
Expand description
Sparse Merkle tree mapping 256-bit keys to 256-bit values. Both keys and values are represented by 4 field elements.
All leaves sit at depth 64. The most significant element of the key is used to identify the leaf to which the key maps.
A leaf is either empty, or holds one or more key-value pairs. An empty leaf hashes to the empty word. Otherwise, a leaf hashes to the hash of its key-value pairs, ordered by key first, value second.
Implementations§
source§impl Smt
impl Smt
sourcepub const EMPTY_VALUE: Word = _
pub const EMPTY_VALUE: Word = _
The default value used to compute the hash of empty leaves
sourcepub fn new() -> Self
pub fn new() -> Self
Returns a new Smt.
All leaves in the returned tree are set to Self::EMPTY_VALUE.
sourcepub fn with_entries(
entries: impl IntoIterator<Item = (RpoDigest, Word)>,
) -> Result<Self, MerkleError>
pub fn with_entries( entries: impl IntoIterator<Item = (RpoDigest, Word)>, ) -> Result<Self, MerkleError>
Returns a new Smt instantiated with leaves set as specified by the provided entries.
All leaves omitted from the entries list are set to Self::EMPTY_VALUE.
§Errors
Returns an error if the provided entries contain multiple values for the same key.
sourcepub fn open(&self, key: &RpoDigest) -> SmtProof
pub fn open(&self, key: &RpoDigest) -> SmtProof
Returns an opening of the leaf associated with key
. Conceptually, an opening is a Merkle
path to the leaf, as well as the leaf itself.
sourcepub fn leaves(&self) -> impl Iterator<Item = (LeafIndex<SMT_DEPTH>, &SmtLeaf)>
pub fn leaves(&self) -> impl Iterator<Item = (LeafIndex<SMT_DEPTH>, &SmtLeaf)>
Returns an iterator over the leaves of this Smt.
sourcepub fn entries(&self) -> impl Iterator<Item = &(RpoDigest, Word)>
pub fn entries(&self) -> impl Iterator<Item = &(RpoDigest, Word)>
Returns an iterator over the key-value pairs of this Smt.
sourcepub fn inner_nodes(&self) -> impl Iterator<Item = InnerNodeInfo> + '_
pub fn inner_nodes(&self) -> impl Iterator<Item = InnerNodeInfo> + '_
Returns an iterator over the inner nodes of this Smt.
sourcepub fn insert(&mut self, key: RpoDigest, value: Word) -> Word
pub fn insert(&mut self, key: RpoDigest, value: Word) -> Word
Inserts a value at the specified key, returning the previous value associated with that key.
Recall that by definition, any key that hasn’t been updated is associated with
Self::EMPTY_VALUE
.
This also recomputes all hashes between the leaf (associated with the key) and the root, updating the root itself.
sourcepub fn compute_mutations(
&self,
kv_pairs: impl IntoIterator<Item = (RpoDigest, Word)>,
) -> MutationSet<SMT_DEPTH, RpoDigest, Word>
pub fn compute_mutations( &self, kv_pairs: impl IntoIterator<Item = (RpoDigest, Word)>, ) -> MutationSet<SMT_DEPTH, RpoDigest, Word>
Computes what changes are necessary to insert the specified key-value pairs into this Merkle tree, allowing for validation before applying those changes.
This method returns a MutationSet
, which contains all the information for inserting
kv_pairs
into this Merkle tree already calculated, including the new root hash, which can
be queried with MutationSet::root()
. Once a mutation set is returned,
Smt::apply_mutations()
can be called in order to commit these changes to the Merkle
tree, or drop()
to discard them.
§Example
let mut smt = Smt::new();
let pair = (RpoDigest::default(), Word::default());
let mutations = smt.compute_mutations(vec![pair]);
assert_eq!(mutations.root(), *EmptySubtreeRoots::entry(SMT_DEPTH, 0));
smt.apply_mutations(mutations);
assert_eq!(smt.root(), *EmptySubtreeRoots::entry(SMT_DEPTH, 0));
sourcepub fn apply_mutations(
&mut self,
mutations: MutationSet<SMT_DEPTH, RpoDigest, Word>,
) -> Result<(), MerkleError>
pub fn apply_mutations( &mut self, mutations: MutationSet<SMT_DEPTH, RpoDigest, Word>, ) -> Result<(), MerkleError>
Apply the prospective mutations computed with Smt::compute_mutations()
to this tree.
§Errors
If mutations
was computed on a tree with a different root than this one, returns
MerkleError::ConflictingRoots
with a two-item Vec
. The first item is the root hash
the mutations
were computed against, and the second item is the actual current root of
this tree.
Trait Implementations§
source§impl Deserializable for Smt
impl Deserializable for Smt
source§fn read_from<R: ByteReader>(
source: &mut R,
) -> Result<Self, DeserializationError>
fn read_from<R: ByteReader>( source: &mut R, ) -> Result<Self, DeserializationError>
source
, attempts to deserialize these bytes
into Self
, and returns the result. Read moresource§fn read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>
fn read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>
source§impl Serializable for Smt
impl Serializable for Smt
source§fn write_into<W: ByteWriter>(&self, target: &mut W)
fn write_into<W: ByteWriter>(&self, target: &mut W)
self
into bytes and writes these bytes into the target
.source§fn get_size_hint(&self) -> usize
fn get_size_hint(&self) -> usize
impl Eq for Smt
impl StructuralPartialEq for Smt
Auto Trait Implementations§
impl Freeze for Smt
impl RefUnwindSafe for Smt
impl Send for Smt
impl Sync for Smt
impl Unpin for Smt
impl UnwindSafe for Smt
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,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)