difftreelog
fix set prop for not existed token (#933)
in: master
* fix: set prop for not existed token * optimize token checking * remove comments * test(token properties): on token non-existence * fix PR comments * rename value * refactor(modify token properties): readability + grammar * revert: unused import used for try-runtime * fix prop permission check * Add self_mint flag * Add LazyValue * fix tests * fix unit tests * fix docker * fix mintCross sponsoring * Generalize next_token_id * fix: set sponsored properties ---------
20 files changed
.docker/Dockerfile-chain-dev-unitdiffbeforeafterboth--- a/.docker/Dockerfile-chain-dev-unit
+++ b/.docker/Dockerfile-chain-dev-unit
@@ -17,4 +17,4 @@
WORKDIR /dev_chain
-CMD cargo test --features=limit-testing --workspace
+CMD cargo test --features=limit-testing,tests --workspace
pallets/common/Cargo.tomldiffbeforeafterboth--- a/pallets/common/Cargo.toml
+++ b/pallets/common/Cargo.toml
@@ -36,4 +36,5 @@
"up-pov-estimate-rpc/std",
]
stubgen = ["evm-coder/stubgen"]
+tests = []
try-runtime = ["frame-support/try-runtime"]
pallets/common/src/eth.rsdiffbeforeafterboth--- a/pallets/common/src/eth.rs
+++ b/pallets/common/src/eth.rs
@@ -131,6 +131,18 @@
value: evm_coder::types::Bytes,
}
+impl Property {
+ /// Property key.
+ pub fn key(&self) -> &str {
+ self.key.as_str()
+ }
+
+ /// Property value.
+ pub fn value(&self) -> &[u8] {
+ self.value.0.as_slice()
+ }
+}
+
impl TryFrom<up_data_structs::Property> for Property {
type Error = pallet_evm_coder_substrate::execution::Error;
@@ -227,11 +239,9 @@
Some(value) => match value {
0 => Ok(Some(false)),
1 => Ok(Some(true)),
- _ => {
- return Err(Self::Error::Revert(format!(
- "can't convert value to boolean \"{value}\""
- )))
- }
+ _ => Err(Self::Error::Revert(format!(
+ "can't convert value to boolean \"{value}\""
+ ))),
},
None => Ok(None),
};
pallets/common/src/lib.rsdiffbeforeafterboth--- a/pallets/common/src/lib.rs
+++ b/pallets/common/src/lib.rs
@@ -216,7 +216,6 @@
///
/// # Arguments
///
- /// * `sender`: Caller's account.
/// * `sponsor`: ID of the account of the sponsor-to-be.
pub fn force_set_sponsor(&mut self, sponsor: T::AccountId) -> DispatchResult {
self.check_is_internal()?;
@@ -867,6 +866,74 @@
>;
}
+/// Represents the change mode for the token property.
+pub enum SetPropertyMode {
+ /// The token already exists.
+ ExistingToken,
+
+ /// New token.
+ NewToken {
+ /// The creator of the token is the recipient.
+ mint_target_is_sender: bool,
+ },
+}
+
+/// Value representation with delayed initialization time.
+pub struct LazyValue<T, F: FnOnce() -> T> {
+ value: Option<T>,
+ f: Option<F>,
+}
+
+impl<T, F: FnOnce() -> T> LazyValue<T, F> {
+ /// Create a new LazyValue.
+ pub fn new(f: F) -> Self {
+ Self {
+ value: None,
+ f: Some(f),
+ }
+ }
+
+ /// Get the value. If it call furst time the value will be initialized.
+ pub fn value(&mut self) -> &T {
+ if self.value.is_none() {
+ self.value = Some(self.f.take().unwrap()())
+ }
+
+ self.value.as_ref().unwrap()
+ }
+
+ /// Is value initialized.
+ pub fn has_value(&self) -> bool {
+ self.value.is_some()
+ }
+}
+
+fn check_token_permissions<T, FCA, FTO, FTE>(
+ collection_admin_permitted: bool,
+ token_owner_permitted: bool,
+ is_collection_admin: &mut LazyValue<bool, FCA>,
+ is_token_owner: &mut LazyValue<Result<bool, DispatchError>, FTO>,
+ is_token_exist: &mut LazyValue<bool, FTE>,
+) -> DispatchResult
+where
+ T: Config,
+ FCA: FnOnce() -> bool,
+ FTO: FnOnce() -> Result<bool, DispatchError>,
+ FTE: FnOnce() -> bool,
+{
+ if !(collection_admin_permitted && *is_collection_admin.value()
+ || token_owner_permitted && (*is_token_owner.value())?)
+ {
+ fail!(<Error<T>>::NoPermission);
+ }
+
+ let token_certainly_exist = is_token_owner.has_value() && (*is_token_owner.value())?;
+ if !token_certainly_exist && !is_token_exist.value() {
+ fail!(<Error<T>>::TokenNotFound);
+ }
+ Ok(())
+}
+
impl<T: Config> Pallet<T> {
/// Enshure that receiver address is correct.
///
@@ -1218,10 +1285,6 @@
/// * sets a property under the <key> with the value provided `(<key>, Some(<value>))`
/// * removes a property under the <key> if the value is `None` `(<key>, None)`.
///
- /// - `nesting_budget`: Limit for searching parents in-depth to check ownership.
- /// - `is_token_create`: Indicates that method is called during token initialization.
- /// Allows to bypass ownership check.
- ///
/// All affected properties should have `mutable` permission
/// to be **deleted** or to be **set more than once**,
/// and the sender should have permission to edit those properties.
@@ -1229,35 +1292,36 @@
/// This function fires an event for each property change.
/// In case of an error, all the changes (including the events) will be reverted
/// since the function is transactional.
- pub fn modify_token_properties(
+ #[allow(clippy::too_many_arguments)]
+ pub fn modify_token_properties<FTO, FTE>(
collection: &CollectionHandle<T>,
sender: &T::CrossAccountId,
token_id: TokenId,
+ is_token_exist: &mut LazyValue<bool, FTE>,
properties_updates: impl Iterator<Item = (PropertyKey, Option<PropertyValue>)>,
- is_token_create: bool,
mut stored_properties: TokenProperties,
- is_token_owner: impl Fn() -> Result<bool, DispatchError>,
+ is_token_owner: &mut LazyValue<Result<bool, DispatchError>, FTO>,
set_token_properties: impl FnOnce(TokenProperties),
log: evm_coder::ethereum::Log,
- ) -> DispatchResult {
- let is_collection_admin = collection.is_owner_or_admin(sender);
+ ) -> DispatchResult
+ where
+ FTO: FnOnce() -> Result<bool, DispatchError>,
+ FTE: FnOnce() -> bool,
+ {
+ let mut is_collection_admin = LazyValue::new(|| collection.is_owner_or_admin(sender));
let permissions = Self::property_permissions(collection.id);
- let mut token_owner_result = None;
- let mut is_token_owner = || -> Result<bool, DispatchError> {
- *token_owner_result.get_or_insert_with(&is_token_owner)
- };
-
+ let mut changed = false;
for (key, value) in properties_updates {
let permission = permissions
.get(&key)
.cloned()
.unwrap_or_else(PropertyPermission::none);
- let is_property_exists = stored_properties.get(&key).is_some();
+ let property_exists = stored_properties.get(&key).is_some();
match permission {
- PropertyPermission { mutable: false, .. } if is_property_exists => {
+ PropertyPermission { mutable: false, .. } if property_exists => {
return Err(<Error<T>>::NoPermission.into());
}
@@ -1265,17 +1329,13 @@
collection_admin,
token_owner,
..
- } => {
- //TODO: investigate threats during public minting.
- let is_token_create =
- is_token_create && (collection_admin || token_owner) && value.is_some();
- if !(is_token_create
- || (collection_admin && is_collection_admin)
- || (token_owner && is_token_owner()?))
- {
- fail!(<Error<T>>::NoPermission);
- }
- }
+ } => check_token_permissions::<T, _, FTO, FTE>(
+ collection_admin,
+ token_owner,
+ &mut is_collection_admin,
+ is_token_owner,
+ is_token_exist,
+ )?,
}
match value {
@@ -1293,9 +1353,13 @@
}
}
- <PalletEvm<T>>::deposit_log(log.clone());
+ changed = true;
}
+ if changed {
+ <PalletEvm<T>>::deposit_log(log);
+ }
+
set_token_properties(stored_properties);
Ok(())
@@ -2322,3 +2386,86 @@
}
}
}
+
+#[cfg(feature = "tests")]
+pub mod tests {
+ use crate::{DispatchResult, DispatchError, LazyValue, Config};
+
+ const fn to_bool(u: u8) -> bool {
+ u != 0
+ }
+
+ #[derive(Debug)]
+ pub struct TestCase {
+ pub collection_admin: bool,
+ pub is_collection_admin: bool,
+ pub token_owner: bool,
+ pub is_token_owner: bool,
+ pub no_permission: bool,
+ }
+
+ impl TestCase {
+ const fn new(
+ collection_admin: u8,
+ is_collection_admin: u8,
+ token_owner: u8,
+ is_token_owner: u8,
+ no_permission: u8,
+ ) -> Self {
+ Self {
+ collection_admin: to_bool(collection_admin),
+ is_collection_admin: to_bool(is_collection_admin),
+ token_owner: to_bool(token_owner),
+ is_token_owner: to_bool(is_token_owner),
+ no_permission: to_bool(no_permission),
+ }
+ }
+ }
+
+ #[rustfmt::skip]
+ pub const table: [TestCase; 16] = [
+ // ┌╴collection_admin
+ // │ ┌╴is_collection_admin
+ // │ │ ┌╴token_owner
+ // │ │ │ ┌╴is_token_ownership
+ // │ │ │ │ ┌╴no_permission
+ /* 0*/ TestCase::new(0, 0, 0, 0, 1),
+ /* 1*/ TestCase::new(0, 0, 0, 1, 1),
+ /* 2*/ TestCase::new(0, 0, 1, 0, 1),
+ /* 3*/ TestCase::new(0, 0, 1, 1, 0),
+ /* 4*/ TestCase::new(0, 1, 0, 0, 1),
+ /* 5*/ TestCase::new(0, 1, 0, 1, 1),
+ /* 6*/ TestCase::new(0, 1, 1, 0, 1),
+ /* 7*/ TestCase::new(0, 1, 1, 1, 0),
+ /* 8*/ TestCase::new(1, 0, 0, 0, 1),
+ /* 9*/ TestCase::new(1, 0, 0, 1, 1),
+ /* 10*/ TestCase::new(1, 0, 1, 0, 1),
+ /* 11*/ TestCase::new(1, 0, 1, 1, 0),
+ /* 12*/ TestCase::new(1, 1, 0, 0, 0),
+ /* 13*/ TestCase::new(1, 1, 0, 1, 0),
+ /* 14*/ TestCase::new(1, 1, 1, 0, 0),
+ /* 15*/ TestCase::new(1, 1, 1, 1, 0),
+ ];
+
+ pub fn check_token_permissions<T, FCA, FTO, FTE>(
+ collection_admin_permitted: bool,
+ token_owner_permitted: bool,
+ is_collection_admin: &mut LazyValue<bool, FCA>,
+ check_token_ownership: &mut LazyValue<Result<bool, DispatchError>, FTO>,
+ check_token_existence: &mut LazyValue<bool, FTE>,
+ ) -> DispatchResult
+ where
+ T: Config,
+ FCA: FnOnce() -> bool,
+ FTO: FnOnce() -> Result<bool, DispatchError>,
+ FTE: FnOnce() -> bool,
+ {
+ crate::check_token_permissions::<T, FCA, FTO, FTE>(
+ collection_admin_permitted,
+ token_owner_permitted,
+ is_collection_admin,
+ check_token_ownership,
+ check_token_existence,
+ )
+ }
+}
pallets/nonfungible/src/common.rsdiffbeforeafterboth--- a/pallets/nonfungible/src/common.rs
+++ b/pallets/nonfungible/src/common.rs
@@ -245,7 +245,7 @@
&sender,
token_id,
properties.into_iter(),
- false,
+ pallet_common::SetPropertyMode::ExistingToken,
nesting_budget,
),
weight,
pallets/nonfungible/src/erc.rsdiffbeforeafterboth--- a/pallets/nonfungible/src/erc.rs
+++ b/pallets/nonfungible/src/erc.rs
@@ -194,7 +194,7 @@
&caller,
TokenId(token_id),
properties.into_iter(),
- false,
+ pallet_common::SetPropertyMode::ExistingToken,
&nesting_budget,
)
.map_err(dispatch_to_evm::<T>)
@@ -939,9 +939,8 @@
/// @notice Returns next free NFT ID.
fn next_token_id(&self) -> Result<U256> {
self.consume_store_reads(1)?;
- Ok(<TokensMinted<T>>::get(self.id)
- .checked_add(1)
- .ok_or("item id overflow")?
+ Ok(<Pallet<T>>::next_token_id(self)
+ .map_err(dispatch_to_evm::<T>)?
.into())
}
pallets/nonfungible/src/lib.rsdiffbeforeafterboth--- a/pallets/nonfungible/src/lib.rs
+++ b/pallets/nonfungible/src/lib.rs
@@ -109,7 +109,7 @@
use pallet_common::{
Error as CommonError, Pallet as PalletCommon, Event as CommonEvent, CollectionHandle,
eth::collection_id_to_address, SelfWeightOf as PalletCommonWeightOf,
- weights::WeightInfo as CommonWeightInfo, helpers::add_weight_to_post_info,
+ weights::WeightInfo as CommonWeightInfo, helpers::add_weight_to_post_info, SetPropertyMode,
};
use pallet_structure::{Pallet as PalletStructure, Error as StructureError};
use pallet_evm_coder_substrate::{SubstrateRecorder, WithRecorder};
@@ -585,8 +585,6 @@
/// A batch operation to add, edit or remove properties for a token.
///
/// - `nesting_budget`: Limit for searching parents in-depth to check ownership.
- /// - `is_token_create`: Indicates that method is called during token initialization.
- /// Allows to bypass ownership check.
///
/// All affected properties should have `mutable` permission
/// to be **deleted** or to be **set more than once**,
@@ -601,10 +599,17 @@
sender: &T::CrossAccountId,
token_id: TokenId,
properties_updates: impl Iterator<Item = (PropertyKey, Option<PropertyValue>)>,
- is_token_create: bool,
+ mode: SetPropertyMode,
nesting_budget: &dyn Budget,
) -> DispatchResult {
- let is_token_owner = || {
+ let mut is_token_owner = pallet_common::LazyValue::new(|| {
+ if let SetPropertyMode::NewToken {
+ mint_target_is_sender,
+ } = mode
+ {
+ return Ok(mint_target_is_sender);
+ }
+
let is_owned = <PalletStructure<T>>::check_indirectly_owned(
sender.clone(),
collection.id,
@@ -614,18 +619,21 @@
)?;
Ok(is_owned)
- };
+ });
+ let mut is_token_exist =
+ pallet_common::LazyValue::new(|| Self::token_exists(collection, token_id));
+
let stored_properties = <TokenProperties<T>>::get((collection.id, token_id));
<PalletCommon<T>>::modify_token_properties(
collection,
sender,
token_id,
+ &mut is_token_exist,
properties_updates,
- is_token_create,
stored_properties,
- is_token_owner,
+ &mut is_token_owner,
|properties| <TokenProperties<T>>::set((collection.id, token_id), properties),
erc::ERC721TokenEvent::TokenChanged {
token_id: token_id.into(),
@@ -634,6 +642,19 @@
)
}
+ pub fn next_token_id(collection: &NonfungibleHandle<T>) -> Result<TokenId, DispatchError> {
+ let next_token_id = <TokensMinted<T>>::get(collection.id)
+ .checked_add(1)
+ .ok_or(<CommonError<T>>::CollectionTokenLimitExceeded)?;
+
+ ensure!(
+ collection.limits.token_limit() >= next_token_id,
+ <CommonError<T>>::CollectionTokenLimitExceeded
+ );
+
+ Ok(TokenId(next_token_id))
+ }
+
/// Batch operation to add or edit properties for the token
///
/// Same as [`modify_token_properties`] but doesn't allow to remove properties
@@ -644,7 +665,7 @@
sender: &T::CrossAccountId,
token_id: TokenId,
properties: impl Iterator<Item = Property>,
- is_token_create: bool,
+ mode: SetPropertyMode,
nesting_budget: &dyn Budget,
) -> DispatchResult {
Self::modify_token_properties(
@@ -652,7 +673,7 @@
sender,
token_id,
properties.map(|p| (p.key, Some(p.value))),
- is_token_create,
+ mode,
nesting_budget,
)
}
@@ -669,14 +690,12 @@
property: Property,
nesting_budget: &dyn Budget,
) -> DispatchResult {
- let is_token_create = false;
-
Self::set_token_properties(
collection,
sender,
token_id,
[property].into_iter(),
- is_token_create,
+ SetPropertyMode::ExistingToken,
nesting_budget,
)
}
@@ -693,14 +712,12 @@
property_keys: impl Iterator<Item = PropertyKey>,
nesting_budget: &dyn Budget,
) -> DispatchResult {
- let is_token_create = false;
-
Self::modify_token_properties(
collection,
sender,
token_id,
property_keys.into_iter().map(|key| (key, None)),
- is_token_create,
+ SetPropertyMode::ExistingToken,
nesting_budget,
)
}
@@ -985,7 +1002,9 @@
sender,
TokenId(token),
data.properties.clone().into_iter(),
- true,
+ SetPropertyMode::NewToken {
+ mint_target_is_sender: sender.conv_eq(&data.owner),
+ },
nesting_budget,
) {
return TransactionOutcome::Rollback(Err(e));
pallets/refungible/src/common.rsdiffbeforeafterboth--- a/pallets/refungible/src/common.rs
+++ b/pallets/refungible/src/common.rs
@@ -399,7 +399,7 @@
&sender,
token_id,
properties.into_iter(),
- false,
+ pallet_common::SetPropertyMode::ExistingToken,
nesting_budget,
),
weight,
pallets/refungible/src/erc.rsdiffbeforeafterboth--- a/pallets/refungible/src/erc.rs
+++ b/pallets/refungible/src/erc.rs
@@ -196,7 +196,7 @@
&caller,
TokenId(token_id),
properties.into_iter(),
- false,
+ pallet_common::SetPropertyMode::ExistingToken,
&nesting_budget,
)
.map_err(dispatch_to_evm::<T>)
@@ -973,9 +973,8 @@
/// @notice Returns next free RFT ID.
fn next_token_id(&self) -> Result<U256> {
self.consume_store_reads(1)?;
- Ok(<TokensMinted<T>>::get(self.id)
- .checked_add(1)
- .ok_or("item id overflow")?
+ Ok(<Pallet<T>>::next_token_id(self)
+ .map_err(dispatch_to_evm::<T>)?
.into())
}
pallets/refungible/src/lib.rsdiffbeforeafterboth--- a/pallets/refungible/src/lib.rs
+++ b/pallets/refungible/src/lib.rs
@@ -97,7 +97,7 @@
use pallet_evm_coder_substrate::WithRecorder;
use pallet_common::{
CommonCollectionOperations, Error as CommonError, eth::collection_id_to_address,
- Event as CommonEvent, Pallet as PalletCommon,
+ Event as CommonEvent, Pallet as PalletCommon, SetPropertyMode,
};
use pallet_structure::Pallet as PalletStructure;
use sp_core::{Get, H160};
@@ -521,8 +521,6 @@
/// * removes a property under the <key> if the value is `None` `(<key>, None)`.
///
/// - `nesting_budget`: Limit for searching parents in-depth to check ownership.
- /// - `is_token_create`: Indicates that method is called during token initialization.
- /// Allows to bypass ownership check.
///
/// All affected properties should have `mutable` permission
/// to be **deleted** or to be **set more than once**,
@@ -537,27 +535,38 @@
sender: &T::CrossAccountId,
token_id: TokenId,
properties_updates: impl Iterator<Item = (PropertyKey, Option<PropertyValue>)>,
- is_token_create: bool,
+ mode: SetPropertyMode,
nesting_budget: &dyn Budget,
) -> DispatchResult {
- let is_token_owner = || -> Result<bool, DispatchError> {
- let balance = collection.balance(sender.clone(), token_id);
- let total_pieces: u128 =
- Self::total_pieces(collection.id, token_id).unwrap_or(u128::MAX);
- if balance != total_pieces {
- return Ok(false);
- }
+ let mut is_token_owner =
+ pallet_common::LazyValue::new(|| -> Result<bool, DispatchError> {
+ if let SetPropertyMode::NewToken {
+ mint_target_is_sender,
+ } = mode
+ {
+ return Ok(mint_target_is_sender);
+ }
- let is_bundle_owner = <PalletStructure<T>>::check_indirectly_owned(
- sender.clone(),
- collection.id,
- token_id,
- None,
- nesting_budget,
- )?;
+ let balance = collection.balance(sender.clone(), token_id);
+ let total_pieces: u128 =
+ Self::total_pieces(collection.id, token_id).unwrap_or(u128::MAX);
+ if balance != total_pieces {
+ return Ok(false);
+ }
+
+ let is_bundle_owner = <PalletStructure<T>>::check_indirectly_owned(
+ sender.clone(),
+ collection.id,
+ token_id,
+ None,
+ nesting_budget,
+ )?;
+
+ Ok(is_bundle_owner)
+ });
- Ok(is_bundle_owner)
- };
+ let mut is_token_exist =
+ pallet_common::LazyValue::new(|| Self::token_exists(collection, token_id));
let stored_properties = <TokenProperties<T>>::get((collection.id, token_id));
@@ -565,10 +574,10 @@
collection,
sender,
token_id,
+ &mut is_token_exist,
properties_updates,
- is_token_create,
stored_properties,
- is_token_owner,
+ &mut is_token_owner,
|properties| <TokenProperties<T>>::set((collection.id, token_id), properties),
erc::ERC721TokenEvent::TokenChanged {
token_id: token_id.into(),
@@ -577,12 +586,25 @@
)
}
+ pub fn next_token_id(collection: &RefungibleHandle<T>) -> Result<TokenId, DispatchError> {
+ let next_token_id = <TokensMinted<T>>::get(collection.id)
+ .checked_add(1)
+ .ok_or(<CommonError<T>>::CollectionTokenLimitExceeded)?;
+
+ ensure!(
+ collection.limits.token_limit() >= next_token_id,
+ <CommonError<T>>::CollectionTokenLimitExceeded
+ );
+
+ Ok(TokenId(next_token_id))
+ }
+
pub fn set_token_properties(
collection: &RefungibleHandle<T>,
sender: &T::CrossAccountId,
token_id: TokenId,
properties: impl Iterator<Item = Property>,
- is_token_create: bool,
+ mode: SetPropertyMode,
nesting_budget: &dyn Budget,
) -> DispatchResult {
Self::modify_token_properties(
@@ -590,7 +612,7 @@
sender,
token_id,
properties.map(|p| (p.key, Some(p.value))),
- is_token_create,
+ mode,
nesting_budget,
)
}
@@ -602,14 +624,12 @@
property: Property,
nesting_budget: &dyn Budget,
) -> DispatchResult {
- let is_token_create = false;
-
Self::set_token_properties(
collection,
sender,
token_id,
[property].into_iter(),
- is_token_create,
+ SetPropertyMode::ExistingToken,
nesting_budget,
)
}
@@ -621,14 +641,12 @@
property_keys: impl Iterator<Item = PropertyKey>,
nesting_budget: &dyn Budget,
) -> DispatchResult {
- let is_token_create = false;
-
Self::modify_token_properties(
collection,
sender,
token_id,
property_keys.into_iter().map(|key| (key, None)),
- is_token_create,
+ SetPropertyMode::ExistingToken,
nesting_budget,
)
}
@@ -914,10 +932,14 @@
let token_id = first_token_id + i as u32 + 1;
<TotalSupply<T>>::insert((collection.id, token_id), totals[i]);
+ let mut mint_target_is_sender = true;
for (user, amount) in data.users.iter() {
if *amount == 0 {
continue;
}
+
+ mint_target_is_sender = mint_target_is_sender && sender.conv_eq(user);
+
<Balance<T>>::insert((collection.id, token_id, &user), amount);
<Owned<T>>::insert((collection.id, &user, TokenId(token_id)), true);
<PalletStructure<T>>::nest_if_sent_to_token_unchecked(
@@ -932,7 +954,9 @@
sender,
TokenId(token_id),
data.properties.clone().into_iter(),
- true,
+ SetPropertyMode::NewToken {
+ mint_target_is_sender,
+ },
nesting_budget,
) {
return TransactionOutcome::Rollback(Err(e));
runtime/common/ethereum/sponsoring.rsdiffbeforeafterboth--- a/runtime/common/ethereum/sponsoring.rs
+++ b/runtime/common/ethereum/sponsoring.rs
@@ -22,7 +22,7 @@
use pallet_evm::account::CrossAccountId;
use pallet_evm_transaction_payment::CallContext;
use pallet_nonfungible::{
- Config as NonfungibleConfig,
+ Config as NonfungibleConfig, Pallet as NonfungiblePallet, NonfungibleHandle,
erc::{
UniqueNFTCall, ERC721UniqueExtensionsCall, ERC721UniqueMintableCall, ERC721Call,
TokenPropertiesCall,
@@ -56,6 +56,8 @@
pub struct UniqueEthSponsorshipHandler<T: UniqueConfig>(PhantomData<*const T>);
impl<T: UniqueConfig + FungibleConfig + NonfungibleConfig + RefungibleConfig>
SponsorshipHandler<T::CrossAccountId, CallContext> for UniqueEthSponsorshipHandler<T>
+where
+ T::AccountId: From<[u8; 32]>,
{
fn get_sponsor(
who: &T::CrossAccountId,
@@ -67,29 +69,71 @@
let (method_id, mut reader) = AbiReader::new_call(&call_context.input).ok()?;
Some(T::CrossAccountId::from_sub(match &collection.mode {
CollectionMode::NFT => {
+ let collection = NonfungibleHandle::cast(collection);
let call = <UniqueNFTCall<T>>::parse(method_id, &mut reader).ok()??;
match call {
- UniqueNFTCall::TokenProperties(TokenPropertiesCall::SetProperty {
- token_id,
- key,
- value,
- ..
- }) => {
- let token_id: TokenId = token_id.try_into().ok()?;
- withdraw_set_token_property::<T>(
- &collection,
- who,
- &token_id,
- key.len() + value.len(),
- )
- .map(|()| sponsor)
- }
- UniqueNFTCall::ERC721UniqueExtensions(
- ERC721UniqueExtensionsCall::Transfer { token_id, .. },
- ) => {
- let token_id: TokenId = token_id.try_into().ok()?;
- withdraw_transfer::<T>(&collection, who, &token_id).map(|()| sponsor)
- }
+ UniqueNFTCall::TokenProperties(call) => match call {
+ TokenPropertiesCall::SetProperty {
+ token_id,
+ key,
+ value,
+ ..
+ } => {
+ let token_id: TokenId = token_id.try_into().ok()?;
+ withdraw_set_existing_token_property::<T>(
+ &collection,
+ who,
+ &token_id,
+ key.len() + value.len(),
+ )
+ .map(|()| sponsor)
+ }
+ TokenPropertiesCall::SetProperties {
+ token_id,
+ properties,
+ ..
+ } => {
+ let token_id: TokenId = token_id.try_into().ok()?;
+ let data_size = properties
+ .into_iter()
+ .map(|p| p.key().len() + p.value().len())
+ .sum();
+
+ withdraw_set_existing_token_property::<T>(
+ &collection,
+ who,
+ &token_id,
+ data_size,
+ )
+ .map(|()| sponsor)
+ }
+ _ => None,
+ },
+ UniqueNFTCall::ERC721UniqueExtensions(call) => match call {
+ ERC721UniqueExtensionsCall::Transfer { token_id, .. } => {
+ let token_id: TokenId = token_id.try_into().ok()?;
+ withdraw_transfer::<T>(&collection, who, &token_id)
+ .map(|()| sponsor)
+ }
+ ERC721UniqueExtensionsCall::MintCross { properties, .. } => {
+ withdraw_create_item::<T>(
+ &collection,
+ who,
+ &CreateItemData::NFT(CreateNftData::default()),
+ )?;
+
+ let token_id =
+ <NonfungiblePallet<T>>::next_token_id(&collection).ok()?;
+ let data_size: usize = properties
+ .into_iter()
+ .map(|p| p.key().len() + p.value().len())
+ .sum();
+
+ withdraw_set_token_property::<T>(&collection, &token_id, data_size)
+ .map(|()| sponsor)
+ }
+ _ => None,
+ },
UniqueNFTCall::ERC721UniqueMintable(
ERC721UniqueMintableCall::Mint { .. }
| ERC721UniqueMintableCall::MintCheckId { .. }
runtime/common/ethereum/sponsoring/refungible.rsdiffbeforeafterboth--- a/runtime/common/ethereum/sponsoring/refungible.rs
+++ b/runtime/common/ethereum/sponsoring/refungible.rs
@@ -94,7 +94,12 @@
..
} => {
let token_id = TokenId::try_from(token_id).ok()?;
- withdraw_set_token_property::<T>(&collection, who, &token_id, key.len() + value.len())
+ withdraw_set_existing_token_property::<T>(
+ &collection,
+ who,
+ &token_id,
+ key.len() + value.len(),
+ )
}
}
}
runtime/common/sponsoring.rsdiffbeforeafterboth--- a/runtime/common/sponsoring.rs
+++ b/runtime/common/sponsoring.rs
@@ -39,7 +39,7 @@
impl<T> Config for T where T: UniqueConfig + FungibleConfig + NonfungibleConfig + RefungibleConfig {}
// TODO: permission check?
-pub fn withdraw_set_token_property<T: Config>(
+pub fn withdraw_set_existing_token_property<T: Config>(
collection: &CollectionHandle<T>,
who: &T::CrossAccountId,
item_id: &TokenId,
@@ -64,6 +64,17 @@
}
}
+ withdraw_set_token_property(collection, item_id, data_size)
+}
+
+pub fn withdraw_set_token_property<T: Config>(
+ collection: &CollectionHandle<T>,
+ item_id: &TokenId,
+ data_size: usize,
+) -> Option<()> {
+ if data_size == 0 {
+ return Some(());
+ }
if data_size > collection.limits.sponsored_data_size() as usize {
return None;
}
@@ -173,7 +184,6 @@
return None;
}
}
-
CreateItemBasket::<T>::insert((collection.id, who.as_sub()), block_number);
Some(())
@@ -237,7 +247,7 @@
..
} => {
let (sponsor, collection) = load::<T>(*collection_id)?;
- withdraw_set_token_property(
+ withdraw_set_existing_token_property(
&collection,
&T::CrossAccountId::from_sub(who.clone()),
token_id,
runtime/tests/Cargo.tomldiffbeforeafterboth--- a/runtime/tests/Cargo.toml
+++ b/runtime/tests/Cargo.toml
@@ -5,6 +5,7 @@
[features]
default = ['refungible']
+tests = ['pallet-common/tests']
refungible = []
runtime/tests/src/tests.rsdiffbeforeafterboth--- a/runtime/tests/src/tests.rs
+++ b/runtime/tests/src/tests.rs
@@ -1737,6 +1737,11 @@
let collection_id = create_test_collection(&CollectionMode::NFT, CollectionId(1));
let origin1 = RuntimeOrigin::signed(1);
+ assert_ok!(Unique::add_collection_admin(
+ origin1.clone(),
+ collection_id,
+ account(1)
+ ));
let data = default_nft_data();
create_test_item(collection_id, &data.into());
@@ -2610,3 +2615,67 @@
));
});
}
+
+mod check_token_permissions {
+ use super::*;
+ use frame_support::once_cell::sync::Lazy;
+ use pallet_common::LazyValue;
+ use sp_runtime::DispatchError;
+
+ fn test<FTE: FnOnce() -> bool>(
+ i: usize,
+ test_case: &pallet_common::tests::TestCase,
+ check_token_existence: &mut LazyValue<bool, FTE>,
+ ) {
+ let collection_admin = test_case.collection_admin;
+ let mut is_collection_admin = LazyValue::new(|| test_case.is_collection_admin);
+ let token_owner = test_case.token_owner;
+ let mut is_token_owner = LazyValue::new(|| Ok(test_case.is_token_owner));
+ let is_no_permission = test_case.no_permission;
+
+ let result = pallet_common::tests::check_token_permissions::<Test, _, _, FTE>(
+ collection_admin,
+ token_owner,
+ &mut is_collection_admin,
+ &mut is_token_owner,
+ check_token_existence,
+ );
+
+ if is_no_permission {
+ assert!(
+ result.is_err(),
+ "{i}: {test_case:?}, token_exist: {}",
+ check_token_existence.value()
+ );
+ assert_err!(result, pallet_common::Error::<Test>::NoPermission,);
+ } else if check_token_existence.has_value() && !check_token_existence.value() {
+ assert!(
+ result.is_err(),
+ "{i}: {test_case:?}, token_exist: {}",
+ check_token_existence.value()
+ );
+ assert_err!(result, pallet_common::Error::<Test>::TokenNotFound,);
+ }
+ }
+
+ #[test]
+ fn no_permission_only() {
+ new_test_ext().execute_with(|| {
+ let mut check_token_existence = LazyValue::new(|| true);
+ for (i, row) in pallet_common::tests::table.iter().enumerate() {
+ test(i, row, &mut check_token_existence);
+ }
+ });
+ }
+
+ #[test]
+ fn no_permission_and_token_not_found() {
+ new_test_ext().execute_with(|| {
+ for (i, row) in pallet_common::tests::table.iter().enumerate() {
+ // This is inside the loop to keep track of whether the lambda was called
+ let mut check_token_existence = LazyValue::new(|| false);
+ test(i, row, &mut check_token_existence);
+ }
+ });
+ }
+}
tests/src/createMultipleItemsEx.test.tsdiffbeforeafterboth--- a/tests/src/createMultipleItemsEx.test.ts
+++ b/tests/src/createMultipleItemsEx.test.ts
@@ -195,7 +195,7 @@
description: 'descr',
tokenPrefix: 'COL',
tokenPropertyPermissions: [
- {key: 'k', permission: {tokenOwner: true, mutable: false, collectionAdmin: false}},
+ {key: 'k', permission: {tokenOwner: false, mutable: false, collectionAdmin: true}},
],
});
tests/src/eth/collectionSponsoring.test.tsdiffbeforeafterboth--- a/tests/src/eth/collectionSponsoring.test.ts
+++ b/tests/src/eth/collectionSponsoring.test.ts
@@ -17,6 +17,7 @@
import {IKeyringPair} from '@polkadot/types/types';
import {Pallets, requirePalletsOrSkip, usingPlaygrounds} from '../util/index';
import {itEth, expect} from './util';
+import {CollectionLimitField, TokenPermissionField} from './util/playgrounds/types';
describe('evm nft collection sponsoring', () => {
let donor: IKeyringPair;
@@ -138,8 +139,7 @@
expect(sponsorship.Confirmed).to.be.eq(helper.address.ethToSubstrate(sponsorEth, true));
// Create user with no balance:
- const user = helper.eth.createAccount();
- const userCross = helper.ethCrossAccount.fromAddress(user);
+ const user = helper.ethCrossAccount.createAccount();
const nextTokenId = await collectionEvm.methods.nextTokenId().call();
expect(nextTokenId).to.be.equal('1');
@@ -149,20 +149,29 @@
expect(oldPermissions.access).to.be.equal('Normal');
await collectionEvm.methods.setCollectionAccess(1 /*'AllowList'*/).send({from: owner});
- await collectionEvm.methods.addToCollectionAllowListCross(userCross).send({from: owner});
+ await collectionEvm.methods.addToCollectionAllowListCross(user).send({from: owner});
await collectionEvm.methods.setCollectionMintMode(true).send({from: owner});
+ await collectionEvm.methods.setCollectionLimit({field: CollectionLimitField.SponsoredDataRateLimit, value: {status: true, value: 30}}).send();
const newPermissions = (await collectionSub.getData())!.raw.permissions;
expect(newPermissions.mintMode).to.be.true;
expect(newPermissions.access).to.be.equal('AllowList');
+ // Set token permissions
+ await collectionEvm.methods.setTokenPropertyPermissions([
+ ['key', [
+ [TokenPermissionField.TokenOwner, true],
+ ],
+ ],
+ ]).send({from: owner});
+
const ownerBalanceBefore = await helper.balance.getSubstrate(helper.address.ethToSubstrate(owner));
const sponsorBalanceBefore = await helper.balance.getSubstrate(helper.address.ethToSubstrate(sponsorEth));
- const userBalanceBefore = await helper.balance.getSubstrate(helper.address.ethToSubstrate(user));
+ const userBalanceBefore = await helper.balance.getSubstrate(helper.address.ethToSubstrate(user.eth));
// User can mint token without balance:
{
- const result = await collectionEvm.methods.mintWithTokenURI(user, 'Test URI').send({from: user});
+ const result = await collectionEvm.methods.mintCross(user, [{key: 'key', value: Buffer.from('Value')}]).send({from: user.eth});
const event = helper.eth.normalizeEvents(result.events)
.find(event => event.event === 'Transfer');
@@ -171,22 +180,102 @@
event: 'Transfer',
args: {
from: '0x0000000000000000000000000000000000000000',
- to: user,
+ to: user.eth,
tokenId: '1',
},
});
+ // await collectionEvm.methods.setProperties(1, [{key: 'key', value: Buffer.from('Value1')}]).send({from: user.eth});
+
const ownerBalanceAfter = await helper.balance.getSubstrate(helper.address.ethToSubstrate(owner));
const sponsorBalanceAfter = await helper.balance.getSubstrate(helper.address.ethToSubstrate(sponsorEth));
- const userBalanceAfter = await helper.balance.getSubstrate(helper.address.ethToSubstrate(user));
+ const userBalanceAfter = await helper.balance.getSubstrate(helper.address.ethToSubstrate(user.eth));
- expect(await collectionEvm.methods.tokenURI(nextTokenId).call()).to.be.equal('Test URI');
+ expect(await collectionEvm.methods.properties(nextTokenId, []).call())
+ .to.be.like([
+ [
+ 'key',
+ '0x' + Buffer.from('Value').toString('hex'),
+ ],
+ ]);
expect(ownerBalanceBefore).to.be.eq(ownerBalanceAfter);
expect(userBalanceAfter).to.be.eq(userBalanceBefore);
expect(sponsorBalanceBefore > sponsorBalanceAfter).to.be.true;
}
}));
+ itEth('Can sponsor [set token properties] via access list', async ({helper}) => {
+ const owner = await helper.eth.createAccountWithBalance(donor);
+ const sponsorEth = await helper.eth.createAccountWithBalance(donor);
+ const sponsorCrossEth = helper.ethCrossAccount.fromAddress(sponsorEth);
+
+ const {collectionAddress} = await helper.eth.createERC721MetadataCompatibleNFTCollection(owner, 'Sponsor collection', '1', '1', '');
+ const collectionEvm = await helper.ethNativeContract.collection(collectionAddress, 'nft', owner, false);
+
+ // Set collection sponsor:
+ await collectionEvm.methods.setCollectionSponsorCross(sponsorCrossEth).send({from: owner});
+
+ // Sponsor can confirm sponsorship:
+ await collectionEvm.methods.confirmCollectionSponsorship().send({from: sponsorEth});
+
+ // Create user with no balance:
+ const user = helper.ethCrossAccount.createAccount();
+ const nextTokenId = await collectionEvm.methods.nextTokenId().call();
+ expect(nextTokenId).to.be.equal('1');
+
+ // Set collection permissions:
+ await collectionEvm.methods.setCollectionAccess(1 /*'AllowList'*/).send({from: owner});
+ await collectionEvm.methods.addToCollectionAllowListCross(user).send({from: owner});
+ await collectionEvm.methods.setCollectionMintMode(true).send({from: owner});
+ await collectionEvm.methods.setCollectionLimit({field: CollectionLimitField.SponsoredDataRateLimit, value: {status: true, value: 30}}).send();
+
+ // Set token permissions
+ await collectionEvm.methods.setTokenPropertyPermissions([
+ ['key', [
+ [TokenPermissionField.TokenOwner, true],
+ ],
+ ],
+ ]).send({from: owner});
+
+ const ownerBalanceBefore = await helper.balance.getSubstrate(helper.address.ethToSubstrate(owner));
+ const sponsorBalanceBefore = await helper.balance.getSubstrate(helper.address.ethToSubstrate(sponsorEth));
+ const userBalanceBefore = await helper.balance.getSubstrate(helper.address.ethToSubstrate(user.eth));
+
+ // User can mint token without balance:
+ {
+ const result = await collectionEvm.methods.mintCross(user, []).send({from: user.eth});
+ const event = helper.eth.normalizeEvents(result.events)
+ .find(event => event.event === 'Transfer');
+
+ expect(event).to.be.deep.equal({
+ address: collectionAddress,
+ event: 'Transfer',
+ args: {
+ from: '0x0000000000000000000000000000000000000000',
+ to: user.eth,
+ tokenId: '1',
+ },
+ });
+
+ await collectionEvm.methods.setProperties(1, [{key: 'key', value: Buffer.from('Value')}]).send({from: user.eth});
+
+ const ownerBalanceAfter = await helper.balance.getSubstrate(helper.address.ethToSubstrate(owner));
+ const sponsorBalanceAfter = await helper.balance.getSubstrate(helper.address.ethToSubstrate(sponsorEth));
+ const userBalanceAfter = await helper.balance.getSubstrate(helper.address.ethToSubstrate(user.eth));
+
+ expect(await collectionEvm.methods.properties(nextTokenId, []).call())
+ .to.be.like([
+ [
+ 'key',
+ '0x' + Buffer.from('Value').toString('hex'),
+ ],
+ ]);
+ expect(ownerBalanceBefore).to.be.eq(ownerBalanceAfter);
+ expect(userBalanceAfter).to.be.eq(userBalanceBefore);
+ expect(sponsorBalanceBefore > sponsorBalanceAfter).to.be.true;
+ }
+ });
+
// TODO: Temprorary off. Need refactor
// itWeb3('Sponsoring collection from substrate address via access list', async ({api, web3, privateKeyWrapper}) => {
// const owner = await createEthAccountWithBalance(api, web3, privateKeyWrapper);
@@ -456,6 +545,15 @@
expect(newPermissions.mintMode).to.be.true;
expect(newPermissions.access).to.be.equal('AllowList');
+ // Set token permissions
+ await collectionEvm.methods.setTokenPropertyPermissions([
+ ['URI', [
+ [TokenPermissionField.TokenOwner, true],
+ [TokenPermissionField.CollectionAdmin, true],
+ ],
+ ],
+ ]).send({from: owner});
+
const ownerBalanceBefore = await helper.balance.getSubstrate(helper.address.ethToSubstrate(owner));
const sponsorBalanceBefore = await helper.balance.getSubstrate(helper.address.ethToSubstrate(sponsorEth));
const userBalanceBefore = await helper.balance.getSubstrate(helper.address.ethToSubstrate(user));
@@ -623,6 +721,15 @@
await collectionEvm.methods.addToCollectionAllowListCross(userCross).send({from: owner});
await collectionEvm.methods.setCollectionMintMode(true).send({from: owner});
+ // Set token permissions
+ await collectionEvm.methods.setTokenPropertyPermissions([
+ ['URI', [
+ [TokenPermissionField.TokenOwner, true],
+ [TokenPermissionField.CollectionAdmin, true],
+ ],
+ ],
+ ]).send({from: owner});
+
const ownerBalanceBefore = await helper.balance.getSubstrate(helper.address.ethToSubstrate(owner));
const sponsorBalanceBefore = await helper.balance.getSubstrate(sponsor.address);
const userBalanceBefore = await helper.balance.getSubstrate(helper.address.ethToSubstrate(user));
tests/src/eth/tokenProperties.test.tsdiffbeforeafterboth--- a/tests/src/eth/tokenProperties.test.ts
+++ b/tests/src/eth/tokenProperties.test.ts
@@ -553,6 +553,63 @@
]).call({from: owner})).to.be.rejectedWith('NoPermission');
}
}));
+
+ [
+ {mode: 'nft' as const, requiredPallets: []},
+ {mode: 'rft' as const, requiredPallets: [Pallets.ReFungible]},
+ ].map(testCase =>
+ itEth.ifWithPallets(`[${testCase.mode}] Can't be multiple set/read for non-existent token`, testCase.requiredPallets, async({helper}) => {
+ const caller = await helper.eth.createAccountWithBalance(donor);
+
+ const properties = Array(5).fill(0).map((_, i) => { return {key: `key_${i}`, value: Buffer.from(`value_${i}`)}; });
+ const permissions: ITokenPropertyPermission[] = properties.map(p => { return {key: p.key, permission: {tokenOwner: true,
+ collectionAdmin: true,
+ mutable: true}}; });
+
+ const collection = await helper[testCase.mode].mintCollection(alice, {
+ tokenPrefix: 'ethp',
+ tokenPropertyPermissions: permissions,
+ }) as UniqueNFTCollection | UniqueRFTCollection;
+
+ await collection.addAdmin(alice, {Ethereum: caller});
+
+ const address = helper.ethAddress.fromCollectionId(collection.collectionId);
+ const contract = await helper.ethNativeContract.collection(address, testCase.mode, caller);
+
+ await expect(contract.methods.setProperties(1, properties).call({from: caller})).to.be.rejectedWith('TokenNotFound');
+ }));
+
+ [
+ {mode: 'nft' as const, requiredPallets: []},
+ {mode: 'rft' as const, requiredPallets: [Pallets.ReFungible]},
+ ].map(testCase =>
+ itEth.ifWithPallets(`[${testCase.mode}] Can't be deleted for non-existent token`, testCase.requiredPallets, async({helper}) => {
+ const caller = await helper.eth.createAccountWithBalance(donor);
+ const collection = await helper[testCase.mode].mintCollection(alice, {
+ tokenPropertyPermissions: [{
+ key: 'testKey',
+ permission: {
+ mutable: true,
+ collectionAdmin: true,
+ },
+ },
+ {
+ key: 'testKey_1',
+ permission: {
+ mutable: true,
+ collectionAdmin: true,
+ },
+ }],
+ });
+
+
+ await collection.addAdmin(alice, {Ethereum: caller});
+
+ const address = helper.ethAddress.fromCollectionId(collection.collectionId);
+ const contract = await helper.ethNativeContract.collection(address, testCase.mode, caller);
+
+ await expect(contract.methods.deleteProperties(1, ['testKey', 'testKey_1']).call({from: caller})).to.be.rejectedWith('TokenNotFound');
+ }));
});
tests/src/getPropertiesRpc.test.tsdiffbeforeafterboth--- a/tests/src/getPropertiesRpc.test.ts
+++ b/tests/src/getPropertiesRpc.test.ts
@@ -120,3 +120,31 @@
expect(propPermissions).to.be.deep.equal(tokenPropPermissions);
});
});
+
+[
+ {mode: 'nft' as const},
+ {mode: 'rft' as const},
+].map(testCase =>
+ describe('negative properties', () => {
+ let alice: IKeyringPair;
+
+ before(async () => {
+ await usingPlaygrounds(async (_, privateKey) => {
+ alice = await privateKey({url: import.meta.url});
+ });
+ });
+
+ itSub(`[${testCase.mode}] set token property for non-existent token`, async ({helper}) => {
+ const collection = await helper[testCase.mode].mintCollection(alice);
+ await collection.setTokenPropertyPermissions(alice, [{key: 'key', permission: {mutable: true, tokenOwner: true, collectionAdmin: true}}]);
+ await expect(collection.setTokenProperties(alice, 1, [{key: 'key', value: 'value'}])).to.be.rejectedWith('common.TokenNotFound');
+ expect(await collection.getTokenProperties(1, ['key'])).to.be.empty;
+ });
+
+ itSub(`[${testCase.mode}] delete token property for non-existent token`, async ({helper}) => {
+ const collection = await helper[testCase.mode].mintCollection(alice);
+ await collection.setTokenPropertyPermissions(alice, [{key: 'key', permission: {mutable: true, tokenOwner: true, collectionAdmin: true}}]);
+ await expect(collection.deleteTokenProperties(alice, 1, ['key'])).to.be.rejectedWith('common.TokenNotFound');
+ expect(await collection.getTokenProperties(1, ['key'])).to.be.empty;
+ });
+ }));
\ No newline at end of file
tests/src/nesting/tokenProperties.test.tsdiffbeforeafterboth1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// This file is part of Unique Network.34// Unique Network is free software: you can redistribute it and/or modify5// it under the terms of the GNU General Public License as published by6// the Free Software Foundation, either version 3 of the License, or7// (at your option) any later version.89// Unique Network is distributed in the hope that it will be useful,10// but WITHOUT ANY WARRANTY; without even the implied warranty of11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the12// GNU General Public License for more details.1314// You should have received a copy of the GNU General Public License15// along with Unique Network. If not, see <http://www.gnu.org/licenses/>.1617import {IKeyringPair} from '@polkadot/types/types';18import {itSub, Pallets, requirePalletsOrSkip, usingPlaygrounds, expect, sizeOfProperty} from '../util';19import {UniqueHelper, UniqueNFToken, UniqueRFToken} from '../util/playgrounds/unique';2021describe('Integration Test: Token Properties', () => {22 let alice: IKeyringPair; // collection owner23 let bob: IKeyringPair; // collection admin24 let charlie: IKeyringPair; // token owner2526 let permissions: {permission: any, signers: IKeyringPair[]}[];2728 before(async () => {29 await usingPlaygrounds(async (helper, privateKey) => {30 const donor = await privateKey({url: import.meta.url});31 [alice, bob, charlie] = await helper.arrange.createAccounts([200n, 100n, 100n], donor);32 });3334 permissions = [35 {permission: {mutable: true, collectionAdmin: true}, signers: [alice, bob]},36 {permission: {mutable: false, collectionAdmin: true}, signers: [alice, bob]},37 {permission: {mutable: true, tokenOwner: true}, signers: [charlie]},38 {permission: {mutable: false, tokenOwner: true}, signers: [charlie]},39 {permission: {mutable: true, collectionAdmin: true, tokenOwner: true}, signers: [alice, bob, charlie]},40 {permission: {mutable: false, collectionAdmin: true, tokenOwner: true}, signers: [alice, bob, charlie]},41 ];42 });4344 async function mintCollectionWithAllPermissionsAndToken(helper: UniqueHelper, mode: 'NFT' | 'RFT'): Promise<[UniqueNFToken | UniqueRFToken, bigint]> {45 const collection = await (mode == 'NFT' ? helper.nft : helper.rft).mintCollection(alice, {46 tokenPropertyPermissions: permissions.flatMap(({permission, signers}, i) =>47 signers.map(signer => ({key: `${i+1}_${signer.address}`, permission}))),48 });49 return mode == 'NFT' ? [await collection.mintToken(alice), 1n] : [await collection.mintToken(alice, 100n as any), 100n];50 }5152 async function testReadsYetEmptyProperties(token: UniqueNFToken | UniqueRFToken) {53 const properties = await token.getProperties();54 expect(properties).to.be.empty;5556 const tokenData = await token.getData();57 expect(tokenData!.properties).to.be.empty;58 }5960 itSub('Reads yet empty properties of a token (NFT)', async ({helper}) => {61 const collection = await helper.nft.mintCollection(alice);62 const token = await collection.mintToken(alice);63 await testReadsYetEmptyProperties(token);64 });6566 itSub.ifWithPallets('Reads yet empty properties of a token (ReFungible)', [Pallets.ReFungible], async ({helper}) => {67 const collection = await helper.rft.mintCollection(alice);68 const token = await collection.mintToken(alice);69 await testReadsYetEmptyProperties(token);70 });7172 async function testAssignPropertiesAccordingToPermissions(token: UniqueNFToken | UniqueRFToken, pieces: bigint) {73 await token.collection.addAdmin(alice, {Substrate: bob.address});74 await token.transfer(alice, {Substrate: charlie.address}, pieces);7576 const propertyKeys: string[] = [];77 let i = 0;78 for(const permission of permissions) {79 i++;80 let j = 0;81 for(const signer of permission.signers) {82 j++;83 const key = i + '_' + signer.address;84 propertyKeys.push(key);8586 await expect(87 token.setProperties(signer, [{key: key, value: 'Serotonin increase'}]),88 `on adding property #${i} by signer #${j}`,89 ).to.be.fulfilled;90 }91 }9293 const properties = await token.getProperties(propertyKeys);94 const tokenData = await token.getData();95 for(let i = 0; i < properties.length; i++) {96 expect(properties[i].value).to.be.equal('Serotonin increase');97 expect(tokenData!.properties[i].value).to.be.equal('Serotonin increase');98 }99 }100101 itSub('Assigns properties to a token according to permissions (NFT)', async ({helper}) => {102 const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'NFT');103 await testAssignPropertiesAccordingToPermissions(token, amount);104 });105106 itSub.ifWithPallets('Assigns properties to a token according to permissions (ReFungible)', [Pallets.ReFungible], async ({helper}) => {107 const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'RFT');108 await testAssignPropertiesAccordingToPermissions(token, amount);109 });110111 async function testChangesPropertiesAccordingPermission(token: UniqueNFToken | UniqueRFToken, pieces: bigint) {112 await token.collection.addAdmin(alice, {Substrate: bob.address});113 await token.transfer(alice, {Substrate: charlie.address}, pieces);114115 const propertyKeys: string[] = [];116 let i = 0;117 for(const permission of permissions) {118 i++;119 if(!permission.permission.mutable) continue;120121 let j = 0;122 for(const signer of permission.signers) {123 j++;124 const key = i + '_' + signer.address;125 propertyKeys.push(key);126127 await expect(128 token.setProperties(signer, [{key, value: 'Serotonin increase'}]),129 `on adding property #${i} by signer #${j}`,130 ).to.be.fulfilled;131132 await expect(133 token.setProperties(signer, [{key, value: 'Serotonin stable'}]),134 `on changing property #${i} by signer #${j}`,135 ).to.be.fulfilled;136 }137 }138139 const properties = await token.getProperties(propertyKeys);140 const tokenData = await token.getData();141 for(let i = 0; i < properties.length; i++) {142 expect(properties[i].value).to.be.equal('Serotonin stable');143 expect(tokenData!.properties[i].value).to.be.equal('Serotonin stable');144 }145 }146147 itSub('Changes properties of a token according to permissions (NFT)', async ({helper}) => {148 const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'NFT');149 await testChangesPropertiesAccordingPermission(token, amount);150 });151152 itSub.ifWithPallets('Changes properties of a token according to permissions (ReFungible)', [Pallets.ReFungible], async ({helper}) => {153 const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'RFT');154 await testChangesPropertiesAccordingPermission(token, amount);155 });156157 async function testDeletePropertiesAccordingPermission(token: UniqueNFToken | UniqueRFToken, pieces: bigint) {158 await token.collection.addAdmin(alice, {Substrate: bob.address});159 await token.transfer(alice, {Substrate: charlie.address}, pieces);160161 const propertyKeys: string[] = [];162 let i = 0;163164 for(const permission of permissions) {165 i++;166 if(!permission.permission.mutable) continue;167168 let j = 0;169 for(const signer of permission.signers) {170 j++;171 const key = i + '_' + signer.address;172 propertyKeys.push(key);173174 await expect(175 token.setProperties(signer, [{key, value: 'Serotonin increase'}]),176 `on adding property #${i} by signer #${j}`,177 ).to.be.fulfilled;178179 await expect(180 token.deleteProperties(signer, [key]),181 `on deleting property #${i} by signer #${j}`,182 ).to.be.fulfilled;183 }184 }185186 expect(await token.getProperties(propertyKeys)).to.be.empty;187 expect((await token.getData())!.properties).to.be.empty;188 }189190 itSub('Deletes properties of a token according to permissions (NFT)', async ({helper}) => {191 const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'NFT');192 await testDeletePropertiesAccordingPermission(token, amount);193 });194195 itSub.ifWithPallets('Deletes properties of a token according to permissions (ReFungible)', [Pallets.ReFungible], async ({helper}) => {196 const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'RFT');197 await testDeletePropertiesAccordingPermission(token, amount);198 });199200 itSub('Assigns properties to a nested token according to permissions', async ({helper}) => {201 const collectionA = await helper.nft.mintCollection(alice, {permissions: {nesting: {tokenOwner: true}}});202 const collectionB = await helper.nft.mintCollection(alice, {203 tokenPropertyPermissions: permissions.flatMap(({permission, signers}, i) =>204 signers.map(signer => ({key: `${i+1}_${signer.address}`, permission}))),205 });206 const targetToken = await collectionA.mintToken(alice);207 const nestedToken = await collectionB.mintToken(alice, targetToken.nestingAccount());208209 await collectionB.addAdmin(alice, {Substrate: bob.address});210 await targetToken.transfer(alice, {Substrate: charlie.address});211212 const propertyKeys: string[] = [];213 let i = 0;214 for(const permission of permissions) {215 i++;216 let j = 0;217 for(const signer of permission.signers) {218 j++;219 const key = i + '_' + signer.address;220 propertyKeys.push(key);221222 await expect(223 nestedToken.setProperties(signer, [{key, value: 'Serotonin increase'}]),224 `on adding property #${i} by signer #${j}`,225 ).to.be.fulfilled;226 }227 }228229 const properties = await nestedToken.getProperties(propertyKeys);230 const tokenData = await nestedToken.getData();231 for(let i = 0; i < properties.length; i++) {232 expect(properties[i].value).to.be.equal('Serotonin increase');233 expect(tokenData!.properties[i].value).to.be.equal('Serotonin increase');234 }235 expect(await targetToken.getProperties()).to.be.empty;236 });237238 itSub('Changes properties of a nested token according to permissions', async ({helper}) => {239 const collectionA = await helper.nft.mintCollection(alice, {permissions: {nesting: {tokenOwner: true}}});240 const collectionB = await helper.nft.mintCollection(alice, {241 tokenPropertyPermissions: permissions.flatMap(({permission, signers}, i) =>242 signers.map(signer => ({key: `${i+1}_${signer.address}`, permission}))),243 });244 const targetToken = await collectionA.mintToken(alice);245 const nestedToken = await collectionB.mintToken(alice, targetToken.nestingAccount());246247 await collectionB.addAdmin(alice, {Substrate: bob.address});248 await targetToken.transfer(alice, {Substrate: charlie.address});249250 const propertyKeys: string[] = [];251 let i = 0;252 for(const permission of permissions) {253 i++;254 if(!permission.permission.mutable) continue;255256 let j = 0;257 for(const signer of permission.signers) {258 j++;259 const key = i + '_' + signer.address;260 propertyKeys.push(key);261262 await expect(263 nestedToken.setProperties(signer, [{key, value: 'Serotonin increase'}]),264 `on adding property #${i} by signer #${j}`,265 ).to.be.fulfilled;266267 await expect(268 nestedToken.setProperties(signer, [{key, value: 'Serotonin stable'}]),269 `on changing property #${i} by signer #${j}`,270 ).to.be.fulfilled;271 }272 }273274 const properties = await nestedToken.getProperties(propertyKeys);275 const tokenData = await nestedToken.getData();276 for(let i = 0; i < properties.length; i++) {277 expect(properties[i].value).to.be.equal('Serotonin stable');278 expect(tokenData!.properties[i].value).to.be.equal('Serotonin stable');279 }280 expect(await targetToken.getProperties()).to.be.empty;281 });282283 itSub('Deletes properties of a nested token according to permissions', async ({helper}) => {284 const collectionA = await helper.nft.mintCollection(alice, {permissions: {nesting: {tokenOwner: true}}});285 const collectionB = await helper.nft.mintCollection(alice, {286 tokenPropertyPermissions: permissions.flatMap(({permission, signers}, i) =>287 signers.map(signer => ({key: `${i+1}_${signer.address}`, permission}))),288 });289 const targetToken = await collectionA.mintToken(alice);290 const nestedToken = await collectionB.mintToken(alice, targetToken.nestingAccount());291292 await collectionB.addAdmin(alice, {Substrate: bob.address});293 await targetToken.transfer(alice, {Substrate: charlie.address});294295 const propertyKeys: string[] = [];296 let i = 0;297 for(const permission of permissions) {298 i++;299 if(!permission.permission.mutable) continue;300301 let j = 0;302 for(const signer of permission.signers) {303 j++;304 const key = i + '_' + signer.address;305 propertyKeys.push(key);306307 await expect(308 nestedToken.setProperties(signer, [{key, value: 'Serotonin increase'}]),309 `on adding property #${i} by signer #${j}`,310 ).to.be.fulfilled;311312 await expect(313 nestedToken.deleteProperties(signer, [key]),314 `on deleting property #${i} by signer #${j}`,315 ).to.be.fulfilled;316 }317 }318319 expect(await nestedToken.getProperties(propertyKeys)).to.be.empty;320 expect((await nestedToken.getData())!.properties).to.be.empty;321 expect(await targetToken.getProperties()).to.be.empty;322 });323324 [325 {mode: 'nft' as const, storage: 'nonfungible' as const, pieces: undefined, requiredPallets: []} as const,326 {mode: 'rft' as const, storage: 'refungible' as const, pieces: 100n, requiredPallets: [Pallets.ReFungible]} as const,327 ].map(testCase =>328 itSub.ifWithPallets(`Allows modifying a token property multiple times with the same size (${testCase.mode})`, testCase.requiredPallets, async({helper}) => {329 const propKey = 'tok-prop';330331 const collection = await helper[testCase.mode].mintCollection(alice, {332 tokenPropertyPermissions: [333 {334 key: propKey,335 permission: {mutable: true, tokenOwner: true},336 },337 ],338 });339340 const maxTokenPropertiesSize = 32768;341342 const propDataSize = 4096;343344 let propDataChar = 'a';345 const makeNewPropData = () => {346 propDataChar = String.fromCharCode(propDataChar.charCodeAt(0) + 1);347 return `${propDataChar}`.repeat(propDataSize);348 };349350 const token = await (351 testCase.pieces352 ? collection.mintToken(alice, testCase.pieces as any)353 : collection.mintToken(alice)354 );355356 const property = {key: propKey, value: makeNewPropData()};357 await token.setProperties(alice, [property]);358 const originalSpace = await token.getTokenPropertiesConsumedSpace();359 expect(originalSpace).to.be.equal(sizeOfProperty(property));360361 const sameSizePropertiesPossibleNum = maxTokenPropertiesSize / propDataSize;362363 // It is possible to modify a property as many times as needed.364 // It will not consume any additional space.365 for(let i = 0; i < sameSizePropertiesPossibleNum + 1; i++) {366 await token.setProperties(alice, [{key: propKey, value: makeNewPropData()}]);367 const consumedSpace = await token.getTokenPropertiesConsumedSpace();368 expect(consumedSpace).to.be.equal(originalSpace);369 }370 }));371372 [373 {mode: 'nft' as const, pieces: undefined, requiredPallets: []},374 {mode: 'rft' as const, pieces: 100n, requiredPallets: [Pallets.ReFungible]},375 ].map(testCase =>376 itSub.ifWithPallets(`Adding then removing a token property doesn't change the consumed space (${testCase.mode})`, testCase.requiredPallets, async({helper}) => {377 const propKey = 'tok-prop';378379 const collection = await helper[testCase.mode].mintCollection(alice, {380 tokenPropertyPermissions: [381 {382 key: propKey,383 permission: {mutable: true, tokenOwner: true},384 },385 ],386 });387 const token = await (388 testCase.pieces389 ? collection.mintToken(alice, testCase.pieces as any)390 : collection.mintToken(alice)391 );392 const originalSpace = await token.getTokenPropertiesConsumedSpace();393394 const propDataSize = 4096;395 const propData = 'a'.repeat(propDataSize);396397 const property = {key: propKey, value: propData};398 await token.setProperties(alice, [property]);399 let consumedSpace = await token.getTokenPropertiesConsumedSpace();400 expect(consumedSpace).to.be.equal(sizeOfProperty(property));401402 await token.deleteProperties(alice, [propKey]);403 consumedSpace = await token.getTokenPropertiesConsumedSpace();404 expect(consumedSpace).to.be.equal(originalSpace);405 }));406407 [408 {mode: 'nft' as const, pieces: undefined, requiredPallets: []},409 {mode: 'rft' as const, pieces: 100n, requiredPallets: [Pallets.ReFungible]},410 ].map(testCase =>411 itSub.ifWithPallets(`Modifying a token property with different sizes correctly changes the consumed space (${testCase.mode})`, testCase.requiredPallets, async({helper}) => {412 const propKey = 'tok-prop';413414 const collection = await helper[testCase.mode].mintCollection(alice, {415 tokenPropertyPermissions: [416 {417 key: propKey,418 permission: {mutable: true, tokenOwner: true},419 },420 ],421 });422 const token = await (423 testCase.pieces424 ? collection.mintToken(alice, testCase.pieces as any)425 : collection.mintToken(alice)426 );427 const originalSpace = await token.getTokenPropertiesConsumedSpace();428429 const initProp = {key: propKey, value: 'a'.repeat(4096)};430 const biggerProp = {key: propKey, value: 'b'.repeat(5000)};431 const smallerProp = {key: propKey, value: 'c'.repeat(4000)};432433 let consumedSpace;434 let expectedConsumedSpaceDiff;435436 await token.setProperties(alice, [initProp]);437 consumedSpace = await token.getTokenPropertiesConsumedSpace();438 expectedConsumedSpaceDiff = sizeOfProperty(initProp) - originalSpace;439 expect(consumedSpace).to.be.equal(originalSpace + expectedConsumedSpaceDiff);440441 await token.setProperties(alice, [biggerProp]);442 consumedSpace = await token.getTokenPropertiesConsumedSpace();443 expectedConsumedSpaceDiff = sizeOfProperty(biggerProp) - sizeOfProperty(initProp);444 expect(consumedSpace).to.be.equal(sizeOfProperty(initProp) + expectedConsumedSpaceDiff);445446 await token.setProperties(alice, [smallerProp]);447 consumedSpace = await token.getTokenPropertiesConsumedSpace();448 expectedConsumedSpaceDiff = sizeOfProperty(biggerProp) - sizeOfProperty(smallerProp);449 expect(consumedSpace).to.be.equal(sizeOfProperty(biggerProp) - expectedConsumedSpaceDiff);450 }));451});452453describe('Negative Integration Test: Token Properties', () => {454 let alice: IKeyringPair; // collection owner455 let bob: IKeyringPair; // collection admin456 let charlie: IKeyringPair; // token owner457458 let constitution: {permission: any, signers: IKeyringPair[], sinner: IKeyringPair}[];459460 before(async () => {461 await usingPlaygrounds(async (helper, privateKey) => {462 const donor = await privateKey({url: import.meta.url});463 let dave: IKeyringPair;464 [alice, bob, charlie, dave] = await helper.arrange.createAccounts([100n, 100n, 100n, 100n], donor);465466 // todo:playgrounds probably separate these tests later467 constitution = [468 {permission: {mutable: true, collectionAdmin: true}, signers: [alice, bob], sinner: charlie},469 {permission: {mutable: false, collectionAdmin: true}, signers: [alice, bob], sinner: charlie},470 {permission: {mutable: true, tokenOwner: true}, signers: [charlie], sinner: alice},471 {permission: {mutable: false, tokenOwner: true}, signers: [charlie], sinner: alice},472 {permission: {mutable: true, collectionAdmin: true, tokenOwner: true}, signers: [alice, bob, charlie], sinner: dave},473 {permission: {mutable: false, collectionAdmin: true, tokenOwner: true}, signers: [alice, bob, charlie], sinner: dave},474 ];475 });476 });477478 async function mintCollectionWithAllPermissionsAndToken(helper: UniqueHelper, mode: 'NFT' | 'RFT'): Promise<[UniqueNFToken | UniqueRFToken, bigint]> {479 const collection = await (mode == 'NFT' ? helper.nft : helper.rft).mintCollection(alice, {480 tokenPropertyPermissions: constitution.map(({permission}, i) => ({key: `${i+1}`, permission})),481 });482 return mode == 'NFT' ? [await collection.mintToken(alice), 1n] : [await collection.mintToken(alice, 100n as any), 100n];483 }484485 async function getConsumedSpace(api: any, collectionId: number, tokenId: number, mode: 'NFT' | 'RFT'): Promise<number> {486 return (await (mode == 'NFT' ? api.query.nonfungible : api.query.refungible).tokenProperties(collectionId, tokenId)).toJSON().consumedSpace;487 }488489 async function prepare(token: UniqueNFToken | UniqueRFToken, pieces: bigint): Promise<number> {490 await token.collection.addAdmin(alice, {Substrate: bob.address});491 await token.transfer(alice, {Substrate: charlie.address}, pieces);492493 let i = 0;494 for(const passage of constitution) {495 i++;496 const signer = passage.signers[0];497 await expect(498 token.setProperties(signer, [{key: `${i}`, value: 'Serotonin increase'}]),499 `on adding property ${i} by ${signer.address}`,500 ).to.be.fulfilled;501 }502503 const originalSpace = await getConsumedSpace(token.collection.helper.getApi(), token.collectionId, token.tokenId, pieces == 1n ? 'NFT' : 'RFT');504 return originalSpace;505 }506507 async function testForbidsChangingDeletingPropertiesUserOutsideOfPermissions(token: UniqueNFToken | UniqueRFToken, pieces: bigint) {508 const originalSpace = await prepare(token, pieces);509510 let i = 0;511 for(const forbiddance of constitution) {512 i++;513 if(!forbiddance.permission.mutable) continue;514515 await expect(516 token.setProperties(forbiddance.sinner, [{key: `${i}`, value: 'Serotonin down'}]),517 `on failing to change property ${i} by the malefactor`,518 ).to.be.rejectedWith(/common\.NoPermission/);519520 await expect(521 token.deleteProperties(forbiddance.sinner, [`${i}`]),522 `on failing to delete property ${i} by the malefactor`,523 ).to.be.rejectedWith(/common\.NoPermission/);524 }525526 const consumedSpace = await getConsumedSpace(token.collection.helper.getApi(), token.collectionId, token.tokenId, pieces == 1n ? 'NFT' : 'RFT');527 expect(consumedSpace).to.be.equal(originalSpace);528 }529530 itSub('Forbids changing/deleting properties of a token if the user is outside of permissions (NFT)', async ({helper}) => {531 const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'NFT');532 await testForbidsChangingDeletingPropertiesUserOutsideOfPermissions(token, amount);533 });534535 itSub.ifWithPallets('Forbids changing/deleting properties of a token if the user is outside of permissions (ReFungible)', [Pallets.ReFungible], async ({helper}) => {536 const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'RFT');537 await testForbidsChangingDeletingPropertiesUserOutsideOfPermissions(token, amount);538 });539540 async function testForbidsChangingDeletingPropertiesIfPropertyImmutable(token: UniqueNFToken | UniqueRFToken, pieces: bigint) {541 const originalSpace = await prepare(token, pieces);542543 let i = 0;544 for(const permission of constitution) {545 i++;546 if(permission.permission.mutable) continue;547548 await expect(549 token.setProperties(permission.signers[0], [{key: `${i}`, value: 'Serotonin down'}]),550 `on failing to change property ${i} by signer #0`,551 ).to.be.rejectedWith(/common\.NoPermission/);552553 await expect(554 token.deleteProperties(permission.signers[0], [i.toString()]),555 `on failing to delete property ${i} by signer #0`,556 ).to.be.rejectedWith(/common\.NoPermission/);557 }558559 const consumedSpace = await getConsumedSpace(token.collection.helper.getApi(), token.collectionId, token.tokenId, pieces == 1n ? 'NFT' : 'RFT');560 expect(consumedSpace).to.be.equal(originalSpace);561 }562563 itSub('Forbids changing/deleting properties of a token if the property is permanent (immutable) (NFT)', async ({helper}) => {564 const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'NFT');565 await testForbidsChangingDeletingPropertiesIfPropertyImmutable(token, amount);566 });567568 itSub.ifWithPallets('Forbids changing/deleting properties of a token if the property is permanent (immutable) (ReFungible)', [Pallets.ReFungible], async ({helper}) => {569 const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'RFT');570 await testForbidsChangingDeletingPropertiesIfPropertyImmutable(token, amount);571 });572573 async function testForbidsAddingPropertiesIfPropertyNotDeclared(token: UniqueNFToken | UniqueRFToken, pieces: bigint) {574 const originalSpace = await prepare(token, pieces);575576 await expect(577 token.setProperties(alice, [{key: 'non-existent', value: 'I exist!'}]),578 'on failing to add a previously non-existent property',579 ).to.be.rejectedWith(/common\.NoPermission/);580581 await expect(582 token.collection.setTokenPropertyPermissions(alice, [{key: 'now-existent', permission: {}}]),583 'on setting a new non-permitted property',584 ).to.be.fulfilled;585586 await expect(587 token.setProperties(alice, [{key: 'now-existent', value: 'I exist!'}]),588 'on failing to add a property forbidden by the \'None\' permission',589 ).to.be.rejectedWith(/common\.NoPermission/);590591 expect(await token.getProperties(['non-existent', 'now-existent'])).to.be.empty;592593 const consumedSpace = await getConsumedSpace(token.collection.helper.getApi(), token.collectionId, token.tokenId, pieces == 1n ? 'NFT' : 'RFT');594 expect(consumedSpace).to.be.equal(originalSpace);595 }596597 itSub('Forbids adding properties to a token if the property is not declared / forbidden with the \'None\' permission (NFT)', async ({helper}) => {598 const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'NFT');599 await testForbidsAddingPropertiesIfPropertyNotDeclared(token, amount);600 });601602 itSub.ifWithPallets('Forbids adding properties to a token if the property is not declared / forbidden with the \'None\' permission (ReFungible)', [Pallets.ReFungible], async ({helper}) => {603 const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'RFT');604 await testForbidsAddingPropertiesIfPropertyNotDeclared(token, amount);605 });606607 async function testForbidsAddingTooLargeProperties(token: UniqueNFToken | UniqueRFToken, pieces: bigint) {608 const originalSpace = await prepare(token, pieces);609610 await expect(611 token.collection.setTokenPropertyPermissions(alice, [612 {key: 'a_holy_book', permission: {collectionAdmin: true, tokenOwner: true}},613 {key: 'young_years', permission: {collectionAdmin: true, tokenOwner: true}},614 ]),615 'on setting new permissions for properties',616 ).to.be.fulfilled;617618 // Mute the general tx parsing error619 {620 console.error = () => {};621 await expect(token.setProperties(alice, [{key: 'a_holy_book', value: 'word '.repeat(6554)}]))622 .to.be.rejected;623 }624625 await expect(token.setProperties(alice, [626 {key: 'a_holy_book', value: 'word '.repeat(3277)},627 {key: 'young_years', value: 'neverending'.repeat(1490)},628 ])).to.be.rejectedWith(/common\.NoSpaceForProperty/);629630 expect(await token.getProperties(['a_holy_book', 'young_years'])).to.be.empty;631 const consumedSpace = await getConsumedSpace(token.collection.helper.getApi(), token.collectionId, token.tokenId, pieces == 1n ? 'NFT' : 'RFT');632 expect(consumedSpace).to.be.equal(originalSpace);633 }634635 itSub('Forbids adding too large properties to a token (NFT)', async ({helper}) => {636 const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'NFT');637 await testForbidsAddingTooLargeProperties(token, amount);638 });639640 itSub.ifWithPallets('Forbids adding too large properties to a token (ReFungible)', [Pallets.ReFungible], async ({helper}) => {641 const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'RFT');642 await testForbidsAddingTooLargeProperties(token, amount);643 });644645 [646 {mode: 'nft' as const, requiredPallets: []},647 {mode: 'rft' as const, requiredPallets: [Pallets.ReFungible]},648 ].map(testCase =>649 itSub.ifWithPallets(`Forbids adding too many propeties to a token (${testCase.mode})`, testCase.requiredPallets, async({helper}) => {650 const collection = await helper[testCase.mode].mintCollection(alice);651 const maxPropertiesPerItem = 64;652653 for(let i = 0; i < maxPropertiesPerItem; i++) {654 await collection.setTokenPropertyPermissions(alice, [{655 key: `${i+1}`,656 permission: {mutable: true, tokenOwner: true, collectionAdmin: true},657 }]);658 }659660 await expect(collection.setTokenPropertyPermissions(alice, [{661 key: `${maxPropertiesPerItem}-th`,662 permission: {mutable: true, tokenOwner: true, collectionAdmin: true},663 }])).to.be.rejectedWith(/common\.PropertyLimitReached/);664 }));665666 [667 {mode: 'nft' as const, pieces: undefined, requiredPallets: []},668 {mode: 'rft' as const, pieces: 100n, requiredPallets: [Pallets.ReFungible]},669 ].map(testCase =>670 itSub.ifWithPallets(`Forbids force_repair_item from non-sudo (${testCase.mode})`, testCase.requiredPallets, async({helper}) => {671 const propKey = 'tok-prop';672673 const collection = await helper[testCase.mode].mintCollection(alice, {674 tokenPropertyPermissions: [675 {676 key: propKey,677 permission: {mutable: true, tokenOwner: true},678 },679 ],680 });681 const token = await (682 testCase.pieces683 ? collection.mintToken(alice, testCase.pieces as any)684 : collection.mintToken(alice)685 );686687 const propDataSize = 4096;688 const propData = 'a'.repeat(propDataSize);689 await token.setProperties(alice, [{key: propKey, value: propData}]);690691 await expect(helper.executeExtrinsic(alice, 'api.tx.unique.forceRepairItem', [token.collectionId, token.tokenId], true))692 .to.be.rejectedWith(/BadOrigin/);693 }));694});695696describe('ReFungible token properties permissions tests', () => {697 let alice: IKeyringPair;698 let bob: IKeyringPair;699 let charlie: IKeyringPair;700701 before(async function() {702 await usingPlaygrounds(async (helper, privateKey) => {703 requirePalletsOrSkip(this, helper, [Pallets.ReFungible]);704705 const donor = await privateKey({url: import.meta.url});706 [alice, bob, charlie] = await helper.arrange.createAccounts([100n, 100n, 100n], donor);707 });708 });709710 async function prepare(helper: UniqueHelper): Promise<UniqueRFToken> {711 const collection = await helper.rft.mintCollection(alice);712 const token = await collection.mintToken(alice, 100n);713714 await collection.addAdmin(alice, {Substrate: bob.address});715 await collection.setTokenPropertyPermissions(alice, [{key: 'fractals', permission: {mutable: true, tokenOwner: true}}]);716717 return token;718 }719720 itSub('Forbids adding token property with tokenOwner==true when signer doesn\'t have all pieces', async ({helper}) => {721 const token = await prepare(helper);722723 await token.transfer(alice, {Substrate: charlie.address}, 33n);724725 await expect(token.setProperties(alice, [726 {key: 'fractals', value: 'multiverse'},727 ])).to.be.rejectedWith(/common\.NoPermission/);728 });729730 itSub('Forbids mutating token property with tokenOwner==true when signer doesn\'t have all pieces', async ({helper}) => {731 const token = await prepare(helper);732733 await expect(token.collection.setTokenPropertyPermissions(alice, [{key: 'fractals', permission: {mutable:true, tokenOwner: true}}]))734 .to.be.fulfilled;735736 await expect(token.setProperties(alice, [737 {key: 'fractals', value: 'multiverse'},738 ])).to.be.fulfilled;739740 await token.transfer(alice, {Substrate: charlie.address}, 33n);741742 await expect(token.setProperties(alice, [743 {key: 'fractals', value: 'want to rule the world'},744 ])).to.be.rejectedWith(/common\.NoPermission/);745 });746747 itSub('Forbids deleting token property with tokenOwner==true when signer doesn\'t have all pieces', async ({helper}) => {748 const token = await prepare(helper);749750 await expect(token.setProperties(alice, [751 {key: 'fractals', value: 'one headline - why believe it'},752 ])).to.be.fulfilled;753754 await token.transfer(alice, {Substrate: charlie.address}, 33n);755756 await expect(token.deleteProperties(alice, ['fractals'])).757 to.be.rejectedWith(/common\.NoPermission/);758 });759760 itSub('Allows token property mutation with collectionOwner==true when admin doesn\'t have all pieces', async ({helper}) => {761 const token = await prepare(helper);762763 await token.transfer(alice, {Substrate: charlie.address}, 33n);764765 await expect(token.collection.setTokenPropertyPermissions(alice, [{key: 'fractals', permission: {mutable:true, collectionAdmin: true}}]))766 .to.be.fulfilled;767768 await expect(token.setProperties(alice, [769 {key: 'fractals', value: 'multiverse'},770 ])).to.be.fulfilled;771 });772});1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// This file is part of Unique Network.34// Unique Network is free software: you can redistribute it and/or modify5// it under the terms of the GNU General Public License as published by6// the Free Software Foundation, either version 3 of the License, or7// (at your option) any later version.89// Unique Network is distributed in the hope that it will be useful,10// but WITHOUT ANY WARRANTY; without even the implied warranty of11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the12// GNU General Public License for more details.1314// You should have received a copy of the GNU General Public License15// along with Unique Network. If not, see <http://www.gnu.org/licenses/>.1617import {IKeyringPair} from '@polkadot/types/types';18import {itSub, Pallets, requirePalletsOrSkip, usingPlaygrounds, expect, sizeOfProperty} from '../util';19import {UniqueHelper, UniqueNFToken, UniqueRFToken} from '../util/playgrounds/unique';2021describe('Integration Test: Token Properties', () => {22 let alice: IKeyringPair; // collection owner23 let bob: IKeyringPair; // collection admin24 let charlie: IKeyringPair; // token owner2526 let permissions: {permission: any, signers: IKeyringPair[]}[];2728 before(async () => {29 await usingPlaygrounds(async (helper, privateKey) => {30 const donor = await privateKey({url: import.meta.url});31 [alice, bob, charlie] = await helper.arrange.createAccounts([200n, 100n, 100n], donor);32 });3334 permissions = [35 {permission: {mutable: true, collectionAdmin: true}, signers: [alice, bob]},36 {permission: {mutable: false, collectionAdmin: true}, signers: [alice, bob]},37 {permission: {mutable: true, tokenOwner: true}, signers: [charlie]},38 {permission: {mutable: false, tokenOwner: true}, signers: [charlie]},39 {permission: {mutable: true, collectionAdmin: true, tokenOwner: true}, signers: [alice, bob, charlie]},40 {permission: {mutable: false, collectionAdmin: true, tokenOwner: true}, signers: [alice, bob, charlie]},41 ];42 });4344 async function mintCollectionWithAllPermissionsAndToken(helper: UniqueHelper, mode: 'NFT' | 'RFT'): Promise<[UniqueNFToken | UniqueRFToken, bigint]> {45 const collection = await (mode == 'NFT' ? helper.nft : helper.rft).mintCollection(alice, {46 tokenPropertyPermissions: permissions.flatMap(({permission, signers}, i) =>47 signers.map(signer => ({key: `${i+1}_${signer.address}`, permission}))),48 });49 return mode == 'NFT' ? [await collection.mintToken(alice), 1n] : [await collection.mintToken(alice, 100n as any), 100n];50 }5152 async function testReadsYetEmptyProperties(token: UniqueNFToken | UniqueRFToken) {53 const properties = await token.getProperties();54 expect(properties).to.be.empty;5556 const tokenData = await token.getData();57 expect(tokenData!.properties).to.be.empty;58 }5960 itSub('Reads yet empty properties of a token (NFT)', async ({helper}) => {61 const collection = await helper.nft.mintCollection(alice);62 const token = await collection.mintToken(alice);63 await testReadsYetEmptyProperties(token);64 });6566 itSub.ifWithPallets('Reads yet empty properties of a token (ReFungible)', [Pallets.ReFungible], async ({helper}) => {67 const collection = await helper.rft.mintCollection(alice);68 const token = await collection.mintToken(alice);69 await testReadsYetEmptyProperties(token);70 });7172 async function testAssignPropertiesAccordingToPermissions(token: UniqueNFToken | UniqueRFToken, pieces: bigint) {73 await token.collection.addAdmin(alice, {Substrate: bob.address});74 await token.transfer(alice, {Substrate: charlie.address}, pieces);7576 const propertyKeys: string[] = [];77 let i = 0;78 for(const permission of permissions) {79 i++;80 let j = 0;81 for(const signer of permission.signers) {82 j++;83 const key = i + '_' + signer.address;84 propertyKeys.push(key);8586 await expect(87 token.setProperties(signer, [{key: key, value: 'Serotonin increase'}]),88 `on adding property #${i} by signer #${j}`,89 ).to.be.fulfilled;90 }91 }9293 const properties = await token.getProperties(propertyKeys);94 const tokenData = await token.getData();95 for(let i = 0; i < properties.length; i++) {96 expect(properties[i].value).to.be.equal('Serotonin increase');97 expect(tokenData!.properties[i].value).to.be.equal('Serotonin increase');98 }99 }100101 itSub('Assigns properties to a token according to permissions (NFT)', async ({helper}) => {102 const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'NFT');103 await testAssignPropertiesAccordingToPermissions(token, amount);104 });105106 itSub.ifWithPallets('Assigns properties to a token according to permissions (ReFungible)', [Pallets.ReFungible], async ({helper}) => {107 const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'RFT');108 await testAssignPropertiesAccordingToPermissions(token, amount);109 });110111 async function testChangesPropertiesAccordingPermission(token: UniqueNFToken | UniqueRFToken, pieces: bigint) {112 await token.collection.addAdmin(alice, {Substrate: bob.address});113 await token.transfer(alice, {Substrate: charlie.address}, pieces);114115 const propertyKeys: string[] = [];116 let i = 0;117 for(const permission of permissions) {118 i++;119 if(!permission.permission.mutable) continue;120121 let j = 0;122 for(const signer of permission.signers) {123 j++;124 const key = i + '_' + signer.address;125 propertyKeys.push(key);126127 await expect(128 token.setProperties(signer, [{key, value: 'Serotonin increase'}]),129 `on adding property #${i} by signer #${j}`,130 ).to.be.fulfilled;131132 await expect(133 token.setProperties(signer, [{key, value: 'Serotonin stable'}]),134 `on changing property #${i} by signer #${j}`,135 ).to.be.fulfilled;136 }137 }138139 const properties = await token.getProperties(propertyKeys);140 const tokenData = await token.getData();141 for(let i = 0; i < properties.length; i++) {142 expect(properties[i].value).to.be.equal('Serotonin stable');143 expect(tokenData!.properties[i].value).to.be.equal('Serotonin stable');144 }145 }146147 itSub('Changes properties of a token according to permissions (NFT)', async ({helper}) => {148 const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'NFT');149 await testChangesPropertiesAccordingPermission(token, amount);150 });151152 itSub.ifWithPallets('Changes properties of a token according to permissions (ReFungible)', [Pallets.ReFungible], async ({helper}) => {153 const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'RFT');154 await testChangesPropertiesAccordingPermission(token, amount);155 });156157 async function testDeletePropertiesAccordingPermission(token: UniqueNFToken | UniqueRFToken, pieces: bigint) {158 await token.collection.addAdmin(alice, {Substrate: bob.address});159 await token.transfer(alice, {Substrate: charlie.address}, pieces);160161 const propertyKeys: string[] = [];162 let i = 0;163164 for(const permission of permissions) {165 i++;166 if(!permission.permission.mutable) continue;167168 let j = 0;169 for(const signer of permission.signers) {170 j++;171 const key = i + '_' + signer.address;172 propertyKeys.push(key);173174 await expect(175 token.setProperties(signer, [{key, value: 'Serotonin increase'}]),176 `on adding property #${i} by signer #${j}`,177 ).to.be.fulfilled;178179 await expect(180 token.deleteProperties(signer, [key]),181 `on deleting property #${i} by signer #${j}`,182 ).to.be.fulfilled;183 }184 }185186 expect(await token.getProperties(propertyKeys)).to.be.empty;187 expect((await token.getData())!.properties).to.be.empty;188 }189190 itSub('Deletes properties of a token according to permissions (NFT)', async ({helper}) => {191 const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'NFT');192 await testDeletePropertiesAccordingPermission(token, amount);193 });194195 itSub.ifWithPallets('Deletes properties of a token according to permissions (ReFungible)', [Pallets.ReFungible], async ({helper}) => {196 const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'RFT');197 await testDeletePropertiesAccordingPermission(token, amount);198 });199200 itSub('Assigns properties to a nested token according to permissions', async ({helper}) => {201 const collectionA = await helper.nft.mintCollection(alice, {permissions: {nesting: {tokenOwner: true}}});202 const collectionB = await helper.nft.mintCollection(alice, {203 tokenPropertyPermissions: permissions.flatMap(({permission, signers}, i) =>204 signers.map(signer => ({key: `${i+1}_${signer.address}`, permission}))),205 });206 const targetToken = await collectionA.mintToken(alice);207 const nestedToken = await collectionB.mintToken(alice, targetToken.nestingAccount());208209 await collectionB.addAdmin(alice, {Substrate: bob.address});210 await targetToken.transfer(alice, {Substrate: charlie.address});211212 const propertyKeys: string[] = [];213 let i = 0;214 for(const permission of permissions) {215 i++;216 let j = 0;217 for(const signer of permission.signers) {218 j++;219 const key = i + '_' + signer.address;220 propertyKeys.push(key);221222 await expect(223 nestedToken.setProperties(signer, [{key, value: 'Serotonin increase'}]),224 `on adding property #${i} by signer #${j}`,225 ).to.be.fulfilled;226 }227 }228229 const properties = await nestedToken.getProperties(propertyKeys);230 const tokenData = await nestedToken.getData();231 for(let i = 0; i < properties.length; i++) {232 expect(properties[i].value).to.be.equal('Serotonin increase');233 expect(tokenData!.properties[i].value).to.be.equal('Serotonin increase');234 }235 expect(await targetToken.getProperties()).to.be.empty;236 });237238 itSub('Changes properties of a nested token according to permissions', async ({helper}) => {239 const collectionA = await helper.nft.mintCollection(alice, {permissions: {nesting: {tokenOwner: true}}});240 const collectionB = await helper.nft.mintCollection(alice, {241 tokenPropertyPermissions: permissions.flatMap(({permission, signers}, i) =>242 signers.map(signer => ({key: `${i+1}_${signer.address}`, permission}))),243 });244 const targetToken = await collectionA.mintToken(alice);245 const nestedToken = await collectionB.mintToken(alice, targetToken.nestingAccount());246247 await collectionB.addAdmin(alice, {Substrate: bob.address});248 await targetToken.transfer(alice, {Substrate: charlie.address});249250 const propertyKeys: string[] = [];251 let i = 0;252 for(const permission of permissions) {253 i++;254 if(!permission.permission.mutable) continue;255256 let j = 0;257 for(const signer of permission.signers) {258 j++;259 const key = i + '_' + signer.address;260 propertyKeys.push(key);261262 await expect(263 nestedToken.setProperties(signer, [{key, value: 'Serotonin increase'}]),264 `on adding property #${i} by signer #${j}`,265 ).to.be.fulfilled;266267 await expect(268 nestedToken.setProperties(signer, [{key, value: 'Serotonin stable'}]),269 `on changing property #${i} by signer #${j}`,270 ).to.be.fulfilled;271 }272 }273274 const properties = await nestedToken.getProperties(propertyKeys);275 const tokenData = await nestedToken.getData();276 for(let i = 0; i < properties.length; i++) {277 expect(properties[i].value).to.be.equal('Serotonin stable');278 expect(tokenData!.properties[i].value).to.be.equal('Serotonin stable');279 }280 expect(await targetToken.getProperties()).to.be.empty;281 });282283 itSub('Deletes properties of a nested token according to permissions', async ({helper}) => {284 const collectionA = await helper.nft.mintCollection(alice, {permissions: {nesting: {tokenOwner: true}}});285 const collectionB = await helper.nft.mintCollection(alice, {286 tokenPropertyPermissions: permissions.flatMap(({permission, signers}, i) =>287 signers.map(signer => ({key: `${i+1}_${signer.address}`, permission}))),288 });289 const targetToken = await collectionA.mintToken(alice);290 const nestedToken = await collectionB.mintToken(alice, targetToken.nestingAccount());291292 await collectionB.addAdmin(alice, {Substrate: bob.address});293 await targetToken.transfer(alice, {Substrate: charlie.address});294295 const propertyKeys: string[] = [];296 let i = 0;297 for(const permission of permissions) {298 i++;299 if(!permission.permission.mutable) continue;300301 let j = 0;302 for(const signer of permission.signers) {303 j++;304 const key = i + '_' + signer.address;305 propertyKeys.push(key);306307 await expect(308 nestedToken.setProperties(signer, [{key, value: 'Serotonin increase'}]),309 `on adding property #${i} by signer #${j}`,310 ).to.be.fulfilled;311312 await expect(313 nestedToken.deleteProperties(signer, [key]),314 `on deleting property #${i} by signer #${j}`,315 ).to.be.fulfilled;316 }317 }318319 expect(await nestedToken.getProperties(propertyKeys)).to.be.empty;320 expect((await nestedToken.getData())!.properties).to.be.empty;321 expect(await targetToken.getProperties()).to.be.empty;322 });323324 [325 {mode: 'nft' as const, storage: 'nonfungible' as const, pieces: undefined, requiredPallets: []} as const,326 {mode: 'rft' as const, storage: 'refungible' as const, pieces: 100n, requiredPallets: [Pallets.ReFungible]} as const,327 ].map(testCase =>328 itSub.ifWithPallets(`Allows modifying a token property multiple times with the same size (${testCase.mode})`, testCase.requiredPallets, async({helper}) => {329 const propKey = 'tok-prop';330331 const collection = await helper[testCase.mode].mintCollection(alice, {332 tokenPropertyPermissions: [333 {334 key: propKey,335 permission: {mutable: true, tokenOwner: true},336 },337 ],338 });339340 const maxTokenPropertiesSize = 32768;341342 const propDataSize = 4096;343344 let propDataChar = 'a';345 const makeNewPropData = () => {346 propDataChar = String.fromCharCode(propDataChar.charCodeAt(0) + 1);347 return `${propDataChar}`.repeat(propDataSize);348 };349350 const token = await (351 testCase.pieces352 ? collection.mintToken(alice, testCase.pieces as any)353 : collection.mintToken(alice)354 );355356 const property = {key: propKey, value: makeNewPropData()};357 await token.setProperties(alice, [property]);358 const originalSpace = await token.getTokenPropertiesConsumedSpace();359 expect(originalSpace).to.be.equal(sizeOfProperty(property));360361 const sameSizePropertiesPossibleNum = maxTokenPropertiesSize / propDataSize;362363 // It is possible to modify a property as many times as needed.364 // It will not consume any additional space.365 for(let i = 0; i < sameSizePropertiesPossibleNum + 1; i++) {366 await token.setProperties(alice, [{key: propKey, value: makeNewPropData()}]);367 const consumedSpace = await token.getTokenPropertiesConsumedSpace();368 expect(consumedSpace).to.be.equal(originalSpace);369 }370 }));371372 [373 {mode: 'nft' as const, pieces: undefined, requiredPallets: []},374 {mode: 'rft' as const, pieces: 100n, requiredPallets: [Pallets.ReFungible]},375 ].map(testCase =>376 itSub.ifWithPallets(`Adding then removing a token property doesn't change the consumed space (${testCase.mode})`, testCase.requiredPallets, async({helper}) => {377 const propKey = 'tok-prop';378379 const collection = await helper[testCase.mode].mintCollection(alice, {380 tokenPropertyPermissions: [381 {382 key: propKey,383 permission: {mutable: true, tokenOwner: true},384 },385 ],386 });387 const token = await (388 testCase.pieces389 ? collection.mintToken(alice, testCase.pieces as any)390 : collection.mintToken(alice)391 );392 const originalSpace = await token.getTokenPropertiesConsumedSpace();393394 const propDataSize = 4096;395 const propData = 'a'.repeat(propDataSize);396397 const property = {key: propKey, value: propData};398 await token.setProperties(alice, [property]);399 let consumedSpace = await token.getTokenPropertiesConsumedSpace();400 expect(consumedSpace).to.be.equal(sizeOfProperty(property));401402 await token.deleteProperties(alice, [propKey]);403 consumedSpace = await token.getTokenPropertiesConsumedSpace();404 expect(consumedSpace).to.be.equal(originalSpace);405 }));406407 [408 {mode: 'nft' as const, pieces: undefined, requiredPallets: []},409 {mode: 'rft' as const, pieces: 100n, requiredPallets: [Pallets.ReFungible]},410 ].map(testCase =>411 itSub.ifWithPallets(`Modifying a token property with different sizes correctly changes the consumed space (${testCase.mode})`, testCase.requiredPallets, async({helper}) => {412 const propKey = 'tok-prop';413414 const collection = await helper[testCase.mode].mintCollection(alice, {415 tokenPropertyPermissions: [416 {417 key: propKey,418 permission: {mutable: true, tokenOwner: true},419 },420 ],421 });422 const token = await (423 testCase.pieces424 ? collection.mintToken(alice, testCase.pieces as any)425 : collection.mintToken(alice)426 );427 const originalSpace = await token.getTokenPropertiesConsumedSpace();428429 const initProp = {key: propKey, value: 'a'.repeat(4096)};430 const biggerProp = {key: propKey, value: 'b'.repeat(5000)};431 const smallerProp = {key: propKey, value: 'c'.repeat(4000)};432433 let consumedSpace;434 let expectedConsumedSpaceDiff;435436 await token.setProperties(alice, [initProp]);437 consumedSpace = await token.getTokenPropertiesConsumedSpace();438 expectedConsumedSpaceDiff = sizeOfProperty(initProp) - originalSpace;439 expect(consumedSpace).to.be.equal(originalSpace + expectedConsumedSpaceDiff);440441 await token.setProperties(alice, [biggerProp]);442 consumedSpace = await token.getTokenPropertiesConsumedSpace();443 expectedConsumedSpaceDiff = sizeOfProperty(biggerProp) - sizeOfProperty(initProp);444 expect(consumedSpace).to.be.equal(sizeOfProperty(initProp) + expectedConsumedSpaceDiff);445446 await token.setProperties(alice, [smallerProp]);447 consumedSpace = await token.getTokenPropertiesConsumedSpace();448 expectedConsumedSpaceDiff = sizeOfProperty(biggerProp) - sizeOfProperty(smallerProp);449 expect(consumedSpace).to.be.equal(sizeOfProperty(biggerProp) - expectedConsumedSpaceDiff);450 }));451452 itSub('Set sponsored properties', async({helper}) => {453 const collection = await helper.nft.mintCollection(alice, {tokenPropertyPermissions: [{key: 'k', permission: {tokenOwner: true}}]});454455 await collection.setSponsor(alice, alice.address);456 await collection.confirmSponsorship(alice);457 await collection.setPermissions(alice, {access: 'AllowList', mintMode: true});458 await collection.addToAllowList(alice, {Substrate: bob.address});459 await collection.setLimits(alice, {sponsoredDataRateLimit: {blocks: 30}});460461 const token = await collection.mintToken(alice, {Substrate: bob.address});462463 const aliceBalanceBefore = await helper.balance.getSubstrate(alice.address);464 const bobBalanceBefore = await helper.balance.getSubstrate(bob.address);465466 await token.setProperties(bob, [{key: 'k', value: 'val'}]);467468 const aliceBalanceAfter = await helper.balance.getSubstrate(alice.address);469 const bobBalanceAfter = await helper.balance.getSubstrate(bob.address);470471 expect(bobBalanceAfter).to.be.equal(bobBalanceBefore);472 expect(aliceBalanceBefore > aliceBalanceAfter).to.be.true;473 });474});475476describe('Negative Integration Test: Token Properties', () => {477 let alice: IKeyringPair; // collection owner478 let bob: IKeyringPair; // collection admin479 let charlie: IKeyringPair; // token owner480481 let constitution: {permission: any, signers: IKeyringPair[], sinner: IKeyringPair}[];482483 before(async () => {484 await usingPlaygrounds(async (helper, privateKey) => {485 const donor = await privateKey({url: import.meta.url});486 let dave: IKeyringPair;487 [alice, bob, charlie, dave] = await helper.arrange.createAccounts([100n, 100n, 100n, 100n], donor);488489 // todo:playgrounds probably separate these tests later490 constitution = [491 {permission: {mutable: true, collectionAdmin: true}, signers: [alice, bob], sinner: charlie},492 {permission: {mutable: false, collectionAdmin: true}, signers: [alice, bob], sinner: charlie},493 {permission: {mutable: true, tokenOwner: true}, signers: [charlie], sinner: alice},494 {permission: {mutable: false, tokenOwner: true}, signers: [charlie], sinner: alice},495 {permission: {mutable: true, collectionAdmin: true, tokenOwner: true}, signers: [alice, bob, charlie], sinner: dave},496 {permission: {mutable: false, collectionAdmin: true, tokenOwner: true}, signers: [alice, bob, charlie], sinner: dave},497 ];498 });499 });500501 [502 {mode: 'nft' as const, requiredPallets: [Pallets.NFT]},503 {mode: 'rft' as const, requiredPallets: [Pallets.ReFungible]},504 ].map(testCase =>505 itSub.ifWithPallets(`Forbids adding/deleting properties of a token if token doesn't exist (${testCase.mode.toLocaleUpperCase})`, testCase.requiredPallets, async({helper}) => {506 const collection = await helper[testCase.mode].mintCollection(alice, {507 tokenPropertyPermissions: constitution.slice(0, 1).map(({permission}) => ({key: '1', permission})),508 });509 const nonExistentToken = collection.getTokenObject(1);510511 await expect(512 nonExistentToken.setProperties(alice, [{key: '1', value: 'Serotonin increase'}]),513 'on expecting failure whilst adding a property by alice',514 ).to.be.rejectedWith(/common\.TokenNotFound/);515516 await expect(517 nonExistentToken.deleteProperties(alice, ['1']),518 'on expecting failure whilst deleting a property by alice',519 ).to.be.rejectedWith(/common\.TokenNotFound/);520 }));521522 async function mintCollectionWithAllPermissionsAndToken(helper: UniqueHelper, mode: 'NFT' | 'RFT'): Promise<[UniqueNFToken | UniqueRFToken, bigint]> {523 const collection = await (mode == 'NFT' ? helper.nft : helper.rft).mintCollection(alice, {524 tokenPropertyPermissions: constitution.map(({permission}, i) => ({key: `${i+1}`, permission})),525 });526 return mode == 'NFT' ? [await collection.mintToken(alice), 1n] : [await collection.mintToken(alice, 100n as any), 100n];527 }528529 async function getConsumedSpace(api: any, collectionId: number, tokenId: number, mode: 'NFT' | 'RFT'): Promise<number> {530 return (await (mode == 'NFT' ? api.query.nonfungible : api.query.refungible).tokenProperties(collectionId, tokenId)).toJSON().consumedSpace;531 }532533 async function prepare(token: UniqueNFToken | UniqueRFToken, pieces: bigint): Promise<number> {534 await token.collection.addAdmin(alice, {Substrate: bob.address});535 await token.transfer(alice, {Substrate: charlie.address}, pieces);536537 let i = 0;538 for(const passage of constitution) {539 i++;540 const signer = passage.signers[0];541 await expect(542 token.setProperties(signer, [{key: `${i}`, value: 'Serotonin increase'}]),543 `on adding property ${i} by ${signer.address}`,544 ).to.be.fulfilled;545 }546547 const originalSpace = await getConsumedSpace(token.collection.helper.getApi(), token.collectionId, token.tokenId, pieces == 1n ? 'NFT' : 'RFT');548 return originalSpace;549 }550551 async function testForbidsChangingDeletingPropertiesUserOutsideOfPermissions(token: UniqueNFToken | UniqueRFToken, pieces: bigint) {552 const originalSpace = await prepare(token, pieces);553554 let i = 0;555 for(const forbiddance of constitution) {556 i++;557 if(!forbiddance.permission.mutable) continue;558559 await expect(560 token.setProperties(forbiddance.sinner, [{key: `${i}`, value: 'Serotonin down'}]),561 `on failing to change property ${i} by the malefactor`,562 ).to.be.rejectedWith(/common\.NoPermission/);563564 await expect(565 token.deleteProperties(forbiddance.sinner, [`${i}`]),566 `on failing to delete property ${i} by the malefactor`,567 ).to.be.rejectedWith(/common\.NoPermission/);568 }569570 const consumedSpace = await getConsumedSpace(token.collection.helper.getApi(), token.collectionId, token.tokenId, pieces == 1n ? 'NFT' : 'RFT');571 expect(consumedSpace).to.be.equal(originalSpace);572 }573574 itSub('Forbids changing/deleting properties of a token if the user is outside of permissions (NFT)', async ({helper}) => {575 const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'NFT');576 await testForbidsChangingDeletingPropertiesUserOutsideOfPermissions(token, amount);577 });578579 itSub.ifWithPallets('Forbids changing/deleting properties of a token if the user is outside of permissions (ReFungible)', [Pallets.ReFungible], async ({helper}) => {580 const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'RFT');581 await testForbidsChangingDeletingPropertiesUserOutsideOfPermissions(token, amount);582 });583584 async function testForbidsChangingDeletingPropertiesIfPropertyImmutable(token: UniqueNFToken | UniqueRFToken, pieces: bigint) {585 const originalSpace = await prepare(token, pieces);586587 let i = 0;588 for(const permission of constitution) {589 i++;590 if(permission.permission.mutable) continue;591592 await expect(593 token.setProperties(permission.signers[0], [{key: `${i}`, value: 'Serotonin down'}]),594 `on failing to change property ${i} by signer #0`,595 ).to.be.rejectedWith(/common\.NoPermission/);596597 await expect(598 token.deleteProperties(permission.signers[0], [i.toString()]),599 `on failing to delete property ${i} by signer #0`,600 ).to.be.rejectedWith(/common\.NoPermission/);601 }602603 const consumedSpace = await getConsumedSpace(token.collection.helper.getApi(), token.collectionId, token.tokenId, pieces == 1n ? 'NFT' : 'RFT');604 expect(consumedSpace).to.be.equal(originalSpace);605 }606607 itSub('Forbids changing/deleting properties of a token if the property is permanent (immutable) (NFT)', async ({helper}) => {608 const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'NFT');609 await testForbidsChangingDeletingPropertiesIfPropertyImmutable(token, amount);610 });611612 itSub.ifWithPallets('Forbids changing/deleting properties of a token if the property is permanent (immutable) (ReFungible)', [Pallets.ReFungible], async ({helper}) => {613 const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'RFT');614 await testForbidsChangingDeletingPropertiesIfPropertyImmutable(token, amount);615 });616617 async function testForbidsAddingPropertiesIfPropertyNotDeclared(token: UniqueNFToken | UniqueRFToken, pieces: bigint) {618 const originalSpace = await prepare(token, pieces);619620 await expect(621 token.setProperties(alice, [{key: 'non-existent', value: 'I exist!'}]),622 'on failing to add a previously non-existent property',623 ).to.be.rejectedWith(/common\.NoPermission/);624625 await expect(626 token.collection.setTokenPropertyPermissions(alice, [{key: 'now-existent', permission: {}}]),627 'on setting a new non-permitted property',628 ).to.be.fulfilled;629630 await expect(631 token.setProperties(alice, [{key: 'now-existent', value: 'I exist!'}]),632 'on failing to add a property forbidden by the \'None\' permission',633 ).to.be.rejectedWith(/common\.NoPermission/);634635 expect(await token.getProperties(['non-existent', 'now-existent'])).to.be.empty;636637 const consumedSpace = await getConsumedSpace(token.collection.helper.getApi(), token.collectionId, token.tokenId, pieces == 1n ? 'NFT' : 'RFT');638 expect(consumedSpace).to.be.equal(originalSpace);639 }640641 itSub('Forbids adding properties to a token if the property is not declared / forbidden with the \'None\' permission (NFT)', async ({helper}) => {642 const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'NFT');643 await testForbidsAddingPropertiesIfPropertyNotDeclared(token, amount);644 });645646 itSub.ifWithPallets('Forbids adding properties to a token if the property is not declared / forbidden with the \'None\' permission (ReFungible)', [Pallets.ReFungible], async ({helper}) => {647 const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'RFT');648 await testForbidsAddingPropertiesIfPropertyNotDeclared(token, amount);649 });650651 async function testForbidsAddingTooLargeProperties(token: UniqueNFToken | UniqueRFToken, pieces: bigint) {652 const originalSpace = await prepare(token, pieces);653654 await expect(655 token.collection.setTokenPropertyPermissions(alice, [656 {key: 'a_holy_book', permission: {collectionAdmin: true, tokenOwner: true}},657 {key: 'young_years', permission: {collectionAdmin: true, tokenOwner: true}},658 ]),659 'on setting new permissions for properties',660 ).to.be.fulfilled;661662 // Mute the general tx parsing error663 {664 console.error = () => {};665 await expect(token.setProperties(alice, [{key: 'a_holy_book', value: 'word '.repeat(6554)}]))666 .to.be.rejected;667 }668669 await expect(token.setProperties(alice, [670 {key: 'a_holy_book', value: 'word '.repeat(3277)},671 {key: 'young_years', value: 'neverending'.repeat(1490)},672 ])).to.be.rejectedWith(/common\.NoSpaceForProperty/);673674 expect(await token.getProperties(['a_holy_book', 'young_years'])).to.be.empty;675 const consumedSpace = await getConsumedSpace(token.collection.helper.getApi(), token.collectionId, token.tokenId, pieces == 1n ? 'NFT' : 'RFT');676 expect(consumedSpace).to.be.equal(originalSpace);677 }678679 itSub('Forbids adding too large properties to a token (NFT)', async ({helper}) => {680 const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'NFT');681 await testForbidsAddingTooLargeProperties(token, amount);682 });683684 itSub.ifWithPallets('Forbids adding too large properties to a token (ReFungible)', [Pallets.ReFungible], async ({helper}) => {685 const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'RFT');686 await testForbidsAddingTooLargeProperties(token, amount);687 });688689 [690 {mode: 'nft' as const, requiredPallets: []},691 {mode: 'rft' as const, requiredPallets: [Pallets.ReFungible]},692 ].map(testCase =>693 itSub.ifWithPallets(`Forbids adding too many propeties to a token (${testCase.mode})`, testCase.requiredPallets, async({helper}) => {694 const collection = await helper[testCase.mode].mintCollection(alice);695 const maxPropertiesPerItem = 64;696697 for(let i = 0; i < maxPropertiesPerItem; i++) {698 await collection.setTokenPropertyPermissions(alice, [{699 key: `${i+1}`,700 permission: {mutable: true, tokenOwner: true, collectionAdmin: true},701 }]);702 }703704 await expect(collection.setTokenPropertyPermissions(alice, [{705 key: `${maxPropertiesPerItem}-th`,706 permission: {mutable: true, tokenOwner: true, collectionAdmin: true},707 }])).to.be.rejectedWith(/common\.PropertyLimitReached/);708 }));709710 [711 {mode: 'nft' as const, pieces: undefined, requiredPallets: []},712 {mode: 'rft' as const, pieces: 100n, requiredPallets: [Pallets.ReFungible]},713 ].map(testCase =>714 itSub.ifWithPallets(`Forbids force_repair_item from non-sudo (${testCase.mode})`, testCase.requiredPallets, async({helper}) => {715 const propKey = 'tok-prop';716717 const collection = await helper[testCase.mode].mintCollection(alice, {718 tokenPropertyPermissions: [719 {720 key: propKey,721 permission: {mutable: true, tokenOwner: true},722 },723 ],724 });725 const token = await (726 testCase.pieces727 ? collection.mintToken(alice, testCase.pieces as any)728 : collection.mintToken(alice)729 );730731 const propDataSize = 4096;732 const propData = 'a'.repeat(propDataSize);733 await token.setProperties(alice, [{key: propKey, value: propData}]);734735 await expect(helper.executeExtrinsic(alice, 'api.tx.unique.forceRepairItem', [token.collectionId, token.tokenId], true))736 .to.be.rejectedWith(/BadOrigin/);737 }));738});739740describe('ReFungible token properties permissions tests', () => {741 let alice: IKeyringPair;742 let bob: IKeyringPair;743 let charlie: IKeyringPair;744745 before(async function() {746 await usingPlaygrounds(async (helper, privateKey) => {747 requirePalletsOrSkip(this, helper, [Pallets.ReFungible]);748749 const donor = await privateKey({url: import.meta.url});750 [alice, bob, charlie] = await helper.arrange.createAccounts([100n, 100n, 100n], donor);751 });752 });753754 async function prepare(helper: UniqueHelper): Promise<UniqueRFToken> {755 const collection = await helper.rft.mintCollection(alice);756 const token = await collection.mintToken(alice, 100n);757758 await collection.addAdmin(alice, {Substrate: bob.address});759 await collection.setTokenPropertyPermissions(alice, [{key: 'fractals', permission: {mutable: true, tokenOwner: true}}]);760761 return token;762 }763764 itSub('Forbids adding token property with tokenOwner==true when signer doesn\'t have all pieces', async ({helper}) => {765 const token = await prepare(helper);766767 await token.transfer(alice, {Substrate: charlie.address}, 33n);768769 await expect(token.setProperties(alice, [770 {key: 'fractals', value: 'multiverse'},771 ])).to.be.rejectedWith(/common\.NoPermission/);772 });773774 itSub('Forbids mutating token property with tokenOwner==true when signer doesn\'t have all pieces', async ({helper}) => {775 const token = await prepare(helper);776777 await expect(token.collection.setTokenPropertyPermissions(alice, [{key: 'fractals', permission: {mutable:true, tokenOwner: true}}]))778 .to.be.fulfilled;779780 await expect(token.setProperties(alice, [781 {key: 'fractals', value: 'multiverse'},782 ])).to.be.fulfilled;783784 await token.transfer(alice, {Substrate: charlie.address}, 33n);785786 await expect(token.setProperties(alice, [787 {key: 'fractals', value: 'want to rule the world'},788 ])).to.be.rejectedWith(/common\.NoPermission/);789 });790791 itSub('Forbids deleting token property with tokenOwner==true when signer doesn\'t have all pieces', async ({helper}) => {792 const token = await prepare(helper);793794 await expect(token.setProperties(alice, [795 {key: 'fractals', value: 'one headline - why believe it'},796 ])).to.be.fulfilled;797798 await token.transfer(alice, {Substrate: charlie.address}, 33n);799800 await expect(token.deleteProperties(alice, ['fractals'])).801 to.be.rejectedWith(/common\.NoPermission/);802 });803804 itSub('Allows token property mutation with collectionOwner==true when admin doesn\'t have all pieces', async ({helper}) => {805 const token = await prepare(helper);806807 await token.transfer(alice, {Substrate: charlie.address}, 33n);808809 await expect(token.collection.setTokenPropertyPermissions(alice, [{key: 'fractals', permission: {mutable:true, collectionAdmin: true}}]))810 .to.be.fulfilled;811812 await expect(token.setProperties(alice, [813 {key: 'fractals', value: 'multiverse'},814 ])).to.be.fulfilled;815 });816});