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 '../../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';31import {TCollectionMode} from '../../../util/playgrounds/types';3233class EthGroupBase {34 helper: EthUniqueHelper;3536 constructor(helper: EthUniqueHelper) {37 this.helper = helper;38 }39}404142class ContractGroup extends EthGroupBase {43 async findImports(imports?: ContractImports[]){44 if(!imports) return function(path: string) {45 return {error: `File not found: ${path}`};46 };4748 const knownImports = {} as {[key: string]: string};49 for(const imp of imports) {50 knownImports[imp.solPath] = (await readFile(imp.fsPath)).toString();51 }5253 return function(path: string) {54 if(path in knownImports) return {contents: knownImports[path]};55 return {error: `File not found: ${path}`};56 };57 }5859 async compile(name: string, src: string, imports?: ContractImports[]): Promise<CompiledContract> {60 const out = JSON.parse(solc.compile(JSON.stringify({61 language: 'Solidity',62 sources: {63 [`${name}.sol`]: {64 content: src,65 },66 },67 settings: {68 outputSelection: {69 '*': {70 '*': ['*'],71 },72 },73 },74 }), {import: await this.findImports(imports)})).contracts[`${name}.sol`][name];7576 return {77 abi: out.abi,78 object: '0x' + out.evm.bytecode.object,79 };80 }8182 async deployByCode(signer: string, name: string, src: string, imports?: ContractImports[]): Promise<Contract> {83 const compiledContract = await this.compile(name, src, imports);84 return this.deployByAbi(signer, compiledContract.abi, compiledContract.object);85 }8687 async deployByAbi(signer: string, abi: any, object: string): Promise<Contract> {88 const web3 = this.helper.getWeb3();89 const contract = new web3.eth.Contract(abi, undefined, {90 data: object,91 from: signer,92 gas: this.helper.eth.DEFAULT_GAS,93 });94 return await contract.deploy({data: object}).send({from: signer});95 }9697}9899class NativeContractGroup extends EthGroupBase {100101 contractHelpers(caller: string): Contract {102 const web3 = this.helper.getWeb3();103 return new web3.eth.Contract(contractHelpersAbi as any, '0x842899ECF380553E8a4de75bF534cdf6fBF64049', {from: caller, gas: this.helper.eth.DEFAULT_GAS});104 }105106 collectionHelpers(caller: string) {107 const web3 = this.helper.getWeb3();108 return new web3.eth.Contract(collectionHelpersAbi as any, '0x6c4e9fe1ae37a41e93cee429e8e1881abdcbb54f', {from: caller, gas: this.helper.eth.DEFAULT_GAS});109 }110111 collection(address: string, mode: TCollectionMode, caller?: string): Contract {112 const abi = {113 'nft': nonFungibleAbi,114 'rft': refungibleAbi,115 'ft': fungibleAbi,116 }[mode];117 const web3 = this.helper.getWeb3();118 return new web3.eth.Contract(abi as any, address, {gas: this.helper.eth.DEFAULT_GAS, ...(caller ? {from: caller} : {})});119 }120121 collectionById(collectionId: number, mode: 'nft' | 'rft' | 'ft', caller?: string): Contract {122 return this.collection(this.helper.ethAddress.fromCollectionId(collectionId), mode, caller);123 }124125 rftToken(address: string, caller?: string): Contract {126 const web3 = this.helper.getWeb3();127 return new web3.eth.Contract(refungibleTokenAbi as any, address, {gas: this.helper.eth.DEFAULT_GAS, ...(caller ? {from: caller} : {})});128 }129130 rftTokenById(collectionId: number, tokenId: number, caller?: string): Contract {131 return this.rftToken(this.helper.ethAddress.fromTokenId(collectionId, tokenId), caller);132 }133}134135136class EthGroup extends EthGroupBase {137 DEFAULT_GAS = 2_500_000;138139 createAccount() {140 const web3 = this.helper.getWeb3();141 const account = web3.eth.accounts.create();142 web3.eth.accounts.wallet.add(account.privateKey);143 return account.address;144 }145146 async createAccountWithBalance(donor: IKeyringPair, amount=100n) {147 const account = this.createAccount();148 await this.transferBalanceFromSubstrate(donor, account, amount);149150 return account;151 }152153 async transferBalanceFromSubstrate(donor: IKeyringPair, recepient: string, amount=100n, inTokens=true) {154 return await this.helper.balance.transferToSubstrate(donor, evmToAddress(recepient), amount * (inTokens ? this.helper.balance.getOneTokenNominal() : 1n));155 }156157 async getCollectionCreationFee(signer: string) {158 const collectionHelper = this.helper.ethNativeContract.collectionHelpers(signer);159 return await collectionHelper.methods.collectionCreationFee().call();160 }161162 async sendEVM(signer: IKeyringPair, contractAddress: string, abi: string, value: string, gasLimit?: number) {163 if(!gasLimit) gasLimit = this.DEFAULT_GAS;164 const web3 = this.helper.getWeb3();165 const gasPrice = await web3.eth.getGasPrice();166 167 await this.helper.executeExtrinsic(168 signer,169 'api.tx.evm.call', [this.helper.address.substrateToEth(signer.address), contractAddress, abi, value, gasLimit, gasPrice, null, null, []],170 true,171 );172 }173174 async callEVM(signer: TEthereumAccount, contractAddress: string, abi: string) {175 return await this.helper.callRpc('api.rpc.eth.call', [{from: signer, to: contractAddress, data: abi}]);176 }177 178 async createCollecion(functionName: string, signer: string, name: string, description: string, tokenPrefix: string): Promise<{ collectionId: number, collectionAddress: string, events: NormalizedEvent[] }> {179 const collectionCreationPrice = this.helper.balance.getCollectionCreationPrice();180 const collectionHelper = this.helper.ethNativeContract.collectionHelpers(signer);181 182 const result = await collectionHelper.methods[functionName](name, description, tokenPrefix).send({value: Number(collectionCreationPrice)});183184 const collectionAddress = this.helper.ethAddress.normalizeAddress(result.events.CollectionCreated.returnValues.collectionId);185 const collectionId = this.helper.ethAddress.extractCollectionId(collectionAddress);186 const events = this.helper.eth.normalizeEvents(result.events);187 188 return {collectionId, collectionAddress, events};189 }190 191 async createNFTCollection(signer: string, name: string, description: string, tokenPrefix: string): Promise<{ collectionId: number, collectionAddress: string, events: NormalizedEvent[] }> {192 return this.createCollecion('createNFTCollection', signer, name, description, tokenPrefix);193 }194195 async createERC721MetadataCompatibleNFTCollection(signer: string, name: string, description: string, tokenPrefix: string, baseUri: string): Promise<{collectionId: number, collectionAddress: string, events: NormalizedEvent[] }> {196 const collectionHelper = this.helper.ethNativeContract.collectionHelpers(signer);197198 const {collectionId, collectionAddress, events} = await this.createCollecion('createNFTCollection', signer, name, description, tokenPrefix);199200 await collectionHelper.methods.makeCollectionERC721MetadataCompatible(collectionAddress, baseUri).send();201202 return {collectionId, collectionAddress, events};203 }204205 async createRFTCollection(signer: string, name: string, description: string, tokenPrefix: string): Promise<{collectionId: number, collectionAddress: string}> {206 return this.createCollecion('createRFTCollection', signer, name, description, tokenPrefix);207 }208209 async createERC721MetadataCompatibleRFTCollection(signer: string, name: string, description: string, tokenPrefix: string, baseUri: string): Promise<{collectionId: number, collectionAddress: string, events: NormalizedEvent[] }> {210 const collectionHelper = this.helper.ethNativeContract.collectionHelpers(signer);211212 const {collectionId, collectionAddress, events} = await this.createCollecion('createRFTCollection', signer, name, description, tokenPrefix);213214 await collectionHelper.methods.makeCollectionERC721MetadataCompatible(collectionAddress, baseUri).send();215216 return {collectionId, collectionAddress, events};217 }218219 async deployCollectorContract(signer: string): Promise<Contract> {220 return await this.helper.ethContract.deployByCode(signer, 'Collector', `221 // SPDX-License-Identifier: UNLICENSED222 pragma solidity ^0.8.6;223224 contract Collector {225 uint256 collected;226 fallback() external payable {227 giveMoney();228 }229 function giveMoney() public payable {230 collected += msg.value;231 }232 function getCollected() public view returns (uint256) {233 return collected;234 }235 function getUnaccounted() public view returns (uint256) {236 return address(this).balance - collected;237 }238239 function withdraw(address payable target) public {240 target.transfer(collected);241 collected = 0;242 }243 }244 `);245 }246247 async deployFlipper(signer: string): Promise<Contract> {248 return await this.helper.ethContract.deployByCode(signer, 'Flipper', `249 // SPDX-License-Identifier: UNLICENSED250 pragma solidity ^0.8.6;251252 contract Flipper {253 bool value = false;254 function flip() public {255 value = !value;256 }257 function getValue() public view returns (bool) {258 return value;259 }260 }261 `);262 }263264 async recordCallFee(user: string, call: () => Promise<any>): Promise<bigint> {265 const before = await this.helper.balance.getEthereum(user);266 await call();267 268 await this.helper.wait.newBlocks(1);269 const after = await this.helper.balance.getEthereum(user);270271 return before - after;272 }273274 normalizeEvents(events: any): NormalizedEvent[] {275 const output = [];276 for (const key of Object.keys(events)) {277 if (key.match(/^[0-9]+$/)) {278 output.push(events[key]);279 } else if (Array.isArray(events[key])) {280 output.push(...events[key]);281 } else {282 output.push(events[key]);283 }284 }285 output.sort((a, b) => a.logIndex - b.logIndex);286 return output.map(({address, event, returnValues}) => {287 const args: { [key: string]: string } = {};288 for (const key of Object.keys(returnValues)) {289 if (!key.match(/^[0-9]+$/)) {290 args[key] = returnValues[key];291 }292 }293 return {294 address,295 event,296 args,297 };298 });299 }300301 async calculateFee(address: ICrossAccountId, code: () => Promise<any>): Promise<bigint> {302 const wrappedCode = async () => {303 await code();304 305 await this.helper.wait.newBlocks(1);306 };307 return await this.helper.arrange.calculcateFee(address, wrappedCode);308 }309}310311class EthAddressGroup extends EthGroupBase {312 extractCollectionId(address: string): number {313 if (!(address.length === 42 || address.length === 40)) throw new Error('address wrong format');314 return parseInt(address.substr(address.length - 8), 16);315 }316317 fromCollectionId(collectionId: number): string {318 if (collectionId >= 0xffffffff || collectionId < 0) throw new Error('collectionId overflow');319 return Web3.utils.toChecksumAddress(`0x17c4e6453cc49aaaaeaca894e6d9683e${collectionId.toString(16).padStart(8, '0')}`);320 }321322 extractTokenId(address: string): {collectionId: number, tokenId: number} {323 if (!address.startsWith('0x'))324 throw 'address not starts with "0x"';325 if (address.length > 42)326 throw 'address length is more than 20 bytes';327 return {328 collectionId: Number('0x' + address.substring(address.length - 16, address.length - 8)),329 tokenId: Number('0x' + address.substring(address.length - 8)),330 };331 }332333 fromTokenId(collectionId: number, tokenId: number): string {334 return this.helper.util.getTokenAddress({collectionId, tokenId});335 }336337 normalizeAddress(address: string): string {338 return '0x' + address.substring(address.length - 40);339 }340} 341342export class EthPropertyGroup extends EthGroupBase {343 property(key: string, value: string): EthProperty {344 return [345 key, 346 '0x'+Buffer.from(value).toString('hex'),347 ];348 }349}350export type EthUniqueHelperConstructor = new (...args: any[]) => EthUniqueHelper;351352export class EthCrossAccountGroup extends EthGroupBase {353 fromAddress(address: TEthereumAccount): TEthCrossAccount {354 return {355 0: address,356 1: '0',357 field_0: address,358 field_1: '0',359 };360 }361362 fromKeyringPair(keyring: IKeyringPair): TEthCrossAccount {363 return {364 0: '0x0000000000000000000000000000000000000000',365 1: keyring.addressRaw,366 field_0: '0x0000000000000000000000000000000000000000',367 field_1: keyring.addressRaw,368 };369 }370}371372export class EthUniqueHelper extends DevUniqueHelper {373 web3: Web3 | null = null;374 web3Provider: WebsocketProvider | null = null;375376 eth: EthGroup;377 ethAddress: EthAddressGroup;378 ethNativeContract: NativeContractGroup;379 ethContract: ContractGroup;380 ethCrossAccount: EthCrossAccountGroup;381 ethProperty: EthPropertyGroup;382383 constructor(logger: { log: (msg: any, level: any) => void, level: any }, options: {[key: string]: any} = {}) {384 options.helperBase = options.helperBase ?? EthUniqueHelper;385386 super(logger, options);387 this.eth = new EthGroup(this);388 this.ethAddress = new EthAddressGroup(this);389 this.ethCrossAccount = new EthCrossAccountGroup(this);390 this.ethNativeContract = new NativeContractGroup(this);391 this.ethContract = new ContractGroup(this);392 this.ethProperty = new EthPropertyGroup(this);393 }394395 getWeb3(): Web3 {396 if(this.web3 === null) throw Error('Web3 not connected');397 return this.web3;398 }399400 async connectWeb3(wsEndpoint: string) {401 if(this.web3 !== null) return;402 this.web3Provider = new Web3.providers.WebsocketProvider(wsEndpoint);403 this.web3 = new Web3(this.web3Provider);404 }405406 async disconnect() {407 if(this.web3 === null) return;408 this.web3Provider?.connection.close();409410 await super.disconnect();411 }412413 clearApi() {414 super.clearApi();415 this.web3 = null;416 }417418 clone(helperCls: EthUniqueHelperConstructor, options?: { [key: string]: any; }): EthUniqueHelper {419 const newHelper = super.clone(helperCls, options) as EthUniqueHelper;420 newHelper.web3 = this.web3;421 newHelper.web3Provider = this.web3Provider;422423 return newHelper;424 }425}