difftreelog
CORE-302 Some refactor
in: master
3 files changed
pallets/evm-collection/src/eth.rsdiffbeforeafterboth1// 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/>.1617use core::marker::PhantomData;18use evm_coder::{abi::AbiWriter, execution::*, generate_stubgen, solidity_interface, types::*, ToLog};19use ethereum as _;20use pallet_common::CollectionById;21use pallet_common::CollectionHandle;22use pallet_evm_coder_substrate::{SubstrateRecorder, WithRecorder};23use pallet_evm::{24 ExitRevert, OnCreate, OnMethodCall, PrecompileResult, PrecompileFailure,25 account::CrossAccountId, Pallet as PalletEvm,26};27use sp_core::H160;28use up_data_structs::{29 CreateCollectionData, MAX_COLLECTION_DESCRIPTION_LENGTH, MAX_TOKEN_PREFIX_LENGTH,30 MAX_COLLECTION_NAME_LENGTH, OFFCHAIN_SCHEMA_LIMIT, VARIABLE_ON_CHAIN_SCHEMA_LIMIT,31 CONST_ON_CHAIN_SCHEMA_LIMIT,32};33use crate::{Config, Pallet};34use frame_support::traits::Get;3536use sp_std::{vec::Vec, rc::Rc};37use alloc::format;3839struct EvmCollection<T: Config>(SubstrateRecorder<T>);40impl<T: Config> WithRecorder<T> for EvmCollection<T> {41 fn recorder(&self) -> &SubstrateRecorder<T> {42 &self.043 }4445 fn into_recorder(self) -> SubstrateRecorder<T> {46 self.047 }48}4950#[derive(ToLog)]51pub enum CollectionEvent {52 CollectionCreated {53 #[indexed]54 owner: address,55 #[indexed]56 collection_id: address,57 },58}5960#[solidity_interface(name = "Collection")]61impl<T: Config> EvmCollection<T> {62 fn create_721_collection(63 &self,64 caller: caller,65 name: string,66 description: string,67 token_prefix: string,68 ) -> Result<address> {69 let caller = T::CrossAccountId::from_eth(caller);70 let name = name71 .encode_utf16()72 .collect::<Vec<u16>>()73 .try_into()74 .map_err(|_| error_feild_too_long("name", MAX_COLLECTION_NAME_LENGTH))?;75 let description = description76 .encode_utf16()77 .collect::<Vec<u16>>()78 .try_into()79 .map_err(|_| error_feild_too_long("description", MAX_COLLECTION_DESCRIPTION_LENGTH))?;80 let token_prefix = token_prefix81 .into_bytes()82 .try_into()83 .map_err(|_| error_feild_too_long("token_prefix", MAX_TOKEN_PREFIX_LENGTH))?;8485 let data = CreateCollectionData {86 name,87 description,88 token_prefix,89 ..Default::default()90 };9192 let collection_id =93 <pallet_nonfungible::Pallet<T>>::init_collection(caller.as_sub().clone(), data)94 .map_err(pallet_evm_coder_substrate::dispatch_to_evm::<T>)?;9596 let address = pallet_common::eth::collection_id_to_address(collection_id);97 <PalletEvm<T>>::deposit_log(98 CollectionEvent::CollectionCreated {99 owner: *caller.as_eth(),100 collection_id: address,101 }102 .to_log(address),103 );104 Ok(address)105 }106107 fn set_sponsor(108 &self,109 caller: caller,110 collection_address: address,111 sponsor: address,112 ) -> Result<void> {113 let mut collection = collection_from_address(collection_address, &self.0)?;114 check_is_owner(caller, &collection)?;115116 fn set_offchain_shema(shema: string) -> Result<void> {117 let shema = shema118 .into_bytes()119 .try_into()120 .map_err(|_| error_feild_too_long(stringify!(shema), OFFCHAIN_SCHEMA_LIMIT))?;121 collection.offchain_schema = shema;122 save(collection)123 }124125 fn confirm_sponsorship(&self, caller: caller, collection_address: address) -> Result<void> {126 let mut collection = collection_from_address(collection_address, &self.0)?;127 let caller = T::CrossAccountId::from_eth(caller);128 if !collection.confirm_sponsorship(caller.as_sub()) {129 return Err(Error::Revert("Caller is not set as sponsor".into()));130 }131 save(collection)132 }133134 fn set_offchain_shema(135 &self,136 caller: caller,137 collection_address: address,138 shema: string,139 ) -> Result<void> {140 let mut collection = collection_from_address(collection_address, &self.0)?;141 check_is_owner(caller, &collection)?;142143 let shema = shema144 .into_bytes()145 .try_into()146 .map_err(|_| error_feild_too_long(stringify!(shema), OFFCHAIN_SCHEMA_LIMIT))?;147 collection.offchain_schema = shema;148 save(collection)149 }150151 fn set_variable_on_chain_schema(152 &self,153 caller: caller,154 collection_address: address,155 variable: string,156 ) -> Result<void> {157 let mut collection = collection_from_address(collection_address, &self.0)?;158 check_is_owner(caller, &collection)?;159160 let variable = variable.into_bytes().try_into().map_err(|_| {161 error_feild_too_long(stringify!(variable), VARIABLE_ON_CHAIN_SCHEMA_LIMIT)162 })?;163 collection.variable_on_chain_schema = variable;164 save(collection)165 }166167 fn set_const_on_chain_schema(168 &self,169 caller: caller,170 collection_address: address,171 const_on_chain: string,172 ) -> Result<void> {173 let mut collection = collection_from_address(collection_address, &self.0)?;174 check_is_owner(caller, &collection)?;175176 let const_on_chain = const_on_chain.into_bytes().try_into().map_err(|_| {177 error_feild_too_long(stringify!(const_on_chain), CONST_ON_CHAIN_SCHEMA_LIMIT)178 })?;179 collection.const_on_chain_schema = const_on_chain;180 save(collection)181 }182183 fn set_limits(184 &self,185 caller: caller,186 collection_address: address,187 limits_json: string,188 ) -> Result<void> {189 let mut collection = collection_from_address(collection_address, &self.0)?;190 check_is_owner(caller, &collection)?;191192 let limits = serde_json::from_str(limits_json.as_ref())193 .map_err(|e| Error::Revert(format!("Parse JSON error: {}", e)))?;194 collection.limits = limits;195 save(collection)196 }197}198199fn error_feild_too_long(feild: &str, bound: u32) -> Error {200 Error::Revert(format!("{} is too long. Max length is {}.", feild, bound))201}202203fn collection_from_address<T: Config>(204 collection_address: address,205 recorder: &Rc<SubstrateRecorder<T>>,206) -> Result<CollectionHandle<T>> {207 let collection_id = pallet_common::eth::map_eth_to_id(&collection_address)208 .ok_or(Error::Revert("Bad ETH prefix".into()))?;209 let collection =210 pallet_common::CollectionHandle::new_with_recorder(collection_id, recorder.clone())211 .ok_or(Error::Revert("Create collection handle error".into()))?;212 Ok(collection)213}214215fn check_is_owner<T: Config>(caller: caller, collection: &CollectionHandle<T>) -> Result<()> {216 let caller = T::CrossAccountId::from_eth(caller);217 collection218 .check_is_owner(&caller)219 .map_err(|e| Error::Revert(format!("{:?}", e)))?;220 Ok(())221}222223fn save<T: Config>(collection: CollectionHandle<T>) -> Result<()> {224 collection225 .save()226 .map_err(|e| Error::Revert(format!("{:?}", e)))227}228229pub struct CollectionOnMethodCall<T: Config>(PhantomData<*const T>);230impl<T: Config> OnMethodCall<T> for CollectionOnMethodCall<T> {231 fn is_reserved(contract: &sp_core::H160) -> bool {232 contract == &T::ContractAddress::get()233 }234235 fn is_used(contract: &sp_core::H160) -> bool {236 contract == &T::ContractAddress::get()237 }238239 fn call(240 source: &sp_core::H160,241 target: &sp_core::H160,242 gas_left: u64,243 input: &[u8],244 value: sp_core::U256,245 ) -> Option<PrecompileResult> {246 // TODO: Extract to another OnMethodCall handler247 if target != &T::ContractAddress::get() {248 return None;249 }250251 let helpers = EvmCollection::<T>(SubstrateRecorder::new(gas_left));252 pallet_evm_coder_substrate::call(*source, helpers, value, input)253 }254255 fn get_code(contract: &sp_core::H160) -> Option<Vec<u8>> {256 (contract == &T::ContractAddress::get())257 .then(|| include_bytes!("./stubs/Collection.raw").to_vec())258 }259}260261generate_stubgen!(collection_impl, CollectionCall<()>, true);262generate_stubgen!(collection_iface, CollectionCall<()>, false);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/>.1617use core::marker::PhantomData;18use evm_coder::{abi::AbiWriter, execution::*, generate_stubgen, solidity_interface, types::*, ToLog};19use ethereum as _;20use pallet_common::CollectionById;21use pallet_common::CollectionHandle;22use pallet_evm_coder_substrate::{SubstrateRecorder, WithRecorder};23use pallet_evm::{24 ExitRevert, OnCreate, OnMethodCall, PrecompileResult, PrecompileFailure,25 account::CrossAccountId, Pallet as PalletEvm,26};27use sp_core::H160;28use up_data_structs::{29 CreateCollectionData, MAX_COLLECTION_DESCRIPTION_LENGTH, MAX_TOKEN_PREFIX_LENGTH,30 MAX_COLLECTION_NAME_LENGTH, OFFCHAIN_SCHEMA_LIMIT, VARIABLE_ON_CHAIN_SCHEMA_LIMIT,31 CONST_ON_CHAIN_SCHEMA_LIMIT,32};33use crate::{Config, Pallet};34use frame_support::traits::Get;3536use sp_std::{vec::Vec, rc::Rc};37use alloc::format;3839struct EvmCollection<T: Config>(SubstrateRecorder<T>);40impl<T: Config> WithRecorder<T> for EvmCollection<T> {41 fn recorder(&self) -> &SubstrateRecorder<T> {42 &self.043 }4445 fn into_recorder(self) -> SubstrateRecorder<T> {46 self.047 }48}4950#[derive(ToLog)]51pub enum CollectionEvent {52 CollectionCreated {53 #[indexed]54 owner: address,55 #[indexed]56 collection_id: address,57 },58}5960#[solidity_interface(name = "Collection")]61impl<T: Config> EvmCollection<T> {62 fn create_721_collection(63 &self,64 caller: caller,65 name: string,66 description: string,67 token_prefix: string,68 ) -> Result<address> {69 let caller = T::CrossAccountId::from_eth(caller);70 let name = name71 .encode_utf16()72 .collect::<Vec<u16>>()73 .try_into()74 .map_err(|_| error_feild_too_long("name", MAX_COLLECTION_NAME_LENGTH))?;75 let description = description76 .encode_utf16()77 .collect::<Vec<u16>>()78 .try_into()79 .map_err(|_| error_feild_too_long("description", MAX_COLLECTION_DESCRIPTION_LENGTH))?;80 let token_prefix = token_prefix81 .into_bytes()82 .try_into()83 .map_err(|_| error_feild_too_long("token_prefix", MAX_TOKEN_PREFIX_LENGTH))?;8485 let data = CreateCollectionData {86 name,87 description,88 token_prefix,89 ..Default::default()90 };9192 let collection_id =93 <pallet_nonfungible::Pallet<T>>::init_collection(caller.as_sub().clone(), data)94 .map_err(pallet_evm_coder_substrate::dispatch_to_evm::<T>)?;9596 let address = pallet_common::eth::collection_id_to_address(collection_id);97 <PalletEvm<T>>::deposit_log(98 CollectionEvent::CollectionCreated {99 owner: *caller.as_eth(),100 collection_id: address,101 }102 .to_log(address),103 );104 Ok(address)105 }106107 fn set_sponsor(108 &self,109 caller: caller,110 collection_address: address,111 sponsor: address,112 ) -> Result<void> {113 let mut collection = collection_from_address(collection_address, &self.0)?;114 check_is_owner(caller, &collection)?;115116 fn set_offchain_shema(shema: string) -> Result<void> {117 let shema = shema118 .into_bytes()119 .try_into()120 .map_err(|_| error_feild_too_long(stringify!(shema), OFFCHAIN_SCHEMA_LIMIT))?;121 collection.offchain_schema = shema;122 save(collection)123 }124125 fn confirm_sponsorship(&self, caller: caller, collection_address: address) -> Result<void> {126 let mut collection = collection_from_address(collection_address, &self.0)?;127 let caller = T::CrossAccountId::from_eth(caller);128 if !collection.confirm_sponsorship(caller.as_sub()) {129 return Err(Error::Revert("Caller is not set as sponsor".into()));130 }131 save(collection)132 }133134 fn set_offchain_shema(135 &self,136 caller: caller,137 collection_address: address,138 shema: string,139 ) -> Result<void> {140 let mut collection = collection_from_address(collection_address, &self.0)?;141 check_is_owner(caller, &collection)?;142143 let shema = shema144 .into_bytes()145 .try_into()146 .map_err(|_| error_feild_too_long(stringify!(shema), OFFCHAIN_SCHEMA_LIMIT))?;147 collection.offchain_schema = shema;148 save(collection)149 }150151 fn set_variable_on_chain_schema(152 &self,153 caller: caller,154 collection_address: address,155 variable: string,156 ) -> Result<void> {157 let mut collection = collection_from_address(collection_address, &self.0)?;158 check_is_owner(caller, &collection)?;159160 let variable = variable.into_bytes().try_into().map_err(|_| {161 error_feild_too_long(stringify!(variable), VARIABLE_ON_CHAIN_SCHEMA_LIMIT)162 })?;163 collection.variable_on_chain_schema = variable;164 save(collection)165 }166167 fn set_const_on_chain_schema(168 &self,169 caller: caller,170 collection_address: address,171 const_on_chain: string,172 ) -> Result<void> {173 let mut collection = collection_from_address(collection_address, &self.0)?;174 check_is_owner(caller, &collection)?;175176 let const_on_chain = const_on_chain.into_bytes().try_into().map_err(|_| {177 error_feild_too_long(stringify!(const_on_chain), CONST_ON_CHAIN_SCHEMA_LIMIT)178 })?;179 collection.const_on_chain_schema = const_on_chain;180 save(collection)181 }182183 fn set_limits(184 &self,185 caller: caller,186 collection_address: address,187 limits_json: string,188 ) -> Result<void> {189 let mut collection = collection_from_address(collection_address, &self.0)?;190 check_is_owner(caller, &collection)?;191192 let limits = serde_json::from_str(limits_json.as_ref())193 .map_err(|e| Error::Revert(format!("Parse JSON error: {}", e)))?;194 collection.limits = limits;195 save(collection)196 }197}198199fn error_feild_too_long(feild: &str, bound: u32) -> Error {200 Error::Revert(format!("{} is too long. Max length is {}.", feild, bound))201}202203fn collection_from_address<T: Config>(204 collection_address: address,205 recorder: &Rc<SubstrateRecorder<T>>,206) -> Result<CollectionHandle<T>> {207 let collection_id = pallet_common::eth::map_eth_to_id(&collection_address)208 .ok_or(Error::Revert("Contract is not an unique collection".into()))?;209 let collection =210 pallet_common::CollectionHandle::new_with_recorder(collection_id, recorder.clone())211 .ok_or(Error::Revert("Create collection handle error".into()))?;212 Ok(collection)213}214215fn check_is_owner<T: Config>(caller: caller, collection: &CollectionHandle<T>) -> Result<()> {216 let caller = T::CrossAccountId::from_eth(caller);217 collection218 .check_is_owner(&caller)219 .map_err(pallet_evm_coder_substrate::dispatch_to_evm::<T>)?;220 Ok(())221}222223fn save<T: Config>(collection: CollectionHandle<T>) -> Result<()> {224 Ok(collection225 .save()226 .map_err(pallet_evm_coder_substrate::dispatch_to_evm::<T>)?)227}228229pub struct CollectionOnMethodCall<T: Config>(PhantomData<*const T>);230impl<T: Config> OnMethodCall<T> for CollectionOnMethodCall<T> {231 fn is_reserved(contract: &sp_core::H160) -> bool {232 contract == &T::ContractAddress::get()233 }234235 fn is_used(contract: &sp_core::H160) -> bool {236 contract == &T::ContractAddress::get()237 }238239 fn call(240 source: &sp_core::H160,241 target: &sp_core::H160,242 gas_left: u64,243 input: &[u8],244 value: sp_core::U256,245 ) -> Option<PrecompileResult> {246 if target != &T::ContractAddress::get() {247 return None;248 }249250 let helpers = EvmCollection::<T>(SubstrateRecorder::new(gas_left));251 pallet_evm_coder_substrate::call(*source, helpers, value, input)252 }253254 fn get_code(contract: &sp_core::H160) -> Option<Vec<u8>> {255 (contract == &T::ContractAddress::get())256 .then(|| include_bytes!("./stubs/Collection.raw").to_vec())257 }258}259260generate_stubgen!(collection_impl, CollectionCall<()>, true);261generate_stubgen!(collection_iface, CollectionCall<()>, false);tests/package.jsondiffbeforeafterboth--- a/tests/package.json
+++ b/tests/package.json
@@ -73,6 +73,7 @@
"testBlockProduction": "mocha --timeout 9999999 -r ts-node/register ./**/block-production.test.ts",
"testEnableDisableTransfers": "mocha --timeout 9999999 -r ts-node/register ./**/enableDisableTransfer.test.ts",
"testLimits": "mocha --timeout 9999999 -r ts-node/register ./**/limits.test.ts",
+ "testEthCreateCollection": "mocha --timeout 9999999 -r ts-node/register ./**/eth/createCollection.test.ts",
"polkadot-types-fetch-metadata": "curl -H 'Content-Type: application/json' -d '{\"id\":\"1\", \"jsonrpc\":\"2.0\", \"method\": \"state_getMetadata\", \"params\":[]}' http://localhost:9933 > src/interfaces/metadata.json",
"polkadot-types-from-defs": "ts-node ./node_modules/.bin/polkadot-types-from-defs --endpoint src/interfaces/metadata.json --input src/interfaces/ --package .",
"polkadot-types-from-chain": "ts-node ./node_modules/.bin/polkadot-types-from-chain --endpoint src/interfaces/metadata.json --output src/interfaces/ --package .",
tests/src/eth/createCollection.test.tsdiffbeforeafterboth--- a/tests/src/eth/createCollection.test.ts
+++ b/tests/src/eth/createCollection.test.ts
@@ -231,11 +231,11 @@
.call()).to.be.rejectedWith('NotSufficientFounds');
});
- itWeb3('(!negative test!) Collection address (Bad ETH prefix)', async ({api, web3}) => {
+ itWeb3('(!negative test!) Collection address (Contract is not an unique collection)', async ({api, web3}) => {
const owner = await createEthAccountWithBalance(api, web3);
const helper = collectionHelper(web3, owner);
const collectionAddressWithBadPrefix = '0x00112233445566778899AABBCCDDEEFF00112233';
- const EXPECTED_ERROR = 'Bad ETH prefix';
+ const EXPECTED_ERROR = 'Contract is not an unique collection';
{
const sponsor = await createEthAccountWithBalance(api, web3);
await expect(helper.methods