`e0d3e40ea06e`

source

tests/src/substrate/substrate-api.ts6.4 KiBsource history
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';2728import {SilentConsole} from '../util/playgrounds/unique.dev';29303132function defaultApiOptions(): ApiOptions {33  const wsProvider = new WsProvider(config.substrateUrl);34  return {35    provider: wsProvider, signedExtensions: {36      ContractHelpers: {37        extrinsic: {},38        payload: {},39      },40      FakeTransactionFinalizer: {41        extrinsic: {},42        payload: {},43      },44    },45    rpc: {46      unique: defs.unique.rpc,47      appPromotion: defs.appPromotion.rpc,48      rmrk: defs.rmrk.rpc,49      eth: {50        feeHistory: {51          description: 'Dummy',52          params: [],53          type: 'u8',54        },55        maxPriorityFeePerGas: {56          description: 'Dummy',57          params: [],58          type: 'u8',59        },60      },61    },62  };63}6465export async function getApiConnection(settings: ApiOptions | undefined = undefined): Promise<ApiPromise> {66  settings = settings || defaultApiOptions();67  const api = new ApiPromise(settings);6869  if (api) {70    await api.isReadyOrError;71  }7273  return api;74}7576export default async function usingApi<T = void>(action: (api: ApiPromise, privateKeyWrapper: (account: string) => IKeyringPair) => Promise<T>, settings: ApiOptions | undefined = undefined): Promise<T> {77  settings = settings || defaultApiOptions();78  const api: ApiPromise = new ApiPromise(settings);79  let result: T = null as unknown as T;8081  const silentConsole = new SilentConsole();82  silentConsole.enable();8384  try {85    await promisifySubstrate(api, async () => {86      if (api) {87        await api.isReadyOrError;88        const ss58Format = (api.registry.getChainProperties())!.toJSON().ss58Format;89        const privateKeyWrapper = (account: string) => privateKey(account, Number(ss58Format));90        result = await action(api, privateKeyWrapper);91      }92    })();93  } finally {94    await api.disconnect();95    silentConsole.disable();96  }97  return result as T;98}99100enum TransactionStatus {101  Success,102  Fail,103  NotReady104}105106function getTransactionStatus(events: EventRecord[], status: ExtrinsicStatus): TransactionStatus {107  if (status.isReady) {108    return TransactionStatus.NotReady;109  }110  if (status.isBroadcast) {111    return TransactionStatus.NotReady;112  }113  if (status.isInBlock || status.isFinalized) {114    if(events.filter(e => e.event.data.method === 'ExtrinsicFailed').length > 0) {115      return TransactionStatus.Fail;116    }117    if(events.filter(e => e.event.data.method === 'ExtrinsicSuccess').length > 0) {118      return TransactionStatus.Success;119    }120  }121122  return TransactionStatus.Fail;123}124125export function executeTransaction(api: ApiPromise, sender: IKeyringPair, transaction: SubmittableExtrinsic<'promise'>): Promise<EventRecord[]> {126  return new Promise(async (res, rej) => {127    try {128      await transaction.signAndSend(sender, ({events, status}) => {129        if (!status.isInBlock && !status.isFinalized) return;130        for (const {event} of events) {131          if (api.events.system.ExtrinsicSuccess.is(event)) {132            res(events);133          } else if (api.events.system.ExtrinsicFailed.is(event)) {134            const {data: [error]} = event;135            if (error.isModule) {136              const decoded = api.registry.findMetaError(error.asModule);137              const {method, section} = decoded;138              rej(new Error(`${section}.${method}`));139            } else {140              rej(new Error(error.toString()));141            }142          }143        }144      });145    } catch (e) {146      rej(e);147    }148  });149}150151export function152submitTransactionAsync(sender: IKeyringPair, transaction: SubmittableExtrinsic<ApiTypes>): Promise<EventRecord[]> {153  /* eslint no-async-promise-executor: "off" */154  return new Promise(async (resolve, reject) => {155    try {156      await transaction.signAndSend(sender, ({events = [], status}) => {157        const transactionStatus = getTransactionStatus(events, status);158159        if (transactionStatus === TransactionStatus.Success) {160          resolve(events);161        } else if (transactionStatus === TransactionStatus.Fail) {162          console.log(`Something went wrong with transaction. Status: ${status}`);163          reject(events);164        }165      });166    } catch (e) {167      console.log('Error: ', e);168      reject(e);169    }170  });171}172173export function submitTransactionExpectFailAsync(sender: IKeyringPair, transaction: SubmittableExtrinsic<ApiTypes>): Promise<EventRecord[]> {174  console.error = () => {};175  console.log = () => {};176177  /* eslint no-async-promise-executor: "off" */178  return new Promise<EventRecord[]>(async function(res, rej) {179    const resolve = (rec: EventRecord[]) => {180      setTimeout(() => {181        res(rec);182      });183    };184    const reject = (errror: any) => {185      setTimeout(() => {186        rej(errror);187      });188    };189    try {190      await transaction.signAndSend(sender, ({events = [], status}) => {191        const transactionStatus = getTransactionStatus(events, status);192193        // console.log('transactionStatus', transactionStatus, 'events', events);194195        if (transactionStatus === TransactionStatus.Success) {196          resolve(events);197        } else if (transactionStatus === TransactionStatus.Fail) {198          reject(events);199        }200      });201    } catch (e) {202      reject(e);203    }204  });205}