Struct miden_client::notes::NoteAssets

pub struct NoteAssets { /* private fields */ }

An asset container for a note.

A note must contain at least 1 asset and can contain up to 256 assets. No duplicates are allowed, but the order of assets is unspecified.

All the assets in a note can be reduced to a single commitment which is computed by sequentially hashing the assets. Note that the same list of assets can result in two different commitments if the asset ordering is different.

Implementations

impl NoteAssets

pub const MAX_NUM_ASSETS: usize = 256usize

The maximum number of assets which can be carried by a single note.

pub fn new(assets: Vec<Asset>) -> Result<NoteAssets, NoteError>

Returns new NoteAssets constructed from the provided list of assets.

Errors

Returns an error if:

• The list contains more than 256 assets.
• There are duplicate assets in the list.

pub fn commitment(&self) -> RpoDigest

Returns a commitment to the note’s assets.

pub fn num_assets(&self) -> usize

Returns the number of assets.

pub fn is_empty(&self) -> bool

Returns true if the number of assets is 0.

pub fn iter(&self) -> Iter<'_, Asset>

Returns an iterator over all assets.

pub fn to_padded_assets(&self) -> Vec<BaseElement>

Returns all assets represented as a vector of field elements.

The vector is padded with ZEROs so that its length is a multiple of 8. This is useful because hashing the returned elements results in the note asset commitment.

pub fn add_asset(&mut self, asset: Asset) -> Result<(), NoteError>

Adds the provided asset to this list of note assets.

Errors

Returns an error if:

• The same non-fungible asset is already in the list.
• A fungible asset issued by the same faucet exists in the list and adding both assets together results in an invalid asset.
• Adding the asset to the list will push the list beyond the Self::MAX_NUM_ASSETS limit.

Trait Implementations

impl Clone for NoteAssets

fn clone(&self) -> NoteAssets

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NoteAssets

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

Formats the value using the given formatter.

impl Default for NoteAssets

fn default() -> NoteAssets

Returns the “default value” for a type.

impl Deserializable for NoteAssets

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

where R: ByteReader,

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<'de> Deserialize<'de> for NoteAssets

fn deserialize<__D>( __deserializer: __D, ) -> Result<NoteAssets, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for NoteAssets

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

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

where W: ByteWriter,

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 Serialize for NoteAssets

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for NoteAssets