Struct StorageMapWitness 

pub struct StorageMapWitness { /* private fields */ }

A witness of an asset in a StorageMap.

It proves inclusion of a certain storage item in the map.

Guarantees

This type guarantees that the raw key-value pairs it contains are all present in the contained SMT proof. Note that the inverse is not necessarily true. The proof may contain more entries than the map because to prove inclusion of a given raw key A an SmtLeaf::Multiple may be present that contains both keys hash(A) and hash(B). However, B may not be present in the key-value pairs and this is a valid state.

Implementations

impl StorageMapWitness

pub fn new( proof: SmtProof, raw_keys: impl IntoIterator<Item = Word>, ) -> Result<Self, StorageMapError>

Creates a new StorageMapWitness from an SMT proof and a provided set of map keys.

Errors

Returns an error if:

• Any of the map keys is not contained in the proof.

pub fn new_unchecked( proof: SmtProof, raw_key_values: impl IntoIterator<Item = (Word, Word)>, ) -> Self

Creates a new StorageMapWitness from an SMT proof and a set of raw key value pairs.

Warning

This does not validate any of the guarantees of this type. See the type-level docs for more details.

pub fn proof(&self) -> &SmtProof

Returns a reference to the underlying SmtProof.

pub fn get(&self, raw_key: &Word) -> Option<Word>

Looks up the provided key in this witness and returns:

• a non-empty Word if the key is tracked by this witness and exists in it,
• Word::empty if the key is tracked by this witness and does not exist,
• None if the key is not tracked by this witness.

pub fn entries(&self) -> impl Iterator<Item = (&Word, &Word)>

Returns an iterator over the key-value pairs in this witness.

Note that the returned key is the raw map key.

pub fn authenticated_nodes(&self) -> impl Iterator<Item = InnerNodeInfo> + '_

Returns an iterator over every inner node of this witness’ merkle path.

Trait Implementations

impl Clone for StorageMapWitness

fn clone(&self) -> StorageMapWitness

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StorageMapWitness

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

Formats the value using the given formatter.

impl From<StorageMapWitness> for SmtProof

fn from(witness: StorageMapWitness) -> Self

Converts to this type from the input type.

impl PartialEq for StorageMapWitness

fn eq(&self, other: &StorageMapWitness) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for StorageMapWitness

impl StructuralPartialEq for StorageMapWitness