git.delta.rocks / unique-network / refs/commits / 52ec20b9c55b

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        rmrk: defs.rmrk.rpc,103        eth: {104          feeHistory: {105            description: 'Dummy',106            params: [],107            type: 'u8',108          },109          maxPriorityFeePerGas: {110            description: 'Dummy',111            params: [],112            type: 'u8',113          },114        },115      },116    });117    await this.api.isReadyOrError;118    this.network = await UniqueHelper.detectNetwork(this.api);119  }120}121122export class DevRelayHelper extends RelayHelper {123  wait: WaitGroup;124125  constructor(logger: { log: (msg: any, level: any) => void, level: any }, options: {[key: string]: any} = {}) {126    options.helperBase = options.helperBase ?? DevRelayHelper;127128    super(logger, options);129    this.wait = new WaitGroup(this);130  }131}132133export class DevWestmintHelper extends WestmintHelper {134  wait: WaitGroup;135136  constructor(logger: { log: (msg: any, level: any) => void, level: any }, options: {[key: string]: any} = {}) {137    options.helperBase = options.helperBase ?? DevWestmintHelper;138139    super(logger, options);140    this.wait = new WaitGroup(this);141  }142}143144export class DevStatemineHelper extends DevWestmintHelper {}145146export class DevStatemintHelper extends DevWestmintHelper {}147148export class DevMoonbeamHelper extends MoonbeamHelper {149  account: MoonbeamAccountGroup;150  wait: WaitGroup;151152  constructor(logger: { log: (msg: any, level: any) => void, level: any }, options: {[key: string]: any} = {}) {153    options.helperBase = options.helperBase ?? DevMoonbeamHelper;154    options.notePreimagePallet = options.notePreimagePallet ?? 'democracy';155156    super(logger, options);157    this.account = new MoonbeamAccountGroup(this);158    this.wait = new WaitGroup(this);159  }160}161162export class DevMoonriverHelper extends DevMoonbeamHelper {163  constructor(logger: { log: (msg: any, level: any) => void, level: any }, options: {[key: string]: any} = {}) {164    options.notePreimagePallet = options.notePreimagePallet ?? 'preimage';165    super(logger, options);166  }167}168169export class DevAcalaHelper extends AcalaHelper {170  wait: WaitGroup;171172  constructor(logger: { log: (msg: any, level: any) => void, level: any }, options: {[key: string]: any} = {}) {173    options.helperBase = options.helperBase ?? DevAcalaHelper;174175    super(logger, options);176    this.wait = new WaitGroup(this);177  }178}179180export class DevKaruraHelper extends DevAcalaHelper {}181182class ArrangeGroup {183  helper: DevUniqueHelper;184185  scheduledIdSlider = 0;186187  constructor(helper: DevUniqueHelper) {188    this.helper = helper;189  }190191  /**192   * Generates accounts with the specified UNQ token balance193   * @param balances balances for generated accounts. Each balance will be multiplied by the token nominal.194   * @param donor donor account for balances195   * @returns array of newly created accounts196   * @example const [acc1, acc2, acc3] = await createAccounts([0n, 10n, 20n], donor);197   */198  createAccounts = async (balances: bigint[], donor: IKeyringPair): Promise<IKeyringPair[]> => {199    let nonce = await this.helper.chain.getNonce(donor.address);200    const wait = new WaitGroup(this.helper);201    const ss58Format = this.helper.chain.getChainProperties().ss58Format;202    const tokenNominal = this.helper.balance.getOneTokenNominal();203    const transactions = [];204    const accounts: IKeyringPair[] = [];205    for (const balance of balances) {206      const recipient = this.helper.util.fromSeed(mnemonicGenerate(), ss58Format);207      accounts.push(recipient);208      if (balance !== 0n) {209        const tx = this.helper.constructApiCall('api.tx.balances.transfer', [{Id: recipient.address}, balance * tokenNominal]);210        transactions.push(this.helper.signTransaction(donor, tx, {nonce}, 'account generation'));211        nonce++;212      }213    }214215    await Promise.all(transactions).catch(_e => {});216217    //#region TODO remove this region, when nonce problem will be solved218    const checkBalances = async () => {219      let isSuccess = true;220      for (let i = 0; i < balances.length; i++) {221        const balance = await this.helper.balance.getSubstrate(accounts[i].address);222        if (balance !== balances[i] * tokenNominal) {223          isSuccess = false;224          break;225        }226      }227      return isSuccess;228    };229230    let accountsCreated = false;231    const maxBlocksChecked = await this.helper.arrange.isDevNode() ? 50 : 5;232    // checkBalances retry up to 5-50 blocks233    for (let index = 0; index < maxBlocksChecked; index++) {234      accountsCreated = await checkBalances();235      if(accountsCreated) break;236      await wait.newBlocks(1);237    }238239    if (!accountsCreated) throw Error('Accounts generation failed');240    //#endregion241242    return accounts;243  };244245  // TODO combine this method and createAccounts into one246  createCrowd = async (accountsToCreate: number, withBalance: bigint, donor: IKeyringPair): Promise<IKeyringPair[]> => {247    const createAsManyAsCan = async () => {248      let transactions: any = [];249      const accounts: IKeyringPair[] = [];250      let nonce = await this.helper.chain.getNonce(donor.address);251      const tokenNominal = this.helper.balance.getOneTokenNominal();252      for (let i = 0; i < accountsToCreate; i++) {253        if (i === 500) { // if there are too many accounts to create254          await Promise.allSettled(transactions); // wait while first 500 (should be 100 for devnode) tx will be settled255          transactions = []; //256          nonce = await this.helper.chain.getNonce(donor.address); // update nonce257        }258        const recepient = this.helper.util.fromSeed(mnemonicGenerate());259        accounts.push(recepient);260        if (withBalance !== 0n) {261          const tx = this.helper.constructApiCall('api.tx.balances.transfer', [{Id: recepient.address}, withBalance * tokenNominal]);262          transactions.push(this.helper.signTransaction(donor, tx, {nonce}, 'account generation'));263          nonce++;264        }265      }266267      const fullfilledAccounts = [];268      await Promise.allSettled(transactions);269      for (const account of accounts) {270        const accountBalance = await this.helper.balance.getSubstrate(account.address);271        if (accountBalance === withBalance * tokenNominal) {272          fullfilledAccounts.push(account);273        }274      }275      return fullfilledAccounts;276    };277278279    const crowd: IKeyringPair[] = [];280    // do up to 5 retries281    for (let index = 0; index < 5 && accountsToCreate !== 0; index++) {282      const asManyAsCan = await createAsManyAsCan();283      crowd.push(...asManyAsCan);284      accountsToCreate -= asManyAsCan.length;285    }286287    if (accountsToCreate !== 0) throw Error(`Crowd generation failed: ${accountsToCreate} accounts left`);288289    return crowd;290  };291292  isDevNode = async () => {293    let blockNumber = (await this.helper.callRpc('api.query.system.number')).toJSON();294    if (blockNumber == 0) {295      await this.helper.wait.newBlocks(1);296      blockNumber = (await this.helper.callRpc('api.query.system.number')).toJSON();297    }298    const block2 = await this.helper.callRpc('api.rpc.chain.getBlock', [await this.helper.callRpc('api.rpc.chain.getBlockHash', [blockNumber])]);299    const block1 = await this.helper.callRpc('api.rpc.chain.getBlock', [await this.helper.callRpc('api.rpc.chain.getBlockHash', [blockNumber - 1])]);300    const findCreationDate = (block: any) => {301      const humanBlock = block.toHuman();302      let date;303      humanBlock.block.extrinsics.forEach((ext: any) => {304        if(ext.method.section === 'timestamp') {305          date = Number(ext.method.args.now.replaceAll(',', ''));306        }307      });308      return date;309    };310    const block1date = await findCreationDate(block1);311    const block2date = await findCreationDate(block2);312    if(block2date! - block1date! < 9000) return true;313  };314315  async calculcateFee(payer: ICrossAccountId, promise: () => Promise<any>): Promise<bigint> {316    const address = payer.Substrate ? payer.Substrate : await this.helper.address.ethToSubstrate(payer.Ethereum!);317    let balance = await this.helper.balance.getSubstrate(address);318319    await promise();320321    balance -= await this.helper.balance.getSubstrate(address);322323    return balance;324  }325326  async calculatePoVInfo(txs: any[]): Promise<IPovInfo> {327    const rawPovInfo = await this.helper.callRpc('api.rpc.unique.estimateExtrinsicPoV', [txs]);328329    const kvJson: {[key: string]: string} = {};330331    for (const kv of rawPovInfo.keyValues) {332      kvJson[kv.key.toHex()] = kv.value.toHex();333    }334335    const kvStr = JSON.stringify(kvJson);336337    const chainql = spawnSync(338      'chainql', 339      [340        `--tla-code=data=${kvStr}`,341        '-e', 'function(data) cql.dump(cql.chain("wss://ws-opal.unique.network:443").latest._meta, data, {omit_empty:true})',342      ],343    );344345    return {346      proofSize: rawPovInfo.proofSize.toNumber(),347      compactProofSize: rawPovInfo.compactProofSize.toNumber(),348      compressedProofSize: rawPovInfo.compressedProofSize.toNumber(),349      results: rawPovInfo.results,350      kv: JSON.parse(chainql.stdout.toString()),351    };352  }353354  calculatePalletAddress(palletId: any) {355    const address = stringToU8a(('modl' + palletId).padEnd(32, '\0'));356    return encodeAddress(address, this.helper.chain.getChainProperties().ss58Format);357  }358359  makeScheduledIds(num: number): string[] {360    function makeId(slider: number) {361      const scheduledIdSize = 64;362      const hexId = slider.toString(16);363      const prefixSize = scheduledIdSize - hexId.length;364365      const scheduledId = '0x' + '0'.repeat(prefixSize) + hexId;366367      return scheduledId;368    }369370    const ids = [];371    for (let i = 0; i < num; i++) {372      ids.push(makeId(this.scheduledIdSlider));373      this.scheduledIdSlider += 1;374    }375376    return ids;377  }378379  makeScheduledId(): string {380    return (this.makeScheduledIds(1))[0];381  }382383  async captureEvents(eventSection: string, eventMethod: string): Promise<EventCapture> {384    const capture = new EventCapture(this.helper, eventSection, eventMethod);385    await capture.startCapture();386387    return capture;388  }389}390391class MoonbeamAccountGroup {392  helper: MoonbeamHelper;393394  keyring: Keyring;395  _alithAccount: IKeyringPair;396  _baltatharAccount: IKeyringPair;397  _dorothyAccount: IKeyringPair;398399  constructor(helper: MoonbeamHelper) {400    this.helper = helper;401402    this.keyring = new Keyring({type: 'ethereum'});403    const alithPrivateKey = '0x5fb92d6e98884f76de468fa3f6278f8807c48bebc13595d45af5bdc4da702133';404    const baltatharPrivateKey = '0x8075991ce870b93a8870eca0c0f91913d12f47948ca0fd25b49c6fa7cdbeee8b';405    const dorothyPrivateKey = '0x39539ab1876910bbf3a223d84a29e28f1cb4e2e456503e7e91ed39b2e7223d68';406407    this._alithAccount = this.keyring.addFromUri(alithPrivateKey, undefined, 'ethereum');408    this._baltatharAccount = this.keyring.addFromUri(baltatharPrivateKey, undefined, 'ethereum');409    this._dorothyAccount = this.keyring.addFromUri(dorothyPrivateKey, undefined, 'ethereum');410  }411412  alithAccount() {413    return this._alithAccount;414  }415416  baltatharAccount() {417    return this._baltatharAccount;418  }419420  dorothyAccount() {421    return this._dorothyAccount;422  }423424  create() {425    return this.keyring.addFromUri(mnemonicGenerate());426  }427}428429class WaitGroup {430  helper: ChainHelperBase;431432  constructor(helper: ChainHelperBase) {433    this.helper = helper;434  }435436  sleep(milliseconds: number) {437    return new Promise((resolve) => setTimeout(resolve, milliseconds));438  }439440  private async waitWithTimeout(promise: Promise<any>, timeout: number) {441    let isBlock = false;442    promise.then(() => isBlock = true).catch(() => isBlock = true);443    let totalTime = 0;444    const step = 100;445    while(!isBlock) {446      await this.sleep(step);447      totalTime += step;448      if(totalTime >= timeout) throw Error('Blocks production failed');449    }450    return promise;451  }452453  /**454   * Wait for specified number of blocks455   * @param blocksCount number of blocks to wait456   * @returns457   */458  async newBlocks(blocksCount = 1, timeout?: number): Promise<void> {459    timeout = timeout ?? blocksCount * 60_000;460    // eslint-disable-next-line no-async-promise-executor461    const promise = new Promise<void>(async (resolve) => {462      const unsubscribe = await this.helper.getApi().rpc.chain.subscribeNewHeads(() => {463        if (blocksCount > 0) {464          blocksCount--;465        } else {466          unsubscribe();467          resolve();468        }469      });470    });471    await this.waitWithTimeout(promise, timeout);472    return promise;473  }474475  async forParachainBlockNumber(blockNumber: bigint | number, timeout?: number) {476    timeout = timeout ?? 30 * 60 * 1000;477    // eslint-disable-next-line no-async-promise-executor478    const promise = new Promise<void>(async (resolve) => {479      const unsubscribe = await this.helper.getApi().rpc.chain.subscribeNewHeads((data: any) => {480        if (data.number.toNumber() >= blockNumber) {481          unsubscribe();482          resolve();483        }484      });485    });486    await this.waitWithTimeout(promise, timeout);487    return promise;488  }489490  async forRelayBlockNumber(blockNumber: bigint | number, timeout?: number) {491    timeout = timeout ?? 30 * 60 * 1000;492    // eslint-disable-next-line no-async-promise-executor493    const promise = new Promise<void>(async (resolve) => {494      const unsubscribe = await this.helper.getApi().query.parachainSystem.validationData((data: any) => {495        if (data.value.relayParentNumber.toNumber() >= blockNumber) {496          // @ts-ignore497          unsubscribe();498          resolve();499        }500      });501    });502    await this.waitWithTimeout(promise, timeout);503    return promise;504  }505506  noScheduledTasks() {507    const api = this.helper.getApi();508509    // eslint-disable-next-line no-async-promise-executor510    const promise = new Promise<void>(async resolve => {511      const unsubscribe = await api.rpc.chain.subscribeNewHeads(async () => {512        const areThereScheduledTasks = await api.query.scheduler.lookup.entries();513514        if(areThereScheduledTasks.length == 0) {515          unsubscribe();516          resolve();517        }518      });519    });520521    return promise;522  }523524  event(maxBlocksToWait: number, eventSection: string, eventMethod: string) {525    // eslint-disable-next-line no-async-promise-executor526    const promise = new Promise<EventRecord | null>(async (resolve) => {527      const unsubscribe = await this.helper.getApi().rpc.chain.subscribeNewHeads(async header => {528        const blockNumber = header.number.toHuman();529        const blockHash = header.hash;530        const eventIdStr = `${eventSection}.${eventMethod}`;531        const waitLimitStr = `wait blocks remaining: ${maxBlocksToWait}`;532533        this.helper.logger.log(`[Block #${blockNumber}] Waiting for event \`${eventIdStr}\` (${waitLimitStr})`);534535        const apiAt = await this.helper.getApi().at(blockHash);536        const eventRecords = (await apiAt.query.system.events()) as any;537538        const neededEvent = eventRecords.toArray().find((r: FrameSystemEventRecord) => {539          return r.event.section == eventSection && r.event.method == eventMethod;540        });541542        if (neededEvent) {543          unsubscribe();544          resolve(neededEvent);545        } else if (maxBlocksToWait > 0) {546          maxBlocksToWait--;547        } else {548          this.helper.logger.log(`Event \`${eventIdStr}\` is NOT found`);549          unsubscribe();550          resolve(null);551        }552      });553    });554    return promise;555  }556}557558class TestUtilGroup {559  helper: DevUniqueHelper;560561  constructor(helper: DevUniqueHelper) {562    this.helper = helper;563  }564565  async enable() {566    if (this.helper.fetchMissingPalletNames([Pallets.TestUtils]).length != 0) {567      return;568    }569570    const signer = this.helper.util.fromSeed('//Alice');571    await this.helper.getSudo<DevUniqueHelper>().executeExtrinsic(signer, 'api.tx.testUtils.enable', [], true);572  }573574  async setTestValue(signer: TSigner, testVal: number) {575    await this.helper.executeExtrinsic(signer, 'api.tx.testUtils.setTestValue', [testVal], true);576  }577578  async incTestValue(signer: TSigner) {579    await this.helper.executeExtrinsic(signer, 'api.tx.testUtils.incTestValue', [], true);580  }581582  async setTestValueAndRollback(signer: TSigner, testVal: number) {583    await this.helper.executeExtrinsic(signer, 'api.tx.testUtils.setTestValueAndRollback', [testVal], true);584  }585586  async testValue(blockIdx?: number) {587    const api = blockIdx588      ? await this.helper.getApi().at(await this.helper.callRpc('api.rpc.chain.getBlockHash', [blockIdx]))589      : this.helper.getApi();590591    return (await api.query.testUtils.testValue()).toJSON();592  }593594  async justTakeFee(signer: TSigner) {595    await this.helper.executeExtrinsic(signer, 'api.tx.testUtils.justTakeFee', [], true);596  }597598  async selfCancelingInc(signer: TSigner, scheduledId: string, maxTestVal: number) {599    await this.helper.executeExtrinsic(signer, 'api.tx.testUtils.selfCancelingInc', [scheduledId, maxTestVal], true);600  }601}602603class EventCapture {604  helper: DevUniqueHelper;605  eventSection: string;606  eventMethod: string;607  events: EventRecord[] = [];608  unsubscribe: VoidFn | null = null;609610  constructor(611    helper: DevUniqueHelper,612    eventSection: string,613    eventMethod: string,614  ) {615    this.helper = helper;616    this.eventSection = eventSection;617    this.eventMethod = eventMethod;618  }619620  async startCapture() {621    this.stopCapture();622    this.unsubscribe = (await this.helper.getApi().query.system.events((eventRecords: FrameSystemEventRecord[]) => {623      const newEvents = eventRecords.filter(r => {624        return r.event.section == this.eventSection && r.event.method == this.eventMethod;625      });626627      this.events.push(...newEvents);628    })) as any;629  }630631  stopCapture() {632    if (this.unsubscribe !== null) {633      this.unsubscribe();634    }635  }636637  extractCapturedEvents() {638    return this.events;639  }640}641642class AdminGroup {643  helper: UniqueHelper;644645  constructor(helper: UniqueHelper) {646    this.helper = helper;647  }648649  async payoutStakers(signer: IKeyringPair, stakersToPayout: number) {650    const payoutResult = await this.helper.executeExtrinsic(signer, 'api.tx.appPromotion.payoutStakers', [stakersToPayout], true);651    return payoutResult.result.events.filter(e => e.event.method === 'StakingRecalculation').map(e => {652      return {653        staker: e.event.data[0].toString(),654        stake: e.event.data[1].toBigInt(),655        payout: e.event.data[2].toBigInt(),656      };657    });658  }659}