git.delta.rocks / unique-network / refs/commits / 4ce643d7d57f

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';13import {VoidFn} from '@polkadot/api/types';14import {FrameSystemEventRecord} from '@polkadot/types/lookup';1516export class SilentLogger {17  log(_msg: any, _level: any): void { }18  level = {19    ERROR: 'ERROR' as const,20    WARNING: 'WARNING' as const,21    INFO: 'INFO' as const,22  };23}2425export class SilentConsole {26  // TODO: Remove, this is temporary: Filter unneeded API output27  // (Jaco promised it will be removed in the next version)28  consoleErr: any;29  consoleLog: any;30  consoleWarn: any;3132  constructor() {33    this.consoleErr = console.error;34    this.consoleLog = console.log;35    this.consoleWarn = console.warn;36  }3738  enable() {  39    const outFn = (printer: any) => (...args: any[]) => {40      for (const arg of args) {41        if (typeof arg !== 'string')42          continue;43        if (arg.includes('1000:: Normal connection closure') || arg.includes('Not decorating unknown runtime apis:') || arg.includes('RPC methods not decorated:') || arg === 'Normal connection closure')44          return;45      }46      printer(...args);47    };48  49    console.error = outFn(this.consoleErr.bind(console));50    console.log = outFn(this.consoleLog.bind(console));51    console.warn = outFn(this.consoleWarn.bind(console));52  }5354  disable() {55    console.error = this.consoleErr;56    console.log = this.consoleLog;57    console.warn = this.consoleWarn;58  }59}6061export class DevUniqueHelper extends UniqueHelper {62  /**63   * Arrange methods for tests64   */65  arrange: ArrangeGroup;66  wait: WaitGroup;67  admin: AdminGroup;6869  constructor(logger: { log: (msg: any, level: any) => void, level: any }, options: {[key: string]: any} = {}) {70    options.helperBase = options.helperBase ?? DevUniqueHelper;7172    super(logger, options);73    this.arrange = new ArrangeGroup(this);74    this.wait = new WaitGroup(this);75    this.admin = new AdminGroup(this);76  }7778  async connect(wsEndpoint: string, _listeners?: any): Promise<void> {79    const wsProvider = new WsProvider(wsEndpoint);80    this.api = new ApiPromise({81      provider: wsProvider,82      signedExtensions: {83        ContractHelpers: {84          extrinsic: {},85          payload: {},86        },87        FakeTransactionFinalizer: {88          extrinsic: {},89          payload: {},90        },91      },92      rpc: {93        unique: defs.unique.rpc,94        appPromotion: defs.appPromotion.rpc,95        rmrk: defs.rmrk.rpc,96        eth: {97          feeHistory: {98            description: 'Dummy',99            params: [],100            type: 'u8',101          },102          maxPriorityFeePerGas: {103            description: 'Dummy',104            params: [],105            type: 'u8',106          },107        },108      },109    });110    await this.api.isReadyOrError;111    this.network = await UniqueHelper.detectNetwork(this.api);112  }113}114115export class DevRelayHelper extends RelayHelper {}116117export class DevWestmintHelper extends WestmintHelper {118  wait: WaitGroup;119120  constructor(logger: { log: (msg: any, level: any) => void, level: any }, options: {[key: string]: any} = {}) {121    options.helperBase = options.helperBase ?? DevWestmintHelper;122123    super(logger, options);124    this.wait = new WaitGroup(this);125  }126}127128export class DevMoonbeamHelper extends MoonbeamHelper {129  account: MoonbeamAccountGroup;130  wait: WaitGroup;131132  constructor(logger: { log: (msg: any, level: any) => void, level: any }, options: {[key: string]: any} = {}) {133    options.helperBase = options.helperBase ?? DevMoonbeamHelper;134135    super(logger, options);136    this.account = new MoonbeamAccountGroup(this);137    this.wait = new WaitGroup(this);138  }139}140141export class DevMoonriverHelper extends DevMoonbeamHelper {}142143export class DevAcalaHelper extends AcalaHelper {144  wait: WaitGroup;145146  constructor(logger: { log: (msg: any, level: any) => void, level: any }, options: {[key: string]: any} = {}) {147    options.helperBase = options.helperBase ?? DevAcalaHelper;148149    super(logger, options);150    this.wait = new WaitGroup(this);151  }152}153154export class DevKaruraHelper extends DevAcalaHelper {}155156class ArrangeGroup {157  helper: DevUniqueHelper;158159  scheduledIdSlider = 0;160161  constructor(helper: DevUniqueHelper) {162    this.helper = helper;163  }164165  /**166   * Generates accounts with the specified UNQ token balance 167   * @param balances balances for generated accounts. Each balance will be multiplied by the token nominal.168   * @param donor donor account for balances169   * @returns array of newly created accounts170   * @example const [acc1, acc2, acc3] = await createAccounts([0n, 10n, 20n], donor); 171   */172  createAccounts = async (balances: bigint[], donor: IKeyringPair): Promise<IKeyringPair[]> => {173    let nonce = await this.helper.chain.getNonce(donor.address);174    const wait = new WaitGroup(this.helper);175    const ss58Format = this.helper.chain.getChainProperties().ss58Format;176    const tokenNominal = this.helper.balance.getOneTokenNominal();177    const transactions = [];178    const accounts: IKeyringPair[] = [];179    for (const balance of balances) {180      const recipient = this.helper.util.fromSeed(mnemonicGenerate(), ss58Format);181      accounts.push(recipient);182      if (balance !== 0n) {183        const tx = this.helper.constructApiCall('api.tx.balances.transfer', [{Id: recipient.address}, balance * tokenNominal]);184        transactions.push(this.helper.signTransaction(donor, tx, {nonce}, 'account generation'));185        nonce++;186      }187    }188189    await Promise.all(transactions).catch(_e => {});190    191    //#region TODO remove this region, when nonce problem will be solved192    const checkBalances = async () => {193      let isSuccess = true;194      for (let i = 0; i < balances.length; i++) {195        const balance = await this.helper.balance.getSubstrate(accounts[i].address);196        if (balance !== balances[i] * tokenNominal) {197          isSuccess = false;198          break;199        }200      }201      return isSuccess;202    };203204    let accountsCreated = false;205    const maxBlocksChecked = await this.helper.arrange.isDevNode() ? 50 : 5;206    // checkBalances retry up to 5-50 blocks207    for (let index = 0; index < maxBlocksChecked; index++) {208      accountsCreated = await checkBalances();209      if(accountsCreated) break;210      await wait.newBlocks(1);211    }212213    if (!accountsCreated) throw Error('Accounts generation failed');214    //#endregion215216    return accounts;217  };218219  // TODO combine this method and createAccounts into one220  createCrowd = async (accountsToCreate: number, withBalance: bigint, donor: IKeyringPair): Promise<IKeyringPair[]> => {  221    const createAsManyAsCan = async () => {222      let transactions: any = [];223      const accounts: IKeyringPair[] = [];224      let nonce = await this.helper.chain.getNonce(donor.address);225      const tokenNominal = this.helper.balance.getOneTokenNominal();226      for (let i = 0; i < accountsToCreate; i++) {227        if (i === 500) { // if there are too many accounts to create228          await Promise.allSettled(transactions); // wait while first 500 (should be 100 for devnode) tx will be settled 229          transactions = []; //230          nonce = await this.helper.chain.getNonce(donor.address); // update nonce 231        }232        const recepient = this.helper.util.fromSeed(mnemonicGenerate());233        accounts.push(recepient);234        if (withBalance !== 0n) {235          const tx = this.helper.constructApiCall('api.tx.balances.transfer', [{Id: recepient.address}, withBalance * tokenNominal]);236          transactions.push(this.helper.signTransaction(donor, tx, {nonce}, 'account generation'));237          nonce++;238        }239      }240      241      const fullfilledAccounts = [];242      await Promise.allSettled(transactions);243      for (const account of accounts) {244        const accountBalance = await this.helper.balance.getSubstrate(account.address);245        if (accountBalance === withBalance * tokenNominal) {246          fullfilledAccounts.push(account);247        }248      }249      return fullfilledAccounts;250    };251252    253    const crowd: IKeyringPair[] = [];254    // do up to 5 retries255    for (let index = 0; index < 5 && accountsToCreate !== 0; index++) {256      const asManyAsCan = await createAsManyAsCan();257      crowd.push(...asManyAsCan);258      accountsToCreate -= asManyAsCan.length;259    }260261    if (accountsToCreate !== 0) throw Error(`Crowd generation failed: ${accountsToCreate} accounts left`);262263    return crowd;264  };265266  isDevNode = async () => {267    let blockNumber = (await this.helper.callRpc('api.query.system.number')).toJSON();268    if (blockNumber == 0) {269      await this.helper.wait.newBlocks(1); 270      blockNumber = (await this.helper.callRpc('api.query.system.number')).toJSON();271    }272    const block2 = await this.helper.callRpc('api.rpc.chain.getBlock', [await this.helper.callRpc('api.rpc.chain.getBlockHash', [blockNumber])]);273    const block1 = await this.helper.callRpc('api.rpc.chain.getBlock', [await this.helper.callRpc('api.rpc.chain.getBlockHash', [blockNumber - 1])]);274    const findCreationDate = async (block: any) => {275      const humanBlock = block.toHuman();276      let date;277      humanBlock.block.extrinsics.forEach((ext: any) => {278        if(ext.method.section === 'timestamp') {279          date = Number(ext.method.args.now.replaceAll(',', ''));280        }281      });282      return date;283    };284    const block1date = await findCreationDate(block1);285    const block2date = await findCreationDate(block2);286    if(block2date! - block1date! < 9000) return true;287  };288  289  async calculcateFee(payer: ICrossAccountId, promise: () => Promise<any>): Promise<bigint> {290    const address = payer.Substrate ? payer.Substrate : await this.helper.address.ethToSubstrate(payer.Ethereum!);291    let balance = await this.helper.balance.getSubstrate(address); 292    293    await promise();294    295    balance -= await this.helper.balance.getSubstrate(address);296    297    return balance;298  }299300  calculatePalletAddress(palletId: any) {301    const address = stringToU8a(('modl' + palletId).padEnd(32, '\0'));302    return encodeAddress(address);303  }304305  async makeScheduledIds(num: number): Promise<string[]> {306    await this.helper.wait.noScheduledTasks();307308    function makeId(slider: number) {309      const scheduledIdSize = 32;310      const hexId = slider.toString(16);311      const prefixSize = scheduledIdSize - hexId.length;312313      const scheduledId = '0x' + '0'.repeat(prefixSize) + hexId;314315      return scheduledId;  316    }317318    const ids = [];319    for (let i = 0; i < num; i++) {320      ids.push(makeId(this.scheduledIdSlider));321      this.scheduledIdSlider += 1;322    }323324    return ids;325  }326327  async makeScheduledId(): Promise<string> {328    return (await this.makeScheduledIds(1))[0];329  }330331  async captureEvents(eventSection: string, eventMethod: string): Promise<EventCapture> {332    const capture = new EventCapture(this.helper, eventSection, eventMethod);333    await capture.startCapture();334335    return capture;336  }337}338339class MoonbeamAccountGroup {340  helper: MoonbeamHelper;341342  keyring: Keyring;343  _alithAccount: IKeyringPair;344  _baltatharAccount: IKeyringPair;345  _dorothyAccount: IKeyringPair;346347  constructor(helper: MoonbeamHelper) {348    this.helper = helper;349350    this.keyring = new Keyring({type: 'ethereum'});351    const alithPrivateKey = '0x5fb92d6e98884f76de468fa3f6278f8807c48bebc13595d45af5bdc4da702133';352    const baltatharPrivateKey = '0x8075991ce870b93a8870eca0c0f91913d12f47948ca0fd25b49c6fa7cdbeee8b';353    const dorothyPrivateKey = '0x39539ab1876910bbf3a223d84a29e28f1cb4e2e456503e7e91ed39b2e7223d68';354355    this._alithAccount = this.keyring.addFromUri(alithPrivateKey, undefined, 'ethereum');356    this._baltatharAccount = this.keyring.addFromUri(baltatharPrivateKey, undefined, 'ethereum');357    this._dorothyAccount = this.keyring.addFromUri(dorothyPrivateKey, undefined, 'ethereum');358  }359360  alithAccount() {361    return this._alithAccount;362  }363364  baltatharAccount() {365    return this._baltatharAccount;366  }367368  dorothyAccount() {369    return this._dorothyAccount;370  }371372  create() {373    return this.keyring.addFromUri(mnemonicGenerate());374  }375}376377class WaitGroup {378  helper: ChainHelperBase;379380  constructor(helper: ChainHelperBase) {381    this.helper = helper;382  }383384  /**385   * Wait for specified number of blocks386   * @param blocksCount number of blocks to wait387   * @returns 388   */389  async newBlocks(blocksCount = 1): Promise<void> {390    // eslint-disable-next-line no-async-promise-executor391    const promise = new Promise<void>(async (resolve) => {392      const unsubscribe = await this.helper.getApi().rpc.chain.subscribeNewHeads(() => {393        if (blocksCount > 0) {394          blocksCount--;395        } else {396          unsubscribe();397          resolve();398        }399      });400    });401    return promise;402  }403404  async forParachainBlockNumber(blockNumber: bigint) {405    // eslint-disable-next-line no-async-promise-executor406    return new Promise<void>(async (resolve) => {407      const unsubscribe = await this.helper.getApi().rpc.chain.subscribeNewHeads(async (data: any) => {408        if (data.number.toNumber() >= blockNumber) {409          unsubscribe();410          resolve();411        }412      });413    });414  }415  416  async forRelayBlockNumber(blockNumber: bigint) {417    // eslint-disable-next-line no-async-promise-executor418    return new Promise<void>(async (resolve) => {419      const unsubscribe = await this.helper.getApi().query.parachainSystem.validationData(async (data: any) => {420        if (data.value.relayParentNumber.toNumber() >= blockNumber) {421          // @ts-ignore422          unsubscribe();423          resolve();424        }425      });426    });427  }428429  async noScheduledTasks() {430    const api = this.helper.getApi();431    432    // eslint-disable-next-line no-async-promise-executor433    const promise = new Promise<void>(async resolve => {434      const unsubscribe = await api.rpc.chain.subscribeNewHeads(async () => {435        const areThereScheduledTasks = await api.query.scheduler.lookup.entries();436437        if(areThereScheduledTasks.length == 0) {438          unsubscribe();439          resolve();440        }441      }); 442    });443444    return promise;445  }446447  async event(maxBlocksToWait: number, eventSection: string, eventMethod: string) {448    // eslint-disable-next-line no-async-promise-executor449    const promise = new Promise<EventRecord | null>(async (resolve) => {450      const unsubscribe = await this.helper.getApi().rpc.chain.subscribeNewHeads(async header => {451        const blockNumber = header.number.toHuman();452        const blockHash = header.hash;453        const eventIdStr = `${eventSection}.${eventMethod}`;454        const waitLimitStr = `wait blocks remaining: ${maxBlocksToWait}`;455  456        this.helper.logger.log(`[Block #${blockNumber}] Waiting for event \`${eventIdStr}\` (${waitLimitStr})`);457  458        const apiAt = await this.helper.getApi().at(blockHash);459        const eventRecords = (await apiAt.query.system.events()) as any;460  461        const neededEvent = eventRecords.toArray().find((r: FrameSystemEventRecord) => {462          return r.event.section == eventSection && r.event.method == eventMethod;463        });464  465        if (neededEvent) {466          unsubscribe();467          resolve(neededEvent);468        } else if (maxBlocksToWait > 0) {469          maxBlocksToWait--;470        } else {471          this.helper.logger.log(`Event \`${eventIdStr}\` is NOT found`);472          unsubscribe();473          resolve(null);474        }475      });476    });477    return promise;478  }479}480481class EventCapture {482  helper: DevUniqueHelper;483  eventSection: string;484  eventMethod: string;485  events: EventRecord[] = [];486  unsubscribe: VoidFn | null = null;487488  constructor(489    helper: DevUniqueHelper,490    eventSection: string,491    eventMethod: string,492  ) {493    this.helper = helper;494    this.eventSection = eventSection;495    this.eventMethod = eventMethod;496  }497498  async startCapture() {499    this.stopCapture();500    this.unsubscribe = (await this.helper.getApi().query.system.events((eventRecords: FrameSystemEventRecord[]) => {501      const newEvents = eventRecords.filter(r => {502        return r.event.section == this.eventSection && r.event.method == this.eventMethod;503      });504505      this.events.push(...newEvents);506    })) as any;507  }508509  stopCapture() {510    if (this.unsubscribe !== null) {511      this.unsubscribe();512    }513  }514515  extractCapturedEvents() {516    return this.events;517  }518}519520class AdminGroup {521  helper: UniqueHelper;522523  constructor(helper: UniqueHelper) {524    this.helper = helper;525  }526527  async payoutStakers(signer: IKeyringPair, stakersToPayout: number) {528    const payoutResult = await this.helper.executeExtrinsic(signer, 'api.tx.appPromotion.payoutStakers', [stakersToPayout], true);529    return payoutResult.result.events.filter(e => e.event.method === 'StakingRecalculation').map(e => {530      return {531        staker: e.event.data[0].toString(),532        stake: e.event.data[1].toBigInt(),533        payout: e.event.data[2].toBigInt(),534      };535    });536  }537}