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 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 216 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 335 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 372 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}