Enum WellKnownNote

pub enum WellKnownNote {
    P2ID,
    P2IDR,
    SWAP,
}

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

Variants

P2ID

P2IDR

SWAP

Implementations

impl WellKnownNote

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

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 current note.

pub fn script(&self) -> NoteScript

Returns the note script of the current WellKnownNote instance.

pub fn script_root(&self) -> Digest

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 check_note_inputs( &self, note: &Note, target_account_id: AccountId, block_ref: BlockNumber, ) -> NoteAccountCompatibility

Checks the correctness of the provided note inputs against the target account.

It performs:

• for all notes: a check that note inputs have correct number of values.
• for P2ID note: assertion that the account ID provided by the note inputs is equal to the target account ID.
• for P2IDR note: assertion that the account ID provided by the note inputs is equal to the target account ID (which means that the note is going to be consumed by the target account) or that the target account ID is equal to the sender account ID (which means that the note is going to be consumed by the sender account)