Enum miden_processor::AdviceExtractor

pub enum AdviceExtractor {
    PopStack,
    PopStackWord,
    PopStackDWord,
    GetMerklePath,
}

Defines a set of actions which can be initiated from the VM to extract data from the advice provider. These actions can only modify the advice stack.

Variants

PopStack

Pops an element from the advice stack and returns it.

Errors

Returns an error if the advice stack is empty.

Inputs: Operand stack: […] Advice stack: [value, …] Advice map: {…} Merkle store: {…}

Outputs: Operand stack: […] Advice stack: […] Advice map: {…} Merkle store: {…} Return: [value]

PopStackWord

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

Note: a word is popped off the stack element-by-element. For example, a [d, c, b, a, ...] stack (i.e., d is at the top of the stack) will yield [d, c, b, a].

Errors

Returns an error if the advice stack does not contain a full word.

Inputs: Operand stack: […] Advice stack: [d, c, b, a, …] Advice map: {…} Merkle store: {…}

Outputs: Operand stack: […] Advice stack: […] Advice map: {…} Merkle store: {…} Return: [a, b, c, d]

PopStackDWord

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

Note: words are popped off the stack element-by-element. For example, a [h, g, f, e, d, c, b, a, ...] stack (i.e., h is at the top of the stack) will yield two words: [h, g, f,e ], [d, c, b, a].

Errors

Returns an error if the advice stack does not contain two words.

Inputs: Operand stack: […] Advice stack: [h, g, f, e, d, c, b, a, …] Advice map: {…} Merkle store: {…}

Outputs: Operand stack: […] Advice stack: […] Advice map: {…} Merkle store: {…} Return: [a, b, c, d, e, f, g, h]

GetMerklePath

Extracts a Merkle path for the node specified by the values at the top of the operand stack and returns it to the caller.

Errors

Returns an error if the Merkle store does not contain the specified Merkle path.

Inputs: Operand stack: [WORD, depth, index, ROOT, …] Advice stack: […] Advice map: {…} Merkle store: {path, …}

Outputs: Operand stack: [WORD, depth, index, ROOT, …] Advice stack: […] Advice map: {…} Merkle store: {path, …} Return: [path]

Trait Implementations

impl Clone for AdviceExtractor

fn clone(&self) -> AdviceExtractor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AdviceExtractor

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

Formats the value using the given formatter.

impl Display for AdviceExtractor

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

Formats the value using the given formatter.

impl PartialEq for AdviceExtractor

fn eq(&self, other: &AdviceExtractor) -> 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 Copy for AdviceExtractor

impl Eq for AdviceExtractor

impl StructuralPartialEq for AdviceExtractor