Transactions interpretation utils

.github/workflows/pre-merge-unit-tests.yml

@@ -0,0 +1,40 @@
+name: "Jest Unit Tests"
+on:
+  pull_request:
+    branches: [main]
+    paths:
+      - 'src/**'
+      - '**.js'
+      - '**.ts'
+      - '**.json'
+  repository_dispatch:
+    types: run-unit-tests
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  run-unit-tests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: ${{ github.ref }}
+          if: ${{ !github.event.pull_request.draft }}
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+      - name: Setup yarn
+        run: npm install -g yarn
+      - name: Clean up
+        run: |
+          rm -rf node_modules build
+      - name: Install Dependencies
+        run: yarn install
+      - name: Build
+        run: yarn build
+      - name: Run unit tests
+        run: yarn test --silent

CHANGELOG.md

@@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+- [Added transaction interpretation utils](https://github.com/multiversx/mx-sdk-dapp-core/pull/38)
 - [Added custom web socket url support](https://github.com/multiversx/mx-sdk-dapp-core/pull/35)
 - [Metamask integration](https://github.com/multiversx/mx-sdk-dapp-core/pull/27)
 - [Extension integration](https://github.com/multiversx/mx-sdk-dapp-core/pull/26)

eslint.config.mjs

@@ -33,11 +33,11 @@ export default [
     },
     settings: {
       'import/parsers': {
-        '@typescript-eslint/parser': ['.ts', '.tsx']
+        '@typescript-eslint/parser': ['.ts']
       },
       'import/resolver': {
         node: {
-          extensions: ['.js', '.jsx', '.ts', '.tsx'],
+          extensions: ['.js', '.ts'],
           moduleDirectory: ['node_modules', 'src/']
         },
         typescript: {

jest.config.js

@@ -25,5 +25,7 @@ module.exports = {
     'web.tsx',
     'json',
     'node'
-  ]
+  ],
+  workerIdleMemoryLimit: '512MB', // Memory used per worker. Required to prevent memory leaks
+  maxWorkers: '50%' // Maximum tests ran in parallel. Required to prevent CPU usage at 100%
 };

src/apiCalls/index.ts

@@ -1,2 +1,3 @@
 export * from './configuration';
 export * from './endpoints';
+export * from './transactions';

src/apiCalls/transactions/index.ts

@@ -0,0 +1,2 @@
+export * from './getTransactionByHash';
+export * from './getTransactionsByHashes';

src/constants/index.ts

@@ -1,8 +1,9 @@
-export * from './network.constants';
-export * from './placeholders.constants';
-export * from './storage.constants';
-export * from './window.constants';
 export * from './browser.constants';
 export * from './errorMessages.constants';
 export * from './mvx.constants';
 export * from './ledger.constants';
+export * from './network.constants';
+export * from './placeholders.constants';
+export * from './storage.constants';
+export * from './transactions.constants';
+export * from './window.constants';

src/constants/mvx.constants.ts

@@ -1,14 +1,7 @@
-export const GAS_PRICE_MODIFIER = 0.01;
-export const GAS_PER_DATA_BYTE = 1500;
-export const GAS_LIMIT = 50000;
-/**
- * Extra gas limit for guarded transactions
- */
-export const EXTRA_GAS_LIMIT_GUARDED_TX = 50000;
-export const GAS_PRICE = 1000000000;
+export const ALL_SHARDS_SHARD_ID = 4294967280;
+export const CROSS_SHARD_ROUNDS = 5;
 export const DECIMALS = 18;
 export const DIGITS = 4;
-export const VERSION = 1;
 export const LEDGER_CONTRACT_DATA_ENABLED_VALUE = 1;
 export const METACHAIN_SHARD_ID = 4294967295;
-export const ALL_SHARDS_SHARD_ID = 4294967280;
+export const VERSION = 1;

src/constants/transactions.constants.ts

@@ -1,6 +1,12 @@
-export const CANCEL_TRANSACTION_TOAST_ID = 'cancel-transaction-toast';
 export const AVERAGE_TX_DURATION_MS = 6000;
-export const CROSS_SHARD_ROUNDS = 5;
-export const TRANSACTIONS_STATUS_POLLING_INTERVAL_MS = 90 * 1000; // 90sec
-export const TRANSACTIONS_STATUS_DROP_INTERVAL_MS = 10 * 60 * 1000; // 10min
 export const CANCEL_TRANSACTION_TOAST_DEFAULT_DURATION = 20000;
+export const CANCEL_TRANSACTION_TOAST_ID = 'cancel-transaction-toast';
+export const EXTRA_GAS_LIMIT_GUARDED_TX = 50_000;
+export const GAS_LIMIT = 50_000;
+export const GAS_PER_DATA_BYTE = 1_500;
+export const GAS_PRICE = 1_000_000_000;
+export const GAS_PRICE_MODIFIER = 0.01;
+export const REFUNDED_GAS = 'refundedGas';
+export const TRANSACTIONS_STATUS_DROP_INTERVAL_MS = 10 * 60 * 1000; // 10min
+export const TRANSACTIONS_STATUS_POLLING_INTERVAL_MS = 90 * 1000; // 90sec
+export const WALLET_SIGN_SESSION = 'signSession';

src/core/methods/initApp/initApp.ts

@@ -1,4 +1,6 @@
+import { safeWindow } from 'constants/index';
 import { restoreProvider } from 'core/providers/helpers/restoreProvider';
+import { ProviderFactory } from 'core/providers/ProviderFactory';
 import { getDefaultNativeAuthConfig } from 'services/nativeAuth/methods/getDefaultNativeAuthConfig';
 import { NativeAuthConfigType } from 'services/nativeAuth/nativeAuth.types';
 import { initializeNetwork } from 'store/actions';
@@ -30,7 +32,8 @@ const defaultInitAppProps = {
  * */
 export async function initApp({
   storage = defaultInitAppProps.storage,
-  dAppConfig
+  dAppConfig,
+  customProviders
 }: InitAppType) {
   initStore(storage.getStorageCallback);
 
@@ -57,6 +60,13 @@ export async function initApp({
 
   const isLoggedIn = getIsLoggedIn();
 
+  const usedProviders = [
+    ...((safeWindow as any)?.multiversx?.providers || []),
+    ...(customProviders || [])
+  ];
+
+  ProviderFactory.customProviders(usedProviders || []);
+
   if (isLoggedIn) {
     await restoreProvider();
     await registerWebsocketListener();

src/core/methods/initApp/initApp.types.ts

@@ -1,3 +1,4 @@
+import { ICustomProvider } from 'core/providers/types/providerFactory.types';
 import { NativeAuthConfigType } from 'services/nativeAuth/nativeAuth.types';
 import { StorageCallback } from 'store/storage';
 import { EnvironmentsEnum } from 'types/enums.types';
@@ -49,4 +50,5 @@ export type InitAppType = {
     getStorageCallback: StorageCallback;
   };
   dAppConfig: DappConfigType;
+  customProviders?: ICustomProvider[];
 };

src/core/methods/initApp/websocket/initializeWebsocketConnection.ts

@@ -7,7 +7,7 @@ import {
 } from 'store/actions/account/accountActions';
 import { networkSelector } from 'store/selectors';
 import { getStore } from 'store/store';
-import { retryMultipleTimes } from 'utils/retryMultipleTimes';
+import { retryMultipleTimes } from 'utils/misc/retryMultipleTimes';
 import {
   BatchTransactionsWSResponseType,
   websocketConnection,

src/core/methods/trackTransactions/helpers/checkTransactionStatus/checkBatch.ts

@@ -19,7 +19,7 @@ import { getPendingTransactions } from './getPendingTransactions';
 import { manageFailedTransactions } from './manageFailedTransactions';
 import { TransactionsTrackerType } from '../../trackTransactions.types';
 
-export interface TransactionStatusTrackerPropsType
+export interface TransactionStatusTrackerParamsType
   extends TransactionsTrackerType {
   sessionId: string;
   transactionBatch: SignedTransactionType[];
@@ -126,7 +126,7 @@ export async function checkBatch({
   isSequential,
   onSuccess,
   onFail
-}: TransactionStatusTrackerPropsType) {
+}: TransactionStatusTrackerParamsType) {
   try {
     if (transactions == null) {
       return;

src/core/providers/DappProvider/helpers/logout/logout.ts

@@ -1,5 +1,4 @@
 import { getAddress } from 'core/methods/account/getAddress';
-import { getProviderType } from 'core/providers/helpers/utils';
 import {
   IProvider,
   ProviderTypeEnum
@@ -26,7 +25,7 @@ const broadcastLogoutAcrossTabs = (address: string) => {
   storage.local.removeItem(localStorageKeys.logoutEvent);
 };
 
-export type LogoutPropsType = {
+export type LogoutParamsType = {
   shouldAttemptReLogin?: boolean;
   shouldBroadcastLogoutAcrossTabs?: boolean;
   /*
@@ -37,7 +36,7 @@ export type LogoutPropsType = {
 
 interface IProviderLogout {
   provider: IProvider;
-  options?: LogoutPropsType;
+  options?: LogoutParamsType;
 }
 
 export async function logout({
@@ -48,7 +47,6 @@ export async function logout({
   }
 }: IProviderLogout) {
   let address = getAddress();
-  const providerType = getProviderType(provider);
 
   if (options.shouldBroadcastLogoutAcrossTabs) {
     broadcastLogoutAcrossTabs(address);
@@ -59,7 +57,7 @@ export async function logout({
 
     if (
       options.hasConsentPopup &&
-      providerType === ProviderTypeEnum.crossWindow
+      provider.getType() === ProviderTypeEnum.crossWindow
     ) {
       (provider as unknown as CrossWindowProvider).setShouldShowConsentPopup(
         true

src/core/providers/DappProvider/helpers/signMessage/signMessage.ts

@@ -1,6 +1,5 @@
 import { Message, Address } from '@multiversx/sdk-core';
 import { getAddress } from 'core/methods/account/getAddress';
-import { getProviderType } from 'core/providers/helpers/utils';
 import {
   IProvider,
   ProviderTypeEnum
@@ -22,7 +21,6 @@ export async function signMessage({
   options
 }: SignMessageType): Promise<Nullable<Message>> {
   const address = getAddress();
-  const providerType = getProviderType(provider);
 
   const messageToSign = new Message({
     address: new Address(address),
@@ -31,7 +29,7 @@ export async function signMessage({
 
   if (
     options?.hasConsentPopup &&
-    providerType === ProviderTypeEnum.crossWindow
+    provider.getType() === ProviderTypeEnum.crossWindow
   ) {
     (provider as unknown as CrossWindowProvider).setShouldShowConsentPopup(
       true

src/core/providers/ProviderFactory.ts

@@ -11,19 +11,26 @@ import { getConfig } from './helpers/getConfig';
 import { createIframeProvider } from './helpers/iframe/createIframeProvider';
 import { createLedgerProvider } from './helpers/ledger/createLedgerProvider';
 import {
+  ICustomProvider,
   IProvider,
   IProviderFactory,
   ProviderTypeEnum
 } from './types/providerFactory.types';
 
 export class ProviderFactory {
-  public async create({
+  private static _customProviders: ICustomProvider[] = [];
+
+  public static customProviders(providers: ICustomProvider[]) {
+    this._customProviders = providers;
+  }
+
+  public static async create({
     type,
-    config: userConfig,
-    customProvider
+    config: userConfig
   }: IProviderFactory): Promise<DappProvider> {
     let createdProvider: IProvider | null = null;
-    const { account, ui } = await getConfig(userConfig);
+    const config = await getConfig(userConfig);
+    const { account, UI } = config;
 
     switch (type) {
       case ProviderTypeEnum.extension: {
@@ -47,10 +54,7 @@ export class ProviderFactory {
       }
 
       case ProviderTypeEnum.ledger: {
-        const ledgerProvider = await createLedgerProvider(
-          ui.ledger.eventBus,
-          ui.ledger.mount
-        );
+        const ledgerProvider = await createLedgerProvider(UI.ledger.mount);
 
         if (!ledgerProvider) {
           throw new Error('Unable to create ledger provider');
@@ -106,16 +110,15 @@ export class ProviderFactory {
         break;
       }
 
-      case ProviderTypeEnum.custom: {
-        if (!customProvider) {
-          throw new Error('Unable to create custom provider provider');
-        }
-        createdProvider = customProvider;
+      default: {
+        this._customProviders.forEach(async (customProvider) => {
+          if (customProvider.type === type) {
+            createdProvider = await customProvider.constructor(config);
+            createdProvider.getType = () => type;
+          }
+        });
         break;
       }
-
-      default:
-        break;
     }
 
     if (!createdProvider) {
@@ -125,7 +128,7 @@ export class ProviderFactory {
     const dappProvider = new DappProvider(createdProvider);
 
     setAccountProvider(dappProvider);
-    setProviderType(type);
+    setProviderType(type as ProviderTypeEnum);
 
     return dappProvider;
   }