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.

Implementations

impl PartialStorageMap

pub fn new(partial_smt: PartialSmt) -> Self

Returns a new instance of partial storage map with the specified partial SMT.

pub fn partial_smt(&self) -> &PartialSmt

pub fn root(&self) -> Word

pub fn open(&self, key: &Word) -> Result<SmtProof, MerkleError>

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. The key needs to be hashed to have a behavior in line with StorageMap. For more details as to why this is needed, refer to the docs for that struct.

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 of the map.

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, proof: SmtProof) -> Result<(), MerkleError>

Adds an SmtProof 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 From<PartialSmt> for PartialStorageMap

fn from(partial_smt: PartialSmt) -> Self

Converts to this type from the input type.

impl From<StorageMap> for PartialStorageMap

fn from(value: StorageMap) -> Self

Converts to this type from the input type.

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