difftreelog
feat set/get tokenPropertyPermissions for NFT
in: master
7 files changed
pallets/common/src/eth.rsdiffbeforeafterboth--- a/pallets/common/src/eth.rs
+++ b/pallets/common/src/eth.rs
@@ -162,3 +162,12 @@
CollectionAdmin,
TokenOwner,
}
+
+#[derive(AbiCoder, Copy, Clone, Default, Debug)]
+#[repr(u8)]
+pub enum EthTokenPermissions {
+ #[default]
+ Mutable,
+ TokenOwner,
+ CollectionAdmin,
+}
pallets/nonfungible/src/erc.rsdiffbeforeafterboth--- a/pallets/nonfungible/src/erc.rs
+++ b/pallets/nonfungible/src/erc.rs
@@ -38,7 +38,7 @@
use pallet_common::{
CollectionHandle, CollectionPropertyPermissions, CommonCollectionOperations,
erc::{CommonEvmHandler, PrecompileResult, CollectionCall, static_property::key},
- eth::EthCrossAccount,
+ eth::{EthCrossAccount, EthTokenPermissions},
};
use pallet_evm::{account::CrossAccountId, PrecompileHandle};
use pallet_evm_coder_substrate::call;
@@ -60,6 +60,7 @@
/// @param collectionAdmin Permission to mutate property by collection admin if property is mutable.
/// @param tokenOwner Permission to mutate property by token owner if property is mutable.
#[weight(<SelfWeightOf<T>>::set_token_property_permissions(1))]
+ #[solidity(hide)]
fn set_token_property_permission(
&mut self,
caller: caller,
@@ -69,10 +70,10 @@
token_owner: bool,
) -> Result<()> {
let caller = T::CrossAccountId::from_eth(caller);
- <Pallet<T>>::set_property_permission(
+ <Pallet<T>>::set_property_permissions(
self,
&caller,
- PropertyKeyPermission {
+ [PropertyKeyPermission {
key: <Vec<u8>>::from(key)
.try_into()
.map_err(|_| "too long key")?,
@@ -81,11 +82,81 @@
collection_admin,
token_owner,
},
- },
+ }]
+ .into(),
)
.map_err(dispatch_to_evm::<T>)
}
+ /// @notice Set permissions for token property.
+ /// @dev Throws error if `msg.sender` is not admin or owner of the collection.
+ /// @param permissions Permissions for keys.
+ fn set_token_property_permissions(
+ &mut self,
+ caller: caller,
+ permissions: Vec<(string, Vec<(EthTokenPermissions, bool)>)>,
+ ) -> Result<()> {
+ let caller = T::CrossAccountId::from_eth(caller);
+ const PERMISSIONS_FIELDS_COUNT: usize = 3;
+
+ let mut perms = <Vec<_>>::new();
+
+ for (key, pp) in permissions {
+ if pp.len() > PERMISSIONS_FIELDS_COUNT {
+ return Err(alloc::format!(
+ "Actual number of fields {} for {}, which exceeds the maximum value of {}",
+ pp.len(),
+ stringify!(EthTokenPermissions),
+ PERMISSIONS_FIELDS_COUNT
+ )
+ .as_str()
+ .into());
+ }
+
+ let mut token_permission = PropertyPermission {
+ mutable: false,
+ collection_admin: false,
+ token_owner: false,
+ };
+
+ for (perm, value) in pp {
+ match perm {
+ EthTokenPermissions::Mutable => token_permission.mutable = value,
+ EthTokenPermissions::TokenOwner => token_permission.token_owner = value,
+ EthTokenPermissions::CollectionAdmin => {
+ token_permission.collection_admin = value
+ }
+ }
+ }
+
+ perms.push(PropertyKeyPermission {
+ key: <Vec<u8>>::from(key)
+ .try_into()
+ .map_err(|_| "too long key")?,
+ permission: token_permission,
+ });
+ }
+
+ <Pallet<T>>::set_property_permissions(self, &caller, perms).map_err(dispatch_to_evm::<T>)
+ }
+
+ fn token_property_permissions(
+ &self,
+ ) -> Result<Vec<(string, Vec<(EthTokenPermissions, bool)>)>> {
+ let mut res = <Vec<_>>::new();
+ for (key, pp) in <Pallet<T>>::token_property_permission(self.id) {
+ let key = string::from_utf8(key.into_inner()).unwrap();
+ let pp = [
+ (EthTokenPermissions::Mutable, pp.mutable),
+ (EthTokenPermissions::TokenOwner, pp.token_owner),
+ (EthTokenPermissions::CollectionAdmin, pp.collection_admin),
+ ]
+ .into();
+ res.push((key, pp));
+ }
+ Ok(res)
+ }
+
/// @notice Set token property value.
/// @dev Throws error if `msg.sender` has no permission to edit the property.
/// @param tokenId ID of the token.
pallets/nonfungible/src/lib.rsdiffbeforeafterboth--- a/pallets/nonfungible/src/lib.rs
+++ b/pallets/nonfungible/src/lib.rs
@@ -103,7 +103,7 @@
AccessMode, CollectionId, CollectionFlags, CustomDataLimit, TokenId, CreateCollectionData,
CreateNftExData, mapping::TokenAddressMapping, budget::Budget, Property, PropertyPermission,
PropertyKey, PropertyValue, PropertyKeyPermission, Properties, PropertyScope, TrySetProperty,
- TokenChild, AuxPropertyValue,
+ TokenChild, AuxPropertyValue, PropertiesPermissionMap,
};
use pallet_evm::{account::CrossAccountId, Pallet as PalletEvm};
use pallet_common::{
@@ -827,12 +827,16 @@
/// Set property permissions for the collection.
///
/// Sender should be the owner or admin of the collection.
- pub fn set_property_permission(
+ pub fn set_property_permissions(
collection: &CollectionHandle<T>,
sender: &T::CrossAccountId,
- permission: PropertyKeyPermission,
+ permission: Vec<PropertyKeyPermission>,
) -> DispatchResult {
- <PalletCommon<T>>::set_property_permission(collection, sender, permission)
+ <PalletCommon<T>>::set_token_property_permissions(collection, sender, permission)
+ }
+
+ pub fn token_property_permission(collection_id: CollectionId) -> PropertiesPermissionMap {
+ <PalletCommon<T>>::property_permissions(collection_id)
}
pub fn check_token_immediate_ownership(
pallets/nonfungible/src/stubs/UniqueNFT.soldiffbeforeafterboth--- a/pallets/nonfungible/src/stubs/UniqueNFT.sol
+++ b/pallets/nonfungible/src/stubs/UniqueNFT.sol
@@ -18,30 +18,44 @@
}
/// @title A contract that allows to set and delete token properties and change token property permissions.
-/// @dev the ERC-165 identifier for this interface is 0x91a97a68
+/// @dev the ERC-165 identifier for this interface is 0xde0695c2
contract TokenProperties is Dummy, ERC165 {
+ // /// @notice Set permissions for token property.
+ // /// @dev Throws error if `msg.sender` is not admin or owner of the collection.
+ // /// @param key Property key.
+ // /// @param isMutable Permission to mutate property.
+ // /// @param collectionAdmin Permission to mutate property by collection admin if property is mutable.
+ // /// @param tokenOwner Permission to mutate property by token owner if property is mutable.
+ // /// @dev EVM selector for this function is: 0x222d97fa,
+ // /// or in textual repr: setTokenPropertyPermission(string,bool,bool,bool)
+ // function setTokenPropertyPermission(string memory key, bool isMutable, bool collectionAdmin, bool tokenOwner) public {
+ // require(false, stub_error);
+ // key;
+ // isMutable;
+ // collectionAdmin;
+ // tokenOwner;
+ // dummy = 0;
+ // }
+
/// @notice Set permissions for token property.
/// @dev Throws error if `msg.sender` is not admin or owner of the collection.
- /// @param key Property key.
- /// @param isMutable Permission to mutate property.
- /// @param collectionAdmin Permission to mutate property by collection admin if property is mutable.
- /// @param tokenOwner Permission to mutate property by token owner if property is mutable.
- /// @dev EVM selector for this function is: 0x222d97fa,
- /// or in textual repr: setTokenPropertyPermission(string,bool,bool,bool)
- function setTokenPropertyPermission(
- string memory key,
- bool isMutable,
- bool collectionAdmin,
- bool tokenOwner
- ) public {
+ /// @param permissions Permissions for keys.
+ /// @dev EVM selector for this function is: 0xbd92983a,
+ /// or in textual repr: setTokenPropertyPermissions((string,(uint8,bool)[])[])
+ function setTokenPropertyPermissions(Tuple48[] memory permissions) public {
require(false, stub_error);
- key;
- isMutable;
- collectionAdmin;
- tokenOwner;
+ permissions;
dummy = 0;
}
+ /// @dev EVM selector for this function is: 0xf23d7790,
+ /// or in textual repr: tokenPropertyPermissions()
+ function tokenPropertyPermissions() public view returns (Tuple48[] memory) {
+ require(false, stub_error);
+ dummy;
+ return new Tuple48[](0);
+ }
+
// /// @notice Set token property value.
// /// @dev Throws error if `msg.sender` has no permission to edit the property.
// /// @param tokenId ID of the token.
@@ -118,6 +132,24 @@
bytes value;
}
+enum EthTokenPermissions {
+ Mutable,
+ TokenOwner,
+ CollectionAdmin
+}
+
+/// @dev anonymous struct
+struct Tuple48 {
+ string field_0;
+ Tuple46[] field_1;
+}
+
+/// @dev anonymous struct
+struct Tuple46 {
+ EthTokenPermissions field_0;
+ bool field_1;
+}
+
/// @title A contract that allows you to work with collections.
/// @dev the ERC-165 identifier for this interface is 0xb5e1747f
contract Collection is Dummy, ERC165 {
tests/src/eth/abi/nonFungible.jsondiffbeforeafterboth--- a/tests/src/eth/abi/nonFungible.json
+++ b/tests/src/eth/abi/nonFungible.json
@@ -697,12 +697,29 @@
},
{
"inputs": [
- { "internalType": "string", "name": "key", "type": "string" },
- { "internalType": "bool", "name": "isMutable", "type": "bool" },
- { "internalType": "bool", "name": "collectionAdmin", "type": "bool" },
- { "internalType": "bool", "name": "tokenOwner", "type": "bool" }
+ {
+ "components": [
+ { "internalType": "string", "name": "field_0", "type": "string" },
+ {
+ "components": [
+ {
+ "internalType": "enum EthTokenPermissions",
+ "name": "field_0",
+ "type": "uint8"
+ },
+ { "internalType": "bool", "name": "field_1", "type": "bool" }
+ ],
+ "internalType": "struct Tuple46[]",
+ "name": "field_1",
+ "type": "tuple[]"
+ }
+ ],
+ "internalType": "struct Tuple48[]",
+ "name": "permissions",
+ "type": "tuple[]"
+ }
],
- "name": "setTokenPropertyPermission",
+ "name": "setTokenPropertyPermissions",
"outputs": [],
"stateMutability": "nonpayable",
"type": "function"
@@ -743,6 +760,35 @@
"type": "function"
},
{
+ "inputs": [],
+ "name": "tokenPropertyPermissions",
+ "outputs": [
+ {
+ "components": [
+ { "internalType": "string", "name": "field_0", "type": "string" },
+ {
+ "components": [
+ {
+ "internalType": "enum EthTokenPermissions",
+ "name": "field_0",
+ "type": "uint8"
+ },
+ { "internalType": "bool", "name": "field_1", "type": "bool" }
+ ],
+ "internalType": "struct Tuple46[]",
+ "name": "field_1",
+ "type": "tuple[]"
+ }
+ ],
+ "internalType": "struct Tuple48[]",
+ "name": "",
+ "type": "tuple[]"
+ }
+ ],
+ "stateMutability": "view",
+ "type": "function"
+ },
+ {
"inputs": [
{ "internalType": "uint256", "name": "tokenId", "type": "uint256" }
],
tests/src/eth/api/UniqueNFT.soldiffbeforeafterboth--- a/tests/src/eth/api/UniqueNFT.sol
+++ b/tests/src/eth/api/UniqueNFT.sol
@@ -13,22 +13,28 @@
}
/// @title A contract that allows to set and delete token properties and change token property permissions.
-/// @dev the ERC-165 identifier for this interface is 0x91a97a68
+/// @dev the ERC-165 identifier for this interface is 0xde0695c2
interface TokenProperties is Dummy, ERC165 {
+ // /// @notice Set permissions for token property.
+ // /// @dev Throws error if `msg.sender` is not admin or owner of the collection.
+ // /// @param key Property key.
+ // /// @param isMutable Permission to mutate property.
+ // /// @param collectionAdmin Permission to mutate property by collection admin if property is mutable.
+ // /// @param tokenOwner Permission to mutate property by token owner if property is mutable.
+ // /// @dev EVM selector for this function is: 0x222d97fa,
+ // /// or in textual repr: setTokenPropertyPermission(string,bool,bool,bool)
+ // function setTokenPropertyPermission(string memory key, bool isMutable, bool collectionAdmin, bool tokenOwner) external;
+
/// @notice Set permissions for token property.
/// @dev Throws error if `msg.sender` is not admin or owner of the collection.
- /// @param key Property key.
- /// @param isMutable Permission to mutate property.
- /// @param collectionAdmin Permission to mutate property by collection admin if property is mutable.
- /// @param tokenOwner Permission to mutate property by token owner if property is mutable.
- /// @dev EVM selector for this function is: 0x222d97fa,
- /// or in textual repr: setTokenPropertyPermission(string,bool,bool,bool)
- function setTokenPropertyPermission(
- string memory key,
- bool isMutable,
- bool collectionAdmin,
- bool tokenOwner
- ) external;
+ /// @param permissions Permissions for keys.
+ /// @dev EVM selector for this function is: 0xbd92983a,
+ /// or in textual repr: setTokenPropertyPermissions((string,(uint8,bool)[])[])
+ function setTokenPropertyPermissions(Tuple43[] memory permissions) external;
+
+ /// @dev EVM selector for this function is: 0xf23d7790,
+ /// or in textual repr: tokenPropertyPermissions()
+ function tokenPropertyPermissions() external view returns (Tuple43[] memory);
// /// @notice Set token property value.
// /// @dev Throws error if `msg.sender` has no permission to edit the property.
@@ -79,6 +85,24 @@
bytes value;
}
+enum EthTokenPermissions {
+ Mutable,
+ TokenOwner,
+ CollectionAdmin
+}
+
+/// @dev anonymous struct
+struct Tuple43 {
+ string field_0;
+ Tuple41[] field_1;
+}
+
+/// @dev anonymous struct
+struct Tuple41 {
+ EthTokenPermissions field_0;
+ bool field_1;
+}
+
/// @title A contract that allows you to work with collections.
/// @dev the ERC-165 identifier for this interface is 0xb5e1747f
interface Collection is Dummy, ERC165 {
tests/src/eth/tokenProperties.test.tsdiffbeforeafterboth1// 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';2324describe('EVM token properties', () => {25 let donor: IKeyringPair;26 let alice: IKeyringPair;2728 before(async function() {29 await usingEthPlaygrounds(async (helper, privateKey) => {30 donor = await privateKey({filename: __filename});31 [alice] = await helper.arrange.createAccounts([100n], donor);32 });33 });3435 itEth('Can be reconfigured', async({helper}) => {36 const caller = await helper.eth.createAccountWithBalance(donor);37 for(const [mutable,collectionAdmin, tokenOwner] of cartesian([], [false, true], [false, true], [false, true])) {38 const collection = await helper.nft.mintCollection(alice);39 await collection.addAdmin(alice, {Ethereum: caller});40 41 const address = helper.ethAddress.fromCollectionId(collection.collectionId);42 const contract = helper.ethNativeContract.collection(address, 'nft', caller);43 44 await contract.methods.setTokenPropertyPermission('testKey', mutable, collectionAdmin, tokenOwner).send({from: caller});45 46 expect(await collection.getPropertyPermissions()).to.be.deep.equal([{47 key: 'testKey',48 permission: {mutable, collectionAdmin, tokenOwner},49 }]);50 }51 });5253 [54 {55 method: 'setProperties',56 methodParams: [[{key: 'testKey1', value: Buffer.from('testValue1')}, {key: 'testKey2', value: Buffer.from('testValue2')}]],57 expectedProps: [{key: 'testKey1', value: 'testValue1'}, {key: 'testKey2', value: 'testValue2'}],58 },59 {60 method: 'setProperty' /*Soft-deprecated*/, 61 methodParams: ['testKey1', Buffer.from('testValue1')],62 expectedProps: [{key: 'testKey1', value: 'testValue1'}],63 },64 ].map(testCase => 65 itEth(`[${testCase.method}] Can be set`, async({helper}) => {66 const caller = await helper.eth.createAccountWithBalance(donor);67 const collection = await helper.nft.mintCollection(alice, {68 tokenPropertyPermissions: [{69 key: 'testKey1',70 permission: {71 collectionAdmin: true,72 },73 }, {74 key: 'testKey2',75 permission: {76 collectionAdmin: true,77 },78 }],79 });8081 await collection.addAdmin(alice, {Ethereum: caller});82 const token = await collection.mintToken(alice);83 84 const collectionEvm = helper.ethNativeContract.collectionById(collection.collectionId, 'nft', caller, testCase.method === 'setProperty');85 86 await collectionEvm.methods[testCase.method](token.tokenId, ...testCase.methodParams).send({from: caller});87 88 const properties = await token.getProperties();89 expect(properties).to.deep.equal(testCase.expectedProps);90 }));91 92 [93 {mode: 'nft' as const, requiredPallets: []},94 {mode: 'rft' as const, requiredPallets: [Pallets.ReFungible]},95 ].map(testCase => 96 itEth.ifWithPallets(`Can be multiple set/read for ${testCase.mode}`, testCase.requiredPallets, async({helper}) => {97 const caller = await helper.eth.createAccountWithBalance(donor);98 99 const properties = Array(5).fill(0).map((_, i) => { return {key: `key_${i}`, value: Buffer.from(`value_${i}`)}; });100 const permissions: ITokenPropertyPermission[] = properties.map(p => { return {key: p.key, permission: {tokenOwner: true,101 collectionAdmin: true,102 mutable: true}}; });103 104 const collection = await helper[testCase.mode].mintCollection(alice, {105 tokenPrefix: 'ethp',106 tokenPropertyPermissions: permissions,107 }) as UniqueNFTCollection | UniqueRFTCollection;108 109 const token = await collection.mintToken(alice);110 111 const valuesBefore = await token.getProperties(properties.map(p => p.key));112 expect(valuesBefore).to.be.deep.equal([]);113 114 115 await collection.addAdmin(alice, {Ethereum: caller});116 117 const address = helper.ethAddress.fromCollectionId(collection.collectionId);118 const contract = helper.ethNativeContract.collection(address, testCase.mode, caller);119 120 expect(await contract.methods.properties(token.tokenId, []).call()).to.be.deep.equal([]);121 122 await contract.methods.setProperties(token.tokenId, properties).send({from: caller});123 124 const values = await token.getProperties(properties.map(p => p.key));125 expect(values).to.be.deep.equal(properties.map(p => { return {key: p.key, value: p.value.toString()}; }));126 127 expect(await contract.methods.properties(token.tokenId, []).call()).to.be.like(properties128 .map(p => { return helper.ethProperty.property(p.key, p.value.toString()); }));129 130 expect(await contract.methods.properties(token.tokenId, [properties[0].key]).call())131 .to.be.like([helper.ethProperty.property(properties[0].key, properties[0].value.toString())]);132 }));133 134 [135 {mode: 'nft' as const, requiredPallets: []},136 {mode: 'rft' as const, requiredPallets: [Pallets.ReFungible]},137 ].map(testCase => 138 itEth.ifWithPallets(`Can be deleted for ${testCase.mode}`, testCase.requiredPallets, async({helper}) => {139 const caller = await helper.eth.createAccountWithBalance(donor);140 const collection = await helper[testCase.mode].mintCollection(alice, {141 tokenPropertyPermissions: [{142 key: 'testKey',143 permission: {144 mutable: true,145 collectionAdmin: true,146 },147 },148 {149 key: 'testKey_1',150 permission: {151 mutable: true,152 collectionAdmin: true,153 },154 }],155 });156 157 const token = await collection.mintToken(alice);158 await token.setProperties(alice, [{key: 'testKey', value: 'testValue'}, {key: 'testKey_1', value: 'testValue_1'}]);159 expect(await token.getProperties()).to.has.length(2);160161 await collection.addAdmin(alice, {Ethereum: caller});162163 const address = helper.ethAddress.fromCollectionId(collection.collectionId);164 const contract = helper.ethNativeContract.collection(address, testCase.mode, caller);165166 await contract.methods.deleteProperties(token.tokenId, ['testKey', 'testKey_1']).send({from: caller});167168 const result = await token.getProperties(['testKey', 'testKey_1']);169 expect(result.length).to.equal(0);170 }));171172 itEth('Can be read', async({helper}) => {173 const caller = helper.eth.createAccount();174 const collection = await helper.nft.mintCollection(alice, {175 tokenPropertyPermissions: [{176 key: 'testKey',177 permission: {178 collectionAdmin: true,179 },180 }],181 });182 183 const token = await collection.mintToken(alice);184 await token.setProperties(alice, [{key: 'testKey', value: 'testValue'}]);185186 const address = helper.ethAddress.fromCollectionId(collection.collectionId);187 const contract = helper.ethNativeContract.collection(address, 'nft', caller);188189 const value = await contract.methods.property(token.tokenId, 'testKey').call();190 expect(value).to.equal(helper.getWeb3().utils.toHex('testValue'));191 });192});193194describe('EVM token properties negative', () => {195 let donor: IKeyringPair;196 let alice: IKeyringPair;197 let caller: string;198 let aliceCollection: UniqueNFTCollection;199 let token: UniqueNFToken;200 const tokenProps = [{key: 'testKey_1', value: 'testValue_1'}, {key: 'testKey_2', value: 'testValue_2'}];201 let collectionEvm: Contract;202203 before(async function() {204 await usingEthPlaygrounds(async (helper, privateKey) => {205 donor = await privateKey({filename: __filename});206 [alice] = await helper.arrange.createAccounts([100n], donor);207 });208 });209210 beforeEach(async () => {211 // 1. create collection with props: testKey_1, testKey_2212 // 2. create token and set props testKey_1, testKey_2213 await usingEthPlaygrounds(async (helper) => {214 aliceCollection = await helper.nft.mintCollection(alice, {215 tokenPropertyPermissions: [{216 key: 'testKey_1',217 permission: {218 mutable: true,219 collectionAdmin: true,220 },221 },222 {223 key: 'testKey_2',224 permission: {225 mutable: true,226 collectionAdmin: true,227 },228 }],229 }); 230 token = await aliceCollection.mintToken(alice);231 await token.setProperties(alice, tokenProps);232 collectionEvm = helper.ethNativeContract.collection(helper.ethAddress.fromCollectionId(aliceCollection.collectionId), 'nft', caller, true);233 });234 });235236 [237 {method: 'setProperty', methodParams: [tokenProps[1].key, Buffer.from('newValue')]},238 {method: 'setProperties', methodParams: [[{key: tokenProps[1].key, value: Buffer.from('newValue')}]]},239 ].map(testCase =>240 itEth(`[${testCase.method}] Cannot set properties of non-owned collection`, async ({helper}) => {241 caller = await helper.eth.createAccountWithBalance(donor);242 collectionEvm = helper.ethNativeContract.collection(helper.ethAddress.fromCollectionId(aliceCollection.collectionId), 'nft', caller, true);243 // Caller not an owner and not an admin, so he cannot set properties:244 await expect(collectionEvm.methods[testCase.method](token.tokenId, ...testCase.methodParams).call({from: caller})).to.be.rejectedWith('NoPermission');245 await expect(collectionEvm.methods[testCase.method](token.tokenId, ...testCase.methodParams).send({from: caller})).to.be.rejected;246247 // Props have not changed:248 const expectedProps = tokenProps.map(p => helper.ethProperty.property(p.key, p.value.toString()));249 const actualProps = await collectionEvm.methods.properties(token.tokenId, []).call();250 expect(actualProps).to.deep.eq(expectedProps);251 }));252253 [254 {method: 'setProperty', methodParams: ['testKey_3', Buffer.from('testValue3')]},255 {method: 'setProperties', methodParams: [[{key: 'testKey_3', value: Buffer.from('testValue3')}]]},256 ].map(testCase =>257 itEth(`[${testCase.method}] Cannot set non-existing properties`, async ({helper}) => {258 caller = await helper.eth.createAccountWithBalance(donor);259 collectionEvm = helper.ethNativeContract.collection(helper.ethAddress.fromCollectionId(aliceCollection.collectionId), 'nft', caller, true);260 await helper.collection.addAdmin(alice, aliceCollection.collectionId, {Ethereum: caller});261262 await expect(collectionEvm.methods[testCase.method](token.tokenId, ...testCase.methodParams).call({from: caller})).to.be.rejectedWith('NoPermission');263 await expect(collectionEvm.methods[testCase.method](token.tokenId, ...testCase.methodParams).send({from: caller})).to.be.rejected;264265 // Props have not changed:266 const expectedProps = tokenProps.map(p => helper.ethProperty.property(p.key, p.value.toString()));267 const actualProps = await collectionEvm.methods.properties(token.tokenId, []).call();268 expect(actualProps).to.deep.eq(expectedProps);269 }));270271 [272 {method: 'deleteProperty', methodParams: ['testKey_2']},273 {method: 'deleteProperties', methodParams: [['testKey_2']]},274 ].map(testCase => 275 itEth(`[${testCase.method}] Cannot delete properties of non-owned collection`, async ({helper}) => {276 caller = await helper.eth.createAccountWithBalance(donor);277 collectionEvm = helper.ethNativeContract.collection(helper.ethAddress.fromCollectionId(aliceCollection.collectionId), 'nft', caller, testCase.method == 'deleteProperty');278 // Caller not an owner and not an admin, so he cannot set properties:279 await expect(collectionEvm.methods[testCase.method](token.tokenId, ...testCase.methodParams).call({from: caller})).to.be.rejectedWith('NoPermission');280 await expect(collectionEvm.methods[testCase.method](token.tokenId, ...testCase.methodParams).send({from: caller})).to.be.rejected;281282 // Props have not changed:283 const expectedProps = tokenProps.map(p => helper.ethProperty.property(p.key, p.value.toString()));284 const actualProps = await collectionEvm.methods.properties(token.tokenId, []).call();285 expect(actualProps).to.deep.eq(expectedProps);286 }));287 288 [289 {method: 'deleteProperty', methodParams: ['testKey_3']},290 {method: 'deleteProperties', methodParams: [['testKey_3']]},291 ].map(testCase => 292 itEth(`[${testCase.method}] Cannot delete non-existing properties`, async ({helper}) => {293 caller = await helper.eth.createAccountWithBalance(donor);294 collectionEvm = helper.ethNativeContract.collection(helper.ethAddress.fromCollectionId(aliceCollection.collectionId), 'nft', caller, testCase.method == 'deleteProperty');295 await helper.collection.addAdmin(alice, aliceCollection.collectionId, {Ethereum: caller});296 // Caller cannot delete non-existing properties:297 await expect(collectionEvm.methods[testCase.method](token.tokenId, ...testCase.methodParams).call({from: caller})).to.be.rejectedWith('NoPermission');298 await expect(collectionEvm.methods[testCase.method](token.tokenId, ...testCase.methodParams).send({from: caller})).to.be.rejected;299 // Props have not changed:300 const expectedProps = tokenProps.map(p => helper.ethProperty.property(p.key, p.value.toString()));301 const actualProps = await collectionEvm.methods.properties(token.tokenId, []).call();302 expect(actualProps).to.deep.eq(expectedProps);303 }));304});305306307type ElementOf<A> = A extends readonly (infer T)[] ? T : never;308function* cartesian<T extends Array<Array<any>>, R extends Array<any>>(internalRest: [...R], ...args: [...T]): Generator<[...R, ...{[K in keyof T]: ElementOf<T[K]>}]> {309 if(args.length === 0) {310 yield internalRest as any;311 return;312 }313 for(const value of args[0]) {314 yield* cartesian([...internalRest, value], ...args.slice(1)) as any;315 }316}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';2324describe('EVM token properties', () => {25 let donor: IKeyringPair;26 let alice: IKeyringPair;2728 before(async function() {29 await usingEthPlaygrounds(async (helper, privateKey) => {30 donor = await privateKey({filename: __filename});31 [alice] = await helper.arrange.createAccounts([100n], donor);32 });33 });3435 itEth.only('Can be reconfigured', async({helper}) => {36 const caller = await helper.eth.createAccountWithBalance(donor);37 for(const [mutable,collectionAdmin, tokenOwner] of cartesian([], [false, true], [false, true], [false, true])) {38 const collection = await helper.nft.mintCollection(alice);39 await collection.addAdmin(alice, {Ethereum: caller});40 41 const address = helper.ethAddress.fromCollectionId(collection.collectionId);42 const contract = helper.ethNativeContract.collection(address, 'nft', caller);43 44 await contract.methods.setTokenPropertyPermissions([['testKey', [[0, mutable], [1, tokenOwner], [2, collectionAdmin]]]]).send({from: caller});45 46 expect(await collection.getPropertyPermissions()).to.be.deep.equal([{47 key: 'testKey',48 permission: {mutable, collectionAdmin, tokenOwner},49 }]);5051 expect(await contract.methods.tokenPropertyPermissions().call({from: caller})).to.be.like([52 ['testKey', [['0', mutable], ['1', tokenOwner], ['2', collectionAdmin]]]53 ]);54 }55 });5657 [58 {59 method: 'setProperties',60 methodParams: [[{key: 'testKey1', value: Buffer.from('testValue1')}, {key: 'testKey2', value: Buffer.from('testValue2')}]],61 expectedProps: [{key: 'testKey1', value: 'testValue1'}, {key: 'testKey2', value: 'testValue2'}],62 },63 {64 method: 'setProperty' /*Soft-deprecated*/, 65 methodParams: ['testKey1', Buffer.from('testValue1')],66 expectedProps: [{key: 'testKey1', value: 'testValue1'}],67 },68 ].map(testCase => 69 itEth(`[${testCase.method}] Can be set`, async({helper}) => {70 const caller = await helper.eth.createAccountWithBalance(donor);71 const collection = await helper.nft.mintCollection(alice, {72 tokenPropertyPermissions: [{73 key: 'testKey1',74 permission: {75 collectionAdmin: true,76 },77 }, {78 key: 'testKey2',79 permission: {80 collectionAdmin: true,81 },82 }],83 });8485 await collection.addAdmin(alice, {Ethereum: caller});86 const token = await collection.mintToken(alice);87 88 const collectionEvm = helper.ethNativeContract.collectionById(collection.collectionId, 'nft', caller, testCase.method === 'setProperty');89 90 await collectionEvm.methods[testCase.method](token.tokenId, ...testCase.methodParams).send({from: caller});91 92 const properties = await token.getProperties();93 expect(properties).to.deep.equal(testCase.expectedProps);94 }));95 96 [97 {mode: 'nft' as const, requiredPallets: []},98 {mode: 'rft' as const, requiredPallets: [Pallets.ReFungible]},99 ].map(testCase => 100 itEth.ifWithPallets(`Can be multiple set/read for ${testCase.mode}`, testCase.requiredPallets, async({helper}) => {101 const caller = await helper.eth.createAccountWithBalance(donor);102 103 const properties = Array(5).fill(0).map((_, i) => { return {key: `key_${i}`, value: Buffer.from(`value_${i}`)}; });104 const permissions: ITokenPropertyPermission[] = properties.map(p => { return {key: p.key, permission: {tokenOwner: true,105 collectionAdmin: true,106 mutable: true}}; });107 108 const collection = await helper[testCase.mode].mintCollection(alice, {109 tokenPrefix: 'ethp',110 tokenPropertyPermissions: permissions,111 }) as UniqueNFTCollection | UniqueRFTCollection;112 113 const token = await collection.mintToken(alice);114 115 const valuesBefore = await token.getProperties(properties.map(p => p.key));116 expect(valuesBefore).to.be.deep.equal([]);117 118 119 await collection.addAdmin(alice, {Ethereum: caller});120 121 const address = helper.ethAddress.fromCollectionId(collection.collectionId);122 const contract = helper.ethNativeContract.collection(address, testCase.mode, caller);123 124 expect(await contract.methods.properties(token.tokenId, []).call()).to.be.deep.equal([]);125 126 await contract.methods.setProperties(token.tokenId, properties).send({from: caller});127 128 const values = await token.getProperties(properties.map(p => p.key));129 expect(values).to.be.deep.equal(properties.map(p => { return {key: p.key, value: p.value.toString()}; }));130 131 expect(await contract.methods.properties(token.tokenId, []).call()).to.be.like(properties132 .map(p => { return helper.ethProperty.property(p.key, p.value.toString()); }));133 134 expect(await contract.methods.properties(token.tokenId, [properties[0].key]).call())135 .to.be.like([helper.ethProperty.property(properties[0].key, properties[0].value.toString())]);136 }));137 138 [139 {mode: 'nft' as const, requiredPallets: []},140 {mode: 'rft' as const, requiredPallets: [Pallets.ReFungible]},141 ].map(testCase => 142 itEth.ifWithPallets(`Can be deleted for ${testCase.mode}`, testCase.requiredPallets, async({helper}) => {143 const caller = await helper.eth.createAccountWithBalance(donor);144 const collection = await helper[testCase.mode].mintCollection(alice, {145 tokenPropertyPermissions: [{146 key: 'testKey',147 permission: {148 mutable: true,149 collectionAdmin: true,150 },151 },152 {153 key: 'testKey_1',154 permission: {155 mutable: true,156 collectionAdmin: true,157 },158 }],159 });160 161 const token = await collection.mintToken(alice);162 await token.setProperties(alice, [{key: 'testKey', value: 'testValue'}, {key: 'testKey_1', value: 'testValue_1'}]);163 expect(await token.getProperties()).to.has.length(2);164165 await collection.addAdmin(alice, {Ethereum: caller});166167 const address = helper.ethAddress.fromCollectionId(collection.collectionId);168 const contract = helper.ethNativeContract.collection(address, testCase.mode, caller);169170 await contract.methods.deleteProperties(token.tokenId, ['testKey', 'testKey_1']).send({from: caller});171172 const result = await token.getProperties(['testKey', 'testKey_1']);173 expect(result.length).to.equal(0);174 }));175176 itEth('Can be read', async({helper}) => {177 const caller = helper.eth.createAccount();178 const collection = await helper.nft.mintCollection(alice, {179 tokenPropertyPermissions: [{180 key: 'testKey',181 permission: {182 collectionAdmin: true,183 },184 }],185 });186 187 const token = await collection.mintToken(alice);188 await token.setProperties(alice, [{key: 'testKey', value: 'testValue'}]);189190 const address = helper.ethAddress.fromCollectionId(collection.collectionId);191 const contract = helper.ethNativeContract.collection(address, 'nft', caller);192193 const value = await contract.methods.property(token.tokenId, 'testKey').call();194 expect(value).to.equal(helper.getWeb3().utils.toHex('testValue'));195 });196});197198describe('EVM token properties negative', () => {199 let donor: IKeyringPair;200 let alice: IKeyringPair;201 let caller: string;202 let aliceCollection: UniqueNFTCollection;203 let token: UniqueNFToken;204 const tokenProps = [{key: 'testKey_1', value: 'testValue_1'}, {key: 'testKey_2', value: 'testValue_2'}];205 let collectionEvm: Contract;206207 before(async function() {208 await usingEthPlaygrounds(async (helper, privateKey) => {209 donor = await privateKey({filename: __filename});210 [alice] = await helper.arrange.createAccounts([100n], donor);211 });212 });213214 beforeEach(async () => {215 // 1. create collection with props: testKey_1, testKey_2216 // 2. create token and set props testKey_1, testKey_2217 await usingEthPlaygrounds(async (helper) => {218 aliceCollection = await helper.nft.mintCollection(alice, {219 tokenPropertyPermissions: [{220 key: 'testKey_1',221 permission: {222 mutable: true,223 collectionAdmin: true,224 },225 },226 {227 key: 'testKey_2',228 permission: {229 mutable: true,230 collectionAdmin: true,231 },232 }],233 }); 234 token = await aliceCollection.mintToken(alice);235 await token.setProperties(alice, tokenProps);236 collectionEvm = helper.ethNativeContract.collection(helper.ethAddress.fromCollectionId(aliceCollection.collectionId), 'nft', caller, true);237 });238 });239240 [241 {method: 'setProperty', methodParams: [tokenProps[1].key, Buffer.from('newValue')]},242 {method: 'setProperties', methodParams: [[{key: tokenProps[1].key, value: Buffer.from('newValue')}]]},243 ].map(testCase =>244 itEth(`[${testCase.method}] Cannot set properties of non-owned collection`, async ({helper}) => {245 caller = await helper.eth.createAccountWithBalance(donor);246 collectionEvm = helper.ethNativeContract.collection(helper.ethAddress.fromCollectionId(aliceCollection.collectionId), 'nft', caller, true);247 // Caller not an owner and not an admin, so he cannot set properties:248 await expect(collectionEvm.methods[testCase.method](token.tokenId, ...testCase.methodParams).call({from: caller})).to.be.rejectedWith('NoPermission');249 await expect(collectionEvm.methods[testCase.method](token.tokenId, ...testCase.methodParams).send({from: caller})).to.be.rejected;250251 // Props have not changed:252 const expectedProps = tokenProps.map(p => helper.ethProperty.property(p.key, p.value.toString()));253 const actualProps = await collectionEvm.methods.properties(token.tokenId, []).call();254 expect(actualProps).to.deep.eq(expectedProps);255 }));256257 [258 {method: 'setProperty', methodParams: ['testKey_3', Buffer.from('testValue3')]},259 {method: 'setProperties', methodParams: [[{key: 'testKey_3', value: Buffer.from('testValue3')}]]},260 ].map(testCase =>261 itEth(`[${testCase.method}] Cannot set non-existing properties`, async ({helper}) => {262 caller = await helper.eth.createAccountWithBalance(donor);263 collectionEvm = helper.ethNativeContract.collection(helper.ethAddress.fromCollectionId(aliceCollection.collectionId), 'nft', caller, true);264 await helper.collection.addAdmin(alice, aliceCollection.collectionId, {Ethereum: caller});265266 await expect(collectionEvm.methods[testCase.method](token.tokenId, ...testCase.methodParams).call({from: caller})).to.be.rejectedWith('NoPermission');267 await expect(collectionEvm.methods[testCase.method](token.tokenId, ...testCase.methodParams).send({from: caller})).to.be.rejected;268269 // Props have not changed:270 const expectedProps = tokenProps.map(p => helper.ethProperty.property(p.key, p.value.toString()));271 const actualProps = await collectionEvm.methods.properties(token.tokenId, []).call();272 expect(actualProps).to.deep.eq(expectedProps);273 }));274275 [276 {method: 'deleteProperty', methodParams: ['testKey_2']},277 {method: 'deleteProperties', methodParams: [['testKey_2']]},278 ].map(testCase => 279 itEth(`[${testCase.method}] Cannot delete properties of non-owned collection`, async ({helper}) => {280 caller = await helper.eth.createAccountWithBalance(donor);281 collectionEvm = helper.ethNativeContract.collection(helper.ethAddress.fromCollectionId(aliceCollection.collectionId), 'nft', caller, testCase.method == 'deleteProperty');282 // Caller not an owner and not an admin, so he cannot set properties:283 await expect(collectionEvm.methods[testCase.method](token.tokenId, ...testCase.methodParams).call({from: caller})).to.be.rejectedWith('NoPermission');284 await expect(collectionEvm.methods[testCase.method](token.tokenId, ...testCase.methodParams).send({from: caller})).to.be.rejected;285286 // Props have not changed:287 const expectedProps = tokenProps.map(p => helper.ethProperty.property(p.key, p.value.toString()));288 const actualProps = await collectionEvm.methods.properties(token.tokenId, []).call();289 expect(actualProps).to.deep.eq(expectedProps);290 }));291 292 [293 {method: 'deleteProperty', methodParams: ['testKey_3']},294 {method: 'deleteProperties', methodParams: [['testKey_3']]},295 ].map(testCase => 296 itEth(`[${testCase.method}] Cannot delete non-existing properties`, async ({helper}) => {297 caller = await helper.eth.createAccountWithBalance(donor);298 collectionEvm = helper.ethNativeContract.collection(helper.ethAddress.fromCollectionId(aliceCollection.collectionId), 'nft', caller, testCase.method == 'deleteProperty');299 await helper.collection.addAdmin(alice, aliceCollection.collectionId, {Ethereum: caller});300 // Caller cannot delete non-existing properties:301 await expect(collectionEvm.methods[testCase.method](token.tokenId, ...testCase.methodParams).call({from: caller})).to.be.rejectedWith('NoPermission');302 await expect(collectionEvm.methods[testCase.method](token.tokenId, ...testCase.methodParams).send({from: caller})).to.be.rejected;303 // Props have not changed:304 const expectedProps = tokenProps.map(p => helper.ethProperty.property(p.key, p.value.toString()));305 const actualProps = await collectionEvm.methods.properties(token.tokenId, []).call();306 expect(actualProps).to.deep.eq(expectedProps);307 }));308});309310311type ElementOf<A> = A extends readonly (infer T)[] ? T : never;312function* cartesian<T extends Array<Array<any>>, R extends Array<any>>(internalRest: [...R], ...args: [...T]): Generator<[...R, ...{[K in keyof T]: ElementOf<T[K]>}]> {313 if(args.length === 0) {314 yield internalRest as any;315 return;316 }317 for(const value of args[0]) {318 yield* cartesian([...internalRest, value], ...args.slice(1)) as any;319 }320}