Enum WellKnownNote 

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

The enum holding the types of basic well-known notes provided by the miden-lib.

Variants

P2ID

P2IDE

SWAP

MINT

BURN

Implementations

impl WellKnownNote

pub fn from_note(note: &Note) -> Option<WellKnownNote>

Returns a WellKnownNote instance based on the note script of the provided Note. Returns None if the provided note is not a basic well-known note.

pub fn num_expected_inputs(&self) -> usize

Returns the expected inputs number of the active note.

pub fn script(&self) -> NoteScript

Returns the note script of the current WellKnownNote instance.

pub fn script_root(&self) -> Word

Returns the script root of the current WellKnownNote instance.

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

Returns a boolean value indicating whether this WellKnownNote 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 well-known 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.