Crate miden_processor

Modules

• crypto
• math
• utils

Structs

• AdviceInputs
  Inputs container to initialize advice provider for the execution of Miden VM programs.
• AdviceMap
  Defines a set of non-deterministic (advice) inputs which the VM can access by their keys.
• AsmOpInfo
  Contains assembly instruction and operation index in the sequence corresponding to the specified AsmOp decorator. This index starts from 1 instead of 0.
• AssemblyOp
  Contains information corresponding to an assembly instruction (only applicable in debug mode).
• ChipletsLengths
  Contains trace lengths of all chilplets: hash, bitwise, memory and kernel ROM trace lengths.
• ChipletsTrace
• ColMatrix
  A two-dimensional matrix of field elements arranged in column-major order.
• ContextId
  Represents the ID of an execution context
• DecoderTrace
• DefaultHost
  A default Host implementation that provides the essential functionality required by the VM.
• Digest
• ExecutionOptions
  A set of parameters specifying execution parameters of the VM.
• ExecutionTrace
  Execution trace which is generated when a program is executed on the VM.
• Felt
  Represents base field element in the field using Montgomery representation.
• Kernel
  A list of procedure hashes defining a VM kernel.
• MastForest
  Represents one or more procedures, represented as a collection of MastNodes.
• MastNodeId
  An opaque handle to a MastNode in some MastForest. It is the responsibility of the user to use a given MastNodeId with the corresponding MastForest.
• MemAdviceProvider
  An in-memory [AdviceProvider] implementation which uses BTreeMaps as its backing storage.
• MemMastForestStore
  A simple MastForestStore where all known MastForests are held in memory.
• Process
  A Process is the underlying execution engine for a Miden Program.
• Program
• ProgramInfo
  A program information set consisting of its MAST root and set of kernel procedure roots used for its compilation.
• QuadExtension
  Represents an element in a quadratic extension of a StarkField.
• RangeCheckTrace
• RecAdviceProvider
  An in-memory [AdviceProvider] implementation with support for data access recording.
• RowIndex
  A newtype wrapper around a usize value representing a step in the execution trace.
• StackInputs
  Initial state of the stack to support program execution.
• StackOutputs
  Output container for Miden VM programs.
• StackTrace
• TraceLenSummary
  Contains the data about lengths of the trace parts.
• VmState
  VmState holds a current process state information at a specific clock cycle.
• VmStateIterator
  Iterator that iterates through vm state at each step of the execution. This allows debugging or replaying ability to view various process state at each clock cycle. If the execution returned an error, it returns that error on the clock cycle it stopped.

Enums

• AdviceExtractor
  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.
• AdviceInjector
  Defines a set of actions which can be initiated from the VM to inject new data into the advice provider.
• AdviceSource
  Specifies the source of the value(s) to be pushed onto the advice stack.
• DeserializationError
  Defines errors which can occur during deserialization.
• ExecutionError
• ExecutionOptionsError
• Ext2InttError
• HostResponse
  Response returned by the host upon successful execution of a Host function.
• InputError
• MastNode
• Operation
  A set of native VM operations which take exactly one cycle to execute.

Constants

• EMPTY_WORD
  Array of field elements representing word of ZEROs in the Miden base field.
• FMP_MIN
  Memory addresses for procedure locals start at 2^30.
• NUM_RAND_ROWS
  Number of rows at the end of an execution trace which are injected with random values.
• ONE
  Field element representing ONE in the Miden base filed.
• SMT_DEPTH
• SYSCALL_FMP_MIN
  Memory address for procedure locals within a SYSCALL starts at 2^31.
• ZERO
  Field element representing ZERO in the Miden base filed.

Traits

• AdviceProvider
  Defines behavior of an advice provider.
• Host
  Defines an interface by which the VM can make requests to the host.
• MastForestStore
  A set of MastForests available to the prover that programs may refer to (by means of an vm_core::mast::ExternalNode).
• ProcessState
  A trait that defines a set of methods which allow access to the state of the process.

Functions

• execute
  Returns an execution trace resulting from executing the provided program against the provided inputs.
• execute_iter
  Returns an iterator which allows callers to step through the execution and inspect VM state at each execution step.

Type Aliases

• Word
  A group of four field elements in the Miden base field.