`a5ed1cdb6cd5`

source

tests/src/.outdated/substrate/substrate-api.ts7.0 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      CheckMaintenance: {41        extrinsic: {},42        payload: {},43      },44      DisableIdentityCalls: {45        extrinsic: {},46        payload: {},47      },48      FakeTransactionFinalizer: {49        extrinsic: {},50        payload: {},51      },52    },53    rpc: {54      unique: defs.unique.rpc,55      appPromotion: defs.appPromotion.rpc,56      eth: {57        feeHistory: {58          description: 'Dummy',59          params: [],60          type: 'u8',61        },62        maxPriorityFeePerGas: {63          description: 'Dummy',64          params: [],65          type: 'u8',66        },67      },68    },69  };70}7172export async function getApiConnection(settings: ApiOptions | undefined = undefined): Promise<ApiPromise> {73  settings = settings || defaultApiOptions();74  const api = new ApiPromise(settings);7576  if (api) {77    await api.isReadyOrError;78  }7980  return api;81}8283export default async function usingApi<T = void>(action: (api: ApiPromise, privateKeyWrapper: (account: string) => IKeyringPair) => Promise<T>, settings: ApiOptions | undefined = undefined): Promise<T> {84  settings = settings || defaultApiOptions();85  const api: ApiPromise = new ApiPromise(settings);86  let result: T = null as unknown as T;8788  const silentConsole = new SilentConsole();89  silentConsole.enable();9091  try {92    await promisifySubstrate(api, async () => {93      if (api) {94        await api.isReadyOrError;95        const ss58Format = (api.registry.getChainProperties())!.toJSON().ss58Format;96        const privateKeyWrapper = (account: string) => privateKey(account, Number(ss58Format));97        result = await action(api, privateKeyWrapper);98      }99    })();100  } finally {101    await api.disconnect();102    silentConsole.disable();103  }104  return result as T;105}106107enum TransactionStatus {108  Success,109  Fail,110  NotReady111}112113function getTransactionStatus(events: EventRecord[], status: ExtrinsicStatus): TransactionStatus {114  if (status.isReady) {115    return TransactionStatus.NotReady;116  }117  if (status.isBroadcast) {118    return TransactionStatus.NotReady;119  }120  if (status.isRetracted) {121    return TransactionStatus.NotReady;122  }123  if (status.isInBlock || status.isFinalized) {124    if(events.filter(e => e.event.data.method === 'ExtrinsicFailed').length > 0) {125      return TransactionStatus.Fail;126    }127    if(events.filter(e => e.event.data.method === 'ExtrinsicSuccess').length > 0) {128      return TransactionStatus.Success;129    }130  }131132  return TransactionStatus.Fail;133}134135export function executeTransaction(api: ApiPromise, sender: IKeyringPair, transaction: SubmittableExtrinsic<'promise'>): Promise<EventRecord[]> {136  return new Promise(async (res, rej) => {137    try {138      await transaction.signAndSend(sender, ({events, status}) => {139        if (!status.isInBlock && !status.isFinalized) return;140        for (const {event} of events) {141          if (api.events.system.ExtrinsicSuccess.is(event)) {142            res(events);143          } else if (api.events.system.ExtrinsicFailed.is(event)) {144            const {data: [error]} = event;145            if (error.isModule) {146              const decoded = api.registry.findMetaError(error.asModule);147              const {method, section} = decoded;148              rej(new Error(`${section}.${method}`));149            } else {150              rej(new Error(error.toString()));151            }152          }153        }154      });155    } catch (e) {156      rej(e);157    }158  });159}160161/**162 * @deprecated use `executeTransaction` instead163 */164export function165submitTransactionAsync(sender: IKeyringPair, transaction: SubmittableExtrinsic<ApiTypes>): Promise<EventRecord[]> {166  /* eslint no-async-promise-executor: "off" */167  return new Promise(async (resolve, reject) => {168    try {169      await transaction.signAndSend(sender, ({events = [], status, dispatchError}) => {170        const transactionStatus = getTransactionStatus(events, status);171172        if (transactionStatus === TransactionStatus.Success) {173          resolve(events);174        } else if (transactionStatus === TransactionStatus.Fail) {175          let moduleError = null;176177          if (dispatchError) {178            if (dispatchError.isModule) {179              const modErr = dispatchError.asModule;180              const errorMeta = dispatchError.registry.findMetaError(modErr);181182              moduleError = JSON.stringify(errorMeta, null, 4);183            }184          }185186          console.log(`Something went wrong with transaction. Status: ${status}\nModule error: ${moduleError}`);187          reject(events);188        }189      });190    } catch (e) {191      console.log('Error: ', e);192      reject(e);193    }194  });195}196197export function submitTransactionExpectFailAsync(sender: IKeyringPair, transaction: SubmittableExtrinsic<ApiTypes>): Promise<EventRecord[]> {198  console.error = () => {};199  console.log = () => {};200201  /* eslint no-async-promise-executor: "off" */202  return new Promise<EventRecord[]>(async function(res, rej) {203    const resolve = (rec: EventRecord[]) => {204      setTimeout(() => {205        res(rec);206      });207    };208    const reject = (errror: any) => {209      setTimeout(() => {210        rej(errror);211      });212    };213    try {214      await transaction.signAndSend(sender, ({events = [], status}) => {215        const transactionStatus = getTransactionStatus(events, status);216217        // console.log('transactionStatus', transactionStatus, 'events', events);218219        if (transactionStatus === TransactionStatus.Success) {220          resolve(events);221        } else if (transactionStatus === TransactionStatus.Fail) {222          reject(events);223        }224      });225    } catch (e) {226      reject(e);227    }228  });229}