Struct miden_objects::crypto::merkle::SmtProof

pub struct SmtProof { /* private fields */ }

A proof which can be used to assert membership (or non-membership) of key-value pairs in a super::Smt.

The proof consists of a Merkle path and leaf which describes the node located at the base of the path.

Implementations

impl SmtProof

pub fn new(path: MerklePath, leaf: SmtLeaf) -> Result<SmtProof, SmtProofError>

Returns a new instance of SmtProof instantiated from the specified path and leaf.

Errors

Returns an error if the path length is not SMT_DEPTH.

pub fn verify_membership( &self, key: &RpoDigest, value: &[BaseElement; 4], root: &RpoDigest ) -> bool

Returns true if a super::Smt with the specified root contains the provided key-value pair.

Note: this method cannot be used to assert non-membership. That is, if false is returned, it does not mean that the provided key-value pair is not in the tree.

pub fn get(&self, key: &RpoDigest) -> Option<[BaseElement; 4]>

Returns the value associated with the specific key according to this proof, or None if this proof does not contain a value for the specified key.

A key-value pair generated by using this method should pass the verify_membership() check.

pub fn compute_root(&self) -> RpoDigest

Computes the root of a super::Smt to which this proof resolves.

pub fn path(&self) -> &MerklePath

Returns the proof’s Merkle path.

pub fn leaf(&self) -> &SmtLeaf

Returns the leaf associated with the proof.

pub fn into_parts(self) -> (MerklePath, SmtLeaf)

Consume the proof and returns its parts.

Trait Implementations

impl Clone for SmtProof

fn clone(&self) -> SmtProof

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SmtProof

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

Formats the value using the given formatter.

impl Deserializable for SmtProof

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

where R: ByteReader,

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 SmtProof

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serializable for SmtProof

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

where W: ByteWriter,

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 SmtProof

impl StructuralPartialEq for SmtProof