@rango-dev/queue-manager-rango-preset 0.1.10-next.98 → 0.1.11-next.2

package/src/shared.ts

@@ -8,10 +8,16 @@ import {
   StarknetTransaction,
   TronTransaction,
   Transfer as TransferTransaction,
+  AmountRestrictionType,
+  BestRouteResponse,
+  MetaResponse,
+  Token,
+  SwapResult,
 } from 'rango-sdk';
 
-import { ErrorDetail, PrettyError } from './shared-errors';
-import { SignerError } from 'rango-types';
+import { PrettyError } from './shared-errors';
+import BigNumber from 'bignumber.js';
+import { numberToString } from './numbers';
 
 export interface PendingSwapWithQueueID {
   id: string;
@@ -57,8 +63,10 @@ export type EventType =
   | 'task_canceled'
   | 'task_paused'
   | 'contract_confirmed'
+  | 'confirm_approve_contract'
   | 'contract_rejected'
-  | 'transfer_confirmed'
+  | 'check_tx_status'
+  | 'check_approve_tx_status'
   | 'transfer_rejected'
   | 'calling_smart_contract'
   | 'smart_contract_called'
@@ -66,17 +74,19 @@ export type EventType =
   | 'step_completed_with_output'
   | 'waiting_for_network_change'
   | 'waiting_for_connecting_wallet'
+  | 'waiting_for_change_wallet_account'
   | 'network_changed'
   | 'not_enough_balance'
+  | 'waiting_for_queue'
   | 'check_fee_failed'
   | 'route_failed_to_find'
   | 'transaction_expired';
 
 export type SwapSavedSettings = {
   slippage: string;
-  disabledSwappersIds: string[];
-  disabledSwappersGroups: string[];
-  infiniteApprove: boolean;
+  disabledSwappersIds?: string[];
+  disabledSwappersGroups?: string[];
+  infiniteApprove?: boolean;
 };
 
 type InternalStepState =
@@ -105,19 +115,6 @@ export type SwapExplorerUrl = {
   description: string | null;
 };
 
-export type SwapperId =
-  | 'ThorChain'
-  | 'OneInchEth'
-  | 'Binance Bridge'
-  | 'OneInchBsc'
-  | 'OneInchPolygon'
-  | 'Terra Bridge'
-  | 'TerraSwap'
-  | 'Osmosis'
-  | 'Lido'
-  | 'PoS Bridge'
-  | 'Wormhole';
-
 export type StepStatus =
   | 'created'
   | 'running'
@@ -127,39 +124,55 @@ export type StepStatus =
   | 'approved';
 
 export type PendingSwapStep = {
+  // routing data
   id: number;
-  fromBlockchain: Network;
+  fromBlockchain: string;
   fromSymbol: string;
   fromSymbolAddress: string | null;
   fromDecimals: number;
-  fromAmountPrecision: number | null;
-  fromAmountMinValue: number | null;
-  fromAmountMaxValue: number | null;
+  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: SwapperId;
+  swapperId: string;
   expectedOutputAmountHumanReadable: string | null;
   startTransactionTime: number;
-  outputAmount: string | null;
+  internalSteps: SwapperStatusStep[] | null;
+  estimatedTimeInSeconds: number | null;
+
+  // status data
   status: StepStatus;
   networkStatus: PendingSwapNetworkStatus | null;
   executedTransactionId: string | null;
+  executedTransactionTime: string | null;
   explorerUrl: SwapExplorerUrl[] | null;
-  evmApprovalTransaction: EvmTransaction | null;
-  evmTransaction: EvmTransaction | null;
+  diagnosisUrl: string | null;
+  outputAmount: string | null;
+
+  // txs data
   cosmosTransaction: CosmosTransaction | null;
   transferTransaction: TransferTransaction | null;
   solanaTransaction: SolanaTransaction | null;
-  starknetTransaction: StarknetTransaction | null;
-  starknetApprovalTransaction: StarknetTransaction | null;
-  tronTransaction: TronTransaction | null;
+  evmApprovalTransaction: EvmTransaction | null;
+  evmTransaction: EvmTransaction | null;
   tronApprovalTransaction: TronTransaction | null;
-  diagnosisUrl: string | null;
-  internalSteps: SwapperStatusStep[] | null;
+  tronTransaction: TronTransaction | null;
+  starknetApprovalTransaction: StarknetTransaction | null;
+  starknetTransaction: StarknetTransaction | 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 = {
@@ -273,30 +286,6 @@ export const getTronApproveUrl = (tx: string): string => {
   );
 };
 
-export const prettifyErrorMessage = (obj: unknown): ErrorDetail => {
-  if (!obj) return { extraMessage: '', extraMessageErrorCode: null };
-  if (obj instanceof PrettyError) return obj.getErrorDetail();
-  if (obj instanceof SignerError) {
-    const t = obj.getErrorDetail();
-    return {
-      extraMessage: t.message,
-      extraMessageDetail: t.detail,
-      extraMessageErrorCode: t.code,
-    };
-  }
-  if (obj instanceof Error)
-    return {
-      extraMessage: obj.toString(),
-      extraMessageErrorCode: null,
-    };
-  if (typeof obj !== 'string')
-    return {
-      extraMessage: JSON.stringify(obj),
-      extraMessageErrorCode: null,
-    };
-  return { extraMessage: obj, extraMessageErrorCode: null };
-};
-
 export function getNextStep(
   swap: PendingSwap,
   currentStep: PendingSwapStep
@@ -311,7 +300,9 @@ export function getNextStep(
   );
 }
 
-// TODO:  we have samething in `helpers`, for fixing circular dependency, we copied and should be removed eventually.
+/**
+ * Returns the wallet address, based on the current step of `PendingSwap`.
+ */
 export const getCurrentAddressOf = (
   swap: PendingSwap,
   step: PendingSwapStep
@@ -319,6 +310,10 @@ export const getCurrentAddressOf = (
   const result =
     swap.wallets[step.evmTransaction?.blockChain || ''] ||
     swap.wallets[step.evmApprovalTransaction?.blockChain || ''] ||
+    swap.wallets[step.tronTransaction?.blockChain || ''] ||
+    swap.wallets[step.tronApprovalTransaction?.blockChain || ''] ||
+    swap.wallets[step.starknetTransaction?.blockChain || ''] ||
+    swap.wallets[step.starknetApprovalTransaction?.blockChain || ''] ||
     swap.wallets[step.cosmosTransaction?.blockChain || ''] ||
     swap.wallets[step.solanaTransaction?.blockChain || ''] ||
     (step.transferTransaction?.fromWalletAddress
@@ -329,7 +324,6 @@ export const getCurrentAddressOf = (
   return result.address;
 };
 
-// TODO:  we have samething in `helpers`, for fixing circular dependency, we copied and should be removed eventually.
 export function getRelatedWallet(
   swap: PendingSwap,
   currentStep: PendingSwapStep
@@ -360,3 +354,138 @@ export function getRelatedWalletOrNull(
     return null;
   }
 }
+
+export const getUsdPrice = (
+  blockchain: string,
+  symbol: string,
+  address: string | null,
+  allTokens: Token[]
+): number | null => {
+  const token = allTokens?.find(
+    (t) =>
+      t.blockchain === blockchain &&
+      t.symbol?.toUpperCase() === symbol?.toUpperCase() &&
+      t.address === address
+  );
+  return token?.usdPrice || null;
+};
+
+export function getUsdFeeOfStep(
+  step: SwapResult,
+  allTokens: Token[]
+): BigNumber {
+  let totalFeeInUsd = new BigNumber(0);
+  for (let i = 0; i < step.fee.length; i++) {
+    const fee = step.fee[i];
+    if (fee.expenseType === 'DECREASE_FROM_OUTPUT') continue;
+
+    const unitPrice = getUsdPrice(
+      fee.asset.blockchain,
+      fee.asset.symbol,
+      fee.asset.address,
+      allTokens
+    );
+    totalFeeInUsd = totalFeeInUsd.plus(
+      new BigNumber(fee.amount).multipliedBy(unitPrice || 0)
+    );
+  }
+
+  return totalFeeInUsd;
+}
+
+export function calculatePendingSwap(
+  inputAmount: string,
+  bestRoute: BestRouteResponse,
+  wallets: { [p: string]: WalletTypeAndAddress },
+  settings: SwapSavedSettings,
+  validateBalanceOrFee: boolean,
+  meta: MetaResponse | null
+): PendingSwap {
+  const simulationResult = bestRoute.result;
+  if (!simulationResult) throw Error('Simulation result should not be null');
+
+  return {
+    creationTime: new Date().getTime().toString(),
+    finishTime: null,
+    requestId: bestRoute.requestId || '',
+    inputAmount: inputAmount,
+    wallets,
+    status: 'running',
+    isPaused: false,
+    extraMessage: null,
+    extraMessageSeverity: null,
+    extraMessageDetail: null,
+    extraMessageErrorCode: null,
+    networkStatusExtraMessage: null,
+    networkStatusExtraMessageDetail: null,
+    lastNotificationTime: null,
+    settings: settings,
+    simulationResult: simulationResult,
+    validateBalanceOrFee,
+    steps:
+      bestRoute.result?.swaps?.map((swap, index) => {
+        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
+            ? numberToString(getUsdFeeOfStep(swap, meta?.tokens), null, 8)
+            : null,
+          estimatedTimeInSeconds: swap.estimatedTimeInSeconds || null,
+
+          // status, tracking
+          status: 'created',
+          networkStatus: null,
+          startTransactionTime: new Date().getTime(),
+          externalTransactionId: null,
+          executedTransactionId: null,
+          executedTransactionTime: null,
+          explorerUrl: null,
+          diagnosisUrl: null,
+          trackingCode: null,
+          internalSteps: null,
+
+          // transactions
+          evmTransaction: null,
+          evmApprovalTransaction: null,
+          starknetTransaction: null,
+          starknetApprovalTransaction: null,
+          tronTransaction: null,
+          tronApprovalTransaction: null,
+          cosmosTransaction: null,
+          solanaTransaction: null,
+          transferTransaction: null,
+
+          // front fields
+          hasAlreadyProceededToSign: false,
+        };
+      }) || [],
+  };
+}

package/src/types.ts

@@ -72,4 +72,5 @@ export interface UseQueueManagerParams {
   disconnectedWallet: WalletType | undefined;
   clearDisconnectedWallet: () => void;
   evmChains: EvmBlockchainMeta[];
+  notifier: SwapQueueContext['notifier'];
 }