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 {ArrangeGroup, DevUniqueHelper} from '../../../util/playgrounds/unique.dev';2021import {ContractImports, CompiledContract, CrossAddress, 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 refungibleTokenDeprecatedAbi from '../../abi/reFungibleTokenDeprecated.json';33import contractHelpersAbi from '../../abi/contractHelpers.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}5152function unlimitedMoneyHack<C>(_contract: C): C {53 const contract = _contract as any;54 55 for (const method in contract.methods) {56 const _method = contract.methods[method];57 contract.methods[method] = function (...args: any) {58 const encodedCall = _method.call(this, ...args);59 const _call = encodedCall.call;60 encodedCall.call = function (...args: any) {61 if (args.length === 0) {62 return _call.call(this, {gasPrice: '0'});63 }64 65 if (typeof args[0] !== 'object')66 throw new Error('only options are supported');67 args[0].gasPrice = '0';68 return _call.call(this, ...args);69 };70 return encodedCall;71 };72 }73 return contract;74}7576class ContractGroup extends EthGroupBase {77 async findImports(imports?: ContractImports[]){78 if(!imports) return function(path: string) {79 return {error: `File not found: ${path}`};80 };8182 const knownImports = {} as {[key: string]: string};83 for(const imp of imports) {84 knownImports[imp.solPath] = (await readFile(imp.fsPath)).toString();85 }8687 return function(path: string) {88 if(path in knownImports) return {contents: knownImports[path]};89 return {error: `File not found: ${path}`};90 };91 }9293 async compile(name: string, src: string, imports?: ContractImports[]): Promise<CompiledContract> {94 const compiled = JSON.parse(solc.compile(JSON.stringify({95 language: 'Solidity',96 sources: {97 [`${name}.sol`]: {98 content: src,99 },100 },101 settings: {102 outputSelection: {103 '*': {104 '*': ['*'],105 },106 },107 },108 }), {import: await this.findImports(imports)}));109110 const hasErrors = compiled['errors']111 && compiled['errors'].length > 0112 && compiled.errors.some(function(err: any) {113 return err.severity == 'error';114 });115116 if (hasErrors) {117 throw compiled.errors;118 }119 const out = compiled.contracts[`${name}.sol`][name];120121 return {122 abi: out.abi,123 object: '0x' + out.evm.bytecode.object,124 };125 }126127 async deployByCode(signer: string, name: string, src: string, imports?: ContractImports[], gas?: number): Promise<Contract> {128 const compiledContract = await this.compile(name, src, imports);129 return this.deployByAbi(signer, compiledContract.abi, compiledContract.object, gas);130 }131132 async deployByAbi(signer: string, abi: any, object: string, gas?: number): Promise<Contract> {133 const web3 = this.helper.getWeb3();134 const contract = new web3.eth.Contract(abi, undefined, {135 data: object,136 from: signer,137 gas: gas ?? this.helper.eth.DEFAULT_GAS,138 gasPrice: await this.getGasPrice(),139 });140 return unlimitedMoneyHack(await contract.deploy({data: object}).send({from: signer}));141 }142143}144145class NativeContractGroup extends EthGroupBase {146147 async contractHelpers(caller: string): Promise<Contract> {148 const web3 = this.helper.getWeb3();149 return unlimitedMoneyHack(new web3.eth.Contract(contractHelpersAbi as any, this.helper.getApi().consts.evmContractHelpers.contractAddress.toString(), {150 from: caller,151 gas: this.helper.eth.DEFAULT_GAS,152 gasPrice: await this.getGasPrice(),153 }));154 }155156 async collectionHelpers(caller: string) {157 const web3 = this.helper.getWeb3();158 return unlimitedMoneyHack(new web3.eth.Contract(collectionHelpersAbi as any, this.helper.getApi().consts.common.contractAddress.toString(), {159 from: caller,160 gas: this.helper.eth.DEFAULT_GAS,161 gasPrice: await this.getGasPrice(),162 }));163 }164165 async collection(address: string, mode: TCollectionMode, caller?: string, mergeDeprecated = false) {166 let abi = {167 'nft': nonFungibleAbi,168 'rft': refungibleAbi,169 'ft': fungibleAbi,170 }[mode];171 if (mergeDeprecated) {172 const deprecated = {173 'nft': nonFungibleDeprecatedAbi,174 'rft': refungibleDeprecatedAbi,175 'ft': fungibleDeprecatedAbi,176 }[mode];177 abi = [...abi,...deprecated];178 }179 const web3 = this.helper.getWeb3();180 return unlimitedMoneyHack(new web3.eth.Contract(abi as any, address, {181 gas: this.helper.eth.DEFAULT_GAS,182 gasPrice: await this.getGasPrice(),183 ...(caller ? {from: caller} : {}),184 }));185 }186187 collectionById(collectionId: number, mode: 'nft' | 'rft' | 'ft', caller?: string, mergeDeprecated = false) {188 return this.collection(this.helper.ethAddress.fromCollectionId(collectionId), mode, caller, mergeDeprecated);189 }190191 async rftToken(address: string, caller?: string, mergeDeprecated = false) {192 const web3 = this.helper.getWeb3();193 const abi = mergeDeprecated ? [...refungibleTokenAbi, ...refungibleTokenDeprecatedAbi] : refungibleTokenAbi;194 return unlimitedMoneyHack(new web3.eth.Contract(abi as any, address, {195 gas: this.helper.eth.DEFAULT_GAS,196 gasPrice: await this.getGasPrice(),197 ...(caller ? {from: caller} : {}),198 }));199 }200201 rftTokenById(collectionId: number, tokenId: number, caller?: string, mergeDeprecated = false) {202 return this.rftToken(this.helper.ethAddress.fromTokenId(collectionId, tokenId), caller, mergeDeprecated);203 }204}205206207class EthGroup extends EthGroupBase {208 DEFAULT_GAS = 2_500_000;209210 createAccount() {211 const web3 = this.helper.getWeb3();212 const account = web3.eth.accounts.create();213 web3.eth.accounts.wallet.add(account.privateKey);214 return account.address;215 }216217 async createAccountWithBalance(donor: IKeyringPair, amount=100n) {218 const account = this.createAccount();219 await this.transferBalanceFromSubstrate(donor, account, amount);220221 return account;222 }223224 async transferBalanceFromSubstrate(donor: IKeyringPair, recepient: string, amount=100n, inTokens=true) {225 return await this.helper.balance.transferToSubstrate(donor, evmToAddress(recepient), amount * (inTokens ? this.helper.balance.getOneTokenNominal() : 1n));226 }227228 async getCollectionCreationFee(signer: string) {229 const collectionHelper = await this.helper.ethNativeContract.collectionHelpers(signer);230 return await collectionHelper.methods.collectionCreationFee().call();231 }232233 async sendEVM(signer: IKeyringPair, contractAddress: string, abi: string, value: string, gasLimit?: number) {234 if(!gasLimit) gasLimit = this.DEFAULT_GAS;235 const web3 = this.helper.getWeb3();236 const gasPrice = await web3.eth.getGasPrice();237 238 await this.helper.executeExtrinsic(239 signer,240 'api.tx.evm.call', [this.helper.address.substrateToEth(signer.address), contractAddress, abi, value, gasLimit, gasPrice, null, null, []],241 true,242 );243 }244245 async callEVM(signer: TEthereumAccount, contractAddress: string, abi: string) {246 return await this.helper.callRpc('api.rpc.eth.call', [{from: signer, to: contractAddress, data: abi}]);247 }248249 createCollectionMethodName(mode: TCollectionMode) {250 switch (mode) {251 case 'ft':252 return 'createFTCollection';253 case 'nft':254 return 'createNFTCollection';255 case 'rft':256 return 'createRFTCollection';257 }258 }259260 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 }> {261 const collectionCreationPrice = this.helper.balance.getCollectionCreationPrice();262 const collectionHelper = await this.helper.ethNativeContract.collectionHelpers(signer);263 const functionName: string = this.createCollectionMethodName(mode);264265 const functionParams = mode === 'ft' ? [name, decimals, description, tokenPrefix] : [name, description, tokenPrefix];266 const result = await collectionHelper.methods[functionName](...functionParams).send({value: Number(collectionCreationPrice)});267268 const collectionAddress = this.helper.ethAddress.normalizeAddress(result.events.CollectionCreated.returnValues.collectionId);269 const collectionId = this.helper.ethAddress.extractCollectionId(collectionAddress);270 const events = this.helper.eth.normalizeEvents(result.events);271 const collection = await this.helper.ethNativeContract.collectionById(collectionId, mode, signer, mergeDeprecated);272273 return {collectionId, collectionAddress, events, collection};274 }275276 createNFTCollection(signer: string, name: string, description: string, tokenPrefix: string): Promise<{ collectionId: number, collectionAddress: string, events: NormalizedEvent[] }> {277 return this.createCollection('nft', signer, name, description, tokenPrefix);278 }279280 async createERC721MetadataCompatibleNFTCollection(signer: string, name: string, description: string, tokenPrefix: string, baseUri: string): Promise<{collectionId: number, collectionAddress: string, events: NormalizedEvent[] }> {281 const collectionHelper = await this.helper.ethNativeContract.collectionHelpers(signer);282283 const {collectionId, collectionAddress, events} = await this.createCollection('nft', signer, name, description, tokenPrefix);284285 await collectionHelper.methods.makeCollectionERC721MetadataCompatible(collectionAddress, baseUri).send();286287 return {collectionId, collectionAddress, events};288 }289290 createRFTCollection(signer: string, name: string, description: string, tokenPrefix: string): Promise<{collectionId: number, collectionAddress: string, events: NormalizedEvent[]}> {291 return this.createCollection('rft', signer, name, description, tokenPrefix);292 }293294 createFungibleCollection(signer: string, name: string, decimals: number, description: string, tokenPrefix: string): Promise<{ collectionId: number, collectionAddress: string, events: NormalizedEvent[]}> {295 return this.createCollection('ft', signer, name, description, tokenPrefix, decimals);296 }297298 async createERC721MetadataCompatibleRFTCollection(signer: string, name: string, description: string, tokenPrefix: string, baseUri: string): Promise<{collectionId: number, collectionAddress: string, events: NormalizedEvent[] }> {299 const collectionHelper = await this.helper.ethNativeContract.collectionHelpers(signer);300301 const {collectionId, collectionAddress, events} = await this.createCollection('rft', signer, name, description, tokenPrefix);302303 await collectionHelper.methods.makeCollectionERC721MetadataCompatible(collectionAddress, baseUri).send();304305 return {collectionId, collectionAddress, events};306 }307308 async deployCollectorContract(signer: string): Promise<Contract> {309 return await this.helper.ethContract.deployByCode(signer, 'Collector', `310 // SPDX-License-Identifier: UNLICENSED311 pragma solidity ^0.8.6;312313 contract Collector {314 uint256 collected;315 fallback() external payable {316 giveMoney();317 }318 function giveMoney() public payable {319 collected += msg.value;320 }321 function getCollected() public view returns (uint256) {322 return collected;323 }324 function getUnaccounted() public view returns (uint256) {325 return address(this).balance - collected;326 }327328 function withdraw(address payable target) public {329 target.transfer(collected);330 collected = 0;331 }332 }333 `);334 }335336 async deployFlipper(signer: string): Promise<Contract> {337 return await this.helper.ethContract.deployByCode(signer, 'Flipper', `338 // SPDX-License-Identifier: UNLICENSED339 pragma solidity ^0.8.6;340341 contract Flipper {342 bool value = false;343 function flip() public {344 value = !value;345 }346 function getValue() public view returns (bool) {347 return value;348 }349 }350 `);351 }352353 async recordCallFee(user: string, call: () => Promise<any>): Promise<bigint> {354 const before = await this.helper.balance.getEthereum(user);355 await call();356 357 await this.helper.wait.newBlocks(1);358 const after = await this.helper.balance.getEthereum(user);359360 return before - after;361 }362363 normalizeEvents(events: any): NormalizedEvent[] {364 const output = [];365 for (const key of Object.keys(events)) {366 if (key.match(/^[0-9]+$/)) {367 output.push(events[key]);368 } else if (Array.isArray(events[key])) {369 output.push(...events[key]);370 } else {371 output.push(events[key]);372 }373 }374 output.sort((a, b) => a.logIndex - b.logIndex);375 return output.map(({address, event, returnValues}) => {376 const args: { [key: string]: string } = {};377 for (const key of Object.keys(returnValues)) {378 if (!key.match(/^[0-9]+$/)) {379 args[key] = returnValues[key];380 }381 }382 return {383 address,384 event,385 args,386 };387 });388 }389390 async calculateFee(address: ICrossAccountId, code: () => Promise<any>): Promise<bigint> {391 const wrappedCode = async () => {392 await code();393 394 await this.helper.wait.newBlocks(1);395 };396 return await this.helper.arrange.calculcateFee(address, wrappedCode);397 }398}399400class EthAddressGroup extends EthGroupBase {401 extractCollectionId(address: string): number {402 if (!(address.length === 42 || address.length === 40)) throw new Error('address wrong format');403 return parseInt(address.substr(address.length - 8), 16);404 }405406 fromCollectionId(collectionId: number): string {407 if (collectionId >= 0xffffffff || collectionId < 0) throw new Error('collectionId overflow');408 return Web3.utils.toChecksumAddress(`0x17c4e6453cc49aaaaeaca894e6d9683e${collectionId.toString(16).padStart(8, '0')}`);409 }410411 extractTokenId(address: string): {collectionId: number, tokenId: number} {412 if (!address.startsWith('0x'))413 throw 'address not starts with "0x"';414 if (address.length > 42)415 throw 'address length is more than 20 bytes';416 return {417 collectionId: Number('0x' + address.substring(address.length - 16, address.length - 8)),418 tokenId: Number('0x' + address.substring(address.length - 8)),419 };420 }421422 fromTokenId(collectionId: number, tokenId: number): string {423 return this.helper.util.getTokenAddress({collectionId, tokenId});424 }425426 normalizeAddress(address: string): string {427 return '0x' + address.substring(address.length - 40);428 }429}430export class EthPropertyGroup extends EthGroupBase {431 property(key: string, value: string): EthProperty {432 return [433 key,434 '0x'+Buffer.from(value).toString('hex'),435 ];436 }437}438export type EthUniqueHelperConstructor = new (...args: any[]) => EthUniqueHelper;439440export class EthCrossAccountGroup extends EthGroupBase {441 createAccount(): CrossAddress {442 return this.fromAddress(this.helper.eth.createAccount());443 }444445 async createAccountWithBalance(donor: IKeyringPair, amount=100n) {446 return this.fromAddress(await this.helper.eth.createAccountWithBalance(donor, amount));447 }448449 fromAddress(address: TEthereumAccount): CrossAddress {450 return {451 eth: address,452 sub: '0',453 };454 }455456 fromKeyringPair(keyring: IKeyringPair): CrossAddress {457 return {458 eth: '0x0000000000000000000000000000000000000000',459 sub: keyring.addressRaw,460 };461 }462}463464export class FeeGas {465 fee: number | bigint = 0n;466467 gas: number | bigint = 0n;468469 public static async build(helper: EthUniqueHelper, fee: bigint): Promise<FeeGas> {470 const instance = new FeeGas();471 instance.fee = instance.convertToTokens(fee);472 instance.gas = await instance.convertToGas(fee, helper);473 return instance;474 }475476 private async convertToGas(fee: bigint, helper: EthUniqueHelper): Promise<bigint> {477 const gasPrice = BigInt(await helper.getWeb3().eth.getGasPrice());478 return fee / gasPrice;479 }480481 private convertToTokens(value: bigint, nominal = 1_000_000_000_000_000_000n): number {482 return Number((value * 1000n) / nominal) / 1000;483 }484}485486class EthArrangeGroup extends ArrangeGroup {487 helper: EthUniqueHelper;488489 constructor(helper: EthUniqueHelper) {490 super(helper);491 this.helper = helper;492 }493494 async calculcateFeeGas(payer: ICrossAccountId, promise: () => Promise<any>): Promise<FeeGas> {495 const fee = await this.calculcateFee(payer, promise);496 return await FeeGas.build(this.helper, fee);497 }498}499export class EthUniqueHelper extends DevUniqueHelper {500 web3: Web3 | null = null;501 web3Provider: WebsocketProvider | null = null;502503 eth: EthGroup;504 ethAddress: EthAddressGroup;505 ethCrossAccount: EthCrossAccountGroup;506 ethNativeContract: NativeContractGroup;507 ethContract: ContractGroup;508 ethProperty: EthPropertyGroup;509 arrange: EthArrangeGroup;510 constructor(logger: { log: (msg: any, level: any) => void, level: any }, options: {[key: string]: any} = {}) {511 options.helperBase = options.helperBase ?? EthUniqueHelper;512513 super(logger, options);514 this.eth = new EthGroup(this);515 this.ethAddress = new EthAddressGroup(this);516 this.ethCrossAccount = new EthCrossAccountGroup(this);517 this.ethNativeContract = new NativeContractGroup(this);518 this.ethContract = new ContractGroup(this);519 this.ethProperty = new EthPropertyGroup(this);520 this.arrange = new EthArrangeGroup(this);521 super.arrange = this.arrange;522 }523524 getWeb3(): Web3 {525 if(this.web3 === null) throw Error('Web3 not connected');526 return this.web3;527 }528529 connectWeb3(wsEndpoint: string) {530 if(this.web3 !== null) return;531 this.web3Provider = new Web3.providers.WebsocketProvider(wsEndpoint);532 this.web3 = new Web3(this.web3Provider);533 }534535 async disconnect() {536 if(this.web3 === null) return;537 this.web3Provider?.connection.close();538539 await super.disconnect();540 }541542 clearApi() {543 super.clearApi();544 this.web3 = null;545 }546547 clone(helperCls: EthUniqueHelperConstructor, options?: { [key: string]: any; }): EthUniqueHelper {548 const newHelper = super.clone(helperCls, options) as EthUniqueHelper;549 newHelper.web3 = this.web3;550 newHelper.web3Provider = this.web3Provider;551552 return newHelper;553 }554}