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, 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): Promise<{ collectionId: number, collectionAddress: string, events: NormalizedEvent[] }> {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);271272 return {collectionId, collectionAddress, events};273 }274275 createNFTCollection(signer: string, name: string, description: string, tokenPrefix: string): Promise<{ collectionId: number, collectionAddress: string, events: NormalizedEvent[] }> {276 return this.createCollection('nft', signer, name, description, tokenPrefix);277 }278279 async createERC721MetadataCompatibleNFTCollection(signer: string, name: string, description: string, tokenPrefix: string, baseUri: string): Promise<{collectionId: number, collectionAddress: string, events: NormalizedEvent[] }> {280 const collectionHelper = await this.helper.ethNativeContract.collectionHelpers(signer);281282 const {collectionId, collectionAddress, events} = await this.createCollection('nft', signer, name, description, tokenPrefix);283284 await collectionHelper.methods.makeCollectionERC721MetadataCompatible(collectionAddress, baseUri).send();285286 return {collectionId, collectionAddress, events};287 }288289 createRFTCollection(signer: string, name: string, description: string, tokenPrefix: string): Promise<{collectionId: number, collectionAddress: string, events: NormalizedEvent[]}> {290 return this.createCollection('rft', signer, name, description, tokenPrefix);291 }292293 createFungibleCollection(signer: string, name: string, decimals: number, description: string, tokenPrefix: string): Promise<{ collectionId: number, collectionAddress: string, events: NormalizedEvent[]}> {294 return this.createCollection('ft', signer, name, description, tokenPrefix, decimals);295 }296297 async createERC721MetadataCompatibleRFTCollection(signer: string, name: string, description: string, tokenPrefix: string, baseUri: string): Promise<{collectionId: number, collectionAddress: string, events: NormalizedEvent[] }> {298 const collectionHelper = await this.helper.ethNativeContract.collectionHelpers(signer);299300 const {collectionId, collectionAddress, events} = await this.createCollection('rft', signer, name, description, tokenPrefix);301302 await collectionHelper.methods.makeCollectionERC721MetadataCompatible(collectionAddress, baseUri).send();303304 return {collectionId, collectionAddress, events};305 }306307 async deployCollectorContract(signer: string): Promise<Contract> {308 return await this.helper.ethContract.deployByCode(signer, 'Collector', `309 // SPDX-License-Identifier: UNLICENSED310 pragma solidity ^0.8.6;311312 contract Collector {313 uint256 collected;314 fallback() external payable {315 giveMoney();316 }317 function giveMoney() public payable {318 collected += msg.value;319 }320 function getCollected() public view returns (uint256) {321 return collected;322 }323 function getUnaccounted() public view returns (uint256) {324 return address(this).balance - collected;325 }326327 function withdraw(address payable target) public {328 target.transfer(collected);329 collected = 0;330 }331 }332 `);333 }334335 async deployFlipper(signer: string): Promise<Contract> {336 return await this.helper.ethContract.deployByCode(signer, 'Flipper', `337 // SPDX-License-Identifier: UNLICENSED338 pragma solidity ^0.8.6;339340 contract Flipper {341 bool value = false;342 function flip() public {343 value = !value;344 }345 function getValue() public view returns (bool) {346 return value;347 }348 }349 `);350 }351352 async recordCallFee(user: string, call: () => Promise<any>): Promise<bigint> {353 const before = await this.helper.balance.getEthereum(user);354 await call();355 356 await this.helper.wait.newBlocks(1);357 const after = await this.helper.balance.getEthereum(user);358359 return before - after;360 }361362 normalizeEvents(events: any): NormalizedEvent[] {363 const output = [];364 for (const key of Object.keys(events)) {365 if (key.match(/^[0-9]+$/)) {366 output.push(events[key]);367 } else if (Array.isArray(events[key])) {368 output.push(...events[key]);369 } else {370 output.push(events[key]);371 }372 }373 output.sort((a, b) => a.logIndex - b.logIndex);374 return output.map(({address, event, returnValues}) => {375 const args: { [key: string]: string } = {};376 for (const key of Object.keys(returnValues)) {377 if (!key.match(/^[0-9]+$/)) {378 args[key] = returnValues[key];379 }380 }381 return {382 address,383 event,384 args,385 };386 });387 }388389 async calculateFee(address: ICrossAccountId, code: () => Promise<any>): Promise<bigint> {390 const wrappedCode = async () => {391 await code();392 393 await this.helper.wait.newBlocks(1);394 };395 return await this.helper.arrange.calculcateFee(address, wrappedCode);396 }397}398399class EthAddressGroup extends EthGroupBase {400 extractCollectionId(address: string): number {401 if (!(address.length === 42 || address.length === 40)) throw new Error('address wrong format');402 return parseInt(address.substr(address.length - 8), 16);403 }404405 fromCollectionId(collectionId: number): string {406 if (collectionId >= 0xffffffff || collectionId < 0) throw new Error('collectionId overflow');407 return Web3.utils.toChecksumAddress(`0x17c4e6453cc49aaaaeaca894e6d9683e${collectionId.toString(16).padStart(8, '0')}`);408 }409410 extractTokenId(address: string): {collectionId: number, tokenId: number} {411 if (!address.startsWith('0x'))412 throw 'address not starts with "0x"';413 if (address.length > 42)414 throw 'address length is more than 20 bytes';415 return {416 collectionId: Number('0x' + address.substring(address.length - 16, address.length - 8)),417 tokenId: Number('0x' + address.substring(address.length - 8)),418 };419 }420421 fromTokenId(collectionId: number, tokenId: number): string {422 return this.helper.util.getTokenAddress({collectionId, tokenId});423 }424425 normalizeAddress(address: string): string {426 return '0x' + address.substring(address.length - 40);427 }428}429export class EthPropertyGroup extends EthGroupBase {430 property(key: string, value: string): EthProperty {431 return [432 key,433 '0x'+Buffer.from(value).toString('hex'),434 ];435 }436}437export type EthUniqueHelperConstructor = new (...args: any[]) => EthUniqueHelper;438439export class EthCrossAccountGroup extends EthGroupBase {440 createAccount(): CrossAddress {441 return this.fromAddress(this.helper.eth.createAccount());442 }443444 async createAccountWithBalance(donor: IKeyringPair, amount=100n) {445 return this.fromAddress(await this.helper.eth.createAccountWithBalance(donor, amount));446 }447448 fromAddress(address: TEthereumAccount): CrossAddress {449 return {450 eth: address,451 sub: '0',452 };453 }454455 fromKeyringPair(keyring: IKeyringPair): CrossAddress {456 return {457 eth: '0x0000000000000000000000000000000000000000',458 sub: keyring.addressRaw,459 };460 }461}462463export class EthUniqueHelper extends DevUniqueHelper {464 web3: Web3 | null = null;465 web3Provider: WebsocketProvider | null = null;466467 eth: EthGroup;468 ethAddress: EthAddressGroup;469 ethCrossAccount: EthCrossAccountGroup;470 ethNativeContract: NativeContractGroup;471 ethContract: ContractGroup;472 ethProperty: EthPropertyGroup;473474 constructor(logger: { log: (msg: any, level: any) => void, level: any }, options: {[key: string]: any} = {}) {475 options.helperBase = options.helperBase ?? EthUniqueHelper;476477 super(logger, options);478 this.eth = new EthGroup(this);479 this.ethAddress = new EthAddressGroup(this);480 this.ethCrossAccount = new EthCrossAccountGroup(this);481 this.ethNativeContract = new NativeContractGroup(this);482 this.ethContract = new ContractGroup(this);483 this.ethProperty = new EthPropertyGroup(this);484 }485486 getWeb3(): Web3 {487 if(this.web3 === null) throw Error('Web3 not connected');488 return this.web3;489 }490491 connectWeb3(wsEndpoint: string) {492 if(this.web3 !== null) return;493 this.web3Provider = new Web3.providers.WebsocketProvider(wsEndpoint);494 this.web3 = new Web3(this.web3Provider);495 }496497 async disconnect() {498 if(this.web3 === null) return;499 this.web3Provider?.connection.close();500501 await super.disconnect();502 }503504 clearApi() {505 super.clearApi();506 this.web3 = null;507 }508509 clone(helperCls: EthUniqueHelperConstructor, options?: { [key: string]: any; }): EthUniqueHelper {510 const newHelper = super.clone(helperCls, options) as EthUniqueHelper;511 newHelper.web3 = this.web3;512 newHelper.web3Provider = this.web3Provider;513514 return newHelper;515 }516}