git.delta.rocks / unique-network / refs/commits / 6360d02576ab

1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// SPDX-License-Identifier: Apache-2.034import {stringToU8a} from '@polkadot/util';5import {encodeAddress, mnemonicGenerate} from '@polkadot/util-crypto';6import {UniqueHelper, MoonbeamHelper, ChainHelperBase, AcalaHelper, RelayHelper, WestmintHelper} from './unique';7import {ApiPromise, Keyring, WsProvider} from '@polkadot/api';8import * as defs from '../../interfaces/definitions';9import {IKeyringPair} from '@polkadot/types/types';10import {EventRecord} from '@polkadot/types/interfaces';11import {ICrossAccountId} from './types';12import {FrameSystemEventRecord} from '@polkadot/types/lookup';1314export class SilentLogger {15  log(_msg: any, _level: any): void { }16  level = {17    ERROR: 'ERROR' as const,18    WARNING: 'WARNING' as const,19    INFO: 'INFO' as const,20  };21}2223export class SilentConsole {24  // TODO: Remove, this is temporary: Filter unneeded API output25  // (Jaco promised it will be removed in the next version)26  consoleErr: any;27  consoleLog: any;28  consoleWarn: any;2930  constructor() {31    this.consoleErr = console.error;32    this.consoleLog = console.log;33    this.consoleWarn = console.warn;34  }3536  enable() {  37    const outFn = (printer: any) => (...args: any[]) => {38      for (const arg of args) {39        if (typeof arg !== 'string')40          continue;41        if (arg.includes('1000:: Normal connection closure') || arg.includes('Not decorating unknown runtime apis:') || arg.includes('RPC methods not decorated:') || arg === 'Normal connection closure')42          return;43      }44      printer(...args);45    };46  47    console.error = outFn(this.consoleErr.bind(console));48    console.log = outFn(this.consoleLog.bind(console));49    console.warn = outFn(this.consoleWarn.bind(console));50  }5152  disable() {53    console.error = this.consoleErr;54    console.log = this.consoleLog;55    console.warn = this.consoleWarn;56  }57}5859export class DevUniqueHelper extends UniqueHelper {60  /**61   * Arrange methods for tests62   */63  arrange: ArrangeGroup;64  wait: WaitGroup;65  admin: AdminGroup;6667  constructor(logger: { log: (msg: any, level: any) => void, level: any }, options: {[key: string]: any} = {}) {68    options.helperBase = options.helperBase ?? DevUniqueHelper;6970    super(logger, options);71    this.arrange = new ArrangeGroup(this);72    this.wait = new WaitGroup(this);73    this.admin = new AdminGroup(this);74  }7576  async connect(wsEndpoint: string, _listeners?: any): Promise<void> {77    const wsProvider = new WsProvider(wsEndpoint);78    this.api = new ApiPromise({79      provider: wsProvider,80      signedExtensions: {81        ContractHelpers: {82          extrinsic: {},83          payload: {},84        },85        FakeTransactionFinalizer: {86          extrinsic: {},87          payload: {},88        },89      },90      rpc: {91        unique: defs.unique.rpc,92        appPromotion: defs.appPromotion.rpc,93        rmrk: defs.rmrk.rpc,94        eth: {95          feeHistory: {96            description: 'Dummy',97            params: [],98            type: 'u8',99          },100          maxPriorityFeePerGas: {101            description: 'Dummy',102            params: [],103            type: 'u8',104          },105        },106      },107    });108    await this.api.isReadyOrError;109    this.network = await UniqueHelper.detectNetwork(this.api);110  }111}112113export class DevRelayHelper extends RelayHelper {}114115export class DevWestmintHelper extends WestmintHelper {116  wait: WaitGroup;117118  constructor(logger: { log: (msg: any, level: any) => void, level: any }, options: {[key: string]: any} = {}) {119    options.helperBase = options.helperBase ?? DevWestmintHelper;120121    super(logger, options);122    this.wait = new WaitGroup(this);123  }124}125126export class DevMoonbeamHelper extends MoonbeamHelper {127  account: MoonbeamAccountGroup;128  wait: WaitGroup;129130  constructor(logger: { log: (msg: any, level: any) => void, level: any }, options: {[key: string]: any} = {}) {131    options.helperBase = options.helperBase ?? DevMoonbeamHelper;132133    super(logger, options);134    this.account = new MoonbeamAccountGroup(this);135    this.wait = new WaitGroup(this);136  }137}138139export class DevMoonriverHelper extends DevMoonbeamHelper {}140141export class DevAcalaHelper extends AcalaHelper {142  wait: WaitGroup;143144  constructor(logger: { log: (msg: any, level: any) => void, level: any }, options: {[key: string]: any} = {}) {145    options.helperBase = options.helperBase ?? DevAcalaHelper;146147    super(logger, options);148    this.wait = new WaitGroup(this);149  }150}151152export class DevKaruraHelper extends DevAcalaHelper {}153154class ArrangeGroup {155  helper: DevUniqueHelper;156157  constructor(helper: DevUniqueHelper) {158    this.helper = helper;159  }160161  /**162   * Generates accounts with the specified UNQ token balance 163   * @param balances balances for generated accounts. Each balance will be multiplied by the token nominal.164   * @param donor donor account for balances165   * @returns array of newly created accounts166   * @example const [acc1, acc2, acc3] = await createAccounts([0n, 10n, 20n], donor); 167   */168  createAccounts = async (balances: bigint[], donor: IKeyringPair): Promise<IKeyringPair[]> => {169    let nonce = await this.helper.chain.getNonce(donor.address);170    const wait = new WaitGroup(this.helper);171    const ss58Format = this.helper.chain.getChainProperties().ss58Format;172    const tokenNominal = this.helper.balance.getOneTokenNominal();173    const transactions = [];174    const accounts: IKeyringPair[] = [];175    for (const balance of balances) {176      const recipient = this.helper.util.fromSeed(mnemonicGenerate(), ss58Format);177      accounts.push(recipient);178      if (balance !== 0n) {179        const tx = this.helper.constructApiCall('api.tx.balances.transfer', [{Id: recipient.address}, balance * tokenNominal]);180        transactions.push(this.helper.signTransaction(donor, tx, {nonce}, 'account generation'));181        nonce++;182      }183    }184185    await Promise.all(transactions).catch(_e => {});186    187    //#region TODO remove this region, when nonce problem will be solved188    const checkBalances = async () => {189      let isSuccess = true;190      for (let i = 0; i < balances.length; i++) {191        const balance = await this.helper.balance.getSubstrate(accounts[i].address);192        if (balance !== balances[i] * tokenNominal) {193          isSuccess = false;194          break;195        }196      }197      return isSuccess;198    };199200    let accountsCreated = false;201    const maxBlocksChecked = await this.helper.arrange.isDevNode() ? 50 : 5;202    // checkBalances retry up to 5-50 blocks203    for (let index = 0; index < maxBlocksChecked; index++) {204      accountsCreated = await checkBalances();205      if(accountsCreated) break;206      await wait.newBlocks(1);207    }208209    if (!accountsCreated) throw Error('Accounts generation failed');210    //#endregion211212    return accounts;213  };214215  // TODO combine this method and createAccounts into one216  createCrowd = async (accountsToCreate: number, withBalance: bigint, donor: IKeyringPair): Promise<IKeyringPair[]> => {  217    const createAsManyAsCan = async () => {218      let transactions: any = [];219      const accounts: IKeyringPair[] = [];220      let nonce = await this.helper.chain.getNonce(donor.address);221      const tokenNominal = this.helper.balance.getOneTokenNominal();222      for (let i = 0; i < accountsToCreate; i++) {223        if (i === 500) { // if there are too many accounts to create224          await Promise.allSettled(transactions); // wait while first 500 (should be 100 for devnode) tx will be settled 225          transactions = []; //226          nonce = await this.helper.chain.getNonce(donor.address); // update nonce 227        }228        const recepient = this.helper.util.fromSeed(mnemonicGenerate());229        accounts.push(recepient);230        if (withBalance !== 0n) {231          const tx = this.helper.constructApiCall('api.tx.balances.transfer', [{Id: recepient.address}, withBalance * tokenNominal]);232          transactions.push(this.helper.signTransaction(donor, tx, {nonce}, 'account generation'));233          nonce++;234        }235      }236      237      const fullfilledAccounts = [];238      await Promise.allSettled(transactions);239      for (const account of accounts) {240        const accountBalance = await this.helper.balance.getSubstrate(account.address);241        if (accountBalance === withBalance * tokenNominal) {242          fullfilledAccounts.push(account);243        }244      }245      return fullfilledAccounts;246    };247248    249    const crowd: IKeyringPair[] = [];250    // do up to 5 retries251    for (let index = 0; index < 5 && accountsToCreate !== 0; index++) {252      const asManyAsCan = await createAsManyAsCan();253      crowd.push(...asManyAsCan);254      accountsToCreate -= asManyAsCan.length;255    }256257    if (accountsToCreate !== 0) throw Error(`Crowd generation failed: ${accountsToCreate} accounts left`);258259    return crowd;260  };261262  isDevNode = async () => {263    const block1 = await this.helper.callRpc('api.rpc.chain.getBlock', [await this.helper.callRpc('api.rpc.chain.getBlockHash', [1])]);264    const block2 = await this.helper.callRpc('api.rpc.chain.getBlock', [await this.helper.callRpc('api.rpc.chain.getBlockHash', [2])]);265    const findCreationDate = async (block: any) => {266      const humanBlock = block.toHuman();267      let date;268      humanBlock.block.extrinsics.forEach((ext: any) => {269        if(ext.method.section === 'timestamp') {270          date = Number(ext.method.args.now.replaceAll(',', ''));271        }272      });273      return date;274    };275    const block1date = await findCreationDate(block1);276    const block2date = await findCreationDate(block2);277    if(block2date! - block1date! < 9000) return true;278  };279  280  async calculcateFee(payer: ICrossAccountId, promise: () => Promise<any>): Promise<bigint> {281    const address = payer.Substrate ? payer.Substrate : await this.helper.address.ethToSubstrate(payer.Ethereum!);282    let balance = await this.helper.balance.getSubstrate(address); 283    284    await promise();285    286    balance -= await this.helper.balance.getSubstrate(address);287    288    return balance;289  }290291  calculatePalletAddress(palletId: any) {292    const address = stringToU8a(('modl' + palletId).padEnd(32, '\0'));293    return encodeAddress(address);294  }295}296297class MoonbeamAccountGroup {298  helper: MoonbeamHelper;299300  keyring: Keyring;301  _alithAccount: IKeyringPair;302  _baltatharAccount: IKeyringPair;303  _dorothyAccount: IKeyringPair;304305  constructor(helper: MoonbeamHelper) {306    this.helper = helper;307308    this.keyring = new Keyring({type: 'ethereum'});309    const alithPrivateKey = '0x5fb92d6e98884f76de468fa3f6278f8807c48bebc13595d45af5bdc4da702133';310    const baltatharPrivateKey = '0x8075991ce870b93a8870eca0c0f91913d12f47948ca0fd25b49c6fa7cdbeee8b';311    const dorothyPrivateKey = '0x39539ab1876910bbf3a223d84a29e28f1cb4e2e456503e7e91ed39b2e7223d68';312313    this._alithAccount = this.keyring.addFromUri(alithPrivateKey, undefined, 'ethereum');314    this._baltatharAccount = this.keyring.addFromUri(baltatharPrivateKey, undefined, 'ethereum');315    this._dorothyAccount = this.keyring.addFromUri(dorothyPrivateKey, undefined, 'ethereum');316  }317318  alithAccount() {319    return this._alithAccount;320  }321322  baltatharAccount() {323    return this._baltatharAccount;324  }325326  dorothyAccount() {327    return this._dorothyAccount;328  }329330  create() {331    return this.keyring.addFromUri(mnemonicGenerate());332  }333}334335class WaitGroup {336  helper: ChainHelperBase;337338  constructor(helper: ChainHelperBase) {339    this.helper = helper;340  }341342  /**343   * Wait for specified number of blocks344   * @param blocksCount number of blocks to wait345   * @returns 346   */347  async newBlocks(blocksCount = 1): Promise<void> {348    // eslint-disable-next-line no-async-promise-executor349    const promise = new Promise<void>(async (resolve) => {350      const unsubscribe = await this.helper.getApi().rpc.chain.subscribeNewHeads(() => {351        if (blocksCount > 0) {352          blocksCount--;353        } else {354          unsubscribe();355          resolve();356        }357      });358    });359    return promise;360  }361362  async forParachainBlockNumber(blockNumber: bigint) {363    // eslint-disable-next-line no-async-promise-executor364    return new Promise<void>(async (resolve) => {365      const unsubscribe = await this.helper.getApi().rpc.chain.subscribeNewHeads(async (data: any) => {366        if (data.number.toNumber() >= blockNumber) {367          unsubscribe();368          resolve();369        }370      });371    });372  }373  374  async forRelayBlockNumber(blockNumber: bigint) {375    // eslint-disable-next-line no-async-promise-executor376    return new Promise<void>(async (resolve) => {377      const unsubscribe = await this.helper.getApi().query.parachainSystem.validationData(async (data: any) => {378        if (data.value.relayParentNumber.toNumber() >= blockNumber) {379          // @ts-ignore380          unsubscribe();381          resolve();382        }383      });384    });385  }386387  async event(maxBlocksToWait: number, eventSection: string, eventMethod: string) {388    // eslint-disable-next-line no-async-promise-executor389    const promise = new Promise<EventRecord | null>(async (resolve) => {390      const unsubscribe = await this.helper.getApi().rpc.chain.subscribeNewHeads(async header => {391        const blockNumber = header.number.toHuman();392        const blockHash = header.hash;393        const eventIdStr = `${eventSection}.${eventMethod}`;394        const waitLimitStr = `wait blocks remaining: ${maxBlocksToWait}`;395  396        this.helper.logger.log(`[Block #${blockNumber}] Waiting for event \`${eventIdStr}\` (${waitLimitStr})`);397  398        const apiAt = await this.helper.getApi().at(blockHash);399        const eventRecords = (await apiAt.query.system.events()) as any;400  401        const neededEvent = eventRecords.toArray().find((r: FrameSystemEventRecord) => {402          return r.event.section == eventSection && r.event.method == eventMethod;403        });404  405        if (neededEvent) {406          unsubscribe();407          resolve(neededEvent);408        } else if (maxBlocksToWait > 0) {409          maxBlocksToWait--;410        } else {411          this.helper.logger.log(`Event \`${eventIdStr}\` is NOT found`);412  413          unsubscribe();414          resolve(null);415        }416      });417    });418    return promise;419  }420}421422class AdminGroup {423  helper: UniqueHelper;424425  constructor(helper: UniqueHelper) {426    this.helper = helper;427  }428429  async payoutStakers(signer: IKeyringPair, stakersToPayout: number) {430    const payoutResult = await this.helper.executeExtrinsic(signer, 'api.tx.appPromotion.payoutStakers', [stakersToPayout], true);431    return payoutResult.result.events.filter(e => e.event.method === 'StakingRecalculation').map(e => {432      return {433        staker: e.event.data[0].toString(),434        stake: e.event.data[1].toBigInt(),435        payout: e.event.data[2].toBigInt(),436      };437    });438  }439}