Struct 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.

The fungible asset can have callbacks to the faucet enabled or disabled, depending on AssetCallbackFlag. See AssetCallbacks for more details.

Implementations

impl FungibleAsset

pub const MAX_AMOUNT: u64

Specifies the maximum amount a fungible asset can represent.

This number was chosen so that it can be represented as a positive and negative number in a field element. See account_delta.masm for more details on how this number was chosen.

pub const SERIALIZED_SIZE: usize

The serialized size of a FungibleAsset in bytes.

An account ID (15 bytes) plus an amount (u64) plus a callbacks flag (u8).

pub fn new( faucet_id: AccountId, amount: u64, ) -> Result<FungibleAsset, 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 FungibleAsset::MAX_AMOUNT.

pub fn from_key_value( key: AssetVaultKey, value: Word, ) -> Result<FungibleAsset, AssetError>

Creates a fungible asset from the provided key and value.

Errors

Returns an error if:

• The provided key does not contain a valid faucet ID.
• The provided key’s asset ID limbs are not zero.
• The faucet ID is not a fungible faucet ID.
• The provided value’s amount is greater than FungibleAsset::MAX_AMOUNT or its three most significant elements are not zero.

pub fn from_key_value_words( key: Word, value: Word, ) -> Result<FungibleAsset, AssetError>

Creates a fungible asset from the provided key and value.

Prefer Self::from_key_value for more type safety.

Errors

Returns an error if:

• The provided key does not contain a valid faucet ID.
• Self::from_key_value fails.

pub fn with_callbacks(self, callbacks: AssetCallbackFlag) -> FungibleAsset

Returns a copy of this asset with the given AssetCallbackFlag.

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_same(&self, other: &FungibleAsset) -> bool

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

pub fn callbacks(&self) -> AssetCallbackFlag

Returns the AssetCallbackFlag of this asset.

pub fn vault_key(&self) -> AssetVaultKey

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

pub fn to_key_word(&self) -> Word

Returns the asset’s key encoded to a Word.

pub fn to_value_word(&self) -> Word

Returns the asset’s value encoded to a Word.

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

Adds two fungible assets together and returns the result.

Errors

Returns an error if:

• The assets do not have the same vault key (i.e. different faucet or callback flags).
• The total value of assets is greater than or equal to 2^63.

pub fn sub(self, other: FungibleAsset) -> Result<FungibleAsset, AssetError>

Subtracts a fungible asset from another and returns the result.

Errors

Returns an error if:

• The assets do not have the same vault key (i.e. different faucet or callback flags).
• The final amount would be negative.

Trait Implementations

impl Clone for FungibleAsset

fn clone(&self) -> FungibleAsset

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

Formats the value using the given formatter.

impl Deserializable for FungibleAsset

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

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

Formats the value using the given formatter.

impl From<FungibleAsset> for Asset

fn from(asset: FungibleAsset) -> Asset

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

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

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 Copy for FungibleAsset

impl Eq for FungibleAsset

impl StructuralPartialEq for FungibleAsset