Enum StandardNote 

pub enum StandardNote {
    P2ID,
    P2IDE,
    SWAP,
    MINT,
    BURN,
}

The enum holding the types of standard notes provided by miden-standards.

Variants

P2ID

P2IDE

SWAP

MINT

BURN

Implementations

impl StandardNote

pub fn from_script(script: &NoteScript) -> Option<StandardNote>

Returns a StandardNote instance based on the provided NoteScript. Returns None if the provided script does not match any standard note script.

pub fn from_script_root(root: Word) -> Option<StandardNote>

Returns a StandardNote instance based on the provided script root. Returns None if the provided root does not match any standard note script.

pub fn name(&self) -> &'static str

Returns the name of this StandardNote variant as a string.

pub fn expected_num_storage_items(&self) -> usize

Returns the expected number of storage items of the active note.

pub fn script(&self) -> NoteScript

Returns the note script of the current StandardNote instance.

pub fn script_root(&self) -> Word

Returns the script root of the current StandardNote instance.

pub fn is_compatible_with(&self, account_interface: &AccountInterface) -> bool

Returns a boolean value indicating whether this StandardNote is compatible with the provided AccountInterface.

pub fn is_consumable( &self, note: &Note, target_account_id: AccountId, block_ref: BlockNumber, ) -> Option<NoteConsumptionStatus>

Performs the inputs check of the provided standard note against the target account and the block number.

This function returns:

• Some if we can definitively determine whether the note can be consumed not by the target account.
• None if the consumption status of the note cannot be determined conclusively and further checks are necessary.