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

1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// This file is part of Unique Network.34// Unique Network is free software: you can redistribute it and/or modify5// it under the terms of the GNU General Public License as published by6// the Free Software Foundation, either version 3 of the License, or7// (at your option) any later version.89// Unique Network is distributed in the hope that it will be useful,10// but WITHOUT ANY WARRANTY; without even the implied warranty of11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the12// GNU General Public License for more details.1314// You should have received a copy of the GNU General Public License15// along with Unique Network. If not, see <http://www.gnu.org/licenses/>.1617// eslint-disable-next-line @typescript-eslint/triple-slash-reference18/// <reference path="helpers.d.ts" />1920import {ApiPromise} from '@polkadot/api';21import {addressToEvm, evmToAddress} from '@polkadot/util-crypto';22import Web3 from 'web3';23import usingApi, {submitTransactionAsync} from '../../substrate/substrate-api';24import {IKeyringPair} from '@polkadot/types/types';25import {expect} from 'chai';26import {CrossAccountId, getGenericResult, UNIQUE} from '../../util/helpers';27import * as solc from 'solc';28import config from '../../config';29import privateKey from '../../substrate/privateKey';30import contractHelpersAbi from './contractHelpersAbi.json';31import collectionAbi from '../collectionAbi.json';32import collectionHelperAbi from '../collectionHelperAbi.json';33import getBalance from '../../substrate/get-balance';34import waitNewBlocks from '../../substrate/wait-new-blocks';3536export const GAS_ARGS = {gas: 2500000};3738export enum SponsoringMode {39  Disabled = 0,40  Allowlisted = 1,41  Generous = 2,42}4344let web3Connected = false;45export async function usingWeb3<T>(cb: (web3: Web3) => Promise<T> | T): Promise<T> {46  if (web3Connected) throw new Error('do not nest usingWeb3 calls');47  web3Connected = true;4849  const provider = new Web3.providers.WebsocketProvider(config.substrateUrl);50  const web3 = new Web3(provider);5152  try {53    return await cb(web3);54  } finally {55    // provider.disconnect(3000, 'normal disconnect');56    provider.connection.close();57    web3Connected = false;58  }59}6061function encodeIntBE(v: number): number[] {62  if (v >= 0xffffffff || v < 0) throw new Error('id overflow');63  return [64    v >> 24,65    (v >> 16) & 0xff,66    (v >> 8) & 0xff,67    v & 0xff,68  ];69}7071export function collectionIdToAddress(collection: number): string {72  const buf = Buffer.from([0x17, 0xc4, 0xe6, 0x45, 0x3c, 0xc4, 0x9a, 0xaa, 0xae, 0xac, 0xa8, 0x94, 0xe6, 0xd9, 0x68, 0x3e,73    ...encodeIntBE(collection),74  ]);75  return Web3.utils.toChecksumAddress('0x' + buf.toString('hex'));76}77export function collectionIdFromAddress(address: string): number {78  if (!address.startsWith('0x'))79    throw 'address not starts with "0x"';80  if (address.length > 42)81    throw 'address length is more than 20 bytes';82  return Number('0x' + address.substring(address.length - 8));83}84  85export function normalizeAddress(address: string): string {86  return '0x' + address.substring(address.length - 40);87}8889export function tokenIdToAddress(collection: number, token: number): string {90  const buf = Buffer.from([0xf8, 0x23, 0x8c, 0xcf, 0xff, 0x8e, 0xd8, 0x87, 0x46, 0x3f, 0xd5, 0xe0,91    ...encodeIntBE(collection),92    ...encodeIntBE(token),93  ]);94  return Web3.utils.toChecksumAddress('0x' + buf.toString('hex'));95}96export function tokenIdToCross(collection: number, token: number): CrossAccountId {97  return {98    Ethereum: tokenIdToAddress(collection, token),99  };100}101102export function createEthAccount(web3: Web3) {103  const account = web3.eth.accounts.create();104  web3.eth.accounts.wallet.add(account.privateKey);105  return account.address;106}107108export async function createEthAccountWithBalance(api: ApiPromise, web3: Web3) {109  const alice = privateKey('//Alice');110  const account = createEthAccount(web3);111  await transferBalanceToEth(api, alice, account);112113  return account;114}115116export async function transferBalanceToEth(api: ApiPromise, source: IKeyringPair, target: string, amount = 1000n * UNIQUE) {117  const tx = api.tx.balances.transfer(evmToAddress(target), amount);118  const events = await submitTransactionAsync(source, tx);119  const result = getGenericResult(events);120  expect(result.success).to.be.true;121}122123export async function itWeb3(name: string, cb: (apis: { web3: Web3, api: ApiPromise }) => any, opts: { only?: boolean, skip?: boolean } = {}) {124  let i: any = it;125  if (opts.only) i = i.only;126  else if (opts.skip) i = i.skip;127  i(name, async () => {128    await usingApi(async api => {129      await usingWeb3(async web3 => {130        await cb({api, web3});131      });132    });133  });134}135itWeb3.only = (name: string, cb: (apis: { web3: Web3, api: ApiPromise }) => any) => itWeb3(name, cb, {only: true});136itWeb3.skip = (name: string, cb: (apis: { web3: Web3, api: ApiPromise }) => any) => itWeb3(name, cb, {skip: true});137138export async function generateSubstrateEthPair(web3: Web3) {139  const account = web3.eth.accounts.create();140  evmToAddress(account.address);141}142143type NormalizedEvent = {144    address: string,145    event: string,146    args: { [key: string]: string }147};148149export function normalizeEvents(events: any): NormalizedEvent[] {150  const output = [];151  for (const key of Object.keys(events)) {152    if (key.match(/^[0-9]+$/)) {153      output.push(events[key]);154    } else if (Array.isArray(events[key])) {155      output.push(...events[key]);156    } else {157      output.push(events[key]);158    }159  }160  output.sort((a, b) => a.logIndex - b.logIndex);161  return output.map(({address, event, returnValues}) => {162    const args: { [key: string]: string } = {};163    for (const key of Object.keys(returnValues)) {164      if (!key.match(/^[0-9]+$/)) {165        args[key] = returnValues[key];166      }167    }168    return {169      address,170      event,171      args,172    };173  });174}175176export async function recordEvents(contract: any, action: () => Promise<void>): Promise<NormalizedEvent[]> {177  const out: any = [];178  contract.events.allEvents((_: any, event: any) => {179    out.push(event);180  });181  await action();182  return normalizeEvents(out);183}184185export function subToEthLowercase(eth: string): string {186  const bytes = addressToEvm(eth);187  return '0x' + Buffer.from(bytes).toString('hex');188}189190export function subToEth(eth: string): string {191  return Web3.utils.toChecksumAddress(subToEthLowercase(eth));192}193194export function compileContract(name: string, src: string) {195  const out = JSON.parse(solc.compile(JSON.stringify({196    language: 'Solidity',197    sources: {198      [`${name}.sol`]: {199        content: `200          // SPDX-License-Identifier: UNLICENSED201          pragma solidity ^0.8.6;202203          ${src}204        `,205      },206    },207    settings: {208      outputSelection: {209        '*': {210          '*': ['*'],211        },212      },213    },214  }))).contracts[`${name}.sol`][name];215216  return {217    abi: out.abi,218    object: '0x' + out.evm.bytecode.object,219  };220}221222export async function deployFlipper(web3: Web3, deployer: string) {223  const compiled = compileContract('Flipper', `224    contract Flipper {225      bool value = false;226      function flip() public {227        value = !value;228      }229      function getValue() public view returns (bool) {230        return value;231      }232    }233  `);234  const flipperContract = new web3.eth.Contract(compiled.abi, undefined, {235    data: compiled.object,236    from: deployer,237    ...GAS_ARGS,238  });239  const flipper = await flipperContract.deploy({data: compiled.object}).send({from: deployer});240241  return flipper;242}243244export async function deployCollector(web3: Web3, deployer: string) {245  const compiled = compileContract('Collector', `246    contract Collector {247      uint256 collected;248      fallback() external payable {249        giveMoney();250      }251      function giveMoney() public payable {252        collected += msg.value;253      }254      function getCollected() public view returns (uint256) {255        return collected;256      }257      function getUnaccounted() public view returns (uint256) {258        return address(this).balance - collected;259      }260261      function withdraw(address payable target) public {262        target.transfer(collected);263        collected = 0;264      }265    }266  `);267  const collectorContract = new web3.eth.Contract(compiled.abi, undefined, {268    data: compiled.object,269    from: deployer,270    ...GAS_ARGS,271  });272  const collector = await collectorContract.deploy({data: compiled.object}).send({from: deployer});273274  return collector;275}276277/** 278 * pallet evm_contract_helpers279 * @param web3 280 * @param caller - eth address281 * @returns 282 */283export function contractHelpers(web3: Web3, caller: string) {284  return new web3.eth.Contract(contractHelpersAbi as any, '0x842899ECF380553E8a4de75bF534cdf6fBF64049', {from: caller, ...GAS_ARGS});285}286287/** 288 * evm collection helper289 * @param web3 290 * @param caller - eth address291 * @returns 292 */293export function evmCollectionHelper(web3: Web3, caller: string) {294  return new web3.eth.Contract(collectionHelperAbi as any, '0x6c4e9fe1ae37a41e93cee429e8e1881abdcbb54f', {from: caller, ...GAS_ARGS});295}296297/** 298 * evm collection299 * @param web3 300 * @param caller - eth address301 * @returns 302 */303export function evmCollection(web3: Web3, caller: string, collection: string) {304  return new web3.eth.Contract(collectionAbi as any, collection, {from: caller, ...GAS_ARGS});305}306307/**308 * Execute ethereum method call using substrate account309 * @param to target contract310 * @param mkTx - closure, receiving `contract.methods`, and returning method call,311 * to be used as following (assuming `to` = erc20 contract):312 * `m => m.transfer(to, amount)`313 *314 * # Example315 * ```ts316 * executeEthTxOnSub(api, alice, erc20Contract, m => m.transfer(target, amount));317 * ```318 */319export async function executeEthTxOnSub(web3: Web3, api: ApiPromise, from: IKeyringPair, to: any, mkTx: (methods: any) => any, {value = 0}: {value?: bigint | number} = { }) {320  const tx = api.tx.evm.call(321    subToEth(from.address),322    to.options.address,323    mkTx(to.methods).encodeABI(),324    value,325    GAS_ARGS.gas,326    await web3.eth.getGasPrice(),327    null,328    null,329    [],330  );331  const events = await submitTransactionAsync(from, tx);332  expect(events.some(({event: {section, method}}) => section == 'evm' && method == 'Executed')).to.be.true;333}334335export async function ethBalanceViaSub(api: ApiPromise, address: string): Promise<bigint> {336  return (await getBalance(api, [evmToAddress(address)]))[0];337}338339/**340 * Measure how much gas given closure consumes341 *342 * @param user which user balance will be checked343 */344export async function recordEthFee(api: ApiPromise, user: string, call: () => Promise<any>): Promise<bigint> {345  const before = await ethBalanceViaSub(api, user);346347  await call();348349  // In dev mode, the transaction might not finish processing in time350  await waitNewBlocks(api, 1);351  const after = await ethBalanceViaSub(api, user);352353  // Can't use .to.be.less, because chai doesn't supports bigint354  expect(after < before).to.be.true;355356  return before - after;357}358359type ElementOf<A> = A extends readonly (infer T)[] ? T : never;360// I want a fancier api, not a memory efficiency361export function* cartesian<T extends Array<Array<any>>, R extends Array<any>>(internalRest: [...R], ...args: [...T]): Generator<[...R, ...{[K in keyof T]: ElementOf<T[K]>}]> {362  if(args.length === 0) {363    yield internalRest as any;364    return;365  }366  for(const value of args[0]) {367    yield* cartesian([...internalRest, value], ...args.slice(1)) as any;368  }369}