git.delta.rocks / unique-network / refs/commits / 792111584ff1

1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// SPDX-License-Identifier: Apache-2.034import {mnemonicGenerate} from '@polkadot/util-crypto';5import {UniqueHelper, MoonbeamHelper, ChainHelperBase, AcalaHelper, RelayHelper, WestmintHelper} from './unique';6import {ApiPromise, Keyring, WsProvider} from '@polkadot/api';7import * as defs from '../../interfaces/definitions';8import {IKeyringPair} from '@polkadot/types/types';9import {EventRecord} from '@polkadot/types/interfaces';10import {ICrossAccountId} from './types';1112export class SilentLogger {13  log(_msg: any, _level: any): void { }14  level = {15    ERROR: 'ERROR' as const,16    WARNING: 'WARNING' as const,17    INFO: 'INFO' as const,18  };19}2021export class SilentConsole {22  // TODO: Remove, this is temporary: Filter unneeded API output23  // (Jaco promised it will be removed in the next version)24  consoleErr: any;25  consoleLog: any;26  consoleWarn: any;2728  constructor() {29    this.consoleErr = console.error;30    this.consoleLog = console.log;31    this.consoleWarn = console.warn;32  }3334  enable() {  35    const outFn = (printer: any) => (...args: any[]) => {36      for (const arg of args) {37        if (typeof arg !== 'string')38          continue;39        if (arg.includes('1000:: Normal connection closure') || arg.includes('Not decorating unknown runtime apis:') || arg.includes('RPC methods not decorated:') || arg === 'Normal connection closure')40          return;41      }42      printer(...args);43    };44  45    console.error = outFn(this.consoleErr.bind(console));46    console.log = outFn(this.consoleLog.bind(console));47    console.warn = outFn(this.consoleWarn.bind(console));48  }4950  disable() {51    console.error = this.consoleErr;52    console.log = this.consoleLog;53    console.warn = this.consoleWarn;54  }55}5657export class DevUniqueHelper extends UniqueHelper {58  /**59   * Arrange methods for tests60   */61  arrange: ArrangeGroup;62  wait: WaitGroup;63  admin: AdminGroup;6465  constructor(logger: { log: (msg: any, level: any) => void, level: any }, options: {[key: string]: any} = {}) {66    options.helperBase = options.helperBase ?? DevUniqueHelper;6768    super(logger, options);69    this.arrange = new ArrangeGroup(this);70    this.wait = new WaitGroup(this);71    this.admin = new AdminGroup(this);72  }7374  async connect(wsEndpoint: string, _listeners?: any): Promise<void> {75    const wsProvider = new WsProvider(wsEndpoint);76    this.api = new ApiPromise({77      provider: wsProvider,78      signedExtensions: {79        ContractHelpers: {80          extrinsic: {},81          payload: {},82        },83        FakeTransactionFinalizer: {84          extrinsic: {},85          payload: {},86        },87      },88      rpc: {89        unique: defs.unique.rpc,90        appPromotion: defs.appPromotion.rpc,91        rmrk: defs.rmrk.rpc,92        eth: {93          feeHistory: {94            description: 'Dummy',95            params: [],96            type: 'u8',97          },98          maxPriorityFeePerGas: {99            description: 'Dummy',100            params: [],101            type: 'u8',102          },103        },104      },105    });106    await this.api.isReadyOrError;107    this.network = await UniqueHelper.detectNetwork(this.api);108  }109}110111export class DevRelayHelper extends RelayHelper {}112113export class DevWestmintHelper extends WestmintHelper {114  wait: WaitGroup;115116  constructor(logger: { log: (msg: any, level: any) => void, level: any }, options: {[key: string]: any} = {}) {117    options.helperBase = options.helperBase ?? DevWestmintHelper;118119    super(logger, options);120    this.wait = new WaitGroup(this);121  }122}123124export class DevMoonbeamHelper extends MoonbeamHelper {125  account: MoonbeamAccountGroup;126  wait: WaitGroup;127128  constructor(logger: { log: (msg: any, level: any) => void, level: any }, options: {[key: string]: any} = {}) {129    options.helperBase = options.helperBase ?? DevMoonbeamHelper;130131    super(logger, options);132    this.account = new MoonbeamAccountGroup(this);133    this.wait = new WaitGroup(this);134  }135}136137export class DevMoonriverHelper extends DevMoonbeamHelper {}138139export class DevAcalaHelper extends AcalaHelper {140  wait: WaitGroup;141142  constructor(logger: { log: (msg: any, level: any) => void, level: any }, options: {[key: string]: any} = {}) {143    options.helperBase = options.helperBase ?? DevAcalaHelper;144145    super(logger, options);146    this.wait = new WaitGroup(this);147  }148}149150export class DevKaruraHelper extends DevAcalaHelper {}151152class ArrangeGroup {153  helper: DevUniqueHelper;154155  constructor(helper: DevUniqueHelper) {156    this.helper = helper;157  }158159  /**160   * Generates accounts with the specified UNQ token balance 161   * @param balances balances for generated accounts. Each balance will be multiplied by the token nominal.162   * @param donor donor account for balances163   * @returns array of newly created accounts164   * @example const [acc1, acc2, acc3] = await createAccounts([0n, 10n, 20n], donor); 165   */166  createAccounts = async (balances: bigint[], donor: IKeyringPair): Promise<IKeyringPair[]> => {167    let nonce = await this.helper.chain.getNonce(donor.address);168    const wait = new WaitGroup(this.helper);169    const ss58Format = this.helper.chain.getChainProperties().ss58Format;170    const tokenNominal = this.helper.balance.getOneTokenNominal();171    const transactions = [];172    const accounts: IKeyringPair[] = [];173    for (const balance of balances) {174      const recipient = this.helper.util.fromSeed(mnemonicGenerate(), ss58Format);175      accounts.push(recipient);176      if (balance !== 0n) {177        const tx = this.helper.constructApiCall('api.tx.balances.transfer', [{Id: recipient.address}, balance * tokenNominal]);178        transactions.push(this.helper.signTransaction(donor, tx, {nonce}, 'account generation'));179        nonce++;180      }181    }182183    await Promise.all(transactions).catch(_e => {});184    185    //#region TODO remove this region, when nonce problem will be solved186    const checkBalances = async () => {187      let isSuccess = true;188      for (let i = 0; i < balances.length; i++) {189        const balance = await this.helper.balance.getSubstrate(accounts[i].address);190        if (balance !== balances[i] * tokenNominal) {191          isSuccess = false;192          break;193        }194      }195      return isSuccess;196    };197198    let accountsCreated = false;199    // checkBalances retry up to 5 blocks200    for (let index = 0; index < 5; index++) {201      accountsCreated = await checkBalances();202      if(accountsCreated) break;203      await wait.newBlocks(1);204    }205206    if (!accountsCreated) throw Error('Accounts generation failed');207    //#endregion208209    return accounts;210  };211212  // TODO combine this method and createAccounts into one213  createCrowd = async (accountsToCreate: number, withBalance: bigint, donor: IKeyringPair): Promise<IKeyringPair[]> => {  214    const createAsManyAsCan = async () => {215      let transactions: any = [];216      const accounts: IKeyringPair[] = [];217      let nonce = await this.helper.chain.getNonce(donor.address);218      const tokenNominal = this.helper.balance.getOneTokenNominal();219      for (let i = 0; i < accountsToCreate; i++) {220        if (i === 500) { // if there are too many accounts to create221          await Promise.allSettled(transactions); // wait while first 500 (should be 100 for devnode) tx will be settled 222          transactions = []; //223          nonce = await this.helper.chain.getNonce(donor.address); // update nonce 224        }225        const recepient = this.helper.util.fromSeed(mnemonicGenerate());226        accounts.push(recepient);227        if (withBalance !== 0n) {228          const tx = this.helper.constructApiCall('api.tx.balances.transfer', [{Id: recepient.address}, withBalance * tokenNominal]);229          transactions.push(this.helper.signTransaction(donor, tx, {nonce}, 'account generation'));230          nonce++;231        }232      }233      234      const fullfilledAccounts = [];235      await Promise.allSettled(transactions);236      for (const account of accounts) {237        const accountBalance = await this.helper.balance.getSubstrate(account.address);238        if (accountBalance === withBalance * tokenNominal) {239          fullfilledAccounts.push(account);240        }241      }242      return fullfilledAccounts;243    };244245    246    const crowd: IKeyringPair[] = [];247    // do up to 5 retries248    for (let index = 0; index < 5 && accountsToCreate !== 0; index++) {249      const asManyAsCan = await createAsManyAsCan();250      crowd.push(...asManyAsCan);251      accountsToCreate -= asManyAsCan.length;252    }253254    if (accountsToCreate !== 0) throw Error(`Crowd generation failed: ${accountsToCreate} accounts left`);255256    return crowd;257  };258259  isDevNode = async () => {260    const block1 = await this.helper.callRpc('api.rpc.chain.getBlock', [await this.helper.callRpc('api.rpc.chain.getBlockHash', [1])]);261    const block2 = await this.helper.callRpc('api.rpc.chain.getBlock', [await this.helper.callRpc('api.rpc.chain.getBlockHash', [2])]);262    const findCreationDate = async (block: any) => {263      const humanBlock = block.toHuman();264      let date;265      humanBlock.block.extrinsics.forEach((ext: any) => {266        if(ext.method.section === 'timestamp') {267          date = Number(ext.method.args.now.replaceAll(',', ''));268        }269      });270      return date;271    };272    const block1date = await findCreationDate(block1);273    const block2date = await findCreationDate(block2);274    if(block2date! - block1date! < 9000) return true;275  };276  277  async calculcateFee(payer: ICrossAccountId, promise: () => Promise<any>): Promise<bigint> {278    const address = payer.Substrate ? payer.Substrate : await this.helper.address.ethToSubstrate(payer.Ethereum!);279    let balance = await this.helper.balance.getSubstrate(address); 280    281    await promise();282    283    balance -= await this.helper.balance.getSubstrate(address);284    285    return balance;286  }287}288289class MoonbeamAccountGroup {290  helper: MoonbeamHelper;291292  _alithAccount: IKeyringPair;293  _baltatharAccount: IKeyringPair;294  _dorothyAccount: IKeyringPair;295296  constructor(helper: MoonbeamHelper) {297    this.helper = helper;298299    const keyring = new Keyring({type: 'ethereum'});300    const alithPrivateKey = '0x5fb92d6e98884f76de468fa3f6278f8807c48bebc13595d45af5bdc4da702133';301    const baltatharPrivateKey = '0x8075991ce870b93a8870eca0c0f91913d12f47948ca0fd25b49c6fa7cdbeee8b';302    const dorothyPrivateKey = '0x39539ab1876910bbf3a223d84a29e28f1cb4e2e456503e7e91ed39b2e7223d68';303304    this._alithAccount = keyring.addFromUri(alithPrivateKey, undefined, 'ethereum');305    this._baltatharAccount = keyring.addFromUri(baltatharPrivateKey, undefined, 'ethereum');306    this._dorothyAccount = keyring.addFromUri(dorothyPrivateKey, undefined, 'ethereum');307  }308309  alithAccount() {310    return this._alithAccount;311  }312313  baltatharAccount() {314    return this._baltatharAccount;315  }316317  dorothyAccount() {318    return this._dorothyAccount;319  }320}321322class WaitGroup {323  helper: ChainHelperBase;324325  constructor(helper: ChainHelperBase) {326    this.helper = helper;327  }328329  /**330   * Wait for specified number of blocks331   * @param blocksCount number of blocks to wait332   * @returns 333   */334  async newBlocks(blocksCount = 1): Promise<void> {335    // eslint-disable-next-line no-async-promise-executor336    const promise = new Promise<void>(async (resolve) => {337      const unsubscribe = await this.helper.getApi().rpc.chain.subscribeNewHeads(() => {338        if (blocksCount > 0) {339          blocksCount--;340        } else {341          unsubscribe();342          resolve();343        }344      });345    });346    return promise;347  }348349  async forParachainBlockNumber(blockNumber: bigint) {350    // eslint-disable-next-line no-async-promise-executor351    return new Promise<void>(async (resolve) => {352      const unsubscribe = await this.helper.getApi().rpc.chain.subscribeNewHeads(async (data: any) => {353        if (data.number.toNumber() >= blockNumber) {354          unsubscribe();355          resolve();356        }357      });358    });359  }360  361  async forRelayBlockNumber(blockNumber: bigint) {362    // eslint-disable-next-line no-async-promise-executor363    return new Promise<void>(async (resolve) => {364      const unsubscribe = await this.helper.getApi().query.parachainSystem.validationData(async (data: any) => {365        if (data.value.relayParentNumber.toNumber() >= blockNumber) {366          // @ts-ignore367          unsubscribe();368          resolve();369        }370      });371    });372  }373374  async event(maxBlocksToWait: number, eventSection: string, eventMethod: string) {375    // eslint-disable-next-line no-async-promise-executor376    const promise = new Promise<EventRecord | null>(async (resolve) => {377      const unsubscribe = await this.helper.getApi().rpc.chain.subscribeNewHeads(async header => {378        const blockNumber = header.number.toHuman();379        const blockHash = header.hash;380        const eventIdStr = `${eventSection}.${eventMethod}`;381        const waitLimitStr = `wait blocks remaining: ${maxBlocksToWait}`;382  383        console.log(`[Block #${blockNumber}] Waiting for event \`${eventIdStr}\` (${waitLimitStr})`);384  385        const apiAt = await this.helper.getApi().at(blockHash);386        const eventRecords = await apiAt.query.system.events();387  388        const neededEvent = eventRecords.find(r => {389          return r.event.section == eventSection && r.event.method == eventMethod;390        });391  392        if (neededEvent) {393          unsubscribe();394          resolve(neededEvent);395        } else if (maxBlocksToWait > 0) {396          maxBlocksToWait--;397        } else {398          console.log(`Event \`${eventIdStr}\` is NOT found`);399  400          unsubscribe();401          resolve(null);402        }403      });404    });405    return promise;406  }407}408409class AdminGroup {410  helper: UniqueHelper;411412  constructor(helper: UniqueHelper) {413    this.helper = helper;414  }415416  async payoutStakers(signer: IKeyringPair, stakersToPayout: number) {417    const payoutResult = await this.helper.executeExtrinsic(signer, 'api.tx.appPromotion.payoutStakers', [stakersToPayout], true);418    return payoutResult.result.events.filter(e => e.event.method === 'StakingRecalculation').map(e => {419      return {420        staker: e.event.data[0].toString(),421        stake: e.event.data[1].toBigInt(),422        payout: e.event.data[2].toBigInt(),423      };424    });425  }426}