Struct Vault 

pub struct Vault { /* private fields */ }

Vault structure for domains that can hold native tokens, custom data, and non-native tokens.

Sharded vaults are more complex than base vaults - they support custom data storage and can hold both fungible and non-fungible tokens in addition to native tokens.

Implementations

impl Vault

pub const fn new(shard: NonZero<u64>) -> Vault

Creates a new sharded vault on the specified shard.

The vault is initialized with zero balance and no custom data.

Parameters

• shard - shard identifier for the new vault

Examples

use std::num::NonZero;
use delta_primitives::vault::sharded::{Vault, ReadableShardedVault};

let vault = Vault::new(NonZero::new(3).unwrap());
assert_eq!(vault.shard(), 3);

Trait Implementations

impl Clone for Vault

fn clone(&self) -> Vault

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Vault

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Vault

fn deserialize<__D>( __deserializer: __D, ) -> Result<Vault, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Vault

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

Formats the value using the given formatter.

impl PartialEq for Vault

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

fn balance(&self) -> u64

Returns the native token balance of the vault in plancks.

impl ReadableShardedVault for Vault

fn shard(&self) -> u64

Returns the shard identifier that the vault belongs to.

fn data(&self) -> Option<&VaultDataType>

Returns the custom data stored in the vault, if any.

fn token_balance(&self, kind: &TokenKind) -> u64

Returns the balance of a specific token type in the vault.

fn nft_holdings(&self, token_kind: &TokenKind) -> BTreeSet<u64>

Returns the holdings of a specific non-fungible token type in the vault.

fn tokens(&self) -> impl Iterator<Item = TokenKind>

Returns an iterator over all token kinds stored in this vault.

impl Serialize for Vault

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<ShardedVault> for Vault

type Error = ProtoError

The type returned in the event of a conversion error.

fn try_from( value: ShardedVault, ) -> Result<Vault, <Vault as TryFrom<ShardedVault>>::Error>

Performs the conversion.

impl WritableNativeBalance for Vault

fn set_balance(&mut self, balance: u64)

Sets the native token balance of the vault.

fn checked_add_balance(&mut self, balance: u64) -> Result<(), VaultError>

Adds to the native token balance with overflow checking.

fn checked_sub_balance(&mut self, balance: u64) -> Result<(), VaultError>

Subtracts from the native token balance with underflow checking.

fn saturating_add_balance(&mut self, balance: u64)

Adds to the native token balance with saturation.

fn saturating_sub_balance(&mut self, balance: u64)

Subtracts from the native token balance with saturation.

impl WritableShardedVault for Vault

fn set_data(&mut self, data: Option<VaultDataType>)

Sets the custom data for the vault.

fn apply_diff(&mut self, diff: &StateDiffOperation) -> Result<(), VaultError>

Applies a state diff operation to the vault.

fn set_token_balance( &mut self, token_kind: &TokenKind, balance: u64, ) -> Result<(), VaultError>

Sets the balance of a fungible token type in the vault.

fn set_nft_holdings( &mut self, token_kind: &TokenKind, balance: BTreeSet<u64>, ) -> Result<(), VaultError>

Sets holdings of a specific NFT token in the vault.

fn checked_add_token_balance( &mut self, token_kind: &TokenKind, balance: u64, ) -> Result<(), VaultError>

Adds to a token balance with overflow checking.

fn checked_sub_token_balance( &mut self, token_kind: &TokenKind, balance: u64, ) -> Result<(), VaultError>

Subtracts from a token balance with underflow checking.

fn add_nft_holdings( &mut self, token_kind: &TokenKind, holdings: BTreeSet<u64>, ) -> Result<(), VaultError>

Adds NFT holdings to the vault.

fn apply_nft_diff( &mut self, token_kind: &TokenKind, diff: &Diff, ) -> Result<(), VaultError>

Applies an NFT diff to the vault.

impl Eq for Vault

impl StructuralPartialEq for Vault