1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277
use alloc::{string::ToString, vec::Vec};
use super::{
AccountId, AccountType, Asset, ByteReader, ByteWriter, Deserializable, DeserializationError,
FungibleAsset, NonFungibleAsset, Serializable, ZERO,
};
use crate::{
accounts::{AccountVaultDelta, NonFungibleDeltaAction},
crypto::merkle::Smt,
AssetVaultError, Digest,
};
// ASSET VAULT
// ================================================================================================
/// A container for an unlimited number of assets.
///
/// An asset vault can contain an unlimited number of assets. The assets are stored in a Sparse
/// Merkle tree as follows:
/// - For fungible assets, the index of a node is defined by the issuing faucet ID, and the value of
/// the node is the asset itself. Thus, for any fungible asset there will be only one node in the
/// tree.
/// - For non-fungible assets, the index is defined by the asset itself, and the asset is also the
/// value of the node.
///
/// An asset vault can be reduced to a single hash which is the root of the Sparse Merkle Tree.
#[derive(Debug, Clone, Default, PartialEq, Eq)]
pub struct AssetVault {
asset_tree: Smt,
}
impl AssetVault {
// CONSTRUCTOR
// --------------------------------------------------------------------------------------------
/// Returns a new [AssetVault] initialized with the provided assets.
pub fn new(assets: &[Asset]) -> Result<Self, AssetVaultError> {
Ok(Self {
asset_tree: Smt::with_entries(
assets.iter().map(|asset| (asset.vault_key().into(), (*asset).into())),
)
.map_err(AssetVaultError::DuplicateAsset)?,
})
}
// PUBLIC ACCESSORS
// --------------------------------------------------------------------------------------------
/// Returns a commitment to this vault.
pub fn commitment(&self) -> Digest {
self.asset_tree.root()
}
/// Returns true if the specified non-fungible asset is stored in this vault.
pub fn has_non_fungible_asset(&self, asset: Asset) -> Result<bool, AssetVaultError> {
if asset.is_fungible() {
return Err(AssetVaultError::NotANonFungibleAsset(asset));
}
// check if the asset is stored in the vault
match self.asset_tree.get_value(&asset.vault_key().into()) {
asset if asset == Smt::EMPTY_VALUE => Ok(false),
_ => Ok(true),
}
}
/// Returns the balance of the asset issued by the specified faucet. If the vault does not
/// contain such an asset, 0 is returned.
///
/// # Errors
/// Returns an error if the specified ID is not an ID of a fungible asset faucet.
pub fn get_balance(&self, faucet_id: AccountId) -> Result<u64, AssetVaultError> {
if !matches!(faucet_id.account_type(), AccountType::FungibleFaucet) {
return Err(AssetVaultError::NotAFungibleFaucetId(faucet_id));
}
// if the tree value is [0, 0, 0, 0], the asset is not stored in the vault
match self.asset_tree.get_value(&[ZERO, ZERO, ZERO, faucet_id.into()].into()) {
asset if asset == Smt::EMPTY_VALUE => Ok(0),
asset => Ok(FungibleAsset::new_unchecked(asset).amount()),
}
}
/// Returns an iterator over the assets stored in the vault.
pub fn assets(&self) -> impl Iterator<Item = Asset> + '_ {
self.asset_tree.entries().map(|x| Asset::new_unchecked(x.1))
}
/// Returns a reference to the Sparse Merkle Tree underling this asset vault.
pub fn asset_tree(&self) -> &Smt {
&self.asset_tree
}
// PUBLIC MODIFIERS
// --------------------------------------------------------------------------------------------
/// Applies the specified delta to the asset vault.
///
/// # Errors
/// Returns an error:
/// - If the total value of assets is greater than or equal to 2^63.
/// - If the delta contains an addition/subtraction for a fungible asset that is not stored in
/// the vault.
/// - If the delta contains a non-fungible asset removal that is not stored in the vault.
/// - If the delta contains a non-fungible asset addition that is already stored in the vault.
pub fn apply_delta(&mut self, delta: &AccountVaultDelta) -> Result<(), AssetVaultError> {
for (&faucet_id, &delta) in delta.fungible().iter() {
let asset = FungibleAsset::new(faucet_id, delta.unsigned_abs())
.expect("Not a fungible faucet ID or delta is too large");
match delta >= 0 {
true => self.add_fungible_asset(asset),
false => self.remove_fungible_asset(asset),
}?;
}
for (&asset, &action) in delta.non_fungible().iter() {
match action {
NonFungibleDeltaAction::Add => self.add_non_fungible_asset(asset),
NonFungibleDeltaAction::Remove => self.remove_non_fungible_asset(asset),
}?;
}
Ok(())
}
// ADD ASSET
// --------------------------------------------------------------------------------------------
/// Add the specified asset to the vault.
///
/// # Errors
/// - If the total value of two fungible assets is greater than or equal to 2^63.
/// - If the vault already contains the same non-fungible asset.
pub fn add_asset(&mut self, asset: Asset) -> Result<Asset, AssetVaultError> {
Ok(match asset {
Asset::Fungible(asset) => Asset::Fungible(self.add_fungible_asset(asset)?),
Asset::NonFungible(asset) => Asset::NonFungible(self.add_non_fungible_asset(asset)?),
})
}
/// Add the specified fungible asset to the vault. If the vault already contains an asset
/// issued by the same faucet, the amounts are added together.
///
/// # Errors
/// - If the total value of assets is greater than or equal to 2^63.
fn add_fungible_asset(
&mut self,
asset: FungibleAsset,
) -> Result<FungibleAsset, AssetVaultError> {
// fetch current asset value from the tree and add the new asset to it.
let new: FungibleAsset = match self.asset_tree.get_value(&asset.vault_key().into()) {
current if current == Smt::EMPTY_VALUE => asset,
current => {
let current = FungibleAsset::new_unchecked(current);
current.add(asset).map_err(AssetVaultError::AddFungibleAssetBalanceError)?
},
};
self.asset_tree.insert(new.vault_key().into(), new.into());
// return the new asset
Ok(new)
}
/// Add the specified non-fungible asset to the vault.
///
/// # Errors
/// - If the vault already contains the same non-fungible asset.
fn add_non_fungible_asset(
&mut self,
asset: NonFungibleAsset,
) -> Result<NonFungibleAsset, AssetVaultError> {
// add non-fungible asset to the vault
let old = self.asset_tree.insert(asset.vault_key().into(), asset.into());
// if the asset already exists, return an error
if old != Smt::EMPTY_VALUE {
return Err(AssetVaultError::DuplicateNonFungibleAsset(asset));
}
Ok(asset)
}
// REMOVE ASSET
// --------------------------------------------------------------------------------------------
/// Remove the specified asset from the vault.
///
/// # Errors
/// - The fungible asset is not found in the vault.
/// - The amount of the fungible asset in the vault is less than the amount to be removed.
/// - The non-fungible asset is not found in the vault.
pub fn remove_asset(&mut self, asset: Asset) -> Result<Asset, AssetVaultError> {
match asset {
Asset::Fungible(asset) => {
let asset = self.remove_fungible_asset(asset)?;
Ok(Asset::Fungible(asset))
},
Asset::NonFungible(asset) => {
let asset = self.remove_non_fungible_asset(asset)?;
Ok(Asset::NonFungible(asset))
},
}
}
/// Remove the specified fungible asset from the vault.
///
/// # Errors
/// - The asset is not found in the vault.
/// - The amount of the asset in the vault is less than the amount to be removed.
fn remove_fungible_asset(
&mut self,
asset: FungibleAsset,
) -> Result<FungibleAsset, AssetVaultError> {
// fetch the asset from the vault.
let mut current = match self.asset_tree.get_value(&asset.vault_key().into()) {
current if current == Smt::EMPTY_VALUE => {
return Err(AssetVaultError::FungibleAssetNotFound(asset))
},
current => FungibleAsset::new_unchecked(current),
};
// subtract the amount of the asset to be removed from the current amount.
current
.sub(asset.amount())
.map_err(AssetVaultError::SubtractFungibleAssetBalanceError)?;
// if the amount of the asset is zero, remove the asset from the vault.
let new = match current.amount() {
0 => Smt::EMPTY_VALUE,
_ => current.into(),
};
self.asset_tree.insert(asset.vault_key().into(), new);
// return the asset that was removed.
Ok(asset)
}
/// Remove the specified non-fungible asset from the vault.
///
/// # Errors
/// - The non-fungible asset is not found in the vault.
fn remove_non_fungible_asset(
&mut self,
asset: NonFungibleAsset,
) -> Result<NonFungibleAsset, AssetVaultError> {
// remove the asset from the vault.
let old = self.asset_tree.insert(asset.vault_key().into(), Smt::EMPTY_VALUE);
// return an error if the asset did not exist in the vault.
if old == Smt::EMPTY_VALUE {
return Err(AssetVaultError::NonFungibleAssetNotFound(asset));
}
// return the asset that was removed.
Ok(asset)
}
}
// SERIALIZATION
// ================================================================================================
impl Serializable for AssetVault {
fn write_into<W: ByteWriter>(&self, target: &mut W) {
// TODO: determine total number of assets in the vault without allocating the vector
let assets = self.assets().collect::<Vec<_>>();
// TODO: either enforce that number of assets in the vault is never greater than
// u32::MAX or use variable-length encoding for the number of assets
assert!(assets.len() <= u32::MAX as usize, "too many assets in the vault");
target.write_u32(assets.len() as u32);
target.write_many(&assets);
}
}
impl Deserializable for AssetVault {
fn read_from<R: ByteReader>(source: &mut R) -> Result<Self, DeserializationError> {
let num_assets = source.read_u32()? as usize;
let assets = source.read_many::<Asset>(num_assets)?;
Self::new(&assets).map_err(|err| DeserializationError::InvalidValue(err.to_string()))
}
}