@rango-dev/queue-manager-rango-preset 0.22.1-next.8 → 0.23.0

package/src/helpers.ts

@@ -1,13 +1,7 @@
 /* eslint-disable destructuring/in-params */
 /* eslint-disable @typescript-eslint/no-magic-numbers */
 /* eslint-disable @typescript-eslint/no-floating-promises */
-import type {
-  PendingSwap,
-  PendingSwapStep,
-  StepStatus,
-  SwapStatus,
-  Wallet,
-} from './shared';
+import type { SwapStatus, Wallet } from './shared';
 import type {
   ArrayElement,
   Step,
@@ -22,10 +16,10 @@ import type {
   QueueName,
   QueueType,
 } from '@rango-dev/queue-manager-core';
-import type { Providers } from '@rango-dev/wallets-react';
 import type {
   Meta,
   Network,
+  Providers,
   WalletState,
   WalletType,
 } from '@rango-dev/wallets-shared';
@@ -34,12 +28,23 @@ import type {
   EvmBlockchainMeta,
   Transaction,
 } from 'rango-sdk';
-import type { APIErrorCode, SignerErrorCode } from 'rango-types/lib';
+import type {
+  APIErrorCode,
+  PendingSwap,
+  PendingSwapStep,
+  SignerErrorCode,
+  StepStatus,
+} from 'rango-types';
 
 import { Status } from '@rango-dev/queue-manager-core';
-import { readAccountAddress } from '@rango-dev/wallets-react';
-import { getBlockChainNameFromId, Networks } from '@rango-dev/wallets-shared';
+import { readAccountAddress } from '@rango-dev/wallets-core';
+import {
+  getBlockChainNameFromId,
+  getEvmProvider,
+  splitWalletNetwork,
+} from '@rango-dev/wallets-shared';
 import { TransactionType } from 'rango-sdk';
+import { PendingSwapNetworkStatus } from 'rango-types';
 
 import {
   DEFAULT_ERROR_CODE,
@@ -57,7 +62,6 @@ import {
   getRelatedWalletOrNull,
   getScannerUrl,
   MessageSeverity,
-  PendingSwapNetworkStatus,
 } from './shared';
 import {
   mapAppErrorCodesToAPIErrorCode,
@@ -128,29 +132,6 @@ export function inMemoryTransactionsData() {
   };
 }
 
-/**
- * Sample inputs are:
- *  - "metamask-ETH"
- *  - "metamask-BSC-BSC:0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
- *  - "token-pocket-BSC-BSC:0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
- * Returns "wallet and network" separately, even if the wallet is dashed inside.
- *
- */
-
-export function splitWalletNetwork(input: string): string[] {
-  const removedAddressInput = input?.split(':')[0] || '';
-  const splittedInput = removedAddressInput.split('-');
-  const network = splittedInput[splittedInput.length - 1];
-  const walletNetwork = splittedInput.slice(0, -1);
-
-  if (walletNetwork[walletNetwork.length - 1] === network) {
-    walletNetwork.pop();
-  }
-  const wallet = walletNetwork.join('-');
-
-  return [wallet, network];
-}
-
 /**
  *
  * Returns `steps`, if it's a `running` swap.
@@ -361,7 +342,7 @@ export function updateSwapStatus({
       details && details.includes('Warning')
         ? 'Swap canceled by user.'
         : details;
-    const walletType = getRelatedWalletOrNull(swap, currentStep!)?.walletType;
+    const walletType = getRelatedWalletOrNull(swap, currentStep)?.walletType;
     swap.extraMessageSeverity = MessageSeverity.error;
 
     const failureType = mapAppErrorCodesToAPIErrorCode(errorCode);
@@ -624,25 +605,6 @@ export function isWalletNull(wallet: Wallet | null): boolean {
   );
 }
 
-/**
- * On our implementation for `wallets` package, We keep the instance in 2 ways
- * If it's a single chain wallet, it returns the instance directly,
- * If it's a multichain wallet, it returns a `Map` of instances.
- * This function will get the `ETHEREUM` instance in both types.
- */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export function getEvmProvider(providers: Providers, type: WalletType): any {
-  if (type && providers[type]) {
-    // we need this because provider can return an instance or a map of instances, so what you are doing here is try to detect that.
-    if (providers[type].size) {
-      return providers[type].get(Networks.ETHEREUM);
-    }
-
-    return providers[type];
-  }
-  return null;
-}
-
 /**
  * In a `PendingSwap`, each step needs a wallet to proceed,
  * By using this function we can access what wallet exactly we need to run current step.

package/src/index.ts

@@ -33,29 +33,21 @@ export {
   StepExecutionEventStatus,
   StepExecutionBlockedEventStatus,
 } from './types';
-export type {
-  PendingSwapWithQueueID,
-  PendingSwapStep,
-  PendingSwap,
-  EventType,
-} from './shared';
+export type { PendingSwapWithQueueID, EventType } from './shared';
 export {
   getCurrentBlockchainOfOrNull,
   getRelatedWalletOrNull,
   getRelatedWallet,
   MessageSeverity,
-  PendingSwapNetworkStatus,
   calculatePendingSwap,
 } from './shared';
 export {
   updateSwapStatus,
   checkWaitingForNetworkChange,
   getCurrentStep,
-  getEvmProvider,
   cancelSwap,
   getRequiredWallet,
   getRunningSwaps,
-  splitWalletNetwork,
   resetRunningSwapNotifsOnPageLoad,
   isApprovalTX,
   getLastSuccessfulStep,

package/src/migration.ts

@@ -1,11 +1,9 @@
-import {
-  PersistedQueue,
-  Persistor,
-  Status,
-  DB_NAME,
-} from '@rango-dev/queue-manager-core';
+import type { PersistedQueue } from '@rango-dev/queue-manager-core';
+import type { PendingSwap } from 'rango-types';
+
+import { DB_NAME, Persistor, Status } from '@rango-dev/queue-manager-core';
 import { v4 as uuid } from 'uuid';
-import { PendingSwap } from './shared';
+
 import { SwapActionTypes } from './types';
 
 const MIGRATED_KEY = 'migratedToQueueManager';
@@ -49,9 +47,9 @@ async function migration(): Promise<boolean> {
   const convertedSwaps: PersistedQueue[] = [];
 
   swaps.forEach((swap) => {
-    /* 
-      For running task we need to add some more work
-      We need to create a queue task to be run and resume the running task from queue manager.
+    /*
+     *For running task we need to add some more work
+     *We need to create a queue task to be run and resume the running task from queue manager.
      */
     if (swap.status === 'running') {
       const taskId = uuid();
@@ -112,7 +110,9 @@ async function migration(): Promise<boolean> {
   // Getting an instance from persistor, so we can directly put our data inside it.
   const persistor = new Persistor();
 
-  const promises = convertedSwaps.map((queue) => persistor.insertQueue(queue));
+  const promises = convertedSwaps.map(async (queue) =>
+    persistor.insertQueue(queue)
+  );
   await Promise.all(promises);
 
   // Mark as the data has been successfully migrated.

package/src/services/eventEmitter.ts

@@ -6,7 +6,7 @@ import type {
   Step,
   StepEvent,
 } from '../types';
-import type { PendingSwap, PendingSwapStep } from 'rango-types/lib';
+import type { PendingSwap, PendingSwapStep } from 'rango-types';
 
 import mitt from 'mitt';
 

package/src/shared-sentry.ts

@@ -1,6 +1,7 @@
+import type { WalletType } from '@rango-dev/wallets-shared';
+import type { PendingSwap, PendingSwapStep } from 'rango-types';
+
 import * as Sentry from '@sentry/browser';
-import { PendingSwap, PendingSwapStep } from './shared';
-import { WalletType } from '@rango-dev/wallets-shared';
 
 export function logRPCError(
   error: unknown,

package/src/shared.ts

@@ -1,20 +1,18 @@
 import type { Network, WalletType } from '@rango-dev/wallets-shared';
 import type {
-  AmountRestrictionType,
   BestRouteResponse,
   BlockchainMeta,
-  CosmosTransaction,
-  EvmTransaction,
   MetaResponse,
-  SimulationResult,
-  SolanaTransaction,
-  StarknetTransaction,
   SwapResult,
   Token,
-  Transfer as TransferTransaction,
-  TronTransaction,
 } from 'rango-sdk';
-import type { TonTransaction } from 'rango-types';
+import type {
+  PendingSwap,
+  PendingSwapStep,
+  SwapSavedSettings,
+  SwapStepRoute,
+  WalletTypeAndAddress,
+} from 'rango-types';
 
 import BigNumber from 'bignumber.js';
 import {
@@ -86,107 +84,6 @@ export type EventType =
   | 'route_failed_to_find'
   | 'transaction_expired';
 
-export type SwapSavedSettings = {
-  slippage: string;
-  disabledSwappersIds?: string[];
-  disabledSwappersGroups?: string[];
-  infiniteApprove?: boolean;
-};
-
-type InternalStepState =
-  | 'PENDING'
-  | 'CREATED'
-  | 'WAITING'
-  | 'SIGNED'
-  | 'SUCCESSED'
-  | 'FAILED';
-
-export type SwapperStatusStep = {
-  name: string;
-  state: InternalStepState;
-  current: boolean;
-};
-
-export enum PendingSwapNetworkStatus {
-  WaitingForConnectingWallet = 'waitingForConnectingWallet',
-  WaitingForQueue = 'waitingForQueue',
-  WaitingForNetworkChange = 'waitingForNetworkChange',
-  NetworkChanged = 'networkChanged',
-}
-
-export type SwapExplorerUrl = {
-  url: string;
-  description: string | null;
-};
-
-export type StepStatus =
-  | 'created'
-  | 'running'
-  | 'failed'
-  | 'success'
-  | 'waitingForApproval'
-  | 'approved';
-
-export type PendingSwapStep = {
-  // routing data
-  id: number;
-  fromBlockchain: string;
-  fromSymbol: string;
-  fromSymbolAddress: string | null;
-  fromDecimals: number;
-  fromAmountPrecision: string | null;
-  fromAmountMinValue: string | null;
-  fromAmountMaxValue: string | null;
-  fromAmountRestrictionType: AmountRestrictionType | null;
-  fromLogo: string;
-  toBlockchain: string;
-  toSymbol: string;
-  toSymbolAddress: string | null;
-  toDecimals: number;
-  toLogo: string;
-  swapperId: string;
-  expectedOutputAmountHumanReadable: string | null;
-  startTransactionTime: number;
-  internalSteps: SwapperStatusStep[] | null;
-  estimatedTimeInSeconds: number | null;
-
-  // status data
-  status: StepStatus;
-  networkStatus: PendingSwapNetworkStatus | null;
-  executedTransactionId: string | null;
-  executedTransactionTime: string | null;
-  explorerUrl: SwapExplorerUrl[] | null;
-  diagnosisUrl: string | null;
-  outputAmount: string | null;
-
-  // txs data
-  cosmosTransaction: CosmosTransaction | null;
-  transferTransaction: TransferTransaction | null;
-  solanaTransaction: SolanaTransaction | null;
-  evmApprovalTransaction: EvmTransaction | null;
-  evmTransaction: EvmTransaction | null;
-  tronApprovalTransaction: TronTransaction | null;
-  tronTransaction: TronTransaction | null;
-  starknetApprovalTransaction: StarknetTransaction | null;
-  starknetTransaction: StarknetTransaction | null;
-  tonTransaction: TonTransaction | null;
-
-  /*
-   * missing fields in older versions
-   * keeping null for backward compatability
-   */
-  swapperLogo: string | null;
-  swapperType: string | null;
-  fromBlockchainLogo: string | null;
-  toBlockchainLogo: string | null;
-  feeInUsd: string | null;
-};
-
-export type WalletTypeAndAddress = {
-  walletType: WalletType;
-  address: string;
-};
-
 export enum MessageSeverity {
   error = 'error',
   warning = 'warning',
@@ -196,28 +93,6 @@ export enum MessageSeverity {
 
 export type SwapStatus = 'running' | 'failed' | 'success';
 
-export type PendingSwap = {
-  creationTime: string;
-  finishTime: string | null;
-  requestId: string;
-  inputAmount: string;
-  status: SwapStatus;
-  isPaused: boolean;
-  extraMessage: string | null;
-  extraMessageSeverity: MessageSeverity | null;
-  extraMessageErrorCode: string | null;
-  extraMessageDetail: string | null | undefined;
-  networkStatusExtraMessage: string | null;
-  networkStatusExtraMessageDetail: string | null;
-  lastNotificationTime: string | null;
-  wallets: { [p: string]: WalletTypeAndAddress };
-  settings: SwapSavedSettings;
-  steps: PendingSwapStep[];
-  simulationResult: SimulationResult;
-  validateBalanceOrFee: boolean;
-  hasAlreadyProceededToSign?: boolean | null;
-};
-
 export const getCurrentBlockchainOfOrNull = (
   swap: PendingSwap,
   step: PendingSwapStep
@@ -358,8 +233,11 @@ export function getRelatedWallet(
 
 export function getRelatedWalletOrNull(
   swap: PendingSwap,
-  currentStep: PendingSwapStep
+  currentStep: PendingSwapStep | null
 ): WalletTypeAndAddress | null {
+  if (!currentStep) {
+    return null;
+  }
   try {
     return getRelatedWallet(swap, currentStep);
   } catch (e) {
@@ -407,6 +285,49 @@ export function getUsdFeeOfStep(
   return totalFeeInUsd;
 }
 
+function mapSwapStepToPendingSwapStep(
+  swap: SwapResult,
+  meta: Pick<MetaResponse, 'blockchains' | 'tokens'> | null
+): SwapStepRoute {
+  return {
+    // from
+    fromBlockchain: swap.from.blockchain,
+    fromBlockchainLogo: swap.from.blockchainLogo,
+    fromLogo: swap.from.logo,
+    fromSymbol: swap.from.symbol,
+    fromSymbolAddress: swap.from.address,
+    fromDecimals: swap.from.decimals,
+    fromAmountPrecision: swap.fromAmountPrecision,
+    fromAmountMinValue: swap.fromAmountMinValue,
+    fromAmountMaxValue: swap.fromAmountMaxValue,
+    fromAmountRestrictionType: swap.fromAmountRestrictionType,
+    fromUsdPrice: swap.from.usdPrice,
+
+    // to
+    toBlockchain: swap.to.blockchain,
+    toBlockchainLogo: swap.to.blockchainLogo,
+    toSymbol: swap.to.symbol,
+    toSymbolAddress: swap.to.address,
+    toDecimals: swap.to.decimals,
+    toLogo: swap.to.logo,
+    toUsdPrice: swap.to.usdPrice,
+
+    // swapper
+    swapperId: swap.swapperId,
+    swapperLogo: swap.swapperLogo,
+    swapperType: swap.swapperType,
+
+    // route
+    expectedOutputAmountHumanReadable: swap.toAmount,
+    feeInUsd: meta
+      ? // eslint-disable-next-line @typescript-eslint/no-magic-numbers
+        numberToString(getUsdFeeOfStep(swap, meta?.tokens), null, 8)
+      : null,
+    estimatedTimeInSeconds: swap.estimatedTimeInSeconds || null,
+    internalSteps: null,
+  };
+}
+
 export function calculatePendingSwap(
   inputAmount: string,
   bestRoute: BestRouteResponse,
@@ -440,44 +361,23 @@ export function calculatePendingSwap(
     validateBalanceOrFee,
     steps:
       bestRoute.result?.swaps?.map((swap, index) => {
+        const stepRoute = mapSwapStepToPendingSwapStep(swap, meta);
         return {
           id: index + 1,
 
-          // from
-          fromBlockchain: swap.from.blockchain,
-          fromBlockchainLogo: swap.from.blockchainLogo,
-          fromLogo: swap.from.logo,
-          fromSymbol: swap.from.symbol,
-          fromSymbolAddress: swap.from.address,
-          fromDecimals: swap.from.decimals,
-          fromAmountPrecision: swap.fromAmountPrecision,
-          fromAmountMinValue: swap.fromAmountMinValue,
-          fromAmountMaxValue: swap.fromAmountMaxValue,
-          fromAmountRestrictionType: swap.fromAmountRestrictionType,
-
-          // to
-          toBlockchain: swap.to.blockchain,
-          toBlockchainLogo: swap.to.blockchainLogo,
-          toSymbol: swap.to.symbol,
-          toSymbolAddress: swap.to.address,
-          toDecimals: swap.to.decimals,
-          toLogo: swap.to.logo,
-
-          // swapper
-          swapperId: swap.swapperId,
-          swapperLogo: swap.swapperLogo,
-          swapperType: swap.swapperType,
-
-          // output, fee, timing
-          expectedOutputAmountHumanReadable: swap.toAmount,
-          outputAmount: '',
-          feeInUsd: meta
-            ? // eslint-disable-next-line @typescript-eslint/no-magic-numbers
-              numberToString(getUsdFeeOfStep(swap, meta?.tokens), null, 8)
-            : null,
-          estimatedTimeInSeconds: swap.estimatedTimeInSeconds || null,
+          // route
+          ...stepRoute,
+          internalSwaps:
+            swap?.internalSwaps?.map((internalSwap) => {
+              const stepRoute = mapSwapStepToPendingSwapStep(
+                internalSwap,
+                meta
+              );
+              return stepRoute;
+            }) || null,
 
           // status, tracking
+          outputAmount: '',
           status: 'created',
           networkStatus: null,
           startTransactionTime: new Date().getTime(),

package/src/types.ts

@@ -1,10 +1,14 @@
-import type { PendingSwap, PendingSwapStep, Wallet } from './shared';
-import type { QueueDef, QueueStorage } from '@rango-dev/queue-manager-core';
-import type { QueueContext } from '@rango-dev/queue-manager-core/dist/queue';
-import type { ConnectResult, Providers } from '@rango-dev/wallets-react';
+import type { Wallet } from './shared';
+import type {
+  QueueContext,
+  QueueDef,
+  QueueStorage,
+} from '@rango-dev/queue-manager-core';
+import type { ConnectResult } from '@rango-dev/wallets-core';
 import type {
   Meta,
   Network,
+  Providers,
   WalletState,
   WalletType,
 } from '@rango-dev/wallets-shared';
@@ -12,6 +16,8 @@ import type { Transaction } from 'rango-sdk';
 import type {
   APIErrorCode,
   EvmBlockchainMeta,
+  PendingSwap,
+  PendingSwapStep,
   SignerFactory,
 } from 'rango-types';