Struct miden_objects::assets::FungibleAsset

pub struct FungibleAsset { /* private fields */ }

A fungible asset.

A fungible asset consists of a faucet ID of the faucet which issued the asset as well as the asset amount. Asset amount is guaranteed to be 2^63 - 1 or smaller.

Implementations

impl FungibleAsset

pub const MAX_AMOUNT: u64 = 9_223_372_036_854_775_807u64

Specifies a maximum amount value for fungible assets which can be at most a 63-bit value.

pub fn new(faucet_id: AccountId, amount: u64) -> Result<Self, AssetError>

Returns a fungible asset instantiated with the provided faucet ID and amount.

Errors

Returns an error if:

• The faucet_id is not a valid fungible faucet ID.
• The provided amount is greater than 2^63 - 1.

pub fn faucet_id(&self) -> AccountId

Return ID of the faucet which issued this asset.

pub fn amount(&self) -> u64

Returns the amount of this asset.

pub fn is_from_same_faucet(&self, other: &Self) -> bool

Returns true if this and the other assets were issued from the same faucet.

pub fn vault_key(&self) -> Word

Returns the key which is used to store this asset in the account vault.

pub fn add(self, other: Self) -> Result<Self, AssetError>

Adds two fungible assets together and returns the result.

Errors

Returns an error if:

• The assets were not issued by the same faucet.
• The total value of assets is greater than or equal to 2^63.

pub fn sub(&mut self, amount: u64) -> Result<Self, AssetError>

Subtracts the specified amount from this asset and returns the resulting asset.

Errors

Returns an error if this asset’s amount is smaller than the requested amount.

Trait Implementations

impl Clone for FungibleAsset

fn clone(&self) -> FungibleAsset

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FungibleAsset

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

Formats the value using the given formatter.

impl Display for FungibleAsset

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

Formats the value using the given formatter.

impl From<FungibleAsset> for Word

fn from(asset: FungibleAsset) -> Self

Converts to this type from the input type.

impl From<FungibleAsset> for [u8; 32]

fn from(asset: FungibleAsset) -> Self

Converts to this type from the input type.

impl From<FungibleAsset> for Asset

fn from(asset: FungibleAsset) -> Self

Converts to this type from the input type.

impl PartialEq for FungibleAsset

fn eq(&self, other: &FungibleAsset) -> 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 TryFrom<[BaseElement; 4]> for FungibleAsset

type Error = AssetError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<[u8; 32]> for FungibleAsset

type Error = AssetError

The type returned in the event of a conversion error.

fn try_from(value: [u8; 32]) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for FungibleAsset

impl Eq for FungibleAsset

impl StructuralPartialEq for FungibleAsset