Struct miden_objects::assets::AssetVault

pub struct AssetVault { /* private fields */ }

A container for an unlimited number of assets.

An asset vault can contain an unlimited number of assets. The assets are stored in a Sparse Merkle tree as follows:

• For fungible assets, the index of a node is defined by the issuing faucet ID, and the value of the node is the asset itself. Thus, for any fungible asset there will be only one node in the tree.
• For non-fungible assets, the index is defined by the asset itself, and the asset is also the value of the node.

An asset vault can be reduced to a single hash which is the root of the Sparse Merkle Tree.

Implementations

impl AssetVault

pub fn new(assets: &[Asset]) -> Result<Self, AssetVaultError>

Returns a new AssetVault initialized with the provided assets.

pub fn commitment(&self) -> Digest

Returns a commitment to this vault.

pub fn has_non_fungible_asset( &self, asset: Asset ) -> Result<bool, AssetVaultError>

Returns true if the specified non-fungible asset is stored in this vault.

pub fn get_balance(&self, faucet_id: AccountId) -> Result<u64, AssetVaultError>

Returns the balance of the asset issued by the specified faucet. If the vault does not contain such an asset, 0 is returned.

Errors

Returns an error if the specified ID is not an ID of a fungible asset faucet.

pub fn assets(&self) -> impl Iterator<Item = Asset> + '_

Returns an iterator over the assets stored in the vault.

pub fn asset_tree(&self) -> &Smt

Returns a reference to the Sparse Merkle Tree underling this asset vault.

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

Add the specified asset to the vault.

Errors

• If the total value of two fungible assets is greater than or equal to 2^63.
• If the vault already contains the same non-fungible asset.

pub fn remove_asset(&mut self, asset: Asset) -> Result<Asset, AssetVaultError>

Remove the specified asset from the vault.

Errors

• The fungible asset is not found in the vault.
• The amount of the fungible asset in the vault is less than the amount to be removed.
• The non-fungible asset is not found in the vault.

Trait Implementations

impl Clone for AssetVault

fn clone(&self) -> AssetVault

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AssetVault

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

Formats the value using the given formatter.

impl Default for AssetVault

fn default() -> AssetVault

Returns the “default value” for a type.

impl Deserializable for AssetVault

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 PartialEq for AssetVault

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

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 Eq for AssetVault

impl StructuralPartialEq for AssetVault