Struct miden_objects::notes::Note

pub struct Note { /* private fields */ }

A note which can be used to transfer assets between accounts.

This struct is a full description of a note which is needed to execute a note in a transaction. A note consists of:

Core on-chain data which is used to execute a note:

• A script which must be executed in a context of some account to claim the assets.
• A set of inputs which can be read to memory during script execution via the invocation of the note::get_inputs in the kernel API.
• A set of assets stored in the note.
• A serial number which can be used to break linkability between note hash and note nullifier.

Auxiliary data which is used to verify authenticity and signal additional information:

• A metadata object which contains information about the sender, the tag and the number of assets in the note.

Implementations

impl Note

pub fn new( script: NoteScript, inputs: &[Felt], assets: &[Asset], serial_num: Word, sender: AccountId, tag: Felt ) -> Result<Self, NoteError>

Returns a new note created with the specified parameters.

Errors

Returns an error if:

• The number of inputs exceeds 16.
• The number of provided assets exceeds 1000.
• The list of assets contains duplicates.

pub fn from_parts( script: NoteScript, inputs: NoteInputs, assets: NoteAssets, serial_num: Word, metadata: NoteMetadata ) -> Self

Returns a note instance created from the provided parts.

pub fn script(&self) -> &NoteScript

Returns a reference script which locks the assets of this note.

pub fn inputs(&self) -> &NoteInputs

Returns a reference to the note inputs.

pub fn assets(&self) -> &NoteAssets

Returns a reference to the asset of this note.

pub fn serial_num(&self) -> Word

Returns a serial number of this note.

pub fn metadata(&self) -> &NoteMetadata

Returns the metadata associated with this note.

pub fn recipient(&self) -> Digest

Returns the recipient of this note.

Recipient is defined and calculated as:

hash(hash(hash(serial_num, [0; 4]), script_hash), input_hash)

pub fn id(&self) -> NoteId

Returns a unique identifier of this note, which is simultaneously a commitment to the note.

pub fn authentication_hash(&self) -> Digest

Returns the value used to authenticate a notes existence in the note tree. This is computed as a 2-to-1 hash of the note hash and note metadata [hash(note_id, note_metadata)]

pub fn nullifier(&self) -> Nullifier

Returns the nullifier for this note.

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 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 NoteEnvelope

fn from(note: &Note) -> Self

Converts to this type from the input type.

impl From<&Note> for NoteId

fn from(note: &Note) -> Self

Converts to this type from the input type.

impl From<&Note> for Nullifier

fn from(note: &Note) -> Self

Converts to this type from the input type.

impl From<&Note> for OutputNote

fn from(note: &Note) -> Self

Converts to this type from the input type.

impl From<Note> for NoteEnvelope

fn from(note: Note) -> Self

Converts to this type from the input type.

impl From<Note> for OutputNote

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