git.delta.rocks / unique-network / refs/commits / d83685be86d3

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 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, CollectionMode, CreateCollectionData} from './types';2223// Native contracts ABI24import 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}5253class 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, args?: any[]): Promise<Contract> {105    const compiledContract = await this.compile(name, src, imports);106    return this.deployByAbi(signer, compiledContract.abi, compiledContract.object, gas, args);107  }108109  async deployByAbi(signer: string, abi: any, object: string, gas?: number, args?: any[]): 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    });116    return await contract.deploy({data: object, arguments: args}).send({from: signer});117  }118119}120121class NativeContractGroup extends EthGroupBase {122123  contractHelpers(caller: string) {124    const web3 = this.helper.getWeb3();125    return new web3.eth.Contract(contractHelpersAbi as any, this.helper.getApi().consts.evmContractHelpers.contractAddress.toString(), {126      from: caller,127      gas: this.helper.eth.DEFAULT_GAS,128    });129  }130131  collectionHelpers(caller: string) {132    const web3 = this.helper.getWeb3();133    return new web3.eth.Contract(collectionHelpersAbi as any, this.helper.getApi().consts.common.contractAddress.toString(), {134      from: caller,135      gas: this.helper.eth.DEFAULT_GAS,136    });137  }138139  collection(address: string, mode: TCollectionMode, caller?: string, mergeDeprecated = false) {140    let abi;141    if(address === this.helper.ethAddress.fromCollectionId(0)) {142      abi = nativeFungibleAbi;143    } else {144      abi ={145        'nft': nonFungibleAbi,146        'rft': refungibleAbi,147        'ft': fungibleAbi,148      }[mode];149    }150    if(mergeDeprecated) {151      const deprecated = {152        'nft': nonFungibleDeprecatedAbi,153        'rft': refungibleDeprecatedAbi,154        'ft': fungibleDeprecatedAbi,155      }[mode];156      abi = [...abi, ...deprecated];157    }158    const web3 = this.helper.getWeb3();159    return new web3.eth.Contract(abi as any, address, {160      gas: this.helper.eth.DEFAULT_GAS,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  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      ...(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}182183class CreateCollectionTransaction {184  signer: string;185  data: CreateCollectionData;186  mergeDeprecated: boolean;187  helper: EthUniqueHelper;188189  constructor(helper: EthUniqueHelper, signer: string, data: CreateCollectionData, mergeDeprecated = false) {190    this.helper = helper;191    this.signer = signer;192193    let flags = 0;194    // convert CollectionFlags to number and join them in one number195    if(!data.flags || typeof data.flags == 'number') {196      flags = data.flags ?? 0;197    } else {198      for(let i = 0; i < data.flags.length; i++){199        const flag = data.flags[i];200        flags = flags | flag;201      }202    }203    data.flags = flags;204205    this.data = data;206    this.mergeDeprecated = mergeDeprecated;207  }208209  // eslint-disable-next-line require-await210  private async createTransaction() {211    const collectionHelper = this.helper.ethNativeContract.collectionHelpers(this.signer);212    let collectionMode;213    switch (this.data.collectionMode) {214      case 'nft': collectionMode = CollectionMode.Nonfungible; break;215      case 'rft': collectionMode = CollectionMode.Refungible; break;216      case 'ft': collectionMode = CollectionMode.Fungible; break;217    }218219    const tx = collectionHelper.methods.createCollection([220      this.data.name,221      this.data.description,222      this.data.tokenPrefix,223      collectionMode,224      this.data.decimals,225      this.data.properties,226      this.data.tokenPropertyPermissions,227      this.data.adminList,228      this.data.nestingSettings,229      this.data.limits,230      this.data.pendingSponsor,231      this.data.flags,232    ]);233    return tx;234  }235236  async send(options?: any): Promise<{ collectionId: number, collectionAddress: string, events: NormalizedEvent[], collection: Contract }> {237    const collectionCreationPrice = {238      value: Number(this.helper.balance.getCollectionCreationPrice()),239    };240    const tx = await this.createTransaction();241    const result = await tx.send({...options, ...collectionCreationPrice});242243    const collectionAddress = this.helper.ethAddress.normalizeAddress(result.events.CollectionCreated.returnValues.collectionId);244    const collectionId = this.helper.ethAddress.extractCollectionId(collectionAddress);245    const events = this.helper.eth.normalizeEvents(result.events);246    const collection = await this.helper.ethNativeContract.collectionById(collectionId, this.data.collectionMode, this.signer, this.mergeDeprecated);247248    return {collectionId, collectionAddress, events, collection};249  }250251  async call(options?: any) {252    const collectionCreationPrice = {253      value: Number(this.helper.balance.getCollectionCreationPrice()),254    };255    const tx = await this.createTransaction();256257    return await tx.call({...options, ...collectionCreationPrice});258  }259}260261262class EthGroup extends EthGroupBase {263  DEFAULT_GAS = 2_500_000;264265  createAccount() {266    const web3 = this.helper.getWeb3();267    const account = web3.eth.accounts.create();268    web3.eth.accounts.wallet.add(account.privateKey);269    return account.address;270  }271272  async createAccountWithBalance(donor: IKeyringPair, amount = 600n) {273    const account = this.createAccount();274    await this.transferBalanceFromSubstrate(donor, account, amount);275276    return account;277  }278279  async transferBalanceFromSubstrate(donor: IKeyringPair, recepient: string, amount = 100n, inTokens = true) {280    return await this.helper.balance.transferToSubstrate(donor, evmToAddress(recepient), amount * (inTokens ? this.helper.balance.getOneTokenNominal() : 1n));281  }282283  async getCollectionCreationFee(signer: string) {284    const collectionHelper = await this.helper.ethNativeContract.collectionHelpers(signer);285    return await collectionHelper.methods.collectionCreationFee().call();286  }287288  async sendEVM(signer: IKeyringPair, contractAddress: string, abi: string, value: string, gasLimit?: number) {289    if(!gasLimit) gasLimit = this.DEFAULT_GAS;290    const web3 = this.helper.getWeb3();291    // FIXME: can't send legacy transaction using tx.evm.call292    const gasPrice = await web3.eth.getGasPrice();293    // TODO: check execution status294    await this.helper.executeExtrinsic(295      signer,296      'api.tx.evm.call', [this.helper.address.substrateToEth(signer.address), contractAddress, abi, value, gasLimit, gasPrice, null, null, []],297      true,298    );299  }300301  async callEVM(signer: TEthereumAccount, contractAddress: string, abi: string) {302    return await this.helper.callRpc('api.rpc.eth.call', [{from: signer, to: contractAddress, data: abi}]);303  }304305  createCollectionMethodName(mode: TCollectionMode) {306    switch (mode) {307      case 'ft':308        return 'createFTCollection';309      case 'nft':310        return 'createNFTCollection';311      case 'rft':312        return 'createRFTCollection';313    }314  }315316  createCollection(signer: string, data: CreateCollectionData, mergeDeprecated = false): CreateCollectionTransaction {317    return new CreateCollectionTransaction(this.helper, signer, data, mergeDeprecated);318  }319320  createNFTCollection(signer: string, name: string, description: string, tokenPrefix: string): Promise<{ collectionId: number, collectionAddress: string, events: NormalizedEvent[] }> {321    return this.createCollection(signer, new CreateCollectionData(name, description, tokenPrefix, 'nft')).send();322  }323324  async createERC721MetadataCompatibleCollection(signer: string, data: CreateCollectionData, baseUri: string): Promise<{ collectionId: number, collectionAddress: string, events: NormalizedEvent[] }> {325    const collectionHelper = await this.helper.ethNativeContract.collectionHelpers(signer);326327    const {collectionId, collectionAddress, events} = await this.createCollection(signer, data).send();328329    await collectionHelper.methods.makeCollectionERC721MetadataCompatible(collectionAddress, baseUri).send();330331    return {collectionId, collectionAddress, events};332  }333334  async createERC721MetadataCompatibleNFTCollection(signer: string, name: string, description: string, tokenPrefix: string, baseUri: string): Promise<{ collectionId: number, collectionAddress: string, events: NormalizedEvent[] }> {335    const collectionHelper = await this.helper.ethNativeContract.collectionHelpers(signer);336337    const {collectionId, collectionAddress, events} = await this.createCollection(signer, new CreateCollectionData(name, description, tokenPrefix, 'nft')).send();338339    await collectionHelper.methods.makeCollectionERC721MetadataCompatible(collectionAddress, baseUri).send();340341    return {collectionId, collectionAddress, events};342  }343344  createRFTCollection(signer: string, name: string, description: string, tokenPrefix: string): Promise<{ collectionId: number, collectionAddress: string, events: NormalizedEvent[] }> {345    return this.createCollection(signer, new CreateCollectionData(name, description, tokenPrefix, 'rft')).send();346  }347348  createFungibleCollection(signer: string, name: string, decimals: number, description: string, tokenPrefix: string): Promise<{ collectionId: number, collectionAddress: string, events: NormalizedEvent[] }> {349    return this.createCollection(signer, new CreateCollectionData(name, description, tokenPrefix, 'ft')).send();350  }351352  async createERC721MetadataCompatibleRFTCollection(signer: string, name: string, description: string, tokenPrefix: string, baseUri: string): Promise<{ collectionId: number, collectionAddress: string, events: NormalizedEvent[] }> {353    const collectionHelper = await this.helper.ethNativeContract.collectionHelpers(signer);354355    const {collectionId, collectionAddress, events} = await this.createCollection(signer, new CreateCollectionData(name, description, tokenPrefix, 'rft')).send();356357    await collectionHelper.methods.makeCollectionERC721MetadataCompatible(collectionAddress, baseUri).send();358359    return {collectionId, collectionAddress, events};360  }361362  async deployCollectorContract(signer: string): Promise<Contract> {363    return await this.helper.ethContract.deployByCode(signer, 'Collector', `364    // SPDX-License-Identifier: UNLICENSED365    pragma solidity ^0.8.6;366367    contract Collector {368      uint256 collected;369      fallback() external payable {370        giveMoney();371      }372      function giveMoney() public payable {373        collected += msg.value;374      }375      function getCollected() public view returns (uint256) {376        return collected;377      }378      function getUnaccounted() public view returns (uint256) {379        return address(this).balance - collected;380      }381382      function withdraw(address payable target) public {383        target.transfer(collected);384        collected = 0;385      }386    }387  `);388  }389390  async deployFlipper(signer: string): Promise<Contract> {391    return await this.helper.ethContract.deployByCode(signer, 'Flipper', `392    // SPDX-License-Identifier: UNLICENSED393    pragma solidity ^0.8.6;394395    contract Flipper {396      bool value = false;397      function flip() public {398        value = !value;399      }400      function getValue() public view returns (bool) {401        return value;402      }403    }404  `);405  }406407  async recordCallFee(user: string, call: () => Promise<any>): Promise<bigint> {408    const before = await this.helper.balance.getEthereum(user);409    await call();410    // In dev mode, the transaction might not finish processing in time411    await this.helper.wait.newBlocks(1);412    const after = await this.helper.balance.getEthereum(user);413414    return before - after;415  }416417  normalizeEvents(events: any): NormalizedEvent[] {418    const output = [];419    for(const key of Object.keys(events)) {420      if(key.match(/^[0-9]+$/)) {421        output.push(events[key]);422      } else if(Array.isArray(events[key])) {423        output.push(...events[key]);424      } else {425        output.push(events[key]);426      }427    }428    output.sort((a, b) => a.logIndex - b.logIndex);429    return output.map(({address, event, returnValues}) => {430      const args: { [key: string]: string } = {};431      for(const key of Object.keys(returnValues)) {432        if(!key.match(/^[0-9]+$/)) {433          args[key] = returnValues[key];434        }435      }436      return {437        address,438        event,439        args,440      };441    });442  }443444  async calculateFee(address: ICrossAccountId, code: () => Promise<any>): Promise<bigint> {445    const wrappedCode = async () => {446      await code();447      // In dev mode, the transaction might not finish processing in time448      await this.helper.wait.newBlocks(1);449    };450    return await this.helper.arrange.calculcateFee(address, wrappedCode);451  }452}453454class EthAddressGroup extends EthGroupBase {455  extractCollectionId(address: string): number {456    if(!(address.length === 42 || address.length === 40)) throw new Error('address wrong format');457    return parseInt(address.slice(address.length - 8), 16);458  }459460  fromCollectionId(collectionId: number): string {461    if(collectionId >= 0xffffffff || collectionId < 0) throw new Error('collectionId overflow');462    return Web3.utils.toChecksumAddress(`0x17c4e6453cc49aaaaeaca894e6d9683e${collectionId.toString(16).padStart(8, '0')}`);463  }464465  extractTokenId(address: string): { collectionId: number, tokenId: number } {466    if(!address.startsWith('0x'))467      throw 'address not starts with "0x"';468    if(address.length > 42)469      throw 'address length is more than 20 bytes';470    return {471      collectionId: Number('0x' + address.substring(address.length - 16, address.length - 8)),472      tokenId: Number('0x' + address.substring(address.length - 8)),473    };474  }475476  fromTokenId(collectionId: number, tokenId: number): string {477    return this.helper.util.getTokenAddress({collectionId, tokenId});478  }479480  normalizeAddress(address: string): string {481    return '0x' + address.substring(address.length - 40);482  }483}484export class EthPropertyGroup extends EthGroupBase {485  property(key: string, value: string): EthProperty {486    return [487      key,488      '0x' + Buffer.from(value).toString('hex'),489    ];490  }491}492export type EthUniqueHelperConstructor = new (...args: any[]) => EthUniqueHelper;493494export class EthCrossAccountGroup extends EthGroupBase {495  createAccount(): CrossAddress {496    return this.fromAddress(this.helper.eth.createAccount());497  }498499  async createAccountWithBalance(donor: IKeyringPair, amount = 100n) {500    return this.fromAddress(await this.helper.eth.createAccountWithBalance(donor, amount));501  }502503  fromAddress(address: TEthereumAccount): CrossAddress {504    return {505      eth: address,506      sub: '0',507    };508  }509510  fromAddr(address: TEthereumAccount): [string, string] {511    return [512      address,513      '0',514    ];515  }516517  fromKeyringPair(keyring: IKeyringPair): CrossAddress {518    return {519      eth: '0x0000000000000000000000000000000000000000',520      sub: keyring.addressRaw,521    };522  }523}524525export class FeeGas {526  fee: number | bigint = 0n;527528  gas: number | bigint = 0n;529530  public static async build(helper: EthUniqueHelper, fee: bigint): Promise<FeeGas> {531    const instance = new FeeGas();532    instance.fee = instance.convertToTokens(fee);533    instance.gas = await instance.convertToGas(fee, helper);534    return instance;535  }536537  private async convertToGas(fee: bigint, helper: EthUniqueHelper): Promise<bigint> {538    const gasPrice = BigInt(await helper.getWeb3().eth.getGasPrice());539    return fee / gasPrice;540  }541542  private convertToTokens(value: bigint, nominal = 1_000_000_000_000_000_000n): number {543    return Number((value * 1000n) / nominal) / 1000;544  }545}546547class EthArrangeGroup extends ArrangeGroup {548  helper: EthUniqueHelper;549550  constructor(helper: EthUniqueHelper) {551    super(helper);552    this.helper = helper;553  }554555  async calculcateFeeGas(payer: ICrossAccountId, promise: () => Promise<any>): Promise<FeeGas> {556    const fee = await this.calculcateFee(payer, promise);557    return await FeeGas.build(this.helper, fee);558  }559}560export class EthUniqueHelper extends DevUniqueHelper {561  web3: Web3 | null = null;562  web3Provider: WebsocketProvider | null = null;563564  eth: EthGroup;565  ethAddress: EthAddressGroup;566  ethCrossAccount: EthCrossAccountGroup;567  ethNativeContract: NativeContractGroup;568  ethContract: ContractGroup;569  ethProperty: EthPropertyGroup;570  arrange: EthArrangeGroup;571  constructor(logger: { log: (msg: any, level: any) => void, level: any }, options: { [key: string]: any } = {}) {572    options.helperBase = options.helperBase ?? EthUniqueHelper;573574    super(logger, options);575    this.eth = new EthGroup(this);576    this.ethAddress = new EthAddressGroup(this);577    this.ethCrossAccount = new EthCrossAccountGroup(this);578    this.ethNativeContract = new NativeContractGroup(this);579    this.ethContract = new ContractGroup(this);580    this.ethProperty = new EthPropertyGroup(this);581    this.arrange = new EthArrangeGroup(this);582    super.arrange = this.arrange;583  }584585  getWeb3(): Web3 {586    if(this.web3 === null) throw Error('Web3 not connected');587    return this.web3;588  }589590  connectWeb3(wsEndpoint: string) {591    if(this.web3 !== null) return;592    this.web3Provider = new Web3.providers.WebsocketProvider(wsEndpoint);593    this.web3 = new Web3(this.web3Provider);594  }595596  async disconnect() {597    if(this.web3 === null) return;598    this.web3Provider?.connection.close();599600    await super.disconnect();601  }602603  clearApi() {604    super.clearApi();605    this.web3 = null;606  }607608  clone(helperCls: EthUniqueHelperConstructor, options?: { [key: string]: any; }): EthUniqueHelper {609    const newHelper = super.clone(helperCls, options) as EthUniqueHelper;610    newHelper.web3 = this.web3;611    newHelper.web3Provider = this.web3Provider;612613    return newHelper;614  }615}