`98307afa9ae6`

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, sizeOfProperty} from '../util';19import {UniqueHelper, UniqueNFToken, UniqueRFToken} from '../util/playgrounds/unique';2021describe('Integration Test: Token Properties', () => {22  let alice: IKeyringPair; // collection owner23  let bob: IKeyringPair; // collection admin24  let charlie: IKeyringPair; // token owner2526  let permissions: {permission: any, signers: IKeyringPair[]}[];2728  before(async () => {29    await usingPlaygrounds(async (helper, privateKey) => {30      const donor = await privateKey({url: import.meta.url});31      [alice, bob, charlie] = await helper.arrange.createAccounts([200n, 100n, 100n], donor);32    });3334    permissions = [35      {permission: {mutable: true, collectionAdmin: true}, signers: [alice, bob]},36      {permission: {mutable: false, collectionAdmin: true}, signers: [alice, bob]},37      {permission: {mutable: true, tokenOwner: true}, signers: [charlie]},38      {permission: {mutable: false, tokenOwner: true}, signers: [charlie]},39      {permission: {mutable: true, collectionAdmin: true, tokenOwner: true}, signers: [alice, bob, charlie]},40      {permission: {mutable: false, collectionAdmin: true, tokenOwner: true}, signers: [alice, bob, charlie]},41    ];42  });4344  async function mintCollectionWithAllPermissionsAndToken(helper: UniqueHelper, mode: 'NFT' | 'RFT'): Promise<[UniqueNFToken | UniqueRFToken, bigint]> {45    const collection = await (mode == 'NFT' ? helper.nft : helper.rft).mintCollection(alice, {46      tokenPropertyPermissions: permissions.flatMap(({permission, signers}, i) =>47        signers.map(signer => ({key: `${i+1}_${signer.address}`, permission}))),48    });49    return mode == 'NFT' ? [await collection.mintToken(alice), 1n] : [await collection.mintToken(alice, 100n as any), 100n];50  }5152  async function testReadsYetEmptyProperties(token: UniqueNFToken | UniqueRFToken) {53    const properties = await token.getProperties();54    expect(properties).to.be.empty;5556    const tokenData = await token.getData();57    expect(tokenData!.properties).to.be.empty;58  }5960  itSub('Reads yet empty properties of a token (NFT)', async ({helper}) => {61    const collection = await helper.nft.mintCollection(alice);62    const token = await collection.mintToken(alice);63    await testReadsYetEmptyProperties(token);64  });6566  itSub.ifWithPallets('Reads yet empty properties of a token (ReFungible)', [Pallets.ReFungible], async ({helper}) => {67    const collection = await helper.rft.mintCollection(alice);68    const token = await collection.mintToken(alice);69    await testReadsYetEmptyProperties(token);70  });7172  async function testAssignPropertiesAccordingToPermissions(token: UniqueNFToken | UniqueRFToken, pieces: bigint) {73    await token.collection.addAdmin(alice, {Substrate: bob.address});74    await token.transfer(alice, {Substrate: charlie.address}, pieces);7576    const propertyKeys: string[] = [];77    let i = 0;78    for (const permission of permissions) {79      i++;80      let j = 0;81      for (const signer of permission.signers) {82        j++;83        const key = i + '_' + signer.address;84        propertyKeys.push(key);8586        await expect(87          token.setProperties(signer, [{key: key, value: 'Serotonin increase'}]),88          `on adding property #${i} by signer #${j}`,89        ).to.be.fulfilled;90      }91    }9293    const properties = await token.getProperties(propertyKeys);94    const tokenData = await token.getData();95    for (let i = 0; i < properties.length; i++) {96      expect(properties[i].value).to.be.equal('Serotonin increase');97      expect(tokenData!.properties[i].value).to.be.equal('Serotonin increase');98    }99  }100101  itSub('Assigns properties to a token according to permissions (NFT)', async ({helper}) =>  {102    const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'NFT');103    await testAssignPropertiesAccordingToPermissions(token, amount);104  });105106  itSub.ifWithPallets('Assigns properties to a token according to permissions (ReFungible)', [Pallets.ReFungible], async ({helper}) => {107    const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'RFT');108    await testAssignPropertiesAccordingToPermissions(token, amount);109  });110111  async function testChangesPropertiesAccordingPermission(token: UniqueNFToken | UniqueRFToken, pieces: bigint) {112    await token.collection.addAdmin(alice, {Substrate: bob.address});113    await token.transfer(alice, {Substrate: charlie.address}, pieces);114115    const propertyKeys: string[] = [];116    let i = 0;117    for (const permission of permissions) {118      i++;119      if (!permission.permission.mutable) continue;120121      let j = 0;122      for (const signer of permission.signers) {123        j++;124        const key = i + '_' + signer.address;125        propertyKeys.push(key);126127        await expect(128          token.setProperties(signer, [{key, value: 'Serotonin increase'}]),129          `on adding property #${i} by signer #${j}`,130        ).to.be.fulfilled;131132        await expect(133          token.setProperties(signer, [{key, value: 'Serotonin stable'}]),134          `on changing property #${i} by signer #${j}`,135        ).to.be.fulfilled;136      }137    }138139    const properties = await token.getProperties(propertyKeys);140    const tokenData = await token.getData();141    for (let i = 0; i < properties.length; i++) {142      expect(properties[i].value).to.be.equal('Serotonin stable');143      expect(tokenData!.properties[i].value).to.be.equal('Serotonin stable');144    }145  }146147  itSub('Changes properties of a token according to permissions (NFT)', async ({helper}) =>  {148    const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'NFT');149    await testChangesPropertiesAccordingPermission(token, amount);150  });151152  itSub.ifWithPallets('Changes properties of a token according to permissions (ReFungible)', [Pallets.ReFungible], async ({helper}) => {153    const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'RFT');154    await testChangesPropertiesAccordingPermission(token, amount);155  });156157  async function testDeletePropertiesAccordingPermission(token: UniqueNFToken | UniqueRFToken, pieces: bigint) {158    await token.collection.addAdmin(alice, {Substrate: bob.address});159    await token.transfer(alice, {Substrate: charlie.address}, pieces);160161    const propertyKeys: string[] = [];162    let i = 0;163164    for (const permission of permissions) {165      i++;166      if (!permission.permission.mutable) continue;167168      let j = 0;169      for (const signer of permission.signers) {170        j++;171        const key = i + '_' + signer.address;172        propertyKeys.push(key);173174        await expect(175          token.setProperties(signer, [{key, value: 'Serotonin increase'}]),176          `on adding property #${i} by signer #${j}`,177        ).to.be.fulfilled;178179        await expect(180          token.deleteProperties(signer, [key]),181          `on deleting property #${i} by signer #${j}`,182        ).to.be.fulfilled;183      }184    }185186    expect(await token.getProperties(propertyKeys)).to.be.empty;187    expect((await token.getData())!.properties).to.be.empty;188  }189190  itSub('Deletes properties of a token according to permissions (NFT)', async ({helper}) =>  {191    const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'NFT');192    await testDeletePropertiesAccordingPermission(token, amount);193  });194195  itSub.ifWithPallets('Deletes properties of a token according to permissions (ReFungible)', [Pallets.ReFungible], async ({helper}) => {196    const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'RFT');197    await testDeletePropertiesAccordingPermission(token, amount);198  });199200  itSub('Assigns properties to a nested token according to permissions', async ({helper}) =>  {201    const collectionA = await helper.nft.mintCollection(alice, {permissions: {nesting: {tokenOwner: true}}});202    const collectionB = await helper.nft.mintCollection(alice, {203      tokenPropertyPermissions: permissions.flatMap(({permission, signers}, i) =>204        signers.map(signer => ({key: `${i+1}_${signer.address}`, permission}))),205    });206    const targetToken = await collectionA.mintToken(alice);207    const nestedToken = await collectionB.mintToken(alice, targetToken.nestingAccount());208209    await collectionB.addAdmin(alice, {Substrate: bob.address});210    await targetToken.transfer(alice, {Substrate: charlie.address});211212    const propertyKeys: string[] = [];213    let i = 0;214    for (const permission of permissions) {215      i++;216      let j = 0;217      for (const signer of permission.signers) {218        j++;219        const key = i + '_' + signer.address;220        propertyKeys.push(key);221222        await expect(223          nestedToken.setProperties(signer, [{key, value: 'Serotonin increase'}]),224          `on adding property #${i} by signer #${j}`,225        ).to.be.fulfilled;226      }227    }228229    const properties = await nestedToken.getProperties(propertyKeys);230    const tokenData = await nestedToken.getData();231    for (let i = 0; i < properties.length; i++) {232      expect(properties[i].value).to.be.equal('Serotonin increase');233      expect(tokenData!.properties[i].value).to.be.equal('Serotonin increase');234    }235    expect(await targetToken.getProperties()).to.be.empty;236  });237238  itSub('Changes properties of a nested token according to permissions', async ({helper}) =>  {239    const collectionA = await helper.nft.mintCollection(alice, {permissions: {nesting: {tokenOwner: true}}});240    const collectionB = await helper.nft.mintCollection(alice, {241      tokenPropertyPermissions: permissions.flatMap(({permission, signers}, i) =>242        signers.map(signer => ({key: `${i+1}_${signer.address}`, permission}))),243    });244    const targetToken = await collectionA.mintToken(alice);245    const nestedToken = await collectionB.mintToken(alice, targetToken.nestingAccount());246247    await collectionB.addAdmin(alice, {Substrate: bob.address});248    await targetToken.transfer(alice, {Substrate: charlie.address});249250    const propertyKeys: string[] = [];251    let i = 0;252    for (const permission of permissions) {253      i++;254      if (!permission.permission.mutable) continue;255256      let j = 0;257      for (const signer of permission.signers) {258        j++;259        const key = i + '_' + signer.address;260        propertyKeys.push(key);261262        await expect(263          nestedToken.setProperties(signer, [{key, value: 'Serotonin increase'}]),264          `on adding property #${i} by signer #${j}`,265        ).to.be.fulfilled;266267        await expect(268          nestedToken.setProperties(signer, [{key, value: 'Serotonin stable'}]),269          `on changing property #${i} by signer #${j}`,270        ).to.be.fulfilled;271      }272    }273274    const properties = await nestedToken.getProperties(propertyKeys);275    const tokenData = await nestedToken.getData();276    for (let i = 0; i < properties.length; i++) {277      expect(properties[i].value).to.be.equal('Serotonin stable');278      expect(tokenData!.properties[i].value).to.be.equal('Serotonin stable');279    }280    expect(await targetToken.getProperties()).to.be.empty;281  });282283  itSub('Deletes properties of a nested token according to permissions', async ({helper}) =>  {284    const collectionA = await helper.nft.mintCollection(alice, {permissions: {nesting: {tokenOwner: true}}});285    const collectionB = await helper.nft.mintCollection(alice, {286      tokenPropertyPermissions: permissions.flatMap(({permission, signers}, i) =>287        signers.map(signer => ({key: `${i+1}_${signer.address}`, permission}))),288    });289    const targetToken = await collectionA.mintToken(alice);290    const nestedToken = await collectionB.mintToken(alice, targetToken.nestingAccount());291292    await collectionB.addAdmin(alice, {Substrate: bob.address});293    await targetToken.transfer(alice, {Substrate: charlie.address});294295    const propertyKeys: string[] = [];296    let i = 0;297    for (const permission of permissions) {298      i++;299      if (!permission.permission.mutable) continue;300301      let j = 0;302      for (const signer of permission.signers) {303        j++;304        const key = i + '_' + signer.address;305        propertyKeys.push(key);306307        await expect(308          nestedToken.setProperties(signer, [{key, value: 'Serotonin increase'}]),309          `on adding property #${i} by signer #${j}`,310        ).to.be.fulfilled;311312        await expect(313          nestedToken.deleteProperties(signer, [key]),314          `on deleting property #${i} by signer #${j}`,315        ).to.be.fulfilled;316      }317    }318319    expect(await nestedToken.getProperties(propertyKeys)).to.be.empty;320    expect((await nestedToken.getData())!.properties).to.be.empty;321    expect(await targetToken.getProperties()).to.be.empty;322  });323324  [325    {mode: 'nft' as const, storage: 'nonfungible' as const, pieces: undefined, requiredPallets: []} as const,326    {mode: 'rft' as const, storage: 'refungible' as const, pieces: 100n, requiredPallets: [Pallets.ReFungible]} as const,327  ].map(testCase =>328    itSub.ifWithPallets(`Allows modifying a token property multiple times with the same size (${testCase.mode})`, testCase.requiredPallets, async({helper}) => {329      const propKey = 'tok-prop';330331      const collection = await helper[testCase.mode].mintCollection(alice, {332        tokenPropertyPermissions: [333          {334            key: propKey,335            permission: {mutable: true, tokenOwner: true},336          },337        ],338      });339340      const maxTokenPropertiesSize = 32768;341342      const propDataSize = 4096;343344      let propDataChar = 'a';345      const makeNewPropData = () => {346        propDataChar = String.fromCharCode(propDataChar.charCodeAt(0) + 1);347        return `${propDataChar}`.repeat(propDataSize);348      };349350      const token = await (351        testCase.pieces352          ? collection.mintToken(alice, testCase.pieces as any)353          : collection.mintToken(alice)354      );355356      const property = {key: propKey, value: makeNewPropData()};357      await token.setProperties(alice, [property]);358      const originalSpace = await token.getTokenPropertiesConsumedSpace();359      expect(originalSpace).to.be.equal(sizeOfProperty(property));360361      const sameSizePropertiesPossibleNum = maxTokenPropertiesSize / propDataSize;362363      // It is possible to modify a property as many times as needed.364      // It will not consume any additional space.365      for (let i = 0; i < sameSizePropertiesPossibleNum + 1; i++) {366        await token.setProperties(alice, [{key: propKey, value: makeNewPropData()}]);367        const consumedSpace = await token.getTokenPropertiesConsumedSpace();368        expect(consumedSpace).to.be.equal(originalSpace);369      }370    }));371372  [373    {mode: 'nft' as const, pieces: undefined, requiredPallets: []},374    {mode: 'rft' as const, pieces: 100n, requiredPallets: [Pallets.ReFungible]},375  ].map(testCase =>376    itSub.ifWithPallets(`Adding then removing a token property doesn't change the consumed space (${testCase.mode})`, testCase.requiredPallets, async({helper}) => {377      const propKey = 'tok-prop';378379      const collection = await helper[testCase.mode].mintCollection(alice, {380        tokenPropertyPermissions: [381          {382            key: propKey,383            permission: {mutable: true, tokenOwner: true},384          },385        ],386      });387      const token = await (388        testCase.pieces389          ? collection.mintToken(alice, testCase.pieces as any)390          : collection.mintToken(alice)391      );392      const originalSpace = await token.getTokenPropertiesConsumedSpace();393394      const propDataSize = 4096;395      const propData = 'a'.repeat(propDataSize);396397      const property = {key: propKey, value: propData};398      await token.setProperties(alice, [property]);399      let consumedSpace = await token.getTokenPropertiesConsumedSpace();400      expect(consumedSpace).to.be.equal(sizeOfProperty(property));401402      await token.deleteProperties(alice, [propKey]);403      consumedSpace = await token.getTokenPropertiesConsumedSpace();404      expect(consumedSpace).to.be.equal(originalSpace);405    }));406407  [408    {mode: 'nft' as const, pieces: undefined, requiredPallets: []},409    {mode: 'rft' as const, pieces: 100n, requiredPallets: [Pallets.ReFungible]},410  ].map(testCase =>411    itSub.ifWithPallets(`Modifying a token property with different sizes correctly changes the consumed space (${testCase.mode})`, testCase.requiredPallets, async({helper}) => {412      const propKey = 'tok-prop';413414      const collection = await helper[testCase.mode].mintCollection(alice, {415        tokenPropertyPermissions: [416          {417            key: propKey,418            permission: {mutable: true, tokenOwner: true},419          },420        ],421      });422      const token = await (423        testCase.pieces424          ? collection.mintToken(alice, testCase.pieces as any)425          : collection.mintToken(alice)426      );427      const originalSpace = await token.getTokenPropertiesConsumedSpace();428429      const initProp = {key: propKey, value: 'a'.repeat(4096)};430      const biggerProp = {key: propKey, value: 'b'.repeat(5000)};431      const smallerProp = {key: propKey, value: 'c'.repeat(4000)};432433      let consumedSpace;434      let expectedConsumedSpaceDiff;435436      await token.setProperties(alice, [initProp]);437      consumedSpace = await token.getTokenPropertiesConsumedSpace();438      expectedConsumedSpaceDiff = sizeOfProperty(initProp) - originalSpace;439      expect(consumedSpace).to.be.equal(originalSpace + expectedConsumedSpaceDiff);440441      await token.setProperties(alice, [biggerProp]);442      consumedSpace = await token.getTokenPropertiesConsumedSpace();443      expectedConsumedSpaceDiff = sizeOfProperty(biggerProp) - sizeOfProperty(initProp);444      expect(consumedSpace).to.be.equal(sizeOfProperty(initProp) + expectedConsumedSpaceDiff);445446      await token.setProperties(alice, [smallerProp]);447      consumedSpace = await token.getTokenPropertiesConsumedSpace();448      expectedConsumedSpaceDiff = sizeOfProperty(biggerProp) - sizeOfProperty(smallerProp);449      expect(consumedSpace).to.be.equal(sizeOfProperty(biggerProp) - expectedConsumedSpaceDiff);450    }));451});452453describe('Negative Integration Test: Token Properties', () => {454  let alice: IKeyringPair; // collection owner455  let bob: IKeyringPair; // collection admin456  let charlie: IKeyringPair; // token owner457458  let constitution: {permission: any, signers: IKeyringPair[], sinner: IKeyringPair}[];459460  before(async () => {461    await usingPlaygrounds(async (helper, privateKey) => {462      const donor = await privateKey({url: import.meta.url});463      let dave: IKeyringPair;464      [alice, bob, charlie, dave] = await helper.arrange.createAccounts([100n, 100n, 100n, 100n], donor);465466      // todo:playgrounds probably separate these tests later467      constitution = [468        {permission: {mutable: true, collectionAdmin: true}, signers: [alice, bob], sinner: charlie},469        {permission: {mutable: false, collectionAdmin: true}, signers: [alice, bob], sinner: charlie},470        {permission: {mutable: true, tokenOwner: true}, signers: [charlie], sinner: alice},471        {permission: {mutable: false, tokenOwner: true}, signers: [charlie], sinner: alice},472        {permission: {mutable: true, collectionAdmin: true, tokenOwner: true}, signers: [alice, bob, charlie], sinner: dave},473        {permission: {mutable: false, collectionAdmin: true, tokenOwner: true}, signers: [alice, bob, charlie], sinner: dave},474      ];475    });476  });477478  async function mintCollectionWithAllPermissionsAndToken(helper: UniqueHelper, mode: 'NFT' | 'RFT'): Promise<[UniqueNFToken | UniqueRFToken, bigint]> {479    const collection = await (mode == 'NFT' ? helper.nft : helper.rft).mintCollection(alice, {480      tokenPropertyPermissions: constitution.map(({permission}, i) => ({key: `${i+1}`, permission})),481    });482    return mode == 'NFT' ? [await collection.mintToken(alice), 1n] : [await collection.mintToken(alice, 100n as any), 100n];483  }484485  async function getConsumedSpace(api: any, collectionId: number, tokenId: number, mode: 'NFT' | 'RFT'): Promise<number> {486    return (await (mode == 'NFT' ? api.query.nonfungible : api.query.refungible).tokenProperties(collectionId, tokenId)).toJSON().consumedSpace;487  }488489  async function prepare(token: UniqueNFToken | UniqueRFToken, pieces: bigint): Promise<number> {490    await token.collection.addAdmin(alice, {Substrate: bob.address});491    await token.transfer(alice, {Substrate: charlie.address}, pieces);492493    let i = 0;494    for (const passage of constitution) {495      i++;496      const signer = passage.signers[0];497      await expect(498        token.setProperties(signer, [{key: `${i}`, value: 'Serotonin increase'}]),499        `on adding property ${i} by ${signer.address}`,500      ).to.be.fulfilled;501    }502503    const originalSpace = await getConsumedSpace(token.collection.helper.getApi(), token.collectionId, token.tokenId, pieces == 1n ? 'NFT' : 'RFT');504    return originalSpace;505  }506507  async function testForbidsChangingDeletingPropertiesUserOutsideOfPermissions(token: UniqueNFToken | UniqueRFToken, pieces: bigint) {508    const originalSpace = await prepare(token, pieces);509510    let i = 0;511    for (const forbiddance of constitution) {512      i++;513      if (!forbiddance.permission.mutable) continue;514515      await expect(516        token.setProperties(forbiddance.sinner, [{key: `${i}`, value: 'Serotonin down'}]),517        `on failing to change property ${i} by the malefactor`,518      ).to.be.rejectedWith(/common\.NoPermission/);519520      await expect(521        token.deleteProperties(forbiddance.sinner, [`${i}`]),522        `on failing to delete property ${i} by the malefactor`,523      ).to.be.rejectedWith(/common\.NoPermission/);524    }525526    const consumedSpace = await getConsumedSpace(token.collection.helper.getApi(), token.collectionId, token.tokenId, pieces == 1n ? 'NFT' : 'RFT');527    expect(consumedSpace).to.be.equal(originalSpace);528  }529530  itSub('Forbids changing/deleting properties of a token if the user is outside of permissions (NFT)', async ({helper}) =>  {531    const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'NFT');532    await testForbidsChangingDeletingPropertiesUserOutsideOfPermissions(token, amount);533  });534535  itSub.ifWithPallets('Forbids changing/deleting properties of a token if the user is outside of permissions (ReFungible)', [Pallets.ReFungible], async ({helper}) => {536    const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'RFT');537    await testForbidsChangingDeletingPropertiesUserOutsideOfPermissions(token, amount);538  });539540  async function testForbidsChangingDeletingPropertiesIfPropertyImmutable(token: UniqueNFToken | UniqueRFToken, pieces: bigint) {541    const originalSpace = await prepare(token, pieces);542543    let i = 0;544    for (const permission of constitution) {545      i++;546      if (permission.permission.mutable) continue;547548      await expect(549        token.setProperties(permission.signers[0], [{key: `${i}`, value: 'Serotonin down'}]),550        `on failing to change property ${i} by signer #0`,551      ).to.be.rejectedWith(/common\.NoPermission/);552553      await expect(554        token.deleteProperties(permission.signers[0], [i.toString()]),555        `on failing to delete property ${i} by signer #0`,556      ).to.be.rejectedWith(/common\.NoPermission/);557    }558559    const consumedSpace = await getConsumedSpace(token.collection.helper.getApi(), token.collectionId, token.tokenId, pieces == 1n ? 'NFT' : 'RFT');560    expect(consumedSpace).to.be.equal(originalSpace);561  }562563  itSub('Forbids changing/deleting properties of a token if the property is permanent (immutable) (NFT)', async ({helper}) =>  {564    const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'NFT');565    await testForbidsChangingDeletingPropertiesIfPropertyImmutable(token, amount);566  });567568  itSub.ifWithPallets('Forbids changing/deleting properties of a token if the property is permanent (immutable) (ReFungible)', [Pallets.ReFungible], async ({helper}) => {569    const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'RFT');570    await testForbidsChangingDeletingPropertiesIfPropertyImmutable(token, amount);571  });572573  async function testForbidsAddingPropertiesIfPropertyNotDeclared(token: UniqueNFToken | UniqueRFToken, pieces: bigint) {574    const originalSpace = await prepare(token, pieces);575576    await expect(577      token.setProperties(alice, [{key: 'non-existent', value: 'I exist!'}]),578      'on failing to add a previously non-existent property',579    ).to.be.rejectedWith(/common\.NoPermission/);580581    await expect(582      token.collection.setTokenPropertyPermissions(alice, [{key: 'now-existent', permission: {}}]),583      'on setting a new non-permitted property',584    ).to.be.fulfilled;585586    await expect(587      token.setProperties(alice, [{key: 'now-existent', value: 'I exist!'}]),588      'on failing to add a property forbidden by the \'None\' permission',589    ).to.be.rejectedWith(/common\.NoPermission/);590591    expect(await token.getProperties(['non-existent', 'now-existent'])).to.be.empty;592593    const consumedSpace = await getConsumedSpace(token.collection.helper.getApi(), token.collectionId, token.tokenId, pieces == 1n ? 'NFT' : 'RFT');594    expect(consumedSpace).to.be.equal(originalSpace);595  }596597  itSub('Forbids adding properties to a token if the property is not declared / forbidden with the \'None\' permission (NFT)', async ({helper}) =>  {598    const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'NFT');599    await testForbidsAddingPropertiesIfPropertyNotDeclared(token, amount);600  });601602  itSub.ifWithPallets('Forbids adding properties to a token if the property is not declared / forbidden with the \'None\' permission (ReFungible)', [Pallets.ReFungible], async ({helper}) => {603    const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'RFT');604    await testForbidsAddingPropertiesIfPropertyNotDeclared(token, amount);605  });606607  async function testForbidsAddingTooLargeProperties(token: UniqueNFToken | UniqueRFToken, pieces: bigint) {608    const originalSpace = await prepare(token, pieces);609610    await expect(611      token.collection.setTokenPropertyPermissions(alice, [612        {key: 'a_holy_book', permission: {collectionAdmin: true, tokenOwner: true}},613        {key: 'young_years', permission: {collectionAdmin: true, tokenOwner: true}},614      ]),615      'on setting new permissions for properties',616    ).to.be.fulfilled;617618    // Mute the general tx parsing error619    {620      console.error = () => {};621      await expect(token.setProperties(alice, [{key: 'a_holy_book', value: 'word '.repeat(6554)}]))622        .to.be.rejected;623    }624625    await expect(token.setProperties(alice, [626      {key: 'a_holy_book', value: 'word '.repeat(3277)},627      {key: 'young_years', value: 'neverending'.repeat(1490)},628    ])).to.be.rejectedWith(/common\.NoSpaceForProperty/);629630    expect(await token.getProperties(['a_holy_book', 'young_years'])).to.be.empty;631    const consumedSpace = await getConsumedSpace(token.collection.helper.getApi(), token.collectionId, token.tokenId, pieces == 1n ? 'NFT' : 'RFT');632    expect(consumedSpace).to.be.equal(originalSpace);633  }634635  itSub('Forbids adding too large properties to a token (NFT)', async ({helper}) =>  {636    const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'NFT');637    await testForbidsAddingTooLargeProperties(token, amount);638  });639640  itSub.ifWithPallets('Forbids adding too large properties to a token (ReFungible)', [Pallets.ReFungible], async ({helper}) => {641    const [token, amount] = await mintCollectionWithAllPermissionsAndToken(helper, 'RFT');642    await testForbidsAddingTooLargeProperties(token, amount);643  });644645  [646    {mode: 'nft' as const, requiredPallets: []},647    {mode: 'rft' as const, requiredPallets: [Pallets.ReFungible]},648  ].map(testCase =>649    itSub.ifWithPallets(`Forbids adding too many propeties to a token (${testCase.mode})`, testCase.requiredPallets, async({helper}) => {650      const collection = await helper[testCase.mode].mintCollection(alice);651      const maxPropertiesPerItem = 64;652653      for (let i = 0; i < maxPropertiesPerItem; i++) {654        await collection.setTokenPropertyPermissions(alice, [{655          key: `${i+1}`,656          permission: {mutable: true, tokenOwner: true, collectionAdmin: true},657        }]);658      }659660      await expect(collection.setTokenPropertyPermissions(alice, [{661        key: `${maxPropertiesPerItem}-th`,662        permission: {mutable: true, tokenOwner: true, collectionAdmin: true},663      }])).to.be.rejectedWith(/common\.PropertyLimitReached/);664    }));665666  [667    {mode: 'nft' as const, pieces: undefined, requiredPallets: []},668    {mode: 'rft' as const, pieces: 100n, requiredPallets: [Pallets.ReFungible]},669  ].map(testCase =>670    itSub.ifWithPallets(`Forbids force_repair_item from non-sudo (${testCase.mode})`, testCase.requiredPallets, async({helper}) => {671      const propKey = 'tok-prop';672673      const collection = await helper[testCase.mode].mintCollection(alice, {674        tokenPropertyPermissions: [675          {676            key: propKey,677            permission: {mutable: true, tokenOwner: true},678          },679        ],680      });681      const token = await (682        testCase.pieces683          ? collection.mintToken(alice, testCase.pieces as any)684          : collection.mintToken(alice)685      );686687      const propDataSize = 4096;688      const propData = 'a'.repeat(propDataSize);689      await token.setProperties(alice, [{key: propKey, value: propData}]);690691      await expect(helper.executeExtrinsic(alice, 'api.tx.unique.forceRepairItem', [token.collectionId, token.tokenId], true))692        .to.be.rejectedWith(/BadOrigin/);693    }));694});695696describe('ReFungible token properties permissions tests', () => {697  let alice: IKeyringPair;698  let bob: IKeyringPair;699  let charlie: IKeyringPair;700701  before(async function() {702    await usingPlaygrounds(async (helper, privateKey) => {703      requirePalletsOrSkip(this, helper, [Pallets.ReFungible]);704705      const donor = await privateKey({url: import.meta.url});706      [alice, bob, charlie] = await helper.arrange.createAccounts([100n, 100n, 100n], donor);707    });708  });709710  async function prepare(helper: UniqueHelper): Promise<UniqueRFToken> {711    const collection = await helper.rft.mintCollection(alice);712    const token = await collection.mintToken(alice, 100n);713714    await collection.addAdmin(alice, {Substrate: bob.address});715    await collection.setTokenPropertyPermissions(alice, [{key: 'fractals', permission: {mutable: true, tokenOwner: true}}]);716717    return token;718  }719720  itSub('Forbids adding token property with tokenOwner==true when signer doesn\'t have all pieces', async ({helper}) =>  {721    const token = await prepare(helper);722723    await token.transfer(alice, {Substrate: charlie.address}, 33n);724725    await expect(token.setProperties(alice, [726      {key: 'fractals', value: 'multiverse'},727    ])).to.be.rejectedWith(/common\.NoPermission/);728  });729730  itSub('Forbids mutating token property with tokenOwner==true when signer doesn\'t have all pieces', async ({helper}) =>  {731    const token = await prepare(helper);732733    await expect(token.collection.setTokenPropertyPermissions(alice, [{key: 'fractals', permission: {mutable:true, tokenOwner: true}}]))734      .to.be.fulfilled;735736    await expect(token.setProperties(alice, [737      {key: 'fractals', value: 'multiverse'},738    ])).to.be.fulfilled;739740    await token.transfer(alice, {Substrate: charlie.address}, 33n);741742    await expect(token.setProperties(alice, [743      {key: 'fractals', value: 'want to rule the world'},744    ])).to.be.rejectedWith(/common\.NoPermission/);745  });746747  itSub('Forbids deleting token property with tokenOwner==true when signer doesn\'t have all pieces', async ({helper}) =>  {748    const token = await prepare(helper);749750    await expect(token.setProperties(alice, [751      {key: 'fractals', value: 'one headline - why believe it'},752    ])).to.be.fulfilled;753754    await token.transfer(alice, {Substrate: charlie.address}, 33n);755756    await expect(token.deleteProperties(alice, ['fractals'])).757      to.be.rejectedWith(/common\.NoPermission/);758  });759760  itSub('Allows token property mutation with collectionOwner==true when admin doesn\'t have all pieces', async ({helper}) =>  {761    const token = await prepare(helper);762763    await token.transfer(alice, {Substrate: charlie.address}, 33n);764765    await expect(token.collection.setTokenPropertyPermissions(alice, [{key: 'fractals', permission: {mutable:true, collectionAdmin: true}}]))766      .to.be.fulfilled;767768    await expect(token.setProperties(alice, [769      {key: 'fractals', value: 'multiverse'},770    ])).to.be.fulfilled;771  });772});