Struct MerkleVerify

pub struct MerkleVerify;

Verify membership in a Merkle tree.

Verify that a leaf lives in a Merkle tree, given the tree’s root, its height, the leaf’s index, and the leaf itself. The authentication path is non-deterministically divined. This algorithm asserts that the leaf is a member of the tree; phrased differently, if membership could not be established, it crashes the VM.

Behavior

BEFORE: _ [root: Digest] tree_height leaf_index [leaf: Digest]
AFTER:  _

Preconditions

• all input arguments are properly BFieldCodec encoded

Postconditions

None.

Implementations

impl MerkleVerify

pub const TREE_TOO_HIGH_ERROR_ID: i128 = 0i128

pub const OUT_OF_BOUNDS_LEAF_ERROR_ID: i128 = 1i128

pub const ROOT_MISMATCH_ERROR_ID: i128 = 2i128

Trait Implementations

impl BasicSnippet for MerkleVerify

fn inputs(&self) -> Vec<(DataType, String)>

fn outputs(&self) -> Vec<(DataType, String)>

fn entrypoint(&self) -> String

fn code(&self, _: &mut Library) -> Vec<LabelledInstruction>

fn sign_offs(&self) -> HashMap<Reviewer, SignOffFingerprint>

Contains an entry for every sign off.

fn annotated_code(&self, library: &mut Library) -> Vec<LabelledInstruction>

fn link_for_isolated_run(&self) -> Vec<LabelledInstruction>

fn init_stack_for_isolated_run(&self) -> Vec<BFieldElement>

Initial stack on program start, when the snippet runs in isolation.

fn stack_diff(&self) -> isize

impl Clone for MerkleVerify

fn clone(&self) -> MerkleVerify

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MerkleVerify

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

Formats the value using the given formatter.