`fe21accc75eb`

source

tests/src/eth/collectionProperties.test.ts13.1 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 {itEth, usingEthPlaygrounds, expect, EthUniqueHelper} from './util';18import {Pallets} from '../util';19import {IProperty, ITokenPropertyPermission} from '../util/playgrounds/types';20import {IKeyringPair} from '@polkadot/types/types';21import {TCollectionMode} from '../util/playgrounds/types';2223describe('EVM collection properties', () => {24  let donor: IKeyringPair;25  let alice: IKeyringPair;2627  before(async function() {28    await usingEthPlaygrounds(async (_helper, privateKey) => {29      donor = await privateKey({filename: __filename});30      [alice] = await _helper.arrange.createAccounts([20n], donor);31    });32  });3334  // Soft-deprecated: setCollectionProperty35  [36    {method: 'setCollectionProperties', methodParams: [[{key: 'testKey1', value: Buffer.from('testValue1')}, {key: 'testKey2', value: Buffer.from('testValue2')}]], expectedProps: [{key: 'testKey1', value: 'testValue1'}, {key: 'testKey2', value: 'testValue2'}]}, 37    {method: 'setCollectionProperty', methodParams: ['testKey', Buffer.from('testValue')], expectedProps: [{key: 'testKey', value: 'testValue'}]},38  ].map(testCase => 39    itEth(`Collection properties can be set: ${testCase.method}`, async({helper}) => {40      const caller = await helper.eth.createAccountWithBalance(donor);41      const collection = await helper.nft.mintCollection(alice, {name: 'name', description: 'test', tokenPrefix: 'test', properties: []});42      await collection.addAdmin(alice, {Ethereum: caller});4344      const address = helper.ethAddress.fromCollectionId(collection.collectionId);45      const contract = helper.ethNativeContract.collection(address, 'nft', caller, testCase.method === 'setCollectionProperty');4647      await contract.methods[testCase.method](...testCase.methodParams).send({from: caller});4849      const raw = (await collection.getData())?.raw;50      expect(raw.properties).to.deep.equal(testCase.expectedProps);51    }));5253  itEth('Cannot set invalid properties', async({helper}) => {54    const caller = await helper.eth.createAccountWithBalance(donor);55    const collection = await helper.nft.mintCollection(alice, {name: 'name', description: 'test', tokenPrefix: 'test', properties: []});56    await collection.addAdmin(alice, {Ethereum: caller});5758    const address = helper.ethAddress.fromCollectionId(collection.collectionId);59    const contract = helper.ethNativeContract.collection(address, 'nft', caller);6061    await expect(contract.methods.setCollectionProperties([{key: '', value: Buffer.from('val1')}]).send({from: caller})).to.be.rejected;62    await expect(contract.methods.setCollectionProperties([{key: 'déjà vu', value: Buffer.from('hmm...')}]).send({from: caller})).to.be.rejected;63    await expect(contract.methods.setCollectionProperties([{key: 'a'.repeat(257), value: Buffer.from('val3')}]).send({from: caller})).to.be.rejected;64    // TODO add more expects65    const raw = (await collection.getData())?.raw;66    expect(raw.properties).to.deep.equal([]);67  });686970  // Soft-deprecated: deleteCollectionProperty71  [72    {method: 'deleteCollectionProperties', methodParams: [['testKey1', 'testKey2']], expectedProps: [{key: 'testKey3', value: 'testValue3'}]},73    {method: 'deleteCollectionProperty', methodParams: ['testKey1'], expectedProps: [{key: 'testKey2', value: 'testValue2'}, {key: 'testKey3', value: 'testValue3'}]}, 74  ].map(testCase => 75    itEth(`Collection properties can be deleted: ${testCase.method}`, async({helper}) => {76      const properties = [77        {key: 'testKey1', value: 'testValue1'},78        {key: 'testKey2', value: 'testValue2'},79        {key: 'testKey3', value: 'testValue3'}];80      const caller = await helper.eth.createAccountWithBalance(donor);81      const collection = await helper.nft.mintCollection(alice, {name: 'name', description: 'test', tokenPrefix: 'test', properties});82  83      await collection.addAdmin(alice, {Ethereum: caller});84  85      const address = helper.ethAddress.fromCollectionId(collection.collectionId);86      const contract = helper.ethNativeContract.collection(address, 'nft', caller, testCase.method === 'deleteCollectionProperty');87  88      await contract.methods[testCase.method](...testCase.methodParams).send({from: caller});89  90      const raw = (await collection.getData())?.raw;91  92      expect(raw.properties.length).to.equal(testCase.expectedProps.length);93      expect(raw.properties).to.deep.equal(testCase.expectedProps);94    }));95  96  // TODO cannot delete non-existing props and props of non-owned collections9798  itEth('Can be read', async({helper}) => {99    const caller = helper.eth.createAccount();100    const collection = await helper.nft.mintCollection(alice, {name: 'name', description: 'test', tokenPrefix: 'test', properties: [{key: 'testKey', value: 'testValue'}]});101102    const address = helper.ethAddress.fromCollectionId(collection.collectionId);103    const contract = helper.ethNativeContract.collection(address, 'nft', caller);104105    const value = await contract.methods.collectionProperty('testKey').call();106    expect(value).to.equal(helper.getWeb3().utils.toHex('testValue'));107  });108});109110describe('Supports ERC721Metadata', () => {111  let donor: IKeyringPair;112113  before(async function() {114    await usingEthPlaygrounds(async (_helper, privateKey) => {115      donor = await privateKey({filename: __filename});116    });117  });118119  const checkERC721Metadata = async (helper: EthUniqueHelper, mode: 'nft' | 'rft') => {120    const caller = await helper.eth.createAccountWithBalance(donor);121    const bruh = await helper.eth.createAccountWithBalance(donor);122123    const BASE_URI = 'base/';124    const SUFFIX = 'suffix1';125    const URI = 'uri1';126127    const collectionHelpers = helper.ethNativeContract.collectionHelpers(caller);128    const creatorMethod = mode === 'rft' ? 'createRFTCollection' : 'createNFTCollection';129130    const {collectionId, collectionAddress} = await helper.eth[creatorMethod](caller, 'n', 'd', 'p');131    const bruhCross = helper.ethCrossAccount.fromAddress(bruh);132133    const contract = helper.ethNativeContract.collectionById(collectionId, mode, caller);134    await contract.methods.addCollectionAdminCross(bruhCross).send(); // to check that admin will work too135136    const collection1 = helper.nft.getCollectionObject(collectionId);137    const data1 = await collection1.getData();138    expect(data1?.raw.flags.erc721metadata).to.be.false;139    expect(await contract.methods.supportsInterface('0x5b5e139f').call()).to.be.false;140141    await collectionHelpers.methods.makeCollectionERC721MetadataCompatible(collectionAddress, BASE_URI)142      .send({from: bruh});143144    expect(await contract.methods.supportsInterface('0x5b5e139f').call()).to.be.true;145146    const collection2 = helper.nft.getCollectionObject(collectionId);147    const data2 = await collection2.getData();148    expect(data2?.raw.flags.erc721metadata).to.be.true;149150    const propertyPermissions = data2?.raw.tokenPropertyPermissions;151    expect(propertyPermissions?.length).to.equal(2);152153    expect(propertyPermissions.find((tpp: ITokenPropertyPermission) => {154      return tpp.key === 'URI' && tpp.permission.mutable && tpp.permission.collectionAdmin && !tpp.permission.tokenOwner;155    })).to.be.not.null;156157    expect(propertyPermissions.find((tpp: ITokenPropertyPermission) => {158      return tpp.key === 'URISuffix' && tpp.permission.mutable && tpp.permission.collectionAdmin && !tpp.permission.tokenOwner;159    })).to.be.not.null;160161    expect(data2?.raw.properties?.find((property: IProperty) => {162      return property.key === 'baseURI' && property.value === BASE_URI;163    })).to.be.not.null;164165    const token1Result = await contract.methods.mint(bruh).send();166    const tokenId1 = token1Result.events.Transfer.returnValues.tokenId;167168    expect(await contract.methods.tokenURI(tokenId1).call()).to.equal(BASE_URI);169170    await contract.methods.setProperties(tokenId1, [{key: 'URISuffix', value: Buffer.from(SUFFIX)}]).send();171    expect(await contract.methods.tokenURI(tokenId1).call()).to.equal(BASE_URI + SUFFIX);172173    await contract.methods.setProperties(tokenId1, [{key: 'URI', value: Buffer.from(URI)}]).send();174    expect(await contract.methods.tokenURI(tokenId1).call()).to.equal(URI);175176    await contract.methods.deleteProperties(tokenId1, ['URI']).send();177    expect(await contract.methods.tokenURI(tokenId1).call()).to.equal(BASE_URI + SUFFIX);178179    const token2Result = await contract.methods.mintWithTokenURI(bruh, URI).send();180    const tokenId2 = token2Result.events.Transfer.returnValues.tokenId;181182    expect(await contract.methods.tokenURI(tokenId2).call()).to.equal(URI);183184    await contract.methods.deleteProperties(tokenId2, ['URI']).send();185    expect(await contract.methods.tokenURI(tokenId2).call()).to.equal(BASE_URI);186187    await contract.methods.setProperties(tokenId2, [{key: 'URISuffix', value: Buffer.from(SUFFIX)}]).send();188    expect(await contract.methods.tokenURI(tokenId2).call()).to.equal(BASE_URI + SUFFIX);189  };190191  itEth('ERC721Metadata property can be set for NFT collection', async({helper}) => {192    await checkERC721Metadata(helper, 'nft');193  });194195  itEth.ifWithPallets('ERC721Metadata property can be set for RFT collection', [Pallets.ReFungible], async({helper}) => {196    await checkERC721Metadata(helper, 'rft');197  });198});199200describe('EVM collection property', () => {201  let donor: IKeyringPair;202203  before(async function() {204    await usingEthPlaygrounds(async (_helper, privateKey) => {205      donor = await privateKey({filename: __filename});206    });207  });208209  async function testSetReadProperties(helper: EthUniqueHelper, mode: TCollectionMode) {210    const collection = await helper[mode].mintCollection(donor, {name: 'A', description: 'B', tokenPrefix: 'C'});211212    const sender = await helper.eth.createAccountWithBalance(donor, 100n);213    await collection.addAdmin(donor, {Ethereum: sender});214215    const collectionAddress = helper.ethAddress.fromCollectionId(collection.collectionId);216    const contract = helper.ethNativeContract.collection(collectionAddress, mode, sender);217218    const keys = ['key0', 'key1'];219220    const writeProperties = [221      helper.ethProperty.property(keys[0], 'value0'),222      helper.ethProperty.property(keys[1], 'value1'),223    ];224225    await contract.methods.setCollectionProperties(writeProperties).send();226    const readProperties = await contract.methods.collectionProperties([keys[0], keys[1]]).call();227    expect(readProperties).to.be.like(writeProperties);228  }229230  itEth('Set/read properties ft', async ({helper}) => {231    await testSetReadProperties(helper, 'ft');232  });233  itEth.ifWithPallets('Set/read properties rft', [Pallets.ReFungible], async ({helper}) => {234    await testSetReadProperties(helper, 'rft');235  });236  itEth('Set/read properties nft', async ({helper}) => {237    await testSetReadProperties(helper, 'nft');238  });239240  async function testDeleteProperties(helper: EthUniqueHelper, mode: TCollectionMode) {241    const collection = await helper[mode].mintCollection(donor, {name: 'A', description: 'B', tokenPrefix: 'C'});242243    const sender = await helper.eth.createAccountWithBalance(donor, 100n);244    await collection.addAdmin(donor, {Ethereum: sender});245246    const collectionAddress = helper.ethAddress.fromCollectionId(collection.collectionId);247    const contract = helper.ethNativeContract.collection(collectionAddress, mode, sender);248249    const keys = ['key0', 'key1', 'key2', 'key3'];250251    {252      const writeProperties = [253        helper.ethProperty.property(keys[0], 'value0'),254        helper.ethProperty.property(keys[1], 'value1'),255        helper.ethProperty.property(keys[2], 'value2'),256        helper.ethProperty.property(keys[3], 'value3'),257      ];258259      await contract.methods.setCollectionProperties(writeProperties).send();260      const readProperties = await contract.methods.collectionProperties([keys[0], keys[1], keys[2], keys[3]]).call();261      expect(readProperties).to.be.like(writeProperties);262    }263264    {265      const expectProperties = [266        helper.ethProperty.property(keys[0], 'value0'),267        helper.ethProperty.property(keys[1], 'value1'),268      ];269270      await contract.methods.deleteCollectionProperties([keys[2], keys[3]]).send();271      const readProperties = await contract.methods.collectionProperties([]).call();272      expect(readProperties).to.be.like(expectProperties);273    }274  }275  276  itEth('Delete properties ft', async ({helper}) => {277    await testDeleteProperties(helper, 'ft');278  });279  itEth.ifWithPallets('Delete properties rft', [Pallets.ReFungible], async ({helper}) => {280    await testDeleteProperties(helper, 'rft');281  });282  itEth('Delete properties nft', async ({helper}) => {283    await testDeleteProperties(helper, 'nft');284  });285    286});