`9296d13cc7af`

source

tests/src/nesting/tokenProperties.test.ts32.6 KiBsource history
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  }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 => {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;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 => {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;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: []},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 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)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(`Modifying a token property with different sizes correctly changes the 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      );425      const originalSpace = await token.getTokenPropertiesConsumedSpace();426427      const initPropDataSize = 4096;428      const biggerPropDataSize = 5000;429      const smallerPropDataSize = 4000;430431      const initPropData = 'a'.repeat(initPropDataSize);432      const biggerPropData = 'b'.repeat(biggerPropDataSize);433      const smallerPropData = 'c'.repeat(smallerPropDataSize);434435      let consumedSpace;436      let expectedConsumedSpaceDiff;437438      await token.setProperties(alice, [{key: propKey, value: initPropData}]);439      consumedSpace = await token.getTokenPropertiesConsumedSpace();440      expectedConsumedSpaceDiff = initPropDataSize - originalSpace;441      expect(consumedSpace).to.be.equal(originalSpace + expectedConsumedSpaceDiff);442443      await token.setProperties(alice, [{key: propKey, value: biggerPropData}]);444      consumedSpace = await token.getTokenPropertiesConsumedSpace();445      expectedConsumedSpaceDiff = biggerPropDataSize - initPropDataSize;446      expect(consumedSpace).to.be.equal(initPropDataSize + expectedConsumedSpaceDiff);447448      await token.setProperties(alice, [{key: propKey, value: smallerPropData}]);449      consumedSpace = await token.getTokenPropertiesConsumedSpace();450      expectedConsumedSpaceDiff = biggerPropDataSize - smallerPropDataSize;451      expect(consumedSpace).to.be.equal(biggerPropDataSize - expectedConsumedSpaceDiff);452    }));453});454455describe('Negative Integration Test: Token Properties', () => {456  let alice: IKeyringPair; // collection owner457  let bob: IKeyringPair; // collection admin458  let charlie: IKeyringPair; // token owner459460  let constitution: {permission: any, signers: IKeyringPair[], sinner: IKeyringPair}[];461462  before(async () => {463    await usingPlaygrounds(async (helper, privateKey) => {464      const donor = await privateKey({filename: __filename});465      let dave: IKeyringPair;466      [alice, bob, charlie, dave] = await helper.arrange.createAccounts([100n, 100n, 100n, 100n], donor);467468      // todo:playgrounds probably separate these tests later469      constitution = [470        {permission: {mutable: true, collectionAdmin: true}, signers: [alice, bob], sinner: charlie},471        {permission: {mutable: false, collectionAdmin: true}, signers: [alice, bob], sinner: charlie},472        {permission: {mutable: true, tokenOwner: true}, signers: [charlie], sinner: alice},473        {permission: {mutable: false, tokenOwner: true}, signers: [charlie], sinner: alice},474        {permission: {mutable: true, collectionAdmin: true, tokenOwner: true}, signers: [alice, bob, charlie], sinner: dave},475        {permission: {mutable: false, collectionAdmin: true, tokenOwner: true}, signers: [alice, bob, charlie], sinner: dave},476      ];477    });478  });479480  async function mintCollectionWithAllPermissionsAndToken(helper: UniqueHelper, mode: 'NFT' | 'RFT'): Promise<[UniqueNFToken | UniqueRFToken, bigint]> {481    const collection = await (mode == 'NFT' ? helper.nft : helper.rft).mintCollection(alice, {482      tokenPropertyPermissions: constitution.map(({permission}, i) => {return {key: `${i+1}`, permission};}),483    });484    return mode == 'NFT' ? [await collection.mintToken(alice), 1n] : [await collection.mintToken(alice, 100n), 100n];485  }486487  async function getConsumedSpace(api: any, collectionId: number, tokenId: number, mode: 'NFT' | 'RFT'): Promise<number> {488    return (await (mode == 'NFT' ? api.query.nonfungible : api.query.refungible).tokenProperties(collectionId, tokenId)).toJSON().consumedSpace;489  }490491  async function prepare(token: UniqueNFToken | UniqueRFToken, pieces: bigint): Promise<number> {492    await token.collection.addAdmin(alice, {Substrate: bob.address});493    await token.transfer(alice, {Substrate: charlie.address}, pieces);494495    let i = 0;496    for (const passage of constitution) {497      i++;498      const signer = passage.signers[0];499      await expect(500        token.setProperties(signer, [{key: `${i}`, value: 'Serotonin increase'}]),501        `on adding property ${i} by ${signer.address}`,502      ).to.be.fulfilled;503    }504505    const originalSpace = await getConsumedSpace(token.collection.helper.getApi(), token.collectionId, token.tokenId, pieces == 1n ? 'NFT' : 'RFT');506    return originalSpace;507  }508509  async function testForbidsChangingDeletingPropertiesUserOutsideOfPermissions(token: UniqueNFToken | UniqueRFToken, pieces: bigint) {510    const originalSpace = await prepare(token, pieces);511512    let i = 0;513    for (const forbiddance of constitution) {514      i++;515      if (!forbiddance.permission.mutable) continue;516517      await expect(518        token.setProperties(forbiddance.sinner, [{key: `${i}`, value: 'Serotonin down'}]),519        `on failing to change property ${i} by the malefactor`,520      ).to.be.rejectedWith(/common\.NoPermission/);521522      await expect(523        token.deleteProperties(forbiddance.sinner, [`${i}`]),524        `on failing to delete property ${i} by the malefactor`,525      ).to.be.rejectedWith(/common\.NoPermission/);526    }527528    const consumedSpace = await getConsumedSpace(token.collection.helper.getApi(), token.collectionId, token.tokenId, pieces == 1n ? 'NFT' : 'RFT');529    expect(consumedSpace).to.be.equal(originalSpace);530  }531532  itSub('Forbids changing/deleting properties of a token if the user is outside of permissions (NFT)', async ({helper}) =>  {533    const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'NFT');534    await testForbidsChangingDeletingPropertiesUserOutsideOfPermissions(token, amount);535  });536537  itSub.ifWithPallets('Forbids changing/deleting properties of a token if the user is outside of permissions (ReFungible)', [Pallets.ReFungible], async ({helper}) => {538    const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'RFT');539    await testForbidsChangingDeletingPropertiesUserOutsideOfPermissions(token, amount);540  });541542  async function testForbidsChangingDeletingPropertiesIfPropertyImmutable(token: UniqueNFToken | UniqueRFToken, pieces: bigint) {543    const originalSpace = await prepare(token, pieces);544545    let i = 0;546    for (const permission of constitution) {547      i++;548      if (permission.permission.mutable) continue;549550      await expect(551        token.setProperties(permission.signers[0], [{key: `${i}`, value: 'Serotonin down'}]),552        `on failing to change property ${i} by signer #0`,553      ).to.be.rejectedWith(/common\.NoPermission/);554555      await expect(556        token.deleteProperties(permission.signers[0], [i.toString()]),557        `on failing to delete property ${i} by signer #0`,558      ).to.be.rejectedWith(/common\.NoPermission/);559    }560561    const consumedSpace = await getConsumedSpace(token.collection.helper.getApi(), token.collectionId, token.tokenId, pieces == 1n ? 'NFT' : 'RFT');562    expect(consumedSpace).to.be.equal(originalSpace);563  }564565  itSub('Forbids changing/deleting properties of a token if the property is permanent (immutable) (NFT)', async ({helper}) =>  {566    const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'NFT');567    await testForbidsChangingDeletingPropertiesIfPropertyImmutable(token, amount);568  });569570  itSub.ifWithPallets('Forbids changing/deleting properties of a token if the property is permanent (immutable) (ReFungible)', [Pallets.ReFungible], async ({helper}) => {571    const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'RFT');572    await testForbidsChangingDeletingPropertiesIfPropertyImmutable(token, amount);573  });574575  async function testForbidsAddingPropertiesIfPropertyNotDeclared(token: UniqueNFToken | UniqueRFToken, pieces: bigint) {576    const originalSpace = await prepare(token, pieces);577578    await expect(579      token.setProperties(alice, [{key: 'non-existent', value: 'I exist!'}]),580      'on failing to add a previously non-existent property',581    ).to.be.rejectedWith(/common\.NoPermission/);582583    await expect(584      token.collection.setTokenPropertyPermissions(alice, [{key: 'now-existent', permission: {}}]),585      'on setting a new non-permitted property',586    ).to.be.fulfilled;587588    await expect(589      token.setProperties(alice, [{key: 'now-existent', value: 'I exist!'}]),590      'on failing to add a property forbidden by the \'None\' permission',591    ).to.be.rejectedWith(/common\.NoPermission/);592593    expect(await token.getProperties(['non-existent', 'now-existent'])).to.be.empty;594595    const consumedSpace = await getConsumedSpace(token.collection.helper.getApi(), token.collectionId, token.tokenId, pieces == 1n ? 'NFT' : 'RFT');596    expect(consumedSpace).to.be.equal(originalSpace);597  }598599  itSub('Forbids adding properties to a token if the property is not declared / forbidden with the \'None\' permission (NFT)', async ({helper}) =>  {600    const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'NFT');601    await testForbidsAddingPropertiesIfPropertyNotDeclared(token, amount);602  });603604  itSub.ifWithPallets('Forbids adding properties to a token if the property is not declared / forbidden with the \'None\' permission (ReFungible)', [Pallets.ReFungible], async ({helper}) => {605    const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'RFT');606    await testForbidsAddingPropertiesIfPropertyNotDeclared(token, amount);607  });608609  async function testForbidsAddingTooLargeProperties(token: UniqueNFToken | UniqueRFToken, pieces: bigint) {610    const originalSpace = await prepare(token, pieces);611612    await expect(613      token.collection.setTokenPropertyPermissions(alice, [614        {key: 'a_holy_book', permission: {collectionAdmin: true, tokenOwner: true}},615        {key: 'young_years', permission: {collectionAdmin: true, tokenOwner: true}},616      ]),617      'on setting new permissions for properties',618    ).to.be.fulfilled;619620    // Mute the general tx parsing error621    {622      console.error = () => {};623      await expect(token.setProperties(alice, [{key: 'a_holy_book', value: 'word '.repeat(6554)}]))624        .to.be.rejected;625    }626627    await expect(token.setProperties(alice, [628      {key: 'a_holy_book', value: 'word '.repeat(3277)},629      {key: 'young_years', value: 'neverending'.repeat(1490)},630    ])).to.be.rejectedWith(/common\.NoSpaceForProperty/);631632    expect(await token.getProperties(['a_holy_book', 'young_years'])).to.be.empty;633    const consumedSpace = await getConsumedSpace(token.collection.helper.getApi(), token.collectionId, token.tokenId, pieces == 1n ? 'NFT' : 'RFT');634    expect(consumedSpace).to.be.equal(originalSpace);635  }636637  itSub('Forbids adding too large properties to a token (NFT)', async ({helper}) =>  {638    const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'NFT');639    await testForbidsAddingTooLargeProperties(token, amount);640  });641642  itSub.ifWithPallets('Forbids adding too large properties to a token (ReFungible)', [Pallets.ReFungible], async ({helper}) => {643    const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'RFT');644    await testForbidsAddingTooLargeProperties(token, amount);645  });646647  [648    {mode: 'nft' as const, requiredPallets: []},649    {mode: 'rft' as const, requiredPallets: [Pallets.ReFungible]},650  ].map(testCase =>651    itSub.ifWithPallets(`Forbids adding too many propeties to a token (${testCase.mode})`, testCase.requiredPallets, async({helper}) => {652      const collection = await helper[testCase.mode].mintCollection(alice);653      const maxPropertiesPerItem = 64;654655      for (let i = 0; i < maxPropertiesPerItem; i++) {656        await collection.setTokenPropertyPermissions(alice, [{657          key: `${i+1}`,658          permission: {mutable: true, tokenOwner: true, collectionAdmin: true},659        }]);660      }661662      await expect(collection.setTokenPropertyPermissions(alice, [{663        key: `${maxPropertiesPerItem}-th`,664        permission: {mutable: true, tokenOwner: true, collectionAdmin: true},665      }])).to.be.rejectedWith(/common\.PropertyLimitReached/);666    }));667668  [669    {mode: 'nft' as const, pieces: undefined, requiredPallets: []},670    {mode: 'rft' as const, pieces: 100n, requiredPallets: [Pallets.ReFungible]},671  ].map(testCase =>672    itSub.ifWithPallets(`Forbids force_repair_item from non-sudo (${testCase.mode})`, testCase.requiredPallets, async({helper}) => {673      const propKey = 'tok-prop';674675      const collection = await helper[testCase.mode].mintCollection(alice, {676        tokenPropertyPermissions: [677          {678            key: propKey,679            permission: {mutable: true, tokenOwner: true},680          },681        ],682      });683      const token = await (684        testCase.pieces685          ? collection.mintToken(alice, testCase.pieces)686          : collection.mintToken(alice)687      );688689      const propDataSize = 4096;690      const propData = 'a'.repeat(propDataSize);691      await token.setProperties(alice, [{key: propKey, value: propData}]);692693      await expect(helper.executeExtrinsic(alice, 'api.tx.unique.forceRepairItem', [token.collectionId, token.tokenId], true))694        .to.be.rejectedWith(/BadOrigin/);695    }));696});697698describe('ReFungible token properties permissions tests', () => {699  let alice: IKeyringPair;700  let bob: IKeyringPair;701  let charlie: IKeyringPair;702703  before(async function() {704    await usingPlaygrounds(async (helper, privateKey) => {705      requirePalletsOrSkip(this, helper, [Pallets.ReFungible]);706707      const donor = await privateKey({filename: __filename});708      [alice, bob, charlie] = await helper.arrange.createAccounts([100n, 100n, 100n], donor);709    });710  });711712  async function prepare(helper: UniqueHelper): Promise<UniqueRFToken> {713    const collection = await helper.rft.mintCollection(alice);714    const token = await collection.mintToken(alice, 100n);715716    await collection.addAdmin(alice, {Substrate: bob.address});717    await collection.setTokenPropertyPermissions(alice, [{key: 'fractals', permission: {mutable: true, tokenOwner: true}}]);718719    return token;720  }721722  itSub('Forbids adding token property with tokenOwner==true when signer doesn\'t have all pieces', async ({helper}) =>  {723    const token = await prepare(helper);724725    await token.transfer(alice, {Substrate: charlie.address}, 33n);726727    await expect(token.setProperties(alice, [728      {key: 'fractals', value: 'multiverse'},729    ])).to.be.rejectedWith(/common\.NoPermission/);730  });731732  itSub('Forbids mutating token property with tokenOwner==true when signer doesn\'t have all pieces', async ({helper}) =>  {733    const token = await prepare(helper);734735    await expect(token.collection.setTokenPropertyPermissions(alice, [{key: 'fractals', permission: {mutable:true, tokenOwner: true}}]))736      .to.be.fulfilled;737738    await expect(token.setProperties(alice, [739      {key: 'fractals', value: 'multiverse'},740    ])).to.be.fulfilled;741742    await token.transfer(alice, {Substrate: charlie.address}, 33n);743744    await expect(token.setProperties(alice, [745      {key: 'fractals', value: 'want to rule the world'},746    ])).to.be.rejectedWith(/common\.NoPermission/);747  });748749  itSub('Forbids deleting token property with tokenOwner==true when signer doesn\'t have all pieces', async ({helper}) =>  {750    const token = await prepare(helper);751752    await expect(token.setProperties(alice, [753      {key: 'fractals', value: 'one headline - why believe it'},754    ])).to.be.fulfilled;755756    await token.transfer(alice, {Substrate: charlie.address}, 33n);757758    await expect(token.deleteProperties(alice, ['fractals'])).759      to.be.rejectedWith(/common\.NoPermission/);760  });761762  itSub('Allows token property mutation with collectionOwner==true when admin doesn\'t have all pieces', async ({helper}) =>  {763    const token = await prepare(helper);764765    await token.transfer(alice, {Substrate: charlie.address}, 33n);766767    await expect(token.collection.setTokenPropertyPermissions(alice, [{key: 'fractals', permission: {mutable:true, collectionAdmin: true}}]))768      .to.be.fulfilled;769770    await expect(token.setProperties(alice, [771      {key: 'fractals', value: 'multiverse'},772    ])).to.be.fulfilled;773  });774});