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

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 {Contract} from 'web3-eth-contract';19import {itEth, usingEthPlaygrounds, expect} from './util';20import {ITokenPropertyPermission} from '../util/playgrounds/types';21import {Pallets} from '../util';22import {UniqueNFTCollection, UniqueNFToken, UniqueRFTCollection} from '../util/playgrounds/unique';23import {EthTokenPermissions} from './util/playgrounds/types';2425describe('EVM token properties', () => {26  let donor: IKeyringPair;27  let alice: IKeyringPair;2829  before(async function() {30    await usingEthPlaygrounds(async (helper, privateKey) => {31      donor = await privateKey({filename: __filename});32      [alice] = await helper.arrange.createAccounts([100n], donor);33    });34  });3536  [37    {mode: 'nft' as const, requiredPallets: []},38    {mode: 'rft' as const, requiredPallets: [Pallets.ReFungible]},39  ].map(testCase =>40    itEth.ifWithPallets(`[${testCase.mode}] Set and get token property permissions`, testCase.requiredPallets, async({helper}) => {41      const owner = await helper.eth.createAccountWithBalance(donor);42      const caller = await helper.ethCrossAccount.createAccountWithBalance(donor);43      for(const [mutable,collectionAdmin, tokenOwner] of cartesian([], [false, true], [false, true], [false, true])) {44        const {collectionId, collectionAddress} = await helper.eth.createCollection(testCase.mode, owner, 'A', 'B', 'C');45        const collection = await helper.ethNativeContract.collection(collectionAddress, testCase.mode, owner);46        await collection.methods.addCollectionAdminCross(caller).send({from: owner});4748        await collection.methods.setTokenPropertyPermissions([49          ['testKey', [50            [EthTokenPermissions.Mutable, mutable], 51            [EthTokenPermissions.TokenOwner, tokenOwner], 52            [EthTokenPermissions.CollectionAdmin, collectionAdmin]],53          ],54        ]).send({from: caller.eth});55      56        expect(await helper[testCase.mode].getPropertyPermissions(collectionId)).to.be.deep.equal([{57          key: 'testKey',58          permission: {mutable, collectionAdmin, tokenOwner},59        }]);6061        expect(await collection.methods.tokenPropertyPermissions().call({from: caller.eth})).to.be.like([62          ['testKey', [63            [EthTokenPermissions.Mutable.toString(), mutable], 64            [EthTokenPermissions.TokenOwner.toString(), tokenOwner], 65            [EthTokenPermissions.CollectionAdmin.toString(), collectionAdmin]],66          ],67        ]);68      }69    }));7071  [72    {mode: 'nft' as const, requiredPallets: []},73    {mode: 'rft' as const, requiredPallets: [Pallets.ReFungible]},74  ].map(testCase =>75    itEth.ifWithPallets(`[${testCase.mode}] Set and get multiple token property permissions as owner`, testCase.requiredPallets, async({helper}) => {76      const owner = await helper.eth.createAccountWithBalance(donor);77      78      const {collectionId, collectionAddress} = await helper.eth.createCollection(testCase.mode, owner, 'A', 'B', 'C');79      const collection = await helper.ethNativeContract.collection(collectionAddress, testCase.mode, owner);8081      await collection.methods.setTokenPropertyPermissions([82        ['testKey_0', [83          [EthTokenPermissions.Mutable, true], 84          [EthTokenPermissions.TokenOwner, true], 85          [EthTokenPermissions.CollectionAdmin, true]],86        ],87        ['testKey_1', [88          [EthTokenPermissions.Mutable, true], 89          [EthTokenPermissions.TokenOwner, false], 90          [EthTokenPermissions.CollectionAdmin, true]],91        ],92        ['testKey_2', [93          [EthTokenPermissions.Mutable, false], 94          [EthTokenPermissions.TokenOwner, true], 95          [EthTokenPermissions.CollectionAdmin, false]],96        ],97      ]).send({from: owner});98      99      expect(await helper[testCase.mode].getPropertyPermissions(collectionId)).to.be.deep.equal([100        {101          key: 'testKey_0',102          permission: {mutable: true, tokenOwner: true, collectionAdmin: true},103        },104        {105          key: 'testKey_1',106          permission: {mutable: true, tokenOwner: false, collectionAdmin: true},107        },108        {109          key: 'testKey_2',110          permission: {mutable: false, tokenOwner: true, collectionAdmin: false},111        },112      ]);113114      expect(await collection.methods.tokenPropertyPermissions().call({from: owner})).to.be.like([115        ['testKey_0', [116          [EthTokenPermissions.Mutable.toString(), true], 117          [EthTokenPermissions.TokenOwner.toString(), true], 118          [EthTokenPermissions.CollectionAdmin.toString(), true]],119        ],120        ['testKey_1', [121          [EthTokenPermissions.Mutable.toString(), true], 122          [EthTokenPermissions.TokenOwner.toString(), false], 123          [EthTokenPermissions.CollectionAdmin.toString(), true]],124        ],125        ['testKey_2', [126          [EthTokenPermissions.Mutable.toString(), false], 127          [EthTokenPermissions.TokenOwner.toString(), true], 128          [EthTokenPermissions.CollectionAdmin.toString(), false]],129        ],130      ]);131      132    }));133134  [135    {mode: 'nft' as const, requiredPallets: []},136    {mode: 'rft' as const, requiredPallets: [Pallets.ReFungible]},137  ].map(testCase =>138    itEth.ifWithPallets(`[${testCase.mode}] Set and get multiple token property permissions as admin`, testCase.requiredPallets, async({helper}) => {139      const owner = await helper.eth.createAccountWithBalance(donor);140      const caller = await helper.ethCrossAccount.createAccountWithBalance(donor);141      142      const {collectionId, collectionAddress} = await helper.eth.createCollection(testCase.mode, owner, 'A', 'B', 'C');143      const collection = await helper.ethNativeContract.collection(collectionAddress, testCase.mode, owner);144      await collection.methods.addCollectionAdminCross(caller).send({from: owner});145146      await collection.methods.setTokenPropertyPermissions([147        ['testKey_0', [148          [EthTokenPermissions.Mutable, true], 149          [EthTokenPermissions.TokenOwner, true], 150          [EthTokenPermissions.CollectionAdmin, true]],151        ],152        ['testKey_1', [153          [EthTokenPermissions.Mutable, true], 154          [EthTokenPermissions.TokenOwner, false], 155          [EthTokenPermissions.CollectionAdmin, true]],156        ],157        ['testKey_2', [158          [EthTokenPermissions.Mutable, false], 159          [EthTokenPermissions.TokenOwner, true], 160          [EthTokenPermissions.CollectionAdmin, false]],161        ],162      ]).send({from: caller.eth});163      164      expect(await helper[testCase.mode].getPropertyPermissions(collectionId)).to.be.deep.equal([165        {166          key: 'testKey_0',167          permission: {mutable: true, tokenOwner: true, collectionAdmin: true},168        },169        {170          key: 'testKey_1',171          permission: {mutable: true, tokenOwner: false, collectionAdmin: true},172        },173        {174          key: 'testKey_2',175          permission: {mutable: false, tokenOwner: true, collectionAdmin: false},176        },177      ]);178179      expect(await collection.methods.tokenPropertyPermissions().call({from: caller.eth})).to.be.like([180        ['testKey_0', [181          [EthTokenPermissions.Mutable.toString(), true], 182          [EthTokenPermissions.TokenOwner.toString(), true], 183          [EthTokenPermissions.CollectionAdmin.toString(), true]],184        ],185        ['testKey_1', [186          [EthTokenPermissions.Mutable.toString(), true], 187          [EthTokenPermissions.TokenOwner.toString(), false], 188          [EthTokenPermissions.CollectionAdmin.toString(), true]],189        ],190        ['testKey_2', [191          [EthTokenPermissions.Mutable.toString(), false], 192          [EthTokenPermissions.TokenOwner.toString(), true], 193          [EthTokenPermissions.CollectionAdmin.toString(), false]],194        ],195      ]);196      197    }));198199  [200    {201      method: 'setProperties',202      methodParams: [[{key: 'testKey1', value: Buffer.from('testValue1')}, {key: 'testKey2', value: Buffer.from('testValue2')}]],203      expectedProps: [{key: 'testKey1', value: 'testValue1'}, {key: 'testKey2', value: 'testValue2'}],204    },205    {206      method: 'setProperty' /*Soft-deprecated*/, 207      methodParams: ['testKey1', Buffer.from('testValue1')],208      expectedProps: [{key: 'testKey1', value: 'testValue1'}],209    },210  ].map(testCase => 211    itEth(`[${testCase.method}] Can be set`, async({helper}) => {212      const caller = await helper.eth.createAccountWithBalance(donor);213      const collection = await helper.nft.mintCollection(alice, {214        tokenPropertyPermissions: [{215          key: 'testKey1',216          permission: {217            collectionAdmin: true,218          },219        }, {220          key: 'testKey2',221          permission: {222            collectionAdmin: true,223          },224        }],225      });226227      await collection.addAdmin(alice, {Ethereum: caller});228      const token = await collection.mintToken(alice);229  230      const collectionEvm = helper.ethNativeContract.collectionById(collection.collectionId, 'nft', caller, testCase.method === 'setProperty');231  232      await collectionEvm.methods[testCase.method](token.tokenId, ...testCase.methodParams).send({from: caller});233  234      const properties = await token.getProperties();235      expect(properties).to.deep.equal(testCase.expectedProps);236    }));237  238  [239    {mode: 'nft' as const, requiredPallets: []},240    {mode: 'rft' as const, requiredPallets: [Pallets.ReFungible]},241  ].map(testCase => 242    itEth.ifWithPallets(`Can be multiple set/read for ${testCase.mode}`, testCase.requiredPallets, async({helper}) => {243      const caller = await helper.eth.createAccountWithBalance(donor);244      245      const properties = Array(5).fill(0).map((_, i) => { return {key: `key_${i}`, value: Buffer.from(`value_${i}`)}; });246      const permissions: ITokenPropertyPermission[] = properties.map(p => { return {key: p.key, permission: {tokenOwner: true,247        collectionAdmin: true,248        mutable: true}}; });249      250      const collection = await helper[testCase.mode].mintCollection(alice, {251        tokenPrefix: 'ethp',252        tokenPropertyPermissions: permissions,253      }) as UniqueNFTCollection | UniqueRFTCollection;254      255      const token = await collection.mintToken(alice);256      257      const valuesBefore = await token.getProperties(properties.map(p => p.key));258      expect(valuesBefore).to.be.deep.equal([]);259      260      261      await collection.addAdmin(alice, {Ethereum: caller});262      263      const address = helper.ethAddress.fromCollectionId(collection.collectionId);264      const contract = helper.ethNativeContract.collection(address, testCase.mode, caller);265      266      expect(await contract.methods.properties(token.tokenId, []).call()).to.be.deep.equal([]);267  268      await contract.methods.setProperties(token.tokenId, properties).send({from: caller});269  270      const values = await token.getProperties(properties.map(p => p.key));271      expect(values).to.be.deep.equal(properties.map(p => { return {key: p.key, value: p.value.toString()}; }));272      273      expect(await contract.methods.properties(token.tokenId, []).call()).to.be.like(properties274        .map(p => { return helper.ethProperty.property(p.key, p.value.toString()); }));275      276      expect(await contract.methods.properties(token.tokenId, [properties[0].key]).call())277        .to.be.like([helper.ethProperty.property(properties[0].key, properties[0].value.toString())]);278    }));279  280  [281    {mode: 'nft' as const, requiredPallets: []},282    {mode: 'rft' as const, requiredPallets: [Pallets.ReFungible]},283  ].map(testCase => 284    itEth.ifWithPallets(`Can be deleted for ${testCase.mode}`, testCase.requiredPallets, async({helper}) => {285      const caller = await helper.eth.createAccountWithBalance(donor);286      const collection = await helper[testCase.mode].mintCollection(alice, {287        tokenPropertyPermissions: [{288          key: 'testKey',289          permission: {290            mutable: true,291            collectionAdmin: true,292          },293        },294        {295          key: 'testKey_1',296          permission: {297            mutable: true,298            collectionAdmin: true,299          },300        }],301      });302    303      const token = await collection.mintToken(alice);304      await token.setProperties(alice, [{key: 'testKey', value: 'testValue'}, {key: 'testKey_1', value: 'testValue_1'}]);305      expect(await token.getProperties()).to.has.length(2);306307      await collection.addAdmin(alice, {Ethereum: caller});308309      const address = helper.ethAddress.fromCollectionId(collection.collectionId);310      const contract = helper.ethNativeContract.collection(address, testCase.mode, caller);311312      await contract.methods.deleteProperties(token.tokenId, ['testKey', 'testKey_1']).send({from: caller});313314      const result = await token.getProperties(['testKey', 'testKey_1']);315      expect(result.length).to.equal(0);316    }));317318  itEth('Can be read', async({helper}) => {319    const caller = helper.eth.createAccount();320    const collection = await helper.nft.mintCollection(alice, {321      tokenPropertyPermissions: [{322        key: 'testKey',323        permission: {324          collectionAdmin: true,325        },326      }],327    });328  329    const token = await collection.mintToken(alice);330    await token.setProperties(alice, [{key: 'testKey', value: 'testValue'}]);331332    const address = helper.ethAddress.fromCollectionId(collection.collectionId);333    const contract = helper.ethNativeContract.collection(address, 'nft', caller);334335    const value = await contract.methods.property(token.tokenId, 'testKey').call();336    expect(value).to.equal(helper.getWeb3().utils.toHex('testValue'));337  });338});339340describe('EVM token properties negative', () => {341  let donor: IKeyringPair;342  let alice: IKeyringPair;343  let caller: string;344  let aliceCollection: UniqueNFTCollection;345  let token: UniqueNFToken;346  const tokenProps = [{key: 'testKey_1', value: 'testValue_1'}, {key: 'testKey_2', value: 'testValue_2'}];347  let collectionEvm: Contract;348349  before(async function() {350    await usingEthPlaygrounds(async (helper, privateKey) => {351      donor = await privateKey({filename: __filename});352      [alice] = await helper.arrange.createAccounts([100n], donor);353    });354  });355356  beforeEach(async () => {357    // 1. create collection with props: testKey_1, testKey_2358    // 2. create token and set props testKey_1, testKey_2359    await usingEthPlaygrounds(async (helper) => {360      aliceCollection = await helper.nft.mintCollection(alice, {361        tokenPropertyPermissions: [{362          key: 'testKey_1',363          permission: {364            mutable: true,365            collectionAdmin: true,366          },367        },368        {369          key: 'testKey_2',370          permission: {371            mutable: true,372            collectionAdmin: true,373          },374        }],375      }); 376      token = await aliceCollection.mintToken(alice);377      await token.setProperties(alice, tokenProps);378      collectionEvm = helper.ethNativeContract.collection(helper.ethAddress.fromCollectionId(aliceCollection.collectionId), 'nft', caller, true);379    });380  });381382  [383    {method: 'setProperty', methodParams: [tokenProps[1].key, Buffer.from('newValue')]},384    {method: 'setProperties', methodParams: [[{key: tokenProps[1].key, value: Buffer.from('newValue')}]]},385  ].map(testCase =>386    itEth(`[${testCase.method}] Cannot set properties of non-owned collection`, async ({helper}) => {387      caller = await helper.eth.createAccountWithBalance(donor);388      collectionEvm = helper.ethNativeContract.collection(helper.ethAddress.fromCollectionId(aliceCollection.collectionId), 'nft', caller, true);389      // Caller not an owner and not an admin, so he cannot set properties:390      await expect(collectionEvm.methods[testCase.method](token.tokenId, ...testCase.methodParams).call({from: caller})).to.be.rejectedWith('NoPermission');391      await expect(collectionEvm.methods[testCase.method](token.tokenId, ...testCase.methodParams).send({from: caller})).to.be.rejected;392393      // Props have not changed:394      const expectedProps = tokenProps.map(p => helper.ethProperty.property(p.key, p.value.toString()));395      const actualProps = await collectionEvm.methods.properties(token.tokenId, []).call();396      expect(actualProps).to.deep.eq(expectedProps);397    }));398399  [400    {method: 'setProperty', methodParams: ['testKey_3', Buffer.from('testValue3')]},401    {method: 'setProperties', methodParams: [[{key: 'testKey_3', value: Buffer.from('testValue3')}]]},402  ].map(testCase =>403    itEth(`[${testCase.method}] Cannot set non-existing properties`, async ({helper}) => {404      caller = await helper.eth.createAccountWithBalance(donor);405      collectionEvm = helper.ethNativeContract.collection(helper.ethAddress.fromCollectionId(aliceCollection.collectionId), 'nft', caller, true);406      await helper.collection.addAdmin(alice, aliceCollection.collectionId, {Ethereum: caller});407408      await expect(collectionEvm.methods[testCase.method](token.tokenId, ...testCase.methodParams).call({from: caller})).to.be.rejectedWith('NoPermission');409      await expect(collectionEvm.methods[testCase.method](token.tokenId, ...testCase.methodParams).send({from: caller})).to.be.rejected;410411      // Props have not changed:412      const expectedProps = tokenProps.map(p => helper.ethProperty.property(p.key, p.value.toString()));413      const actualProps = await collectionEvm.methods.properties(token.tokenId, []).call();414      expect(actualProps).to.deep.eq(expectedProps);415    }));416417  [418    {method: 'deleteProperty', methodParams: ['testKey_2']},419    {method: 'deleteProperties', methodParams: [['testKey_2']]},420  ].map(testCase =>  421    itEth(`[${testCase.method}] Cannot delete properties of non-owned collection`, async ({helper}) => {422      caller = await helper.eth.createAccountWithBalance(donor);423      collectionEvm = helper.ethNativeContract.collection(helper.ethAddress.fromCollectionId(aliceCollection.collectionId), 'nft', caller, testCase.method == 'deleteProperty');424      // Caller not an owner and not an admin, so he cannot set properties:425      await expect(collectionEvm.methods[testCase.method](token.tokenId, ...testCase.methodParams).call({from: caller})).to.be.rejectedWith('NoPermission');426      await expect(collectionEvm.methods[testCase.method](token.tokenId, ...testCase.methodParams).send({from: caller})).to.be.rejected;427428      // Props have not changed:429      const expectedProps = tokenProps.map(p => helper.ethProperty.property(p.key, p.value.toString()));430      const actualProps = await collectionEvm.methods.properties(token.tokenId, []).call();431      expect(actualProps).to.deep.eq(expectedProps);432    }));433   434  [435    {method: 'deleteProperty', methodParams: ['testKey_3']},436    {method: 'deleteProperties', methodParams: [['testKey_3']]},437  ].map(testCase =>  438    itEth(`[${testCase.method}] Cannot delete non-existing properties`, async ({helper}) => {439      caller = await helper.eth.createAccountWithBalance(donor);440      collectionEvm = helper.ethNativeContract.collection(helper.ethAddress.fromCollectionId(aliceCollection.collectionId), 'nft', caller, testCase.method == 'deleteProperty');441      await helper.collection.addAdmin(alice, aliceCollection.collectionId, {Ethereum: caller});442      // Caller cannot delete non-existing properties:443      await expect(collectionEvm.methods[testCase.method](token.tokenId, ...testCase.methodParams).call({from: caller})).to.be.rejectedWith('NoPermission');444      await expect(collectionEvm.methods[testCase.method](token.tokenId, ...testCase.methodParams).send({from: caller})).to.be.rejected;445      // Props have not changed:446      const expectedProps = tokenProps.map(p => helper.ethProperty.property(p.key, p.value.toString()));447      const actualProps = await collectionEvm.methods.properties(token.tokenId, []).call();448      expect(actualProps).to.deep.eq(expectedProps);449    }));450451  [452    {mode: 'nft' as const, requiredPallets: []},453    {mode: 'rft' as const, requiredPallets: [Pallets.ReFungible]},454  ].map(testCase =>455    itEth.ifWithPallets(`[${testCase.mode}] Cant set token property permissions as non owner or admin`, testCase.requiredPallets, async({helper}) => {456      const owner = await helper.eth.createAccountWithBalance(donor);457      const caller = await helper.eth.createAccountWithBalance(donor);458        459      const {collectionAddress} = await helper.eth.createCollection(testCase.mode, owner, 'A', 'B', 'C');460      const collection = await helper.ethNativeContract.collection(collectionAddress, testCase.mode, owner);461  462      await expect(collection.methods.setTokenPropertyPermissions([463        ['testKey_0', [464          [EthTokenPermissions.Mutable, true], 465          [EthTokenPermissions.TokenOwner, true], 466          [EthTokenPermissions.CollectionAdmin, true]],467        ],468      ]).call({from: caller})).to.be.rejectedWith('NoPermission');  469    }));470471  [472    {mode: 'nft' as const, requiredPallets: []},473    {mode: 'rft' as const, requiredPallets: [Pallets.ReFungible]},474  ].map(testCase =>475    itEth.ifWithPallets(`[${testCase.mode}] Cant set token property permissions with invalid character`, testCase.requiredPallets, async({helper}) => {476      const owner = await helper.eth.createAccountWithBalance(donor);477        478      const {collectionAddress} = await helper.eth.createCollection(testCase.mode, owner, 'A', 'B', 'C');479      const collection = await helper.ethNativeContract.collection(collectionAddress, testCase.mode, owner);480  481      await expect(collection.methods.setTokenPropertyPermissions([482        // "Space" is invalid character483        ['testKey 0', [484          [EthTokenPermissions.Mutable, true], 485          [EthTokenPermissions.TokenOwner, true], 486          [EthTokenPermissions.CollectionAdmin, true]],487        ],488      ]).call({from: owner})).to.be.rejectedWith('InvalidCharacterInPropertyKey');  489    }));490  491});492493494type ElementOf<A> = A extends readonly (infer T)[] ? T : never;495function* cartesian<T extends Array<Array<any>>, R extends Array<any>>(internalRest: [...R], ...args: [...T]): Generator<[...R, ...{[K in keyof T]: ElementOf<T[K]>}]> {496  if(args.length === 0) {497    yield internalRest as any;498    return;499  }500  for(const value of args[0]) {501    yield* cartesian([...internalRest, value], ...args.slice(1)) as any;502  }503}