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, EthProperty} from './types';222324import collectionHelpersAbi from '../../abi/collectionHelpers.json';25import fungibleAbi from '../../abi/fungible.json';26import fungibleDeprecatedAbi from '../../abi/fungibleDeprecated.json';27import nonFungibleAbi from '../../abi/nonFungible.json';28import nonFungibleDeprecatedAbi from '../../abi/nonFungibleDeprecated.json';29import refungibleAbi from '../../abi/reFungible.json';30import refungibleDeprecatedAbi from '../../abi/reFungibleDeprecated.json';31import refungibleTokenAbi from '../../abi/reFungibleToken.json';32import contractHelpersAbi from '../../abi/contractHelpers.json';33import {ICrossAccountId, TEthereumAccount} from '../../../util/playgrounds/types';34import {TCollectionMode} from '../../../util/playgrounds/types';3536class EthGroupBase {37 helper: EthUniqueHelper;3839 constructor(helper: EthUniqueHelper) {40 this.helper = helper;41 }42}434445class ContractGroup extends EthGroupBase {46 async findImports(imports?: ContractImports[]){47 if(!imports) return function(path: string) {48 return {error: `File not found: ${path}`};49 };5051 const knownImports = {} as {[key: string]: string};52 for(const imp of imports) {53 knownImports[imp.solPath] = (await readFile(imp.fsPath)).toString();54 }5556 return function(path: string) {57 if(path in knownImports) return {contents: knownImports[path]};58 return {error: `File not found: ${path}`};59 };60 }6162 async compile(name: string, src: string, imports?: ContractImports[]): Promise<CompiledContract> {63 const out = JSON.parse(solc.compile(JSON.stringify({64 language: 'Solidity',65 sources: {66 [`${name}.sol`]: {67 content: src,68 },69 },70 settings: {71 outputSelection: {72 '*': {73 '*': ['*'],74 },75 },76 },77 }), {import: await this.findImports(imports)})).contracts[`${name}.sol`][name];7879 return {80 abi: out.abi,81 object: '0x' + out.evm.bytecode.object,82 };83 }8485 async deployByCode(signer: string, name: string, src: string, imports?: ContractImports[], gas?: number): Promise<Contract> {86 const compiledContract = await this.compile(name, src, imports);87 return this.deployByAbi(signer, compiledContract.abi, compiledContract.object, gas);88 }8990 async deployByAbi(signer: string, abi: any, object: string, gas?: number): Promise<Contract> {91 const web3 = this.helper.getWeb3();92 const contract = new web3.eth.Contract(abi, undefined, {93 data: object,94 from: signer,95 gas: gas ?? this.helper.eth.DEFAULT_GAS,96 });97 return await contract.deploy({data: object}).send({from: signer});98 }99100}101102class NativeContractGroup extends EthGroupBase {103104 contractHelpers(caller: string): Contract {105 const web3 = this.helper.getWeb3();106 return new web3.eth.Contract(contractHelpersAbi as any, '0x842899ECF380553E8a4de75bF534cdf6fBF64049', {from: caller, gas: this.helper.eth.DEFAULT_GAS});107 }108109 collectionHelpers(caller: string) {110 const web3 = this.helper.getWeb3();111 return new web3.eth.Contract(collectionHelpersAbi as any, '0x6c4e9fe1ae37a41e93cee429e8e1881abdcbb54f', {from: caller, gas: this.helper.eth.DEFAULT_GAS});112 }113114 collection(address: string, mode: TCollectionMode, caller?: string, mergeDeprecated = false): Contract {115 let abi = {116 'nft': nonFungibleAbi,117 'rft': refungibleAbi,118 'ft': fungibleAbi,119 }[mode];120 if (mergeDeprecated) {121 const deprecated = {122 'nft': nonFungibleDeprecatedAbi,123 'rft': refungibleDeprecatedAbi,124 'ft': fungibleDeprecatedAbi,125 }[mode];126 abi = [...abi,...deprecated];127 }128 const web3 = this.helper.getWeb3();129 return new web3.eth.Contract(abi as any, address, {gas: this.helper.eth.DEFAULT_GAS, ...(caller ? {from: caller} : {})});130 }131132 collectionById(collectionId: number, mode: 'nft' | 'rft' | 'ft', caller?: string): Contract {133 return this.collection(this.helper.ethAddress.fromCollectionId(collectionId), mode, caller);134 }135136 rftToken(address: string, caller?: string): Contract {137 const web3 = this.helper.getWeb3();138 return new web3.eth.Contract(refungibleTokenAbi as any, address, {gas: this.helper.eth.DEFAULT_GAS, ...(caller ? {from: caller} : {})});139 }140141 rftTokenById(collectionId: number, tokenId: number, caller?: string): Contract {142 return this.rftToken(this.helper.ethAddress.fromTokenId(collectionId, tokenId), caller);143 }144}145146147class EthGroup extends EthGroupBase {148 DEFAULT_GAS = 2_500_000;149150 createAccount() {151 const web3 = this.helper.getWeb3();152 const account = web3.eth.accounts.create();153 web3.eth.accounts.wallet.add(account.privateKey);154 return account.address;155 }156157 async createAccountWithBalance(donor: IKeyringPair, amount=100n) {158 const account = this.createAccount();159 await this.transferBalanceFromSubstrate(donor, account, amount);160161 return account;162 }163164 async transferBalanceFromSubstrate(donor: IKeyringPair, recepient: string, amount=100n, inTokens=true) {165 return await this.helper.balance.transferToSubstrate(donor, evmToAddress(recepient), amount * (inTokens ? this.helper.balance.getOneTokenNominal() : 1n));166 }167168 async getCollectionCreationFee(signer: string) {169 const collectionHelper = this.helper.ethNativeContract.collectionHelpers(signer);170 return await collectionHelper.methods.collectionCreationFee().call();171 }172173 async sendEVM(signer: IKeyringPair, contractAddress: string, abi: string, value: string, gasLimit?: number) {174 if(!gasLimit) gasLimit = this.DEFAULT_GAS;175 const web3 = this.helper.getWeb3();176 const gasPrice = await web3.eth.getGasPrice();177 178 await this.helper.executeExtrinsic(179 signer,180 'api.tx.evm.call', [this.helper.address.substrateToEth(signer.address), contractAddress, abi, value, gasLimit, gasPrice, null, null, []],181 true,182 );183 }184185 async callEVM(signer: TEthereumAccount, contractAddress: string, abi: string) {186 return await this.helper.callRpc('api.rpc.eth.call', [{from: signer, to: contractAddress, data: abi}]);187 }188189 async createCollecion(functionName: string, signer: string, name: string, description: string, tokenPrefix: string): Promise<{ collectionId: number, collectionAddress: string, events: NormalizedEvent[] }> {190 const collectionCreationPrice = this.helper.balance.getCollectionCreationPrice();191 const collectionHelper = this.helper.ethNativeContract.collectionHelpers(signer);192193 const result = await collectionHelper.methods[functionName](name, description, tokenPrefix).send({value: Number(collectionCreationPrice)});194195 const collectionAddress = this.helper.ethAddress.normalizeAddress(result.events.CollectionCreated.returnValues.collectionId);196 const collectionId = this.helper.ethAddress.extractCollectionId(collectionAddress);197 const events = this.helper.eth.normalizeEvents(result.events);198199 return {collectionId, collectionAddress, events};200 }201202 createNFTCollection(signer: string, name: string, description: string, tokenPrefix: string): Promise<{ collectionId: number, collectionAddress: string, events: NormalizedEvent[] }> {203 return this.createCollecion('createNFTCollection', signer, name, description, tokenPrefix);204 }205206 async createERC721MetadataCompatibleNFTCollection(signer: string, name: string, description: string, tokenPrefix: string, baseUri: string): Promise<{collectionId: number, collectionAddress: string, events: NormalizedEvent[] }> {207 const collectionHelper = this.helper.ethNativeContract.collectionHelpers(signer);208209 const {collectionId, collectionAddress, events} = await this.createCollecion('createNFTCollection', signer, name, description, tokenPrefix);210211 await collectionHelper.methods.makeCollectionERC721MetadataCompatible(collectionAddress, baseUri).send();212213 return {collectionId, collectionAddress, events};214 }215216 createRFTCollection(signer: string, name: string, description: string, tokenPrefix: string): Promise<{collectionId: number, collectionAddress: string, events: NormalizedEvent[]}> {217 return this.createCollecion('createRFTCollection', signer, name, description, tokenPrefix);218 }219220 async createFungibleCollection(signer: string, name: string, decimals: number, description: string, tokenPrefix: string): Promise<{ collectionId: number, collectionAddress: string, events: NormalizedEvent[]}> {221 const collectionCreationPrice = this.helper.balance.getCollectionCreationPrice();222 const collectionHelper = this.helper.ethNativeContract.collectionHelpers(signer);223224 const result = await collectionHelper.methods.createFTCollection(name, decimals, description, tokenPrefix).send({value: Number(collectionCreationPrice)});225 const collectionAddress = this.helper.ethAddress.normalizeAddress(result.events.CollectionCreated.returnValues.collectionId);226 const collectionId = this.helper.ethAddress.extractCollectionId(collectionAddress);227228 const events = this.helper.eth.normalizeEvents(result.events);229230 return {collectionId, collectionAddress, events};231 }232233 async createERC721MetadataCompatibleRFTCollection(signer: string, name: string, description: string, tokenPrefix: string, baseUri: string): Promise<{collectionId: number, collectionAddress: string, events: NormalizedEvent[] }> {234 const collectionHelper = this.helper.ethNativeContract.collectionHelpers(signer);235236 const {collectionId, collectionAddress, events} = await this.createCollecion('createRFTCollection', signer, name, description, tokenPrefix);237238 await collectionHelper.methods.makeCollectionERC721MetadataCompatible(collectionAddress, baseUri).send();239240 return {collectionId, collectionAddress, events};241 }242243 async deployCollectorContract(signer: string): Promise<Contract> {244 return await this.helper.ethContract.deployByCode(signer, 'Collector', `245 // SPDX-License-Identifier: UNLICENSED246 pragma solidity ^0.8.6;247248 contract Collector {249 uint256 collected;250 fallback() external payable {251 giveMoney();252 }253 function giveMoney() public payable {254 collected += msg.value;255 }256 function getCollected() public view returns (uint256) {257 return collected;258 }259 function getUnaccounted() public view returns (uint256) {260 return address(this).balance - collected;261 }262263 function withdraw(address payable target) public {264 target.transfer(collected);265 collected = 0;266 }267 }268 `);269 }270271 async deployFlipper(signer: string): Promise<Contract> {272 return await this.helper.ethContract.deployByCode(signer, 'Flipper', `273 // SPDX-License-Identifier: UNLICENSED274 pragma solidity ^0.8.6;275276 contract Flipper {277 bool value = false;278 function flip() public {279 value = !value;280 }281 function getValue() public view returns (bool) {282 return value;283 }284 }285 `);286 }287288 async recordCallFee(user: string, call: () => Promise<any>): Promise<bigint> {289 const before = await this.helper.balance.getEthereum(user);290 await call();291 292 await this.helper.wait.newBlocks(1);293 const after = await this.helper.balance.getEthereum(user);294295 return before - after;296 }297298 normalizeEvents(events: any): NormalizedEvent[] {299 const output = [];300 for (const key of Object.keys(events)) {301 if (key.match(/^[0-9]+$/)) {302 output.push(events[key]);303 } else if (Array.isArray(events[key])) {304 output.push(...events[key]);305 } else {306 output.push(events[key]);307 }308 }309 output.sort((a, b) => a.logIndex - b.logIndex);310 return output.map(({address, event, returnValues}) => {311 const args: { [key: string]: string } = {};312 for (const key of Object.keys(returnValues)) {313 if (!key.match(/^[0-9]+$/)) {314 args[key] = returnValues[key];315 }316 }317 return {318 address,319 event,320 args,321 };322 });323 }324325 async calculateFee(address: ICrossAccountId, code: () => Promise<any>): Promise<bigint> {326 const wrappedCode = async () => {327 await code();328 329 await this.helper.wait.newBlocks(1);330 };331 return await this.helper.arrange.calculcateFee(address, wrappedCode);332 }333}334335class EthAddressGroup extends EthGroupBase {336 extractCollectionId(address: string): number {337 if (!(address.length === 42 || address.length === 40)) throw new Error('address wrong format');338 return parseInt(address.substr(address.length - 8), 16);339 }340341 fromCollectionId(collectionId: number): string {342 if (collectionId >= 0xffffffff || collectionId < 0) throw new Error('collectionId overflow');343 return Web3.utils.toChecksumAddress(`0x17c4e6453cc49aaaaeaca894e6d9683e${collectionId.toString(16).padStart(8, '0')}`);344 }345346 extractTokenId(address: string): {collectionId: number, tokenId: number} {347 if (!address.startsWith('0x'))348 throw 'address not starts with "0x"';349 if (address.length > 42)350 throw 'address length is more than 20 bytes';351 return {352 collectionId: Number('0x' + address.substring(address.length - 16, address.length - 8)),353 tokenId: Number('0x' + address.substring(address.length - 8)),354 };355 }356357 fromTokenId(collectionId: number, tokenId: number): string {358 return this.helper.util.getTokenAddress({collectionId, tokenId});359 }360361 normalizeAddress(address: string): string {362 return '0x' + address.substring(address.length - 40);363 }364}365export class EthPropertyGroup extends EthGroupBase {366 property(key: string, value: string): EthProperty {367 return [368 key,369 '0x'+Buffer.from(value).toString('hex'),370 ];371 }372}373export type EthUniqueHelperConstructor = new (...args: any[]) => EthUniqueHelper;374375export class EthCrossAccountGroup extends EthGroupBase {376 fromAddress(address: TEthereumAccount): TEthCrossAccount {377 return {378 eth: address,379 sub: '0',380 };381 }382383 fromKeyringPair(keyring: IKeyringPair): TEthCrossAccount {384 return {385 eth: '0x0000000000000000000000000000000000000000',386 sub: keyring.addressRaw,387 };388 }389}390391export class EthUniqueHelper extends DevUniqueHelper {392 web3: Web3 | null = null;393 web3Provider: WebsocketProvider | null = null;394395 eth: EthGroup;396 ethAddress: EthAddressGroup;397 ethCrossAccount: EthCrossAccountGroup;398 ethNativeContract: NativeContractGroup;399 ethContract: ContractGroup;400 ethProperty: EthPropertyGroup;401402 constructor(logger: { log: (msg: any, level: any) => void, level: any }, options: {[key: string]: any} = {}) {403 options.helperBase = options.helperBase ?? EthUniqueHelper;404405 super(logger, options);406 this.eth = new EthGroup(this);407 this.ethAddress = new EthAddressGroup(this);408 this.ethCrossAccount = new EthCrossAccountGroup(this);409 this.ethNativeContract = new NativeContractGroup(this);410 this.ethContract = new ContractGroup(this);411 this.ethProperty = new EthPropertyGroup(this);412 }413414 getWeb3(): Web3 {415 if(this.web3 === null) throw Error('Web3 not connected');416 return this.web3;417 }418419 connectWeb3(wsEndpoint: string) {420 if(this.web3 !== null) return;421 this.web3Provider = new Web3.providers.WebsocketProvider(wsEndpoint);422 this.web3 = new Web3(this.web3Provider);423 }424425 async disconnect() {426 if(this.web3 === null) return;427 this.web3Provider?.connection.close();428429 await super.disconnect();430 }431432 clearApi() {433 super.clearApi();434 this.web3 = null;435 }436437 clone(helperCls: EthUniqueHelperConstructor, options?: { [key: string]: any; }): EthUniqueHelper {438 const newHelper = super.clone(helperCls, options) as EthUniqueHelper;439 newHelper.web3 = this.web3;440 newHelper.web3Provider = this.web3Provider;441442 return newHelper;443 }444}