git.delta.rocks / unique-network / refs/commits / f462fd90fa85

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 {UniqueHelper, UniqueBaseCollection, UniqueNFTCollection, UniqueNFToken, UniqueRFTCollection, UniqueRFToken} from '../util/playgrounds/unique';2021// ---------- COLLECTION PROPERTIES2223describe('Integration Test: Collection Properties', () => {24  let alice: IKeyringPair;25  let bob: IKeyringPair;2627  before(async () => {28    await usingPlaygrounds(async (helper, privateKey) => {29      const donor = privateKey('//Alice');30      [alice, bob] = await helper.arrange.createAccounts([50n, 10n], donor);31    });32  });3334  itSub('Properties are initially empty', async ({helper}) => {35    const collection = await helper.nft.mintCollection(alice);36    expect(await collection.getProperties()).to.be.empty;37  });3839  async function testSetsPropertiesForCollection(collection: UniqueBaseCollection) {40    // As owner41    await expect(collection.setProperties(alice, [{key: 'electron', value: 'come bond'}])).to.be.fulfilled;4243    await collection.addAdmin(alice, {Substrate: bob.address});4445    // As administrator46    await expect(collection.setProperties(bob, [{key: 'black_hole'}])).to.be.fulfilled;4748    const properties = await collection.getProperties();49    expect(properties).to.include.deep.members([50      {key: 'electron', value: 'come bond'},51      {key: 'black_hole', value: ''},52    ]);53  }5455  itSub('Sets properties for a NFT collection', async ({helper}) =>  {56    await testSetsPropertiesForCollection(await helper.nft.mintCollection(alice));57  });5859  itSub.ifWithPallets('Sets properties for a ReFungible collection', [Pallets.ReFungible], async ({helper}) => {60    await testSetsPropertiesForCollection(await helper.rft.mintCollection(alice));61  });6263  async function testCheckValidNames(collection: UniqueBaseCollection) {64    // alpha symbols65    await expect(collection.setProperties(alice, [{key: 'answer'}])).to.be.fulfilled;6667    // numeric symbols68    await expect(collection.setProperties(alice, [{key: '451'}])).to.be.fulfilled;6970    // underscore symbol71    await expect(collection.setProperties(alice, [{key: 'black_hole'}])).to.be.fulfilled;7273    // dash symbol74    await expect(collection.setProperties(alice, [{key: '-'}])).to.be.fulfilled;7576    // dot symbol77    await expect(collection.setProperties(alice, [{key: 'once.in.a.long.long.while...', value: 'you get a little lost'}])).to.be.fulfilled;7879    const properties = await collection.getProperties();80    expect(properties).to.include.deep.members([81      {key: 'answer', value: ''},82      {key: '451', value: ''},83      {key: 'black_hole', value: ''},84      {key: '-', value: ''},85      {key: 'once.in.a.long.long.while...', value: 'you get a little lost'},86    ]);87  }8889  itSub('Check valid names for NFT collection properties keys', async ({helper}) =>  {90    await testCheckValidNames(await helper.nft.mintCollection(alice));91  });9293  itSub.ifWithPallets('Check valid names for ReFungible collection properties keys', [Pallets.ReFungible], async ({helper}) => {94    await testCheckValidNames(await helper.rft.mintCollection(alice));95  });9697  async function testChangesProperties(collection: UniqueBaseCollection) {98    await expect(collection.setProperties(alice, [{key: 'electron', value: 'come bond'}, {key: 'black_hole', value: ''}])).to.be.fulfilled;99100    // Mutate the properties101    await expect(collection.setProperties(alice, [{key: 'black_hole', value: 'LIGO'}])).to.be.fulfilled;102103    const properties = await collection.getProperties();104    expect(properties).to.include.deep.members([105      {key: 'electron', value: 'come bond'},106      {key: 'black_hole', value: 'LIGO'},107    ]);108  }109110  itSub('Changes properties of a NFT collection', async ({helper}) =>  {111    await testChangesProperties(await helper.nft.mintCollection(alice));112  });113114  itSub.ifWithPallets('Changes properties of a ReFungible collection', [Pallets.ReFungible], async ({helper}) => {115    await testChangesProperties(await helper.rft.mintCollection(alice));116  });117118  async function testDeleteProperties(collection: UniqueBaseCollection) {119    await expect(collection.setProperties(alice, [{key: 'electron', value: 'come bond'}, {key: 'black_hole', value: 'LIGO'}])).to.be.fulfilled;120121    await expect(collection.deleteProperties(alice, ['electron'])).to.be.fulfilled;122123    const properties = await collection.getProperties(['black_hole', 'electron']);124    expect(properties).to.be.deep.equal([125      {key: 'black_hole', value: 'LIGO'},126    ]);127  }128129  itSub('Deletes properties of a NFT collection', async ({helper}) =>  {130    await testDeleteProperties(await helper.nft.mintCollection(alice));131  });132133  itSub.ifWithPallets('Deletes properties of a ReFungible collection', [Pallets.ReFungible], async ({helper}) => {134    await testDeleteProperties(await helper.rft.mintCollection(alice));135  });136});137138describe('Negative Integration Test: Collection Properties', () => {139  let alice: IKeyringPair;140  let bob: IKeyringPair;141142  before(async () => {143    await usingPlaygrounds(async (helper, privateKey) => {144      const donor = privateKey('//Alice');145      [alice, bob] = await helper.arrange.createAccounts([100n, 10n], donor);146    });147  });148  149  async function testFailsSetPropertiesIfNotOwnerOrAdmin(collection: UniqueBaseCollection) {  150    await expect(collection.setProperties(bob, [{key: 'electron', value: 'come bond'}, {key: 'black_hole', value: 'LIGO'}]))151      .to.be.rejectedWith(/common\.NoPermission/);152153    expect(await collection.getProperties()).to.be.empty;154  }155156  itSub('Fails to set properties in a NFT collection if not its onwer/administrator', async ({helper}) =>  {157    await testFailsSetPropertiesIfNotOwnerOrAdmin(await helper.nft.mintCollection(alice));158  });159160  itSub.ifWithPallets('Fails to set properties in a ReFungible collection if not its onwer/administrator', [Pallets.ReFungible], async ({helper}) => {161    await testFailsSetPropertiesIfNotOwnerOrAdmin(await helper.rft.mintCollection(alice));162  });163  164  async function testFailsSetPropertiesThatExeedLimits(collection: UniqueBaseCollection) {165    const spaceLimit = (await (collection.helper!.api! as any).query.common.collectionProperties(collection.collectionId)).spaceLimit.toNumber();166  167    // Mute the general tx parsing error, too many bytes to process168    {169      console.error = () => {};170      await expect(collection.setProperties(alice, [171        {key: 'electron', value: 'low high '.repeat(Math.ceil(spaceLimit! / 9))},172      ])).to.be.rejected;173    }174175    expect(await collection.getProperties(['electron'])).to.be.empty;176177    await expect(collection.setProperties(alice, [178      {key: 'electron', value: 'low high '.repeat(Math.ceil(spaceLimit! / 18))}, 179      {key: 'black_hole', value: '0'.repeat(Math.ceil(spaceLimit! / 2))}, 180    ])).to.be.rejectedWith(/common\.NoSpaceForProperty/);181182    expect(await collection.getProperties(['electron', 'black_hole'])).to.be.empty;183  }184185  itSub('Fails to set properties that exceed the limits (NFT)', async ({helper}) =>  {186    await testFailsSetPropertiesThatExeedLimits(await helper.nft.mintCollection(alice));187  });188189  itSub.ifWithPallets('Fails to set properties that exceed the limits (ReFungible)', [Pallets.ReFungible], async ({helper}) => {190    await testFailsSetPropertiesThatExeedLimits(await helper.rft.mintCollection(alice));191  });192  193  async function testFailsSetMorePropertiesThanAllowed(collection: UniqueBaseCollection) {194    const propertiesToBeSet = [];195    for (let i = 0; i < 65; i++) {196      propertiesToBeSet.push({197        key: 'electron_' + i,198        value: Math.random() > 0.5 ? 'high' : 'low',199      });200    }201202    await expect(collection.setProperties(alice, propertiesToBeSet)).203      to.be.rejectedWith(/common\.PropertyLimitReached/);204205    expect(await collection.getProperties()).to.be.empty;206  }207208  itSub('Fails to set more properties than it is allowed (NFT)', async ({helper}) =>  {209    await testFailsSetMorePropertiesThanAllowed(await helper.nft.mintCollection(alice));210  });211212  itSub.ifWithPallets('Fails to set more properties than it is allowed (ReFungible)', [Pallets.ReFungible], async ({helper}) => {213    await testFailsSetMorePropertiesThanAllowed(await helper.rft.mintCollection(alice));214  });215  216  async function testFailsSetPropertiesWithInvalidNames(collection: UniqueBaseCollection) {217    const invalidProperties = [218      [{key: 'electron', value: 'negative'}, {key: 'string theory', value: 'understandable'}],219      [{key: 'Mr/Sandman', value: 'Bring me a gene'}],220      [{key: 'déjà vu', value: 'hmm...'}],221    ];222223    for (let i = 0; i < invalidProperties.length; i++) {224      await expect(225        collection.setProperties(alice, invalidProperties[i]), 226        `on rejecting the new badly-named property #${i}`,227      ).to.be.rejectedWith(/common\.InvalidCharacterInPropertyKey/);228    }229230    await expect(231      collection.setProperties(alice, [{key: '', value: 'nothing must not exist'}]), 232      'on rejecting an unnamed property',233    ).to.be.rejectedWith(/common\.EmptyPropertyKey/);234235    await expect(236      collection.setProperties(alice, [{key: 'CRISPR-Cas9', value: 'rewriting nature!'}]), 237      'on setting the correctly-but-still-badly-named property',238    ).to.be.fulfilled;239240    const keys = invalidProperties.flatMap(propertySet => propertySet.map(property => property.key)).concat('CRISPR-Cas9').concat('');241242    const properties = await collection.getProperties(keys);243    expect(properties).to.be.deep.equal([244      {key: 'CRISPR-Cas9', value: 'rewriting nature!'},245    ]);246247    for (let i = 0; i < invalidProperties.length; i++) {248      await expect(249        collection.deleteProperties(alice, invalidProperties[i].map(propertySet => propertySet.key)), 250        `on trying to delete the non-existent badly-named property #${i}`,251      ).to.be.rejectedWith(/common\.InvalidCharacterInPropertyKey/);252    }253  }254255  itSub('Fails to set properties with invalid names (NFT)', async ({helper}) =>  {256    await testFailsSetPropertiesWithInvalidNames(await helper.nft.mintCollection(alice));257  });258259  itSub.ifWithPallets('Fails to set properties with invalid names (ReFungible)', [Pallets.ReFungible], async ({helper}) => {260    await testFailsSetPropertiesWithInvalidNames(await helper.rft.mintCollection(alice));261  });262});263264// ---------- ACCESS RIGHTS265266describe('Integration Test: Access Rights to Token Properties', () => {267  let alice: IKeyringPair;268  let bob: IKeyringPair;269270  before(async () => {271    await usingPlaygrounds(async (helper, privateKey) => {272      const donor = privateKey('//Alice');273      [alice, bob] = await helper.arrange.createAccounts([100n, 10n], donor);274    });275  });276  277  itSub('Reads access rights to properties of a collection', async ({helper}) =>  {278    const collection = await helper.nft.mintCollection(alice);279    const propertyRights = (await helper.api!.query.common.collectionPropertyPermissions(collection.collectionId)).toJSON();280    expect(propertyRights).to.be.empty;281  });282  283  async function testSetsAccessRightsToProperties(collection: UniqueNFTCollection | UniqueRFTCollection) {  284    await expect(collection.setTokenPropertyPermissions(alice, [{key: 'skullduggery', permission: {mutable: true}}]))285      .to.be.fulfilled;286287    await collection.addAdmin(alice, {Substrate: bob.address});288289    await expect(collection.setTokenPropertyPermissions(bob, [{key: 'mindgame', permission: {collectionAdmin: true, tokenOwner: false}}]))290      .to.be.fulfilled;291292    const propertyRights = await collection.getPropertyPermissions(['skullduggery', 'mindgame']);293    expect(propertyRights).to.include.deep.members([294      {key: 'skullduggery', permission: {mutable: true, collectionAdmin: false, tokenOwner: false}},295      {key: 'mindgame', permission: {mutable: false, collectionAdmin: true, tokenOwner: false}},296    ]);297  }298299  itSub('Sets access rights to properties of a collection (NFT)', async ({helper}) =>  {300    await testSetsAccessRightsToProperties(await helper.nft.mintCollection(alice));301  });302303  itSub.ifWithPallets('Sets access rights to properties of a collection (ReFungible)', [Pallets.ReFungible], async ({helper}) => {304    await testSetsAccessRightsToProperties(await helper.rft.mintCollection(alice));305  });306  307  async function testChangesAccessRightsToProperty(collection: UniqueNFTCollection | UniqueRFTCollection) {308    await expect(collection.setTokenPropertyPermissions(alice, [{key: 'skullduggery', permission: {mutable: true, collectionAdmin: true}}]))309      .to.be.fulfilled;310311    await expect(collection.setTokenPropertyPermissions(alice, [{key: 'skullduggery', permission: {mutable: false, tokenOwner: true}}]))312      .to.be.fulfilled;313314    const propertyRights = await collection.getPropertyPermissions();315    expect(propertyRights).to.be.deep.equal([316      {key: 'skullduggery', permission: {'mutable': false, 'collectionAdmin': false, 'tokenOwner': true}},317    ]);318  }319320  itSub('Changes access rights to properties of a NFT collection', async ({helper}) =>  {321    await testChangesAccessRightsToProperty(await helper.nft.mintCollection(alice));322  });323324  itSub.ifWithPallets('Changes access rights to properties of a ReFungible collection', [Pallets.ReFungible], async ({helper}) => {325    await testChangesAccessRightsToProperty(await helper.rft.mintCollection(alice));326  });327});328329describe('Negative Integration Test: Access Rights to Token Properties', () => {330  let alice: IKeyringPair;331  let bob: IKeyringPair;332333  before(async () => {334    await usingPlaygrounds(async (helper, privateKey) => {335      const donor = privateKey('//Alice');336      [alice, bob] = await helper.arrange.createAccounts([50n, 10n], donor);337    });338  });339340  async function testPreventsFromSettingAccessRightsNotAdminOrOwner(collection: UniqueNFTCollection | UniqueRFTCollection) {341    await expect(collection.setTokenPropertyPermissions(bob, [{key: 'skullduggery', permission: {mutable: true, tokenOwner: true}}]))342      .to.be.rejectedWith(/common\.NoPermission/);343344    const propertyRights = await collection.getPropertyPermissions(['skullduggery']);345    expect(propertyRights).to.be.empty;346  }347348  itSub('Prevents from setting access rights to properties of a NFT collection if not an onwer/admin', async ({helper}) =>  {349    await testPreventsFromSettingAccessRightsNotAdminOrOwner(await helper.nft.mintCollection(alice));350  });351352  itSub.ifWithPallets('Prevents from setting access rights to properties of a ReFungible collection if not an onwer/admin', [Pallets.ReFungible], async ({helper}) => {353    await testPreventsFromSettingAccessRightsNotAdminOrOwner(await helper.rft.mintCollection(alice));354  });355356  async function testPreventFromAddingTooManyPossibleProperties(collection: UniqueNFTCollection | UniqueRFTCollection) {  357    const constitution = [];358    for (let i = 0; i < 65; i++) {359      constitution.push({360        key: 'property_' + i,361        permission: Math.random() > 0.5 ? {mutable: true, collectionAdmin: true, tokenOwner: true} : {},362      });363    }364365    await expect(collection.setTokenPropertyPermissions(alice, constitution))366      .to.be.rejectedWith(/common\.PropertyLimitReached/);367368    const propertyRights = await collection.getPropertyPermissions();369    expect(propertyRights).to.be.empty;370  }371372  itSub('Prevents from adding too many possible properties (NFT)', async ({helper}) =>  {373    await testPreventFromAddingTooManyPossibleProperties(await helper.nft.mintCollection(alice));374  });375376  itSub.ifWithPallets('Prevents from adding too many possible properties (ReFungible)', [Pallets.ReFungible], async ({helper}) => {377    await testPreventFromAddingTooManyPossibleProperties(await helper.rft.mintCollection(alice));378  });379380  async function testPreventAccessRightsModifiedIfConstant(collection: UniqueNFTCollection | UniqueRFTCollection) {381    await expect(collection.setTokenPropertyPermissions(alice, [{key: 'skullduggery', permission: {mutable: false, tokenOwner: true}}]))382      .to.be.fulfilled;383384    await expect(collection.setTokenPropertyPermissions(alice, [{key: 'skullduggery', permission: {collectionAdmin: true}}]))385      .to.be.rejectedWith(/common\.NoPermission/);386387    const propertyRights = await collection.getPropertyPermissions(['skullduggery']);388    expect(propertyRights).to.deep.equal([389      {key: 'skullduggery', permission: {'mutable': false, 'collectionAdmin': false, 'tokenOwner': true}},390    ]);391  }392393  itSub('Prevents access rights to be modified if constant (NFT)', async ({helper}) =>  {394    await testPreventAccessRightsModifiedIfConstant(await helper.nft.mintCollection(alice));395  });396397  itSub.ifWithPallets('Prevents access rights to be modified if constant (ReFungible)', [Pallets.ReFungible], async ({helper}) => {398    await testPreventAccessRightsModifiedIfConstant(await helper.rft.mintCollection(alice));399  });400401  async function testPreventsAddingPropertiesWithInvalidNames(collection: UniqueNFTCollection | UniqueRFTCollection) {402    const invalidProperties = [403      [{key: 'skullduggery', permission: {tokenOwner: true}}, {key: 'im possible', permission: {collectionAdmin: true}}],404      [{key: 'G#4', permission: {tokenOwner: true}}],405      [{key: 'HÆMILTON', permission: {mutable: false, collectionAdmin: true, tokenOwner: true}}],406    ];407408    for (let i = 0; i < invalidProperties.length; i++) {409      await expect(410        collection.setTokenPropertyPermissions(alice, invalidProperties[i]), 411        `on setting the new badly-named property #${i}`,412      ).to.be.rejectedWith(/common\.InvalidCharacterInPropertyKey/);413    }414415    await expect(416      collection.setTokenPropertyPermissions(alice, [{key: '', permission: {}}]), 417      'on rejecting an unnamed property',418    ).to.be.rejectedWith(/common\.EmptyPropertyKey/);419420    const correctKey = '--0x03116e387820CA05'; // PolkadotJS would parse this as an already encoded hex-string421    await expect(422      collection.setTokenPropertyPermissions(alice, [423        {key: correctKey, permission: {collectionAdmin: true}},424      ]), 425      'on setting the correctly-but-still-badly-named property',426    ).to.be.fulfilled;427428    const keys = invalidProperties.flatMap(propertySet => propertySet.map(property => property.key)).concat(correctKey).concat('');429430    const propertyRights = await collection.getPropertyPermissions(keys);431    expect(propertyRights).to.be.deep.equal([432      {key: correctKey, permission: {mutable: false, collectionAdmin: true, tokenOwner: false}},433    ]);434  }435436  itSub('Prevents adding properties with invalid names (NFT)', async ({helper}) =>  {437    await testPreventsAddingPropertiesWithInvalidNames(await helper.nft.mintCollection(alice));438  });439440  itSub.ifWithPallets('Prevents adding properties with invalid names (ReFungible)', [Pallets.ReFungible], async ({helper}) => {441    await testPreventsAddingPropertiesWithInvalidNames(await helper.rft.mintCollection(alice));442  });443});444445// ---------- TOKEN PROPERTIES446447describe('Integration Test: Token Properties', () => {448  let alice: IKeyringPair; // collection owner449  let bob: IKeyringPair; // collection admin450  let charlie: IKeyringPair; // token owner451452  let permissions: {permission: any, signers: IKeyringPair[]}[];453454  before(async () => {455    await usingPlaygrounds(async (helper, privateKey) => {456      const donor = privateKey('//Alice');457      [alice, bob, charlie] = await helper.arrange.createAccounts([100n, 100n, 100n], donor);458    });459460    // todo:playgrounds probably separate these tests later461    permissions = [462      {permission: {mutable: true, collectionAdmin: true}, signers: [alice, bob]},463      {permission: {mutable: false, collectionAdmin: true}, signers: [alice, bob]},464      {permission: {mutable: true, tokenOwner: true}, signers: [charlie]},465      {permission: {mutable: false, tokenOwner: true}, signers: [charlie]},466      {permission: {mutable: true, collectionAdmin: true, tokenOwner: true}, signers: [alice, bob, charlie]},467      {permission: {mutable: false, collectionAdmin: true, tokenOwner: true}, signers: [alice, bob, charlie]},468    ];469  });470  471  async function testReadsYetEmptyProperties(token: UniqueNFToken | UniqueRFToken) {472    const properties = await token.getProperties();473    expect(properties).to.be.empty;474475    const tokenData = await token.getData();476    expect(tokenData!.properties).to.be.empty;477  }478479  itSub('Reads yet empty properties of a token (NFT)', async ({helper}) => {480    const collection = await helper.nft.mintCollection(alice);481    const token = await collection.mintToken(alice);482    await testReadsYetEmptyProperties(token);483  });484485  itSub.ifWithPallets('Reads yet empty properties of a token (ReFungible)', [Pallets.ReFungible], async ({helper}) => {486    const collection = await helper.rft.mintCollection(alice);487    const token = await collection.mintToken(alice);488    await testReadsYetEmptyProperties(token);489  });490491  async function testAssignPropertiesAccordingToPermissions(token: UniqueNFToken | UniqueRFToken, pieces: bigint) {492    await token.collection.addAdmin(alice, {Substrate: bob.address});493    await token.transfer(alice, {Substrate: charlie.address}, pieces);494495    const propertyKeys: string[] = [];496    let i = 0;497    for (const permission of permissions) {498      i++;499      let j = 0;500      for (const signer of permission.signers) {501        j++;502        const key = i + '_' + signer.address;503        propertyKeys.push(key);504505        await expect(506          token.collection.setTokenPropertyPermissions(alice, [{key: key, permission: permission.permission}]), 507          `on setting permission #${i} by alice`,508        ).to.be.fulfilled;509510        await expect(511          token.setProperties(signer, [{key: key, value: 'Serotonin increase'}]), 512          `on adding property #${i} by signer #${j}`,513        ).to.be.fulfilled;514      }515    }516517    const properties = await token.getProperties(propertyKeys);518    const tokenData = await token.getData();519    for (let i = 0; i < properties.length; i++) {520      expect(properties[i].value).to.be.equal('Serotonin increase');521      expect(tokenData!.properties[i].value).to.be.equal('Serotonin increase');522    }523  }524525  itSub('Assigns properties to a token according to permissions (NFT)', async ({helper}) =>  {526    const collection = await helper.nft.mintCollection(alice);527    const token = await collection.mintToken(alice);528    await testAssignPropertiesAccordingToPermissions(token, 1n);529  });530531  itSub.ifWithPallets('Assigns properties to a token according to permissions (ReFungible)', [Pallets.ReFungible], async ({helper}) => {532    const collection = await helper.rft.mintCollection(alice);533    const token = await collection.mintToken(alice, 100n);534    await testAssignPropertiesAccordingToPermissions(token, 100n);535  });536537  async function testChangesPropertiesAccordingPermission(token: UniqueNFToken | UniqueRFToken, pieces: bigint) {538    await token.collection.addAdmin(alice, {Substrate: bob.address});539    await token.transfer(alice, {Substrate: charlie.address}, pieces);540541    const propertyKeys: string[] = [];542    let i = 0;543    for (const permission of permissions) {544      i++;545      if (!permission.permission.mutable) continue;546      547      let j = 0;548      for (const signer of permission.signers) {549        j++;550        const key = i + '_' + signer.address;551        propertyKeys.push(key);552553        await expect(554          token.collection.setTokenPropertyPermissions(alice, [{key: key, permission: permission.permission}]), 555          `on setting permission #${i} by alice`,556        ).to.be.fulfilled;557558        await expect(559          token.setProperties(signer, [{key, value: 'Serotonin increase'}]), 560          `on adding property #${i} by signer #${j}`,561        ).to.be.fulfilled;562563        await expect(564          token.setProperties(signer, [{key, value: 'Serotonin stable'}]), 565          `on changing property #${i} by signer #${j}`,566        ).to.be.fulfilled;567      }568    }569570    const properties = await token.getProperties(propertyKeys);571    const tokenData = await token.getData();572    for (let i = 0; i < properties.length; i++) {573      expect(properties[i].value).to.be.equal('Serotonin stable');574      expect(tokenData!.properties[i].value).to.be.equal('Serotonin stable');575    }576  }577578  itSub('Changes properties of a token according to permissions (NFT)', async ({helper}) =>  {579    const collection = await helper.nft.mintCollection(alice);580    const token = await collection.mintToken(alice);581    await testChangesPropertiesAccordingPermission(token, 1n);582  });583584  itSub.ifWithPallets('Changes properties of a token according to permissions (ReFungible)', [Pallets.ReFungible], async ({helper}) => {585    const collection = await helper.rft.mintCollection(alice);586    const token = await collection.mintToken(alice, 100n);587    await testChangesPropertiesAccordingPermission(token, 100n);588  });589590  async function testDeletePropertiesAccordingPermission(token: UniqueNFToken | UniqueRFToken, pieces: bigint) {591    await token.collection.addAdmin(alice, {Substrate: bob.address});592    await token.transfer(alice, {Substrate: charlie.address}, pieces);593594    const propertyKeys: string[] = [];595    let i = 0;596597    for (const permission of permissions) {598      i++;599      if (!permission.permission.mutable) continue;600      601      let j = 0;602      for (const signer of permission.signers) {603        j++;604        const key = i + '_' + signer.address;605        propertyKeys.push(key);606607        await expect(608          token.collection.setTokenPropertyPermissions(alice, [{key: key, permission: permission.permission}]), 609          `on setting permission #${i} by alice`,610        ).to.be.fulfilled;611612        await expect(613          token.setProperties(signer, [{key, value: 'Serotonin increase'}]), 614          `on adding property #${i} by signer #${j}`,615        ).to.be.fulfilled;616617        await expect(618          token.deleteProperties(signer, [key]), 619          `on deleting property #${i} by signer #${j}`,620        ).to.be.fulfilled;621      }622    }623624    expect(await token.getProperties(propertyKeys)).to.be.empty;625    expect((await token.getData())!.properties).to.be.empty;626  }627  628  itSub('Deletes properties of a token according to permissions (NFT)', async ({helper}) =>  {629    const collection = await helper.nft.mintCollection(alice);630    const token = await collection.mintToken(alice);631    await testDeletePropertiesAccordingPermission(token, 1n);632  });633634  itSub.ifWithPallets('Deletes properties of a token according to permissions (ReFungible)', [Pallets.ReFungible], async ({helper}) => {635    const collection = await helper.rft.mintCollection(alice);636    const token = await collection.mintToken(alice, 100n);637    await testDeletePropertiesAccordingPermission(token, 100n);638  });639640  itSub('Assigns properties to a nested token according to permissions', async ({helper}) =>  {641    const collectionA = await helper.nft.mintCollection(alice, {permissions: {nesting: {tokenOwner: true}}});642    const collectionB = await helper.nft.mintCollection(alice);643    const targetToken = await collectionA.mintToken(alice);644    const nestedToken = await collectionB.mintToken(alice, targetToken.nestingAccount());645646    await collectionB.addAdmin(alice, {Substrate: bob.address});647    await targetToken.transfer(alice, {Substrate: charlie.address});648649    const propertyKeys: string[] = [];650    let i = 0;651    for (const permission of permissions) {652      i++;653      let j = 0;654      for (const signer of permission.signers) {655        j++;656        const key = i + '_' + signer.address;657        propertyKeys.push(key);658        659        await expect(660          nestedToken.collection.setTokenPropertyPermissions(alice, [{key: key, permission: permission.permission}]), 661          `on setting permission #${i} by alice`,662        ).to.be.fulfilled;663664        await expect(665          nestedToken.setProperties(signer, [{key, value: 'Serotonin increase'}]), 666          `on adding property #${i} by signer #${j}`,667        ).to.be.fulfilled;668      }669    }670671    const properties = await nestedToken.getProperties(propertyKeys);672    const tokenData = await nestedToken.getData();673    for (let i = 0; i < properties.length; i++) {674      expect(properties[i].value).to.be.equal('Serotonin increase');675      expect(tokenData!.properties[i].value).to.be.equal('Serotonin increase');676    }677    expect(await targetToken.getProperties()).to.be.empty;678  });679680  itSub('Changes properties of a nested token according to permissions', async ({helper}) =>  {681    const collectionA = await helper.nft.mintCollection(alice, {permissions: {nesting: {tokenOwner: true}}});682    const collectionB = await helper.nft.mintCollection(alice);683    const targetToken = await collectionA.mintToken(alice);684    const nestedToken = await collectionB.mintToken(alice, targetToken.nestingAccount());685686    await collectionB.addAdmin(alice, {Substrate: bob.address});687    await targetToken.transfer(alice, {Substrate: charlie.address});688689    const propertyKeys: string[] = [];690    let i = 0;691    for (const permission of permissions) {692      i++;693      if (!permission.permission.mutable) continue;694      695      let j = 0;696      for (const signer of permission.signers) {697        j++;698        const key = i + '_' + signer.address;699        propertyKeys.push(key);700701        await expect(702          nestedToken.collection.setTokenPropertyPermissions(alice, [{key: key, permission: permission.permission}]), 703          `on setting permission #${i} by alice`,704        ).to.be.fulfilled;705706        await expect(707          nestedToken.setProperties(signer, [{key, value: 'Serotonin increase'}]), 708          `on adding property #${i} by signer #${j}`,709        ).to.be.fulfilled;710711        await expect(712          nestedToken.setProperties(signer, [{key, value: 'Serotonin stable'}]), 713          `on changing property #${i} by signer #${j}`,714        ).to.be.fulfilled;715      }716    }717718    const properties = await nestedToken.getProperties(propertyKeys);719    const tokenData = await nestedToken.getData();720    for (let i = 0; i < properties.length; i++) {721      expect(properties[i].value).to.be.equal('Serotonin stable');722      expect(tokenData!.properties[i].value).to.be.equal('Serotonin stable');723    }724    expect(await targetToken.getProperties()).to.be.empty;725  });726727  itSub('Deletes properties of a nested token according to permissions', async ({helper}) =>  {728    const collectionA = await helper.nft.mintCollection(alice, {permissions: {nesting: {tokenOwner: true}}});729    const collectionB = await helper.nft.mintCollection(alice);730    const targetToken = await collectionA.mintToken(alice);731    const nestedToken = await collectionB.mintToken(alice, targetToken.nestingAccount());732733    await collectionB.addAdmin(alice, {Substrate: bob.address});734    await targetToken.transfer(alice, {Substrate: charlie.address});735736    const propertyKeys: string[] = [];737    let i = 0;738    for (const permission of permissions) {739      i++;740      if (!permission.permission.mutable) continue;741      742      let j = 0;743      for (const signer of permission.signers) {744        j++;745        const key = i + '_' + signer.address;746        propertyKeys.push(key);747748        await expect(749          nestedToken.collection.setTokenPropertyPermissions(alice, [{key: key, permission: permission.permission}]), 750          `on setting permission #${i} by alice`,751        ).to.be.fulfilled;752753        await expect(754          nestedToken.setProperties(signer, [{key, value: 'Serotonin increase'}]), 755          `on adding property #${i} by signer #${j}`,756        ).to.be.fulfilled;757758        await expect(759          nestedToken.deleteProperties(signer, [key]), 760          `on deleting property #${i} by signer #${j}`,761        ).to.be.fulfilled;762      }763    }764765    expect(await nestedToken.getProperties(propertyKeys)).to.be.empty;766    expect((await nestedToken.getData())!.properties).to.be.empty;767    expect(await targetToken.getProperties()).to.be.empty;768  });769});770771describe('Negative Integration Test: Token Properties', () => {772  let alice: IKeyringPair; // collection owner773  let bob: IKeyringPair; // collection admin774  let charlie: IKeyringPair; // token owner775776  let constitution: {permission: any, signers: IKeyringPair[], sinner: IKeyringPair}[];777778  before(async () => {779    await usingPlaygrounds(async (helper, privateKey) => {780      const donor = privateKey('//Alice');781      let dave: IKeyringPair;782      [alice, bob, charlie, dave] = await helper.arrange.createAccounts([100n, 100n, 100n, 100n], donor);783784      // todo:playgrounds probably separate these tests later785      constitution = [786        {permission: {mutable: true, collectionAdmin: true}, signers: [alice, bob], sinner: charlie},787        {permission: {mutable: false, collectionAdmin: true}, signers: [alice, bob], sinner: charlie},788        {permission: {mutable: true, tokenOwner: true}, signers: [charlie], sinner: alice},789        {permission: {mutable: false, tokenOwner: true}, signers: [charlie], sinner: alice},790        {permission: {mutable: true, collectionAdmin: true, tokenOwner: true}, signers: [alice, bob, charlie], sinner: dave},791        {permission: {mutable: false, collectionAdmin: true, tokenOwner: true}, signers: [alice, bob, charlie], sinner: dave},792      ];793    });794  });795796  async function getConsumedSpace(api: any, collectionId: number, tokenId: number, mode: 'NFT' | 'RFT'): Promise<number> {797    return (await (mode == 'NFT' ? api.query.nonfungible : api.query.refungible).tokenProperties(collectionId, tokenId)).toJSON().consumedSpace;798  }799800  async function prepare(token: UniqueNFToken | UniqueRFToken, pieces: bigint): Promise<number> {801    await token.collection.addAdmin(alice, {Substrate: bob.address});802    await token.transfer(alice, {Substrate: charlie.address}, pieces);803804    let i = 0;805    for (const passage of constitution) {806      i++;807      const signer = passage.signers[0];808      809      await expect(810        token.collection.setTokenPropertyPermissions(alice, [{key: `${i}`, permission: passage.permission}]), 811        `on setting permission ${i} by alice`,812      ).to.be.fulfilled;813814      await expect(815        token.setProperties(signer, [{key: `${i}`, value: 'Serotonin increase'}]), 816        `on adding property ${i} by ${signer.address}`,817      ).to.be.fulfilled;818    }819820    const originalSpace = await getConsumedSpace(token.collection.helper.api, token.collectionId, token.tokenId, pieces == 1n ? 'NFT' : 'RFT'); 821    return originalSpace;822  }823824  async function testForbidsChangingDeletingPropertiesUserOutsideOfPermissions(token: UniqueNFToken | UniqueRFToken, pieces: bigint) {825    const originalSpace = await prepare(token, pieces);826827    let i = 0;828    for (const forbiddance of constitution) {829      i++;830      if (!forbiddance.permission.mutable) continue;831832      await expect(833        token.setProperties(forbiddance.sinner, [{key: `${i}`, value: 'Serotonin down'}]), 834        `on failing to change property ${i} by the malefactor`,835      ).to.be.rejectedWith(/common\.NoPermission/);836837      await expect(838        token.deleteProperties(forbiddance.sinner, [`${i}`]), 839        `on failing to delete property ${i} by the malefactor`,840      ).to.be.rejectedWith(/common\.NoPermission/);841    }842843    const consumedSpace = await getConsumedSpace(token.collection.helper.api, token.collectionId, token.tokenId, pieces == 1n ? 'NFT' : 'RFT'); 844    expect(consumedSpace).to.be.equal(originalSpace);845  }846847  itSub('Forbids changing/deleting properties of a token if the user is outside of permissions (NFT)', async ({helper}) =>  {848    const collection = await helper.nft.mintCollection(alice);849    const token = await collection.mintToken(alice);850    await testForbidsChangingDeletingPropertiesUserOutsideOfPermissions(token, 1n);851  });852853  itSub.ifWithPallets('Forbids changing/deleting properties of a token if the user is outside of permissions (ReFungible)', [Pallets.ReFungible], async ({helper}) => {854    const collection = await helper.rft.mintCollection(alice);855    const token = await collection.mintToken(alice, 100n);856    await testForbidsChangingDeletingPropertiesUserOutsideOfPermissions(token, 100n);857  });858859  async function testForbidsChangingDeletingPropertiesIfPropertyImmutable(token: UniqueNFToken | UniqueRFToken, pieces: bigint) {860    const originalSpace = await prepare(token, pieces);861862    let i = 0;863    for (const permission of constitution) {864      i++;865      if (permission.permission.mutable) continue;866867      await expect(868        token.setProperties(permission.signers[0], [{key: `${i}`, value: 'Serotonin down'}]), 869        `on failing to change property ${i} by signer #0`,870      ).to.be.rejectedWith(/common\.NoPermission/);871872      await expect(873        token.deleteProperties(permission.signers[0], [i.toString()]), 874        `on failing to delete property ${i} by signer #0`,875      ).to.be.rejectedWith(/common\.NoPermission/);876    }877  878    const consumedSpace = await getConsumedSpace(token.collection.helper.api, token.collectionId, token.tokenId, pieces == 1n ? 'NFT' : 'RFT'); 879    expect(consumedSpace).to.be.equal(originalSpace);880  }881882  itSub('Forbids changing/deleting properties of a token if the property is permanent (immutable) (NFT)', async ({helper}) =>  {883    const collection = await helper.nft.mintCollection(alice);884    const token = await collection.mintToken(alice);885    await testForbidsChangingDeletingPropertiesIfPropertyImmutable(token, 1n);886  });887888  itSub.ifWithPallets('Forbids changing/deleting properties of a token if the property is permanent (immutable) (ReFungible)', [Pallets.ReFungible], async ({helper}) => {889    const collection = await helper.rft.mintCollection(alice);890    const token = await collection.mintToken(alice, 100n);891    await testForbidsChangingDeletingPropertiesIfPropertyImmutable(token, 100n);892  });893894  async function testForbidsAddingPropertiesIfPropertyNotDeclared(token: UniqueNFToken | UniqueRFToken, pieces: bigint) {895    const originalSpace = await prepare(token, pieces);896897    await expect(898      token.setProperties(alice, [{key: 'non-existent', value: 'I exist!'}]), 899      'on failing to add a previously non-existent property',900    ).to.be.rejectedWith(/common\.NoPermission/);901      902    await expect(903      token.collection.setTokenPropertyPermissions(alice, [{key: 'now-existent', permission: {}}]), 904      'on setting a new non-permitted property',905    ).to.be.fulfilled;906907    await expect(908      token.setProperties(alice, [{key: 'now-existent', value: 'I exist!'}]), 909      'on failing to add a property forbidden by the \'None\' permission',910    ).to.be.rejectedWith(/common\.NoPermission/);911912    expect(await token.getProperties(['non-existent', 'now-existent'])).to.be.empty;913      914    const consumedSpace = await getConsumedSpace(token.collection.helper.api, token.collectionId, token.tokenId, pieces == 1n ? 'NFT' : 'RFT'); 915    expect(consumedSpace).to.be.equal(originalSpace);916  }917918  itSub('Forbids adding properties to a token if the property is not declared / forbidden with the \'None\' permission (NFT)', async ({helper}) =>  {919    const collection = await helper.nft.mintCollection(alice);920    const token = await collection.mintToken(alice);921    await testForbidsAddingPropertiesIfPropertyNotDeclared(token, 1n);922  });923924  itSub.ifWithPallets('Forbids adding properties to a token if the property is not declared / forbidden with the \'None\' permission (ReFungible)', [Pallets.ReFungible], async ({helper}) => {925    const collection = await helper.rft.mintCollection(alice);926    const token = await collection.mintToken(alice, 100n);927    await testForbidsAddingPropertiesIfPropertyNotDeclared(token, 100n);928  });929930  async function testForbidsAddingTooManyProperties(token: UniqueNFToken | UniqueRFToken, pieces: bigint) {931    const originalSpace = await prepare(token, pieces);932933    await expect(934      token.collection.setTokenPropertyPermissions(alice, [935        {key: 'a_holy_book', permission: {collectionAdmin: true, tokenOwner: true}}, 936        {key: 'young_years', permission: {collectionAdmin: true, tokenOwner: true}},937      ]), 938      'on setting new permissions for properties',939    ).to.be.fulfilled;940941    // Mute the general tx parsing error942    {943      console.error = () => {};944      await expect(token.setProperties(alice, [{key: 'a_holy_book', value: 'word '.repeat(6554)}]))945        .to.be.rejected;946    }947948    await expect(token.setProperties(alice, [949      {key: 'a_holy_book', value: 'word '.repeat(3277)}, 950      {key: 'young_years', value: 'neverending'.repeat(1490)},951    ])).to.be.rejectedWith(/common\.NoSpaceForProperty/);952  953    expect(await token.getProperties(['a_holy_book', 'young_years'])).to.be.empty;954    const consumedSpace = await getConsumedSpace(token.collection.helper.api, token.collectionId, token.tokenId, pieces == 1n ? 'NFT' : 'RFT'); 955    expect(consumedSpace).to.be.equal(originalSpace);956  }957958  itSub('Forbids adding too many properties to a token (NFT)', async ({helper}) =>  {959    const collection = await helper.nft.mintCollection(alice);960    const token = await collection.mintToken(alice);961    await testForbidsAddingTooManyProperties(token, 1n);962  });963964  itSub.ifWithPallets('Forbids adding too many properties to a token (ReFungible)', [Pallets.ReFungible], async ({helper}) => {965    const collection = await helper.rft.mintCollection(alice);966    const token = await collection.mintToken(alice, 100n);967    await testForbidsAddingTooManyProperties(token, 100n);968  });969});970971describe('ReFungible token properties permissions tests', () => {972  let alice: IKeyringPair;973  let bob: IKeyringPair;974  let charlie: IKeyringPair;975976  before(async function() {977    await usingPlaygrounds(async (helper, privateKey) => {978      requirePalletsOrSkip(this, helper, [Pallets.ReFungible]);979980      const donor = privateKey('//Alice');981      [alice, bob, charlie] = await helper.arrange.createAccounts([100n, 100n, 100n], donor);982    });983  });984985  async function prepare(helper: UniqueHelper): Promise<UniqueRFToken> {986    const collection = await helper.rft.mintCollection(alice);987    const token = await collection.mintToken(alice, 100n);988    989    await collection.addAdmin(alice, {Substrate: bob.address});990    await collection.setTokenPropertyPermissions(alice, [{key: 'fractals', permission: {mutable: true, tokenOwner: true}}]);991    992    return token;993  }994995  itSub('Forbids adding token property with tokenOwner==true when signer doesn\'t have all pieces', async ({helper}) =>  {996    const token = await prepare(helper);997998    await token.transfer(alice, {Substrate: charlie.address}, 33n);9991000    await expect(token.setProperties(alice, [1001      {key: 'fractals', value: 'multiverse'}, 1002    ])).to.be.rejectedWith(/common\.NoPermission/);1003  });10041005  itSub('Forbids mutating token property with tokenOwher==true when signer doesn\'t have all pieces', async ({helper}) =>  {1006    const token = await prepare(helper);10071008    await expect(token.collection.setTokenPropertyPermissions(alice, [{key: 'fractals', permission: {mutable:true, tokenOwner: true}}]))1009      .to.be.fulfilled;10101011    await expect(token.setProperties(alice, [1012      {key: 'fractals', value: 'multiverse'}, 1013    ])).to.be.fulfilled;10141015    await token.transfer(alice, {Substrate: charlie.address}, 33n);10161017    await expect(token.setProperties(alice, [1018      {key: 'fractals', value: 'want to rule the world'}, 1019    ])).to.be.rejectedWith(/common\.NoPermission/);1020  });10211022  itSub('Forbids deleting token property with tokenOwner==true when signer doesn\'t have all pieces', async ({helper}) =>  {1023    const token = await prepare(helper);10241025    await expect(token.setProperties(alice, [1026      {key: 'fractals', value: 'one headline - why believe it'}, 1027    ])).to.be.fulfilled;10281029    await token.transfer(alice, {Substrate: charlie.address}, 33n);10301031    await expect(token.deleteProperties(alice, ['fractals'])).1032      to.be.rejectedWith(/common\.NoPermission/);1033  });10341035  itSub('Allows token property mutation with collectionOwner==true when admin doesn\'t have all pieces', async ({helper}) =>  {1036    const token = await prepare(helper);10371038    await token.transfer(alice, {Substrate: charlie.address}, 33n);10391040    await expect(token.collection.setTokenPropertyPermissions(alice, [{key: 'fractals', permission: {mutable:true, collectionAdmin: true}}]))1041      .to.be.fulfilled;10421043    await expect(token.setProperties(alice, [1044      {key: 'fractals', value: 'multiverse'}, 1045    ])).to.be.fulfilled;1046  });1047});