12345678import {readFile} from 'fs/promises';910import Web3 from 'web3';11import {WebsocketProvider} from 'web3-core';12import {Contract} from 'web3-eth-contract';1314import * as solc from 'solc';1516import {evmToAddress} from '@polkadot/util-crypto';17import {IKeyringPair} from '@polkadot/types/types';1819import {DevUniqueHelper} from '../../../util/playgrounds/unique.dev';2021import {ContractImports, CompiledContract, TEthCrossAccount, NormalizedEvent} from './types';222324import collectionHelpersAbi from '../../collectionHelpersAbi.json';25import fungibleAbi from '../../fungibleAbi.json';26import nonFungibleAbi from '../../nonFungibleAbi.json';27import refungibleAbi from '../../reFungibleAbi.json';28import refungibleTokenAbi from '../../reFungibleTokenAbi.json';29import contractHelpersAbi from './../contractHelpersAbi.json';30import {ICrossAccountId, TEthereumAccount} from '../../../util/playgrounds/types';3132class EthGroupBase {33 helper: EthUniqueHelper;3435 constructor(helper: EthUniqueHelper) {36 this.helper = helper;37 }38}394041class ContractGroup extends EthGroupBase {42 async findImports(imports?: ContractImports[]){43 if(!imports) return function(path: string) {44 return {error: `File not found: ${path}`};45 };4647 const knownImports = {} as {[key: string]: string};48 for(const imp of imports) {49 knownImports[imp.solPath] = (await readFile(imp.fsPath)).toString();50 }5152 return function(path: string) {53 if(path in knownImports) return {contents: knownImports[path]};54 return {error: `File not found: ${path}`};55 };56 }5758 async compile(name: string, src: string, imports?: ContractImports[]): Promise<CompiledContract> {59 const out = JSON.parse(solc.compile(JSON.stringify({60 language: 'Solidity',61 sources: {62 [`${name}.sol`]: {63 content: src,64 },65 },66 settings: {67 outputSelection: {68 '*': {69 '*': ['*'],70 },71 },72 },73 }), {import: await this.findImports(imports)})).contracts[`${name}.sol`][name];7475 return {76 abi: out.abi,77 object: '0x' + out.evm.bytecode.object,78 };79 }8081 async deployByCode(signer: string, name: string, src: string, imports?: ContractImports[]): Promise<Contract> {82 const compiledContract = await this.compile(name, src, imports);83 return this.deployByAbi(signer, compiledContract.abi, compiledContract.object);84 }8586 async deployByAbi(signer: string, abi: any, object: string): Promise<Contract> {87 const web3 = this.helper.getWeb3();88 const contract = new web3.eth.Contract(abi, undefined, {89 data: object,90 from: signer,91 gas: this.helper.eth.DEFAULT_GAS,92 });93 return await contract.deploy({data: object}).send({from: signer});94 }9596}9798class NativeContractGroup extends EthGroupBase {99100 contractHelpers(caller: string): Contract {101 const web3 = this.helper.getWeb3();102 return new web3.eth.Contract(contractHelpersAbi as any, '0x842899ECF380553E8a4de75bF534cdf6fBF64049', {from: caller, gas: this.helper.eth.DEFAULT_GAS});103 }104105 collectionHelpers(caller: string) {106 const web3 = this.helper.getWeb3();107 return new web3.eth.Contract(collectionHelpersAbi as any, '0x6c4e9fe1ae37a41e93cee429e8e1881abdcbb54f', {from: caller, gas: this.helper.eth.DEFAULT_GAS});108 }109110 collection(address: string, mode: 'nft' | 'rft' | 'ft', caller?: string): Contract {111 const abi = {112 'nft': nonFungibleAbi,113 'rft': refungibleAbi,114 'ft': fungibleAbi,115 }[mode];116 const web3 = this.helper.getWeb3();117 return new web3.eth.Contract(abi as any, address, {gas: this.helper.eth.DEFAULT_GAS, ...(caller ? {from: caller} : {})});118 }119120 collectionById(collectionId: number, mode: 'nft' | 'rft' | 'ft', caller?: string): Contract {121 return this.collection(this.helper.ethAddress.fromCollectionId(collectionId), mode, caller);122 }123124 rftToken(address: string, caller?: string): Contract {125 const web3 = this.helper.getWeb3();126 return new web3.eth.Contract(refungibleTokenAbi as any, address, {gas: this.helper.eth.DEFAULT_GAS, ...(caller ? {from: caller} : {})});127 }128129 rftTokenById(collectionId: number, tokenId: number, caller?: string): Contract {130 return this.rftToken(this.helper.ethAddress.fromTokenId(collectionId, tokenId), caller);131 }132}133134135class EthGroup extends EthGroupBase {136 DEFAULT_GAS = 2_500_000;137138 createAccount() {139 const web3 = this.helper.getWeb3();140 const account = web3.eth.accounts.create();141 web3.eth.accounts.wallet.add(account.privateKey);142 return account.address;143 }144145 async createAccountWithBalance(donor: IKeyringPair, amount=100n) {146 const account = this.createAccount();147 await this.transferBalanceFromSubstrate(donor, account, amount);148149 return account;150 }151152 async transferBalanceFromSubstrate(donor: IKeyringPair, recepient: string, amount=100n, inTokens=true) {153 return await this.helper.balance.transferToSubstrate(donor, evmToAddress(recepient), amount * (inTokens ? this.helper.balance.getOneTokenNominal() : 1n));154 }155156 async getCollectionCreationFee(signer: string) {157 const collectionHelper = this.helper.ethNativeContract.collectionHelpers(signer);158 return await collectionHelper.methods.collectionCreationFee().call();159 }160161 async sendEVM(signer: IKeyringPair, contractAddress: string, abi: string, value: string, gasLimit?: number) {162 if(!gasLimit) gasLimit = this.DEFAULT_GAS;163 const web3 = this.helper.getWeb3();164 const gasPrice = await web3.eth.getGasPrice();165 166 await this.helper.executeExtrinsic(167 signer,168 'api.tx.evm.call', [this.helper.address.substrateToEth(signer.address), contractAddress, abi, value, gasLimit, gasPrice, null, null, []],169 true,170 );171 }172173 async callEVM(signer: TEthereumAccount, contractAddress: string, abi: string) {174 return await this.helper.callRpc('api.rpc.eth.call', [{from: signer, to: contractAddress, data: abi}]);175 }176 177 async createCollecion(functionName: string, signer: string, name: string, description: string, tokenPrefix: string): Promise<{ collectionId: number, collectionAddress: string, events: NormalizedEvent[] }> {178 const collectionCreationPrice = this.helper.balance.getCollectionCreationPrice();179 const collectionHelper = this.helper.ethNativeContract.collectionHelpers(signer);180 181 const result = await collectionHelper.methods[functionName](name, description, tokenPrefix).send({value: Number(collectionCreationPrice)});182183 const collectionAddress = this.helper.ethAddress.normalizeAddress(result.events.CollectionCreated.returnValues.collectionId);184 const collectionId = this.helper.ethAddress.extractCollectionId(collectionAddress);185 const events = this.helper.eth.normalizeEvents(result.events);186 187 return {collectionId, collectionAddress, events};188 }189 190 async createNFTCollection(signer: string, name: string, description: string, tokenPrefix: string): Promise<{ collectionId: number, collectionAddress: string, events: NormalizedEvent[] }> {191 return this.createCollecion('createNFTCollection', signer, name, description, tokenPrefix);192 }193194 async createERC721MetadataCompatibleNFTCollection(signer: string, name: string, description: string, tokenPrefix: string, baseUri: string): Promise<{collectionId: number, collectionAddress: string, events: NormalizedEvent[] }> {195 const collectionHelper = this.helper.ethNativeContract.collectionHelpers(signer);196197 const {collectionId, collectionAddress, events} = await this.createCollecion('createNFTCollection', signer, name, description, tokenPrefix);198199 await collectionHelper.methods.makeCollectionERC721MetadataCompatible(collectionAddress, baseUri).send();200201 return {collectionId, collectionAddress, events};202 }203204 async createRFTCollection(signer: string, name: string, description: string, tokenPrefix: string): Promise<{collectionId: number, collectionAddress: string}> {205 return this.createCollecion('createRFTCollection', signer, name, description, tokenPrefix);206 }207208 async createERC721MetadataCompatibleRFTCollection(signer: string, name: string, description: string, tokenPrefix: string, baseUri: string): Promise<{collectionId: number, collectionAddress: string, events: NormalizedEvent[] }> {209 const collectionHelper = this.helper.ethNativeContract.collectionHelpers(signer);210211 const {collectionId, collectionAddress, events} = await this.createCollecion('createRFTCollection', signer, name, description, tokenPrefix);212213 await collectionHelper.methods.makeCollectionERC721MetadataCompatible(collectionAddress, baseUri).send();214215 return {collectionId, collectionAddress, events};216 }217218 async deployCollectorContract(signer: string): Promise<Contract> {219 return await this.helper.ethContract.deployByCode(signer, 'Collector', `220 // SPDX-License-Identifier: UNLICENSED221 pragma solidity ^0.8.6;222223 contract Collector {224 uint256 collected;225 fallback() external payable {226 giveMoney();227 }228 function giveMoney() public payable {229 collected += msg.value;230 }231 function getCollected() public view returns (uint256) {232 return collected;233 }234 function getUnaccounted() public view returns (uint256) {235 return address(this).balance - collected;236 }237238 function withdraw(address payable target) public {239 target.transfer(collected);240 collected = 0;241 }242 }243 `);244 }245246 async deployFlipper(signer: string): Promise<Contract> {247 return await this.helper.ethContract.deployByCode(signer, 'Flipper', `248 // SPDX-License-Identifier: UNLICENSED249 pragma solidity ^0.8.6;250251 contract Flipper {252 bool value = false;253 function flip() public {254 value = !value;255 }256 function getValue() public view returns (bool) {257 return value;258 }259 }260 `);261 }262263 async recordCallFee(user: string, call: () => Promise<any>): Promise<bigint> {264 const before = await this.helper.balance.getEthereum(user);265 await call();266 267 await this.helper.wait.newBlocks(1);268 const after = await this.helper.balance.getEthereum(user);269270 return before - after;271 }272273 normalizeEvents(events: any): NormalizedEvent[] {274 const output = [];275 for (const key of Object.keys(events)) {276 if (key.match(/^[0-9]+$/)) {277 output.push(events[key]);278 } else if (Array.isArray(events[key])) {279 output.push(...events[key]);280 } else {281 output.push(events[key]);282 }283 }284 output.sort((a, b) => a.logIndex - b.logIndex);285 return output.map(({address, event, returnValues}) => {286 const args: { [key: string]: string } = {};287 for (const key of Object.keys(returnValues)) {288 if (!key.match(/^[0-9]+$/)) {289 args[key] = returnValues[key];290 }291 }292 return {293 address,294 event,295 args,296 };297 });298 }299300 async calculateFee(address: ICrossAccountId, code: () => Promise<any>): Promise<bigint> {301 const wrappedCode = async () => {302 await code();303 304 await this.helper.wait.newBlocks(1);305 };306 return await this.helper.arrange.calculcateFee(address, wrappedCode);307 }308}309310class EthAddressGroup extends EthGroupBase {311 extractCollectionId(address: string): number {312 if (!(address.length === 42 || address.length === 40)) throw new Error('address wrong format');313 return parseInt(address.substr(address.length - 8), 16);314 }315316 fromCollectionId(collectionId: number): string {317 if (collectionId >= 0xffffffff || collectionId < 0) throw new Error('collectionId overflow');318 return Web3.utils.toChecksumAddress(`0x17c4e6453cc49aaaaeaca894e6d9683e${collectionId.toString(16).padStart(8, '0')}`);319 }320321 extractTokenId(address: string): {collectionId: number, tokenId: number} {322 if (!address.startsWith('0x'))323 throw 'address not starts with "0x"';324 if (address.length > 42)325 throw 'address length is more than 20 bytes';326 return {327 collectionId: Number('0x' + address.substring(address.length - 16, address.length - 8)),328 tokenId: Number('0x' + address.substring(address.length - 8)),329 };330 }331332 fromTokenId(collectionId: number, tokenId: number): string {333 return this.helper.util.getTokenAddress({collectionId, tokenId});334 }335336 normalizeAddress(address: string): string {337 return '0x' + address.substring(address.length - 40);338 }339}340341export type EthUniqueHelperConstructor = new (...args: any[]) => EthUniqueHelper;342343export class EthCrossAccountGroup extends EthGroupBase {344 fromAddress(address: TEthereumAccount): TEthCrossAccount {345 return {346 0: address,347 1: '0',348 field_0: address,349 field_1: '0',350 };351 }352353 fromKeyringPair(keyring: IKeyringPair): TEthCrossAccount {354 return {355 0: '0x0000000000000000000000000000000000000000',356 1: keyring.addressRaw,357 field_0: '0x0000000000000000000000000000000000000000',358 field_1: keyring.addressRaw,359 };360 }361}362363export class EthUniqueHelper extends DevUniqueHelper {364 web3: Web3 | null = null;365 web3Provider: WebsocketProvider | null = null;366367 eth: EthGroup;368 ethAddress: EthAddressGroup;369 ethNativeContract: NativeContractGroup;370 ethContract: ContractGroup;371 ethCrossAccount: EthCrossAccountGroup;372373 constructor(logger: { log: (msg: any, level: any) => void, level: any }, options: {[key: string]: any} = {}) {374 options.helperBase = options.helperBase ?? EthUniqueHelper;375376 super(logger, options);377 this.eth = new EthGroup(this);378 this.ethAddress = new EthAddressGroup(this);379 this.ethCrossAccount = new EthCrossAccountGroup(this);380 this.ethNativeContract = new NativeContractGroup(this);381 this.ethContract = new ContractGroup(this);382 }383384 getWeb3(): Web3 {385 if(this.web3 === null) throw Error('Web3 not connected');386 return this.web3;387 }388389 async connectWeb3(wsEndpoint: string) {390 if(this.web3 !== null) return;391 this.web3Provider = new Web3.providers.WebsocketProvider(wsEndpoint);392 this.web3 = new Web3(this.web3Provider);393 }394395 async disconnect() {396 if(this.web3 === null) return;397 this.web3Provider?.connection.close();398399 await super.disconnect();400 }401402 clearApi() {403 super.clearApi();404 this.web3 = null;405 }406407 clone(helperCls: EthUniqueHelperConstructor, options?: { [key: string]: any; }): EthUniqueHelper {408 const newHelper = super.clone(helperCls, options) as EthUniqueHelper;409 newHelper.web3 = this.web3;410 newHelper.web3Provider = this.web3Provider;411412 return newHelper;413 }414}