Struct AssetVaultKey 

pub struct AssetVaultKey { /* private fields */ }

The unique identifier of an Asset in the AssetVault.

Its Word layout is:

[
  asset_id_suffix (64 bits),
  asset_id_prefix (64 bits),
  [faucet_id_suffix (56 bits) | 7 zero bits | callbacks_enabled (1 bit)],
  faucet_id_prefix (64 bits)
]

Implementations

impl AssetVaultKey

pub const SERIALIZED_SIZE: usize = Word::SERIALIZED_SIZE

The serialized size of an AssetVaultKey in bytes.

Serialized as its Word representation (4 field elements).

pub fn new_native( asset_id: AssetId, faucet_id: AccountId, ) -> Result<AssetVaultKey, AssetError>

Creates an AssetVaultKey for a native asset with callbacks disabled.

Errors

Returns an error if:

• the provided ID is not of type AccountType::FungibleFaucet or AccountType::NonFungibleFaucet
• the asset ID limbs are not zero when faucet_id is of type AccountType::FungibleFaucet.

pub fn new( asset_id: AssetId, faucet_id: AccountId, callback_flag: AssetCallbackFlag, ) -> Result<AssetVaultKey, AssetError>

Creates an AssetVaultKey from its parts with the given AssetCallbackFlag.

Errors

Returns an error if:

• the provided ID is not of type AccountType::FungibleFaucet or AccountType::NonFungibleFaucet
• the asset ID limbs are not zero when faucet_id is of type AccountType::FungibleFaucet.

pub fn to_word(&self) -> Word

Returns the word representation of the vault key.

See the type-level documentation for details.

pub fn asset_id(&self) -> AssetId

Returns the AssetId of the vault key 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 flag of the vault key.

pub fn new_fungible(faucet_id: AccountId) -> Option<AssetVaultKey>

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

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

pub fn to_leaf_index( &self, ) -> LeafIndex<miden_protocol::::asset::vault::vault_key::{impl#0}::to_leaf_index::{constant#1}>

Returns the leaf index of a vault key.

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<(), Error>

Formats the value using the given formatter.

impl Deserializable for AssetVaultKey

fn read_from<R>(source: &mut R) -> Result<AssetVaultKey, 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 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 AssetVaultKey

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

Formats the value using the given formatter.

impl From<Asset> for AssetVaultKey

fn from(asset: Asset) -> AssetVaultKey

Converts to this type from the input type.

impl From<AssetVaultKey> for Word

fn from(vault_key: AssetVaultKey) -> Word

Converts to this type from the input type.

impl From<FungibleAsset> for AssetVaultKey

fn from(fungible_asset: FungibleAsset) -> AssetVaultKey

Converts to this type from the input type.

impl From<NonFungibleAsset> for AssetVaultKey

fn from(non_fungible_asset: NonFungibleAsset) -> AssetVaultKey

Converts to this type from the input type.

impl Ord for AssetVaultKey

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

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

where W: ByteWriter,

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 TryFrom<Word> for AssetVaultKey

fn try_from( key: Word, ) -> Result<AssetVaultKey, <AssetVaultKey as TryFrom<Word>>::Error>

Attempts to convert the provided Word into an AssetVaultKey.

Errors

Returns an error if:

• the faucet ID in the key is invalid or not of a faucet type.
• the asset ID limbs are not zero when faucet_id is of type AccountType::FungibleFaucet.

type Error = AssetError

The type returned in the event of a conversion error.

impl Copy for AssetVaultKey

impl Eq for AssetVaultKey

impl StructuralPartialEq for AssetVaultKey