Struct AdviceInputs 

pub struct AdviceInputs {
    pub stack: Vec<Felt>,
    pub map: AdviceMap,
    pub store: MerkleStore,
}

Inputs container to initialize advice provider for the execution of Miden VM programs.

The program may request nondeterministic advice inputs from the prover. These inputs are secret inputs. This means that the prover does not need to share them with the verifier.

There are three types of advice inputs:

1. Single advice stack which can contain any number of elements.
2. Key-mapped element lists which can be pushed onto the advice stack.
3. Merkle store, which is used to provide nondeterministic inputs for instructions that operates with Merkle trees.

Fields

stack: Vec<Felt>

map: AdviceMap

store: MerkleStore

Implementations

impl AdviceInputs

pub fn with_stack_values<I>(self, iter: I) -> Result<Self, InputError>

where I: IntoIterator<Item = u64>,

Attempts to extend the stack values with the given sequence of integers, returning an error if any of the numbers fails while converting to an element [Felt].

pub fn with_stack<I>(self, iter: I) -> Self

where I: IntoIterator<Item = Felt>,

Extends the stack with the given elements.

pub fn with_map<I>(self, iter: I) -> Self

where I: IntoIterator<Item = (Word, Vec<Felt>)>,

Extends the map of values with the given argument, replacing previously inserted items.

pub fn with_merkle_store(self, store: MerkleStore) -> Self

Replaces the MerkleStore with the provided argument.

pub fn extend(&mut self, other: Self)

Extends the contents of this instance with the contents of the other instance.

Trait Implementations

impl Clone for AdviceInputs

fn clone(&self) -> AdviceInputs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AdviceInputs

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

Formats the value using the given formatter.

impl Default for AdviceInputs

fn default() -> AdviceInputs

Returns the “default value” for a type.

impl Deserializable for AdviceInputs

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

Reads a sequence of bytes from the provided source, attempts to deserialize these bytes into Self, and returns the result.

fn min_serialized_size() -> usize

Returns the minimum serialized size for one instance of this type.

fn read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

Attempts to deserialize the provided bytes into Self and returns the result.

fn read_from_bytes_with_budget( bytes: &[u8], budget: usize, ) -> Result<Self, DeserializationError>

Deserializes Self from bytes with a byte budget limit.

impl PartialEq for AdviceInputs

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serializable for AdviceInputs

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

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 AdviceInputs

impl StructuralPartialEq for AdviceInputs