Struct miden_objects::notes::NoteDetails

pub struct NoteDetails { /* private fields */ }

Details of a note consisting of assets, script, inputs, and a serial number.

See super::Note for more details.

Implementations

impl NoteDetails

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

Returns a new note created with the specified parameters.

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.

pub fn into_parts(self) -> (NoteAssets, NoteRecipient)

Decomposes note details into underlying assets and recipient.

Trait Implementations

impl Clone for NoteDetails

fn clone(&self) -> NoteDetails

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NoteDetails

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

Formats the value using the given formatter.

impl Deserializable for NoteDetails

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<&NoteDetails> for NoteId

fn from(note: &NoteDetails) -> Self

Converts to this type from the input type.

impl From<&NoteDetails> for Nullifier

fn from(note: &NoteDetails) -> 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<NoteDetails> for NoteFile

fn from(details: NoteDetails) -> Self

Converts to this type from the input type.

impl PartialEq for NoteDetails

fn eq(&self, other: &NoteDetails) -> 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 NoteDetails

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 NoteDetails

impl StructuralPartialEq for NoteDetails