Modules§
- account
- address
- assembly
- asset
- batch
- block
- crypto
- note
- transaction
- utils
- vm
- word
- A Word type used in the Miden protocol and associated utilities.
Macros§
Structs§
- Felt
- Represents base field element in the field using Montgomery representation.
- Hasher
- Implementation of the Rescue Prime Optimized hash function with 256-bit output.
- Lexicographic
Word - A
Wordwrapper with lexicographic ordering. - Mast
Forest - Represents one or more procedures, represented as a collection of
MastNodes. - Mast
Node Id - An opaque handle to a
MastNodein someMastForest. It is the responsibility of the user to use a givenMastNodeIdwith the correspondingMastForest. - Word
- A unit of data consisting of 4 field elements.
Enums§
- Account
Delta Error - Account
Error - Account
IdError - Account
Tree Error - Address
Error - Asset
Error - Asset
Vault Error - Batch
Account Update Error - FeeError
- Network
IdError - Note
Error - Nullifier
Tree Error - Partial
Blockchain Error - Proposed
Batch Error - Proposed
Block Error - Proven
Batch Error - Proven
Transaction Error - Token
Symbol Error - Transaction
Input Error - Transaction
Output Error - Transaction
Script Error - Word
Error - 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§
- Field
Element - Defines an element in a finite field.
- Pretty
Print - The PrettyPrint trait is used as a building block for pretty printing data or syntax trees, as commonly seen in tools like Prettier.
- Stark
Field - Defines an element in a STARK-friendly finite field.