12345678import {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';222324import collectionHelpersAbi from '../../abi/collectionHelpers.json' assert {type: 'json'};25import fungibleAbi from '../../abi/fungible.json' assert {type: 'json'};26import fungibleDeprecatedAbi from '../../abi/fungibleDeprecated.json' assert {type: 'json'};27import nonFungibleAbi from '../../abi/nonFungible.json' assert {type: 'json'};28import nonFungibleDeprecatedAbi from '../../abi/nonFungibleDeprecated.json' assert {type: 'json'};29import refungibleAbi from '../../abi/reFungible.json' assert {type: 'json'};30import refungibleDeprecatedAbi from '../../abi/reFungibleDeprecated.json' assert {type: 'json'};31import refungibleTokenAbi from '../../abi/reFungibleToken.json' assert {type: 'json'};32import refungibleTokenDeprecatedAbi from '../../abi/reFungibleTokenDeprecated.json' assert {type: 'json'};33import contractHelpersAbi from '../../abi/contractHelpers.json' assert {type: 'json'};34import {ICrossAccountId, TEthereumAccount} from '../../../util/playgrounds/types';35import {TCollectionMode} from '../../../util/playgrounds/types';3637class EthGroupBase {38 helper: EthUniqueHelper;39 gasPrice?: string;4041 constructor(helper: EthUniqueHelper) {42 this.helper = helper;43 }44 async getGasPrice() {45 if (this.gasPrice)46 return this.gasPrice;47 this.gasPrice = await this.helper.getWeb3().eth.getGasPrice();48 return this.gasPrice;49 }50}515253class ContractGroup extends EthGroupBase {54 async findImports(imports?: ContractImports[]) {55 if (!imports) return function(path: string) {56 return {error: `File not found: ${path}`};57 };5859 const knownImports = {} as { [key: string]: string };60 for (const imp of imports) {61 knownImports[imp.solPath] = (await readFile(imp.fsPath)).toString();62 }6364 return function(path: string) {65 if (path in knownImports) return {contents: knownImports[path]};66 return {error: `File not found: ${path}`};67 };68 }6970 async compile(name: string, src: string, imports?: ContractImports[]): Promise<CompiledContract> {71 const compiled = JSON.parse(solc.compile(JSON.stringify({72 language: 'Solidity',73 sources: {74 [`${name}.sol`]: {75 content: src,76 },77 },78 settings: {79 outputSelection: {80 '*': {81 '*': ['*'],82 },83 },84 },85 }), {import: await this.findImports(imports)}));8687 const hasErrors = compiled['errors']88 && compiled['errors'].length > 089 && compiled.errors.some(function(err: any) {90 return err.severity == 'error';91 });9293 if (hasErrors) {94 throw compiled.errors;95 }96 const out = compiled.contracts[`${name}.sol`][name];9798 return {99 abi: out.abi,100 object: '0x' + out.evm.bytecode.object,101 };102 }103104 async deployByCode(signer: string, name: string, src: string, imports?: ContractImports[], gas?: number): Promise<Contract> {105 const compiledContract = await this.compile(name, src, imports);106 return this.deployByAbi(signer, compiledContract.abi, compiledContract.object, gas);107 }108109 async deployByAbi(signer: string, abi: any, object: string, gas?: number): Promise<Contract> {110 const web3 = this.helper.getWeb3();111 const contract = new web3.eth.Contract(abi, undefined, {112 data: object,113 from: signer,114 gas: gas ?? this.helper.eth.DEFAULT_GAS,115 gasPrice: await this.getGasPrice(),116 });117 return await contract.deploy({data: object}).send({from: signer});118 }119120}121122class NativeContractGroup extends EthGroupBase {123124 async contractHelpers(caller: string): Promise<Contract> {125 const web3 = this.helper.getWeb3();126 return new web3.eth.Contract(contractHelpersAbi as any, this.helper.getApi().consts.evmContractHelpers.contractAddress.toString(), {127 from: caller,128 gas: this.helper.eth.DEFAULT_GAS,129 gasPrice: await this.getGasPrice(),130 });131 }132133 async collectionHelpers(caller: string) {134 const web3 = this.helper.getWeb3();135 return new web3.eth.Contract(collectionHelpersAbi as any, this.helper.getApi().consts.common.contractAddress.toString(), {136 from: caller,137 gas: this.helper.eth.DEFAULT_GAS,138 gasPrice: await this.getGasPrice(),139 });140 }141142 async collection(address: string, mode: TCollectionMode, caller?: string, mergeDeprecated = false) {143 let abi = {144 'nft': nonFungibleAbi,145 'rft': refungibleAbi,146 'ft': fungibleAbi,147 }[mode];148 if (mergeDeprecated) {149 const deprecated = {150 'nft': nonFungibleDeprecatedAbi,151 'rft': refungibleDeprecatedAbi,152 'ft': fungibleDeprecatedAbi,153 }[mode];154 abi = [...abi, ...deprecated];155 }156 const web3 = this.helper.getWeb3();157 return new web3.eth.Contract(abi as any, address, {158 gas: this.helper.eth.DEFAULT_GAS,159 gasPrice: await this.getGasPrice(),160 ...(caller ? {from: caller} : {}),161 });162 }163164 collectionById(collectionId: number, mode: 'nft' | 'rft' | 'ft', caller?: string, mergeDeprecated = false) {165 return this.collection(this.helper.ethAddress.fromCollectionId(collectionId), mode, caller, mergeDeprecated);166 }167168 async rftToken(address: string, caller?: string, mergeDeprecated = false) {169 const web3 = this.helper.getWeb3();170 const abi = mergeDeprecated ? [...refungibleTokenAbi, ...refungibleTokenDeprecatedAbi] : refungibleTokenAbi;171 return new web3.eth.Contract(abi as any, address, {172 gas: this.helper.eth.DEFAULT_GAS,173 gasPrice: await this.getGasPrice(),174 ...(caller ? {from: caller} : {}),175 });176 }177178 rftTokenById(collectionId: number, tokenId: number, caller?: string, mergeDeprecated = false) {179 return this.rftToken(this.helper.ethAddress.fromTokenId(collectionId, tokenId), caller, mergeDeprecated);180 }181}182183184class EthGroup extends EthGroupBase {185 DEFAULT_GAS = 2_500_000;186187 createAccount() {188 const web3 = this.helper.getWeb3();189 const account = web3.eth.accounts.create();190 web3.eth.accounts.wallet.add(account.privateKey);191 return account.address;192 }193194 async createAccountWithBalance(donor: IKeyringPair, amount = 600n) {195 const account = this.createAccount();196 await this.transferBalanceFromSubstrate(donor, account, amount);197198 return account;199 }200201 async transferBalanceFromSubstrate(donor: IKeyringPair, recepient: string, amount = 100n, inTokens = true) {202 return await this.helper.balance.transferToSubstrate(donor, evmToAddress(recepient), amount * (inTokens ? this.helper.balance.getOneTokenNominal() : 1n));203 }204205 async getCollectionCreationFee(signer: string) {206 const collectionHelper = await this.helper.ethNativeContract.collectionHelpers(signer);207 return await collectionHelper.methods.collectionCreationFee().call();208 }209210 async sendEVM(signer: IKeyringPair, contractAddress: string, abi: string, value: string, gasLimit?: number) {211 if (!gasLimit) gasLimit = this.DEFAULT_GAS;212 const web3 = this.helper.getWeb3();213 const gasPrice = await web3.eth.getGasPrice();214 215 await this.helper.executeExtrinsic(216 signer,217 'api.tx.evm.call', [this.helper.address.substrateToEth(signer.address), contractAddress, abi, value, gasLimit, gasPrice, null, null, []],218 true,219 );220 }221222 async callEVM(signer: TEthereumAccount, contractAddress: string, abi: string) {223 return await this.helper.callRpc('api.rpc.eth.call', [{from: signer, to: contractAddress, data: abi}]);224 }225226 createCollectionMethodName(mode: TCollectionMode) {227 switch (mode) {228 case 'ft':229 return 'createFTCollection';230 case 'nft':231 return 'createNFTCollection';232 case 'rft':233 return 'createRFTCollection';234 }235 }236237 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 }> {238 const collectionCreationPrice = this.helper.balance.getCollectionCreationPrice();239 const collectionHelper = await this.helper.ethNativeContract.collectionHelpers(signer);240 const functionName: string = this.createCollectionMethodName(mode);241242 const functionParams = mode === 'ft' ? [name, decimals, description, tokenPrefix] : [name, description, tokenPrefix];243 const result = await collectionHelper.methods[functionName](...functionParams).send({value: Number(collectionCreationPrice)});244245 const collectionAddress = this.helper.ethAddress.normalizeAddress(result.events.CollectionCreated.returnValues.collectionId);246 const collectionId = this.helper.ethAddress.extractCollectionId(collectionAddress);247 const events = this.helper.eth.normalizeEvents(result.events);248 const collection = await this.helper.ethNativeContract.collectionById(collectionId, mode, signer, mergeDeprecated);249250 return {collectionId, collectionAddress, events, collection};251 }252253 createNFTCollection(signer: string, name: string, description: string, tokenPrefix: string): Promise<{ collectionId: number, collectionAddress: string, events: NormalizedEvent[] }> {254 return this.createCollection('nft', signer, name, description, tokenPrefix);255 }256257 async createERC721MetadataCompatibleNFTCollection(signer: string, name: string, description: string, tokenPrefix: string, baseUri: string): Promise<{ collectionId: number, collectionAddress: string, events: NormalizedEvent[] }> {258 const collectionHelper = await this.helper.ethNativeContract.collectionHelpers(signer);259260 const {collectionId, collectionAddress, events} = await this.createCollection('nft', signer, name, description, tokenPrefix);261262 await collectionHelper.methods.makeCollectionERC721MetadataCompatible(collectionAddress, baseUri).send();263264 return {collectionId, collectionAddress, events};265 }266267 createRFTCollection(signer: string, name: string, description: string, tokenPrefix: string): Promise<{ collectionId: number, collectionAddress: string, events: NormalizedEvent[] }> {268 return this.createCollection('rft', signer, name, description, tokenPrefix);269 }270271 createFungibleCollection(signer: string, name: string, decimals: number, description: string, tokenPrefix: string): Promise<{ collectionId: number, collectionAddress: string, events: NormalizedEvent[] }> {272 return this.createCollection('ft', signer, name, description, tokenPrefix, decimals);273 }274275 async createERC721MetadataCompatibleRFTCollection(signer: string, name: string, description: string, tokenPrefix: string, baseUri: string): Promise<{ collectionId: number, collectionAddress: string, events: NormalizedEvent[] }> {276 const collectionHelper = await this.helper.ethNativeContract.collectionHelpers(signer);277278 const {collectionId, collectionAddress, events} = await this.createCollection('rft', signer, name, description, tokenPrefix);279280 await collectionHelper.methods.makeCollectionERC721MetadataCompatible(collectionAddress, baseUri).send();281282 return {collectionId, collectionAddress, events};283 }284285 async deployCollectorContract(signer: string): Promise<Contract> {286 return await this.helper.ethContract.deployByCode(signer, 'Collector', `287 // SPDX-License-Identifier: UNLICENSED288 pragma solidity ^0.8.6;289290 contract Collector {291 uint256 collected;292 fallback() external payable {293 giveMoney();294 }295 function giveMoney() public payable {296 collected += msg.value;297 }298 function getCollected() public view returns (uint256) {299 return collected;300 }301 function getUnaccounted() public view returns (uint256) {302 return address(this).balance - collected;303 }304305 function withdraw(address payable target) public {306 target.transfer(collected);307 collected = 0;308 }309 }310 `);311 }312313 async deployFlipper(signer: string): Promise<Contract> {314 return await this.helper.ethContract.deployByCode(signer, 'Flipper', `315 // SPDX-License-Identifier: UNLICENSED316 pragma solidity ^0.8.6;317318 contract Flipper {319 bool value = false;320 function flip() public {321 value = !value;322 }323 function getValue() public view returns (bool) {324 return value;325 }326 }327 `);328 }329330 async recordCallFee(user: string, call: () => Promise<any>): Promise<bigint> {331 const before = await this.helper.balance.getEthereum(user);332 await call();333 334 await this.helper.wait.newBlocks(1);335 const after = await this.helper.balance.getEthereum(user);336337 return before - after;338 }339340 normalizeEvents(events: any): NormalizedEvent[] {341 const output = [];342 for (const key of Object.keys(events)) {343 if (key.match(/^[0-9]+$/)) {344 output.push(events[key]);345 } else if (Array.isArray(events[key])) {346 output.push(...events[key]);347 } else {348 output.push(events[key]);349 }350 }351 output.sort((a, b) => a.logIndex - b.logIndex);352 return output.map(({address, event, returnValues}) => {353 const args: { [key: string]: string } = {};354 for (const key of Object.keys(returnValues)) {355 if (!key.match(/^[0-9]+$/)) {356 args[key] = returnValues[key];357 }358 }359 return {360 address,361 event,362 args,363 };364 });365 }366367 async calculateFee(address: ICrossAccountId, code: () => Promise<any>): Promise<bigint> {368 const wrappedCode = async () => {369 await code();370 371 await this.helper.wait.newBlocks(1);372 };373 return await this.helper.arrange.calculcateFee(address, wrappedCode);374 }375}376377class EthAddressGroup extends EthGroupBase {378 extractCollectionId(address: string): number {379 if (!(address.length === 42 || address.length === 40)) throw new Error('address wrong format');380 return parseInt(address.substr(address.length - 8), 16);381 }382383 fromCollectionId(collectionId: number): string {384 if (collectionId >= 0xffffffff || collectionId < 0) throw new Error('collectionId overflow');385 return Web3.utils.toChecksumAddress(`0x17c4e6453cc49aaaaeaca894e6d9683e${collectionId.toString(16).padStart(8, '0')}`);386 }387388 extractTokenId(address: string): { collectionId: number, tokenId: number } {389 if (!address.startsWith('0x'))390 throw 'address not starts with "0x"';391 if (address.length > 42)392 throw 'address length is more than 20 bytes';393 return {394 collectionId: Number('0x' + address.substring(address.length - 16, address.length - 8)),395 tokenId: Number('0x' + address.substring(address.length - 8)),396 };397 }398399 fromTokenId(collectionId: number, tokenId: number): string {400 return this.helper.util.getTokenAddress({collectionId, tokenId});401 }402403 normalizeAddress(address: string): string {404 return '0x' + address.substring(address.length - 40);405 }406}407export class EthPropertyGroup extends EthGroupBase {408 property(key: string, value: string): EthProperty {409 return [410 key,411 '0x' + Buffer.from(value).toString('hex'),412 ];413 }414}415export type EthUniqueHelperConstructor = new (...args: any[]) => EthUniqueHelper;416417export class EthCrossAccountGroup extends EthGroupBase {418 createAccount(): CrossAddress {419 return this.fromAddress(this.helper.eth.createAccount());420 }421422 async createAccountWithBalance(donor: IKeyringPair, amount = 100n) {423 return this.fromAddress(await this.helper.eth.createAccountWithBalance(donor, amount));424 }425426 fromAddress(address: TEthereumAccount): CrossAddress {427 return {428 eth: address,429 sub: '0',430 };431 }432433 fromKeyringPair(keyring: IKeyringPair): CrossAddress {434 return {435 eth: '0x0000000000000000000000000000000000000000',436 sub: keyring.addressRaw,437 };438 }439}440441export class FeeGas {442 fee: number | bigint = 0n;443444 gas: number | bigint = 0n;445446 public static async build(helper: EthUniqueHelper, fee: bigint): Promise<FeeGas> {447 const instance = new FeeGas();448 instance.fee = instance.convertToTokens(fee);449 instance.gas = await instance.convertToGas(fee, helper);450 return instance;451 }452453 private async convertToGas(fee: bigint, helper: EthUniqueHelper): Promise<bigint> {454 const gasPrice = BigInt(await helper.getWeb3().eth.getGasPrice());455 return fee / gasPrice;456 }457458 private convertToTokens(value: bigint, nominal = 1_000_000_000_000_000_000n): number {459 return Number((value * 1000n) / nominal) / 1000;460 }461}462463class EthArrangeGroup extends ArrangeGroup {464 helper: EthUniqueHelper;465466 constructor(helper: EthUniqueHelper) {467 super(helper);468 this.helper = helper;469 }470471 async calculcateFeeGas(payer: ICrossAccountId, promise: () => Promise<any>): Promise<FeeGas> {472 const fee = await this.calculcateFee(payer, promise);473 return await FeeGas.build(this.helper, fee);474 }475}476export class EthUniqueHelper extends DevUniqueHelper {477 web3: Web3 | null = null;478 web3Provider: WebsocketProvider | null = null;479480 eth: EthGroup;481 ethAddress: EthAddressGroup;482 ethCrossAccount: EthCrossAccountGroup;483 ethNativeContract: NativeContractGroup;484 ethContract: ContractGroup;485 ethProperty: EthPropertyGroup;486 arrange: EthArrangeGroup;487 constructor(logger: { log: (msg: any, level: any) => void, level: any }, options: { [key: string]: any } = {}) {488 options.helperBase = options.helperBase ?? EthUniqueHelper;489490 super(logger, options);491 this.eth = new EthGroup(this);492 this.ethAddress = new EthAddressGroup(this);493 this.ethCrossAccount = new EthCrossAccountGroup(this);494 this.ethNativeContract = new NativeContractGroup(this);495 this.ethContract = new ContractGroup(this);496 this.ethProperty = new EthPropertyGroup(this);497 this.arrange = new EthArrangeGroup(this);498 super.arrange = this.arrange;499 }500501 getWeb3(): Web3 {502 if (this.web3 === null) throw Error('Web3 not connected');503 return this.web3;504 }505506 connectWeb3(wsEndpoint: string) {507 if (this.web3 !== null) return;508 this.web3Provider = new Web3.providers.WebsocketProvider(wsEndpoint);509 this.web3 = new Web3(this.web3Provider);510 }511512 async disconnect() {513 if (this.web3 === null) return;514 this.web3Provider?.connection.close();515516 await super.disconnect();517 }518519 clearApi() {520 super.clearApi();521 this.web3 = null;522 }523524 clone(helperCls: EthUniqueHelperConstructor, options?: { [key: string]: any; }): EthUniqueHelper {525 const newHelper = super.clone(helperCls, options) as EthUniqueHelper;526 newHelper.web3 = this.web3;527 newHelper.web3Provider = this.web3Provider;528529 return newHelper;530 }531}