Struct PartialStorageMap 

pub struct PartialStorageMap { /* private fields */ }

A partial representation of a StorageMap, containing only proofs for a subset of the key-value pairs.

A partial storage map carries only the Merkle authentication data a transaction will need. Every included entry pairs a value with its proof, letting the transaction kernel verify reads (and prepare writes) without needing the complete tree.

Guarantees

This type guarantees that the raw key-value pairs it contains are all present in the contained partial SMT. Note that the inverse is not necessarily true. The SMT 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 PartialStorageMap

pub fn new(root: Word) -> Self

Constructs a PartialStorageMap from a StorageMap root.

For conversion from a StorageMap, prefer Self::new_minimal to be more explicit.

pub fn with_witnesses( witnesses: impl IntoIterator<Item = StorageMapWitness>, ) -> Result<Self, MerkleError>

Returns a new instance of a PartialStorageMap with all provided witnesses added to it.

pub fn new_full(storage_map: StorageMap) -> Self

Converts a StorageMap into a partial storage representation.

The resulting PartialStorageMap will contain the full entries and merkle paths of the original storage map.

pub fn new_minimal(storage_map: &StorageMap) -> Self

Converts a StorageMap into a partial storage representation.

The resulting PartialStorageMap will represent the root of the storage map, but not track any key-value pairs, which means it is the most minimal representation of the storage map.

pub fn partial_smt(&self) -> &PartialSmt

Returns a reference to the underlying PartialSmt.

pub fn root(&self) -> Word

Returns the root of the underlying PartialSmt.

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

Looks up the provided key in this map and returns:

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

pub fn open(&self, raw_key: &Word) -> Result<StorageMapWitness, MerkleError>

Returns an opening of the leaf associated with the raw key.

Conceptually, an opening is a Merkle path to the leaf, as well as the leaf itself.

Errors

Returns an error if:

• the key is not tracked by this partial storage map.

pub fn leaves(&self) -> impl Iterator<Item = (LeafIndex<SMT_DEPTH>, &SmtLeaf)>

Returns an iterator over the leaves of the underlying PartialSmt.

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

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

Note that the returned key is the raw map key.

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

Returns an iterator over the inner nodes of the underlying PartialSmt.

pub fn add(&mut self, witness: StorageMapWitness) -> Result<(), MerkleError>

Adds a StorageMapWitness for the specific key-value pair to this PartialStorageMap.

Trait Implementations

impl Clone for PartialStorageMap

fn clone(&self) -> PartialStorageMap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PartialStorageMap

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

Formats the value using the given formatter.

impl Default for PartialStorageMap

fn default() -> PartialStorageMap

Returns the “default value” for a type.

impl Deserializable for PartialStorageMap

fn read_from<R: ByteReader>( source: &mut R, ) -> Result<Self, DeserializationError>

Reads a sequence of bytes from the provided source, attempts to deserialize these bytes into Self, and returns the result.

fn read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

Attempts to deserialize the provided bytes into Self and returns the result.

impl PartialEq for PartialStorageMap

fn eq(&self, other: &PartialStorageMap) -> 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 Serializable for PartialStorageMap

fn write_into<W: ByteWriter>(&self, target: &mut W)

Serializes self into bytes and writes these bytes into the target.

fn to_bytes(&self) -> Vec<u8>

Serializes self into a vector of bytes.

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self.

impl Eq for PartialStorageMap

impl StructuralPartialEq for PartialStorageMap