--- a/pallets/common/src/erc.rs +++ b/pallets/common/src/erc.rs @@ -20,6 +20,7 @@ solidity_interface, solidity, ToLog, types::*, execution::{Result, Error}, + weight, }; pub use pallet_evm::{PrecompileOutput, PrecompileResult, PrecompileHandle, account::CrossAccountId}; use pallet_evm_coder_substrate::dispatch_to_evm; @@ -31,8 +32,12 @@ use alloc::format; use crate::{ - Pallet, CollectionHandle, Config, CollectionProperties, - eth::{convert_cross_account_to_uint256, convert_uint256_to_cross_account}, + Pallet, CollectionHandle, Config, CollectionProperties, SelfWeightOf, + eth::{ + convert_cross_account_to_uint256, convert_uint256_to_cross_account, + convert_cross_account_to_tuple, + }, + weights::WeightInfo, }; /// Events for ethereum collection helper. @@ -69,6 +74,7 @@ /// /// @param key Property key. /// @param value Propery value. + #[weight(>::set_collection_properties(1))] fn set_collection_property( &mut self, caller: caller, @@ -88,7 +94,10 @@ /// Delete collection property. /// /// @param key Property key. + #[weight(>::delete_collection_properties(1))] fn delete_collection_property(&mut self, caller: caller, key: string) -> Result<()> { + self.consume_store_reads_and_writes(1, 1)?; + let caller = T::CrossAccountId::from_eth(caller); let key = >::from(key) .try_into() @@ -120,6 +129,8 @@ /// /// @param sponsor Address of the sponsor from whose account funds will be debited for operations with the contract. fn set_collection_sponsor(&mut self, caller: caller, sponsor: address) -> Result { + self.consume_store_reads_and_writes(1, 1)?; + check_is_owner_or_admin(caller, self)?; let sponsor = T::CrossAccountId::from_eth(sponsor); @@ -138,6 +149,8 @@ caller: caller, sponsor: uint256, ) -> Result { + self.consume_store_reads_and_writes(1, 1)?; + check_is_owner_or_admin(caller, self)?; let sponsor = convert_uint256_to_cross_account::(sponsor); @@ -146,7 +159,7 @@ save(self) } - // /// Whether there is a pending sponsor. + /// Whether there is a pending sponsor. fn has_collection_pending_sponsor(&self) -> Result { Ok(matches!( self.collection.sponsorship, @@ -158,6 +171,8 @@ /// /// @dev After setting the sponsor for the collection, it must be confirmed with this function. fn confirm_collection_sponsorship(&mut self, caller: caller) -> Result { + self.consume_store_writes(1)?; + let caller = T::CrossAccountId::from_eth(caller); if !self .confirm_sponsorship(caller.as_sub()) @@ -170,6 +185,7 @@ /// Remove collection sponsor. fn remove_collection_sponsor(&mut self, caller: caller) -> Result { + self.consume_store_reads_and_writes(1, 1)?; check_is_owner_or_admin(caller, self)?; self.remove_sponsor().map_err(dispatch_to_evm::)?; save(self) @@ -206,6 +222,8 @@ /// @param value Value of the limit. #[solidity(rename_selector = "setCollectionLimit")] fn set_int_limit(&mut self, caller: caller, limit: string, value: uint32) -> Result { + self.consume_store_reads_and_writes(1, 1)?; + check_is_owner_or_admin(caller, self)?; let mut limits = self.limits.clone(); @@ -249,6 +267,8 @@ /// @param value Value of the limit. #[solidity(rename_selector = "setCollectionLimit")] fn set_bool_limit(&mut self, caller: caller, limit: string, value: bool) -> Result { + self.consume_store_reads_and_writes(1, 1)?; + check_is_owner_or_admin(caller, self)?; let mut limits = self.limits.clone(); @@ -275,7 +295,7 @@ } /// Get contract address. - fn contract_address(&self, _caller: caller) -> Result
{ + fn contract_address(&self) -> Result
{ Ok(crate::eth::collection_id_to_address(self.id)) } @@ -286,6 +306,8 @@ caller: caller, new_admin: uint256, ) -> Result { + self.consume_store_writes(2)?; + let caller = T::CrossAccountId::from_eth(caller); let new_admin = convert_uint256_to_cross_account::(new_admin); >::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::)?; @@ -299,6 +321,8 @@ caller: caller, admin: uint256, ) -> Result { + self.consume_store_writes(2)?; + let caller = T::CrossAccountId::from_eth(caller); let admin = convert_uint256_to_cross_account::(admin); >::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::)?; @@ -308,6 +332,8 @@ /// Add collection admin. /// @param newAdmin Address of the added administrator. fn add_collection_admin(&mut self, caller: caller, new_admin: address) -> Result { + self.consume_store_writes(2)?; + let caller = T::CrossAccountId::from_eth(caller); let new_admin = T::CrossAccountId::from_eth(new_admin); >::toggle_admin(self, &caller, &new_admin, true).map_err(dispatch_to_evm::)?; @@ -318,6 +344,8 @@ /// /// @param admin Address of the removed administrator. fn remove_collection_admin(&mut self, caller: caller, admin: address) -> Result { + self.consume_store_writes(2)?; + let caller = T::CrossAccountId::from_eth(caller); let admin = T::CrossAccountId::from_eth(admin); >::toggle_admin(self, &caller, &admin, false).map_err(dispatch_to_evm::)?; @@ -329,6 +357,8 @@ /// @param enable If "true" degenerates to nesting: 'Owner' else to nesting: 'Disabled' #[solidity(rename_selector = "setCollectionNesting")] fn set_nesting_bool(&mut self, caller: caller, enable: bool) -> Result { + self.consume_store_reads_and_writes(1, 1)?; + check_is_owner_or_admin(caller, self)?; let mut permissions = self.collection.permissions.clone(); @@ -358,6 +388,8 @@ enable: bool, collections: Vec
, ) -> Result { + self.consume_store_reads_and_writes(1, 1)?; + if collections.is_empty() { return Err("no addresses provided".into()); } @@ -401,6 +433,8 @@ /// 0 for Normal /// 1 for AllowList fn set_collection_access(&mut self, caller: caller, mode: uint8) -> Result { + self.consume_store_reads_and_writes(1, 1)?; + check_is_owner_or_admin(caller, self)?; let permissions = CollectionPermissions { access: Some(match mode { @@ -420,30 +454,78 @@ save(self) } + /// Checks that user allowed to operate with collection. + /// + /// @param user User address to check. + fn allowed(&self, user: address) -> Result { + Ok(Pallet::::allowed( + self.id, + T::CrossAccountId::from_eth(user), + )) + } + /// Add the user to the allowed list. /// /// @param user Address of a trusted user. fn add_to_collection_allow_list(&mut self, caller: caller, user: address) -> Result { + self.consume_store_writes(1)?; + let caller = T::CrossAccountId::from_eth(caller); let user = T::CrossAccountId::from_eth(user); >::toggle_allowlist(self, &caller, &user, true).map_err(dispatch_to_evm::)?; Ok(()) } + /// Add substrate user to allowed list. + /// + /// @param user User substrate address. + fn add_to_collection_allow_list_substrate( + &mut self, + caller: caller, + user: uint256, + ) -> Result { + self.consume_store_writes(1)?; + + let caller = T::CrossAccountId::from_eth(caller); + let user = convert_uint256_to_cross_account::(user); + Pallet::::toggle_allowlist(self, &caller, &user, true).map_err(dispatch_to_evm::)?; + Ok(()) + } + /// Remove the user from the allowed list. /// /// @param user Address of a removed user. fn remove_from_collection_allow_list(&mut self, caller: caller, user: address) -> Result { + self.consume_store_writes(1)?; + let caller = T::CrossAccountId::from_eth(caller); let user = T::CrossAccountId::from_eth(user); >::toggle_allowlist(self, &caller, &user, false).map_err(dispatch_to_evm::)?; Ok(()) } + /// Remove substrate user from allowed list. + /// + /// @param user User substrate address. + fn remove_from_collection_allow_list_substrate( + &mut self, + caller: caller, + user: uint256, + ) -> Result { + self.consume_store_writes(1)?; + + let caller = T::CrossAccountId::from_eth(caller); + let user = convert_uint256_to_cross_account::(user); + Pallet::::toggle_allowlist(self, &caller, &user, false).map_err(dispatch_to_evm::)?; + Ok(()) + } + /// Switch permission for minting. /// /// @param mode Enable if "true". fn set_collection_mint_mode(&mut self, caller: caller, mode: bool) -> Result { + self.consume_store_reads_and_writes(1, 1)?; + check_is_owner_or_admin(caller, self)?; let permissions = CollectionPermissions { mint_mode: Some(mode), @@ -481,7 +563,7 @@ /// Returns collection type /// /// @return `Fungible` or `NFT` or `ReFungible` - fn unique_collection_type(&mut self) -> Result { + fn unique_collection_type(&self) -> Result { let mode = match self.collection.mode { CollectionMode::Fungible(_) => "Fungible", CollectionMode::NFT => "NFT", @@ -490,11 +572,23 @@ Ok(mode.into()) } + /// Get collection owner. + /// + /// @return Tuble with sponsor address and his substrate mirror. + /// If address is canonical then substrate mirror is zero and vice versa. + fn collection_owner(&self) -> Result<(address, uint256)> { + Ok(convert_cross_account_to_tuple::( + &T::CrossAccountId::from_sub(self.owner.clone()), + )) + } + /// Changes collection owner to another account /// /// @dev Owner can be changed only by current owner /// @param newOwner new owner account fn set_owner(&mut self, caller: caller, new_owner: address) -> Result { + self.consume_store_writes(1)?; + let caller = T::CrossAccountId::from_eth(caller); let new_owner = T::CrossAccountId::from_eth(new_owner); self.set_owner_internal(caller, new_owner) @@ -506,13 +600,25 @@ /// @dev Owner can be changed only by current owner /// @param newOwner new owner substrate account fn set_owner_substrate(&mut self, caller: caller, new_owner: uint256) -> Result { + self.consume_store_writes(1)?; + let caller = T::CrossAccountId::from_eth(caller); let new_owner = convert_uint256_to_cross_account::(new_owner); self.set_owner_internal(caller, new_owner) .map_err(dispatch_to_evm::) } + + // TODO: need implement AbiWriter for &Vec + // fn collection_admins(&self) -> Result> { + // let result = pallet_common::IsAdmin::::iter_prefix((self.id,)) + // .map(|(admin, _)| pallet_common::eth::convert_cross_account_to_tuple::(&admin)) + // .collect(); + // Ok(result) + // } } +/// ### Note +/// Do not forget to add: `self.consume_store_reads(1)?;` fn check_is_owner_or_admin( caller: caller, collection: &CollectionHandle, @@ -524,9 +630,9 @@ Ok(caller) } +/// ### Note +/// Do not forget to add: `self.consume_store_writes(1)?;` fn save(collection: &CollectionHandle) -> Result { - // TODO possibly delete for the lack of transaction - collection.consume_store_writes(1)?; collection .check_is_internal() .map_err(dispatch_to_evm::)?; --- a/pallets/common/src/eth.rs +++ b/pallets/common/src/eth.rs @@ -16,7 +16,7 @@ //! The module contains a number of functions for converting and checking ethereum identifiers. -use evm_coder::types::uint256; +use evm_coder::types::{uint256, address}; pub use pallet_evm::account::{Config, CrossAccountId}; use sp_core::H160; use up_data_structs::CollectionId; @@ -69,3 +69,19 @@ let account_id = T::AccountId::from(new_admin_arr); T::CrossAccountId::from_sub(account_id) } + +/// Convert `CrossAccountId` to `(address, uint256)`. +pub fn convert_cross_account_to_tuple( + cross_account_id: &T::CrossAccountId, +) -> (address, uint256) +where + T::AccountId: AsRef<[u8; 32]>, +{ + if cross_account_id.is_canonical_substrate() { + let sub = convert_cross_account_to_uint256::(cross_account_id); + (Default::default(), sub) + } else { + let eth = *cross_account_id.as_eth(); + (eth, Default::default()) + } +} --- a/pallets/common/src/lib.rs +++ b/pallets/common/src/lib.rs @@ -112,7 +112,6 @@ RmrkBoundedTheme, RmrkNftChild, CollectionPermissions, - SchemaVersion, }; pub use pallet::*; @@ -202,6 +201,21 @@ )) } + /// Consume gas for reading and writing. + pub fn consume_store_reads_and_writes( + &self, + reads: u64, + writes: u64, + ) -> evm_coder::execution::Result<()> { + let weight = ::DbWeight::get(); + let reads = weight.read.saturating_mul(reads); + let writes = weight.read.saturating_mul(writes); + self.recorder + .consume_gas(T::GasWeightMapping::weight_to_gas( + reads.saturating_add(writes), + )) + } + /// Save collection to storage. pub fn save(&self) -> DispatchResult { >::insert(self.id, &self.collection); @@ -310,6 +324,8 @@ } /// Changes collection owner to another account + /// #### Store read/writes + /// 1 writes fn set_owner_internal( &mut self, caller: T::CrossAccountId, @@ -1292,6 +1308,8 @@ } /// Toggle `user` participation in the `collection`'s allow list. + /// #### Store read/writes + /// 1 writes pub fn toggle_allowlist( collection: &CollectionHandle, sender: &T::CrossAccountId, @@ -1312,6 +1330,8 @@ } /// Toggle `user` participation in the `collection`'s admin list. + /// #### Store read/writes + /// 2 writes pub fn toggle_admin( collection: &CollectionHandle, sender: &T::CrossAccountId, --- a/pallets/evm-contract-helpers/src/eth.rs +++ b/pallets/evm-contract-helpers/src/eth.rs @@ -172,14 +172,9 @@ fn get_sponsor(&self, contract_address: address) -> Result<(address, uint256)> { let sponsor = Pallet::::get_sponsor(contract_address).ok_or("Contract has no sponsor")?; - let result: (address, uint256) = if sponsor.is_canonical_substrate() { - let sponsor = pallet_common::eth::convert_cross_account_to_uint256::(&sponsor); - (Default::default(), sponsor) - } else { - let sponsor = *sponsor.as_eth(); - (sponsor, Default::default()) - }; - Ok(result) + Ok(pallet_common::eth::convert_cross_account_to_tuple::( + &sponsor, + )) } /// Check tat contract has confirmed sponsor. --- a/pallets/fungible/src/stubs/UniqueFungible.sol +++ b/pallets/fungible/src/stubs/UniqueFungible.sol @@ -22,7 +22,7 @@ } /// @title A contract that allows you to work with collections. -/// @dev the ERC-165 identifier for this interface is 0xe54be640 +/// @dev the ERC-165 identifier for this interface is 0x9f70d4e0 contract Collection is Dummy, ERC165 { /// Set collection property. /// @@ -255,6 +255,18 @@ dummy = 0; } + /// Checks that user allowed to operate with collection. + /// + /// @param user User address to check. + /// @dev EVM selector for this function is: 0xd63a8e11, + /// or in textual repr: allowed(address) + function allowed(address user) public view returns (bool) { + require(false, stub_error); + user; + dummy; + return false; + } + /// Add the user to the allowed list. /// /// @param user Address of a trusted user. @@ -266,6 +278,17 @@ dummy = 0; } + /// Add substrate user to allowed list. + /// + /// @param user User substrate address. + /// @dev EVM selector for this function is: 0xd06ad267, + /// or in textual repr: addToCollectionAllowListSubstrate(uint256) + function addToCollectionAllowListSubstrate(uint256 user) public { + require(false, stub_error); + user; + dummy = 0; + } + /// Remove the user from the allowed list. /// /// @param user Address of a removed user. @@ -277,6 +300,17 @@ dummy = 0; } + /// Remove substrate user from allowed list. + /// + /// @param user User substrate address. + /// @dev EVM selector for this function is: 0xa31913ed, + /// or in textual repr: removeFromCollectionAllowListSubstrate(uint256) + function removeFromCollectionAllowListSubstrate(uint256 user) public { + require(false, stub_error); + user; + dummy = 0; + } + /// Switch permission for minting. /// /// @param mode Enable if "true". @@ -325,6 +359,18 @@ return ""; } + /// Get collection owner. + /// + /// @return Tuble with sponsor address and his substrate mirror. + /// If address is canonical then substrate mirror is zero and vice versa. + /// @dev EVM selector for this function is: 0xdf727d3b, + /// or in textual repr: collectionOwner() + function collectionOwner() public view returns (Tuple6 memory) { + require(false, stub_error); + dummy; + return Tuple6(0x0000000000000000000000000000000000000000, 0); + } + /// Changes collection owner to another account /// /// @dev Owner can be changed only by current owner --- a/pallets/nonfungible/src/stubs/UniqueNFT.sol +++ b/pallets/nonfungible/src/stubs/UniqueNFT.sol @@ -99,7 +99,7 @@ } /// @title A contract that allows you to work with collections. -/// @dev the ERC-165 identifier for this interface is 0xe54be640 +/// @dev the ERC-165 identifier for this interface is 0x9f70d4e0 contract Collection is Dummy, ERC165 { /// Set collection property. /// @@ -332,6 +332,18 @@ dummy = 0; } + /// Checks that user allowed to operate with collection. + /// + /// @param user User address to check. + /// @dev EVM selector for this function is: 0xd63a8e11, + /// or in textual repr: allowed(address) + function allowed(address user) public view returns (bool) { + require(false, stub_error); + user; + dummy; + return false; + } + /// Add the user to the allowed list. /// /// @param user Address of a trusted user. @@ -343,6 +355,17 @@ dummy = 0; } + /// Add substrate user to allowed list. + /// + /// @param user User substrate address. + /// @dev EVM selector for this function is: 0xd06ad267, + /// or in textual repr: addToCollectionAllowListSubstrate(uint256) + function addToCollectionAllowListSubstrate(uint256 user) public { + require(false, stub_error); + user; + dummy = 0; + } + /// Remove the user from the allowed list. /// /// @param user Address of a removed user. @@ -354,6 +377,17 @@ dummy = 0; } + /// Remove substrate user from allowed list. + /// + /// @param user User substrate address. + /// @dev EVM selector for this function is: 0xa31913ed, + /// or in textual repr: removeFromCollectionAllowListSubstrate(uint256) + function removeFromCollectionAllowListSubstrate(uint256 user) public { + require(false, stub_error); + user; + dummy = 0; + } + /// Switch permission for minting. /// /// @param mode Enable if "true". @@ -402,6 +436,18 @@ return ""; } + /// Get collection owner. + /// + /// @return Tuble with sponsor address and his substrate mirror. + /// If address is canonical then substrate mirror is zero and vice versa. + /// @dev EVM selector for this function is: 0xdf727d3b, + /// or in textual repr: collectionOwner() + function collectionOwner() public view returns (Tuple17 memory) { + require(false, stub_error); + dummy; + return Tuple17(0x0000000000000000000000000000000000000000, 0); + } + /// Changes collection owner to another account /// /// @dev Owner can be changed only by current owner --- a/pallets/refungible/src/stubs/UniqueRefungible.sol +++ b/pallets/refungible/src/stubs/UniqueRefungible.sol @@ -99,7 +99,7 @@ } /// @title A contract that allows you to work with collections. -/// @dev the ERC-165 identifier for this interface is 0xe54be640 +/// @dev the ERC-165 identifier for this interface is 0x9f70d4e0 contract Collection is Dummy, ERC165 { /// Set collection property. /// @@ -332,6 +332,18 @@ dummy = 0; } + /// Checks that user allowed to operate with collection. + /// + /// @param user User address to check. + /// @dev EVM selector for this function is: 0xd63a8e11, + /// or in textual repr: allowed(address) + function allowed(address user) public view returns (bool) { + require(false, stub_error); + user; + dummy; + return false; + } + /// Add the user to the allowed list. /// /// @param user Address of a trusted user. @@ -343,6 +355,17 @@ dummy = 0; } + /// Add substrate user to allowed list. + /// + /// @param user User substrate address. + /// @dev EVM selector for this function is: 0xd06ad267, + /// or in textual repr: addToCollectionAllowListSubstrate(uint256) + function addToCollectionAllowListSubstrate(uint256 user) public { + require(false, stub_error); + user; + dummy = 0; + } + /// Remove the user from the allowed list. /// /// @param user Address of a removed user. @@ -354,6 +377,17 @@ dummy = 0; } + /// Remove substrate user from allowed list. + /// + /// @param user User substrate address. + /// @dev EVM selector for this function is: 0xa31913ed, + /// or in textual repr: removeFromCollectionAllowListSubstrate(uint256) + function removeFromCollectionAllowListSubstrate(uint256 user) public { + require(false, stub_error); + user; + dummy = 0; + } + /// Switch permission for minting. /// /// @param mode Enable if "true". @@ -402,6 +436,18 @@ return ""; } + /// Get collection owner. + /// + /// @return Tuble with sponsor address and his substrate mirror. + /// If address is canonical then substrate mirror is zero and vice versa. + /// @dev EVM selector for this function is: 0xdf727d3b, + /// or in textual repr: collectionOwner() + function collectionOwner() public view returns (Tuple17 memory) { + require(false, stub_error); + dummy; + return Tuple17(0x0000000000000000000000000000000000000000, 0); + } + /// Changes collection owner to another account /// /// @dev Owner can be changed only by current owner --- a/tests/src/eth/allowlist.test.ts +++ b/tests/src/eth/allowlist.test.ts @@ -14,10 +14,22 @@ // You should have received a copy of the GNU General Public License // along with Unique Network. If not, see . +import {IKeyringPair} from '@polkadot/types/types'; import {expect} from 'chai'; -import {contractHelpers, createEthAccountWithBalance, deployFlipper, itWeb3} from './util/helpers'; +import {isAllowlisted, normalizeAccountId} from '../util/helpers'; +import { + contractHelpers, + createEthAccount, + createEthAccountWithBalance, + deployFlipper, + evmCollection, + evmCollectionHelpers, + getCollectionAddressFromResult, + itWeb3, +} from './util/helpers'; +import {itEth, usingEthPlaygrounds} from './util/playgrounds'; -describe('EVM allowlist', () => { +describe('EVM contract allowlist', () => { itWeb3('Contract allowlist can be toggled', async ({api, web3, privateKeyWrapper}) => { const owner = await createEthAccountWithBalance(api, web3, privateKeyWrapper); const flipper = await deployFlipper(web3, owner); @@ -58,3 +70,79 @@ expect(await flipper.methods.getValue().call()).to.be.false; }); }); + +describe('EVM collection allowlist', () => { + let donor: IKeyringPair; + + before(async function() { + await usingEthPlaygrounds(async (_helper, privateKey) => { + donor = privateKey('//Alice'); + }); + }); + + itEth('Collection allowlist can be added and removed by [eth] address', async ({helper}) => { + const owner = await helper.eth.createAccountWithBalance(donor); + const user = helper.eth.createAccount(); + + const {collectionAddress} = await helper.eth.createNonfungibleCollection(owner, 'A', 'B', 'C'); + const collectionEvm = helper.ethNativeContract.collection(collectionAddress, 'nft', owner); + + expect(await collectionEvm.methods.allowed(user).call({from: owner})).to.be.false; + await collectionEvm.methods.addToCollectionAllowList(user).send({from: owner}); + expect(await collectionEvm.methods.allowed(user).call({from: owner})).to.be.true; + + await collectionEvm.methods.removeFromCollectionAllowList(user).send({from: owner}); + expect(await collectionEvm.methods.allowed(user).call({from: owner})).to.be.false; + }); + + itEth('Collection allowlist can be added and removed by [sub] address', async ({helper}) => { + const owner = await helper.eth.createAccountWithBalance(donor); + const user = donor; + + const {collectionAddress, collectionId} = await helper.eth.createNonfungibleCollection(owner, 'A', 'B', 'C'); + const collectionEvm = helper.ethNativeContract.collection(collectionAddress, 'nft', owner); + + expect(await helper.collection.allowed(collectionId, {Substrate: user.address})).to.be.false; + await collectionEvm.methods.addToCollectionAllowListSubstrate(user.addressRaw).send({from: owner}); + expect(await helper.collection.allowed(collectionId, {Substrate: user.address})).to.be.true; + + await collectionEvm.methods.removeFromCollectionAllowListSubstrate(user.addressRaw).send({from: owner}); + expect(await helper.collection.allowed(collectionId, {Substrate: user.address})).to.be.false; + }); + + itEth('Collection allowlist can not be add and remove [eth] address by not owner', async ({helper}) => { + const owner = await helper.eth.createAccountWithBalance(donor); + const notOwner = await helper.eth.createAccountWithBalance(donor); + const user = helper.eth.createAccount(); + + const {collectionAddress} = await helper.eth.createNonfungibleCollection(owner, 'A', 'B', 'C'); + const collectionEvm = helper.ethNativeContract.collection(collectionAddress, 'nft', owner); + + expect(await collectionEvm.methods.allowed(user).call({from: owner})).to.be.false; + await expect(collectionEvm.methods.addToCollectionAllowList(user).call({from: notOwner})).to.be.rejectedWith('NoPermission'); + expect(await collectionEvm.methods.allowed(user).call({from: owner})).to.be.false; + await collectionEvm.methods.addToCollectionAllowList(user).send({from: owner}); + + expect(await collectionEvm.methods.allowed(user).call({from: owner})).to.be.true; + await expect(collectionEvm.methods.removeFromCollectionAllowList(user).call({from: notOwner})).to.be.rejectedWith('NoPermission'); + expect(await collectionEvm.methods.allowed(user).call({from: owner})).to.be.true; + }); + + itEth('Collection allowlist can not be add and remove [sub] address by not owner', async ({helper}) => { + const owner = await helper.eth.createAccountWithBalance(donor); + const notOwner = await helper.eth.createAccountWithBalance(donor); + const user = donor; + + const {collectionAddress, collectionId} = await helper.eth.createNonfungibleCollection(owner, 'A', 'B', 'C'); + const collectionEvm = helper.ethNativeContract.collection(collectionAddress, 'nft', owner); + + expect(await helper.collection.allowed(collectionId, {Substrate: user.address})).to.be.false; + await expect(collectionEvm.methods.addToCollectionAllowListSubstrate(user.addressRaw).call({from: notOwner})).to.be.rejectedWith('NoPermission'); + expect(await helper.collection.allowed(collectionId, {Substrate: user.address})).to.be.false; + await collectionEvm.methods.addToCollectionAllowListSubstrate(user.addressRaw).send({from: owner}); + + expect(await helper.collection.allowed(collectionId, {Substrate: user.address})).to.be.true; + await expect(collectionEvm.methods.removeFromCollectionAllowListSubstrate(user.addressRaw).call({from: notOwner})).to.be.rejectedWith('NoPermission'); + expect(await helper.collection.allowed(collectionId, {Substrate: user.address})).to.be.true; + }); +}); --- a/tests/src/eth/api/UniqueFungible.sol +++ b/tests/src/eth/api/UniqueFungible.sol @@ -13,7 +13,7 @@ } /// @title A contract that allows you to work with collections. -/// @dev the ERC-165 identifier for this interface is 0xe54be640 +/// @dev the ERC-165 identifier for this interface is 0x9f70d4e0 interface Collection is Dummy, ERC165 { /// Set collection property. /// @@ -164,6 +164,13 @@ /// or in textual repr: setCollectionAccess(uint8) function setCollectionAccess(uint8 mode) external; + /// Checks that user allowed to operate with collection. + /// + /// @param user User address to check. + /// @dev EVM selector for this function is: 0xd63a8e11, + /// or in textual repr: allowed(address) + function allowed(address user) external view returns (bool); + /// Add the user to the allowed list. /// /// @param user Address of a trusted user. @@ -171,6 +178,13 @@ /// or in textual repr: addToCollectionAllowList(address) function addToCollectionAllowList(address user) external; + /// Add substrate user to allowed list. + /// + /// @param user User substrate address. + /// @dev EVM selector for this function is: 0xd06ad267, + /// or in textual repr: addToCollectionAllowListSubstrate(uint256) + function addToCollectionAllowListSubstrate(uint256 user) external; + /// Remove the user from the allowed list. /// /// @param user Address of a removed user. @@ -178,6 +192,13 @@ /// or in textual repr: removeFromCollectionAllowList(address) function removeFromCollectionAllowList(address user) external; + /// Remove substrate user from allowed list. + /// + /// @param user User substrate address. + /// @dev EVM selector for this function is: 0xa31913ed, + /// or in textual repr: removeFromCollectionAllowListSubstrate(uint256) + function removeFromCollectionAllowListSubstrate(uint256 user) external; + /// Switch permission for minting. /// /// @param mode Enable if "true". @@ -208,6 +229,14 @@ /// or in textual repr: uniqueCollectionType() function uniqueCollectionType() external returns (string memory); + /// Get collection owner. + /// + /// @return Tuble with sponsor address and his substrate mirror. + /// If address is canonical then substrate mirror is zero and vice versa. + /// @dev EVM selector for this function is: 0xdf727d3b, + /// or in textual repr: collectionOwner() + function collectionOwner() external view returns (Tuple6 memory); + /// Changes collection owner to another account /// /// @dev Owner can be changed only by current owner --- a/tests/src/eth/api/UniqueNFT.sol +++ b/tests/src/eth/api/UniqueNFT.sol @@ -65,7 +65,7 @@ } /// @title A contract that allows you to work with collections. -/// @dev the ERC-165 identifier for this interface is 0xe54be640 +/// @dev the ERC-165 identifier for this interface is 0x9f70d4e0 interface Collection is Dummy, ERC165 { /// Set collection property. /// @@ -216,6 +216,13 @@ /// or in textual repr: setCollectionAccess(uint8) function setCollectionAccess(uint8 mode) external; + /// Checks that user allowed to operate with collection. + /// + /// @param user User address to check. + /// @dev EVM selector for this function is: 0xd63a8e11, + /// or in textual repr: allowed(address) + function allowed(address user) external view returns (bool); + /// Add the user to the allowed list. /// /// @param user Address of a trusted user. @@ -223,6 +230,13 @@ /// or in textual repr: addToCollectionAllowList(address) function addToCollectionAllowList(address user) external; + /// Add substrate user to allowed list. + /// + /// @param user User substrate address. + /// @dev EVM selector for this function is: 0xd06ad267, + /// or in textual repr: addToCollectionAllowListSubstrate(uint256) + function addToCollectionAllowListSubstrate(uint256 user) external; + /// Remove the user from the allowed list. /// /// @param user Address of a removed user. @@ -230,6 +244,13 @@ /// or in textual repr: removeFromCollectionAllowList(address) function removeFromCollectionAllowList(address user) external; + /// Remove substrate user from allowed list. + /// + /// @param user User substrate address. + /// @dev EVM selector for this function is: 0xa31913ed, + /// or in textual repr: removeFromCollectionAllowListSubstrate(uint256) + function removeFromCollectionAllowListSubstrate(uint256 user) external; + /// Switch permission for minting. /// /// @param mode Enable if "true". @@ -260,6 +281,14 @@ /// or in textual repr: uniqueCollectionType() function uniqueCollectionType() external returns (string memory); + /// Get collection owner. + /// + /// @return Tuble with sponsor address and his substrate mirror. + /// If address is canonical then substrate mirror is zero and vice versa. + /// @dev EVM selector for this function is: 0xdf727d3b, + /// or in textual repr: collectionOwner() + function collectionOwner() external view returns (Tuple17 memory); + /// Changes collection owner to another account /// /// @dev Owner can be changed only by current owner --- a/tests/src/eth/api/UniqueRefungible.sol +++ b/tests/src/eth/api/UniqueRefungible.sol @@ -65,7 +65,7 @@ } /// @title A contract that allows you to work with collections. -/// @dev the ERC-165 identifier for this interface is 0xe54be640 +/// @dev the ERC-165 identifier for this interface is 0x9f70d4e0 interface Collection is Dummy, ERC165 { /// Set collection property. /// @@ -216,6 +216,13 @@ /// or in textual repr: setCollectionAccess(uint8) function setCollectionAccess(uint8 mode) external; + /// Checks that user allowed to operate with collection. + /// + /// @param user User address to check. + /// @dev EVM selector for this function is: 0xd63a8e11, + /// or in textual repr: allowed(address) + function allowed(address user) external view returns (bool); + /// Add the user to the allowed list. /// /// @param user Address of a trusted user. @@ -223,6 +230,13 @@ /// or in textual repr: addToCollectionAllowList(address) function addToCollectionAllowList(address user) external; + /// Add substrate user to allowed list. + /// + /// @param user User substrate address. + /// @dev EVM selector for this function is: 0xd06ad267, + /// or in textual repr: addToCollectionAllowListSubstrate(uint256) + function addToCollectionAllowListSubstrate(uint256 user) external; + /// Remove the user from the allowed list. /// /// @param user Address of a removed user. @@ -230,6 +244,13 @@ /// or in textual repr: removeFromCollectionAllowList(address) function removeFromCollectionAllowList(address user) external; + /// Remove substrate user from allowed list. + /// + /// @param user User substrate address. + /// @dev EVM selector for this function is: 0xa31913ed, + /// or in textual repr: removeFromCollectionAllowListSubstrate(uint256) + function removeFromCollectionAllowListSubstrate(uint256 user) external; + /// Switch permission for minting. /// /// @param mode Enable if "true". @@ -260,6 +281,14 @@ /// or in textual repr: uniqueCollectionType() function uniqueCollectionType() external returns (string memory); + /// Get collection owner. + /// + /// @return Tuble with sponsor address and his substrate mirror. + /// If address is canonical then substrate mirror is zero and vice versa. + /// @dev EVM selector for this function is: 0xdf727d3b, + /// or in textual repr: collectionOwner() + function collectionOwner() external view returns (Tuple17 memory); + /// Changes collection owner to another account /// /// @dev Owner can be changed only by current owner --- a/tests/src/eth/fungibleAbi.json +++ b/tests/src/eth/fungibleAbi.json @@ -78,6 +78,15 @@ }, { "inputs": [ + { "internalType": "uint256", "name": "user", "type": "uint256" } + ], + "name": "addToCollectionAllowListSubstrate", + "outputs": [], + "stateMutability": "nonpayable", + "type": "function" + }, + { + "inputs": [ { "internalType": "address", "name": "owner", "type": "address" }, { "internalType": "address", "name": "spender", "type": "address" } ], @@ -88,6 +97,15 @@ }, { "inputs": [ + { "internalType": "address", "name": "user", "type": "address" } + ], + "name": "allowed", + "outputs": [{ "internalType": "bool", "name": "", "type": "bool" }], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [ { "internalType": "address", "name": "spender", "type": "address" }, { "internalType": "uint256", "name": "amount", "type": "uint256" } ], @@ -116,6 +134,23 @@ "type": "function" }, { + "inputs": [], + "name": "collectionOwner", + "outputs": [ + { + "components": [ + { "internalType": "address", "name": "field_0", "type": "address" }, + { "internalType": "uint256", "name": "field_1", "type": "uint256" } + ], + "internalType": "struct Tuple6", + "name": "", + "type": "tuple" + } + ], + "stateMutability": "view", + "type": "function" + }, + { "inputs": [{ "internalType": "string", "name": "key", "type": "string" }], "name": "collectionProperty", "outputs": [{ "internalType": "bytes", "name": "", "type": "bytes" }], @@ -261,6 +296,15 @@ "type": "function" }, { + "inputs": [ + { "internalType": "uint256", "name": "user", "type": "uint256" } + ], + "name": "removeFromCollectionAllowListSubstrate", + "outputs": [], + "stateMutability": "nonpayable", + "type": "function" + }, + { "inputs": [{ "internalType": "uint8", "name": "mode", "type": "uint8" }], "name": "setCollectionAccess", "outputs": [], --- a/tests/src/eth/nonFungibleAbi.json +++ b/tests/src/eth/nonFungibleAbi.json @@ -109,6 +109,24 @@ }, { "inputs": [ + { "internalType": "uint256", "name": "user", "type": "uint256" } + ], + "name": "addToCollectionAllowListSubstrate", + "outputs": [], + "stateMutability": "nonpayable", + "type": "function" + }, + { + "inputs": [ + { "internalType": "address", "name": "user", "type": "address" } + ], + "name": "allowed", + "outputs": [{ "internalType": "bool", "name": "", "type": "bool" }], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [ { "internalType": "address", "name": "approved", "type": "address" }, { "internalType": "uint256", "name": "tokenId", "type": "uint256" } ], @@ -146,6 +164,23 @@ "type": "function" }, { + "inputs": [], + "name": "collectionOwner", + "outputs": [ + { + "components": [ + { "internalType": "address", "name": "field_0", "type": "address" }, + { "internalType": "uint256", "name": "field_1", "type": "uint256" } + ], + "internalType": "struct Tuple17", + "name": "", + "type": "tuple" + } + ], + "stateMutability": "view", + "type": "function" + }, + { "inputs": [{ "internalType": "string", "name": "key", "type": "string" }], "name": "collectionProperty", "outputs": [{ "internalType": "bytes", "name": "", "type": "bytes" }], @@ -376,6 +411,15 @@ }, { "inputs": [ + { "internalType": "uint256", "name": "user", "type": "uint256" } + ], + "name": "removeFromCollectionAllowListSubstrate", + "outputs": [], + "stateMutability": "nonpayable", + "type": "function" + }, + { + "inputs": [ { "internalType": "address", "name": "from", "type": "address" }, { "internalType": "address", "name": "to", "type": "address" }, { "internalType": "uint256", "name": "tokenId", "type": "uint256" } --- a/tests/src/eth/reFungibleAbi.json +++ b/tests/src/eth/reFungibleAbi.json @@ -109,6 +109,24 @@ }, { "inputs": [ + { "internalType": "uint256", "name": "user", "type": "uint256" } + ], + "name": "addToCollectionAllowListSubstrate", + "outputs": [], + "stateMutability": "nonpayable", + "type": "function" + }, + { + "inputs": [ + { "internalType": "address", "name": "user", "type": "address" } + ], + "name": "allowed", + "outputs": [{ "internalType": "bool", "name": "", "type": "bool" }], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [ { "internalType": "address", "name": "approved", "type": "address" }, { "internalType": "uint256", "name": "tokenId", "type": "uint256" } ], @@ -146,6 +164,23 @@ "type": "function" }, { + "inputs": [], + "name": "collectionOwner", + "outputs": [ + { + "components": [ + { "internalType": "address", "name": "field_0", "type": "address" }, + { "internalType": "uint256", "name": "field_1", "type": "uint256" } + ], + "internalType": "struct Tuple17", + "name": "", + "type": "tuple" + } + ], + "stateMutability": "view", + "type": "function" + }, + { "inputs": [{ "internalType": "string", "name": "key", "type": "string" }], "name": "collectionProperty", "outputs": [{ "internalType": "bytes", "name": "", "type": "bytes" }], @@ -376,6 +411,15 @@ }, { "inputs": [ + { "internalType": "uint256", "name": "user", "type": "uint256" } + ], + "name": "removeFromCollectionAllowListSubstrate", + "outputs": [], + "stateMutability": "nonpayable", + "type": "function" + }, + { + "inputs": [ { "internalType": "address", "name": "from", "type": "address" }, { "internalType": "address", "name": "to", "type": "address" }, { "internalType": "uint256", "name": "tokenId", "type": "uint256" } --- a/tests/src/util/helpers.ts +++ b/tests/src/util/helpers.ts @@ -1651,7 +1651,7 @@ }); } -export async function isAllowlisted(api: ApiPromise, collectionId: number, address: string | CrossAccountId) { +export async function isAllowlisted(api: ApiPromise, collectionId: number, address: string | CrossAccountId | IKeyringPair) { return (await api.rpc.unique.allowed(collectionId, normalizeAccountId(address))).toJSON(); } --- a/tests/src/util/playgrounds/unique.ts +++ b/tests/src/util/playgrounds/unique.ts @@ -730,6 +730,18 @@ } /** + * Check if user is in allow list. + * + * @param collectionId ID of collection + * @param user Account to check + * @example await getAdmins(1) + * @returns is user in allow list + */ + async allowed(collectionId: number, user: ICrossAccountId): Promise { + return (await this.helper.callRpc('api.rpc.unique.allowed', [collectionId, user])).toJSON(); + } + + /** * Adds an address to allow list * @param signer keyring of signer * @param collectionId ID of collection