Struct MemAdviceProvider

pub struct MemAdviceProvider { /* private fields */ }

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

Implementations

impl MemAdviceProvider

Accessors to internal data structures of the provider used for testing purposes.

pub fn stack(&self) -> &[BaseElement]

Returns the current state of the advice stack.

pub fn map(&self) -> &BTreeMap<RpoDigest, Vec<BaseElement>>

Returns the current state of the advice map.

pub fn store(&self) -> &MerkleStore

pub fn has_merkle_root(&self, root: RpoDigest) -> bool

Returns true if the Merkle root exists for the advice provider Merkle store.

impl MemAdviceProvider

pub fn into_parts( self, ) -> (Vec<BaseElement>, BTreeMap<RpoDigest, Vec<BaseElement>>, 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<BaseElement, 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<[BaseElement; 4], 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<[[BaseElement; 4]; 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: [BaseElement; 4], values: Vec<BaseElement>)

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

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

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

fn get_tree_node( &self, root: [BaseElement; 4], depth: &BaseElement, index: &BaseElement, err_ctx: &ErrorContext<'_, impl MastNodeExt>, ) -> Result<[BaseElement; 4], ExecutionError>

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

fn get_merkle_path( &self, root: [BaseElement; 4], depth: &BaseElement, index: &BaseElement, 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: [BaseElement; 4], tree_depth: &BaseElement, index: &BaseElement, 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: [BaseElement; 4], depth: &BaseElement, index: &BaseElement, value: [BaseElement; 4], err_ctx: &ErrorContext<'_, impl MastNodeExt>, ) -> Result<(MerklePath, [BaseElement; 4]), 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: [BaseElement; 4], rhs: [BaseElement; 4], err_ctx: &ErrorContext<'_, impl MastNodeExt>, ) -> Result<[BaseElement; 4], 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 duplicate 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<(), Error>

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) -> MemAdviceProvider

Converts to this type from the input type.