Module note

Expand description

Contains the Client APIs related to notes. Notes can contain assets and scripts that are executed as part of transactions.

This module enables the tracking, retrieval, and processing of notes. It offers methods to query input and output notes from the store, check their consumability, compile note scripts, and retrieve notes based on partial ID matching.

§Overview

The module exposes APIs to:

Retrieve input notes and output notes.
Determine the consumability of notes using the NoteScreener.
Compile note scripts from source code with compile_note_script.
Retrieve an input note by a prefix of its ID using the helper function get_input_note_with_id_prefix.

§Example

use miden_client::{
    auth::TransactionAuthenticator,
    Client,
    crypto::FeltRng,
    note::{NoteScreener, get_input_note_with_id_prefix},
    store::NoteFilter,
};
use miden_protocol::account::AccountId;

// Retrieve all committed input notes
let input_notes = client.get_input_notes(NoteFilter::Committed).await?;
println!("Found {} committed input notes.", input_notes.len());

// Check consumability for a specific note
if let Some(note) = input_notes.first() {
    let consumability = client.get_note_consumability(note.clone()).await?;
    println!("Note consumability: {:?}", consumability);
}

// Retrieve an input note by a partial ID match
let note_prefix = "0x70b7ec";
match get_input_note_with_id_prefix(client, note_prefix).await {
    Ok(note) => println!(
        "Found note with matching prefix: {}",
        note.id().expect("note matched by ID prefix has an ID").to_hex()
    ),
    Err(err) => println!("Error retrieving note: {err:?}"),
}

// Compile the note script
let script_src = "@note_script\npub proc main\n    push.9 push.12 add\nend";
let note_script = client.code_builder().compile_note_script(script_src)?;
println!("Compiled note script successfully.");

For more details on the API and error handling, see the documentation for the specific functions and types in this module.

Modules§

standards: Raw access to miden-standards note modules for items not curated by miden-client.

Structs§

BlockNumber: A convenience wrapper around a u32 representing the number of a block.
FailedNote: Represents a failed note consumption.
InputNoteReader: A lazy iterator over consumed input notes for a specific consumer account.
InputNoteUpdate: Represents the possible states of an input note record in a NoteUpdateTracker.
MintNote: TODO: add docs
NetworkAccountTarget: A NoteAttachment for notes targeted at network accounts.
Note: A note with all the data required for it to be consumed by executing it against the transaction kernel.
NoteAssets: An asset container for a note.
NoteAttachment: The optional attachment for a Note.
NoteAttachmentContent: The content of a NoteAttachment.
NoteAttachmentHeader: The header metadata for a single note attachment.
NoteAttachmentScheme: The user-defined scheme of a NoteAttachment.
NoteAttachments: A collection of note attachments.
NoteConsumption: A note consumption event observed on chain.
NoteConsumptionInfo: Contains information about the successful and failed consumption of notes.
NoteDetails: Details of a note consisting of assets, script, storage, and a serial number.
NoteDetailsCommitment: A commitment to a note’s details, without note metadata.
NoteHeader: Holds the strictly required, public information of a note.
NoteId: The unique identifier of a note.
NoteInclusionProof: Contains the data required to prove inclusion of a note in the canonical chain.
NoteLocation: Contains information about the location of a note.
NoteMetadata: Protocol-level note metadata that combines PartialNoteMetadata with attachment information.
NoteRecipient: Value that describes under which condition a note can be consumed.
NoteScreener: Provides functionality for testing whether a note is relevant to the client or not.
NoteScript: An executable program of a note.
NoteScriptRoot: The MAST root of a NoteScript.
NoteStorage: A container for note storage items.
NoteTag: NoteTags are 32-bits of data that serve as best-effort filters for notes.
NoteUpdateTracker: Contains note changes to apply to the store.
Nullifier: A note’s nullifier.
OutputNoteUpdate: Represents the possible states of an output note record in a NoteUpdateTracker.
P2idNote: TODO: add docs
P2idNoteStorage: Canonical storage representation for a P2ID note.
P2ideNote: Pay-to-ID Extended (P2IDE) note abstraction.
P2ideNoteStorage: Canonical storage representation for a P2IDE note.
PartialNote: A note without detailed recipient information.
PartialNoteMetadata: The user-facing metadata associated with a note.
PswapNote: A partially-fillable swap note for decentralized asset exchange.
SwapNote: TODO: add docs

Enums§

MintNoteStorage: Represents the different storage formats for MINT notes.
NoteConsumptionStatus: Describes if a note could be consumed under a specific conditions: target account state and block height.
NoteError
NoteExecutionHint: Specifies the conditions under which a note is ready to be consumed. These conditions are meant to be encoded in the note script as well.
NoteFile: A serialized representation of a note.
NoteScreenerError: Error when screening notes to check relevance to a client.
NoteType
NoteUpdateType: Represents the possible types of updates that can be applied to a note in a NoteUpdateTracker.
StandardNote: The enum holding the types of standard notes provided by miden-standards.

Traits§

ToInputNoteCommitments: Specifies the data used by the transaction kernel to commit to a note.

Functions§

get_input_note_with_id_prefix: Returns the client input note whose ID starts with note_id_prefix.

Type Aliases§

NoteConsumability: Represents the consumability of a note by a specific account.

Module note

Module note Copy item path

§Overview

§Example

Modules§

Structs§

Enums§

Traits§

Functions§

Type Aliases§

Module note