git.delta.rocks / unique-network / refs/commits / 77e366b9e580

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/playgrounds';19import {ICollectionBase, ICollectionNFT, ITokenNonfungible, ICollectionRFT, ITokenRefungible} from '../util/playgrounds/types';20import {UniqueHelper} from '../util/playgrounds/unique';2122// ---------- COLLECTION PROPERTIES2324describe('Integration Test: Collection Properties', () => {25  let alice: IKeyringPair;26  let bob: IKeyringPair;2728  before(async () => {29    await usingPlaygrounds(async (helper, privateKey) => {30      const donor = privateKey('//Alice');31      [alice, bob] = await helper.arrange.createAccounts([50n, 10n], donor);32    });33  });3435  itSub('Properties are initially empty', async ({helper}) => {36    const collection = await helper.nft.mintCollection(alice);37    expect(await collection.getProperties()).to.be.empty;38  });3940  async function testSetsPropertiesForCollection(collection: ICollectionBase) {41    // As owner42    await expect(collection.setProperties(alice, [{key: 'electron', value: 'come bond'}])).to.be.fulfilled;4344    await collection.addAdmin(alice, {Substrate: bob.address});4546    // As administrator47    await expect(collection.setProperties(bob, [{key: 'black_hole'}])).to.be.fulfilled;4849    const properties = await collection.getProperties();50    expect(properties).to.include.deep.members([51      {key: 'electron', value: 'come bond'},52      {key: 'black_hole', value: ''},53    ]);54  }5556  itSub('Sets properties for a NFT collection', async ({helper}) =>  {57    await testSetsPropertiesForCollection(await helper.nft.mintCollection(alice));58  });5960  itSub.ifWithPallets('Sets properties for a ReFungible collection', [Pallets.ReFungible], async ({helper}) => {61    await testSetsPropertiesForCollection(await helper.rft.mintCollection(alice));62  });6364  async function testCheckValidNames(collection: ICollectionBase) {65    // alpha symbols66    await expect(collection.setProperties(alice, [{key: 'answer'}])).to.be.fulfilled;6768    // numeric symbols69    await expect(collection.setProperties(alice, [{key: '451'}])).to.be.fulfilled;7071    // underscore symbol72    await expect(collection.setProperties(alice, [{key: 'black_hole'}])).to.be.fulfilled;7374    // dash symbol75    await expect(collection.setProperties(alice, [{key: '-'}])).to.be.fulfilled;7677    // dot symbol78    await expect(collection.setProperties(alice, [{key: 'once.in.a.long.long.while...', value: 'you get a little lost'}])).to.be.fulfilled;7980    const properties = await collection.getProperties();81    expect(properties).to.include.deep.members([82      {key: 'answer', value: ''},83      {key: '451', value: ''},84      {key: 'black_hole', value: ''},85      {key: '-', value: ''},86      {key: 'once.in.a.long.long.while...', value: 'you get a little lost'},87    ]);88  }8990  itSub('Check valid names for NFT collection properties keys', async ({helper}) =>  {91    await testCheckValidNames(await helper.nft.mintCollection(alice));92  });9394  itSub.ifWithPallets('Check valid names for ReFungible collection properties keys', [Pallets.ReFungible], async ({helper}) => {95    await testCheckValidNames(await helper.rft.mintCollection(alice));96  });9798  async function testChangesProperties(collection: ICollectionBase) {99    await expect(collection.setProperties(alice, [{key: 'electron', value: 'come bond'}, {key: 'black_hole', value: ''}])).to.be.fulfilled;100101    // Mutate the properties102    await expect(collection.setProperties(alice, [{key: 'black_hole', value: 'LIGO'}])).to.be.fulfilled;103104    const properties = await collection.getProperties();105    expect(properties).to.include.deep.members([106      {key: 'electron', value: 'come bond'},107      {key: 'black_hole', value: 'LIGO'},108    ]);109  }110111  itSub('Changes properties of a NFT collection', async ({helper}) =>  {112    await testChangesProperties(await helper.nft.mintCollection(alice));113  });114115  itSub.ifWithPallets('Changes properties of a ReFungible collection', [Pallets.ReFungible], async ({helper}) => {116    await testChangesProperties(await helper.rft.mintCollection(alice));117  });118119  async function testDeleteProperties(collection: ICollectionBase) {120    await expect(collection.setProperties(alice, [{key: 'electron', value: 'come bond'}, {key: 'black_hole', value: 'LIGO'}])).to.be.fulfilled;121122    await expect(collection.deleteProperties(alice, ['electron'])).to.be.fulfilled;123124    const properties = await collection.getProperties(['black_hole', 'electron']);125    expect(properties).to.be.deep.equal([126      {key: 'black_hole', value: 'LIGO'},127    ]);128  }129130  itSub('Deletes properties of a NFT collection', async ({helper}) =>  {131    await testDeleteProperties(await helper.nft.mintCollection(alice));132  });133134  itSub.ifWithPallets('Deletes properties of a ReFungible collection', [Pallets.ReFungible], async ({helper}) => {135    await testDeleteProperties(await helper.rft.mintCollection(alice));136  });137});138139describe('Negative Integration Test: Collection Properties', () => {140  let alice: IKeyringPair;141  let bob: IKeyringPair;142143  before(async () => {144    await usingPlaygrounds(async (helper, privateKey) => {145      const donor = privateKey('//Alice');146      [alice, bob] = await helper.arrange.createAccounts([100n, 10n], donor);147    });148  });149  150  async function testFailsSetPropertiesIfNotOwnerOrAdmin(collection: ICollectionBase) {  151    await expect(collection.setProperties(bob, [{key: 'electron', value: 'come bond'}, {key: 'black_hole', value: 'LIGO'}]))152      .to.be.rejectedWith(/common\.NoPermission/);153154    expect(await collection.getProperties()).to.be.empty;155  }156157  itSub('Fails to set properties in a NFT collection if not its onwer/administrator', async ({helper}) =>  {158    await testFailsSetPropertiesIfNotOwnerOrAdmin(await helper.nft.mintCollection(alice));159  });160161  itSub.ifWithPallets('Fails to set properties in a ReFungible collection if not its onwer/administrator', [Pallets.ReFungible], async ({helper}) => {162    await testFailsSetPropertiesIfNotOwnerOrAdmin(await helper.rft.mintCollection(alice));163  });164  165  async function testFailsSetPropertiesThatExeedLimits(collection: ICollectionBase) {166    const spaceLimit = (await (collection.helper!.api! as any).query.common.collectionProperties(collection.collectionId)).spaceLimit.toNumber();167  168    // Mute the general tx parsing error, too many bytes to process169    {170      console.error = () => {};171      await expect(collection.setProperties(alice, [172        {key: 'electron', value: 'low high '.repeat(Math.ceil(spaceLimit! / 9))},173      ])).to.be.rejected;174    }175176    expect(await collection.getProperties(['electron'])).to.be.empty;177178    await expect(collection.setProperties(alice, [179      {key: 'electron', value: 'low high '.repeat(Math.ceil(spaceLimit! / 18))}, 180      {key: 'black_hole', value: '0'.repeat(Math.ceil(spaceLimit! / 2))}, 181    ])).to.be.rejectedWith(/common\.NoSpaceForProperty/);182183    expect(await collection.getProperties(['electron', 'black_hole'])).to.be.empty;184  }185186  itSub('Fails to set properties that exceed the limits (NFT)', async ({helper}) =>  {187    await testFailsSetPropertiesThatExeedLimits(await helper.nft.mintCollection(alice));188  });189190  itSub.ifWithPallets('Fails to set properties that exceed the limits (ReFungible)', [Pallets.ReFungible], async ({helper}) => {191    await testFailsSetPropertiesThatExeedLimits(await helper.rft.mintCollection(alice));192  });193  194  async function testFailsSetMorePropertiesThanAllowed(collection: ICollectionBase) {195    const propertiesToBeSet = [];196    for (let i = 0; i < 65; i++) {197      propertiesToBeSet.push({198        key: 'electron_' + i,199        value: Math.random() > 0.5 ? 'high' : 'low',200      });201    }202203    await expect(collection.setProperties(alice, propertiesToBeSet)).204      to.be.rejectedWith(/common\.PropertyLimitReached/);205206    expect(await collection.getProperties()).to.be.empty;207  }208209  itSub('Fails to set more properties than it is allowed (NFT)', async ({helper}) =>  {210    await testFailsSetMorePropertiesThanAllowed(await helper.nft.mintCollection(alice));211  });212213  itSub.ifWithPallets('Fails to set more properties than it is allowed (ReFungible)', [Pallets.ReFungible], async ({helper}) => {214    await testFailsSetMorePropertiesThanAllowed(await helper.rft.mintCollection(alice));215  });216  217  async function testFailsSetPropertiesWithInvalidNames(collection: ICollectionBase) {218    const invalidProperties = [219      [{key: 'electron', value: 'negative'}, {key: 'string theory', value: 'understandable'}],220      [{key: 'Mr/Sandman', value: 'Bring me a gene'}],221      [{key: 'déjà vu', value: 'hmm...'}],222    ];223224    for (let i = 0; i < invalidProperties.length; i++) {225      await expect(226        collection.setProperties(alice, invalidProperties[i]), 227        `on rejecting the new badly-named property #${i}`,228      ).to.be.rejectedWith(/common\.InvalidCharacterInPropertyKey/);229    }230231    await expect(232      collection.setProperties(alice, [{key: '', value: 'nothing must not exist'}]), 233      'on rejecting an unnamed property',234    ).to.be.rejectedWith(/common\.EmptyPropertyKey/);235236    await expect(237      collection.setProperties(alice, [{key: 'CRISPR-Cas9', value: 'rewriting nature!'}]), 238      'on setting the correctly-but-still-badly-named property',239    ).to.be.fulfilled;240241    const keys = invalidProperties.flatMap(propertySet => propertySet.map(property => property.key)).concat('CRISPR-Cas9').concat('');242243    const properties = await collection.getProperties(keys);244    expect(properties).to.be.deep.equal([245      {key: 'CRISPR-Cas9', value: 'rewriting nature!'},246    ]);247248    for (let i = 0; i < invalidProperties.length; i++) {249      await expect(250        collection.deleteProperties(alice, invalidProperties[i].map(propertySet => propertySet.key)), 251        `on trying to delete the non-existent badly-named property #${i}`,252      ).to.be.rejectedWith(/common\.InvalidCharacterInPropertyKey/);253    }254  }255256  itSub('Fails to set properties with invalid names (NFT)', async ({helper}) =>  {257    await testFailsSetPropertiesWithInvalidNames(await helper.nft.mintCollection(alice));258  });259260  itSub.ifWithPallets('Fails to set properties with invalid names (ReFungible)', [Pallets.ReFungible], async ({helper}) => {261    await testFailsSetPropertiesWithInvalidNames(await helper.rft.mintCollection(alice));262  });263});264265// ---------- ACCESS RIGHTS266267describe('Integration Test: Access Rights to Token Properties', () => {268  let alice: IKeyringPair;269  let bob: IKeyringPair;270271  before(async () => {272    await usingPlaygrounds(async (helper, privateKey) => {273      const donor = privateKey('//Alice');274      [alice, bob] = await helper.arrange.createAccounts([100n, 10n], donor);275    });276  });277  278  itSub('Reads access rights to properties of a collection', async ({helper}) =>  {279    const collection = await helper.nft.mintCollection(alice);280    const propertyRights = (await helper.api!.query.common.collectionPropertyPermissions(collection.collectionId)).toJSON();281    expect(propertyRights).to.be.empty;282  });283  284  async function testSetsAccessRightsToProperties(collection: ICollectionNFT | ICollectionRFT) {  285    await expect(collection.setTokenPropertyPermissions(alice, [{key: 'skullduggery', permission: {mutable: true}}]))286      .to.be.fulfilled;287288    await collection.addAdmin(alice, {Substrate: bob.address});289290    await expect(collection.setTokenPropertyPermissions(bob, [{key: 'mindgame', permission: {collectionAdmin: true, tokenOwner: false}}]))291      .to.be.fulfilled;292293    const propertyRights = await collection.getPropertyPermissions(['skullduggery', 'mindgame']);294    expect(propertyRights).to.include.deep.members([295      {key: 'skullduggery', permission: {mutable: true, collectionAdmin: false, tokenOwner: false}},296      {key: 'mindgame', permission: {mutable: false, collectionAdmin: true, tokenOwner: false}},297    ]);298  }299300  itSub('Sets access rights to properties of a collection (NFT)', async ({helper}) =>  {301    await testSetsAccessRightsToProperties(await helper.nft.mintCollection(alice));302  });303304  itSub.ifWithPallets('Sets access rights to properties of a collection (ReFungible)', [Pallets.ReFungible], async ({helper}) => {305    await testSetsAccessRightsToProperties(await helper.rft.mintCollection(alice));306  });307  308  async function testChangesAccessRightsToProperty(collection: ICollectionNFT | ICollectionRFT) {309    await expect(collection.setTokenPropertyPermissions(alice, [{key: 'skullduggery', permission: {mutable: true, collectionAdmin: true}}]))310      .to.be.fulfilled;311312    await expect(collection.setTokenPropertyPermissions(alice, [{key: 'skullduggery', permission: {mutable: false, tokenOwner: true}}]))313      .to.be.fulfilled;314315    const propertyRights = await collection.getPropertyPermissions();316    expect(propertyRights).to.be.deep.equal([317      {key: 'skullduggery', permission: {'mutable': false, 'collectionAdmin': false, 'tokenOwner': true}},318    ]);319  }320321  itSub('Changes access rights to properties of a NFT collection', async ({helper}) =>  {322    await testChangesAccessRightsToProperty(await helper.nft.mintCollection(alice));323  });324325  itSub.ifWithPallets('Changes access rights to properties of a ReFungible collection', [Pallets.ReFungible], async ({helper}) => {326    await testChangesAccessRightsToProperty(await helper.rft.mintCollection(alice));327  });328});329330describe('Negative Integration Test: Access Rights to Token Properties', () => {331  let alice: IKeyringPair;332  let bob: IKeyringPair;333334  before(async () => {335    await usingPlaygrounds(async (helper, privateKey) => {336      const donor = privateKey('//Alice');337      [alice, bob] = await helper.arrange.createAccounts([50n, 10n], donor);338    });339  });340341  async function testPreventsFromSettingAccessRightsNotAdminOrOwner(collection: ICollectionNFT | ICollectionRFT) {342    await expect(collection.setTokenPropertyPermissions(bob, [{key: 'skullduggery', permission: {mutable: true, tokenOwner: true}}]))343      .to.be.rejectedWith(/common\.NoPermission/);344345    const propertyRights = await collection.getPropertyPermissions(['skullduggery']);346    expect(propertyRights).to.be.empty;347  }348349  itSub('Prevents from setting access rights to properties of a NFT collection if not an onwer/admin', async ({helper}) =>  {350    await testPreventsFromSettingAccessRightsNotAdminOrOwner(await helper.nft.mintCollection(alice));351  });352353  itSub.ifWithPallets('Prevents from setting access rights to properties of a ReFungible collection if not an onwer/admin', [Pallets.ReFungible], async ({helper}) => {354    await testPreventsFromSettingAccessRightsNotAdminOrOwner(await helper.rft.mintCollection(alice));355  });356357  async function testPreventFromAddingTooManyPossibleProperties(collection: ICollectionNFT | ICollectionRFT) {  358    const constitution = [];359    for (let i = 0; i < 65; i++) {360      constitution.push({361        key: 'property_' + i,362        permission: Math.random() > 0.5 ? {mutable: true, collectionAdmin: true, tokenOwner: true} : {},363      });364    }365366    await expect(collection.setTokenPropertyPermissions(alice, constitution))367      .to.be.rejectedWith(/common\.PropertyLimitReached/);368369    const propertyRights = await collection.getPropertyPermissions();370    expect(propertyRights).to.be.empty;371  }372373  itSub('Prevents from adding too many possible properties (NFT)', async ({helper}) =>  {374    await testPreventFromAddingTooManyPossibleProperties(await helper.nft.mintCollection(alice));375  });376377  itSub.ifWithPallets('Prevents from adding too many possible properties (ReFungible)', [Pallets.ReFungible], async ({helper}) => {378    await testPreventFromAddingTooManyPossibleProperties(await helper.rft.mintCollection(alice));379  });380381  async function testPreventAccessRightsModifiedIfConstant(collection: ICollectionNFT | ICollectionRFT) {382    await expect(collection.setTokenPropertyPermissions(alice, [{key: 'skullduggery', permission: {mutable: false, tokenOwner: true}}]))383      .to.be.fulfilled;384385    await expect(collection.setTokenPropertyPermissions(alice, [{key: 'skullduggery', permission: {collectionAdmin: true}}]))386      .to.be.rejectedWith(/common\.NoPermission/);387388    const propertyRights = await collection.getPropertyPermissions(['skullduggery']);389    expect(propertyRights).to.deep.equal([390      {key: 'skullduggery', permission: {'mutable': false, 'collectionAdmin': false, 'tokenOwner': true}},391    ]);392  }393394  itSub('Prevents access rights to be modified if constant (NFT)', async ({helper}) =>  {395    await testPreventAccessRightsModifiedIfConstant(await helper.nft.mintCollection(alice));396  });397398  itSub.ifWithPallets('Prevents access rights to be modified if constant (ReFungible)', [Pallets.ReFungible], async ({helper}) => {399    await testPreventAccessRightsModifiedIfConstant(await helper.rft.mintCollection(alice));400  });401402  async function testPreventsAddingPropertiesWithInvalidNames(collection: ICollectionNFT | ICollectionRFT) {403    const invalidProperties = [404      [{key: 'skullduggery', permission: {tokenOwner: true}}, {key: 'im possible', permission: {collectionAdmin: true}}],405      [{key: 'G#4', permission: {tokenOwner: true}}],406      [{key: 'HÆMILTON', permission: {mutable: false, collectionAdmin: true, tokenOwner: true}}],407    ];408409    for (let i = 0; i < invalidProperties.length; i++) {410      await expect(411        collection.setTokenPropertyPermissions(alice, invalidProperties[i]), 412        `on setting the new badly-named property #${i}`,413      ).to.be.rejectedWith(/common\.InvalidCharacterInPropertyKey/);414    }415416    await expect(417      collection.setTokenPropertyPermissions(alice, [{key: '', permission: {}}]), 418      'on rejecting an unnamed property',419    ).to.be.rejectedWith(/common\.EmptyPropertyKey/);420421    const correctKey = '--0x03116e387820CA05'; // PolkadotJS would parse this as an already encoded hex-string422    await expect(423      collection.setTokenPropertyPermissions(alice, [424        {key: correctKey, permission: {collectionAdmin: true}},425      ]), 426      'on setting the correctly-but-still-badly-named property',427    ).to.be.fulfilled;428429    const keys = invalidProperties.flatMap(propertySet => propertySet.map(property => property.key)).concat(correctKey).concat('');430431    const propertyRights = await collection.getPropertyPermissions(keys);432    expect(propertyRights).to.be.deep.equal([433      {key: correctKey, permission: {mutable: false, collectionAdmin: true, tokenOwner: false}},434    ]);435  }436437  itSub('Prevents adding properties with invalid names (NFT)', async ({helper}) =>  {438    await testPreventsAddingPropertiesWithInvalidNames(await helper.nft.mintCollection(alice));439  });440441  itSub.ifWithPallets('Prevents adding properties with invalid names (ReFungible)', [Pallets.ReFungible], async ({helper}) => {442    await testPreventsAddingPropertiesWithInvalidNames(await helper.rft.mintCollection(alice));443  });444});445446// ---------- TOKEN PROPERTIES447448describe('Integration Test: Token Properties', () => {449  let alice: IKeyringPair; // collection owner450  let bob: IKeyringPair; // collection admin451  let charlie: IKeyringPair; // token owner452453  let permissions: {permission: any, signers: IKeyringPair[]}[];454455  before(async () => {456    await usingPlaygrounds(async (helper, privateKey) => {457      const donor = privateKey('//Alice');458      [alice, bob, charlie] = await helper.arrange.createAccounts([100n, 100n, 100n], donor);459    });460461    // todo:playgrounds probably separate these tests later462    permissions = [463      {permission: {mutable: true, collectionAdmin: true}, signers: [alice, bob]},464      {permission: {mutable: false, collectionAdmin: true}, signers: [alice, bob]},465      {permission: {mutable: true, tokenOwner: true}, signers: [charlie]},466      {permission: {mutable: false, tokenOwner: true}, signers: [charlie]},467      {permission: {mutable: true, collectionAdmin: true, tokenOwner: true}, signers: [alice, bob, charlie]},468      {permission: {mutable: false, collectionAdmin: true, tokenOwner: true}, signers: [alice, bob, charlie]},469    ];470  });471  472  async function testReadsYetEmptyProperties(token: ITokenNonfungible | ITokenRefungible) {473    const properties = await token.getProperties();474    expect(properties).to.be.empty;475476    const tokenData = await token.getData();477    expect(tokenData!.properties).to.be.empty;478  }479480  itSub('Reads yet empty properties of a token (NFT)', async ({helper}) => {481    const collection = await helper.nft.mintCollection(alice);482    const token = await collection.mintToken(alice);483    await testReadsYetEmptyProperties(token);484  });485486  itSub.ifWithPallets('Reads yet empty properties of a token (ReFungible)', [Pallets.ReFungible], async ({helper}) => {487    const collection = await helper.rft.mintCollection(alice);488    const token = await collection.mintToken(alice);489    await testReadsYetEmptyProperties(token);490  });491492  async function testAssignPropertiesAccordingToPermissions(token: ITokenNonfungible | ITokenRefungible, pieces: bigint) {493    await token.collection.addAdmin(alice, {Substrate: bob.address});494    await token.transfer(alice, {Substrate: charlie.address}, pieces);495496    const propertyKeys: string[] = [];497    let i = 0;498    for (const permission of permissions) {499      i++;500      let j = 0;501      for (const signer of permission.signers) {502        j++;503        const key = i + '_' + signer.address;504        propertyKeys.push(key);505506        await expect(507          token.collection.setTokenPropertyPermissions(alice, [{key: key, permission: permission.permission}]), 508          `on setting permission #${i} by alice`,509        ).to.be.fulfilled;510511        await expect(512          token.setProperties(signer, [{key: key, value: 'Serotonin increase'}]), 513          `on adding property #${i} by signer #${j}`,514        ).to.be.fulfilled;515      }516    }517518    const properties = await token.getProperties(propertyKeys);519    const tokenData = await token.getData();520    for (let i = 0; i < properties.length; i++) {521      expect(properties[i].value).to.be.equal('Serotonin increase');522      expect(tokenData!.properties[i].value).to.be.equal('Serotonin increase');523    }524  }525526  itSub('Assigns properties to a token according to permissions (NFT)', async ({helper}) =>  {527    const collection = await helper.nft.mintCollection(alice);528    const token = await collection.mintToken(alice);529    await testAssignPropertiesAccordingToPermissions(token, 1n);530  });531532  itSub.ifWithPallets('Assigns properties to a token according to permissions (ReFungible)', [Pallets.ReFungible], async ({helper}) => {533    const collection = await helper.rft.mintCollection(alice);534    const token = await collection.mintToken(alice, 100n);535    await testAssignPropertiesAccordingToPermissions(token, 100n);536  });537538  async function testChangesPropertiesAccordingPermission(token: ITokenNonfungible | ITokenRefungible, pieces: bigint) {539    await token.collection.addAdmin(alice, {Substrate: bob.address});540    await token.transfer(alice, {Substrate: charlie.address}, pieces);541542    const propertyKeys: string[] = [];543    let i = 0;544    for (const permission of permissions) {545      i++;546      if (!permission.permission.mutable) continue;547      548      let j = 0;549      for (const signer of permission.signers) {550        j++;551        const key = i + '_' + signer.address;552        propertyKeys.push(key);553554        await expect(555          token.collection.setTokenPropertyPermissions(alice, [{key: key, permission: permission.permission}]), 556          `on setting permission #${i} by alice`,557        ).to.be.fulfilled;558559        await expect(560          token.setProperties(signer, [{key, value: 'Serotonin increase'}]), 561          `on adding property #${i} by signer #${j}`,562        ).to.be.fulfilled;563564        await expect(565          token.setProperties(signer, [{key, value: 'Serotonin stable'}]), 566          `on changing property #${i} by signer #${j}`,567        ).to.be.fulfilled;568      }569    }570571    const properties = await token.getProperties(propertyKeys);572    const tokenData = await token.getData();573    for (let i = 0; i < properties.length; i++) {574      expect(properties[i].value).to.be.equal('Serotonin stable');575      expect(tokenData!.properties[i].value).to.be.equal('Serotonin stable');576    }577  }578579  itSub('Changes properties of a token according to permissions (NFT)', async ({helper}) =>  {580    const collection = await helper.nft.mintCollection(alice);581    const token = await collection.mintToken(alice);582    await testChangesPropertiesAccordingPermission(token, 1n);583  });584585  itSub.ifWithPallets('Changes properties of a token according to permissions (ReFungible)', [Pallets.ReFungible], async ({helper}) => {586    const collection = await helper.rft.mintCollection(alice);587    const token = await collection.mintToken(alice, 100n);588    await testChangesPropertiesAccordingPermission(token, 100n);589  });590591  async function testDeletePropertiesAccordingPermission(token: ITokenNonfungible | ITokenRefungible, pieces: bigint) {592    await token.collection.addAdmin(alice, {Substrate: bob.address});593    await token.transfer(alice, {Substrate: charlie.address}, pieces);594595    const propertyKeys: string[] = [];596    let i = 0;597598    for (const permission of permissions) {599      i++;600      if (!permission.permission.mutable) continue;601      602      let j = 0;603      for (const signer of permission.signers) {604        j++;605        const key = i + '_' + signer.address;606        propertyKeys.push(key);607608        await expect(609          token.collection.setTokenPropertyPermissions(alice, [{key: key, permission: permission.permission}]), 610          `on setting permission #${i} by alice`,611        ).to.be.fulfilled;612613        await expect(614          token.setProperties(signer, [{key, value: 'Serotonin increase'}]), 615          `on adding property #${i} by signer #${j}`,616        ).to.be.fulfilled;617618        await expect(619          token.deleteProperties(signer, [key]), 620          `on deleting property #${i} by signer #${j}`,621        ).to.be.fulfilled;622      }623    }624625    expect(await token.getProperties(propertyKeys)).to.be.empty;626    expect((await token.getData())!.properties).to.be.empty;627  }628  629  itSub('Deletes properties of a token according to permissions (NFT)', async ({helper}) =>  {630    const collection = await helper.nft.mintCollection(alice);631    const token = await collection.mintToken(alice);632    await testDeletePropertiesAccordingPermission(token, 1n);633  });634635  itSub.ifWithPallets('Deletes properties of a token according to permissions (ReFungible)', [Pallets.ReFungible], async ({helper}) => {636    const collection = await helper.rft.mintCollection(alice);637    const token = await collection.mintToken(alice, 100n);638    await testDeletePropertiesAccordingPermission(token, 100n);639  });640641  itSub('Assigns properties to a nested token according to permissions', async ({helper}) =>  {642    const collectionA = await helper.nft.mintCollection(alice, {permissions: {nesting: {tokenOwner: true}}});643    const collectionB = await helper.nft.mintCollection(alice);644    const targetToken = await collectionA.mintToken(alice);645    const nestedToken = await collectionB.mintToken(alice, targetToken.nestingAccount());646647    await collectionB.addAdmin(alice, {Substrate: bob.address});648    await targetToken.transfer(alice, {Substrate: charlie.address});649650    const propertyKeys: string[] = [];651    let i = 0;652    for (const permission of permissions) {653      i++;654      let j = 0;655      for (const signer of permission.signers) {656        j++;657        const key = i + '_' + signer.address;658        propertyKeys.push(key);659        660        await expect(661          nestedToken.collection.setTokenPropertyPermissions(alice, [{key: key, permission: permission.permission}]), 662          `on setting permission #${i} by alice`,663        ).to.be.fulfilled;664665        await expect(666          nestedToken.setProperties(signer, [{key, value: 'Serotonin increase'}]), 667          `on adding property #${i} by signer #${j}`,668        ).to.be.fulfilled;669      }670671    }672673    const properties = await nestedToken.getProperties(propertyKeys);674    const tokenData = await nestedToken.getData();675    for (let i = 0; i < properties.length; i++) {676      expect(properties[i].value).to.be.equal('Serotonin increase');677      expect(tokenData!.properties[i].value).to.be.equal('Serotonin increase');678    }679    expect(await targetToken.getProperties()).to.be.empty;680  });681682  itSub('Changes properties of a nested token according to permissions', async ({helper}) =>  {683    const collectionA = await helper.nft.mintCollection(alice, {permissions: {nesting: {tokenOwner: true}}});684    const collectionB = await helper.nft.mintCollection(alice);685    const targetToken = await collectionA.mintToken(alice);686    const nestedToken = await collectionB.mintToken(alice, targetToken.nestingAccount());687688    await collectionB.addAdmin(alice, {Substrate: bob.address});689    await targetToken.transfer(alice, {Substrate: charlie.address});690691    const propertyKeys: string[] = [];692    let i = 0;693    for (const permission of permissions) {694      i++;695      if (!permission.permission.mutable) continue;696      697      let j = 0;698      for (const signer of permission.signers) {699        j++;700        const key = i + '_' + signer.address;701        propertyKeys.push(key);702703        await expect(704          nestedToken.collection.setTokenPropertyPermissions(alice, [{key: key, permission: permission.permission}]), 705          `on setting permission #${i} by alice`,706        ).to.be.fulfilled;707708        await expect(709          nestedToken.setProperties(signer, [{key, value: 'Serotonin increase'}]), 710          `on adding property #${i} by signer #${j}`,711        ).to.be.fulfilled;712713        await expect(714          nestedToken.setProperties(signer, [{key, value: 'Serotonin stable'}]), 715          `on changing property #${i} by signer #${j}`,716        ).to.be.fulfilled;717      }718    }719720    const properties = await nestedToken.getProperties(propertyKeys);721    const tokenData = await nestedToken.getData();722    for (let i = 0; i < properties.length; i++) {723      expect(properties[i].value).to.be.equal('Serotonin stable');724      expect(tokenData!.properties[i].value).to.be.equal('Serotonin stable');725    }726    expect(await targetToken.getProperties()).to.be.empty;727  });728729  itSub('Deletes properties of a nested token according to permissions', async ({helper}) =>  {730    const collectionA = await helper.nft.mintCollection(alice, {permissions: {nesting: {tokenOwner: true}}});731    const collectionB = await helper.nft.mintCollection(alice);732    const targetToken = await collectionA.mintToken(alice);733    const nestedToken = await collectionB.mintToken(alice, targetToken.nestingAccount());734735    await collectionB.addAdmin(alice, {Substrate: bob.address});736    await targetToken.transfer(alice, {Substrate: charlie.address});737738    const propertyKeys: string[] = [];739    let i = 0;740    for (const permission of permissions) {741      i++;742      if (!permission.permission.mutable) continue;743      744      let j = 0;745      for (const signer of permission.signers) {746        j++;747        const key = i + '_' + signer.address;748        propertyKeys.push(key);749750        await expect(751          nestedToken.collection.setTokenPropertyPermissions(alice, [{key: key, permission: permission.permission}]), 752          `on setting permission #${i} by alice`,753        ).to.be.fulfilled;754755        await expect(756          nestedToken.setProperties(signer, [{key, value: 'Serotonin increase'}]), 757          `on adding property #${i} by signer #${j}`,758        ).to.be.fulfilled;759760        await expect(761          nestedToken.deleteProperties(signer, [key]), 762          `on deleting property #${i} by signer #${j}`,763        ).to.be.fulfilled;764      }765    }766767    expect(await nestedToken.getProperties(propertyKeys)).to.be.empty;768    expect((await nestedToken.getData())!.properties).to.be.empty;769    expect(await targetToken.getProperties()).to.be.empty;770  });771});772773describe('Negative Integration Test: Token Properties', () => {774  let alice: IKeyringPair; // collection owner775  let bob: IKeyringPair; // collection admin776  let charlie: IKeyringPair; // token owner777778  let constitution: {permission: any, signers: IKeyringPair[], sinner: IKeyringPair}[];779780  before(async () => {781    await usingPlaygrounds(async (helper, privateKey) => {782      const donor = privateKey('//Alice');783      let dave: IKeyringPair;784      [alice, bob, charlie, dave] = await helper.arrange.createAccounts([100n, 100n, 100n, 100n], donor);785786      // todo:playgrounds probably separate these tests later787      constitution = [788        {permission: {mutable: true, collectionAdmin: true}, signers: [alice, bob], sinner: charlie},789        {permission: {mutable: false, collectionAdmin: true}, signers: [alice, bob], sinner: charlie},790        {permission: {mutable: true, tokenOwner: true}, signers: [charlie], sinner: alice},791        {permission: {mutable: false, tokenOwner: true}, signers: [charlie], sinner: alice},792        {permission: {mutable: true, collectionAdmin: true, tokenOwner: true}, signers: [alice, bob, charlie], sinner: dave},793        {permission: {mutable: false, collectionAdmin: true, tokenOwner: true}, signers: [alice, bob, charlie], sinner: dave},794      ];795    });796  });797798  async function getConsumedSpace(api: any, collectionId: number, tokenId: number, mode: 'NFT' | 'RFT'): Promise<number> {799    return (await (mode == 'NFT' ? api.query.nonfungible : api.query.refungible).tokenProperties(collectionId, tokenId)).toJSON().consumedSpace;800  }801802  async function prepare(token: ITokenNonfungible | ITokenRefungible, pieces: bigint): Promise<number> {803    await token.collection.addAdmin(alice, {Substrate: bob.address});804    await token.transfer(alice, {Substrate: charlie.address}, pieces);805806    let i = 0;807    for (const passage of constitution) {808      i++;809      const signer = passage.signers[0];810      811      await expect(812        token.collection.setTokenPropertyPermissions(alice, [{key: `${i}`, permission: passage.permission}]), 813        `on setting permission ${i} by alice`,814      ).to.be.fulfilled;815816      await expect(817        token.setProperties(signer, [{key: `${i}`, value: 'Serotonin increase'}]), 818        `on adding property ${i} by ${signer.address}`,819      ).to.be.fulfilled;820    }821822    const originalSpace = await getConsumedSpace(token.collection.helper.api, token.collectionId, token.tokenId, pieces == 1n ? 'NFT' : 'RFT'); 823    return originalSpace;824  }825826  async function testForbidsChangingDeletingPropertiesUserOutsideOfPermissions(token: ITokenNonfungible | ITokenRefungible, pieces: bigint) {827    const originalSpace = await prepare(token, pieces);828829    let i = 0;830    for (const forbiddance of constitution) {831      i++;832      if (!forbiddance.permission.mutable) continue;833834      await expect(835        token.setProperties(forbiddance.sinner, [{key: `${i}`, value: 'Serotonin down'}]), 836        `on failing to change property ${i} by the malefactor`,837      ).to.be.rejectedWith(/common\.NoPermission/);838839      await expect(840        token.deleteProperties(forbiddance.sinner, [`${i}`]), 841        `on failing to delete property ${i} by the malefactor`,842      ).to.be.rejectedWith(/common\.NoPermission/);843    }844845    const consumedSpace = await getConsumedSpace(token.collection.helper.api, token.collectionId, token.tokenId, pieces == 1n ? 'NFT' : 'RFT'); 846    expect(consumedSpace).to.be.equal(originalSpace);847  }848849  itSub('Forbids changing/deleting properties of a token if the user is outside of permissions (NFT)', async ({helper}) =>  {850    const collection = await helper.nft.mintCollection(alice);851    const token = await collection.mintToken(alice);852    await testForbidsChangingDeletingPropertiesUserOutsideOfPermissions(token, 1n);853  });854855  itSub.ifWithPallets('Forbids changing/deleting properties of a token if the user is outside of permissions (ReFungible)', [Pallets.ReFungible], async ({helper}) => {856    const collection = await helper.rft.mintCollection(alice);857    const token = await collection.mintToken(alice, 100n);858    await testForbidsChangingDeletingPropertiesUserOutsideOfPermissions(token, 100n);859  });860861  async function testForbidsChangingDeletingPropertiesIfPropertyImmutable(token: ITokenNonfungible | ITokenRefungible, pieces: bigint) {862    const originalSpace = await prepare(token, pieces);863864    let i = 0;865    for (const permission of constitution) {866      i++;867      if (permission.permission.mutable) continue;868869      await expect(870        token.setProperties(permission.signers[0], [{key: `${i}`, value: 'Serotonin down'}]), 871        `on failing to change property ${i} by signer #0`,872      ).to.be.rejectedWith(/common\.NoPermission/);873874      await expect(875        token.deleteProperties(permission.signers[0], [i.toString()]), 876        `on failing to delete property ${i} by signer #0`,877      ).to.be.rejectedWith(/common\.NoPermission/);878    }879  880    const consumedSpace = await getConsumedSpace(token.collection.helper.api, token.collectionId, token.tokenId, pieces == 1n ? 'NFT' : 'RFT'); 881    expect(consumedSpace).to.be.equal(originalSpace);882  }883884  itSub('Forbids changing/deleting properties of a token if the property is permanent (immutable) (NFT)', async ({helper}) =>  {885    const collection = await helper.nft.mintCollection(alice);886    const token = await collection.mintToken(alice);887    await testForbidsChangingDeletingPropertiesIfPropertyImmutable(token, 1n);888  });889890  itSub.ifWithPallets('Forbids changing/deleting properties of a token if the property is permanent (immutable) (ReFungible)', [Pallets.ReFungible], async ({helper}) => {891    const collection = await helper.rft.mintCollection(alice);892    const token = await collection.mintToken(alice, 100n);893    await testForbidsChangingDeletingPropertiesIfPropertyImmutable(token, 100n);894  });895896  async function testForbidsAddingPropertiesIfPropertyNotDeclared(token: ITokenNonfungible | ITokenRefungible, pieces: bigint) {897    const originalSpace = await prepare(token, pieces);898899    await expect(900      token.setProperties(alice, [{key: 'non-existent', value: 'I exist!'}]), 901      'on failing to add a previously non-existent property',902    ).to.be.rejectedWith(/common\.NoPermission/);903      904    await expect(905      token.collection.setTokenPropertyPermissions(alice, [{key: 'now-existent', permission: {}}]), 906      'on setting a new non-permitted property',907    ).to.be.fulfilled;908909    await expect(910      token.setProperties(alice, [{key: 'now-existent', value: 'I exist!'}]), 911      'on failing to add a property forbidden by the \'None\' permission',912    ).to.be.rejectedWith(/common\.NoPermission/);913914    expect(await token.getProperties(['non-existent', 'now-existent'])).to.be.empty;915      916    const consumedSpace = await getConsumedSpace(token.collection.helper.api, token.collectionId, token.tokenId, pieces == 1n ? 'NFT' : 'RFT'); 917    expect(consumedSpace).to.be.equal(originalSpace);918  }919920  itSub('Forbids adding properties to a token if the property is not declared / forbidden with the \'None\' permission (NFT)', async ({helper}) =>  {921    const collection = await helper.nft.mintCollection(alice);922    const token = await collection.mintToken(alice);923    await testForbidsAddingPropertiesIfPropertyNotDeclared(token, 1n);924  });925926  itSub.ifWithPallets('Forbids adding properties to a token if the property is not declared / forbidden with the \'None\' permission (ReFungible)', [Pallets.ReFungible], async ({helper}) => {927    const collection = await helper.rft.mintCollection(alice);928    const token = await collection.mintToken(alice, 100n);929    await testForbidsAddingPropertiesIfPropertyNotDeclared(token, 100n);930  });931932  async function testForbidsAddingTooManyProperties(token: ITokenNonfungible | ITokenRefungible, pieces: bigint) {933    const originalSpace = await prepare(token, pieces);934935    await expect(936      token.collection.setTokenPropertyPermissions(alice, [937        {key: 'a_holy_book', permission: {collectionAdmin: true, tokenOwner: true}}, 938        {key: 'young_years', permission: {collectionAdmin: true, tokenOwner: true}},939      ]), 940      'on setting new permissions for properties',941    ).to.be.fulfilled;942943    // Mute the general tx parsing error944    {945      console.error = () => {};946      await expect(token.setProperties(alice, [{key: 'a_holy_book', value: 'word '.repeat(6554)}]))947        .to.be.rejected;948    }949950    await expect(token.setProperties(alice, [951      {key: 'a_holy_book', value: 'word '.repeat(3277)}, 952      {key: 'young_years', value: 'neverending'.repeat(1490)},953    ])).to.be.rejectedWith(/common\.NoSpaceForProperty/);954  955    expect(await token.getProperties(['a_holy_book', 'young_years'])).to.be.empty;956    const consumedSpace = await getConsumedSpace(token.collection.helper.api, token.collectionId, token.tokenId, pieces == 1n ? 'NFT' : 'RFT'); 957    expect(consumedSpace).to.be.equal(originalSpace);958  }959960  itSub('Forbids adding too many properties to a token (NFT)', async ({helper}) =>  {961    const collection = await helper.nft.mintCollection(alice);962    const token = await collection.mintToken(alice);963    await testForbidsAddingTooManyProperties(token, 1n);964  });965966  itSub.ifWithPallets('Forbids adding too many properties to a token (ReFungible)', [Pallets.ReFungible], async ({helper}) => {967    const collection = await helper.rft.mintCollection(alice);968    const token = await collection.mintToken(alice, 100n);969    await testForbidsAddingTooManyProperties(token, 100n);970  });971});972973describe('ReFungible token properties permissions tests', () => {974  let alice: IKeyringPair;975  let bob: IKeyringPair;976  let charlie: IKeyringPair;977978  before(async function() {979    await usingPlaygrounds(async (helper, privateKey) => {980      requirePalletsOrSkip(this, helper, [Pallets.ReFungible]);981982      const donor = privateKey('//Alice');983      [alice, bob, charlie] = await helper.arrange.createAccounts([100n, 100n, 100n], donor);984    });985  });986987  async function prepare(helper: UniqueHelper): Promise<ITokenRefungible> {988    const collection = await helper.rft.mintCollection(alice);989    const token = await collection.mintToken(alice, 100n);990    991    await collection.addAdmin(alice, {Substrate: bob.address});992    await collection.setTokenPropertyPermissions(alice, [{key: 'fractals', permission: {mutable: true, tokenOwner: true}}]);993    994    return token;995  }996997  itSub('Forbids adding token property with tokenOwner==true when signer doesn\'t have all pieces', async ({helper}) =>  {998    const token = await prepare(helper);9991000    await token.transfer(alice, {Substrate: charlie.address}, 33n);10011002    await expect(token.setProperties(alice, [1003      {key: 'fractals', value: 'multiverse'}, 1004    ])).to.be.rejectedWith(/common\.NoPermission/);1005  });10061007  itSub('Forbids mutating token property with tokenOwher==true when signer doesn\'t have all pieces', async ({helper}) =>  {1008    const token = await prepare(helper);10091010    await expect(token.collection.setTokenPropertyPermissions(alice, [{key: 'fractals', permission: {mutable:true, tokenOwner: true}}]))1011      .to.be.fulfilled;10121013    await expect(token.setProperties(alice, [1014      {key: 'fractals', value: 'multiverse'}, 1015    ])).to.be.fulfilled;10161017    await token.transfer(alice, {Substrate: charlie.address}, 33n);10181019    await expect(token.setProperties(alice, [1020      {key: 'fractals', value: 'want to rule the world'}, 1021    ])).to.be.rejectedWith(/common\.NoPermission/);1022  });10231024  itSub('Forbids deleting token property with tokenOwner==true when signer doesn\'t have all pieces', async ({helper}) =>  {1025    const token = await prepare(helper);10261027    await expect(token.setProperties(alice, [1028      {key: 'fractals', value: 'one headline - why believe it'}, 1029    ])).to.be.fulfilled;10301031    await token.transfer(alice, {Substrate: charlie.address}, 33n);10321033    await expect(token.deleteProperties(alice, ['fractals'])).1034      to.be.rejectedWith(/common\.NoPermission/);1035  });10361037  itSub('Allows token property mutation with collectionOwner==true when admin doesn\'t have all pieces', async ({helper}) =>  {1038    const token = await prepare(helper);10391040    await token.transfer(alice, {Substrate: charlie.address}, 33n);10411042    await expect(token.collection.setTokenPropertyPermissions(alice, [{key: 'fractals', permission: {mutable:true, collectionAdmin: true}}]))1043      .to.be.fulfilled;10441045    await expect(token.setProperties(alice, [1046      {key: 'fractals', value: 'multiverse'}, 1047    ])).to.be.fulfilled;1048  });1049});