Struct AssetId 

pub struct AssetId { /* private fields */ }

The unique identifier of an Asset in the AssetVault.

Its Word layout is:

[
  asset_class_suffix (64 bits),
  asset_class_prefix (64 bits),
  [faucet_id_suffix (56 bits) | reserved (6 bits) | composition (2 bits)],
  faucet_id_prefix (64 bits)
]

The composition is the discriminator between assets and so it is placed at a static offset much like the version in an account ID. This makes it slightly easier to change the asset metadata in the future without affecting identification of previous assets.

Use AssetId::hash to produce the corresponding AssetIdHash that is used as the key in the asset vault’s underlying SMT. Hashing ensures a uniform distribution across leaves regardless of how faucet IDs or asset classes are chosen.

Implementations

impl AssetId

pub const SERIALIZED_SIZE: usize = Word::SERIALIZED_SIZE

The serialized size of an AssetId in bytes.

Serialized as its Word representation (4 field elements).

pub fn new( asset_class: AssetClass, faucet_id: AccountId, composition: AssetComposition, ) -> Result<Self, AssetError>

Creates an AssetId from its parts with the given AssetComposition.

Errors

Returns an error if:

• the asset class limbs are not zero when composition is AssetComposition::Fungible.
• the composition is AssetComposition::Custom, which is disallowed until its support is enabled in the tx kernel.

pub fn new_fungible(faucet_id: AccountId) -> Self

Constructs a fungible asset’s ID from a faucet ID.

pub fn to_word(&self) -> Word

Returns the word representation of the asset ID.

See the type-level documentation for details.

pub fn asset_class(&self) -> AssetClass

Returns the AssetClass of the asset ID that distinguishes different assets issued by the same faucet.

pub fn faucet_id(&self) -> AccountId

Returns the AccountId of the faucet that issued the asset.

pub fn callback_flag(&self) -> AssetCallbackFlag

Returns the AssetCallbackFlag of the faucet that issued the asset.

pub fn composition(&self) -> AssetComposition

Returns the AssetComposition of the asset ID.

pub fn hash(&self) -> AssetIdHash

Hashes this raw asset ID to produce the AssetIdHash used as the key in the asset vault’s underlying SMT.

Trait Implementations

impl Clone for AssetId

fn clone(&self) -> AssetId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for AssetId

impl Debug for AssetId

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

Formats the value using the given formatter.

impl Deserializable for AssetId

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 min_serialized_size() -> usize

Returns the minimum serialized size for one instance of this type.

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

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

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

Deserializes Self from bytes with a byte budget limit.

impl Display for AssetId

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

Formats the value using the given formatter.

impl Eq for AssetId

impl From<Asset> for AssetId

fn from(asset: Asset) -> Self

Converts to this type from the input type.

impl From<AssetId> for AssetIdHash

fn from(id: AssetId) -> Self

Converts to this type from the input type.

impl From<AssetId> for Word

fn from(asset_id: AssetId) -> Self

Converts to this type from the input type.

impl From<FungibleAsset> for AssetId

fn from(fungible_asset: FungibleAsset) -> Self

Converts to this type from the input type.

impl From<NonFungibleAsset> for AssetId

fn from(non_fungible_asset: NonFungibleAsset) -> Self

Converts to this type from the input type.

impl Ord for AssetId

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

Implements comparison based on the Word representation.

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,

Restrict a value to a certain interval.

impl PartialEq for AssetId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for AssetId

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serializable for AssetId

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

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

fn get_size_hint(&self) -> usize

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

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

Serializes self into a vector of bytes.

impl StructuralPartialEq for AssetId

impl TryFrom<Word> for AssetId

fn try_from(id: Word) -> Result<Self, Self::Error>

Attempts to convert the provided Word into an AssetId.

Errors

Returns an error if:

• the asset class limbs are not zero when asset composition is AssetComposition::Fungible.
• the metadata byte has reserved bits set.
• the composition encoded in the metadata byte is invalid.

type Error = AssetError

The type returned in the event of a conversion error.