Struct miden_objects::notes::Note

pub struct Note { /* private fields */ }

A note with all the data required for it to be consumed by executing it against the transaction kernel.

Notes consist of note metadata and details. Note metadata is always public, but details may be either public, encrypted, or private, depending on the note type. Note details consist of note assets, script, inputs, and a serial number, the three latter grouped into a recipient object.

Note details can be reduced to two unique identifiers: NoteId and Nullifier. The former is publicly associated with a note, while the latter is known only to entities which have access to full note details.

Fungible and non-fungible asset transfers are done by moving assets to the note’s assets. The note’s script determines the conditions required for the note consumption, i.e. the target account of a P2ID or conditions of a SWAP, and the effects of the note. The serial number has a double duty of preventing double spend, and providing unlikability to the consumer of a note. The note’s inputs allow for customization of its script.

To create a note, the kernel does not require all the information above, a user can create a note only with the commitment to the script, inputs, the serial number (i.e., the recipient), and the kernel only verifies the source account has the assets necessary for the note creation. See NoteRecipient for more details.

Implementations

impl Note

pub fn new( assets: NoteAssets, metadata: NoteMetadata, recipient: NoteRecipient ) -> Self

Returns a new Note created with the specified parameters.

pub fn header(&self) -> &NoteHeader

Returns the note’s header.

pub fn id(&self) -> NoteId

Returns the note’s unique identifier.

This value is both an unique identifier and a commitment to the note.

pub fn metadata(&self) -> &NoteMetadata

Returns the note’s metadata.

pub fn assets(&self) -> &NoteAssets

Returns the note’s assets.

pub fn serial_num(&self) -> Word

Returns the note’s recipient serial_num, the secret required to consume the note.

pub fn script(&self) -> &NoteScript

Returns the note’s recipient script which locks the assets of this note.

pub fn inputs(&self) -> &NoteInputs

Returns the note’s recipient inputs which customizes the script’s behavior.

pub fn recipient(&self) -> &NoteRecipient

Returns the note’s recipient.

pub fn nullifier(&self) -> Nullifier

Returns the note’s nullifier.

This is public data, used to prevent double spend.

pub fn authentication_hash(&self) -> Digest

Returns the note’s authentication hash.

This value is used authenticate the note’s presence in the note tree, it is computed as:

hash(note_id, note_metadata)

Methods from Deref<Target = NoteDetails>

pub fn id(&self) -> NoteId

Returns the note’s unique identifier.

This value is both an unique identifier and a commitment to the note.

pub fn assets(&self) -> &NoteAssets

Returns the note’s assets.

pub fn serial_num(&self) -> Word

Returns the note’s recipient serial_num, the secret required to consume the note.

pub fn script(&self) -> &NoteScript

Returns the note’s recipient script which locks the assets of this note.

pub fn inputs(&self) -> &NoteInputs

Returns the note’s recipient inputs which customizes the script’s behavior.

pub fn recipient(&self) -> &NoteRecipient

Returns the note’s recipient.

pub fn nullifier(&self) -> Nullifier

Returns the note’s nullifier.

This is public data, used to prevent double spend.

Trait Implementations

impl Clone for Note

fn clone(&self) -> Note

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Note

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for Note

type Target = NoteDetails

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Deserializable for Note

fn read_from<R: ByteReader>( source: &mut R ) -> Result<Self, DeserializationError>

Reads a sequence of bytes from the provided source, attempts to deserialize these bytes into Self, and returns the result.

fn read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

Attempts to deserialize the provided bytes into Self and returns the result.

impl From<&Note> for NoteDetails

fn from(note: &Note) -> Self

Converts to this type from the input type.

impl From<&Note> for NoteHeader

fn from(note: &Note) -> Self

Converts to this type from the input type.

impl From<Note> for NoteDetails

fn from(note: Note) -> Self

Converts to this type from the input type.

impl From<Note> for NoteHeader

fn from(note: Note) -> Self

Converts to this type from the input type.

impl PartialEq for Note

fn eq(&self, other: &Note) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serializable for Note

fn write_into<W: ByteWriter>(&self, target: &mut W)

Serializes self into bytes and writes these bytes into the target.

fn to_bytes(&self) -> Vec<u8>

Serializes self into a vector of bytes.

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self.

impl Eq for Note

impl StructuralPartialEq for Note