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

difftreelog

source

tests/src/substrate/substrate-api.ts7.4 KiBsourcehistory
1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// This file is part of Unique Network.34// Unique Network is free software: you can redistribute it and/or modify5// it under the terms of the GNU General Public License as published by6// the Free Software Foundation, either version 3 of the License, or7// (at your option) any later version.89// Unique Network is distributed in the hope that it will be useful,10// but WITHOUT ANY WARRANTY; without even the implied warranty of11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the12// GNU General Public License for more details.1314// You should have received a copy of the GNU General Public License15// along with Unique Network. If not, see <http://www.gnu.org/licenses/>.1617import {ApiPromise, WsProvider} from '@polkadot/api';18import {ApiOptions, ApiTypes, SubmittableExtrinsic} from '@polkadot/api/types';19import {ExtrinsicStatus} from '@polkadot/types/interfaces/author/types';20import {EventRecord} from '@polkadot/types/interfaces/system/types';21import {IKeyringPair} from '@polkadot/types/types';22import config from '../config';23import '../interfaces/augment-api-events';24import * as defs from '../interfaces/definitions';25import privateKey from './privateKey';26import promisifySubstrate from './promisify-substrate';27282930function defaultApiOptions(): ApiOptions {31  const wsProvider = new WsProvider(config.substrateUrl);32  return {33    provider: wsProvider, signedExtensions: {34      ContractHelpers: {35        extrinsic: {},36        payload: {},37      },38      FakeTransactionFinalizer: {39        extrinsic: {},40        payload: {},41      },42    },43    rpc: {44      unique: defs.unique.rpc,45      rmrk: defs.rmrk.rpc,46      eth: {47        feeHistory: {48          description: 'Dummy',49          params: [],50          type: 'u8',51        },52        maxPriorityFeePerGas: {53          description: 'Dummy',54          params: [],55          type: 'u8',56        },57      },58    },59  };60}6162export async function getApiConnection(settings: ApiOptions | undefined = undefined): Promise<ApiPromise> {63  settings = settings || defaultApiOptions();64  const api = new ApiPromise(settings);6566  if (api) {67    await api.isReadyOrError;68  }6970  return api;71}7273export default async function usingApi<T = void>(action: (api: ApiPromise, privateKeyWrapper: (account: string) => IKeyringPair) => Promise<T>, settings: ApiOptions | undefined = undefined): Promise<T> {74  settings = settings || defaultApiOptions();75  const api: ApiPromise = new ApiPromise(settings);76  let result: T = null as unknown as T;7778  // TODO: Remove, this is temporary: Filter unneeded API output79  // (Jaco promised it will be removed in the next version)80  const consoleErr = console.error;81  const consoleLog = console.log;82  const consoleWarn = console.warn;8384  const outFn = (printer: any) => (...args: any[]) => {85    for (const arg of args) {86      if (typeof arg !== 'string')87        continue;88      if (arg.includes('1000:: Normal connection closure') || arg.includes('Not decorating unknown runtime apis:') || arg.includes('RPC methods not decorated:') || arg === 'Normal connection closure')89        return;90    }91    printer(...args);92  };9394  console.error = outFn(consoleErr.bind(console));95  console.log = outFn(consoleLog.bind(console));96  console.warn = outFn(consoleWarn.bind(console));9798  try {99    await promisifySubstrate(api, async () => {100      if (api) {101        await api.isReadyOrError;102        const ss58Format = (api.registry.getChainProperties())!.toJSON().ss58Format;103        const privateKeyWrapper = (account: string) => privateKey(account, Number(ss58Format));104        result = await action(api, privateKeyWrapper);105      }106    })();107  } finally {108    await api.disconnect();109    console.error = consoleErr;110    console.log = consoleLog;111    console.warn = consoleWarn;112  }113  return result as T;114}115116enum TransactionStatus {117  Success,118  Fail,119  NotReady120}121122function getTransactionStatus(events: EventRecord[], status: ExtrinsicStatus): TransactionStatus {123  if (status.isReady) {124    return TransactionStatus.NotReady;125  }126  if (status.isBroadcast) {127    return TransactionStatus.NotReady;128  }129  if (status.isInBlock || status.isFinalized) {130    if(events.filter(e => e.event.data.method === 'ExtrinsicFailed').length > 0) {131      return TransactionStatus.Fail;132    }133    if(events.filter(e => e.event.data.method === 'ExtrinsicSuccess').length > 0) {134      return TransactionStatus.Success;135    }136  }137138  return TransactionStatus.Fail;139}140141export function executeTransaction(api: ApiPromise, sender: IKeyringPair, transaction: SubmittableExtrinsic<'promise'>): Promise<EventRecord[]> {142  return new Promise(async (res, rej) => {143    try {144      await transaction.signAndSend(sender, ({events, status}) => {145        if (!status.isInBlock && !status.isFinalized) return;146        for (const {event} of events) {147          if (api.events.system.ExtrinsicSuccess.is(event)) {148            res(events);149          } else if (api.events.system.ExtrinsicFailed.is(event)) {150            const {data: [error]} = event;151            if (error.isModule) {152              const decoded = api.registry.findMetaError(error.asModule);153              const {method, section} = decoded;154              rej(new Error(`${section}.${method}`));155            } else {156              rej(new Error(error.toString()));157            }158          }159        }160      });161    } catch (e) {162      rej(e);163    }164  });165}166167export function168submitTransactionAsync(sender: IKeyringPair, transaction: SubmittableExtrinsic<ApiTypes>): Promise<EventRecord[]> {169  /* eslint no-async-promise-executor: "off" */170  return new Promise(async (resolve, reject) => {171    try {172      await transaction.signAndSend(sender, ({events = [], status, dispatchError}) => {173        const transactionStatus = getTransactionStatus(events, status);174175        if (transactionStatus === TransactionStatus.Success) {176          resolve(events);177        } else if (transactionStatus === TransactionStatus.Fail) {178          let moduleError = null;179180          if (dispatchError) {181            if (dispatchError.isModule) {182              const modErr = dispatchError.asModule;183              const errorMeta = dispatchError.registry.findMetaError(modErr);184185              moduleError = JSON.stringify(errorMeta, null, 4);186            }187          }188189          console.log(`Something went wrong with transaction. Status: ${status}\nModule error: ${moduleError}`);190          reject(events);191        }192      });193    } catch (e) {194      console.log('Error: ', e);195      reject(e);196    }197  });198}199200export function submitTransactionExpectFailAsync(sender: IKeyringPair, transaction: SubmittableExtrinsic<ApiTypes>): Promise<EventRecord[]> {201  console.error = () => {};202  console.log = () => {};203204  /* eslint no-async-promise-executor: "off" */205  return new Promise<EventRecord[]>(async function(res, rej) {206    const resolve = (rec: EventRecord[]) => {207      setTimeout(() => {208        res(rec);209      });210    };211    const reject = (errror: any) => {212      setTimeout(() => {213        rej(errror);214      });215    };216    try {217      await transaction.signAndSend(sender, ({events = [], status}) => {218        const transactionStatus = getTransactionStatus(events, status);219220        // console.log('transactionStatus', transactionStatus, 'events', events);221222        if (transactionStatus === TransactionStatus.Success) {223          resolve(events);224        } else if (transactionStatus === TransactionStatus.Fail) {225          reject(events);226        }227      });228    } catch (e) {229      reject(e);230    }231  });232}