Crate miden_protocol 

Modules

account

address

assembly

asset

batch

block

crypto

errors

note

transaction

utils

vm

word

A Word type used in the Miden protocol and associated utilities.

Macros

word

Construct a new Word from a hex value.

Structs

CoreLibrary

TODO: add docs

Felt

Represents base field element in the field using Montgomery representation.

Hasher

Implementation of the Rescue Prime Optimized hash function with 256-bit output.

LexicographicWord

A Word wrapper with lexicographic ordering.

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.

ProtocolLib

Word

A unit of data consisting of 4 field elements.

Enums

WordError

Errors that can occur when working with a Word.

Constants

ACCOUNT_TREE_DEPTH

Depth of the account database tree.

ACCOUNT_UPDATE_MAX_SIZE

The maximum allowed size of an account update is 256 KiB.

BATCH_NOTE_TREE_DEPTH

The depth of the Sparse Merkle Tree used to store output notes in a single batch.

BLOCK_NOTE_TREE_DEPTH

The final depth of the Sparse Merkle Tree used to store all notes created in a block.

EMPTY_WORD

Array of field elements representing word of ZEROs in the Miden base field.

MAX_ACCOUNTS_PER_BATCH

The maximum number of accounts that can be updated in a single batch.

MAX_ACCOUNTS_PER_BLOCK

The maximum number of accounts that can be updated in a single block.

MAX_ASSETS_PER_NOTE

The maximum number of assets that can be stored in a single note.

MAX_BATCHES_PER_BLOCK

Maximum number of batches that can be inserted into a single block.

MAX_INPUTS_PER_NOTE

The maximum number of inputs that can accompany a single note.

MAX_INPUT_NOTES_PER_BATCH

The maximum number of input notes that can be consumed in a single batch.

MAX_INPUT_NOTES_PER_BLOCK

Maximum number of input notes that can be consumed in a single block.

MAX_INPUT_NOTES_PER_TX

The maximum number of notes that can be consumed by a single transaction.

MAX_NUM_FOREIGN_ACCOUNTS

Maximum number of the foreign accounts that can be loaded.

MAX_OUTPUT_NOTES_PER_BATCH

The maximum number of notes that can be created in a single batch.

MAX_OUTPUT_NOTES_PER_BLOCK

Maximum number of output notes that can be created in a single block.

MAX_OUTPUT_NOTES_PER_TX

The maximum number of new notes created by a single transaction.

MAX_TX_EXECUTION_CYCLES

The maximum number of VM cycles a transaction is allowed to take.

MIN_PROOF_SECURITY_LEVEL

The minimum proof security level used by the Miden prover & verifier.

MIN_TX_EXECUTION_CYCLES

The minimum number of VM cycles a transaction needs to execute.

ONE

Field element representing ONE in the Miden base filed.

WORD_SIZE

Number of field elements in a word.

ZERO

Field element representing ZERO in the Miden base filed.

Traits

FieldElement

Defines an element in a finite field.

PrettyPrint

The PrettyPrint trait is used as a building block for pretty printing data or syntax trees, as commonly seen in tools like Prettier.

StarkField

Defines an element in a STARK-friendly finite field.