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

difftreelog

Add helper to get total payout

Max Andreev2022-09-15parent: #7586abb.patch.diff
in: master

2 files changed

modifiedtests/src/app-promotion.test.tsdiffbeforeafterboth
--- a/tests/src/app-promotion.test.ts
+++ b/tests/src/app-promotion.test.ts
@@ -619,11 +619,11 @@
     // Wait for rewards and pay
     const [stakedInBlock] = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address});
     await helper.wait.forRelayBlockNumber(rewardAvailableInBlock(stakedInBlock.block));
-    await helper.signTransaction(palletAdmin, helper.api!.tx.appPromotion.payoutStakers(100));
+    // await helper.signTransaction(palletAdmin, helper.api!.tx.appPromotion.payoutStakers(100));
+    const totalPayout = (await helper.sudo.payoutStakers(palletAdmin, 100)).reduce((prev, payout) => prev + payout.payout, 0n);
 
     const totalStakedAfter = await helper.staking.getTotalStaked();
-    expect(totalStakedAfter >= totalStakedBefore + calculateIncome(100n * nominal, 10n)).to.be.true;
-
+    expect(totalStakedAfter).to.equal(totalStakedBefore + (100n * nominal) + totalPayout);
     // staker can unstake
     await helper.staking.unstake(staker);
     expect(await helper.staking.getTotalStaked()).to.be.equal(totalStakedAfter - calculateIncome(100n * nominal, 10n));
modifiedtests/src/util/playgrounds/unique.dev.tsdiffbeforeafterboth
before · tests/src/util/playgrounds/unique.dev.ts
1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// SPDX-License-Identifier: Apache-2.034import {mnemonicGenerate} from '@polkadot/util-crypto';5import {UniqueHelper} from './unique';6import {ApiPromise, WsProvider} from '@polkadot/api';7import * as defs from '../../interfaces/definitions';8import {IKeyringPair} from '@polkadot/types/types';91011export class SilentLogger {12  log(_msg: any, _level: any): void { }13  level = {14    ERROR: 'ERROR' as const,15    WARNING: 'WARNING' as const,16    INFO: 'INFO' as const,17  };18}1920export class SilentConsole {21  // TODO: Remove, this is temporary: Filter unneeded API output22  // (Jaco promised it will be removed in the next version)23  consoleErr: any;24  consoleLog: any;25  consoleWarn: any;2627  constructor() {28    this.consoleErr = console.error;29    this.consoleLog = console.log;30    this.consoleWarn = console.warn;31  }3233  enable() {  34    const outFn = (printer: any) => (...args: any[]) => {35      for (const arg of args) {36        if (typeof arg !== 'string')37          continue;38        if (arg.includes('1000:: Normal connection closure') || arg.includes('Not decorating unknown runtime apis:') || arg.includes('RPC methods not decorated:') || arg === 'Normal connection closure')39          return;40      }41      printer(...args);42    };43  44    console.error = outFn(this.consoleErr.bind(console));45    console.log = outFn(this.consoleLog.bind(console));46    console.warn = outFn(this.consoleWarn.bind(console));47  }4849  disable() {50    console.error = this.consoleErr;51    console.log = this.consoleLog;52    console.warn = this.consoleWarn;53  }54}555657export class DevUniqueHelper extends UniqueHelper {58  /**59   * Arrange methods for tests60   */61  arrange: ArrangeGroup;62  wait: WaitGroup;6364  constructor(logger: { log: (msg: any, level: any) => void, level: any }) {65    super(logger);66    this.arrange = new ArrangeGroup(this);67    this.wait = new WaitGroup(this);68  }6970  async connect(wsEndpoint: string, _listeners?: any): Promise<void> {71    const wsProvider = new WsProvider(wsEndpoint);72    this.api = new ApiPromise({73      provider: wsProvider,74      signedExtensions: {75        ContractHelpers: {76          extrinsic: {},77          payload: {},78        },79        FakeTransactionFinalizer: {80          extrinsic: {},81          payload: {},82        },83      },84      rpc: {85        unique: defs.unique.rpc,86        appPromotion: defs.appPromotion.rpc,87        rmrk: defs.rmrk.rpc,88        eth: {89          feeHistory: {90            description: 'Dummy',91            params: [],92            type: 'u8',93          },94          maxPriorityFeePerGas: {95            description: 'Dummy',96            params: [],97            type: 'u8',98          },99        },100      },101    });102    await this.api.isReadyOrError;103    this.network = await UniqueHelper.detectNetwork(this.api);104  }105}106107class ArrangeGroup {108  helper: UniqueHelper;109110  constructor(helper: UniqueHelper) {111    this.helper = helper;112  }113114  /**115   * Generates accounts with the specified UNQ token balance 116   * @param balances balances for generated accounts. Each balance will be multiplied by the token nominal.117   * @param donor donor account for balances118   * @returns array of newly created accounts119   * @example const [acc1, acc2, acc3] = await createAccounts([0n, 10n, 20n], donor); 120   */121  createAccounts = async (balances: bigint[], donor: IKeyringPair): Promise<IKeyringPair[]> => {122    let nonce = await this.helper.chain.getNonce(donor.address);123    const ss58Format = this.helper.chain.getChainProperties().ss58Format;124    const tokenNominal = this.helper.balance.getOneTokenNominal();125    const transactions = [];126    const accounts: IKeyringPair[] = [];127    for (const balance of balances) {128      const recipient = this.helper.util.fromSeed(mnemonicGenerate(), ss58Format);129      accounts.push(recipient);130      if (balance !== 0n) {131        const tx = this.helper.constructApiCall('api.tx.balances.transfer', [{Id: recipient.address}, balance * tokenNominal]);132        transactions.push(this.helper.signTransaction(donor, tx, 'account generation', {nonce}));133        nonce++;134      }135    }136137    await Promise.all(transactions).catch(_e => {});138    139    //#region TODO remove this region, when nonce problem will be solved140    const checkBalances = async () => {141      let isSuccess = true;142      for (let i = 0; i < balances.length; i++) {143        const balance = await this.helper.balance.getSubstrate(accounts[i].address);144        if (balance !== balances[i] * tokenNominal) {145          isSuccess = false;146          break;147        }148      }149      return isSuccess;150    };151152    let accountsCreated = false;153    // checkBalances retry up to 5 blocks154    for (let index = 0; index < 5; index++) {155      accountsCreated = await checkBalances();156      if(accountsCreated) break;157      158    }159160    if (!accountsCreated) throw Error('Accounts generation failed');161    //#endregion162163    return accounts;164  };165166  // TODO combine this method and createAccounts into one167  createCrowd = async (accountsToCreate: number, withBalance: bigint, donor: IKeyringPair): Promise<IKeyringPair[]> => {  168    const createAsManyAsCan = async () => {169      let transactions: any = [];170      const accounts: IKeyringPair[] = [];171      let nonce = await this.helper.chain.getNonce(donor.address);172      const tokenNominal = this.helper.balance.getOneTokenNominal();173      for (let i = 0; i < accountsToCreate; i++) {174        if (i === 500) { // if there are too many accounts to create175          await Promise.allSettled(transactions); // wait while first 500 (should be 100 for devnode) tx will be settled 176          transactions = []; //177          nonce = await this.helper.chain.getNonce(donor.address); // update nonce 178        }179        const recepient = this.helper.util.fromSeed(mnemonicGenerate());180        accounts.push(recepient);181        if (withBalance !== 0n) {182          const tx = this.helper.constructApiCall('api.tx.balances.transfer', [{Id: recepient.address}, withBalance * tokenNominal]);183          transactions.push(this.helper.signTransaction(donor, tx, 'account generation', {nonce}));184          nonce++;185        }186      }187      188      const fullfilledAccounts = [];189      await Promise.allSettled(transactions);190      for (const account of accounts) {191        const accountBalance = await this.helper.balance.getSubstrate(account.address);192        if (accountBalance === withBalance * tokenNominal) {193          fullfilledAccounts.push(account);194        }195      }196      return fullfilledAccounts;197    };198199    200    const crowd: IKeyringPair[] = [];201    // do up to 5 retries202    for (let index = 0; index < 5 && accountsToCreate !== 0; index++) {203      const asManyAsCan = await createAsManyAsCan();204      crowd.push(...asManyAsCan);205      accountsToCreate -= asManyAsCan.length;206    }207208    if (accountsToCreate !== 0) throw Error(`Crowd generation failed: ${accountsToCreate} accounts left`);209210    return crowd;211  };212213  isDevNode = async () => {214    const block1 = await this.helper.api?.rpc.chain.getBlock(await this.helper.api?.rpc.chain.getBlockHash(1));215    const block2 = await this.helper.api?.rpc.chain.getBlock(await this.helper.api?.rpc.chain.getBlockHash(2));216    const findCreationDate = async (block: any) => {217      const humanBlock = block.toHuman();218      let date;219      humanBlock.block.extrinsics.forEach((ext: any) => {220        if(ext.method.section === 'timestamp') {221          date = Number(ext.method.args.now.replaceAll(',', ''));222        }223      });224      return date;225    };226    const block1date = await findCreationDate(block1);227    const block2date = await findCreationDate(block2);228    if(block2date! - block1date! < 9000) return true;229  };230}231232class WaitGroup {233  helper: UniqueHelper;234235  constructor(helper: UniqueHelper) {236    this.helper = helper;237  }238239  /**240   * Wait for specified bnumber of blocks241   * @param blocksCount number of blocks to wait242   * @returns 243   */244  async newBlocks(blocksCount = 1): Promise<void> {245    // eslint-disable-next-line no-async-promise-executor246    const promise = new Promise<void>(async (resolve) => {247      const unsubscribe = await this.helper.api!.rpc.chain.subscribeNewHeads(() => {248        if (blocksCount > 0) {249          blocksCount--;250        } else {251          unsubscribe();252          resolve();253        }254      });255    });256    return promise;257  }258259  async forParachainBlockNumber(blockNumber: bigint) {260    // eslint-disable-next-line no-async-promise-executor261    return new Promise<void>(async (resolve) => {262      const unsubscribe = await this.helper.api!.rpc.chain.subscribeNewHeads(async (data: any) => {263        if (data.number.toNumber() >= blockNumber) {264          unsubscribe();265          resolve();266        }267      });268    });269  }270  271  async forRelayBlockNumber(blockNumber: bigint) {272    // eslint-disable-next-line no-async-promise-executor273    return new Promise<void>(async (resolve) => {274      const unsubscribe = await this.helper.api!.query.parachainSystem.validationData(async (data: any) => {275        if (data.value.relayParentNumber.toNumber() >= blockNumber) {276          // @ts-ignore277          unsubscribe();278          resolve();279        }280      });281    });282  }283}
after · tests/src/util/playgrounds/unique.dev.ts
1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// SPDX-License-Identifier: Apache-2.034import {mnemonicGenerate} from '@polkadot/util-crypto';5import {UniqueHelper} from './unique';6import {ApiPromise, WsProvider} from '@polkadot/api';7import * as defs from '../../interfaces/definitions';8import {IKeyringPair} from '@polkadot/types/types';91011export class SilentLogger {12  log(_msg: any, _level: any): void { }13  level = {14    ERROR: 'ERROR' as const,15    WARNING: 'WARNING' as const,16    INFO: 'INFO' as const,17  };18}1920export class SilentConsole {21  // TODO: Remove, this is temporary: Filter unneeded API output22  // (Jaco promised it will be removed in the next version)23  consoleErr: any;24  consoleLog: any;25  consoleWarn: any;2627  constructor() {28    this.consoleErr = console.error;29    this.consoleLog = console.log;30    this.consoleWarn = console.warn;31  }3233  enable() {  34    const outFn = (printer: any) => (...args: any[]) => {35      for (const arg of args) {36        if (typeof arg !== 'string')37          continue;38        if (arg.includes('1000:: Normal connection closure') || arg.includes('Not decorating unknown runtime apis:') || arg.includes('RPC methods not decorated:') || arg === 'Normal connection closure')39          return;40      }41      printer(...args);42    };43  44    console.error = outFn(this.consoleErr.bind(console));45    console.log = outFn(this.consoleLog.bind(console));46    console.warn = outFn(this.consoleWarn.bind(console));47  }4849  disable() {50    console.error = this.consoleErr;51    console.log = this.consoleLog;52    console.warn = this.consoleWarn;53  }54}555657export class DevUniqueHelper extends UniqueHelper {58  /**59   * Arrange methods for tests60   */61  arrange: ArrangeGroup;62  wait: WaitGroup;63  sudo: SudoGroup;6465  constructor(logger: { log: (msg: any, level: any) => void, level: any }) {66    super(logger);67    this.arrange = new ArrangeGroup(this);68    this.wait = new WaitGroup(this);69    this.sudo = new SudoGroup(this);70  }7172  async connect(wsEndpoint: string, _listeners?: any): Promise<void> {73    const wsProvider = new WsProvider(wsEndpoint);74    this.api = new ApiPromise({75      provider: wsProvider,76      signedExtensions: {77        ContractHelpers: {78          extrinsic: {},79          payload: {},80        },81        FakeTransactionFinalizer: {82          extrinsic: {},83          payload: {},84        },85      },86      rpc: {87        unique: defs.unique.rpc,88        appPromotion: defs.appPromotion.rpc,89        rmrk: defs.rmrk.rpc,90        eth: {91          feeHistory: {92            description: 'Dummy',93            params: [],94            type: 'u8',95          },96          maxPriorityFeePerGas: {97            description: 'Dummy',98            params: [],99            type: 'u8',100          },101        },102      },103    });104    await this.api.isReadyOrError;105    this.network = await UniqueHelper.detectNetwork(this.api);106  }107}108109class ArrangeGroup {110  helper: UniqueHelper;111112  constructor(helper: UniqueHelper) {113    this.helper = helper;114  }115116  /**117   * Generates accounts with the specified UNQ token balance 118   * @param balances balances for generated accounts. Each balance will be multiplied by the token nominal.119   * @param donor donor account for balances120   * @returns array of newly created accounts121   * @example const [acc1, acc2, acc3] = await createAccounts([0n, 10n, 20n], donor); 122   */123  createAccounts = async (balances: bigint[], donor: IKeyringPair): Promise<IKeyringPair[]> => {124    let nonce = await this.helper.chain.getNonce(donor.address);125    const ss58Format = this.helper.chain.getChainProperties().ss58Format;126    const tokenNominal = this.helper.balance.getOneTokenNominal();127    const transactions = [];128    const accounts: IKeyringPair[] = [];129    for (const balance of balances) {130      const recipient = this.helper.util.fromSeed(mnemonicGenerate(), ss58Format);131      accounts.push(recipient);132      if (balance !== 0n) {133        const tx = this.helper.constructApiCall('api.tx.balances.transfer', [{Id: recipient.address}, balance * tokenNominal]);134        transactions.push(this.helper.signTransaction(donor, tx, 'account generation', {nonce}));135        nonce++;136      }137    }138139    await Promise.all(transactions).catch(_e => {});140    141    //#region TODO remove this region, when nonce problem will be solved142    const checkBalances = async () => {143      let isSuccess = true;144      for (let i = 0; i < balances.length; i++) {145        const balance = await this.helper.balance.getSubstrate(accounts[i].address);146        if (balance !== balances[i] * tokenNominal) {147          isSuccess = false;148          break;149        }150      }151      return isSuccess;152    };153154    let accountsCreated = false;155    // checkBalances retry up to 5 blocks156    for (let index = 0; index < 5; index++) {157      accountsCreated = await checkBalances();158      if(accountsCreated) break;159      160    }161162    if (!accountsCreated) throw Error('Accounts generation failed');163    //#endregion164165    return accounts;166  };167168  // TODO combine this method and createAccounts into one169  createCrowd = async (accountsToCreate: number, withBalance: bigint, donor: IKeyringPair): Promise<IKeyringPair[]> => {  170    const createAsManyAsCan = async () => {171      let transactions: any = [];172      const accounts: IKeyringPair[] = [];173      let nonce = await this.helper.chain.getNonce(donor.address);174      const tokenNominal = this.helper.balance.getOneTokenNominal();175      for (let i = 0; i < accountsToCreate; i++) {176        if (i === 500) { // if there are too many accounts to create177          await Promise.allSettled(transactions); // wait while first 500 (should be 100 for devnode) tx will be settled 178          transactions = []; //179          nonce = await this.helper.chain.getNonce(donor.address); // update nonce 180        }181        const recepient = this.helper.util.fromSeed(mnemonicGenerate());182        accounts.push(recepient);183        if (withBalance !== 0n) {184          const tx = this.helper.constructApiCall('api.tx.balances.transfer', [{Id: recepient.address}, withBalance * tokenNominal]);185          transactions.push(this.helper.signTransaction(donor, tx, 'account generation', {nonce}));186          nonce++;187        }188      }189      190      const fullfilledAccounts = [];191      await Promise.allSettled(transactions);192      for (const account of accounts) {193        const accountBalance = await this.helper.balance.getSubstrate(account.address);194        if (accountBalance === withBalance * tokenNominal) {195          fullfilledAccounts.push(account);196        }197      }198      return fullfilledAccounts;199    };200201    202    const crowd: IKeyringPair[] = [];203    // do up to 5 retries204    for (let index = 0; index < 5 && accountsToCreate !== 0; index++) {205      const asManyAsCan = await createAsManyAsCan();206      crowd.push(...asManyAsCan);207      accountsToCreate -= asManyAsCan.length;208    }209210    if (accountsToCreate !== 0) throw Error(`Crowd generation failed: ${accountsToCreate} accounts left`);211212    return crowd;213  };214215  isDevNode = async () => {216    const block1 = await this.helper.api?.rpc.chain.getBlock(await this.helper.api?.rpc.chain.getBlockHash(1));217    const block2 = await this.helper.api?.rpc.chain.getBlock(await this.helper.api?.rpc.chain.getBlockHash(2));218    const findCreationDate = async (block: any) => {219      const humanBlock = block.toHuman();220      let date;221      humanBlock.block.extrinsics.forEach((ext: any) => {222        if(ext.method.section === 'timestamp') {223          date = Number(ext.method.args.now.replaceAll(',', ''));224        }225      });226      return date;227    };228    const block1date = await findCreationDate(block1);229    const block2date = await findCreationDate(block2);230    if(block2date! - block1date! < 9000) return true;231  };232}233234class WaitGroup {235  helper: UniqueHelper;236237  constructor(helper: UniqueHelper) {238    this.helper = helper;239  }240241  /**242   * Wait for specified bnumber of blocks243   * @param blocksCount number of blocks to wait244   * @returns 245   */246  async newBlocks(blocksCount = 1): Promise<void> {247    // eslint-disable-next-line no-async-promise-executor248    const promise = new Promise<void>(async (resolve) => {249      const unsubscribe = await this.helper.api!.rpc.chain.subscribeNewHeads(() => {250        if (blocksCount > 0) {251          blocksCount--;252        } else {253          unsubscribe();254          resolve();255        }256      });257    });258    return promise;259  }260261  async forParachainBlockNumber(blockNumber: bigint) {262    // eslint-disable-next-line no-async-promise-executor263    return new Promise<void>(async (resolve) => {264      const unsubscribe = await this.helper.api!.rpc.chain.subscribeNewHeads(async (data: any) => {265        if (data.number.toNumber() >= blockNumber) {266          unsubscribe();267          resolve();268        }269      });270    });271  }272  273  async forRelayBlockNumber(blockNumber: bigint) {274    // eslint-disable-next-line no-async-promise-executor275    return new Promise<void>(async (resolve) => {276      const unsubscribe = await this.helper.api!.query.parachainSystem.validationData(async (data: any) => {277        if (data.value.relayParentNumber.toNumber() >= blockNumber) {278          // @ts-ignore279          unsubscribe();280          resolve();281        }282      });283    });284  }285}286287class SudoGroup {288  helper: UniqueHelper;289290  constructor(helper: UniqueHelper) {291    this.helper = helper;292  }293294  async payoutStakers(signer: IKeyringPair, stakersToPayout: number) {295    const payoutResult = await this.helper.executeExtrinsic(signer, 'api.tx.appPromotion.payoutStakers', [stakersToPayout], true);296    return payoutResult.result.events.filter(e => e.event.method === 'StakingRecalculation').map(e => {297      return {298        staker: e.event.data[0].toString(),299        stake: e.event.data[1].toBigInt(),300        payout: e.event.data[2].toBigInt(),301      };302    });303  }304}