git.delta.rocks / unique-network / refs/commits / 39148f6db4ae

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, NormalizedEvent} from './types';2223// Native contracts ABI24import collectionHelpersAbi from '../../collectionHelpersAbi.json';25import fungibleAbi from '../../fungibleAbi.json';26import nonFungibleAbi from '../../nonFungibleAbi.json';27import refungibleAbi from '../../reFungibleAbi.json';28import refungibleTokenAbi from '../../reFungibleTokenAbi.json';29import contractHelpersAbi from './../contractHelpersAbi.json';30import {ICrossAccountId, TEthereumAccount} from '../../../util/playgrounds/types';3132class EthGroupBase {33  helper: EthUniqueHelper;3435  constructor(helper: EthUniqueHelper) {36    this.helper = helper;37  }38}394041class ContractGroup extends EthGroupBase {42  async findImports(imports?: ContractImports[]){43    if(!imports) return function(path: string) {44      return {error: `File not found: ${path}`};45    };4647    const knownImports = {} as {[key: string]: string};48    for(const imp of imports) {49      knownImports[imp.solPath] = (await readFile(imp.fsPath)).toString();50    }5152    return function(path: string) {53      if(path in knownImports) return {contents: knownImports[path]};54      return {error: `File not found: ${path}`};55    };56  }5758  async compile(name: string, src: string, imports?: ContractImports[]): Promise<CompiledContract> {59    const out = JSON.parse(solc.compile(JSON.stringify({60      language: 'Solidity',61      sources: {62        [`${name}.sol`]: {63          content: src,64        },65      },66      settings: {67        outputSelection: {68          '*': {69            '*': ['*'],70          },71        },72      },73    }), {import: await this.findImports(imports)})).contracts[`${name}.sol`][name];7475    return {76      abi: out.abi,77      object: '0x' + out.evm.bytecode.object,78    };79  }8081  async deployByCode(signer: string, name: string, src: string, imports?: ContractImports[]): Promise<Contract> {82    const compiledContract = await this.compile(name, src, imports);83    return this.deployByAbi(signer, compiledContract.abi, compiledContract.object);84  }8586  async deployByAbi(signer: string, abi: any, object: string): Promise<Contract> {87    const web3 = this.helper.getWeb3();88    const contract = new web3.eth.Contract(abi, undefined, {89      data: object,90      from: signer,91      gas: this.helper.eth.DEFAULT_GAS,92    });93    return await contract.deploy({data: object}).send({from: signer});94  }9596}9798class NativeContractGroup extends EthGroupBase {99100  contractHelpers(caller: string): Contract {101    const web3 = this.helper.getWeb3();102    return new web3.eth.Contract(contractHelpersAbi as any, '0x842899ECF380553E8a4de75bF534cdf6fBF64049', {from: caller, gas: this.helper.eth.DEFAULT_GAS});103  }104105  collectionHelpers(caller: string) {106    const web3 = this.helper.getWeb3();107    return new web3.eth.Contract(collectionHelpersAbi as any, '0x6c4e9fe1ae37a41e93cee429e8e1881abdcbb54f', {from: caller, gas: this.helper.eth.DEFAULT_GAS});108  }109110  collection(address: string, mode: 'nft' | 'rft' | 'ft', caller?: string): Contract {111    const abi = {112      'nft': nonFungibleAbi,113      'rft': refungibleAbi,114      'ft': fungibleAbi,115    }[mode];116    const web3 = this.helper.getWeb3();117    return new web3.eth.Contract(abi as any, address, {gas: this.helper.eth.DEFAULT_GAS, ...(caller ? {from: caller} : {})});118  }119120  collectionById(collectionId: number, mode: 'nft' | 'rft' | 'ft', caller?: string): Contract {121    return this.collection(this.helper.ethAddress.fromCollectionId(collectionId), mode, caller);122  }123124  rftToken(address: string, caller?: string): Contract {125    const web3 = this.helper.getWeb3();126    return new web3.eth.Contract(refungibleTokenAbi as any, address, {gas: this.helper.eth.DEFAULT_GAS, ...(caller ? {from: caller} : {})});127  }128129  rftTokenById(collectionId: number, tokenId: number, caller?: string): Contract {130    return this.rftToken(this.helper.ethAddress.fromTokenId(collectionId, tokenId), caller);131  }132}133134135class EthGroup extends EthGroupBase {136  DEFAULT_GAS = 2_500_000;137138  createAccount() {139    const web3 = this.helper.getWeb3();140    const account = web3.eth.accounts.create();141    web3.eth.accounts.wallet.add(account.privateKey);142    return account.address;143  }144145  async createAccountWithBalance(donor: IKeyringPair, amount=100n) {146    const account = this.createAccount();147    await this.transferBalanceFromSubstrate(donor, account, amount);148149    return account;150  }151152  async transferBalanceFromSubstrate(donor: IKeyringPair, recepient: string, amount=100n, inTokens=true) {153    return await this.helper.balance.transferToSubstrate(donor, evmToAddress(recepient), amount * (inTokens ? this.helper.balance.getOneTokenNominal() : 1n));154  }155156  async getCollectionCreationFee(signer: string) {157    const collectionHelper = this.helper.ethNativeContract.collectionHelpers(signer);158    return await collectionHelper.methods.collectionCreationFee().call();159  }160161  async sendEVM(signer: IKeyringPair, contractAddress: string, abi: string, value: string, gasLimit?: number) {162    if(!gasLimit) gasLimit = this.DEFAULT_GAS;163    const web3 = this.helper.getWeb3();164    const gasPrice = await web3.eth.getGasPrice();165    // TODO: check execution status166    await this.helper.executeExtrinsic(167      signer,168      'api.tx.evm.call', [this.helper.address.substrateToEth(signer.address), contractAddress, abi, value, gasLimit, gasPrice, null, null, []],169      true,170    );171  }172173  async callEVM(signer: TEthereumAccount, contractAddress: string, abi: string) {174    return await this.helper.callRpc('api.rpc.eth.call', [{from: signer, to: contractAddress, data: abi}]);175  }176177  async createNFTCollection(signer: string, name: string, description: string, tokenPrefix: string): Promise<{collectionId: number, collectionAddress: string}> {178    const collectionCreationPrice = this.helper.balance.getCollectionCreationPrice();179    const collectionHelper = this.helper.ethNativeContract.collectionHelpers(signer);180181    const result = await collectionHelper.methods.createNFTCollection(name, description, tokenPrefix).send({value: Number(collectionCreationPrice)});182183    const collectionAddress = this.helper.ethAddress.normalizeAddress(result.events.CollectionCreated.returnValues.collectionId);184    const collectionId = this.helper.ethAddress.extractCollectionId(collectionAddress);185186    return {collectionId, collectionAddress};187  }188189  async createERC721MetadataCompatibleNFTCollection(signer: string, name: string, description: string, tokenPrefix: string, baseUri: string): Promise<{collectionId: number, collectionAddress: string}> {190    const collectionHelper = this.helper.ethNativeContract.collectionHelpers(signer);191192    const {collectionId, collectionAddress} = await this.createNFTCollection(signer, name, description, tokenPrefix)193194    await collectionHelper.methods.makeCollectionERC721MetadataCompatible(collectionAddress, baseUri).send();195196    return {collectionId, collectionAddress};197  }198199  async createRFTCollection(signer: string, name: string, description: string, tokenPrefix: string): Promise<{collectionId: number, collectionAddress: string}> {200    const collectionCreationPrice = this.helper.balance.getCollectionCreationPrice();201    const collectionHelper = this.helper.ethNativeContract.collectionHelpers(signer);202203    const result = await collectionHelper.methods.createRFTCollection(name, description, tokenPrefix).send({value: Number(collectionCreationPrice)});204205    const collectionAddress = this.helper.ethAddress.normalizeAddress(result.events.CollectionCreated.returnValues.collectionId);206    const collectionId = this.helper.ethAddress.extractCollectionId(collectionAddress);207208    return {collectionId, collectionAddress};209  }210211  async createERC721MetadataCompatibleRFTCollection(signer: string, name: string, description: string, tokenPrefix: string, baseUri: string): Promise<{collectionId: number, collectionAddress: string}> {212    const collectionHelper = this.helper.ethNativeContract.collectionHelpers(signer);213214    const {collectionId, collectionAddress} = await this.createRFTCollection(signer, name, description, tokenPrefix)215216    await collectionHelper.methods.makeCollectionERC721MetadataCompatible(collectionAddress, baseUri).send();217218    return {collectionId, collectionAddress};219  }220221  async deployCollectorContract(signer: string): Promise<Contract> {222    return await this.helper.ethContract.deployByCode(signer, 'Collector', `223    // SPDX-License-Identifier: UNLICENSED224    pragma solidity ^0.8.6;225226    contract Collector {227      uint256 collected;228      fallback() external payable {229        giveMoney();230      }231      function giveMoney() public payable {232        collected += msg.value;233      }234      function getCollected() public view returns (uint256) {235        return collected;236      }237      function getUnaccounted() public view returns (uint256) {238        return address(this).balance - collected;239      }240241      function withdraw(address payable target) public {242        target.transfer(collected);243        collected = 0;244      }245    }246  `);247  }248249  async deployFlipper(signer: string): Promise<Contract> {250    return await this.helper.ethContract.deployByCode(signer, 'Flipper', `251    // SPDX-License-Identifier: UNLICENSED252    pragma solidity ^0.8.6;253254    contract Flipper {255      bool value = false;256      function flip() public {257        value = !value;258      }259      function getValue() public view returns (bool) {260        return value;261      }262    }263  `);264  }265266  async recordCallFee(user: string, call: () => Promise<any>): Promise<bigint> {267    const before = await this.helper.balance.getEthereum(user);268    await call();269    // In dev mode, the transaction might not finish processing in time270    await this.helper.wait.newBlocks(1);271    const after = await this.helper.balance.getEthereum(user);272273    return before - after;274  }275276  normalizeEvents(events: any): NormalizedEvent[] {277    const output = [];278    for (const key of Object.keys(events)) {279      if (key.match(/^[0-9]+$/)) {280        output.push(events[key]);281      } else if (Array.isArray(events[key])) {282        output.push(...events[key]);283      } else {284        output.push(events[key]);285      }286    }287    output.sort((a, b) => a.logIndex - b.logIndex);288    return output.map(({address, event, returnValues}) => {289      const args: { [key: string]: string } = {};290      for (const key of Object.keys(returnValues)) {291        if (!key.match(/^[0-9]+$/)) {292          args[key] = returnValues[key];293        }294      }295      return {296        address,297        event,298        args,299      };300    });301  }302303  async calculateFee(address: ICrossAccountId, code: () => Promise<any>): Promise<bigint> {304    const wrappedCode = async () => {305      await code();306      // In dev mode, the transaction might not finish processing in time307      await this.helper.wait.newBlocks(1);308    };309    return await this.helper.arrange.calculcateFee(address, wrappedCode);310  }311}312313class EthAddressGroup extends EthGroupBase {314  extractCollectionId(address: string): number {315    if (!(address.length === 42 || address.length === 40)) throw new Error('address wrong format');316    return parseInt(address.substr(address.length - 8), 16);317  }318319  fromCollectionId(collectionId: number): string {320    if (collectionId >= 0xffffffff || collectionId < 0) throw new Error('collectionId overflow');321    return Web3.utils.toChecksumAddress(`0x17c4e6453cc49aaaaeaca894e6d9683e${collectionId.toString(16).padStart(8, '0')}`);322  }323324  extractTokenId(address: string): {collectionId: number, tokenId: number} {325    if (!address.startsWith('0x'))326      throw 'address not starts with "0x"';327    if (address.length > 42)328      throw 'address length is more than 20 bytes';329    return {330      collectionId: Number('0x' + address.substring(address.length - 16, address.length - 8)),331      tokenId: Number('0x' + address.substring(address.length - 8)),332    };333  }334335  fromTokenId(collectionId: number, tokenId: number): string  {336    return this.helper.util.getTokenAddress({collectionId, tokenId});337  }338339  normalizeAddress(address: string): string {340    return '0x' + address.substring(address.length - 40);341  }342}343344export type EthUniqueHelperConstructor = new (...args: any[]) => EthUniqueHelper;345346export class EthUniqueHelper extends DevUniqueHelper {347  web3: Web3 | null = null;348  web3Provider: WebsocketProvider | null = null;349350  eth: EthGroup;351  ethAddress: EthAddressGroup;352  ethNativeContract: NativeContractGroup;353  ethContract: ContractGroup;354355  constructor(logger: { log: (msg: any, level: any) => void, level: any }, options: {[key: string]: any} = {}) {356    options.helperBase = options.helperBase ?? EthUniqueHelper;357358    super(logger, options);359    this.eth = new EthGroup(this);360    this.ethAddress = new EthAddressGroup(this);361    this.ethNativeContract = new NativeContractGroup(this);362    this.ethContract = new ContractGroup(this);363  }364365  getWeb3(): Web3 {366    if(this.web3 === null) throw Error('Web3 not connected');367    return this.web3;368  }369370  async connectWeb3(wsEndpoint: string) {371    if(this.web3 !== null) return;372    this.web3Provider = new Web3.providers.WebsocketProvider(wsEndpoint);373    this.web3 = new Web3(this.web3Provider);374  }375376  async disconnect() {377    if(this.web3 === null) return;378    this.web3Provider?.connection.close();379380    await super.disconnect();381  }382383  clearApi() {384    super.clearApi();385    this.web3 = null;386  }387388  clone(helperCls: EthUniqueHelperConstructor, options?: { [key: string]: any; }): EthUniqueHelper {389    const newHelper = super.clone(helperCls, options) as EthUniqueHelper;390    newHelper.web3 = this.web3;391    newHelper.web3Provider = this.web3Provider;392393    return newHelper;394  }395}