Struct MemAdviceProvider

pub struct MemAdviceProvider { /* private fields */ }

An in-memory [AdviceProvider] implementation which uses BTreeMaps as its backing storage.

Implementations

impl MemAdviceProvider

pub fn into_parts( self, ) -> (Vec<Felt>, BTreeMap<RpoDigest, Vec<Felt>>, MerkleStore)

Consumes the MemAdviceProvider and returns a (Vec<Felt>, SimpleAdviceMap, MerkleStore), containing the stack, map, store respectively, of the advice provider.

Trait Implementations

impl AdviceProvider for MemAdviceProvider

Pass-through implementations of AdviceProvider methods.

TODO: potentially do this via a macro.

fn pop_stack( &mut self, process: ProcessState<'_>, err_ctx: &ErrorContext<'_, impl MastNodeExt>, ) -> Result<Felt, ExecutionError>

Pops an element from the advice stack and returns it.

fn pop_stack_word( &mut self, process: ProcessState<'_>, err_ctx: &ErrorContext<'_, impl MastNodeExt>, ) -> Result<Word, ExecutionError>

Pops a word (4 elements) from the advice stack and returns it.

fn pop_stack_dword( &mut self, process: ProcessState<'_>, err_ctx: &ErrorContext<'_, impl MastNodeExt>, ) -> Result<[Word; 2], ExecutionError>

Pops a double word (8 elements) from the advice stack and returns them.

fn push_stack( &mut self, source: AdviceSource, err_ctx: &ErrorContext<'_, impl MastNodeExt>, ) -> Result<(), ExecutionError>

Pushes the value(s) specified by the source onto the advice stack.

fn insert_into_map(&mut self, key: Word, values: Vec<Felt>)

Inserts the provided value into the advice map under the specified key.

fn get_mapped_values(&self, key: &RpoDigest) -> Option<&[Felt]>

Returns a reference to the value(s) associated with the specified key in the advice map.

fn get_tree_node( &self, root: Word, depth: &Felt, index: &Felt, err_ctx: &ErrorContext<'_, impl MastNodeExt>, ) -> Result<Word, ExecutionError>

Returns a node at the specified depth and index in a Merkle tree with the given root.

fn get_merkle_path( &self, root: Word, depth: &Felt, index: &Felt, err_ctx: &ErrorContext<'_, impl MastNodeExt>, ) -> Result<MerklePath, ExecutionError>

Returns a path to a node at the specified depth and index in a Merkle tree with the specified root.

fn get_leaf_depth( &self, root: Word, tree_depth: &Felt, index: &Felt, err_ctx: &ErrorContext<'_, impl MastNodeExt>, ) -> Result<u8, ExecutionError>

Reconstructs a path from the root until a leaf or empty node and returns its depth.

fn update_merkle_node( &mut self, root: Word, depth: &Felt, index: &Felt, value: Word, err_ctx: &ErrorContext<'_, impl MastNodeExt>, ) -> Result<(MerklePath, Word), ExecutionError>

Updates a node at the specified depth and index in a Merkle tree with the specified root; returns the Merkle path from the updated node to the new root, together with the new root.

fn merge_roots( &mut self, lhs: Word, rhs: Word, err_ctx: &ErrorContext<'_, impl MastNodeExt>, ) -> Result<Word, ExecutionError>

Creates a new Merkle tree in the advice provider by combining Merkle trees with the specified roots. The root of the new tree is defined as hash(left_root, right_root).

impl Clone for MemAdviceProvider

fn clone(&self) -> MemAdviceProvider

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MemAdviceProvider

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

Formats the value using the given formatter.

impl Default for MemAdviceProvider

fn default() -> MemAdviceProvider

Returns the “default value” for a type.

impl From<AdviceInputs> for MemAdviceProvider

fn from(inputs: AdviceInputs) -> Self

Converts to this type from the input type.