package note

Get desktop application:
View/edit binary Protocol Buffers messages

Represents a committed note. A committed note is a note that has been included in a block.

Used in: CommittedNoteList

• optional Note note = 1

  Either private, public, or network note.

• optional NoteInclusionInBlockProof inclusion_proof = 2

  The data needed to prove that the note is present in the chain.

Represents the result of getting committed notes.

Used as response type in: rpc.Api.GetNotesById

• repeated CommittedNote notes = 1

  List of committed notes.

Represents a network note. Network notes are a subtype of public notes, and as such, their details are always publicly known.

• optional NoteMetadata metadata = 1

  The note's metadata.

• bytes details = 2

  Serialized note details (i.e., assets and recipient).

• bytes attachments = 3

  Serialized `miden_protocol::note::NoteAttachments`. Empty bytes encode an empty collection.

Represents a note. The note is composed of the note metadata, its serialized details, and serialized attachments.

Used in: CommittedNote

• optional NoteMetadata metadata = 1

  The note's metadata.

• optional bytes details = 2

  Serialized note details (empty for private notes).

• bytes attachments = 3

  Serialized `miden_protocol::note::NoteAttachments`. Empty bytes encode an empty collection.

Represents a note header. A note header consists of a commitment to the note's details and its metadata.

Used in: transaction.InputNoteCommitment, transaction.TransactionHeader

• optional primitives.Digest details_commitment = 1

  Commitment to the note's details (recipient + assets), excluding metadata.

• optional NoteMetadata metadata = 2

  The note's metadata.

Represents a note's ID.

Used as request type in: ntx_builder.Api.GetNetworkNoteStatus, rpc.Api.GetNetworkNoteStatus

Used as field type in: NoteIdList, NoteInclusionInBlockProof, rpc.ConsumedNoteRef

• optional primitives.Digest id = 1

  A unique identifier of the note which is a 32-byte commitment to the underlying note data.

List of note IDs.

Used as request type in: rpc.Api.GetNotesById

• repeated NoteId ids = 1

  List of note IDs to be queried from the database.

Represents a proof of note's inclusion in a block. Does not include proof of the block's inclusion in the chain.

Used in: CommittedNote, NoteSyncRecord, rpc.TransactionRecord

• optional NoteId note_id = 1

  A unique identifier of the note which is a 32-byte commitment to the underlying note data.

• fixed32 block_num = 2

  The block number in which the note was created.

• uint32 note_index_in_block = 3

  The index of the note in the block.

• optional primitives.SparseMerklePath inclusion_path = 4

  The note's inclusion proof in the block.

Represents a note's metadata. Mirrors the protocol-level `miden_protocol::note::NoteMetadata`: it carries the partial metadata (sender, note type, tag), the per-slot attachment schemes, and the commitment over the note's attachments. The full attachment contents (when present) are carried separately on `Note` / `NetworkNote`.

Used in: NetworkNote, Note, NoteHeader

• optional account.AccountId sender = 1

  The account which sent the note.

• NoteType note_type = 2

  The type of the note.

• fixed32 tag = 3

  A value which can be used by the recipient(s) to identify notes intended for them. See `miden_protocol::note::note_tag` for more info.

• repeated fixed32 attachment_schemes = 4

  The attachment scheme of each attachment slot. The protocol allows up to `NoteAttachments::MAX_COUNT` attachments per note. Each slot carries either a scheme value in `1..=65534` or `0` to indicate that the slot is absent. Trailing absent slots may be omitted, so a note with no attachments has an empty list. See `miden_protocol::note::NoteAttachmentHeader` for more info.

• optional primitives.Digest attachments_commitment = 5

  Commitment over the note's attachments. See `miden_protocol::note::NoteAttachments::to_commitment` for more info.

Represents a note script.

Used in: rpc.MaybeNoteScript

• uint32 entrypoint = 1

  Entrypoint of the script.

• bytes mast = 2

  MAST of the script.

Represents a commitment to a note script.

Used as request type in: rpc.Api.GetNoteScriptByRoot

• optional primitives.Digest root = 1

  Root of the note script.

Represents an attachment in a note sync response. Single-word attachments carry their value directly. Larger attachments carry only their commitment, keeping their size bounded while allowing clients to reconstruct the note metadata.

Used in: NoteSyncMetadata

• fixed32 scheme = 1

  The attachment scheme.

• oneof payload

  • primitives.Digest value = 2

    The raw content of a single-word attachment.

  • primitives.Digest commitment = 3

    The commitment to the content of a multi-word attachment.

Represents note metadata in a note sync response. Clients can reconstruct the protocol-level `NoteMetadata` by deriving the commitment of each attachment value and aggregating it with the commitments of larger attachments.

Used in: NoteSyncRecord

• optional account.AccountId sender = 1

  The account which sent the note.

• NoteType note_type = 2

  The type of the note.

• fixed32 tag = 3

  A value which can be used by the recipient(s) to identify notes intended for them.

• repeated NoteSyncAttachment attachments = 4

  The note's attachments in canonical order.

Represents a note's sync metadata together with proof of inclusion in a block.

Used in: rpc.SyncNotesResponse.NoteSyncBlock

• optional NoteSyncMetadata metadata = 1

  The sync metadata of the note.

• optional NoteInclusionInBlockProof inclusion_proof = 2

  Proof of the note's inclusion in a block.

The type of a note.

Used in: NoteMetadata, NoteSyncMetadata

• NOTE_TYPE_UNSPECIFIED = 0

  Unspecified note type (default value, should not be used).

• NOTE_TYPE_PUBLIC = 1

  Public note - details are visible on-chain.

• NOTE_TYPE_PRIVATE = 2

  Private note - details are not visible on-chain.