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

difftreelog

feat add dispatching

Trubnikov Sergey2023-04-21parent: #60662cc.patch.diff
in: master

6 files changed

addedpallets/balances-adapter/src/common.rsdiffbeforeafterboth
--- /dev/null
+++ b/pallets/balances-adapter/src/common.rs
@@ -0,0 +1,352 @@
+use alloc::vec::Vec;
+use core::marker::PhantomData;
+use crate::{Config, NativeFungibleHandle};
+use pallet_common::{CommonCollectionOperations, CommonWeightInfo};
+
+pub struct CommonWeights<T: Config>(PhantomData<T>);
+impl<T: Config> CommonWeightInfo<T::CrossAccountId> for CommonWeights<T> {
+	fn create_multiple_items(
+		amount: &[up_data_structs::CreateItemData],
+	) -> frame_support::weights::Weight {
+		todo!()
+	}
+
+	fn create_multiple_items_ex(
+		cost: &up_data_structs::CreateItemExData<T::CrossAccountId>,
+	) -> frame_support::weights::Weight {
+		todo!()
+	}
+
+	fn burn_item() -> frame_support::weights::Weight {
+		todo!()
+	}
+
+	fn set_collection_properties(amount: u32) -> frame_support::weights::Weight {
+		todo!()
+	}
+
+	fn delete_collection_properties(amount: u32) -> frame_support::weights::Weight {
+		todo!()
+	}
+
+	fn set_token_properties(amount: u32) -> frame_support::weights::Weight {
+		todo!()
+	}
+
+	fn delete_token_properties(amount: u32) -> frame_support::weights::Weight {
+		todo!()
+	}
+
+	fn set_token_property_permissions(amount: u32) -> frame_support::weights::Weight {
+		todo!()
+	}
+
+	fn transfer() -> frame_support::weights::Weight {
+		todo!()
+	}
+
+	fn approve() -> frame_support::weights::Weight {
+		todo!()
+	}
+
+	fn approve_from() -> frame_support::weights::Weight {
+		todo!()
+	}
+
+	fn transfer_from() -> frame_support::weights::Weight {
+		todo!()
+	}
+
+	fn burn_from() -> frame_support::weights::Weight {
+		todo!()
+	}
+
+	fn burn_recursively_self_raw() -> frame_support::weights::Weight {
+		todo!()
+	}
+
+	fn burn_recursively_breadth_raw(amount: u32) -> frame_support::weights::Weight {
+		todo!()
+	}
+
+	fn token_owner() -> frame_support::weights::Weight {
+		todo!()
+	}
+
+	fn set_allowance_for_all() -> frame_support::weights::Weight {
+		todo!()
+	}
+
+	fn force_repair_item() -> frame_support::weights::Weight {
+		todo!()
+	}
+}
+
+/// Implementation of `CommonCollectionOperations` for `FungibleHandle`. It wraps FungibleHandle Pallete
+/// methods and adds weight info.
+impl<T: Config> CommonCollectionOperations<T> for NativeFungibleHandle<T> {
+	fn create_item(
+		&self,
+		sender: <T>::CrossAccountId,
+		to: <T>::CrossAccountId,
+		data: up_data_structs::CreateItemData,
+		nesting_budget: &dyn up_data_structs::budget::Budget,
+	) -> frame_support::pallet_prelude::DispatchResultWithPostInfo {
+		todo!()
+	}
+
+	fn create_multiple_items(
+		&self,
+		sender: <T>::CrossAccountId,
+		to: <T>::CrossAccountId,
+		data: Vec<up_data_structs::CreateItemData>,
+		nesting_budget: &dyn up_data_structs::budget::Budget,
+	) -> frame_support::pallet_prelude::DispatchResultWithPostInfo {
+		todo!()
+	}
+
+	fn create_multiple_items_ex(
+		&self,
+		sender: <T>::CrossAccountId,
+		data: up_data_structs::CreateItemExData<<T>::CrossAccountId>,
+		nesting_budget: &dyn up_data_structs::budget::Budget,
+	) -> frame_support::pallet_prelude::DispatchResultWithPostInfo {
+		todo!()
+	}
+
+	fn burn_item(
+		&self,
+		sender: <T>::CrossAccountId,
+		token: up_data_structs::TokenId,
+		amount: u128,
+	) -> frame_support::pallet_prelude::DispatchResultWithPostInfo {
+		todo!()
+	}
+
+	fn burn_item_recursively(
+		&self,
+		sender: <T>::CrossAccountId,
+		token: up_data_structs::TokenId,
+		self_budget: &dyn up_data_structs::budget::Budget,
+		breadth_budget: &dyn up_data_structs::budget::Budget,
+	) -> frame_support::pallet_prelude::DispatchResultWithPostInfo {
+		todo!()
+	}
+
+	fn set_collection_properties(
+		&self,
+		sender: <T>::CrossAccountId,
+		properties: Vec<up_data_structs::Property>,
+	) -> frame_support::pallet_prelude::DispatchResultWithPostInfo {
+		todo!()
+	}
+
+	fn delete_collection_properties(
+		&self,
+		sender: &<T>::CrossAccountId,
+		property_keys: Vec<up_data_structs::PropertyKey>,
+	) -> frame_support::pallet_prelude::DispatchResultWithPostInfo {
+		todo!()
+	}
+
+	fn set_token_properties(
+		&self,
+		sender: <T>::CrossAccountId,
+		token_id: up_data_structs::TokenId,
+		properties: Vec<up_data_structs::Property>,
+		budget: &dyn up_data_structs::budget::Budget,
+	) -> frame_support::pallet_prelude::DispatchResultWithPostInfo {
+		todo!()
+	}
+
+	fn delete_token_properties(
+		&self,
+		sender: <T>::CrossAccountId,
+		token_id: up_data_structs::TokenId,
+		property_keys: Vec<up_data_structs::PropertyKey>,
+		budget: &dyn up_data_structs::budget::Budget,
+	) -> frame_support::pallet_prelude::DispatchResultWithPostInfo {
+		todo!()
+	}
+
+	fn set_token_property_permissions(
+		&self,
+		sender: &<T>::CrossAccountId,
+		property_permissions: Vec<up_data_structs::PropertyKeyPermission>,
+	) -> frame_support::pallet_prelude::DispatchResultWithPostInfo {
+		todo!()
+	}
+
+	fn transfer(
+		&self,
+		sender: <T>::CrossAccountId,
+		to: <T>::CrossAccountId,
+		token: up_data_structs::TokenId,
+		amount: u128,
+		budget: &dyn up_data_structs::budget::Budget,
+	) -> frame_support::pallet_prelude::DispatchResultWithPostInfo {
+		todo!()
+	}
+
+	fn approve(
+		&self,
+		sender: <T>::CrossAccountId,
+		spender: <T>::CrossAccountId,
+		token: up_data_structs::TokenId,
+		amount: u128,
+	) -> frame_support::pallet_prelude::DispatchResultWithPostInfo {
+		todo!()
+	}
+
+	fn approve_from(
+		&self,
+		sender: <T>::CrossAccountId,
+		from: <T>::CrossAccountId,
+		to: <T>::CrossAccountId,
+		token: up_data_structs::TokenId,
+		amount: u128,
+	) -> frame_support::pallet_prelude::DispatchResultWithPostInfo {
+		todo!()
+	}
+
+	fn transfer_from(
+		&self,
+		sender: <T>::CrossAccountId,
+		from: <T>::CrossAccountId,
+		to: <T>::CrossAccountId,
+		token: up_data_structs::TokenId,
+		amount: u128,
+		budget: &dyn up_data_structs::budget::Budget,
+	) -> frame_support::pallet_prelude::DispatchResultWithPostInfo {
+		todo!()
+	}
+
+	fn burn_from(
+		&self,
+		sender: <T>::CrossAccountId,
+		from: <T>::CrossAccountId,
+		token: up_data_structs::TokenId,
+		amount: u128,
+		budget: &dyn up_data_structs::budget::Budget,
+	) -> frame_support::pallet_prelude::DispatchResultWithPostInfo {
+		todo!()
+	}
+
+	fn check_nesting(
+		&self,
+		sender: <T>::CrossAccountId,
+		from: (up_data_structs::CollectionId, up_data_structs::TokenId),
+		under: up_data_structs::TokenId,
+		budget: &dyn up_data_structs::budget::Budget,
+	) -> frame_support::sp_runtime::DispatchResult {
+		todo!()
+	}
+
+	fn nest(
+		&self,
+		under: up_data_structs::TokenId,
+		to_nest: (up_data_structs::CollectionId, up_data_structs::TokenId),
+	) {
+		todo!()
+	}
+
+	fn unnest(
+		&self,
+		under: up_data_structs::TokenId,
+		to_nest: (up_data_structs::CollectionId, up_data_structs::TokenId),
+	) {
+		todo!()
+	}
+
+	fn account_tokens(&self, account: <T>::CrossAccountId) -> Vec<up_data_structs::TokenId> {
+		todo!()
+	}
+
+	fn collection_tokens(&self) -> Vec<up_data_structs::TokenId> {
+		todo!()
+	}
+
+	fn token_exists(&self, token: up_data_structs::TokenId) -> bool {
+		todo!()
+	}
+
+	fn last_token_id(&self) -> up_data_structs::TokenId {
+		todo!()
+	}
+
+	fn token_owner(
+		&self,
+		token: up_data_structs::TokenId,
+	) -> Result<<T>::CrossAccountId, up_data_structs::TokenOwnerError> {
+		todo!()
+	}
+
+	fn token_owners(&self, token: up_data_structs::TokenId) -> Vec<<T>::CrossAccountId> {
+		todo!()
+	}
+
+	fn token_property(
+		&self,
+		token_id: up_data_structs::TokenId,
+		key: &up_data_structs::PropertyKey,
+	) -> Option<up_data_structs::PropertyValue> {
+		todo!()
+	}
+
+	fn token_properties(
+		&self,
+		token: up_data_structs::TokenId,
+		keys: Option<Vec<up_data_structs::PropertyKey>>,
+	) -> Vec<up_data_structs::Property> {
+		todo!()
+	}
+
+	fn total_supply(&self) -> u32 {
+		todo!()
+	}
+
+	fn account_balance(&self, account: <T>::CrossAccountId) -> u32 {
+		todo!()
+	}
+
+	fn balance(&self, account: <T>::CrossAccountId, token: up_data_structs::TokenId) -> u128 {
+		todo!()
+	}
+
+	fn total_pieces(&self, token: up_data_structs::TokenId) -> Option<u128> {
+		todo!()
+	}
+
+	fn allowance(
+		&self,
+		sender: <T>::CrossAccountId,
+		spender: <T>::CrossAccountId,
+		token: up_data_structs::TokenId,
+	) -> u128 {
+		todo!()
+	}
+
+	fn refungible_extensions(&self) -> Option<&dyn pallet_common::RefungibleExtensions<T>> {
+		todo!()
+	}
+
+	fn set_allowance_for_all(
+		&self,
+		owner: <T>::CrossAccountId,
+		operator: <T>::CrossAccountId,
+		approve: bool,
+	) -> frame_support::pallet_prelude::DispatchResultWithPostInfo {
+		todo!()
+	}
+
+	fn allowance_for_all(&self, owner: <T>::CrossAccountId, operator: <T>::CrossAccountId) -> bool {
+		todo!()
+	}
+
+	fn repair_item(
+		&self,
+		token: up_data_structs::TokenId,
+	) -> frame_support::pallet_prelude::DispatchResultWithPostInfo {
+		todo!()
+	}
+}
modifiedpallets/balances-adapter/src/erc.rsdiffbeforeafterboth
--- a/pallets/balances-adapter/src/erc.rs
+++ b/pallets/balances-adapter/src/erc.rs
@@ -1,5 +1,5 @@
-use crate::Config;
-use evm_coder::{abi::AbiType, AbiCoder, ToLog, generate_stubgen, solidity_interface, types::*};
+use crate::{Config, NativeFungibleHandle};
+use evm_coder::{abi::AbiType, ToLog, generate_stubgen, solidity_interface, types::*};
 use frame_support::traits::{Currency, ExistenceRequirement};
 use pallet_common::{
 	erc::{CommonEvmHandler, CrossAccountId, PrecompileHandle, PrecompileResult},
@@ -34,17 +34,6 @@
 		spender: Address,
 		value: U256,
 	},
-}
-
-pub struct NativeFungibleHandle<T: Config>(SubstrateRecorder<T>);
-
-impl<T: Config> WithRecorder<T> for NativeFungibleHandle<T> {
-	fn recorder(&self) -> &pallet_evm_coder_substrate::SubstrateRecorder<T> {
-		&self.0
-	}
-	fn into_recorder(self) -> pallet_evm_coder_substrate::SubstrateRecorder<T> {
-		self.0
-	}
 }
 
 #[solidity_interface(name = ERC20, events(ERC20Events), enum(derive(PreDispatch)), enum_attr(weight), expect_selector = 0x942e8b22)]
modifiedpallets/balances-adapter/src/lib.rsdiffbeforeafterboth
--- a/pallets/balances-adapter/src/lib.rs
+++ b/pallets/balances-adapter/src/lib.rs
@@ -4,17 +4,42 @@
 
 extern crate alloc;
 pub use pallet::*;
+use pallet_common::CollectionHandle;
+use pallet_evm_coder_substrate::{WithRecorder, SubstrateRecorder};
 
+pub mod common;
 pub mod erc;
 
+pub struct NativeFungibleHandle<T: Config>(CollectionHandle<T>);
+impl<T: Config> NativeFungibleHandle<T> {
+	pub fn cast(inner: CollectionHandle<T>) -> Self {
+		Self(inner)
+	}
+
+	/// Casts [`NativeFungibleHandle`] into [`CollectionHandle`][`pallet_common::CollectionHandle`].
+	pub fn into_inner(self) -> pallet_common::CollectionHandle<T> {
+		self.0
+	}
+}
+
+impl<T: Config> WithRecorder<T> for NativeFungibleHandle<T> {
+	fn recorder(&self) -> &pallet_evm_coder_substrate::SubstrateRecorder<T> {
+		&self.0.recorder
+	}
+	fn into_recorder(self) -> pallet_evm_coder_substrate::SubstrateRecorder<T> {
+		self.0.recorder
+	}
+}
 #[frame_support::pallet]
 pub mod pallet {
 	use alloc::string::String;
-	use frame_support::traits::Get;
+	use frame_support::{traits::Get, sp_runtime::DispatchResult};
 	use sp_core::U256;
 
 	#[pallet::config]
-	pub trait Config: frame_system::Config + pallet_evm_coder_substrate::Config {
+	pub trait Config:
+		frame_system::Config + pallet_evm_coder_substrate::Config + pallet_common::Config
+	{
 		type Currency: frame_support::traits::Currency<
 			Self::AccountId,
 			Balance = Self::CurrencyBalance,
@@ -28,6 +53,10 @@
 	#[pallet::pallet]
 	pub struct Pallet<T>(_);
 
-	#[pallet::call]
-	impl<T: Config> Pallet<T> {}
+	// #[pallet::call]
+	impl<T: Config> Pallet<T> {
+		pub fn dummy() -> DispatchResult {
+			Ok(())
+		}
+	}
 }
modifiedruntime/common/dispatch.rsdiffbeforeafterboth
--- a/runtime/common/dispatch.rs
+++ b/runtime/common/dispatch.rs
@@ -25,6 +25,7 @@
 };
 pub use pallet_common::dispatch::CollectionDispatch;
 use pallet_fungible::{Pallet as PalletFungible, FungibleHandle};
+use pallet_balances_adapter::{Pallet as PalletNativeFungible, NativeFungibleHandle};
 use pallet_nonfungible::{Pallet as PalletNonfungible, NonfungibleHandle};
 use pallet_refungible::{
 	Pallet as PalletRefungible, RefungibleHandle, erc_token::RefungibleTokenHandle,
@@ -39,11 +40,15 @@
 
 pub enum CollectionDispatchT<T>
 where
-	T: pallet_fungible::Config + pallet_nonfungible::Config + pallet_refungible::Config,
+	T: pallet_fungible::Config
+		+ pallet_nonfungible::Config
+		+ pallet_refungible::Config
+		+ pallet_balances_adapter::Config,
 {
 	Fungible(FungibleHandle<T>),
 	Nonfungible(NonfungibleHandle<T>),
 	Refungible(RefungibleHandle<T>),
+	NativeFungible(NativeFungibleHandle<T>),
 }
 impl<T> CollectionDispatch<T> for CollectionDispatchT<T>
 where
@@ -51,7 +56,8 @@
 		+ pallet_unique::Config
 		+ pallet_fungible::Config
 		+ pallet_nonfungible::Config
-		+ pallet_refungible::Config,
+		+ pallet_refungible::Config
+		+ pallet_balances_adapter::Config,
 {
 	fn create(
 		sender: T::CrossAccountId,
@@ -100,7 +106,13 @@
 
 	fn dispatch(handle: CollectionHandle<T>) -> Self {
 		match handle.mode {
-			CollectionMode::Fungible(_) => Self::Fungible(FungibleHandle::cast(handle)),
+			CollectionMode::Fungible(_) => {
+				if handle.id != up_data_structs::CollectionId(0) {
+					Self::Fungible(FungibleHandle::cast(handle))
+				} else {
+					Self::NativeFungible(NativeFungibleHandle::cast(handle))
+				}
+			}
 			CollectionMode::NFT => Self::Nonfungible(NonfungibleHandle::cast(handle)),
 			CollectionMode::ReFungible => Self::Refungible(RefungibleHandle::cast(handle)),
 		}
@@ -111,6 +123,7 @@
 			Self::Fungible(f) => f.into_inner(),
 			Self::Nonfungible(f) => f.into_inner(),
 			Self::Refungible(f) => f.into_inner(),
+			Self::NativeFungible(f) => f.into_inner(),
 		}
 	}
 
@@ -119,6 +132,7 @@
 			Self::Fungible(h) => h,
 			Self::Nonfungible(h) => h,
 			Self::Refungible(h) => h,
+			Self::NativeFungible(h) => h,
 		}
 	}
 }
@@ -129,7 +143,8 @@
 		+ pallet_unique::Config
 		+ pallet_fungible::Config
 		+ pallet_nonfungible::Config
-		+ pallet_refungible::Config,
+		+ pallet_refungible::Config
+		+ pallet_balances_adapter::Config,
 	T::AccountId: From<[u8; 32]> + AsRef<[u8; 32]>,
 {
 	fn is_reserved(target: &H160) -> bool {
@@ -174,6 +189,7 @@
 				Self::Fungible(h) => h.call(handle),
 				Self::Nonfungible(h) => h.call(handle),
 				Self::Refungible(h) => h.call(handle),
+				Self::NativeFungible(f) => todo!(),
 			}
 		} else if let Some((collection_id, token_id)) =
 			<T as pallet_common::Config>::EvmTokenAddressMapping::address_to_token(
addedtests/src/eth/nativeFungible.test.tsdiffbeforeafterboth
--- /dev/null
+++ b/tests/src/eth/nativeFungible.test.ts
@@ -0,0 +1,44 @@
+// Copyright 2019-2023 Unique Network (Gibraltar) Ltd.
+// This file is part of Unique Network.
+
+// Unique Network is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// Unique Network is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with Unique Network. If not, see <http://www.gnu.org/licenses/>.
+
+import {IKeyringPair} from '@polkadot/types/types';
+import {itEth, usingEthPlaygrounds} from './util';
+
+describe('NativeFungible: Plain calls', () => {
+  let donor: IKeyringPair;
+  let alice: IKeyringPair;
+  let owner: IKeyringPair;
+
+  before(async function() {
+    await usingEthPlaygrounds(async (helper, privateKey) => {
+      donor = await privateKey({url: import.meta.url});
+      [alice, owner] = await helper.arrange.createAccounts([30n, 20n], donor);
+    });
+  });
+
+  itEth.only('Can perform approve()', async ({helper}) => {
+    const owner = await helper.eth.createAccountWithBalance(donor);
+    const spender = helper.eth.createAccount();
+    const collection = await helper.ft.mintCollection(alice);
+    await collection.mint(alice, 200n, {Ethereum: owner});
+
+    const collectionAddress = helper.ethAddress.fromCollectionId(0);
+    const contract = await helper.ethNativeContract.collection(collectionAddress, 'ft', owner);
+
+
+    await contract.methods.approve(spender, 100).send({from: owner});
+  });
+});
\ No newline at end of file
modifiedtests/src/eth/util/playgrounds/unique.dev.tsdiffbeforeafterboth
before · tests/src/eth/util/playgrounds/unique.dev.ts
1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// SPDX-License-Identifier: Apache-2.034/* eslint-disable function-call-argument-newline */5// eslint-disable-next-line @typescript-eslint/triple-slash-reference6/// <reference path="unique.dev.d.ts" />78import {readFile} from 'fs/promises';910import Web3 from 'web3';11import {WebsocketProvider} from 'web3-core';12import {Contract} from 'web3-eth-contract';1314import solc from 'solc';1516import {evmToAddress} from '@polkadot/util-crypto';17import {IKeyringPair} from '@polkadot/types/types';1819import {ArrangeGroup, DevUniqueHelper} from '../../../util/playgrounds/unique.dev';2021import {ContractImports, CompiledContract, CrossAddress, NormalizedEvent, EthProperty} from './types';2223// Native contracts ABI24import collectionHelpersAbi from '../../abi/collectionHelpers.json' assert {type: 'json'};25import nativeFungibleAbi from '../../abi/nativeFungible.json' assert {type: 'json'};26import fungibleAbi from '../../abi/fungible.json' assert {type: 'json'};27import fungibleDeprecatedAbi from '../../abi/fungibleDeprecated.json' assert {type: 'json'};28import nonFungibleAbi from '../../abi/nonFungible.json' assert {type: 'json'};29import nonFungibleDeprecatedAbi from '../../abi/nonFungibleDeprecated.json' assert {type: 'json'};30import refungibleAbi from '../../abi/reFungible.json' assert {type: 'json'};31import refungibleDeprecatedAbi from '../../abi/reFungibleDeprecated.json' assert {type: 'json'};32import refungibleTokenAbi from '../../abi/reFungibleToken.json' assert {type: 'json'};33import refungibleTokenDeprecatedAbi from '../../abi/reFungibleTokenDeprecated.json' assert {type: 'json'};34import contractHelpersAbi from '../../abi/contractHelpers.json' assert {type: 'json'};35import {ICrossAccountId, TEthereumAccount} from '../../../util/playgrounds/types';36import {TCollectionMode} from '../../../util/playgrounds/types';3738class EthGroupBase {39  helper: EthUniqueHelper;40  gasPrice?: string;4142  constructor(helper: EthUniqueHelper) {43    this.helper = helper;44  }45  async getGasPrice() {46    if (this.gasPrice)47      return this.gasPrice;48    this.gasPrice = await this.helper.getWeb3().eth.getGasPrice();49    return this.gasPrice;50  }51}525354class ContractGroup extends EthGroupBase {55  async findImports(imports?: ContractImports[]) {56    if (!imports) return function(path: string) {57      return {error: `File not found: ${path}`};58    };5960    const knownImports = {} as { [key: string]: string };61    for (const imp of imports) {62      knownImports[imp.solPath] = (await readFile(imp.fsPath)).toString();63    }6465    return function(path: string) {66      if (path in knownImports) return {contents: knownImports[path]};67      return {error: `File not found: ${path}`};68    };69  }7071  async compile(name: string, src: string, imports?: ContractImports[]): Promise<CompiledContract> {72    const compiled = JSON.parse(solc.compile(JSON.stringify({73      language: 'Solidity',74      sources: {75        [`${name}.sol`]: {76          content: src,77        },78      },79      settings: {80        outputSelection: {81          '*': {82            '*': ['*'],83          },84        },85      },86    }), {import: await this.findImports(imports)}));8788    const hasErrors = compiled['errors']89      && compiled['errors'].length > 090      && compiled.errors.some(function(err: any) {91        return err.severity == 'error';92      });9394    if (hasErrors) {95      throw compiled.errors;96    }97    const out = compiled.contracts[`${name}.sol`][name];9899    return {100      abi: out.abi,101      object: '0x' + out.evm.bytecode.object,102    };103  }104105  async deployByCode(signer: string, name: string, src: string, imports?: ContractImports[], gas?: number): Promise<Contract> {106    const compiledContract = await this.compile(name, src, imports);107    return this.deployByAbi(signer, compiledContract.abi, compiledContract.object, gas);108  }109110  async deployByAbi(signer: string, abi: any, object: string, gas?: number): Promise<Contract> {111    const web3 = this.helper.getWeb3();112    const contract = new web3.eth.Contract(abi, undefined, {113      data: object,114      from: signer,115      gas: gas ?? this.helper.eth.DEFAULT_GAS,116      gasPrice: await this.getGasPrice(),117    });118    return await contract.deploy({data: object}).send({from: signer});119  }120121}122123class NativeContractGroup extends EthGroupBase {124125  async contractHelpers(caller: string): Promise<Contract> {126    const web3 = this.helper.getWeb3();127    return new web3.eth.Contract(contractHelpersAbi as any, this.helper.getApi().consts.evmContractHelpers.contractAddress.toString(), {128      from: caller,129      gas: this.helper.eth.DEFAULT_GAS,130      gasPrice: await this.getGasPrice(),131    });132  }133134  async collectionHelpers(caller: string) {135    const web3 = this.helper.getWeb3();136    return new web3.eth.Contract(collectionHelpersAbi as any, this.helper.getApi().consts.common.contractAddress.toString(), {137      from: caller,138      gas: this.helper.eth.DEFAULT_GAS,139      gasPrice: await this.getGasPrice(),140    });141  }142143  async collection(address: string, mode: TCollectionMode, caller?: string, mergeDeprecated = false) {144    let abi = {145      'nft': nonFungibleAbi,146      'rft': refungibleAbi,147      'ft': fungibleAbi,148    }[mode];149    if (mergeDeprecated) {150      const deprecated = {151        'nft': nonFungibleDeprecatedAbi,152        'rft': refungibleDeprecatedAbi,153        'ft': fungibleDeprecatedAbi,154      }[mode];155      abi = [...abi, ...deprecated];156    }157    const web3 = this.helper.getWeb3();158    return new web3.eth.Contract(abi as any, address, {159      gas: this.helper.eth.DEFAULT_GAS,160      gasPrice: await this.getGasPrice(),161      ...(caller ? {from: caller} : {}),162    });163  }164165  collectionById(collectionId: number, mode: 'nft' | 'rft' | 'ft', caller?: string, mergeDeprecated = false) {166    return this.collection(this.helper.ethAddress.fromCollectionId(collectionId), mode, caller, mergeDeprecated);167  }168169  async rftToken(address: string, caller?: string, mergeDeprecated = false) {170    const web3 = this.helper.getWeb3();171    const abi = mergeDeprecated ? [...refungibleTokenAbi, ...refungibleTokenDeprecatedAbi] : refungibleTokenAbi;172    return new web3.eth.Contract(abi as any, address, {173      gas: this.helper.eth.DEFAULT_GAS,174      gasPrice: await this.getGasPrice(),175      ...(caller ? {from: caller} : {}),176    });177  }178179  rftTokenById(collectionId: number, tokenId: number, caller?: string, mergeDeprecated = false) {180    return this.rftToken(this.helper.ethAddress.fromTokenId(collectionId, tokenId), caller, mergeDeprecated);181  }182}183184185class EthGroup extends EthGroupBase {186  DEFAULT_GAS = 2_500_000;187188  createAccount() {189    const web3 = this.helper.getWeb3();190    const account = web3.eth.accounts.create();191    web3.eth.accounts.wallet.add(account.privateKey);192    return account.address;193  }194195  async createAccountWithBalance(donor: IKeyringPair, amount = 600n) {196    const account = this.createAccount();197    await this.transferBalanceFromSubstrate(donor, account, amount);198199    return account;200  }201202  async transferBalanceFromSubstrate(donor: IKeyringPair, recepient: string, amount = 100n, inTokens = true) {203    return await this.helper.balance.transferToSubstrate(donor, evmToAddress(recepient), amount * (inTokens ? this.helper.balance.getOneTokenNominal() : 1n));204  }205206  async getCollectionCreationFee(signer: string) {207    const collectionHelper = await this.helper.ethNativeContract.collectionHelpers(signer);208    return await collectionHelper.methods.collectionCreationFee().call();209  }210211  async sendEVM(signer: IKeyringPair, contractAddress: string, abi: string, value: string, gasLimit?: number) {212    if (!gasLimit) gasLimit = this.DEFAULT_GAS;213    const web3 = this.helper.getWeb3();214    const gasPrice = await web3.eth.getGasPrice();215    // TODO: check execution status216    await this.helper.executeExtrinsic(217      signer,218      'api.tx.evm.call', [this.helper.address.substrateToEth(signer.address), contractAddress, abi, value, gasLimit, gasPrice, null, null, []],219      true,220    );221  }222223  async callEVM(signer: TEthereumAccount, contractAddress: string, abi: string) {224    return await this.helper.callRpc('api.rpc.eth.call', [{from: signer, to: contractAddress, data: abi}]);225  }226227  createCollectionMethodName(mode: TCollectionMode) {228    switch (mode) {229      case 'ft':230        return 'createFTCollection';231      case 'nft':232        return 'createNFTCollection';233      case 'rft':234        return 'createRFTCollection';235    }236  }237238  async createCollection(mode: TCollectionMode, signer: string, name: string, description: string, tokenPrefix: string, decimals = 18, mergeDeprecated = false): Promise<{ collectionId: number, collectionAddress: string, events: NormalizedEvent[], collection: Contract }> {239    const collectionCreationPrice = this.helper.balance.getCollectionCreationPrice();240    const collectionHelper = await this.helper.ethNativeContract.collectionHelpers(signer);241    const functionName: string = this.createCollectionMethodName(mode);242243    const functionParams = mode === 'ft' ? [name, decimals, description, tokenPrefix] : [name, description, tokenPrefix];244    const result = await collectionHelper.methods[functionName](...functionParams).send({value: Number(collectionCreationPrice)});245246    const collectionAddress = this.helper.ethAddress.normalizeAddress(result.events.CollectionCreated.returnValues.collectionId);247    const collectionId = this.helper.ethAddress.extractCollectionId(collectionAddress);248    const events = this.helper.eth.normalizeEvents(result.events);249    const collection = await this.helper.ethNativeContract.collectionById(collectionId, mode, signer, mergeDeprecated);250251    return {collectionId, collectionAddress, events, collection};252  }253254  createNFTCollection(signer: string, name: string, description: string, tokenPrefix: string): Promise<{ collectionId: number, collectionAddress: string, events: NormalizedEvent[] }> {255    return this.createCollection('nft', signer, name, description, tokenPrefix);256  }257258  async createERC721MetadataCompatibleNFTCollection(signer: string, name: string, description: string, tokenPrefix: string, baseUri: string): Promise<{ collectionId: number, collectionAddress: string, events: NormalizedEvent[] }> {259    const collectionHelper = await this.helper.ethNativeContract.collectionHelpers(signer);260261    const {collectionId, collectionAddress, events} = await this.createCollection('nft', signer, name, description, tokenPrefix);262263    await collectionHelper.methods.makeCollectionERC721MetadataCompatible(collectionAddress, baseUri).send();264265    return {collectionId, collectionAddress, events};266  }267268  createRFTCollection(signer: string, name: string, description: string, tokenPrefix: string): Promise<{ collectionId: number, collectionAddress: string, events: NormalizedEvent[] }> {269    return this.createCollection('rft', signer, name, description, tokenPrefix);270  }271272  createFungibleCollection(signer: string, name: string, decimals: number, description: string, tokenPrefix: string): Promise<{ collectionId: number, collectionAddress: string, events: NormalizedEvent[] }> {273    return this.createCollection('ft', signer, name, description, tokenPrefix, decimals);274  }275276  async createERC721MetadataCompatibleRFTCollection(signer: string, name: string, description: string, tokenPrefix: string, baseUri: string): Promise<{ collectionId: number, collectionAddress: string, events: NormalizedEvent[] }> {277    const collectionHelper = await this.helper.ethNativeContract.collectionHelpers(signer);278279    const {collectionId, collectionAddress, events} = await this.createCollection('rft', signer, name, description, tokenPrefix);280281    await collectionHelper.methods.makeCollectionERC721MetadataCompatible(collectionAddress, baseUri).send();282283    return {collectionId, collectionAddress, events};284  }285286  async deployCollectorContract(signer: string): Promise<Contract> {287    return await this.helper.ethContract.deployByCode(signer, 'Collector', `288    // SPDX-License-Identifier: UNLICENSED289    pragma solidity ^0.8.6;290291    contract Collector {292      uint256 collected;293      fallback() external payable {294        giveMoney();295      }296      function giveMoney() public payable {297        collected += msg.value;298      }299      function getCollected() public view returns (uint256) {300        return collected;301      }302      function getUnaccounted() public view returns (uint256) {303        return address(this).balance - collected;304      }305306      function withdraw(address payable target) public {307        target.transfer(collected);308        collected = 0;309      }310    }311  `);312  }313314  async deployFlipper(signer: string): Promise<Contract> {315    return await this.helper.ethContract.deployByCode(signer, 'Flipper', `316    // SPDX-License-Identifier: UNLICENSED317    pragma solidity ^0.8.6;318319    contract Flipper {320      bool value = false;321      function flip() public {322        value = !value;323      }324      function getValue() public view returns (bool) {325        return value;326      }327    }328  `);329  }330331  async recordCallFee(user: string, call: () => Promise<any>): Promise<bigint> {332    const before = await this.helper.balance.getEthereum(user);333    await call();334    // In dev mode, the transaction might not finish processing in time335    await this.helper.wait.newBlocks(1);336    const after = await this.helper.balance.getEthereum(user);337338    return before - after;339  }340341  normalizeEvents(events: any): NormalizedEvent[] {342    const output = [];343    for (const key of Object.keys(events)) {344      if (key.match(/^[0-9]+$/)) {345        output.push(events[key]);346      } else if (Array.isArray(events[key])) {347        output.push(...events[key]);348      } else {349        output.push(events[key]);350      }351    }352    output.sort((a, b) => a.logIndex - b.logIndex);353    return output.map(({address, event, returnValues}) => {354      const args: { [key: string]: string } = {};355      for (const key of Object.keys(returnValues)) {356        if (!key.match(/^[0-9]+$/)) {357          args[key] = returnValues[key];358        }359      }360      return {361        address,362        event,363        args,364      };365    });366  }367368  async calculateFee(address: ICrossAccountId, code: () => Promise<any>): Promise<bigint> {369    const wrappedCode = async () => {370      await code();371      // In dev mode, the transaction might not finish processing in time372      await this.helper.wait.newBlocks(1);373    };374    return await this.helper.arrange.calculcateFee(address, wrappedCode);375  }376}377378class EthAddressGroup extends EthGroupBase {379  extractCollectionId(address: string): number {380    if (!(address.length === 42 || address.length === 40)) throw new Error('address wrong format');381    return parseInt(address.substr(address.length - 8), 16);382  }383384  fromCollectionId(collectionId: number): string {385    if (collectionId >= 0xffffffff || collectionId < 0) throw new Error('collectionId overflow');386    return Web3.utils.toChecksumAddress(`0x17c4e6453cc49aaaaeaca894e6d9683e${collectionId.toString(16).padStart(8, '0')}`);387  }388389  extractTokenId(address: string): { collectionId: number, tokenId: number } {390    if (!address.startsWith('0x'))391      throw 'address not starts with "0x"';392    if (address.length > 42)393      throw 'address length is more than 20 bytes';394    return {395      collectionId: Number('0x' + address.substring(address.length - 16, address.length - 8)),396      tokenId: Number('0x' + address.substring(address.length - 8)),397    };398  }399400  fromTokenId(collectionId: number, tokenId: number): string {401    return this.helper.util.getTokenAddress({collectionId, tokenId});402  }403404  normalizeAddress(address: string): string {405    return '0x' + address.substring(address.length - 40);406  }407}408export class EthPropertyGroup extends EthGroupBase {409  property(key: string, value: string): EthProperty {410    return [411      key,412      '0x' + Buffer.from(value).toString('hex'),413    ];414  }415}416export type EthUniqueHelperConstructor = new (...args: any[]) => EthUniqueHelper;417418export class EthCrossAccountGroup extends EthGroupBase {419  createAccount(): CrossAddress {420    return this.fromAddress(this.helper.eth.createAccount());421  }422423  async createAccountWithBalance(donor: IKeyringPair, amount = 100n) {424    return this.fromAddress(await this.helper.eth.createAccountWithBalance(donor, amount));425  }426427  fromAddress(address: TEthereumAccount): CrossAddress {428    return {429      eth: address,430      sub: '0',431    };432  }433434  fromKeyringPair(keyring: IKeyringPair): CrossAddress {435    return {436      eth: '0x0000000000000000000000000000000000000000',437      sub: keyring.addressRaw,438    };439  }440}441442export class FeeGas {443  fee: number | bigint = 0n;444445  gas: number | bigint = 0n;446447  public static async build(helper: EthUniqueHelper, fee: bigint): Promise<FeeGas> {448    const instance = new FeeGas();449    instance.fee = instance.convertToTokens(fee);450    instance.gas = await instance.convertToGas(fee, helper);451    return instance;452  }453454  private async convertToGas(fee: bigint, helper: EthUniqueHelper): Promise<bigint> {455    const gasPrice = BigInt(await helper.getWeb3().eth.getGasPrice());456    return fee / gasPrice;457  }458459  private convertToTokens(value: bigint, nominal = 1_000_000_000_000_000_000n): number {460    return Number((value * 1000n) / nominal) / 1000;461  }462}463464class EthArrangeGroup extends ArrangeGroup {465  helper: EthUniqueHelper;466467  constructor(helper: EthUniqueHelper) {468    super(helper);469    this.helper = helper;470  }471472  async calculcateFeeGas(payer: ICrossAccountId, promise: () => Promise<any>): Promise<FeeGas> {473    const fee = await this.calculcateFee(payer, promise);474    return await FeeGas.build(this.helper, fee);475  }476}477export class EthUniqueHelper extends DevUniqueHelper {478  web3: Web3 | null = null;479  web3Provider: WebsocketProvider | null = null;480481  eth: EthGroup;482  ethAddress: EthAddressGroup;483  ethCrossAccount: EthCrossAccountGroup;484  ethNativeContract: NativeContractGroup;485  ethContract: ContractGroup;486  ethProperty: EthPropertyGroup;487  arrange: EthArrangeGroup;488  constructor(logger: { log: (msg: any, level: any) => void, level: any }, options: { [key: string]: any } = {}) {489    options.helperBase = options.helperBase ?? EthUniqueHelper;490491    super(logger, options);492    this.eth = new EthGroup(this);493    this.ethAddress = new EthAddressGroup(this);494    this.ethCrossAccount = new EthCrossAccountGroup(this);495    this.ethNativeContract = new NativeContractGroup(this);496    this.ethContract = new ContractGroup(this);497    this.ethProperty = new EthPropertyGroup(this);498    this.arrange = new EthArrangeGroup(this);499    super.arrange = this.arrange;500  }501502  getWeb3(): Web3 {503    if (this.web3 === null) throw Error('Web3 not connected');504    return this.web3;505  }506507  connectWeb3(wsEndpoint: string) {508    if (this.web3 !== null) return;509    this.web3Provider = new Web3.providers.WebsocketProvider(wsEndpoint);510    this.web3 = new Web3(this.web3Provider);511  }512513  async disconnect() {514    if (this.web3 === null) return;515    this.web3Provider?.connection.close();516517    await super.disconnect();518  }519520  clearApi() {521    super.clearApi();522    this.web3 = null;523  }524525  clone(helperCls: EthUniqueHelperConstructor, options?: { [key: string]: any; }): EthUniqueHelper {526    const newHelper = super.clone(helperCls, options) as EthUniqueHelper;527    newHelper.web3 = this.web3;528    newHelper.web3Provider = this.web3Provider;529530    return newHelper;531  }532}
after · tests/src/eth/util/playgrounds/unique.dev.ts
1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// SPDX-License-Identifier: Apache-2.034/* eslint-disable function-call-argument-newline */5// eslint-disable-next-line @typescript-eslint/triple-slash-reference6/// <reference path="unique.dev.d.ts" />78import {readFile} from 'fs/promises';910import Web3 from 'web3';11import {WebsocketProvider} from 'web3-core';12import {Contract} from 'web3-eth-contract';1314import solc from 'solc';1516import {evmToAddress} from '@polkadot/util-crypto';17import {IKeyringPair} from '@polkadot/types/types';1819import {ArrangeGroup, DevUniqueHelper} from '../../../util/playgrounds/unique.dev';2021import {ContractImports, CompiledContract, CrossAddress, NormalizedEvent, EthProperty} from './types';2223// Native contracts ABI24import collectionHelpersAbi from '../../abi/collectionHelpers.json' assert {type: 'json'};25import nativeFungibleAbi from '../../abi/nativeFungible.json' assert {type: 'json'};26import fungibleAbi from '../../abi/fungible.json' assert {type: 'json'};27import fungibleDeprecatedAbi from '../../abi/fungibleDeprecated.json' assert {type: 'json'};28import nonFungibleAbi from '../../abi/nonFungible.json' assert {type: 'json'};29import nonFungibleDeprecatedAbi from '../../abi/nonFungibleDeprecated.json' assert {type: 'json'};30import refungibleAbi from '../../abi/reFungible.json' assert {type: 'json'};31import refungibleDeprecatedAbi from '../../abi/reFungibleDeprecated.json' assert {type: 'json'};32import refungibleTokenAbi from '../../abi/reFungibleToken.json' assert {type: 'json'};33import refungibleTokenDeprecatedAbi from '../../abi/reFungibleTokenDeprecated.json' assert {type: 'json'};34import contractHelpersAbi from '../../abi/contractHelpers.json' assert {type: 'json'};35import {ICrossAccountId, TEthereumAccount} from '../../../util/playgrounds/types';36import {TCollectionMode} from '../../../util/playgrounds/types';3738class EthGroupBase {39  helper: EthUniqueHelper;40  gasPrice?: string;4142  constructor(helper: EthUniqueHelper) {43    this.helper = helper;44  }45  async getGasPrice() {46    if (this.gasPrice)47      return this.gasPrice;48    this.gasPrice = await this.helper.getWeb3().eth.getGasPrice();49    return this.gasPrice;50  }51}525354class ContractGroup extends EthGroupBase {55  async findImports(imports?: ContractImports[]) {56    if (!imports) return function(path: string) {57      return {error: `File not found: ${path}`};58    };5960    const knownImports = {} as { [key: string]: string };61    for (const imp of imports) {62      knownImports[imp.solPath] = (await readFile(imp.fsPath)).toString();63    }6465    return function(path: string) {66      if (path in knownImports) return {contents: knownImports[path]};67      return {error: `File not found: ${path}`};68    };69  }7071  async compile(name: string, src: string, imports?: ContractImports[]): Promise<CompiledContract> {72    const compiled = JSON.parse(solc.compile(JSON.stringify({73      language: 'Solidity',74      sources: {75        [`${name}.sol`]: {76          content: src,77        },78      },79      settings: {80        outputSelection: {81          '*': {82            '*': ['*'],83          },84        },85      },86    }), {import: await this.findImports(imports)}));8788    const hasErrors = compiled['errors']89      && compiled['errors'].length > 090      && compiled.errors.some(function(err: any) {91        return err.severity == 'error';92      });9394    if (hasErrors) {95      throw compiled.errors;96    }97    const out = compiled.contracts[`${name}.sol`][name];9899    return {100      abi: out.abi,101      object: '0x' + out.evm.bytecode.object,102    };103  }104105  async deployByCode(signer: string, name: string, src: string, imports?: ContractImports[], gas?: number): Promise<Contract> {106    const compiledContract = await this.compile(name, src, imports);107    return this.deployByAbi(signer, compiledContract.abi, compiledContract.object, gas);108  }109110  async deployByAbi(signer: string, abi: any, object: string, gas?: number): Promise<Contract> {111    const web3 = this.helper.getWeb3();112    const contract = new web3.eth.Contract(abi, undefined, {113      data: object,114      from: signer,115      gas: gas ?? this.helper.eth.DEFAULT_GAS,116      gasPrice: await this.getGasPrice(),117    });118    return await contract.deploy({data: object}).send({from: signer});119  }120121}122123class NativeContractGroup extends EthGroupBase {124125  async contractHelpers(caller: string): Promise<Contract> {126    const web3 = this.helper.getWeb3();127    return new web3.eth.Contract(contractHelpersAbi as any, this.helper.getApi().consts.evmContractHelpers.contractAddress.toString(), {128      from: caller,129      gas: this.helper.eth.DEFAULT_GAS,130      gasPrice: await this.getGasPrice(),131    });132  }133134  async collectionHelpers(caller: string) {135    const web3 = this.helper.getWeb3();136    return new web3.eth.Contract(collectionHelpersAbi as any, this.helper.getApi().consts.common.contractAddress.toString(), {137      from: caller,138      gas: this.helper.eth.DEFAULT_GAS,139      gasPrice: await this.getGasPrice(),140    });141  }142143  async collection(address: string, mode: TCollectionMode, caller?: string, mergeDeprecated = false) {144    let abi;145    if (address === '0' && mode === 'ft') {146      abi = nativeFungibleAbi;147    } else {148      abi ={149        'nft': nonFungibleAbi,150        'rft': refungibleAbi,151        'ft': fungibleAbi,152      }[mode];153    }154    if (mergeDeprecated) {155      const deprecated = {156        'nft': nonFungibleDeprecatedAbi,157        'rft': refungibleDeprecatedAbi,158        'ft': fungibleDeprecatedAbi,159      }[mode];160      abi = [...abi, ...deprecated];161    }162    const web3 = this.helper.getWeb3();163    return new web3.eth.Contract(abi as any, address, {164      gas: this.helper.eth.DEFAULT_GAS,165      gasPrice: await this.getGasPrice(),166      ...(caller ? {from: caller} : {}),167    });168  }169170  collectionById(collectionId: number, mode: 'nft' | 'rft' | 'ft', caller?: string, mergeDeprecated = false) {171    return this.collection(this.helper.ethAddress.fromCollectionId(collectionId), mode, caller, mergeDeprecated);172  }173174  async rftToken(address: string, caller?: string, mergeDeprecated = false) {175    const web3 = this.helper.getWeb3();176    const abi = mergeDeprecated ? [...refungibleTokenAbi, ...refungibleTokenDeprecatedAbi] : refungibleTokenAbi;177    return new web3.eth.Contract(abi as any, address, {178      gas: this.helper.eth.DEFAULT_GAS,179      gasPrice: await this.getGasPrice(),180      ...(caller ? {from: caller} : {}),181    });182  }183184  rftTokenById(collectionId: number, tokenId: number, caller?: string, mergeDeprecated = false) {185    return this.rftToken(this.helper.ethAddress.fromTokenId(collectionId, tokenId), caller, mergeDeprecated);186  }187}188189190class EthGroup extends EthGroupBase {191  DEFAULT_GAS = 2_500_000;192193  createAccount() {194    const web3 = this.helper.getWeb3();195    const account = web3.eth.accounts.create();196    web3.eth.accounts.wallet.add(account.privateKey);197    return account.address;198  }199200  async createAccountWithBalance(donor: IKeyringPair, amount = 600n) {201    const account = this.createAccount();202    await this.transferBalanceFromSubstrate(donor, account, amount);203204    return account;205  }206207  async transferBalanceFromSubstrate(donor: IKeyringPair, recepient: string, amount = 100n, inTokens = true) {208    return await this.helper.balance.transferToSubstrate(donor, evmToAddress(recepient), amount * (inTokens ? this.helper.balance.getOneTokenNominal() : 1n));209  }210211  async getCollectionCreationFee(signer: string) {212    const collectionHelper = await this.helper.ethNativeContract.collectionHelpers(signer);213    return await collectionHelper.methods.collectionCreationFee().call();214  }215216  async sendEVM(signer: IKeyringPair, contractAddress: string, abi: string, value: string, gasLimit?: number) {217    if (!gasLimit) gasLimit = this.DEFAULT_GAS;218    const web3 = this.helper.getWeb3();219    const gasPrice = await web3.eth.getGasPrice();220    // TODO: check execution status221    await this.helper.executeExtrinsic(222      signer,223      'api.tx.evm.call', [this.helper.address.substrateToEth(signer.address), contractAddress, abi, value, gasLimit, gasPrice, null, null, []],224      true,225    );226  }227228  async callEVM(signer: TEthereumAccount, contractAddress: string, abi: string) {229    return await this.helper.callRpc('api.rpc.eth.call', [{from: signer, to: contractAddress, data: abi}]);230  }231232  createCollectionMethodName(mode: TCollectionMode) {233    switch (mode) {234      case 'ft':235        return 'createFTCollection';236      case 'nft':237        return 'createNFTCollection';238      case 'rft':239        return 'createRFTCollection';240    }241  }242243  async createCollection(mode: TCollectionMode, signer: string, name: string, description: string, tokenPrefix: string, decimals = 18, mergeDeprecated = false): Promise<{ collectionId: number, collectionAddress: string, events: NormalizedEvent[], collection: Contract }> {244    const collectionCreationPrice = this.helper.balance.getCollectionCreationPrice();245    const collectionHelper = await this.helper.ethNativeContract.collectionHelpers(signer);246    const functionName: string = this.createCollectionMethodName(mode);247248    const functionParams = mode === 'ft' ? [name, decimals, description, tokenPrefix] : [name, description, tokenPrefix];249    const result = await collectionHelper.methods[functionName](...functionParams).send({value: Number(collectionCreationPrice)});250251    const collectionAddress = this.helper.ethAddress.normalizeAddress(result.events.CollectionCreated.returnValues.collectionId);252    const collectionId = this.helper.ethAddress.extractCollectionId(collectionAddress);253    const events = this.helper.eth.normalizeEvents(result.events);254    const collection = await this.helper.ethNativeContract.collectionById(collectionId, mode, signer, mergeDeprecated);255256    return {collectionId, collectionAddress, events, collection};257  }258259  createNFTCollection(signer: string, name: string, description: string, tokenPrefix: string): Promise<{ collectionId: number, collectionAddress: string, events: NormalizedEvent[] }> {260    return this.createCollection('nft', signer, name, description, tokenPrefix);261  }262263  async createERC721MetadataCompatibleNFTCollection(signer: string, name: string, description: string, tokenPrefix: string, baseUri: string): Promise<{ collectionId: number, collectionAddress: string, events: NormalizedEvent[] }> {264    const collectionHelper = await this.helper.ethNativeContract.collectionHelpers(signer);265266    const {collectionId, collectionAddress, events} = await this.createCollection('nft', signer, name, description, tokenPrefix);267268    await collectionHelper.methods.makeCollectionERC721MetadataCompatible(collectionAddress, baseUri).send();269270    return {collectionId, collectionAddress, events};271  }272273  createRFTCollection(signer: string, name: string, description: string, tokenPrefix: string): Promise<{ collectionId: number, collectionAddress: string, events: NormalizedEvent[] }> {274    return this.createCollection('rft', signer, name, description, tokenPrefix);275  }276277  createFungibleCollection(signer: string, name: string, decimals: number, description: string, tokenPrefix: string): Promise<{ collectionId: number, collectionAddress: string, events: NormalizedEvent[] }> {278    return this.createCollection('ft', signer, name, description, tokenPrefix, decimals);279  }280281  async createERC721MetadataCompatibleRFTCollection(signer: string, name: string, description: string, tokenPrefix: string, baseUri: string): Promise<{ collectionId: number, collectionAddress: string, events: NormalizedEvent[] }> {282    const collectionHelper = await this.helper.ethNativeContract.collectionHelpers(signer);283284    const {collectionId, collectionAddress, events} = await this.createCollection('rft', signer, name, description, tokenPrefix);285286    await collectionHelper.methods.makeCollectionERC721MetadataCompatible(collectionAddress, baseUri).send();287288    return {collectionId, collectionAddress, events};289  }290291  async deployCollectorContract(signer: string): Promise<Contract> {292    return await this.helper.ethContract.deployByCode(signer, 'Collector', `293    // SPDX-License-Identifier: UNLICENSED294    pragma solidity ^0.8.6;295296    contract Collector {297      uint256 collected;298      fallback() external payable {299        giveMoney();300      }301      function giveMoney() public payable {302        collected += msg.value;303      }304      function getCollected() public view returns (uint256) {305        return collected;306      }307      function getUnaccounted() public view returns (uint256) {308        return address(this).balance - collected;309      }310311      function withdraw(address payable target) public {312        target.transfer(collected);313        collected = 0;314      }315    }316  `);317  }318319  async deployFlipper(signer: string): Promise<Contract> {320    return await this.helper.ethContract.deployByCode(signer, 'Flipper', `321    // SPDX-License-Identifier: UNLICENSED322    pragma solidity ^0.8.6;323324    contract Flipper {325      bool value = false;326      function flip() public {327        value = !value;328      }329      function getValue() public view returns (bool) {330        return value;331      }332    }333  `);334  }335336  async recordCallFee(user: string, call: () => Promise<any>): Promise<bigint> {337    const before = await this.helper.balance.getEthereum(user);338    await call();339    // In dev mode, the transaction might not finish processing in time340    await this.helper.wait.newBlocks(1);341    const after = await this.helper.balance.getEthereum(user);342343    return before - after;344  }345346  normalizeEvents(events: any): NormalizedEvent[] {347    const output = [];348    for (const key of Object.keys(events)) {349      if (key.match(/^[0-9]+$/)) {350        output.push(events[key]);351      } else if (Array.isArray(events[key])) {352        output.push(...events[key]);353      } else {354        output.push(events[key]);355      }356    }357    output.sort((a, b) => a.logIndex - b.logIndex);358    return output.map(({address, event, returnValues}) => {359      const args: { [key: string]: string } = {};360      for (const key of Object.keys(returnValues)) {361        if (!key.match(/^[0-9]+$/)) {362          args[key] = returnValues[key];363        }364      }365      return {366        address,367        event,368        args,369      };370    });371  }372373  async calculateFee(address: ICrossAccountId, code: () => Promise<any>): Promise<bigint> {374    const wrappedCode = async () => {375      await code();376      // In dev mode, the transaction might not finish processing in time377      await this.helper.wait.newBlocks(1);378    };379    return await this.helper.arrange.calculcateFee(address, wrappedCode);380  }381}382383class EthAddressGroup extends EthGroupBase {384  extractCollectionId(address: string): number {385    if (!(address.length === 42 || address.length === 40)) throw new Error('address wrong format');386    return parseInt(address.substr(address.length - 8), 16);387  }388389  fromCollectionId(collectionId: number): string {390    if (collectionId >= 0xffffffff || collectionId < 0) throw new Error('collectionId overflow');391    return Web3.utils.toChecksumAddress(`0x17c4e6453cc49aaaaeaca894e6d9683e${collectionId.toString(16).padStart(8, '0')}`);392  }393394  extractTokenId(address: string): { collectionId: number, tokenId: number } {395    if (!address.startsWith('0x'))396      throw 'address not starts with "0x"';397    if (address.length > 42)398      throw 'address length is more than 20 bytes';399    return {400      collectionId: Number('0x' + address.substring(address.length - 16, address.length - 8)),401      tokenId: Number('0x' + address.substring(address.length - 8)),402    };403  }404405  fromTokenId(collectionId: number, tokenId: number): string {406    return this.helper.util.getTokenAddress({collectionId, tokenId});407  }408409  normalizeAddress(address: string): string {410    return '0x' + address.substring(address.length - 40);411  }412}413export class EthPropertyGroup extends EthGroupBase {414  property(key: string, value: string): EthProperty {415    return [416      key,417      '0x' + Buffer.from(value).toString('hex'),418    ];419  }420}421export type EthUniqueHelperConstructor = new (...args: any[]) => EthUniqueHelper;422423export class EthCrossAccountGroup extends EthGroupBase {424  createAccount(): CrossAddress {425    return this.fromAddress(this.helper.eth.createAccount());426  }427428  async createAccountWithBalance(donor: IKeyringPair, amount = 100n) {429    return this.fromAddress(await this.helper.eth.createAccountWithBalance(donor, amount));430  }431432  fromAddress(address: TEthereumAccount): CrossAddress {433    return {434      eth: address,435      sub: '0',436    };437  }438439  fromKeyringPair(keyring: IKeyringPair): CrossAddress {440    return {441      eth: '0x0000000000000000000000000000000000000000',442      sub: keyring.addressRaw,443    };444  }445}446447export class FeeGas {448  fee: number | bigint = 0n;449450  gas: number | bigint = 0n;451452  public static async build(helper: EthUniqueHelper, fee: bigint): Promise<FeeGas> {453    const instance = new FeeGas();454    instance.fee = instance.convertToTokens(fee);455    instance.gas = await instance.convertToGas(fee, helper);456    return instance;457  }458459  private async convertToGas(fee: bigint, helper: EthUniqueHelper): Promise<bigint> {460    const gasPrice = BigInt(await helper.getWeb3().eth.getGasPrice());461    return fee / gasPrice;462  }463464  private convertToTokens(value: bigint, nominal = 1_000_000_000_000_000_000n): number {465    return Number((value * 1000n) / nominal) / 1000;466  }467}468469class EthArrangeGroup extends ArrangeGroup {470  helper: EthUniqueHelper;471472  constructor(helper: EthUniqueHelper) {473    super(helper);474    this.helper = helper;475  }476477  async calculcateFeeGas(payer: ICrossAccountId, promise: () => Promise<any>): Promise<FeeGas> {478    const fee = await this.calculcateFee(payer, promise);479    return await FeeGas.build(this.helper, fee);480  }481}482export class EthUniqueHelper extends DevUniqueHelper {483  web3: Web3 | null = null;484  web3Provider: WebsocketProvider | null = null;485486  eth: EthGroup;487  ethAddress: EthAddressGroup;488  ethCrossAccount: EthCrossAccountGroup;489  ethNativeContract: NativeContractGroup;490  ethContract: ContractGroup;491  ethProperty: EthPropertyGroup;492  arrange: EthArrangeGroup;493  constructor(logger: { log: (msg: any, level: any) => void, level: any }, options: { [key: string]: any } = {}) {494    options.helperBase = options.helperBase ?? EthUniqueHelper;495496    super(logger, options);497    this.eth = new EthGroup(this);498    this.ethAddress = new EthAddressGroup(this);499    this.ethCrossAccount = new EthCrossAccountGroup(this);500    this.ethNativeContract = new NativeContractGroup(this);501    this.ethContract = new ContractGroup(this);502    this.ethProperty = new EthPropertyGroup(this);503    this.arrange = new EthArrangeGroup(this);504    super.arrange = this.arrange;505  }506507  getWeb3(): Web3 {508    if (this.web3 === null) throw Error('Web3 not connected');509    return this.web3;510  }511512  connectWeb3(wsEndpoint: string) {513    if (this.web3 !== null) return;514    this.web3Provider = new Web3.providers.WebsocketProvider(wsEndpoint);515    this.web3 = new Web3(this.web3Provider);516  }517518  async disconnect() {519    if (this.web3 === null) return;520    this.web3Provider?.connection.close();521522    await super.disconnect();523  }524525  clearApi() {526    super.clearApi();527    this.web3 = null;528  }529530  clone(helperCls: EthUniqueHelperConstructor, options?: { [key: string]: any; }): EthUniqueHelper {531    const newHelper = super.clone(helperCls, options) as EthUniqueHelper;532    newHelper.web3 = this.web3;533    newHelper.web3Provider = this.web3Provider;534535    return newHelper;536  }537}