`f780ed94ecfd`

source

tests/src/nesting/collectionProperties.test.ts12.2 KiBsource history
1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// This file is part of Unique Network.34// Unique Network is free software: you can redistribute it and/or modify5// it under the terms of the GNU General Public License as published by6// the Free Software Foundation, either version 3 of the License, or7// (at your option) any later version.89// Unique Network is distributed in the hope that it will be useful,10// but WITHOUT ANY WARRANTY; without even the implied warranty of11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the12// GNU General Public License for more details.1314// You should have received a copy of the GNU General Public License15// along with Unique Network. If not, see <http://www.gnu.org/licenses/>.1617import {IKeyringPair} from '@polkadot/types/types';18import {itSub, Pallets, usingPlaygrounds, expect} from '../util';19import {UniqueBaseCollection} from '../util/playgrounds/unique';2021describe('Integration Test: Collection Properties', () => {22  let alice: IKeyringPair;23  let bob: IKeyringPair;24  25  before(async () => {26    await usingPlaygrounds(async (helper, privateKey) => {27      const donor = await privateKey({filename: __filename});28      [alice, bob] = await helper.arrange.createAccounts([100n, 10n], donor);29    });30  });31  32  itSub('Properties are initially empty', async ({helper}) => {33    const collection = await helper.nft.mintCollection(alice);34    expect(await collection.getProperties()).to.be.empty;35  });36  37  async function testSetsPropertiesForCollection(collection: UniqueBaseCollection) {38    // As owner39    await expect(collection.setProperties(alice, [{key: 'electron', value: 'come bond'}])).to.be.fulfilled;40  41    await collection.addAdmin(alice, {Substrate: bob.address});42  43    // As administrator44    await expect(collection.setProperties(bob, [{key: 'black_hole'}])).to.be.fulfilled;45  46    const properties = await collection.getProperties();47    expect(properties).to.include.deep.members([48      {key: 'electron', value: 'come bond'},49      {key: 'black_hole', value: ''},50    ]);51  }52  53  itSub('Sets properties for a NFT collection', async ({helper}) =>  {54    await testSetsPropertiesForCollection(await helper.nft.mintCollection(alice));55  });56  57  itSub.ifWithPallets('Sets properties for a ReFungible collection', [Pallets.ReFungible], async ({helper}) => {58    await testSetsPropertiesForCollection(await helper.rft.mintCollection(alice));59  });60  61  async function testCheckValidNames(collection: UniqueBaseCollection) {62    // alpha symbols63    await expect(collection.setProperties(alice, [{key: 'answer'}])).to.be.fulfilled;64  65    // numeric symbols66    await expect(collection.setProperties(alice, [{key: '451'}])).to.be.fulfilled;67  68    // underscore symbol69    await expect(collection.setProperties(alice, [{key: 'black_hole'}])).to.be.fulfilled;70  71    // dash symbol72    await expect(collection.setProperties(alice, [{key: '-'}])).to.be.fulfilled;73  74    // dot symbol75    await expect(collection.setProperties(alice, [{key: 'once.in.a.long.long.while...', value: 'you get a little lost'}])).to.be.fulfilled;76  77    const properties = await collection.getProperties();78    expect(properties).to.include.deep.members([79      {key: 'answer', value: ''},80      {key: '451', value: ''},81      {key: 'black_hole', value: ''},82      {key: '-', value: ''},83      {key: 'once.in.a.long.long.while...', value: 'you get a little lost'},84    ]);85  }86  87  itSub('Check valid names for NFT collection properties keys', async ({helper}) =>  {88    await testCheckValidNames(await helper.nft.mintCollection(alice));89  });90  91  itSub.ifWithPallets('Check valid names for ReFungible collection properties keys', [Pallets.ReFungible], async ({helper}) => {92    await testCheckValidNames(await helper.rft.mintCollection(alice));93  });94  95  async function testChangesProperties(collection: UniqueBaseCollection) {96    await expect(collection.setProperties(alice, [{key: 'electron', value: 'come bond'}, {key: 'black_hole', value: ''}])).to.be.fulfilled;97  98    // Mutate the properties99    await expect(collection.setProperties(alice, [{key: 'black_hole', value: 'LIGO'}])).to.be.fulfilled;100  101    const properties = await collection.getProperties();102    expect(properties).to.include.deep.members([103      {key: 'electron', value: 'come bond'},104      {key: 'black_hole', value: 'LIGO'},105    ]);106  }107  108  itSub('Changes properties of a NFT collection', async ({helper}) =>  {109    await testChangesProperties(await helper.nft.mintCollection(alice));110  });111  112  itSub.ifWithPallets('Changes properties of a ReFungible collection', [Pallets.ReFungible], async ({helper}) => {113    await testChangesProperties(await helper.rft.mintCollection(alice));114  });115  116  async function testDeleteProperties(collection: UniqueBaseCollection) {117    await expect(collection.setProperties(alice, [{key: 'electron', value: 'come bond'}, {key: 'black_hole', value: 'LIGO'}])).to.be.fulfilled;118  119    await expect(collection.deleteProperties(alice, ['electron'])).to.be.fulfilled;120  121    const properties = await collection.getProperties(['black_hole', 'electron']);122    expect(properties).to.be.deep.equal([123      {key: 'black_hole', value: 'LIGO'},124    ]);125  }126  127  itSub('Deletes properties of a NFT collection', async ({helper}) =>  {128    await testDeleteProperties(await helper.nft.mintCollection(alice));129  });130  131  itSub.ifWithPallets('Deletes properties of a ReFungible collection', [Pallets.ReFungible], async ({helper}) => {132    await testDeleteProperties(await helper.rft.mintCollection(alice));133  });134135  [136    {mode: 'nft' as const, requiredPallets: []},137    {mode: 'rft' as const, requiredPallets: [Pallets.ReFungible]}, 138  ].map(testCase =>139    itSub.ifWithPallets(`Allows modifying a collection property multiple times (${testCase.mode})`, testCase.requiredPallets, async({helper}) => {140      const propKey = 'tok-prop';141142      const collection = await helper[testCase.mode].mintCollection(alice);143144      const maxCollectionPropertiesSize = 40960;145146      const propDataSize = 4096;147148      let propDataChar = 'a';149      const makeNewPropData = () => {150        propDataChar = String.fromCharCode(propDataChar.charCodeAt(0) + 1);151        return `${propDataChar}`.repeat(propDataSize);152      };153154      await collection.setProperties(alice, [{key: propKey, value: makeNewPropData()}]);155      const originalSpace = await collection.getPropertiesConsumedSpace();156      expect(originalSpace).to.be.equal(propDataSize);157158      const sameSizePropertiesPossibleNum = maxCollectionPropertiesSize / propDataSize;159160      // It is possible to modify a property as many times as needed.161      // It will not consume any additional space.162      for (let i = 0; i < sameSizePropertiesPossibleNum + 1; i++) {163        await collection.setProperties(alice, [{key: propKey, value: makeNewPropData()}]);164        const consumedSpace = await collection.getPropertiesConsumedSpace();165        expect(consumedSpace).to.be.equal(originalSpace);166      }167    }));168});169  170describe('Negative Integration Test: Collection Properties', () => {171  let alice: IKeyringPair;172  let bob: IKeyringPair;173  174  before(async () => {175    await usingPlaygrounds(async (helper, privateKey) => {176      const donor = await privateKey({filename: __filename});177      [alice, bob] = await helper.arrange.createAccounts([100n, 10n], donor);178    });179  });180    181  async function testFailsSetPropertiesIfNotOwnerOrAdmin(collection: UniqueBaseCollection) {  182    await expect(collection.setProperties(bob, [{key: 'electron', value: 'come bond'}, {key: 'black_hole', value: 'LIGO'}]))183      .to.be.rejectedWith(/common\.NoPermission/);184  185    expect(await collection.getProperties()).to.be.empty;186  }187  188  itSub('Fails to set properties in a NFT collection if not its onwer/administrator', async ({helper}) =>  {189    await testFailsSetPropertiesIfNotOwnerOrAdmin(await helper.nft.mintCollection(alice));190  });191  192  itSub.ifWithPallets('Fails to set properties in a ReFungible collection if not its onwer/administrator', [Pallets.ReFungible], async ({helper}) => {193    await testFailsSetPropertiesIfNotOwnerOrAdmin(await helper.rft.mintCollection(alice));194  });195    196  async function testFailsSetPropertiesThatExeedLimits(collection: UniqueBaseCollection) {197    const spaceLimit = (await (collection.helper!.api! as any).query.common.collectionProperties(collection.collectionId)).spaceLimit.toNumber();198    199    // Mute the general tx parsing error, too many bytes to process200    {201      console.error = () => {};202      await expect(collection.setProperties(alice, [203        {key: 'electron', value: 'low high '.repeat(Math.ceil(spaceLimit! / 9))},204      ])).to.be.rejected;205    }206  207    expect(await collection.getProperties(['electron'])).to.be.empty;208  209    await expect(collection.setProperties(alice, [210      {key: 'electron', value: 'low high '.repeat(Math.ceil(spaceLimit! / 18))}, 211      {key: 'black_hole', value: '0'.repeat(Math.ceil(spaceLimit! / 2))}, 212    ])).to.be.rejectedWith(/common\.NoSpaceForProperty/);213  214    expect(await collection.getProperties(['electron', 'black_hole'])).to.be.empty;215  }216  217  itSub('Fails to set properties that exceed the limits (NFT)', async ({helper}) =>  {218    await testFailsSetPropertiesThatExeedLimits(await helper.nft.mintCollection(alice));219  });220  221  itSub.ifWithPallets('Fails to set properties that exceed the limits (ReFungible)', [Pallets.ReFungible], async ({helper}) => {222    await testFailsSetPropertiesThatExeedLimits(await helper.rft.mintCollection(alice));223  });224    225  async function testFailsSetMorePropertiesThanAllowed(collection: UniqueBaseCollection) {226    const propertiesToBeSet = [];227    for (let i = 0; i < 65; i++) {228      propertiesToBeSet.push({229        key: 'electron_' + i,230        value: Math.random() > 0.5 ? 'high' : 'low',231      });232    }233  234    await expect(collection.setProperties(alice, propertiesToBeSet)).235      to.be.rejectedWith(/common\.PropertyLimitReached/);236  237    expect(await collection.getProperties()).to.be.empty;238  }239  240  itSub('Fails to set more properties than it is allowed (NFT)', async ({helper}) =>  {241    await testFailsSetMorePropertiesThanAllowed(await helper.nft.mintCollection(alice));242  });243  244  itSub.ifWithPallets('Fails to set more properties than it is allowed (ReFungible)', [Pallets.ReFungible], async ({helper}) => {245    await testFailsSetMorePropertiesThanAllowed(await helper.rft.mintCollection(alice));246  });247    248  async function testFailsSetPropertiesWithInvalidNames(collection: UniqueBaseCollection) {249    const invalidProperties = [250      [{key: 'electron', value: 'negative'}, {key: 'string theory', value: 'understandable'}],251      [{key: 'Mr/Sandman', value: 'Bring me a gene'}],252      [{key: 'déjà vu', value: 'hmm...'}],253    ];254  255    for (let i = 0; i < invalidProperties.length; i++) {256      await expect(257        collection.setProperties(alice, invalidProperties[i]), 258        `on rejecting the new badly-named property #${i}`,259      ).to.be.rejectedWith(/common\.InvalidCharacterInPropertyKey/);260    }261  262    await expect(263      collection.setProperties(alice, [{key: '', value: 'nothing must not exist'}]), 264      'on rejecting an unnamed property',265    ).to.be.rejectedWith(/common\.EmptyPropertyKey/);266  267    await expect(268      collection.setProperties(alice, [{key: 'CRISPR-Cas9', value: 'rewriting nature!'}]), 269      'on setting the correctly-but-still-badly-named property',270    ).to.be.fulfilled;271  272    const keys = invalidProperties.flatMap(propertySet => propertySet.map(property => property.key)).concat('CRISPR-Cas9').concat('');273  274    const properties = await collection.getProperties(keys);275    expect(properties).to.be.deep.equal([276      {key: 'CRISPR-Cas9', value: 'rewriting nature!'},277    ]);278  279    for (let i = 0; i < invalidProperties.length; i++) {280      await expect(281        collection.deleteProperties(alice, invalidProperties[i].map(propertySet => propertySet.key)), 282        `on trying to delete the non-existent badly-named property #${i}`,283      ).to.be.rejectedWith(/common\.InvalidCharacterInPropertyKey/);284    }285  }286  287  itSub('Fails to set properties with invalid names (NFT)', async ({helper}) =>  {288    await testFailsSetPropertiesWithInvalidNames(await helper.nft.mintCollection(alice));289  });290  291  itSub.ifWithPallets('Fails to set properties with invalid names (ReFungible)', [Pallets.ReFungible], async ({helper}) => {292    await testFailsSetPropertiesWithInvalidNames(await helper.rft.mintCollection(alice));293  });294});295