Struct miden_objects::notes::NoteId

pub struct NoteId(/* private fields */);

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

Note ID is computed as:

hash(recipient, asset_hash),

where recipient is defined as: hash(hash(hash(serial_num, [0; 4]), script_hash), input_hash)

This achieves the following properties:

• Every note can be reduced to a single unique ID.
• To compute a note ID, we do not need to know the note’s serial_num. Knowing the hash of the serial_num (as well as script hash, input hash, and note assets) is sufficient.

Implementations

impl NoteId

pub fn new(recipient: Digest, asset_commitment: Digest) -> Self

Returns a new NoteId instantiated from the provided note components.

pub fn as_elements(&self) -> &[Felt]

Returns the elements representation of this note ID.

pub fn as_bytes(&self) -> [u8; 32]

Returns the byte representation of this note ID.

pub fn to_hex(&self) -> String

Returns a big-endian, hex-encoded string.

pub fn inner(&self) -> Digest

Returns the digest defining this note ID.

impl NoteId

pub fn try_from_hex(hex_value: &str) -> Result<NoteId, HexParseError>

Attempts to convert from a hexadecimal string to NoteId.

Trait Implementations

impl Clone for NoteId

fn clone(&self) -> NoteId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NoteId

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

Formats the value using the given formatter.

impl Deserializable for NoteId

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 NoteId

fn from(note: &Note) -> Self

Converts to this type from the input type.

impl From<&NoteId> for Word

fn from(id: &NoteId) -> Self

Converts to this type from the input type.

impl From<&NoteId> for [u8; 32]

fn from(id: &NoteId) -> Self

Converts to this type from the input type.

impl From<[BaseElement; 4]> for NoteId

fn from(value: Word) -> Self

Converts to this type from the input type.

impl From<RpoDigest> for NoteId

fn from(value: Digest) -> Self

Converts to this type from the input type.

impl From<NoteId> for Word

fn from(id: NoteId) -> Self

Converts to this type from the input type.

impl From<NoteId> for [u8; 32]

fn from(id: NoteId) -> Self

Converts to this type from the input type.

impl Ord for NoteId

fn cmp(&self, other: &NoteId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for NoteId

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

fn partial_cmp(&self, other: &NoteId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serializable for NoteId

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 Copy for NoteId

impl Eq for NoteId

impl StructuralPartialEq for NoteId