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

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, IPovInfo, TSigner} from './types';12import {FrameSystemEventRecord} from '@polkadot/types/lookup';13import {VoidFn} from '@polkadot/api/types';14import {Pallets} from '..';15import {spawnSync} from 'child_process';1617export class SilentLogger {18  log(_msg: any, _level: any): void { }19  level = {20    ERROR: 'ERROR' as const,21    WARNING: 'WARNING' as const,22    INFO: 'INFO' as const,23  };24}2526export class SilentConsole {27  // TODO: Remove, this is temporary: Filter unneeded API output28  // (Jaco promised it will be removed in the next version)29  consoleErr: any;30  consoleLog: any;31  consoleWarn: any;3233  constructor() {34    this.consoleErr = console.error;35    this.consoleLog = console.log;36    this.consoleWarn = console.warn;37  }3839  enable() {40    const outFn = (printer: any) => (...args: any[]) => {41      for (const arg of args) {42        if (typeof arg !== 'string')43          continue;44        if (arg.includes('1000:: Normal connection closure') || arg.includes('Not decorating unknown runtime apis:') || arg.includes('RPC methods not decorated:') || arg === 'Normal connection closure')45          return;46      }47      printer(...args);48    };4950    console.error = outFn(this.consoleErr.bind(console));51    console.log = outFn(this.consoleLog.bind(console));52    console.warn = outFn(this.consoleWarn.bind(console));53  }5455  disable() {56    console.error = this.consoleErr;57    console.log = this.consoleLog;58    console.warn = this.consoleWarn;59  }60}6162export class DevUniqueHelper extends UniqueHelper {63  /**64   * Arrange methods for tests65   */66  arrange: ArrangeGroup;67  wait: WaitGroup;68  admin: AdminGroup;69  testUtils: TestUtilGroup;7071  constructor(logger: { log: (msg: any, level: any) => void, level: any }, options: {[key: string]: any} = {}) {72    options.helperBase = options.helperBase ?? DevUniqueHelper;7374    super(logger, options);75    this.arrange = new ArrangeGroup(this);76    this.wait = new WaitGroup(this);77    this.admin = new AdminGroup(this);78    this.testUtils = new TestUtilGroup(this);79  }8081  async connect(wsEndpoint: string, _listeners?: any): Promise<void> {82    const wsProvider = new WsProvider(wsEndpoint);83    this.api = new ApiPromise({84      provider: wsProvider,85      signedExtensions: {86        ContractHelpers: {87          extrinsic: {},88          payload: {},89        },90        CheckMaintenance: {91          extrinsic: {},92          payload: {},93        },94        FakeTransactionFinalizer: {95          extrinsic: {},96          payload: {},97        },98      },99      rpc: {100        unique: defs.unique.rpc,101        appPromotion: defs.appPromotion.rpc,102        povinfo: defs.povinfo.rpc,103        rmrk: defs.rmrk.rpc,104        eth: {105          feeHistory: {106            description: 'Dummy',107            params: [],108            type: 'u8',109          },110          maxPriorityFeePerGas: {111            description: 'Dummy',112            params: [],113            type: 'u8',114          },115        },116      },117    });118    await this.api.isReadyOrError;119    this.network = await UniqueHelper.detectNetwork(this.api);120    this.wsEndpoint = wsEndpoint;121  }122}123124export class DevRelayHelper extends RelayHelper {125  wait: WaitGroup;126127  constructor(logger: { log: (msg: any, level: any) => void, level: any }, options: {[key: string]: any} = {}) {128    options.helperBase = options.helperBase ?? DevRelayHelper;129130    super(logger, options);131    this.wait = new WaitGroup(this);132  }133}134135export class DevWestmintHelper extends WestmintHelper {136  wait: WaitGroup;137138  constructor(logger: { log: (msg: any, level: any) => void, level: any }, options: {[key: string]: any} = {}) {139    options.helperBase = options.helperBase ?? DevWestmintHelper;140141    super(logger, options);142    this.wait = new WaitGroup(this);143  }144}145146export class DevStatemineHelper extends DevWestmintHelper {}147148export class DevStatemintHelper extends DevWestmintHelper {}149150export class DevMoonbeamHelper extends MoonbeamHelper {151  account: MoonbeamAccountGroup;152  wait: WaitGroup;153154  constructor(logger: { log: (msg: any, level: any) => void, level: any }, options: {[key: string]: any} = {}) {155    options.helperBase = options.helperBase ?? DevMoonbeamHelper;156    options.notePreimagePallet = options.notePreimagePallet ?? 'democracy';157158    super(logger, options);159    this.account = new MoonbeamAccountGroup(this);160    this.wait = new WaitGroup(this);161  }162}163164export class DevMoonriverHelper extends DevMoonbeamHelper {165  constructor(logger: { log: (msg: any, level: any) => void, level: any }, options: {[key: string]: any} = {}) {166    options.notePreimagePallet = options.notePreimagePallet ?? 'preimage';167    super(logger, options);168  }169}170171export class DevAcalaHelper extends AcalaHelper {172  wait: WaitGroup;173174  constructor(logger: { log: (msg: any, level: any) => void, level: any }, options: {[key: string]: any} = {}) {175    options.helperBase = options.helperBase ?? DevAcalaHelper;176177    super(logger, options);178    this.wait = new WaitGroup(this);179  }180}181182export class DevKaruraHelper extends DevAcalaHelper {}183184class ArrangeGroup {185  helper: DevUniqueHelper;186187  scheduledIdSlider = 0;188189  constructor(helper: DevUniqueHelper) {190    this.helper = helper;191  }192193  /**194   * Generates accounts with the specified UNQ token balance195   * @param balances balances for generated accounts. Each balance will be multiplied by the token nominal.196   * @param donor donor account for balances197   * @returns array of newly created accounts198   * @example const [acc1, acc2, acc3] = await createAccounts([0n, 10n, 20n], donor);199   */200  createAccounts = async (balances: bigint[], donor: IKeyringPair): Promise<IKeyringPair[]> => {201    let nonce = await this.helper.chain.getNonce(donor.address);202    const wait = new WaitGroup(this.helper);203    const ss58Format = this.helper.chain.getChainProperties().ss58Format;204    const tokenNominal = this.helper.balance.getOneTokenNominal();205    const transactions = [];206    const accounts: IKeyringPair[] = [];207    for (const balance of balances) {208      const recipient = this.helper.util.fromSeed(mnemonicGenerate(), ss58Format);209      accounts.push(recipient);210      if (balance !== 0n) {211        const tx = this.helper.constructApiCall('api.tx.balances.transfer', [{Id: recipient.address}, balance * tokenNominal]);212        transactions.push(this.helper.signTransaction(donor, tx, {nonce}, 'account generation'));213        nonce++;214      }215    }216217    await Promise.all(transactions).catch(_e => {});218219    //#region TODO remove this region, when nonce problem will be solved220    const checkBalances = async () => {221      let isSuccess = true;222      for (let i = 0; i < balances.length; i++) {223        const balance = await this.helper.balance.getSubstrate(accounts[i].address);224        if (balance !== balances[i] * tokenNominal) {225          isSuccess = false;226          break;227        }228      }229      return isSuccess;230    };231232    let accountsCreated = false;233    const maxBlocksChecked = await this.helper.arrange.isDevNode() ? 50 : 5;234    // checkBalances retry up to 5-50 blocks235    for (let index = 0; index < maxBlocksChecked; index++) {236      accountsCreated = await checkBalances();237      if(accountsCreated) break;238      await wait.newBlocks(1);239    }240241    if (!accountsCreated) throw Error('Accounts generation failed');242    //#endregion243244    return accounts;245  };246247  // TODO combine this method and createAccounts into one248  createCrowd = async (accountsToCreate: number, withBalance: bigint, donor: IKeyringPair): Promise<IKeyringPair[]> => {249    const createAsManyAsCan = async () => {250      let transactions: any = [];251      const accounts: IKeyringPair[] = [];252      let nonce = await this.helper.chain.getNonce(donor.address);253      const tokenNominal = this.helper.balance.getOneTokenNominal();254      for (let i = 0; i < accountsToCreate; i++) {255        if (i === 500) { // if there are too many accounts to create256          await Promise.allSettled(transactions); // wait while first 500 (should be 100 for devnode) tx will be settled257          transactions = []; //258          nonce = await this.helper.chain.getNonce(donor.address); // update nonce259        }260        const recepient = this.helper.util.fromSeed(mnemonicGenerate());261        accounts.push(recepient);262        if (withBalance !== 0n) {263          const tx = this.helper.constructApiCall('api.tx.balances.transfer', [{Id: recepient.address}, withBalance * tokenNominal]);264          transactions.push(this.helper.signTransaction(donor, tx, {nonce}, 'account generation'));265          nonce++;266        }267      }268269      const fullfilledAccounts = [];270      await Promise.allSettled(transactions);271      for (const account of accounts) {272        const accountBalance = await this.helper.balance.getSubstrate(account.address);273        if (accountBalance === withBalance * tokenNominal) {274          fullfilledAccounts.push(account);275        }276      }277      return fullfilledAccounts;278    };279280281    const crowd: IKeyringPair[] = [];282    // do up to 5 retries283    for (let index = 0; index < 5 && accountsToCreate !== 0; index++) {284      const asManyAsCan = await createAsManyAsCan();285      crowd.push(...asManyAsCan);286      accountsToCreate -= asManyAsCan.length;287    }288289    if (accountsToCreate !== 0) throw Error(`Crowd generation failed: ${accountsToCreate} accounts left`);290291    return crowd;292  };293294  isDevNode = async () => {295    let blockNumber = (await this.helper.callRpc('api.query.system.number')).toJSON();296    if (blockNumber == 0) {297      await this.helper.wait.newBlocks(1);298      blockNumber = (await this.helper.callRpc('api.query.system.number')).toJSON();299    }300    const block2 = await this.helper.callRpc('api.rpc.chain.getBlock', [await this.helper.callRpc('api.rpc.chain.getBlockHash', [blockNumber])]);301    const block1 = await this.helper.callRpc('api.rpc.chain.getBlock', [await this.helper.callRpc('api.rpc.chain.getBlockHash', [blockNumber - 1])]);302    const findCreationDate = (block: any) => {303      const humanBlock = block.toHuman();304      let date;305      humanBlock.block.extrinsics.forEach((ext: any) => {306        if(ext.method.section === 'timestamp') {307          date = Number(ext.method.args.now.replaceAll(',', ''));308        }309      });310      return date;311    };312    const block1date = await findCreationDate(block1);313    const block2date = await findCreationDate(block2);314    if(block2date! - block1date! < 9000) return true;315  };316317  async calculcateFee(payer: ICrossAccountId, promise: () => Promise<any>): Promise<bigint> {318    const address = payer.Substrate ? payer.Substrate : await this.helper.address.ethToSubstrate(payer.Ethereum!);319    let balance = await this.helper.balance.getSubstrate(address);320321    await promise();322323    balance -= await this.helper.balance.getSubstrate(address);324325    return balance;326  }327328  async calculatePoVInfo(txs: any[]): Promise<IPovInfo> {329    const rawPovInfo = await this.helper.callRpc('api.rpc.povinfo.estimateExtrinsicPoV', [txs]);330331    const kvJson: {[key: string]: string} = {};332333    for (const kv of rawPovInfo.keyValues) {334      kvJson[kv.key.toHex()] = kv.value.toHex();335    }336337    const kvStr = JSON.stringify(kvJson);338339    const chainql = spawnSync(340      'chainql', 341      [342        `--tla-code=data=${kvStr}`,343        '-e', `function(data) cql.dump(cql.chain("${this.helper.getEndpoint()}").latest._meta, data, {omit_empty:true})`,344      ],345    );346347    if (!chainql.stdout) {348      throw Error('unable to get an output from the `chainql`');349    }350351    return {352      proofSize: rawPovInfo.proofSize.toNumber(),353      compactProofSize: rawPovInfo.compactProofSize.toNumber(),354      compressedProofSize: rawPovInfo.compressedProofSize.toNumber(),355      results: rawPovInfo.results,356      kv: JSON.parse(chainql.stdout.toString()),357    };358  }359360  calculatePalletAddress(palletId: any) {361    const address = stringToU8a(('modl' + palletId).padEnd(32, '\0'));362    return encodeAddress(address, this.helper.chain.getChainProperties().ss58Format);363  }364365  makeScheduledIds(num: number): string[] {366    function makeId(slider: number) {367      const scheduledIdSize = 64;368      const hexId = slider.toString(16);369      const prefixSize = scheduledIdSize - hexId.length;370371      const scheduledId = '0x' + '0'.repeat(prefixSize) + hexId;372373      return scheduledId;374    }375376    const ids = [];377    for (let i = 0; i < num; i++) {378      ids.push(makeId(this.scheduledIdSlider));379      this.scheduledIdSlider += 1;380    }381382    return ids;383  }384385  makeScheduledId(): string {386    return (this.makeScheduledIds(1))[0];387  }388389  async captureEvents(eventSection: string, eventMethod: string): Promise<EventCapture> {390    const capture = new EventCapture(this.helper, eventSection, eventMethod);391    await capture.startCapture();392393    return capture;394  }395}396397class MoonbeamAccountGroup {398  helper: MoonbeamHelper;399400  keyring: Keyring;401  _alithAccount: IKeyringPair;402  _baltatharAccount: IKeyringPair;403  _dorothyAccount: IKeyringPair;404405  constructor(helper: MoonbeamHelper) {406    this.helper = helper;407408    this.keyring = new Keyring({type: 'ethereum'});409    const alithPrivateKey = '0x5fb92d6e98884f76de468fa3f6278f8807c48bebc13595d45af5bdc4da702133';410    const baltatharPrivateKey = '0x8075991ce870b93a8870eca0c0f91913d12f47948ca0fd25b49c6fa7cdbeee8b';411    const dorothyPrivateKey = '0x39539ab1876910bbf3a223d84a29e28f1cb4e2e456503e7e91ed39b2e7223d68';412413    this._alithAccount = this.keyring.addFromUri(alithPrivateKey, undefined, 'ethereum');414    this._baltatharAccount = this.keyring.addFromUri(baltatharPrivateKey, undefined, 'ethereum');415    this._dorothyAccount = this.keyring.addFromUri(dorothyPrivateKey, undefined, 'ethereum');416  }417418  alithAccount() {419    return this._alithAccount;420  }421422  baltatharAccount() {423    return this._baltatharAccount;424  }425426  dorothyAccount() {427    return this._dorothyAccount;428  }429430  create() {431    return this.keyring.addFromUri(mnemonicGenerate());432  }433}434435class WaitGroup {436  helper: ChainHelperBase;437438  constructor(helper: ChainHelperBase) {439    this.helper = helper;440  }441442  sleep(milliseconds: number) {443    return new Promise((resolve) => setTimeout(resolve, milliseconds));444  }445446  private async waitWithTimeout(promise: Promise<any>, timeout: number) {447    let isBlock = false;448    promise.then(() => isBlock = true).catch(() => isBlock = true);449    let totalTime = 0;450    const step = 100;451    while(!isBlock) {452      await this.sleep(step);453      totalTime += step;454      if(totalTime >= timeout) throw Error('Blocks production failed');455    }456    return promise;457  }458459  /**460   * Wait for specified number of blocks461   * @param blocksCount number of blocks to wait462   * @returns463   */464  async newBlocks(blocksCount = 1, timeout?: number): Promise<void> {465    timeout = timeout ?? blocksCount * 60_000;466    // eslint-disable-next-line no-async-promise-executor467    const promise = new Promise<void>(async (resolve) => {468      const unsubscribe = await this.helper.getApi().rpc.chain.subscribeNewHeads(() => {469        if (blocksCount > 0) {470          blocksCount--;471        } else {472          unsubscribe();473          resolve();474        }475      });476    });477    await this.waitWithTimeout(promise, timeout);478    return promise;479  }480481  async forParachainBlockNumber(blockNumber: bigint | number, timeout?: number) {482    timeout = timeout ?? 30 * 60 * 1000;483    // eslint-disable-next-line no-async-promise-executor484    const promise = new Promise<void>(async (resolve) => {485      const unsubscribe = await this.helper.getApi().rpc.chain.subscribeNewHeads((data: any) => {486        if (data.number.toNumber() >= blockNumber) {487          unsubscribe();488          resolve();489        }490      });491    });492    await this.waitWithTimeout(promise, timeout);493    return promise;494  }495496  async forRelayBlockNumber(blockNumber: bigint | number, timeout?: number) {497    timeout = timeout ?? 30 * 60 * 1000;498    // eslint-disable-next-line no-async-promise-executor499    const promise = new Promise<void>(async (resolve) => {500      const unsubscribe = await this.helper.getApi().query.parachainSystem.validationData((data: any) => {501        if (data.value.relayParentNumber.toNumber() >= blockNumber) {502          // @ts-ignore503          unsubscribe();504          resolve();505        }506      });507    });508    await this.waitWithTimeout(promise, timeout);509    return promise;510  }511512  noScheduledTasks() {513    const api = this.helper.getApi();514515    // eslint-disable-next-line no-async-promise-executor516    const promise = new Promise<void>(async resolve => {517      const unsubscribe = await api.rpc.chain.subscribeNewHeads(async () => {518        const areThereScheduledTasks = await api.query.scheduler.lookup.entries();519520        if(areThereScheduledTasks.length == 0) {521          unsubscribe();522          resolve();523        }524      });525    });526527    return promise;528  }529530  event(maxBlocksToWait: number, eventSection: string, eventMethod: string) {531    // eslint-disable-next-line no-async-promise-executor532    const promise = new Promise<EventRecord | null>(async (resolve) => {533      const unsubscribe = await this.helper.getApi().rpc.chain.subscribeNewHeads(async header => {534        const blockNumber = header.number.toHuman();535        const blockHash = header.hash;536        const eventIdStr = `${eventSection}.${eventMethod}`;537        const waitLimitStr = `wait blocks remaining: ${maxBlocksToWait}`;538539        this.helper.logger.log(`[Block #${blockNumber}] Waiting for event \`${eventIdStr}\` (${waitLimitStr})`);540541        const apiAt = await this.helper.getApi().at(blockHash);542        const eventRecords = (await apiAt.query.system.events()) as any;543544        const neededEvent = eventRecords.toArray().find((r: FrameSystemEventRecord) => {545          return r.event.section == eventSection && r.event.method == eventMethod;546        });547548        if (neededEvent) {549          unsubscribe();550          resolve(neededEvent);551        } else if (maxBlocksToWait > 0) {552          maxBlocksToWait--;553        } else {554          this.helper.logger.log(`Event \`${eventIdStr}\` is NOT found`);555          unsubscribe();556          resolve(null);557        }558      });559    });560    return promise;561  }562}563564class TestUtilGroup {565  helper: DevUniqueHelper;566567  constructor(helper: DevUniqueHelper) {568    this.helper = helper;569  }570571  async enable() {572    if (this.helper.fetchMissingPalletNames([Pallets.TestUtils]).length != 0) {573      return;574    }575576    const signer = this.helper.util.fromSeed('//Alice');577    await this.helper.getSudo<DevUniqueHelper>().executeExtrinsic(signer, 'api.tx.testUtils.enable', [], true);578  }579580  async setTestValue(signer: TSigner, testVal: number) {581    await this.helper.executeExtrinsic(signer, 'api.tx.testUtils.setTestValue', [testVal], true);582  }583584  async incTestValue(signer: TSigner) {585    await this.helper.executeExtrinsic(signer, 'api.tx.testUtils.incTestValue', [], true);586  }587588  async setTestValueAndRollback(signer: TSigner, testVal: number) {589    await this.helper.executeExtrinsic(signer, 'api.tx.testUtils.setTestValueAndRollback', [testVal], true);590  }591592  async testValue(blockIdx?: number) {593    const api = blockIdx594      ? await this.helper.getApi().at(await this.helper.callRpc('api.rpc.chain.getBlockHash', [blockIdx]))595      : this.helper.getApi();596597    return (await api.query.testUtils.testValue()).toJSON();598  }599600  async justTakeFee(signer: TSigner) {601    await this.helper.executeExtrinsic(signer, 'api.tx.testUtils.justTakeFee', [], true);602  }603604  async selfCancelingInc(signer: TSigner, scheduledId: string, maxTestVal: number) {605    await this.helper.executeExtrinsic(signer, 'api.tx.testUtils.selfCancelingInc', [scheduledId, maxTestVal], true);606  }607}608609class EventCapture {610  helper: DevUniqueHelper;611  eventSection: string;612  eventMethod: string;613  events: EventRecord[] = [];614  unsubscribe: VoidFn | null = null;615616  constructor(617    helper: DevUniqueHelper,618    eventSection: string,619    eventMethod: string,620  ) {621    this.helper = helper;622    this.eventSection = eventSection;623    this.eventMethod = eventMethod;624  }625626  async startCapture() {627    this.stopCapture();628    this.unsubscribe = (await this.helper.getApi().query.system.events((eventRecords: FrameSystemEventRecord[]) => {629      const newEvents = eventRecords.filter(r => {630        return r.event.section == this.eventSection && r.event.method == this.eventMethod;631      });632633      this.events.push(...newEvents);634    })) as any;635  }636637  stopCapture() {638    if (this.unsubscribe !== null) {639      this.unsubscribe();640    }641  }642643  extractCapturedEvents() {644    return this.events;645  }646}647648class AdminGroup {649  helper: UniqueHelper;650651  constructor(helper: UniqueHelper) {652    this.helper = helper;653  }654655  async payoutStakers(signer: IKeyringPair, stakersToPayout: number) {656    const payoutResult = await this.helper.executeExtrinsic(signer, 'api.tx.appPromotion.payoutStakers', [stakersToPayout], true);657    return payoutResult.result.events.filter(e => e.event.method === 'StakingRecalculation').map(e => {658      return {659        staker: e.event.data[0].toString(),660        stake: e.event.data[1].toBigInt(),661        payout: e.event.data[2].toBigInt(),662      };663    });664  }665}