difftreelog
fieat: add repair_item extrinsic + test
in: master
15 files changed
pallets/common/src/lib.rsdiffbeforeafterboth--- a/pallets/common/src/lib.rs
+++ b/pallets/common/src/lib.rs
@@ -1815,6 +1815,9 @@
/// The price of setting approval for all
fn set_allowance_for_all() -> Weight;
+
+ /// The price of repairing an item.
+ fn repair_item() -> Weight;
}
/// Weight info extension trait for refungible pallet.
@@ -2136,6 +2139,9 @@
/// Tells whether the given `owner` approves the `operator`.
fn allowance_for_all(&self, owner: T::CrossAccountId, operator: T::CrossAccountId) -> bool;
+
+ /// Repairs a possibly broken item.
+ fn repair_item(&self, token: TokenId) -> DispatchResultWithPostInfo;
}
/// Extension for RFT collection.
pallets/fungible/src/common.rsdiffbeforeafterboth--- a/pallets/fungible/src/common.rs
+++ b/pallets/fungible/src/common.rs
@@ -111,6 +111,10 @@
fn set_allowance_for_all() -> Weight {
Weight::zero()
}
+
+ fn repair_item() -> Weight {
+ Weight::zero()
+ }
}
/// Implementation of `CommonCollectionOperations` for `FungibleHandle`. It wraps FungibleHandle Pallete
@@ -441,4 +445,9 @@
fn allowance_for_all(&self, _owner: T::CrossAccountId, _operator: T::CrossAccountId) -> bool {
false
}
+
+ /// Repairs a possibly broken item.
+ fn repair_item(&self, _token: TokenId) -> DispatchResultWithPostInfo {
+ fail!(<Error<T>>::FungibleTokensAreAlwaysValid)
+ }
}
pallets/fungible/src/lib.rsdiffbeforeafterboth--- a/pallets/fungible/src/lib.rs
+++ b/pallets/fungible/src/lib.rs
@@ -129,6 +129,8 @@
SettingPropertiesNotAllowed,
/// Setting allowance for all is not allowed.
SettingAllowanceForAllNotAllowed,
+ /// Only a fungible collection could be possibly broken; any fungible token is valid.
+ FungibleTokensAreAlwaysValid,
}
#[pallet::config]
pallets/nonfungible/src/benchmarking.rsdiffbeforeafterboth--- a/pallets/nonfungible/src/benchmarking.rs
+++ b/pallets/nonfungible/src/benchmarking.rs
@@ -236,4 +236,12 @@
operator: cross_sub;
};
}: {<Pallet<T>>::allowance_for_all(&collection, &owner, &operator)}
+
+ repair_item {
+ bench_init!{
+ owner: sub; collection: collection(owner);
+ owner: cross_from_sub;
+ };
+ let item = create_max_item(&collection, &owner, owner.clone())?;
+ }: {<Pallet<T>>::repair_item(&collection, item)?}
}
pallets/nonfungible/src/common.rsdiffbeforeafterboth--- a/pallets/nonfungible/src/common.rs
+++ b/pallets/nonfungible/src/common.rs
@@ -126,6 +126,10 @@
fn set_allowance_for_all() -> Weight {
<SelfWeightOf<T>>::set_allowance_for_all()
}
+
+ fn repair_item() -> Weight {
+ <SelfWeightOf<T>>::repair_item()
+ }
}
fn map_create_data<T: Config>(
@@ -532,4 +536,11 @@
fn allowance_for_all(&self, owner: T::CrossAccountId, operator: T::CrossAccountId) -> bool {
<Pallet<T>>::allowance_for_all(self, &owner, &operator)
}
+
+ fn repair_item(&self, token: TokenId) -> DispatchResultWithPostInfo {
+ with_weight(
+ <Pallet<T>>::repair_item(self, token),
+ <CommonWeights<T>>::repair_item(),
+ )
+ }
}
pallets/nonfungible/src/lib.rsdiffbeforeafterboth--- a/pallets/nonfungible/src/lib.rs
+++ b/pallets/nonfungible/src/lib.rs
@@ -1398,4 +1398,12 @@
) -> bool {
<CollectionAllowance<T>>::get((collection.id, owner, operator))
}
+
+ pub fn repair_item(collection: &NonfungibleHandle<T>, token: TokenId) -> DispatchResult {
+ <TokenProperties<T>>::mutate((collection.id, token), |properties| {
+ properties.recompute_consumed_space();
+ });
+
+ Ok(())
+ }
}
pallets/nonfungible/src/weights.rsdiffbeforeafterboth--- a/pallets/nonfungible/src/weights.rs
+++ b/pallets/nonfungible/src/weights.rs
@@ -50,6 +50,7 @@
fn token_owner() -> Weight;
fn set_allowance_for_all() -> Weight;
fn allowance_for_all() -> Weight;
+ fn repair_item() -> Weight;
}
/// Weights for pallet_nonfungible using the Substrate node and recommended hardware.
@@ -208,6 +209,12 @@
Weight::from_ref_time(6_161_000 as u64)
.saturating_add(T::DbWeight::get().reads(1 as u64))
}
+ // Storage: Nonfungible TokenProperties (r:1 w:1)
+ fn repair_item() -> Weight {
+ Weight::from_ref_time(5_701_000 as u64)
+ .saturating_add(T::DbWeight::get().reads(1 as u64))
+ .saturating_add(T::DbWeight::get().writes(1 as u64))
+ }
}
// For backwards compatibility and tests
@@ -365,4 +372,10 @@
Weight::from_ref_time(6_161_000 as u64)
.saturating_add(RocksDbWeight::get().reads(1 as u64))
}
+ // Storage: Nonfungible TokenProperties (r:1 w:1)
+ fn repair_item() -> Weight {
+ Weight::from_ref_time(5_701_000 as u64)
+ .saturating_add(RocksDbWeight::get().reads(1 as u64))
+ .saturating_add(RocksDbWeight::get().writes(1 as u64))
+ }
}
pallets/refungible/src/benchmarking.rsdiffbeforeafterboth--- a/pallets/refungible/src/benchmarking.rs
+++ b/pallets/refungible/src/benchmarking.rs
@@ -304,4 +304,12 @@
operator: cross_sub;
};
}: {<Pallet<T>>::allowance_for_all(&collection, &owner, &operator)}
+
+ repair_item {
+ bench_init!{
+ owner: sub; collection: collection(owner);
+ owner: cross_from_sub;
+ };
+ let item = create_max_item(&collection, &owner, [(owner.clone(), 100)])?;
+ }: {<Pallet<T>>::repair_item(&collection, item)?}
}
pallets/refungible/src/common.rsdiffbeforeafterboth--- a/pallets/refungible/src/common.rs
+++ b/pallets/refungible/src/common.rs
@@ -156,6 +156,10 @@
fn set_allowance_for_all() -> Weight {
<SelfWeightOf<T>>::set_allowance_for_all()
}
+
+ fn repair_item() -> Weight {
+ <SelfWeightOf<T>>::repair_item()
+ }
}
fn map_create_data<T: Config>(
@@ -536,6 +540,13 @@
fn allowance_for_all(&self, owner: T::CrossAccountId, operator: T::CrossAccountId) -> bool {
<Pallet<T>>::allowance_for_all(self, &owner, &operator)
}
+
+ fn repair_item(&self, token: TokenId) -> DispatchResultWithPostInfo {
+ with_weight(
+ <Pallet<T>>::repair_item(self, token),
+ <CommonWeights<T>>::repair_item(),
+ )
+ }
}
impl<T: Config> RefungibleExtensions<T> for RefungibleHandle<T> {
pallets/refungible/src/lib.rsdiffbeforeafterboth--- a/pallets/refungible/src/lib.rs
+++ b/pallets/refungible/src/lib.rs
@@ -1461,4 +1461,12 @@
) -> bool {
<CollectionAllowance<T>>::get((collection.id, owner, operator))
}
+
+ pub fn repair_item(collection: &RefungibleHandle<T>, token: TokenId) -> DispatchResult {
+ <TokenProperties<T>>::mutate((collection.id, token), |properties| {
+ properties.recompute_consumed_space();
+ });
+
+ Ok(())
+ }
}
pallets/refungible/src/weights.rsdiffbeforeafterboth--- a/pallets/refungible/src/weights.rs
+++ b/pallets/refungible/src/weights.rs
@@ -57,6 +57,7 @@
fn token_owner() -> Weight;
fn set_allowance_for_all() -> Weight;
fn allowance_for_all() -> Weight;
+ fn repair_item() -> Weight;
}
/// Weights for pallet_refungible using the Substrate node and recommended hardware.
@@ -272,6 +273,12 @@
Weight::from_ref_time(5_901_000 as u64)
.saturating_add(T::DbWeight::get().reads(1 as u64))
}
+ // Storage: Refungible TokenProperties (r:1 w:1)
+ fn repair_item() -> Weight {
+ Weight::from_ref_time(5_489_000 as u64)
+ .saturating_add(T::DbWeight::get().reads(1 as u64))
+ .saturating_add(T::DbWeight::get().writes(1 as u64))
+ }
}
// For backwards compatibility and tests
@@ -486,4 +493,10 @@
Weight::from_ref_time(5_901_000 as u64)
.saturating_add(RocksDbWeight::get().reads(1 as u64))
}
+ // Storage: Refungible TokenProperties (r:1 w:1)
+ fn repair_item() -> Weight {
+ Weight::from_ref_time(5_489_000 as u64)
+ .saturating_add(RocksDbWeight::get().reads(1 as u64))
+ .saturating_add(RocksDbWeight::get().writes(1 as u64))
+ }
}
pallets/unique/src/lib.rsdiffbeforeafterboth--- a/pallets/unique/src/lib.rs
+++ b/pallets/unique/src/lib.rs
@@ -982,6 +982,23 @@
d.set_allowance_for_all(sender, operator, approve)
})
}
+
+ /// Repairs a broken item
+ ///
+ /// # Arguments
+ ///
+ /// * `collection_id`: ID of the collection the item belongs to.
+ /// * `item_id`: ID of the item.
+ #[weight = T::CommonWeightInfo::repair_item()]
+ pub fn repair_item(
+ _origin,
+ collection_id: CollectionId,
+ item_id: TokenId,
+ ) -> DispatchResultWithPostInfo {
+ dispatch_tx::<T, _>(collection_id, |d| {
+ d.repair_item(item_id)
+ })
+ }
}
}
primitives/data-structs/src/lib.rsdiffbeforeafterboth--- a/primitives/data-structs/src/lib.rs
+++ b/primitives/data-structs/src/lib.rs
@@ -1218,6 +1218,10 @@
Ok(())
}
+
+ pub fn values(&self) -> impl Iterator<Item = &Value> {
+ self.0.values()
+ }
}
impl<Value> IntoIterator for PropertiesMap<Value> {
@@ -1290,6 +1294,12 @@
pub fn get(&self, key: &PropertyKey) -> Option<&PropertyValue> {
self.map.get(key)
}
+
+ /// Recomputes the consumed space for the current properties state.
+ /// Needed to repair a token due to a bug fixed in the [PR #733](https://github.com/UniqueNetwork/unique-chain/pull/773).
+ pub fn recompute_consumed_space(&mut self) {
+ self.consumed_space = self.map.values().map(|value| value.len() as u32).sum();
+ }
}
impl IntoIterator for Properties {
runtime/common/weights.rsdiffbeforeafterboth--- a/runtime/common/weights.rs
+++ b/runtime/common/weights.rs
@@ -124,6 +124,10 @@
fn set_allowance_for_all() -> Weight {
max_weight_of!(set_allowance_for_all())
}
+
+ fn repair_item() -> Weight {
+ max_weight_of!(repair_item())
+ }
}
#[cfg(feature = "refungible")]
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} 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({filename: __filename});31 [alice, bob, charlie] = await helper.arrange.createAccounts([100n, 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 => {return {key: `${i+1}_${signer.address}`, permission};})),48 });49 return mode == 'NFT' ? [await collection.mintToken(alice), 1n] : [await collection.mintToken(alice, 100n), 100n];50 }51 52 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;120 121 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;167 168 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 }189 190 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 => {return {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 => {return {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;255 256 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 => {return {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;300 301 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: []},326 {mode: 'rft' as const, storage: 'refungible' as const, pieces: 100n, requiredPallets: [Pallets.ReFungible]}, 327 ].map(testCase =>328 itSub.ifWithPallets(`Allows modifying a token property multiple times (${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)353 : collection.mintToken(alice)354 );355356 await token.setProperties(alice, [{key: propKey, value: makeNewPropData()}]);357 const originalSpace = await token.getTokenPropertiesConsumedSpace();358 expect(originalSpace).to.be.equal(propDataSize);359360 const sameSizePropertiesPossibleNum = maxTokenPropertiesSize / propDataSize;361362 // It is possible to modify a property as many times as needed.363 // It will not consume any additional space.364 for (let i = 0; i < sameSizePropertiesPossibleNum + 1; i++) {365 await token.setProperties(alice, [{key: propKey, value: makeNewPropData()}]);366 const consumedSpace = await token.getTokenPropertiesConsumedSpace();367 expect(consumedSpace).to.be.equal(originalSpace);368 }369 }));370371 [372 {mode: 'nft' as const, pieces: undefined, requiredPallets: []},373 {mode: 'rft' as const, pieces: 100n, requiredPallets: [Pallets.ReFungible]}, 374 ].map(testCase =>375 itSub.ifWithPallets(`Adding then removing a token property doesn't change the consumed space (${testCase.mode})`, testCase.requiredPallets, async({helper}) => {376 const propKey = 'tok-prop';377378 const collection = await helper[testCase.mode].mintCollection(alice, {379 tokenPropertyPermissions: [380 {381 key: propKey,382 permission: {mutable: true, tokenOwner: true},383 },384 ],385 });386 const token = await (387 testCase.pieces388 ? collection.mintToken(alice, testCase.pieces)389 : collection.mintToken(alice)390 );391 const originalSpace = await token.getTokenPropertiesConsumedSpace();392393 const propDataSize = 4096;394 const propData = 'a'.repeat(propDataSize);395396 await token.setProperties(alice, [{key: propKey, value: propData}]);397 let consumedSpace = await token.getTokenPropertiesConsumedSpace();398 expect(consumedSpace).to.be.equal(propDataSize);399400 await token.deleteProperties(alice, [propKey]);401 consumedSpace = await token.getTokenPropertiesConsumedSpace();402 expect(consumedSpace).to.be.equal(originalSpace);403 }));404});405406describe('Negative Integration Test: Token Properties', () => {407 let alice: IKeyringPair; // collection owner408 let bob: IKeyringPair; // collection admin409 let charlie: IKeyringPair; // token owner410411 let constitution: {permission: any, signers: IKeyringPair[], sinner: IKeyringPair}[];412413 before(async () => {414 await usingPlaygrounds(async (helper, privateKey) => {415 const donor = await privateKey({filename: __filename});416 let dave: IKeyringPair;417 [alice, bob, charlie, dave] = await helper.arrange.createAccounts([100n, 100n, 100n, 100n], donor);418419 // todo:playgrounds probably separate these tests later420 constitution = [421 {permission: {mutable: true, collectionAdmin: true}, signers: [alice, bob], sinner: charlie},422 {permission: {mutable: false, collectionAdmin: true}, signers: [alice, bob], sinner: charlie},423 {permission: {mutable: true, tokenOwner: true}, signers: [charlie], sinner: alice},424 {permission: {mutable: false, tokenOwner: true}, signers: [charlie], sinner: alice},425 {permission: {mutable: true, collectionAdmin: true, tokenOwner: true}, signers: [alice, bob, charlie], sinner: dave},426 {permission: {mutable: false, collectionAdmin: true, tokenOwner: true}, signers: [alice, bob, charlie], sinner: dave},427 ];428 });429 });430431 async function mintCollectionWithAllPermissionsAndToken(helper: UniqueHelper, mode: 'NFT' | 'RFT'): Promise<[UniqueNFToken | UniqueRFToken, bigint]> {432 const collection = await (mode == 'NFT' ? helper.nft : helper.rft).mintCollection(alice, {433 tokenPropertyPermissions: constitution.map(({permission}, i) => {return {key: `${i+1}`, permission};}),434 });435 return mode == 'NFT' ? [await collection.mintToken(alice), 1n] : [await collection.mintToken(alice, 100n), 100n];436 }437438 async function getConsumedSpace(api: any, collectionId: number, tokenId: number, mode: 'NFT' | 'RFT'): Promise<number> {439 return (await (mode == 'NFT' ? api.query.nonfungible : api.query.refungible).tokenProperties(collectionId, tokenId)).toJSON().consumedSpace;440 }441442 async function prepare(token: UniqueNFToken | UniqueRFToken, pieces: bigint): Promise<number> {443 await token.collection.addAdmin(alice, {Substrate: bob.address});444 await token.transfer(alice, {Substrate: charlie.address}, pieces);445446 let i = 0;447 for (const passage of constitution) {448 i++;449 const signer = passage.signers[0];450 await expect(451 token.setProperties(signer, [{key: `${i}`, value: 'Serotonin increase'}]), 452 `on adding property ${i} by ${signer.address}`,453 ).to.be.fulfilled;454 }455456 const originalSpace = await getConsumedSpace(token.collection.helper.getApi(), token.collectionId, token.tokenId, pieces == 1n ? 'NFT' : 'RFT'); 457 return originalSpace;458 }459460 async function testForbidsChangingDeletingPropertiesUserOutsideOfPermissions(token: UniqueNFToken | UniqueRFToken, pieces: bigint) {461 const originalSpace = await prepare(token, pieces);462463 let i = 0;464 for (const forbiddance of constitution) {465 i++;466 if (!forbiddance.permission.mutable) continue;467468 await expect(469 token.setProperties(forbiddance.sinner, [{key: `${i}`, value: 'Serotonin down'}]), 470 `on failing to change property ${i} by the malefactor`,471 ).to.be.rejectedWith(/common\.NoPermission/);472473 await expect(474 token.deleteProperties(forbiddance.sinner, [`${i}`]), 475 `on failing to delete property ${i} by the malefactor`,476 ).to.be.rejectedWith(/common\.NoPermission/);477 }478479 const consumedSpace = await getConsumedSpace(token.collection.helper.getApi(), token.collectionId, token.tokenId, pieces == 1n ? 'NFT' : 'RFT'); 480 expect(consumedSpace).to.be.equal(originalSpace);481 }482483 itSub('Forbids changing/deleting properties of a token if the user is outside of permissions (NFT)', async ({helper}) => {484 const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'NFT');485 await testForbidsChangingDeletingPropertiesUserOutsideOfPermissions(token, amount);486 });487488 itSub.ifWithPallets('Forbids changing/deleting properties of a token if the user is outside of permissions (ReFungible)', [Pallets.ReFungible], async ({helper}) => {489 const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'RFT');490 await testForbidsChangingDeletingPropertiesUserOutsideOfPermissions(token, amount);491 });492493 async function testForbidsChangingDeletingPropertiesIfPropertyImmutable(token: UniqueNFToken | UniqueRFToken, pieces: bigint) {494 const originalSpace = await prepare(token, pieces);495496 let i = 0;497 for (const permission of constitution) {498 i++;499 if (permission.permission.mutable) continue;500501 await expect(502 token.setProperties(permission.signers[0], [{key: `${i}`, value: 'Serotonin down'}]), 503 `on failing to change property ${i} by signer #0`,504 ).to.be.rejectedWith(/common\.NoPermission/);505506 await expect(507 token.deleteProperties(permission.signers[0], [i.toString()]), 508 `on failing to delete property ${i} by signer #0`,509 ).to.be.rejectedWith(/common\.NoPermission/);510 }511 512 const consumedSpace = await getConsumedSpace(token.collection.helper.getApi(), token.collectionId, token.tokenId, pieces == 1n ? 'NFT' : 'RFT'); 513 expect(consumedSpace).to.be.equal(originalSpace);514 }515516 itSub('Forbids changing/deleting properties of a token if the property is permanent (immutable) (NFT)', async ({helper}) => {517 const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'NFT');518 await testForbidsChangingDeletingPropertiesIfPropertyImmutable(token, amount);519 });520521 itSub.ifWithPallets('Forbids changing/deleting properties of a token if the property is permanent (immutable) (ReFungible)', [Pallets.ReFungible], async ({helper}) => {522 const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'RFT');523 await testForbidsChangingDeletingPropertiesIfPropertyImmutable(token, amount);524 });525526 async function testForbidsAddingPropertiesIfPropertyNotDeclared(token: UniqueNFToken | UniqueRFToken, pieces: bigint) {527 const originalSpace = await prepare(token, pieces);528529 await expect(530 token.setProperties(alice, [{key: 'non-existent', value: 'I exist!'}]), 531 'on failing to add a previously non-existent property',532 ).to.be.rejectedWith(/common\.NoPermission/);533 534 await expect(535 token.collection.setTokenPropertyPermissions(alice, [{key: 'now-existent', permission: {}}]), 536 'on setting a new non-permitted property',537 ).to.be.fulfilled;538539 await expect(540 token.setProperties(alice, [{key: 'now-existent', value: 'I exist!'}]), 541 'on failing to add a property forbidden by the \'None\' permission',542 ).to.be.rejectedWith(/common\.NoPermission/);543544 expect(await token.getProperties(['non-existent', 'now-existent'])).to.be.empty;545 546 const consumedSpace = await getConsumedSpace(token.collection.helper.getApi(), token.collectionId, token.tokenId, pieces == 1n ? 'NFT' : 'RFT'); 547 expect(consumedSpace).to.be.equal(originalSpace);548 }549550 itSub('Forbids adding properties to a token if the property is not declared / forbidden with the \'None\' permission (NFT)', async ({helper}) => {551 const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'NFT');552 await testForbidsAddingPropertiesIfPropertyNotDeclared(token, amount);553 });554555 itSub.ifWithPallets('Forbids adding properties to a token if the property is not declared / forbidden with the \'None\' permission (ReFungible)', [Pallets.ReFungible], async ({helper}) => {556 const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'RFT');557 await testForbidsAddingPropertiesIfPropertyNotDeclared(token, amount);558 });559560 async function testForbidsAddingTooLargeProperties(token: UniqueNFToken | UniqueRFToken, pieces: bigint) {561 const originalSpace = await prepare(token, pieces);562563 await expect(564 token.collection.setTokenPropertyPermissions(alice, [565 {key: 'a_holy_book', permission: {collectionAdmin: true, tokenOwner: true}}, 566 {key: 'young_years', permission: {collectionAdmin: true, tokenOwner: true}},567 ]), 568 'on setting new permissions for properties',569 ).to.be.fulfilled;570571 // Mute the general tx parsing error572 {573 console.error = () => {};574 await expect(token.setProperties(alice, [{key: 'a_holy_book', value: 'word '.repeat(6554)}]))575 .to.be.rejected;576 }577578 await expect(token.setProperties(alice, [579 {key: 'a_holy_book', value: 'word '.repeat(3277)}, 580 {key: 'young_years', value: 'neverending'.repeat(1490)},581 ])).to.be.rejectedWith(/common\.NoSpaceForProperty/);582 583 expect(await token.getProperties(['a_holy_book', 'young_years'])).to.be.empty;584 const consumedSpace = await getConsumedSpace(token.collection.helper.getApi(), token.collectionId, token.tokenId, pieces == 1n ? 'NFT' : 'RFT'); 585 expect(consumedSpace).to.be.equal(originalSpace);586 }587588 itSub('Forbids adding too large properties to a token (NFT)', async ({helper}) => {589 const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'NFT');590 await testForbidsAddingTooLargeProperties(token, amount);591 });592593 itSub.ifWithPallets('Forbids adding too large properties to a token (ReFungible)', [Pallets.ReFungible], async ({helper}) => {594 const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'RFT');595 await testForbidsAddingTooLargeProperties(token, amount);596 });597598 [599 {mode: 'nft' as const, requiredPallets: []},600 {mode: 'rft' as const, requiredPallets: [Pallets.ReFungible]}, 601 ].map(testCase =>602 itSub.ifWithPallets(`Forbids adding too many propeties to a token (${testCase.mode})`, testCase.requiredPallets, async({helper}) => {603 const collection = await helper[testCase.mode].mintCollection(alice);604 const maxPropertiesPerItem = 64;605606 for (let i = 0; i < maxPropertiesPerItem; i++) {607 await collection.setTokenPropertyPermissions(alice, [{608 key: `${i+1}`,609 permission: {mutable: true, tokenOwner: true, collectionAdmin: true},610 }]);611 }612613 await expect(collection.setTokenPropertyPermissions(alice, [{614 key: `${maxPropertiesPerItem}-th`,615 permission: {mutable: true, tokenOwner: true, collectionAdmin: true},616 }])).to.be.rejectedWith(/common\.PropertyLimitReached/);617 }));618});619620describe('ReFungible token properties permissions tests', () => {621 let alice: IKeyringPair;622 let bob: IKeyringPair;623 let charlie: IKeyringPair;624625 before(async function() {626 await usingPlaygrounds(async (helper, privateKey) => {627 requirePalletsOrSkip(this, helper, [Pallets.ReFungible]);628629 const donor = await privateKey({filename: __filename});630 [alice, bob, charlie] = await helper.arrange.createAccounts([100n, 100n, 100n], donor);631 });632 });633634 async function prepare(helper: UniqueHelper): Promise<UniqueRFToken> {635 const collection = await helper.rft.mintCollection(alice);636 const token = await collection.mintToken(alice, 100n);637 638 await collection.addAdmin(alice, {Substrate: bob.address});639 await collection.setTokenPropertyPermissions(alice, [{key: 'fractals', permission: {mutable: true, tokenOwner: true}}]);640 641 return token;642 }643644 itSub('Forbids adding token property with tokenOwner==true when signer doesn\'t have all pieces', async ({helper}) => {645 const token = await prepare(helper);646647 await token.transfer(alice, {Substrate: charlie.address}, 33n);648649 await expect(token.setProperties(alice, [650 {key: 'fractals', value: 'multiverse'}, 651 ])).to.be.rejectedWith(/common\.NoPermission/);652 });653654 itSub('Forbids mutating token property with tokenOwner==true when signer doesn\'t have all pieces', async ({helper}) => {655 const token = await prepare(helper);656657 await expect(token.collection.setTokenPropertyPermissions(alice, [{key: 'fractals', permission: {mutable:true, tokenOwner: true}}]))658 .to.be.fulfilled;659660 await expect(token.setProperties(alice, [661 {key: 'fractals', value: 'multiverse'}, 662 ])).to.be.fulfilled;663664 await token.transfer(alice, {Substrate: charlie.address}, 33n);665666 await expect(token.setProperties(alice, [667 {key: 'fractals', value: 'want to rule the world'}, 668 ])).to.be.rejectedWith(/common\.NoPermission/);669 });670671 itSub('Forbids deleting token property with tokenOwner==true when signer doesn\'t have all pieces', async ({helper}) => {672 const token = await prepare(helper);673674 await expect(token.setProperties(alice, [675 {key: 'fractals', value: 'one headline - why believe it'}, 676 ])).to.be.fulfilled;677678 await token.transfer(alice, {Substrate: charlie.address}, 33n);679680 await expect(token.deleteProperties(alice, ['fractals'])).681 to.be.rejectedWith(/common\.NoPermission/);682 });683684 itSub('Allows token property mutation with collectionOwner==true when admin doesn\'t have all pieces', async ({helper}) => {685 const token = await prepare(helper);686687 await token.transfer(alice, {Substrate: charlie.address}, 33n);688689 await expect(token.collection.setTokenPropertyPermissions(alice, [{key: 'fractals', permission: {mutable:true, collectionAdmin: true}}]))690 .to.be.fulfilled;691692 await expect(token.setProperties(alice, [693 {key: 'fractals', value: 'multiverse'}, 694 ])).to.be.fulfilled;695 });696});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} 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({filename: __filename});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 => {return {key: `${i+1}_${signer.address}`, permission};})),48 });49 return mode == 'NFT' ? [await collection.mintToken(alice), 1n] : [await collection.mintToken(alice, 100n), 100n];50 }51 52 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;120 121 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;167 168 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 }189 190 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 => {return {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 => {return {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;255 256 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 => {return {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;300 301 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: []},326 {mode: 'rft' as const, storage: 'refungible' as const, pieces: 100n, requiredPallets: [Pallets.ReFungible]}, 327 ].map(testCase =>328 itSub.ifWithPallets(`Allows modifying a token property multiple times (${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)353 : collection.mintToken(alice)354 );355356 await token.setProperties(alice, [{key: propKey, value: makeNewPropData()}]);357 const originalSpace = await token.getTokenPropertiesConsumedSpace();358 expect(originalSpace).to.be.equal(propDataSize);359360 const sameSizePropertiesPossibleNum = maxTokenPropertiesSize / propDataSize;361362 // It is possible to modify a property as many times as needed.363 // It will not consume any additional space.364 for (let i = 0; i < sameSizePropertiesPossibleNum + 1; i++) {365 await token.setProperties(alice, [{key: propKey, value: makeNewPropData()}]);366 const consumedSpace = await token.getTokenPropertiesConsumedSpace();367 expect(consumedSpace).to.be.equal(originalSpace);368 }369 }));370371 [372 {mode: 'nft' as const, pieces: undefined, requiredPallets: []},373 {mode: 'rft' as const, pieces: 100n, requiredPallets: [Pallets.ReFungible]}, 374 ].map(testCase =>375 itSub.ifWithPallets(`Adding then removing a token property doesn't change the consumed space (${testCase.mode})`, testCase.requiredPallets, async({helper}) => {376 const propKey = 'tok-prop';377378 const collection = await helper[testCase.mode].mintCollection(alice, {379 tokenPropertyPermissions: [380 {381 key: propKey,382 permission: {mutable: true, tokenOwner: true},383 },384 ],385 });386 const token = await (387 testCase.pieces388 ? collection.mintToken(alice, testCase.pieces)389 : collection.mintToken(alice)390 );391 const originalSpace = await token.getTokenPropertiesConsumedSpace();392393 const propDataSize = 4096;394 const propData = 'a'.repeat(propDataSize);395396 await token.setProperties(alice, [{key: propKey, value: propData}]);397 let consumedSpace = await token.getTokenPropertiesConsumedSpace();398 expect(consumedSpace).to.be.equal(propDataSize);399400 await token.deleteProperties(alice, [propKey]);401 consumedSpace = await token.getTokenPropertiesConsumedSpace();402 expect(consumedSpace).to.be.equal(originalSpace);403 }));404405 [406 {mode: 'nft' as const, pieces: undefined, requiredPallets: []},407 {mode: 'rft' as const, pieces: 100n, requiredPallets: [Pallets.ReFungible]}, 408 ].map(testCase =>409 itSub.ifWithPallets(`repair_item preserves valid consumed space (${testCase.mode})`, testCase.requiredPallets, async({helper}) => {410 const propKey = 'tok-prop';411412 const collection = await helper[testCase.mode].mintCollection(alice, {413 tokenPropertyPermissions: [414 {415 key: propKey,416 permission: {mutable: true, tokenOwner: true},417 },418 ],419 });420 const token = await (421 testCase.pieces422 ? collection.mintToken(alice, testCase.pieces)423 : collection.mintToken(alice)424 );425426 const propDataSize = 4096;427 const propData = 'a'.repeat(propDataSize);428429 await token.setProperties(alice, [{key: propKey, value: propData}]);430 const originalSpace = await token.getTokenPropertiesConsumedSpace();431 expect(originalSpace).to.be.equal(propDataSize);432433 await helper.executeExtrinsic(alice, 'api.tx.unique.repairItem', [token.collectionId, token.tokenId], true);434 const recomputedSpace = await token.getTokenPropertiesConsumedSpace();435 expect(recomputedSpace).to.be.equal(originalSpace);436 }));437});438439describe('Negative Integration Test: Token Properties', () => {440 let alice: IKeyringPair; // collection owner441 let bob: IKeyringPair; // collection admin442 let charlie: IKeyringPair; // token owner443444 let constitution: {permission: any, signers: IKeyringPair[], sinner: IKeyringPair}[];445446 before(async () => {447 await usingPlaygrounds(async (helper, privateKey) => {448 const donor = await privateKey({filename: __filename});449 let dave: IKeyringPair;450 [alice, bob, charlie, dave] = await helper.arrange.createAccounts([100n, 100n, 100n, 100n], donor);451452 // todo:playgrounds probably separate these tests later453 constitution = [454 {permission: {mutable: true, collectionAdmin: true}, signers: [alice, bob], sinner: charlie},455 {permission: {mutable: false, collectionAdmin: true}, signers: [alice, bob], sinner: charlie},456 {permission: {mutable: true, tokenOwner: true}, signers: [charlie], sinner: alice},457 {permission: {mutable: false, tokenOwner: true}, signers: [charlie], sinner: alice},458 {permission: {mutable: true, collectionAdmin: true, tokenOwner: true}, signers: [alice, bob, charlie], sinner: dave},459 {permission: {mutable: false, collectionAdmin: true, tokenOwner: true}, signers: [alice, bob, charlie], sinner: dave},460 ];461 });462 });463464 async function mintCollectionWithAllPermissionsAndToken(helper: UniqueHelper, mode: 'NFT' | 'RFT'): Promise<[UniqueNFToken | UniqueRFToken, bigint]> {465 const collection = await (mode == 'NFT' ? helper.nft : helper.rft).mintCollection(alice, {466 tokenPropertyPermissions: constitution.map(({permission}, i) => {return {key: `${i+1}`, permission};}),467 });468 return mode == 'NFT' ? [await collection.mintToken(alice), 1n] : [await collection.mintToken(alice, 100n), 100n];469 }470471 async function getConsumedSpace(api: any, collectionId: number, tokenId: number, mode: 'NFT' | 'RFT'): Promise<number> {472 return (await (mode == 'NFT' ? api.query.nonfungible : api.query.refungible).tokenProperties(collectionId, tokenId)).toJSON().consumedSpace;473 }474475 async function prepare(token: UniqueNFToken | UniqueRFToken, pieces: bigint): Promise<number> {476 await token.collection.addAdmin(alice, {Substrate: bob.address});477 await token.transfer(alice, {Substrate: charlie.address}, pieces);478479 let i = 0;480 for (const passage of constitution) {481 i++;482 const signer = passage.signers[0];483 await expect(484 token.setProperties(signer, [{key: `${i}`, value: 'Serotonin increase'}]), 485 `on adding property ${i} by ${signer.address}`,486 ).to.be.fulfilled;487 }488489 const originalSpace = await getConsumedSpace(token.collection.helper.getApi(), token.collectionId, token.tokenId, pieces == 1n ? 'NFT' : 'RFT'); 490 return originalSpace;491 }492493 async function testForbidsChangingDeletingPropertiesUserOutsideOfPermissions(token: UniqueNFToken | UniqueRFToken, pieces: bigint) {494 const originalSpace = await prepare(token, pieces);495496 let i = 0;497 for (const forbiddance of constitution) {498 i++;499 if (!forbiddance.permission.mutable) continue;500501 await expect(502 token.setProperties(forbiddance.sinner, [{key: `${i}`, value: 'Serotonin down'}]), 503 `on failing to change property ${i} by the malefactor`,504 ).to.be.rejectedWith(/common\.NoPermission/);505506 await expect(507 token.deleteProperties(forbiddance.sinner, [`${i}`]), 508 `on failing to delete property ${i} by the malefactor`,509 ).to.be.rejectedWith(/common\.NoPermission/);510 }511512 const consumedSpace = await getConsumedSpace(token.collection.helper.getApi(), token.collectionId, token.tokenId, pieces == 1n ? 'NFT' : 'RFT'); 513 expect(consumedSpace).to.be.equal(originalSpace);514 }515516 itSub('Forbids changing/deleting properties of a token if the user is outside of permissions (NFT)', async ({helper}) => {517 const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'NFT');518 await testForbidsChangingDeletingPropertiesUserOutsideOfPermissions(token, amount);519 });520521 itSub.ifWithPallets('Forbids changing/deleting properties of a token if the user is outside of permissions (ReFungible)', [Pallets.ReFungible], async ({helper}) => {522 const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'RFT');523 await testForbidsChangingDeletingPropertiesUserOutsideOfPermissions(token, amount);524 });525526 async function testForbidsChangingDeletingPropertiesIfPropertyImmutable(token: UniqueNFToken | UniqueRFToken, pieces: bigint) {527 const originalSpace = await prepare(token, pieces);528529 let i = 0;530 for (const permission of constitution) {531 i++;532 if (permission.permission.mutable) continue;533534 await expect(535 token.setProperties(permission.signers[0], [{key: `${i}`, value: 'Serotonin down'}]), 536 `on failing to change property ${i} by signer #0`,537 ).to.be.rejectedWith(/common\.NoPermission/);538539 await expect(540 token.deleteProperties(permission.signers[0], [i.toString()]), 541 `on failing to delete property ${i} by signer #0`,542 ).to.be.rejectedWith(/common\.NoPermission/);543 }544 545 const consumedSpace = await getConsumedSpace(token.collection.helper.getApi(), token.collectionId, token.tokenId, pieces == 1n ? 'NFT' : 'RFT'); 546 expect(consumedSpace).to.be.equal(originalSpace);547 }548549 itSub('Forbids changing/deleting properties of a token if the property is permanent (immutable) (NFT)', async ({helper}) => {550 const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'NFT');551 await testForbidsChangingDeletingPropertiesIfPropertyImmutable(token, amount);552 });553554 itSub.ifWithPallets('Forbids changing/deleting properties of a token if the property is permanent (immutable) (ReFungible)', [Pallets.ReFungible], async ({helper}) => {555 const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'RFT');556 await testForbidsChangingDeletingPropertiesIfPropertyImmutable(token, amount);557 });558559 async function testForbidsAddingPropertiesIfPropertyNotDeclared(token: UniqueNFToken | UniqueRFToken, pieces: bigint) {560 const originalSpace = await prepare(token, pieces);561562 await expect(563 token.setProperties(alice, [{key: 'non-existent', value: 'I exist!'}]), 564 'on failing to add a previously non-existent property',565 ).to.be.rejectedWith(/common\.NoPermission/);566 567 await expect(568 token.collection.setTokenPropertyPermissions(alice, [{key: 'now-existent', permission: {}}]), 569 'on setting a new non-permitted property',570 ).to.be.fulfilled;571572 await expect(573 token.setProperties(alice, [{key: 'now-existent', value: 'I exist!'}]), 574 'on failing to add a property forbidden by the \'None\' permission',575 ).to.be.rejectedWith(/common\.NoPermission/);576577 expect(await token.getProperties(['non-existent', 'now-existent'])).to.be.empty;578 579 const consumedSpace = await getConsumedSpace(token.collection.helper.getApi(), token.collectionId, token.tokenId, pieces == 1n ? 'NFT' : 'RFT'); 580 expect(consumedSpace).to.be.equal(originalSpace);581 }582583 itSub('Forbids adding properties to a token if the property is not declared / forbidden with the \'None\' permission (NFT)', async ({helper}) => {584 const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'NFT');585 await testForbidsAddingPropertiesIfPropertyNotDeclared(token, amount);586 });587588 itSub.ifWithPallets('Forbids adding properties to a token if the property is not declared / forbidden with the \'None\' permission (ReFungible)', [Pallets.ReFungible], async ({helper}) => {589 const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'RFT');590 await testForbidsAddingPropertiesIfPropertyNotDeclared(token, amount);591 });592593 async function testForbidsAddingTooLargeProperties(token: UniqueNFToken | UniqueRFToken, pieces: bigint) {594 const originalSpace = await prepare(token, pieces);595596 await expect(597 token.collection.setTokenPropertyPermissions(alice, [598 {key: 'a_holy_book', permission: {collectionAdmin: true, tokenOwner: true}}, 599 {key: 'young_years', permission: {collectionAdmin: true, tokenOwner: true}},600 ]), 601 'on setting new permissions for properties',602 ).to.be.fulfilled;603604 // Mute the general tx parsing error605 {606 console.error = () => {};607 await expect(token.setProperties(alice, [{key: 'a_holy_book', value: 'word '.repeat(6554)}]))608 .to.be.rejected;609 }610611 await expect(token.setProperties(alice, [612 {key: 'a_holy_book', value: 'word '.repeat(3277)}, 613 {key: 'young_years', value: 'neverending'.repeat(1490)},614 ])).to.be.rejectedWith(/common\.NoSpaceForProperty/);615 616 expect(await token.getProperties(['a_holy_book', 'young_years'])).to.be.empty;617 const consumedSpace = await getConsumedSpace(token.collection.helper.getApi(), token.collectionId, token.tokenId, pieces == 1n ? 'NFT' : 'RFT'); 618 expect(consumedSpace).to.be.equal(originalSpace);619 }620621 itSub('Forbids adding too large properties to a token (NFT)', async ({helper}) => {622 const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'NFT');623 await testForbidsAddingTooLargeProperties(token, amount);624 });625626 itSub.ifWithPallets('Forbids adding too large properties to a token (ReFungible)', [Pallets.ReFungible], async ({helper}) => {627 const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'RFT');628 await testForbidsAddingTooLargeProperties(token, amount);629 });630631 [632 {mode: 'nft' as const, requiredPallets: []},633 {mode: 'rft' as const, requiredPallets: [Pallets.ReFungible]}, 634 ].map(testCase =>635 itSub.ifWithPallets(`Forbids adding too many propeties to a token (${testCase.mode})`, testCase.requiredPallets, async({helper}) => {636 const collection = await helper[testCase.mode].mintCollection(alice);637 const maxPropertiesPerItem = 64;638639 for (let i = 0; i < maxPropertiesPerItem; i++) {640 await collection.setTokenPropertyPermissions(alice, [{641 key: `${i+1}`,642 permission: {mutable: true, tokenOwner: true, collectionAdmin: true},643 }]);644 }645646 await expect(collection.setTokenPropertyPermissions(alice, [{647 key: `${maxPropertiesPerItem}-th`,648 permission: {mutable: true, tokenOwner: true, collectionAdmin: true},649 }])).to.be.rejectedWith(/common\.PropertyLimitReached/);650 }));651});652653describe('ReFungible token properties permissions tests', () => {654 let alice: IKeyringPair;655 let bob: IKeyringPair;656 let charlie: IKeyringPair;657658 before(async function() {659 await usingPlaygrounds(async (helper, privateKey) => {660 requirePalletsOrSkip(this, helper, [Pallets.ReFungible]);661662 const donor = await privateKey({filename: __filename});663 [alice, bob, charlie] = await helper.arrange.createAccounts([100n, 100n, 100n], donor);664 });665 });666667 async function prepare(helper: UniqueHelper): Promise<UniqueRFToken> {668 const collection = await helper.rft.mintCollection(alice);669 const token = await collection.mintToken(alice, 100n);670 671 await collection.addAdmin(alice, {Substrate: bob.address});672 await collection.setTokenPropertyPermissions(alice, [{key: 'fractals', permission: {mutable: true, tokenOwner: true}}]);673 674 return token;675 }676677 itSub('Forbids adding token property with tokenOwner==true when signer doesn\'t have all pieces', async ({helper}) => {678 const token = await prepare(helper);679680 await token.transfer(alice, {Substrate: charlie.address}, 33n);681682 await expect(token.setProperties(alice, [683 {key: 'fractals', value: 'multiverse'}, 684 ])).to.be.rejectedWith(/common\.NoPermission/);685 });686687 itSub('Forbids mutating token property with tokenOwner==true when signer doesn\'t have all pieces', async ({helper}) => {688 const token = await prepare(helper);689690 await expect(token.collection.setTokenPropertyPermissions(alice, [{key: 'fractals', permission: {mutable:true, tokenOwner: true}}]))691 .to.be.fulfilled;692693 await expect(token.setProperties(alice, [694 {key: 'fractals', value: 'multiverse'}, 695 ])).to.be.fulfilled;696697 await token.transfer(alice, {Substrate: charlie.address}, 33n);698699 await expect(token.setProperties(alice, [700 {key: 'fractals', value: 'want to rule the world'}, 701 ])).to.be.rejectedWith(/common\.NoPermission/);702 });703704 itSub('Forbids deleting token property with tokenOwner==true when signer doesn\'t have all pieces', async ({helper}) => {705 const token = await prepare(helper);706707 await expect(token.setProperties(alice, [708 {key: 'fractals', value: 'one headline - why believe it'}, 709 ])).to.be.fulfilled;710711 await token.transfer(alice, {Substrate: charlie.address}, 33n);712713 await expect(token.deleteProperties(alice, ['fractals'])).714 to.be.rejectedWith(/common\.NoPermission/);715 });716717 itSub('Allows token property mutation with collectionOwner==true when admin doesn\'t have all pieces', async ({helper}) => {718 const token = await prepare(helper);719720 await token.transfer(alice, {Substrate: charlie.address}, 33n);721722 await expect(token.collection.setTokenPropertyPermissions(alice, [{key: 'fractals', permission: {mutable:true, collectionAdmin: true}}]))723 .to.be.fulfilled;724725 await expect(token.setProperties(alice, [726 {key: 'fractals', value: 'multiverse'}, 727 ])).to.be.fulfilled;728 });729});