git.delta.rocks / unique-network / refs/commits / 8a76dd7aa345

1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// SPDX-License-Identifier: Apache-2.034/* eslint-disable function-call-argument-newline */5// eslint-disable-next-line @typescript-eslint/triple-slash-reference6/// <reference path="unique.dev.d.ts" />78import {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';2223// Native contracts ABI24import 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 contractHelpersAbi from '../../abi/contractHelpers.json';33import {ICrossAccountId, TEthereumAccount} from '../../../util/playgrounds/types';34import {TCollectionMode} from '../../../util/playgrounds/types';3536class EthGroupBase {37  helper: EthUniqueHelper;38  gasPrice?: string;3940  constructor(helper: EthUniqueHelper) {41    this.helper = helper;42  }43  async getGasPrice() {44    if (this.gasPrice)45      return this.gasPrice;46    this.gasPrice = await this.helper.getWeb3().eth.getGasPrice();47    return this.gasPrice;48  }49}5051function unlimitedMoneyHack<C>(_contract: C): C {52  const contract = _contract as any;53  // Hack: fight against gasPrice override54  for (const method in contract.methods) {55    const _method = contract.methods[method];56    contract.methods[method] = function (...args: any) {57      const encodedCall = _method.call(this, ...args);58      const _call = encodedCall.call;59      encodedCall.call = function (...args: any) {60        if (args.length === 0) {61          return _call.call(this, {gasPrice: '0'});62        }63        // No support for callback/defaultBlock, they may be placed as first argument64        if (typeof args[0] !== 'object')65          throw new Error('only options are supported');66        args[0].gasPrice = '0';67        return _call.call(this, ...args);68      };69      return encodedCall;70    };71  }72  return contract;73}7475class ContractGroup extends EthGroupBase {76  async findImports(imports?: ContractImports[]){77    if(!imports) return function(path: string) {78      return {error: `File not found: ${path}`};79    };8081    const knownImports = {} as {[key: string]: string};82    for(const imp of imports) {83      knownImports[imp.solPath] = (await readFile(imp.fsPath)).toString();84    }8586    return function(path: string) {87      if(path in knownImports) return {contents: knownImports[path]};88      return {error: `File not found: ${path}`};89    };90  }9192  async compile(name: string, src: string, imports?: ContractImports[]): Promise<CompiledContract> {93    const compiled = JSON.parse(solc.compile(JSON.stringify({94      language: 'Solidity',95      sources: {96        [`${name}.sol`]: {97          content: src,98        },99      },100      settings: {101        outputSelection: {102          '*': {103            '*': ['*'],104          },105        },106      },107    }), {import: await this.findImports(imports)}));108109    const hasErrors = compiled['errors']110      && compiled['errors'].length > 0111      && compiled.errors.some(function(err: any) {112        return err.severity == 'error';113      });114115    if (hasErrors) {116      throw compiled.errors;117    }118    const out = compiled.contracts[`${name}.sol`][name];119120    return {121      abi: out.abi,122      object: '0x' + out.evm.bytecode.object,123    };124  }125126  async deployByCode(signer: string, name: string, src: string, imports?: ContractImports[], gas?: number): Promise<Contract> {127    const compiledContract = await this.compile(name, src, imports);128    return this.deployByAbi(signer, compiledContract.abi, compiledContract.object, gas);129  }130131  async deployByAbi(signer: string, abi: any, object: string, gas?: number): Promise<Contract> {132    const web3 = this.helper.getWeb3();133    const contract = new web3.eth.Contract(abi, undefined, {134      data: object,135      from: signer,136      gas: gas ?? this.helper.eth.DEFAULT_GAS,137      gasPrice: await this.getGasPrice(),138    });139    return unlimitedMoneyHack(await contract.deploy({data: object}).send({from: signer}));140  }141142}143144class NativeContractGroup extends EthGroupBase {145146  async contractHelpers(caller: string): Promise<Contract> {147    const web3 = this.helper.getWeb3();148    return unlimitedMoneyHack(new web3.eth.Contract(contractHelpersAbi as any, this.helper.getApi().consts.evmContractHelpers.contractAddress.toString(), {149      from: caller,150      gas: this.helper.eth.DEFAULT_GAS,151      gasPrice: await this.getGasPrice(),152    }));153  }154155  async collectionHelpers(caller: string) {156    const web3 = this.helper.getWeb3();157    return unlimitedMoneyHack(new web3.eth.Contract(collectionHelpersAbi as any, this.helper.getApi().consts.common.contractAddress.toString(), {158      from: caller,159      gas: this.helper.eth.DEFAULT_GAS,160      gasPrice: await this.getGasPrice(),161    }));162  }163164  async collection(address: string, mode: TCollectionMode, caller?: string, mergeDeprecated = false) {165    let abi = {166      'nft': nonFungibleAbi,167      'rft': refungibleAbi,168      'ft': fungibleAbi,169    }[mode];170    if (mergeDeprecated) {171      const deprecated = {172        'nft': nonFungibleDeprecatedAbi,173        'rft': refungibleDeprecatedAbi,174        'ft': fungibleDeprecatedAbi,175      }[mode];176      abi = [...abi,...deprecated];177    }178    const web3 = this.helper.getWeb3();179    return unlimitedMoneyHack(new web3.eth.Contract(abi as any, address, {180      gas: this.helper.eth.DEFAULT_GAS,181      gasPrice: await this.getGasPrice(),182      ...(caller ? {from: caller} : {}),183    }));184  }185186  collectionById(collectionId: number, mode: 'nft' | 'rft' | 'ft', caller?: string, mergeDeprecated = false) {187    return this.collection(this.helper.ethAddress.fromCollectionId(collectionId), mode, caller, mergeDeprecated);188  }189190  async rftToken(address: string, caller?: string) {191    const web3 = this.helper.getWeb3();192    return unlimitedMoneyHack(new web3.eth.Contract(refungibleTokenAbi as any, address, {193      gas: this.helper.eth.DEFAULT_GAS,194      gasPrice: await this.getGasPrice(),195      ...(caller ? {from: caller} : {}),196    }));197  }198199  rftTokenById(collectionId: number, tokenId: number, caller?: string) {200    return this.rftToken(this.helper.ethAddress.fromTokenId(collectionId, tokenId), caller);201  }202}203204205class EthGroup extends EthGroupBase {206  DEFAULT_GAS = 2_500_000;207208  createAccount() {209    const web3 = this.helper.getWeb3();210    const account = web3.eth.accounts.create();211    web3.eth.accounts.wallet.add(account.privateKey);212    return account.address;213  }214215  async createAccountWithBalance(donor: IKeyringPair, amount=100n) {216    const account = this.createAccount();217    await this.transferBalanceFromSubstrate(donor, account, amount);218219    return account;220  }221222  async transferBalanceFromSubstrate(donor: IKeyringPair, recepient: string, amount=100n, inTokens=true) {223    return await this.helper.balance.transferToSubstrate(donor, evmToAddress(recepient), amount * (inTokens ? this.helper.balance.getOneTokenNominal() : 1n));224  }225226  async getCollectionCreationFee(signer: string) {227    const collectionHelper = await this.helper.ethNativeContract.collectionHelpers(signer);228    return await collectionHelper.methods.collectionCreationFee().call();229  }230231  async sendEVM(signer: IKeyringPair, contractAddress: string, abi: string, value: string, gasLimit?: number) {232    if(!gasLimit) gasLimit = this.DEFAULT_GAS;233    const web3 = this.helper.getWeb3();234    const gasPrice = await web3.eth.getGasPrice();235    // TODO: check execution status236    await this.helper.executeExtrinsic(237      signer,238      'api.tx.evm.call', [this.helper.address.substrateToEth(signer.address), contractAddress, abi, value, gasLimit, gasPrice, null, null, []],239      true,240    );241  }242243  async callEVM(signer: TEthereumAccount, contractAddress: string, abi: string) {244    return await this.helper.callRpc('api.rpc.eth.call', [{from: signer, to: contractAddress, data: abi}]);245  }246247  createCollectionMethodName(mode: TCollectionMode) {248    switch (mode) {249      case 'ft':250        return 'createFTCollection';251      case 'nft':252        return 'createNFTCollection';253      case 'rft':254        return 'createRFTCollection';255    }256  }257258  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 }> {259    const collectionCreationPrice = this.helper.balance.getCollectionCreationPrice();260    const collectionHelper = await this.helper.ethNativeContract.collectionHelpers(signer);261    const functionName: string = this.createCollectionMethodName(mode);262263    const functionParams = mode === 'ft' ? [name, decimals, description, tokenPrefix] : [name, description, tokenPrefix];264    const result = await collectionHelper.methods[functionName](...functionParams).send({value: Number(collectionCreationPrice)});265266    const collectionAddress = this.helper.ethAddress.normalizeAddress(result.events.CollectionCreated.returnValues.collectionId);267    const collectionId = this.helper.ethAddress.extractCollectionId(collectionAddress);268    const events = this.helper.eth.normalizeEvents(result.events);269    const collection = await this.helper.ethNativeContract.collectionById(collectionId, mode, signer, mergeDeprecated);270271    return {collectionId, collectionAddress, events, collection};272  }273274  createNFTCollection(signer: string, name: string, description: string, tokenPrefix: string): Promise<{ collectionId: number, collectionAddress: string, events: NormalizedEvent[] }> {275    return this.createCollection('nft', signer, name, description, tokenPrefix);276  }277278  async createERC721MetadataCompatibleNFTCollection(signer: string, name: string, description: string, tokenPrefix: string, baseUri: string): Promise<{collectionId: number, collectionAddress: string, events: NormalizedEvent[] }> {279    const collectionHelper = await this.helper.ethNativeContract.collectionHelpers(signer);280281    const {collectionId, collectionAddress, events} = await this.createCollection('nft', signer, name, description, tokenPrefix);282283    await collectionHelper.methods.makeCollectionERC721MetadataCompatible(collectionAddress, baseUri).send();284285    return {collectionId, collectionAddress, events};286  }287288  createRFTCollection(signer: string, name: string, description: string, tokenPrefix: string): Promise<{collectionId: number, collectionAddress: string, events: NormalizedEvent[]}> {289    return this.createCollection('rft', signer, name, description, tokenPrefix);290  }291292  createFungibleCollection(signer: string, name: string, decimals: number, description: string, tokenPrefix: string): Promise<{ collectionId: number, collectionAddress: string, events: NormalizedEvent[]}> {293    return this.createCollection('ft', signer, name, description, tokenPrefix, decimals);294  }295296  async createERC721MetadataCompatibleRFTCollection(signer: string, name: string, description: string, tokenPrefix: string, baseUri: string): Promise<{collectionId: number, collectionAddress: string, events: NormalizedEvent[] }> {297    const collectionHelper = await this.helper.ethNativeContract.collectionHelpers(signer);298299    const {collectionId, collectionAddress, events} = await this.createCollection('rft', signer, name, description, tokenPrefix);300301    await collectionHelper.methods.makeCollectionERC721MetadataCompatible(collectionAddress, baseUri).send();302303    return {collectionId, collectionAddress, events};304  }305306  async deployCollectorContract(signer: string): Promise<Contract> {307    return await this.helper.ethContract.deployByCode(signer, 'Collector', `308    // SPDX-License-Identifier: UNLICENSED309    pragma solidity ^0.8.6;310311    contract Collector {312      uint256 collected;313      fallback() external payable {314        giveMoney();315      }316      function giveMoney() public payable {317        collected += msg.value;318      }319      function getCollected() public view returns (uint256) {320        return collected;321      }322      function getUnaccounted() public view returns (uint256) {323        return address(this).balance - collected;324      }325326      function withdraw(address payable target) public {327        target.transfer(collected);328        collected = 0;329      }330    }331  `);332  }333334  async deployFlipper(signer: string): Promise<Contract> {335    return await this.helper.ethContract.deployByCode(signer, 'Flipper', `336    // SPDX-License-Identifier: UNLICENSED337    pragma solidity ^0.8.6;338339    contract Flipper {340      bool value = false;341      function flip() public {342        value = !value;343      }344      function getValue() public view returns (bool) {345        return value;346      }347    }348  `);349  }350351  async recordCallFee(user: string, call: () => Promise<any>): Promise<bigint> {352    const before = await this.helper.balance.getEthereum(user);353    await call();354    // In dev mode, the transaction might not finish processing in time355    await this.helper.wait.newBlocks(1);356    const after = await this.helper.balance.getEthereum(user);357358    return before - after;359  }360361  normalizeEvents(events: any): NormalizedEvent[] {362    const output = [];363    for (const key of Object.keys(events)) {364      if (key.match(/^[0-9]+$/)) {365        output.push(events[key]);366      } else if (Array.isArray(events[key])) {367        output.push(...events[key]);368      } else {369        output.push(events[key]);370      }371    }372    output.sort((a, b) => a.logIndex - b.logIndex);373    return output.map(({address, event, returnValues}) => {374      const args: { [key: string]: string } = {};375      for (const key of Object.keys(returnValues)) {376        if (!key.match(/^[0-9]+$/)) {377          args[key] = returnValues[key];378        }379      }380      return {381        address,382        event,383        args,384      };385    });386  }387388  async calculateFee(address: ICrossAccountId, code: () => Promise<any>): Promise<bigint> {389    const wrappedCode = async () => {390      await code();391      // In dev mode, the transaction might not finish processing in time392      await this.helper.wait.newBlocks(1);393    };394    return await this.helper.arrange.calculcateFee(address, wrappedCode);395  }396}397398class EthAddressGroup extends EthGroupBase {399  extractCollectionId(address: string): number {400    if (!(address.length === 42 || address.length === 40)) throw new Error('address wrong format');401    return parseInt(address.substr(address.length - 8), 16);402  }403404  fromCollectionId(collectionId: number): string {405    if (collectionId >= 0xffffffff || collectionId < 0) throw new Error('collectionId overflow');406    return Web3.utils.toChecksumAddress(`0x17c4e6453cc49aaaaeaca894e6d9683e${collectionId.toString(16).padStart(8, '0')}`);407  }408409  extractTokenId(address: string): {collectionId: number, tokenId: number} {410    if (!address.startsWith('0x'))411      throw 'address not starts with "0x"';412    if (address.length > 42)413      throw 'address length is more than 20 bytes';414    return {415      collectionId: Number('0x' + address.substring(address.length - 16, address.length - 8)),416      tokenId: Number('0x' + address.substring(address.length - 8)),417    };418  }419420  fromTokenId(collectionId: number, tokenId: number): string  {421    return this.helper.util.getTokenAddress({collectionId, tokenId});422  }423424  normalizeAddress(address: string): string {425    return '0x' + address.substring(address.length - 40);426  }427}428export class EthPropertyGroup extends EthGroupBase {429  property(key: string, value: string): EthProperty {430    return [431      key,432      '0x'+Buffer.from(value).toString('hex'),433    ];434  }435}436export type EthUniqueHelperConstructor = new (...args: any[]) => EthUniqueHelper;437438export class EthCrossAccountGroup extends EthGroupBase {439  createAccount(): CrossAddress {440    return this.fromAddress(this.helper.eth.createAccount());441  }442443  async createAccountWithBalance(donor: IKeyringPair, amount=100n) {444    return this.fromAddress(await this.helper.eth.createAccountWithBalance(donor, amount));445  }446447  fromAddress(address: TEthereumAccount): CrossAddress {448    return {449      eth: address,450      sub: '0',451    };452  }453454  fromKeyringPair(keyring: IKeyringPair): CrossAddress {455    return {456      eth: '0x0000000000000000000000000000000000000000',457      sub: keyring.addressRaw,458    };459  }460}461462export class EthUniqueHelper extends DevUniqueHelper {463  web3: Web3 | null = null;464  web3Provider: WebsocketProvider | null = null;465466  eth: EthGroup;467  ethAddress: EthAddressGroup;468  ethCrossAccount: EthCrossAccountGroup;469  ethNativeContract: NativeContractGroup;470  ethContract: ContractGroup;471  ethProperty: EthPropertyGroup;472473  constructor(logger: { log: (msg: any, level: any) => void, level: any }, options: {[key: string]: any} = {}) {474    options.helperBase = options.helperBase ?? EthUniqueHelper;475476    super(logger, options);477    this.eth = new EthGroup(this);478    this.ethAddress = new EthAddressGroup(this);479    this.ethCrossAccount = new EthCrossAccountGroup(this);480    this.ethNativeContract = new NativeContractGroup(this);481    this.ethContract = new ContractGroup(this);482    this.ethProperty = new EthPropertyGroup(this);483  }484485  getWeb3(): Web3 {486    if(this.web3 === null) throw Error('Web3 not connected');487    return this.web3;488  }489490  connectWeb3(wsEndpoint: string) {491    if(this.web3 !== null) return;492    this.web3Provider = new Web3.providers.WebsocketProvider(wsEndpoint);493    this.web3 = new Web3(this.web3Provider);494  }495496  async disconnect() {497    if(this.web3 === null) return;498    this.web3Provider?.connection.close();499500    await super.disconnect();501  }502503  clearApi() {504    super.clearApi();505    this.web3 = null;506  }507508  clone(helperCls: EthUniqueHelperConstructor, options?: { [key: string]: any; }): EthUniqueHelper {509    const newHelper = super.clone(helperCls, options) as EthUniqueHelper;510    newHelper.web3 = this.web3;511    newHelper.web3Provider = this.web3Provider;512513    return newHelper;514  }515}