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

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, TEthCrossAccount, 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;3839  constructor(helper: EthUniqueHelper) {40    this.helper = helper;41  }42}434445class ContractGroup extends EthGroupBase {46  async findImports(imports?: ContractImports[]){47    if(!imports) return function(path: string) {48      return {error: `File not found: ${path}`};49    };5051    const knownImports = {} as {[key: string]: string};52    for(const imp of imports) {53      knownImports[imp.solPath] = (await readFile(imp.fsPath)).toString();54    }5556    return function(path: string) {57      if(path in knownImports) return {contents: knownImports[path]};58      return {error: `File not found: ${path}`};59    };60  }6162  async compile(name: string, src: string, imports?: ContractImports[]): Promise<CompiledContract> {63    const out = JSON.parse(solc.compile(JSON.stringify({64      language: 'Solidity',65      sources: {66        [`${name}.sol`]: {67          content: src,68        },69      },70      settings: {71        outputSelection: {72          '*': {73            '*': ['*'],74          },75        },76      },77    }), {import: await this.findImports(imports)})).contracts[`${name}.sol`][name];7879    return {80      abi: out.abi,81      object: '0x' + out.evm.bytecode.object,82    };83  }8485  async deployByCode(signer: string, name: string, src: string, imports?: ContractImports[], gas?: number): Promise<Contract> {86    const compiledContract = await this.compile(name, src, imports);87    return this.deployByAbi(signer, compiledContract.abi, compiledContract.object, gas);88  }8990  async deployByAbi(signer: string, abi: any, object: string, gas?: number): Promise<Contract> {91    const web3 = this.helper.getWeb3();92    const contract = new web3.eth.Contract(abi, undefined, {93      data: object,94      from: signer,95      gas: gas ?? this.helper.eth.DEFAULT_GAS,96    });97    return await contract.deploy({data: object}).send({from: signer});98  }99100}101102class NativeContractGroup extends EthGroupBase {103104  contractHelpers(caller: string): Contract {105    const web3 = this.helper.getWeb3();106    return new web3.eth.Contract(contractHelpersAbi as any, this.helper.getApi().consts.evmContractHelpers.contractAddress.toString(), {from: caller, gas: this.helper.eth.DEFAULT_GAS});107  }108109  collectionHelpers(caller: string) {110    const web3 = this.helper.getWeb3();111    return new web3.eth.Contract(collectionHelpersAbi as any, this.helper.getApi().consts.common.contractAddress.toString(), {from: caller, gas: this.helper.eth.DEFAULT_GAS});112  }113114  collection(address: string, mode: TCollectionMode, caller?: string, mergeDeprecated = false): Contract {115    let abi = {116      'nft': nonFungibleAbi,117      'rft': refungibleAbi,118      'ft': fungibleAbi,119    }[mode];120    if (mergeDeprecated) {121      const deprecated = {122        'nft': nonFungibleDeprecatedAbi,123        'rft': refungibleDeprecatedAbi,124        'ft': fungibleDeprecatedAbi,125      }[mode];126      abi = [...abi,...deprecated];127    }128    const web3 = this.helper.getWeb3();129    return new web3.eth.Contract(abi as any, address, {gas: this.helper.eth.DEFAULT_GAS, ...(caller ? {from: caller} : {})});130  }131132  collectionById(collectionId: number, mode: 'nft' | 'rft' | 'ft', caller?: string, mergeDeprecated = false): Contract {133    return this.collection(this.helper.ethAddress.fromCollectionId(collectionId), mode, caller, mergeDeprecated);134  }135136  rftToken(address: string, caller?: string): Contract {137    const web3 = this.helper.getWeb3();138    return new web3.eth.Contract(refungibleTokenAbi as any, address, {gas: this.helper.eth.DEFAULT_GAS, ...(caller ? {from: caller} : {})});139  }140141  rftTokenById(collectionId: number, tokenId: number, caller?: string): Contract {142    return this.rftToken(this.helper.ethAddress.fromTokenId(collectionId, tokenId), caller);143  }144}145146147class EthGroup extends EthGroupBase {148  DEFAULT_GAS = 2_500_000;149150  createAccount() {151    const web3 = this.helper.getWeb3();152    const account = web3.eth.accounts.create();153    web3.eth.accounts.wallet.add(account.privateKey);154    return account.address;155  }156157  async createAccountWithBalance(donor: IKeyringPair, amount=100n) {158    const account = this.createAccount();159    await this.transferBalanceFromSubstrate(donor, account, amount);160161    return account;162  }163164  async transferBalanceFromSubstrate(donor: IKeyringPair, recepient: string, amount=100n, inTokens=true) {165    return await this.helper.balance.transferToSubstrate(donor, evmToAddress(recepient), amount * (inTokens ? this.helper.balance.getOneTokenNominal() : 1n));166  }167168  async getCollectionCreationFee(signer: string) {169    const collectionHelper = this.helper.ethNativeContract.collectionHelpers(signer);170    return await collectionHelper.methods.collectionCreationFee().call();171  }172173  async sendEVM(signer: IKeyringPair, contractAddress: string, abi: string, value: string, gasLimit?: number) {174    if(!gasLimit) gasLimit = this.DEFAULT_GAS;175    const web3 = this.helper.getWeb3();176    const gasPrice = await web3.eth.getGasPrice();177    // TODO: check execution status178    await this.helper.executeExtrinsic(179      signer,180      'api.tx.evm.call', [this.helper.address.substrateToEth(signer.address), contractAddress, abi, value, gasLimit, gasPrice, null, null, []],181      true,182    );183  }184185  async callEVM(signer: TEthereumAccount, contractAddress: string, abi: string) {186    return await this.helper.callRpc('api.rpc.eth.call', [{from: signer, to: contractAddress, data: abi}]);187  }188189  createCollectionMethodName(mode: TCollectionMode) {190    switch (mode) {191        case 'ft':192            return 'createFTCollection';193        case 'nft':194            return 'createNFTCollection';195        case 'rft':196            return 'createRFTCollection';197    }198  }199200  async createCollection(mode: TCollectionMode, signer: string, name: string, description: string, tokenPrefix: string, decimals: number = 18): Promise<{ collectionId: number, collectionAddress: string, events: NormalizedEvent[] }> {201    const collectionCreationPrice = this.helper.balance.getCollectionCreationPrice();202    const collectionHelper = this.helper.ethNativeContract.collectionHelpers(signer);203    const functionName: string = this.createCollectionMethodName(mode);204205    const functionParams = functionName === 'createFTCollection' ? [name, decimals, description, tokenPrefix] : [name, description, tokenPrefix];206    const result = await collectionHelper.methods[functionName](...functionParams).send({value: Number(collectionCreationPrice)});207208    const collectionAddress = this.helper.ethAddress.normalizeAddress(result.events.CollectionCreated.returnValues.collectionId);209    const collectionId = this.helper.ethAddress.extractCollectionId(collectionAddress);210    const events = this.helper.eth.normalizeEvents(result.events);211212    return {collectionId, collectionAddress, events};213  }214215  createNFTCollection(signer: string, name: string, description: string, tokenPrefix: string): Promise<{ collectionId: number, collectionAddress: string, events: NormalizedEvent[] }> {216    return this.createCollection('nft', signer, name, description, tokenPrefix);217  }218219  async createERC721MetadataCompatibleNFTCollection(signer: string, name: string, description: string, tokenPrefix: string, baseUri: string): Promise<{collectionId: number, collectionAddress: string, events: NormalizedEvent[] }> {220    const collectionHelper = this.helper.ethNativeContract.collectionHelpers(signer);221222    const {collectionId, collectionAddress, events} = await this.createCollection('nft', signer, name, description, tokenPrefix);223224    await collectionHelper.methods.makeCollectionERC721MetadataCompatible(collectionAddress, baseUri).send();225226    return {collectionId, collectionAddress, events};227  }228229  createRFTCollection(signer: string, name: string, description: string, tokenPrefix: string): Promise<{collectionId: number, collectionAddress: string, events: NormalizedEvent[]}> {230    return this.createCollection('rft', signer, name, description, tokenPrefix);231  }232233  createFungibleCollection(signer: string, name: string, decimals: number, description: string, tokenPrefix: string): Promise<{ collectionId: number, collectionAddress: string, events: NormalizedEvent[]}> {234    return this.createCollecion('createFTCollection', signer, name, description, tokenPrefix, decimals);235  }236237  async createERC721MetadataCompatibleRFTCollection(signer: string, name: string, description: string, tokenPrefix: string, baseUri: string): Promise<{collectionId: number, collectionAddress: string, events: NormalizedEvent[] }> {238    const collectionHelper = this.helper.ethNativeContract.collectionHelpers(signer);239240    const {collectionId, collectionAddress, events} = await this.createCollection('rft', signer, name, description, tokenPrefix);241242    await collectionHelper.methods.makeCollectionERC721MetadataCompatible(collectionAddress, baseUri).send();243244    return {collectionId, collectionAddress, events};245  }246247  async deployCollectorContract(signer: string): Promise<Contract> {248    return await this.helper.ethContract.deployByCode(signer, 'Collector', `249    // SPDX-License-Identifier: UNLICENSED250    pragma solidity ^0.8.6;251252    contract Collector {253      uint256 collected;254      fallback() external payable {255        giveMoney();256      }257      function giveMoney() public payable {258        collected += msg.value;259      }260      function getCollected() public view returns (uint256) {261        return collected;262      }263      function getUnaccounted() public view returns (uint256) {264        return address(this).balance - collected;265      }266267      function withdraw(address payable target) public {268        target.transfer(collected);269        collected = 0;270      }271    }272  `);273  }274275  async deployFlipper(signer: string): Promise<Contract> {276    return await this.helper.ethContract.deployByCode(signer, 'Flipper', `277    // SPDX-License-Identifier: UNLICENSED278    pragma solidity ^0.8.6;279280    contract Flipper {281      bool value = false;282      function flip() public {283        value = !value;284      }285      function getValue() public view returns (bool) {286        return value;287      }288    }289  `);290  }291292  async recordCallFee(user: string, call: () => Promise<any>): Promise<bigint> {293    const before = await this.helper.balance.getEthereum(user);294    await call();295    // In dev mode, the transaction might not finish processing in time296    await this.helper.wait.newBlocks(1);297    const after = await this.helper.balance.getEthereum(user);298299    return before - after;300  }301302  normalizeEvents(events: any): NormalizedEvent[] {303    const output = [];304    for (const key of Object.keys(events)) {305      if (key.match(/^[0-9]+$/)) {306        output.push(events[key]);307      } else if (Array.isArray(events[key])) {308        output.push(...events[key]);309      } else {310        output.push(events[key]);311      }312    }313    output.sort((a, b) => a.logIndex - b.logIndex);314    return output.map(({address, event, returnValues}) => {315      const args: { [key: string]: string } = {};316      for (const key of Object.keys(returnValues)) {317        if (!key.match(/^[0-9]+$/)) {318          args[key] = returnValues[key];319        }320      }321      return {322        address,323        event,324        args,325      };326    });327  }328329  async calculateFee(address: ICrossAccountId, code: () => Promise<any>): Promise<bigint> {330    const wrappedCode = async () => {331      await code();332      // In dev mode, the transaction might not finish processing in time333      await this.helper.wait.newBlocks(1);334    };335    return await this.helper.arrange.calculcateFee(address, wrappedCode);336  }337}338339class EthAddressGroup extends EthGroupBase {340  extractCollectionId(address: string): number {341    if (!(address.length === 42 || address.length === 40)) throw new Error('address wrong format');342    return parseInt(address.substr(address.length - 8), 16);343  }344345  fromCollectionId(collectionId: number): string {346    if (collectionId >= 0xffffffff || collectionId < 0) throw new Error('collectionId overflow');347    return Web3.utils.toChecksumAddress(`0x17c4e6453cc49aaaaeaca894e6d9683e${collectionId.toString(16).padStart(8, '0')}`);348  }349350  extractTokenId(address: string): {collectionId: number, tokenId: number} {351    if (!address.startsWith('0x'))352      throw 'address not starts with "0x"';353    if (address.length > 42)354      throw 'address length is more than 20 bytes';355    return {356      collectionId: Number('0x' + address.substring(address.length - 16, address.length - 8)),357      tokenId: Number('0x' + address.substring(address.length - 8)),358    };359  }360361  fromTokenId(collectionId: number, tokenId: number): string  {362    return this.helper.util.getTokenAddress({collectionId, tokenId});363  }364365  normalizeAddress(address: string): string {366    return '0x' + address.substring(address.length - 40);367  }368}369export class EthPropertyGroup extends EthGroupBase {370  property(key: string, value: string): EthProperty {371    return [372      key,373      '0x'+Buffer.from(value).toString('hex'),374    ];375  }376}377export type EthUniqueHelperConstructor = new (...args: any[]) => EthUniqueHelper;378379export class EthCrossAccountGroup extends EthGroupBase {380  createAccount(): TEthCrossAccount {381    return this.fromAddress(this.helper.eth.createAccount());382  }383384  async createAccountWithBalance(donor: IKeyringPair, amount=100n) {385    return this.fromAddress(await this.helper.eth.createAccountWithBalance(donor, amount));386  }387388  fromAddress(address: TEthereumAccount): TEthCrossAccount {389    return {390      eth: address,391      sub: '0',392    };393  }394395  fromKeyringPair(keyring: IKeyringPair): TEthCrossAccount {396    return {397      eth: '0x0000000000000000000000000000000000000000',398      sub: keyring.addressRaw,399    };400  }401}402403export class EthUniqueHelper extends DevUniqueHelper {404  web3: Web3 | null = null;405  web3Provider: WebsocketProvider | null = null;406407  eth: EthGroup;408  ethAddress: EthAddressGroup;409  ethCrossAccount: EthCrossAccountGroup;410  ethNativeContract: NativeContractGroup;411  ethContract: ContractGroup;412  ethProperty: EthPropertyGroup;413414  constructor(logger: { log: (msg: any, level: any) => void, level: any }, options: {[key: string]: any} = {}) {415    options.helperBase = options.helperBase ?? EthUniqueHelper;416417    super(logger, options);418    this.eth = new EthGroup(this);419    this.ethAddress = new EthAddressGroup(this);420    this.ethCrossAccount = new EthCrossAccountGroup(this);421    this.ethNativeContract = new NativeContractGroup(this);422    this.ethContract = new ContractGroup(this);423    this.ethProperty = new EthPropertyGroup(this);424  }425426  getWeb3(): Web3 {427    if(this.web3 === null) throw Error('Web3 not connected');428    return this.web3;429  }430431  connectWeb3(wsEndpoint: string) {432    if(this.web3 !== null) return;433    this.web3Provider = new Web3.providers.WebsocketProvider(wsEndpoint);434    this.web3 = new Web3(this.web3Provider);435  }436437  async disconnect() {438    if(this.web3 === null) return;439    this.web3Provider?.connection.close();440441    await super.disconnect();442  }443444  clearApi() {445    super.clearApi();446    this.web3 = null;447  }448449  clone(helperCls: EthUniqueHelperConstructor, options?: { [key: string]: any; }): EthUniqueHelper {450    const newHelper = super.clone(helperCls, options) as EthUniqueHelper;451    newHelper.web3 = this.web3;452    newHelper.web3Provider = this.web3Provider;453454    return newHelper;455  }456}