Struct NonFungibleAsset

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

A commitment to a non-fungible asset.

The commitment is constructed as follows:

• Hash the asset data producing [hash0, hash1, hash2, hash3].
• Replace the value of hash3 with the prefix of the faucet id (faucet_id_prefix) producing [hash0, hash1, hash2, faucet_id_prefix].
• This layout ensures that fungible and non-fungible assets are distinguishable by interpreting the 3rd element of an asset as an AccountIdPrefix and checking its type.

NonFungibleAsset itself does not contain the actual asset data. The container for this data is NonFungibleAssetDetails.

Implementations

impl NonFungibleAsset

pub const SERIALIZED_SIZE: usize = 32usize

The serialized size of a NonFungibleAsset in bytes.

Currently represented as a word.

pub fn new(details: &NonFungibleAssetDetails) -> Result<Self, AssetError>

Returns a non-fungible asset created from the specified asset details.

Errors

Returns an error if the provided faucet ID is not for a non-fungible asset faucet.

pub fn from_parts( faucet_id: AccountIdPrefix, data_hash: Word, ) -> Result<Self, AssetError>

Return a non-fungible asset created from the specified faucet and using the provided hash of the asset’s data.

Hash of the asset’s data is expected to be computed from the binary representation of the asset’s data.

Errors

Returns an error if the provided faucet ID is not for a non-fungible asset faucet.

pub unsafe fn new_unchecked(value: Word) -> NonFungibleAsset

Creates a new NonFungibleAsset without checking its validity.

Safety

This function required that the provided value is a valid word representation of a NonFungibleAsset.

pub fn vault_key(&self) -> Word

Returns the vault key of the NonFungibleAsset.

This is the same as the asset with the following modifications, in this order:

• Swaps the faucet ID at index 0 and hash0 at index 3.
• Sets the fungible bit for hash0 to 0.

Rationale

This means hash0 will be used as the leaf index in the asset SMT which ensures that a non-fungible faucet’s assets generally end up in different leaves as the key is not based on the faucet ID.

It also ensures that there is never any collision in the leaf index between a non-fungible asset and a fungible asset, as the former’s vault key always has the fungible bit set to 0 and the latter’s vault key always has the bit set to 1.

pub fn faucet_id_prefix(&self) -> AccountIdPrefix

Return ID prefix of the faucet which issued this asset.

Trait Implementations

impl Clone for NonFungibleAsset

fn clone(&self) -> NonFungibleAsset

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NonFungibleAsset

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

Formats the value using the given formatter.

impl Deserializable for NonFungibleAsset

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 Display for NonFungibleAsset

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

Formats the value using the given formatter.

impl From<NonFungibleAsset> for Word

fn from(asset: NonFungibleAsset) -> Self

Converts to this type from the input type.

impl From<NonFungibleAsset> for Asset

fn from(asset: NonFungibleAsset) -> Self

Converts to this type from the input type.

impl Ord for NonFungibleAsset

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

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

fn partial_cmp(&self, other: &Self) -> 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 NonFungibleAsset

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

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<[BaseElement; 4]> for NonFungibleAsset

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

impl Eq for NonFungibleAsset

impl StructuralPartialEq for NonFungibleAsset