Struct AssetVaultKey 

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

The key of an Asset in the asset vault.

The layout of an asset key is:

• Fungible asset key: [0, 0, faucet_id_suffix, faucet_id_prefix].
• Non-fungible asset key: [faucet_id_prefix, hash1, hash2, hash0'], where hash0' is equivalent to hash0 with the fungible bit set to 0. See NonFungibleAsset::vault_key for more details.

For details on the layout of an asset, see the documentation of Asset.

Guarantees

This type guarantees that it contains a valid fungible or non-fungible asset key:

• For fungible assets
  • The felt at index 3 has the fungible bit set to 1 and it is a valid account ID prefix.
  • The felt at index 2 is a valid account ID suffix.
• For non-fungible assets
  • The felt at index 3 has the fungible bit set to 0.
  • The felt at index 0 is a valid account ID prefix.

The fungible bit is the bit in the AccountId that encodes whether the ID is a faucet.

Implementations

impl AssetVaultKey

pub fn new_unchecked(value: Word) -> Self

Creates a new AssetVaultKey from the given Word without performing validation.

Warning

This function does not check whether the provided Word represents a valid fungible or non-fungible asset key.

pub fn faucet_id_prefix(&self) -> AccountIdPrefix

Returns an AccountIdPrefix from the asset key.

pub fn faucet_id(&self) -> Option<AccountId>

Returns the AccountId from the asset key if it is a fungible asset, None otherwise.

pub fn to_leaf_index(&self) -> LeafIndex<SMT_DEPTH>

Returns the leaf index of a vault key.

pub fn from_account_id(faucet_id: AccountId) -> Option<Self>

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

Returns None if the provided ID is not of type AccountType::FungibleFaucet

Trait Implementations

impl Clone for AssetVaultKey

fn clone(&self) -> AssetVaultKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AssetVaultKey

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

Formats the value using the given formatter.

impl Display for AssetVaultKey

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

Formats the value using the given formatter.

impl From<Asset> for AssetVaultKey

fn from(asset: Asset) -> Self

Converts to this type from the input type.

impl From<AssetVaultKey> for Word

fn from(vault_key: AssetVaultKey) -> Self

Converts to this type from the input type.

impl From<FungibleAsset> for AssetVaultKey

fn from(fungible_asset: FungibleAsset) -> Self

Converts to this type from the input type.

impl From<NonFungibleAsset> for AssetVaultKey

fn from(non_fungible_asset: NonFungibleAsset) -> Self

Converts to this type from the input type.

impl Ord for AssetVaultKey

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

Restrict a value to a certain interval.

impl PartialEq for AssetVaultKey

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for AssetVaultKey

fn partial_cmp(&self, other: &AssetVaultKey) -> 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 Copy for AssetVaultKey

impl Eq for AssetVaultKey

impl StructuralPartialEq for AssetVaultKey