1234import {stringToU8a} from '@polkadot/util';5import {encodeAddress, mnemonicGenerate} from '@polkadot/util-crypto';6import {UniqueHelper, MoonbeamHelper, ChainHelperBase, AcalaHelper, RelayHelper, WestmintHelper, AstarHelper} 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 28 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 646566 arrange: ArrangeGroup;67 wait: WaitGroup;68 admin: AdminGroup;69 session: SessionGroup;70 testUtils: TestUtilGroup;7172 constructor(logger: { log: (msg: any, level: any) => void, level: any }, options: {[key: string]: any} = {}) {73 options.helperBase = options.helperBase ?? DevUniqueHelper;7475 super(logger, options);76 this.arrange = new ArrangeGroup(this);77 this.wait = new WaitGroup(this);78 this.admin = new AdminGroup(this);79 this.testUtils = new TestUtilGroup(this);80 this.session = new SessionGroup(this);81 }8283 async connect(wsEndpoint: string, _listeners?: any): Promise<void> {84 const wsProvider = new WsProvider(wsEndpoint);85 this.api = new ApiPromise({86 provider: wsProvider,87 signedExtensions: {88 ContractHelpers: {89 extrinsic: {},90 payload: {},91 },92 CheckMaintenance: {93 extrinsic: {},94 payload: {},95 },96 DisableIdentityCalls: {97 extrinsic: {},98 payload: {},99 },100 FakeTransactionFinalizer: {101 extrinsic: {},102 payload: {},103 },104 },105 rpc: {106 unique: defs.unique.rpc,107 appPromotion: defs.appPromotion.rpc,108 povinfo: defs.povinfo.rpc,109 eth: {110 feeHistory: {111 description: 'Dummy',112 params: [],113 type: 'u8',114 },115 maxPriorityFeePerGas: {116 description: 'Dummy',117 params: [],118 type: 'u8',119 },120 },121 },122 });123 await this.api.isReadyOrError;124 this.network = await UniqueHelper.detectNetwork(this.api);125 this.wsEndpoint = wsEndpoint;126 }127}128129export class DevRelayHelper extends RelayHelper {130 wait: WaitGroup;131132 constructor(logger: { log: (msg: any, level: any) => void, level: any }, options: {[key: string]: any} = {}) {133 options.helperBase = options.helperBase ?? DevRelayHelper;134135 super(logger, options);136 this.wait = new WaitGroup(this);137 }138}139140export class DevWestmintHelper extends WestmintHelper {141 wait: WaitGroup;142143 constructor(logger: { log: (msg: any, level: any) => void, level: any }, options: {[key: string]: any} = {}) {144 options.helperBase = options.helperBase ?? DevWestmintHelper;145146 super(logger, options);147 this.wait = new WaitGroup(this);148 }149}150151export class DevStatemineHelper extends DevWestmintHelper {}152153export class DevStatemintHelper extends DevWestmintHelper {}154155export class DevMoonbeamHelper extends MoonbeamHelper {156 account: MoonbeamAccountGroup;157 wait: WaitGroup;158159 constructor(logger: { log: (msg: any, level: any) => void, level: any }, options: {[key: string]: any} = {}) {160 options.helperBase = options.helperBase ?? DevMoonbeamHelper;161 options.notePreimagePallet = options.notePreimagePallet ?? 'preimage';162163 super(logger, options);164 this.account = new MoonbeamAccountGroup(this);165 this.wait = new WaitGroup(this);166 }167}168169export class DevMoonriverHelper extends DevMoonbeamHelper {170 constructor(logger: { log: (msg: any, level: any) => void, level: any }, options: {[key: string]: any} = {}) {171 options.notePreimagePallet = options.notePreimagePallet ?? 'preimage';172 super(logger, options);173 }174}175176export class DevAstarHelper extends AstarHelper {177 wait: WaitGroup;178179 constructor(logger: { log: (msg: any, level: any) => void, level: any }, options: {[key: string]: any} = {}) {180 options.helperBase = options.helperBase ?? DevAstarHelper;181182 super(logger, options);183 this.wait = new WaitGroup(this);184 }185}186187export class DevAcalaHelper extends AcalaHelper {188 wait: WaitGroup;189190 constructor(logger: { log: (msg: any, level: any) => void, level: any }, options: {[key: string]: any} = {}) {191 options.helperBase = options.helperBase ?? DevAcalaHelper;192193 super(logger, options);194 this.wait = new WaitGroup(this);195 }196}197198export class DevKaruraHelper extends DevAcalaHelper {}199200export class ArrangeGroup {201 helper: DevUniqueHelper;202203 scheduledIdSlider = 0;204205 constructor(helper: DevUniqueHelper) {206 this.helper = helper;207 }208209 210211212213214215216 createAccounts = async (balances: bigint[], donor: IKeyringPair): Promise<IKeyringPair[]> => {217 let nonce = await this.helper.chain.getNonce(donor.address);218 const wait = new WaitGroup(this.helper);219 const ss58Format = this.helper.chain.getChainProperties().ss58Format;220 const tokenNominal = this.helper.balance.getOneTokenNominal();221 const transactions = [];222 const accounts: IKeyringPair[] = [];223 for (const balance of balances) {224 const recipient = this.helper.util.fromSeed(mnemonicGenerate(), ss58Format);225 accounts.push(recipient);226 if (balance !== 0n) {227 const tx = this.helper.constructApiCall('api.tx.balances.transfer', [{Id: recipient.address}, balance * tokenNominal]);228 transactions.push(this.helper.signTransaction(donor, tx, {nonce, era: 0}, 'account generation'));229 nonce++;230 }231 }232233 await Promise.all(transactions).catch(_e => {});234235 236 const checkBalances = async () => {237 let isSuccess = true;238 for (let i = 0; i < balances.length; i++) {239 const balance = await this.helper.balance.getSubstrate(accounts[i].address);240 if (balance !== balances[i] * tokenNominal) {241 isSuccess = false;242 break;243 }244 }245 return isSuccess;246 };247248 let accountsCreated = false;249 const maxBlocksChecked = await this.helper.arrange.isDevNode() ? 50 : 5;250 251 for (let index = 0; index < maxBlocksChecked; index++) {252 accountsCreated = await checkBalances();253 if(accountsCreated) break;254 await wait.newBlocks(1);255 }256257 if (!accountsCreated) throw Error('Accounts generation failed');258 259260 return accounts;261 };262263 264 createCrowd = async (accountsToCreate: number, withBalance: bigint, donor: IKeyringPair): Promise<IKeyringPair[]> => {265 const createAsManyAsCan = async () => {266 let transactions: any = [];267 const accounts: IKeyringPair[] = [];268 let nonce = await this.helper.chain.getNonce(donor.address);269 const tokenNominal = this.helper.balance.getOneTokenNominal();270 const ss58Format = this.helper.chain.getChainProperties().ss58Format;271 for (let i = 0; i < accountsToCreate; i++) {272 if (i === 500) { 273 await Promise.allSettled(transactions); 274 transactions = []; 275 nonce = await this.helper.chain.getNonce(donor.address); 276 }277 const recipient = this.helper.util.fromSeed(mnemonicGenerate(), ss58Format);278 accounts.push(recipient);279 if (withBalance !== 0n) {280 const tx = this.helper.constructApiCall('api.tx.balances.transfer', [{Id: recipient.address}, withBalance * tokenNominal]);281 transactions.push(this.helper.signTransaction(donor, tx, {nonce}, 'account generation'));282 nonce++;283 }284 }285286 const fullfilledAccounts = [];287 await Promise.allSettled(transactions);288 for (const account of accounts) {289 const accountBalance = await this.helper.balance.getSubstrate(account.address);290 if (accountBalance === withBalance * tokenNominal) {291 fullfilledAccounts.push(account);292 }293 }294 return fullfilledAccounts;295 };296297298 const crowd: IKeyringPair[] = [];299 300 for (let index = 0; index < 5 && accountsToCreate !== 0; index++) {301 const asManyAsCan = await createAsManyAsCan();302 crowd.push(...asManyAsCan);303 accountsToCreate -= asManyAsCan.length;304 }305306 if (accountsToCreate !== 0) throw Error(`Crowd generation failed: ${accountsToCreate} accounts left`);307308 return crowd;309 };310311 isDevNode = async () => {312 let blockNumber = (await this.helper.callRpc('api.query.system.number')).toJSON();313 if (blockNumber == 0) {314 await this.helper.wait.newBlocks(1);315 blockNumber = (await this.helper.callRpc('api.query.system.number')).toJSON();316 }317 const block2 = await this.helper.callRpc('api.rpc.chain.getBlock', [await this.helper.callRpc('api.rpc.chain.getBlockHash', [blockNumber])]);318 const block1 = await this.helper.callRpc('api.rpc.chain.getBlock', [await this.helper.callRpc('api.rpc.chain.getBlockHash', [blockNumber - 1])]);319 const findCreationDate = (block: any) => {320 const humanBlock = block.toHuman();321 let date;322 humanBlock.block.extrinsics.forEach((ext: any) => {323 if(ext.method.section === 'timestamp') {324 date = Number(ext.method.args.now.replaceAll(',', ''));325 }326 });327 return date;328 };329 const block1date = await findCreationDate(block1);330 const block2date = await findCreationDate(block2);331 if(block2date! - block1date! < 9000) return true;332 };333334 async calculcateFee(payer: ICrossAccountId, promise: () => Promise<any>): Promise<bigint> {335 const address = payer.Substrate ? payer.Substrate : this.helper.address.ethToSubstrate(payer.Ethereum!);336 let balance = await this.helper.balance.getSubstrate(address);337338 await promise();339340 balance -= await this.helper.balance.getSubstrate(address);341342 return balance;343 }344345 async calculatePoVInfo(txs: any[]): Promise<IPovInfo> {346 const rawPovInfo = await this.helper.callRpc('api.rpc.povinfo.estimateExtrinsicPoV', [txs]);347348 const kvJson: {[key: string]: string} = {};349350 for (const kv of rawPovInfo.keyValues) {351 kvJson[kv.key.toHex()] = kv.value.toHex();352 }353354 const kvStr = JSON.stringify(kvJson);355356 const chainql = spawnSync(357 'chainql',358 [359 `--tla-code=data=${kvStr}`,360 '-e', `function(data) cql.dump(cql.chain("${this.helper.getEndpoint()}").latest._meta, data, {omit_empty:true})`,361 ],362 );363364 if (!chainql.stdout) {365 throw Error('unable to get an output from the `chainql`');366 }367368 return {369 proofSize: rawPovInfo.proofSize.toNumber(),370 compactProofSize: rawPovInfo.compactProofSize.toNumber(),371 compressedProofSize: rawPovInfo.compressedProofSize.toNumber(),372 results: rawPovInfo.results,373 kv: JSON.parse(chainql.stdout.toString()),374 };375 }376377 calculatePalletAddress(palletId: any) {378 const address = stringToU8a(('modl' + palletId).padEnd(32, '\0'));379 return encodeAddress(address, this.helper.chain.getChainProperties().ss58Format);380 }381382 makeScheduledIds(num: number): string[] {383 function makeId(slider: number) {384 const scheduledIdSize = 64;385 const hexId = slider.toString(16);386 const prefixSize = scheduledIdSize - hexId.length;387388 const scheduledId = '0x' + '0'.repeat(prefixSize) + hexId;389390 return scheduledId;391 }392393 const ids = [];394 for (let i = 0; i < num; i++) {395 ids.push(makeId(this.scheduledIdSlider));396 this.scheduledIdSlider += 1;397 }398399 return ids;400 }401402 makeScheduledId(): string {403 return (this.makeScheduledIds(1))[0];404 }405406 async captureEvents(eventSection: string, eventMethod: string): Promise<EventCapture> {407 const capture = new EventCapture(this.helper, eventSection, eventMethod);408 await capture.startCapture();409410 return capture;411 }412}413414class MoonbeamAccountGroup {415 helper: MoonbeamHelper;416417 keyring: Keyring;418 _alithAccount: IKeyringPair;419 _baltatharAccount: IKeyringPair;420 _dorothyAccount: IKeyringPair;421422 constructor(helper: MoonbeamHelper) {423 this.helper = helper;424425 this.keyring = new Keyring({type: 'ethereum'});426 const alithPrivateKey = '0x5fb92d6e98884f76de468fa3f6278f8807c48bebc13595d45af5bdc4da702133';427 const baltatharPrivateKey = '0x8075991ce870b93a8870eca0c0f91913d12f47948ca0fd25b49c6fa7cdbeee8b';428 const dorothyPrivateKey = '0x39539ab1876910bbf3a223d84a29e28f1cb4e2e456503e7e91ed39b2e7223d68';429430 this._alithAccount = this.keyring.addFromUri(alithPrivateKey, undefined, 'ethereum');431 this._baltatharAccount = this.keyring.addFromUri(baltatharPrivateKey, undefined, 'ethereum');432 this._dorothyAccount = this.keyring.addFromUri(dorothyPrivateKey, undefined, 'ethereum');433 }434435 alithAccount() {436 return this._alithAccount;437 }438439 baltatharAccount() {440 return this._baltatharAccount;441 }442443 dorothyAccount() {444 return this._dorothyAccount;445 }446447 create() {448 return this.keyring.addFromUri(mnemonicGenerate());449 }450}451452class WaitGroup {453 helper: ChainHelperBase;454455 constructor(helper: ChainHelperBase) {456 this.helper = helper;457 }458459 sleep(milliseconds: number) {460 return new Promise((resolve) => setTimeout(resolve, milliseconds));461 }462463 private async waitWithTimeout(promise: Promise<any>, timeout: number) {464 let isBlock = false;465 promise.then(() => isBlock = true).catch(() => isBlock = true);466 let totalTime = 0;467 const step = 100;468 while(!isBlock) {469 await this.sleep(step);470 totalTime += step;471 if(totalTime >= timeout) throw Error('Blocks production failed');472 }473 return promise;474 }475476 477478479480481482483 withTimeout<T>(484 promise: Promise<T>,485 timeoutMS = 30000,486 timeoutError = 'The operation has timed out!',487 ): Promise<T> {488 const timeout = new Promise<never>((_, reject) => {489 setTimeout(() => {490 reject(new Error(timeoutError));491 }, timeoutMS);492 });493494 return Promise.race<T>([promise, timeout]).catch(e => {throw new Error(e);});495 }496497 498499500501502 async newBlocks(blocksCount = 1, timeout?: number): Promise<void> {503 timeout = timeout ?? blocksCount * 60_000;504 505 const promise = new Promise<void>(async (resolve) => {506 const unsubscribe = await this.helper.getApi().rpc.chain.subscribeNewHeads(() => {507 if (blocksCount > 0) {508 blocksCount--;509 } else {510 unsubscribe();511 resolve();512 }513 });514 });515 await this.waitWithTimeout(promise, timeout);516 return promise;517 }518519 520521522523524525526 async newSessions(sessionCount = 1, blockTimeout = 60000): Promise<void> {527 console.log(`Waiting for ${sessionCount} new session${sessionCount > 1 ? 's' : ''}.`528 + ' This might take a while -- check SessionPeriod in pallet_session::Config for session time.');529530 const expectedSessionIndex = await (this.helper as DevUniqueHelper).session.getIndex() + sessionCount;531 let currentSessionIndex = -1;532533 while (currentSessionIndex < expectedSessionIndex) {534 535 currentSessionIndex = await this.withTimeout(new Promise(async (resolve) => {536 await this.newBlocks(1);537 const res = await (this.helper as DevUniqueHelper).session.getIndex();538 resolve(res);539 }), blockTimeout, 'The chain has stopped producing blocks!');540 }541 }542543 async forParachainBlockNumber(blockNumber: bigint | number, timeout?: number) {544 timeout = timeout ?? 30 * 60 * 1000;545 546 const promise = new Promise<void>(async (resolve) => {547 const unsubscribe = await this.helper.getApi().rpc.chain.subscribeNewHeads((data: any) => {548 if (data.number.toNumber() >= blockNumber) {549 unsubscribe();550 resolve();551 }552 });553 });554 await this.waitWithTimeout(promise, timeout);555 return promise;556 }557558 async forRelayBlockNumber(blockNumber: bigint | number, timeout?: number) {559 timeout = timeout ?? 30 * 60 * 1000;560 561 const promise = new Promise<void>(async (resolve) => {562 const unsubscribe = await this.helper.getApi().query.parachainSystem.validationData((data: any) => {563 if (data.value.relayParentNumber.toNumber() >= blockNumber) {564 565 unsubscribe();566 resolve();567 }568 });569 });570 await this.waitWithTimeout(promise, timeout);571 return promise;572 }573574 noScheduledTasks() {575 const api = this.helper.getApi();576577 578 const promise = new Promise<void>(async resolve => {579 const unsubscribe = await api.rpc.chain.subscribeNewHeads(async () => {580 const areThereScheduledTasks = await api.query.scheduler.lookup.entries();581582 if(areThereScheduledTasks.length == 0) {583 unsubscribe();584 resolve();585 }586 });587 });588589 return promise;590 }591592 event(maxBlocksToWait: number, eventSection: string, eventMethod: string) {593 594 const promise = new Promise<EventRecord | null>(async (resolve) => {595 const unsubscribe = await this.helper.getApi().rpc.chain.subscribeNewHeads(async header => {596 const blockNumber = header.number.toHuman();597 const blockHash = header.hash;598 const eventIdStr = `${eventSection}.${eventMethod}`;599 const waitLimitStr = `wait blocks remaining: ${maxBlocksToWait}`;600601 this.helper.logger.log(`[Block #${blockNumber}] Waiting for event \`${eventIdStr}\` (${waitLimitStr})`);602603 const apiAt = await this.helper.getApi().at(blockHash);604 const eventRecords = (await apiAt.query.system.events()) as any;605606 const neededEvent = eventRecords.toArray().find((r: FrameSystemEventRecord) => {607 return r.event.section == eventSection && r.event.method == eventMethod;608 });609610 if (neededEvent) {611 unsubscribe();612 resolve(neededEvent);613 } else if (maxBlocksToWait > 0) {614 maxBlocksToWait--;615 } else {616 this.helper.logger.log(`Event \`${eventIdStr}\` is NOT found`);617 unsubscribe();618 resolve(null);619 }620 });621 });622 return promise;623 }624}625626class SessionGroup {627 helper: ChainHelperBase;628629 constructor(helper: ChainHelperBase) {630 this.helper = helper;631 }632633 634 async getIndex(): Promise<number> {635 return (await this.helper.callRpc('api.query.session.currentIndex')).toNumber();636 }637638 newSessions(sessionCount = 1, blockTimeout = 24000): Promise<void> {639 return (this.helper as DevUniqueHelper).wait.newSessions(sessionCount, blockTimeout);640 }641642 setOwnKeys(signer: TSigner, key: string) {643 return this.helper.executeExtrinsic(644 signer,645 'api.tx.session.setKeys',646 [key, '0x0'],647 true,648 );649 }650651 setOwnKeysFromAddress(signer: TSigner) {652 return this.setOwnKeys(signer, '0x' + Buffer.from(signer.addressRaw).toString('hex'));653 }654}655656class TestUtilGroup {657 helper: DevUniqueHelper;658659 constructor(helper: DevUniqueHelper) {660 this.helper = helper;661 }662663 async enable() {664 if (this.helper.fetchMissingPalletNames([Pallets.TestUtils]).length != 0) {665 return;666 }667668 const signer = this.helper.util.fromSeed('//Alice');669 await this.helper.getSudo<DevUniqueHelper>().executeExtrinsic(signer, 'api.tx.testUtils.enable', [], true);670 }671672 async setTestValue(signer: TSigner, testVal: number) {673 await this.helper.executeExtrinsic(signer, 'api.tx.testUtils.setTestValue', [testVal], true);674 }675676 async incTestValue(signer: TSigner) {677 await this.helper.executeExtrinsic(signer, 'api.tx.testUtils.incTestValue', [], true);678 }679680 async setTestValueAndRollback(signer: TSigner, testVal: number) {681 await this.helper.executeExtrinsic(signer, 'api.tx.testUtils.setTestValueAndRollback', [testVal], true);682 }683684 async testValue(blockIdx?: number) {685 const api = blockIdx686 ? await this.helper.getApi().at(await this.helper.callRpc('api.rpc.chain.getBlockHash', [blockIdx]))687 : this.helper.getApi();688689 return (await api.query.testUtils.testValue()).toJSON();690 }691692 async justTakeFee(signer: TSigner) {693 await this.helper.executeExtrinsic(signer, 'api.tx.testUtils.justTakeFee', [], true);694 }695696 async selfCancelingInc(signer: TSigner, scheduledId: string, maxTestVal: number) {697 await this.helper.executeExtrinsic(signer, 'api.tx.testUtils.selfCancelingInc', [scheduledId, maxTestVal], true);698 }699}700701class EventCapture {702 helper: DevUniqueHelper;703 eventSection: string;704 eventMethod: string;705 events: EventRecord[] = [];706 unsubscribe: VoidFn | null = null;707708 constructor(709 helper: DevUniqueHelper,710 eventSection: string,711 eventMethod: string,712 ) {713 this.helper = helper;714 this.eventSection = eventSection;715 this.eventMethod = eventMethod;716 }717718 async startCapture() {719 this.stopCapture();720 this.unsubscribe = (await this.helper.getApi().query.system.events((eventRecords: FrameSystemEventRecord[]) => {721 const newEvents = eventRecords.filter(r => {722 return r.event.section == this.eventSection && r.event.method == this.eventMethod;723 });724725 this.events.push(...newEvents);726 })) as any;727 }728729 stopCapture() {730 if (this.unsubscribe !== null) {731 this.unsubscribe();732 }733 }734735 extractCapturedEvents() {736 return this.events;737 }738}739740class AdminGroup {741 helper: UniqueHelper;742743 constructor(helper: UniqueHelper) {744 this.helper = helper;745 }746747 async payoutStakers(signer: IKeyringPair, stakersToPayout: number): Promise<{staker: string, stake: bigint, payout: bigint}[]> {748 const payoutResult = await this.helper.executeExtrinsic(signer, 'api.tx.appPromotion.payoutStakers', [stakersToPayout], true);749 return payoutResult.result.events.filter(e => e.event.method === 'StakingRecalculation').map(e => {750 return {751 staker: e.event.data[0].toString(),752 stake: e.event.data[1].toBigInt(),753 payout: e.event.data[2].toBigInt(),754 };755 });756 }757}