Struct AccountVaultDelta 

pub struct AccountVaultDelta { /* private fields */ }

AccountVaultDelta stores the difference between the initial and final account vault states.

The difference is represented as a map of AssetDeltas keyed by the ID of the asset they change. The AssetId orders the assets in the same way as the in-kernel account delta.

Purpose

The purpose of a vault delta is to represent the changes to the vault that a transaction results in and provide a way to commit to and sign these changes. Unlike an AccountVaultPatch, a delta cannot be applied to an account and multiple deltas cannot be merged, since that isn’t necessary for signing.

Limitations

The delta does not include the functionality to merge or split assets. This would mainly be needed to merge deltas, which isn’t supported. Additionally, once custom assets are supported, their merge and split logic will be defined in the issuing faucet, and the delta would not be able to (easily) invoke this logic.

Implementations

impl AccountVaultDelta

pub const MAX_ASSETS_PER_DELTA_OP: u16 = 1024

Maximum number of added or removed assets in a vault delta.

pub fn new( asset_deltas: impl IntoIterator<Item = AssetDelta>, ) -> Result<AccountVaultDelta, AccountDeltaError>

Validates and creates an AccountVaultDelta from the given asset deltas.

Errors

Returns an error if:

• the same asset is changed by more than one delta.
• the number of added or removed assets exceeds Self::MAX_ASSETS_PER_DELTA_OP.

pub fn is_empty(&self) -> bool

Returns true if this vault delta contains no updates.

pub fn num_assets(&self) -> usize

Returns the number of assets changed in this delta.

pub fn iter(&self) -> impl Iterator<Item = &AssetDelta>

Returns an iterator over the asset deltas, sorted by asset ID.

pub fn added_assets(&self) -> impl Iterator<Item = Asset>

Returns an iterator over the added assets in this delta.

pub fn removed_assets(&self) -> impl Iterator<Item = Asset>

Returns an iterator over the removed assets in this delta.

Trait Implementations

impl Clone for AccountVaultDelta

fn clone(&self) -> AccountVaultDelta

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AccountVaultDelta

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

Formats the value using the given formatter.

impl Default for AccountVaultDelta

fn default() -> AccountVaultDelta

Returns the “default value” for a type.

impl Deserializable for AccountVaultDelta

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

impl PartialEq for AccountVaultDelta

fn eq(&self, other: &AccountVaultDelta) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serializable for AccountVaultDelta

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 StructuralPartialEq for AccountVaultDelta