Struct PartialVault 

pub struct PartialVault { /* private fields */ }

A partial representation of an AssetVault, containing only proofs for a subset of assets.

Partial vault is used to provide verifiable access to specific assets in a vault without the need to provide the full vault data. It contains all required data for loading vault data into the transaction kernel for transaction execution.

Implementations

impl PartialVault

pub fn new(root: Word) -> PartialVault

Constructs a PartialVault from an AssetVault root.

For conversion from an AssetVault, prefer Self::new_minimal to be more explicit.

pub fn new_full(vault: AssetVault) -> PartialVault

Converts an AssetVault into a partial vault representation.

The resulting PartialVault will contain the full merkle paths of the original asset vault.

pub fn new_minimal(vault: &AssetVault) -> PartialVault

Converts an AssetVault into a partial vault representation.

The resulting PartialVault will represent the root of the asset vault, but not track any key-value pairs, which means it is the most minimal representation of the asset vault.

pub fn root(&self) -> Word

Returns the root of the partial vault.

pub fn inner_nodes(&self) -> impl Iterator<Item = InnerNodeInfo>

Returns an iterator over all inner nodes in the Sparse Merkle Tree proofs.

This is useful for reconstructing parts of the Sparse Merkle Tree or for verification purposes.

pub fn leaves(&self) -> impl Iterator<Item = &SmtLeaf>

Returns an iterator over all leaves in the Sparse Merkle Tree proofs.

Each item returned is a tuple containing the leaf index and a reference to the leaf.

pub fn open( &self, vault_key: AssetVaultKey, ) -> Result<AssetWitness, PartialAssetVaultError>

Returns an opening of the leaf associated with vault_key.

The vault_key can be obtained with Asset::vault_key.

Errors

Returns an error if:

• the key is not tracked by this partial vault.

pub fn get( &self, vault_key: AssetVaultKey, ) -> Result<Option<Asset>, MerkleError>

Returns the Asset associated with the given vault_key.

The return value is None if the asset does not exist in the vault.

Errors

Returns an error if:

• the key is not tracked by this partial SMT.

pub fn add( &mut self, witness: AssetWitness, ) -> Result<(), PartialAssetVaultError>

Adds an AssetWitness to this PartialVault.

Errors

Returns an error if:

• the new root after the insertion of the leaf and the path does not match the existing root (except when the first leaf is added).

Trait Implementations

impl Clone for PartialVault

fn clone(&self) -> PartialVault

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PartialVault

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

Formats the value using the given formatter.

impl Default for PartialVault

fn default() -> PartialVault

Returns the “default value” for a type.

impl Deserializable for PartialVault

fn read_from<R>(source: &mut R) -> Result<PartialVault, 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 read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

Attempts to deserialize the provided bytes into Self and returns the result.

impl PartialEq for PartialVault

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

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

where W: ByteWriter,

Serializes self into bytes and writes these bytes into the target.

fn to_bytes(&self) -> Vec<u8>

Serializes self into a vector of bytes.

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self.

impl TryFrom<PartialSmt> for PartialVault

fn try_from( partial_smt: PartialSmt, ) -> Result<PartialVault, <PartialVault as TryFrom<PartialSmt>>::Error>

Returns a new instance of a partial vault from the provided partial SMT.

Errors

Returns an error if:

• the provided SMT does not track only valid Assets.
• the vault key at which the asset is stored does not match the vault key derived from the asset.

type Error = PartialAssetVaultError

The type returned in the event of a conversion error.

impl Eq for PartialVault

impl StructuralPartialEq for PartialVault