[DDW 1034]: Refactor error handling for reward only wallets

Author: shawnbusuttil

source/renderer/app/api/api.ts

@@ -228,6 +228,7 @@ import Asset from '../domains/Asset';
 import { getAssets } from './assets/requests/getAssets';
 import { getAccountPublicKey } from './wallets/requests/getAccountPublicKey';
 import { doesWalletRequireAdaToRemainToSupportTokens } from './utils/apiHelpers';
+import { handleNotEnoughMoneyError } from './errors';
 
 export default class AdaApi {
   config: RequestConfig;
@@ -1059,51 +1060,14 @@ export default class AdaApi {
         minimumAda,
       };
     } catch (error) {
-      let notEnoughMoneyError;
-
-      if (walletBalance.gt(availableBalance)) {
-        // 1. Amount exceeds availableBalance due to pending transactions:
-        // - walletBalance > availableBalance
-        // = show "Cannot calculate fees while there are pending transactions."
-        notEnoughMoneyError = 'canNotCalculateTransactionFees';
-      } else if (
-        !walletBalance.isZero() &&
-        walletBalance.isEqualTo(rewardsBalance)
-      ) {
-        // 2. Wallet contains only rewards:
-        // - walletBalance === rewardsBalance
-        // = show "Cannot send from a wallet that contains only rewards balances."
-        notEnoughMoneyError = 'inputsDepleted';
-      } else {
-        // 3. Amount exceeds walletBalance:
-        // - walletBalance === availableBalance
-        // = show "Not enough Ada. Try sending a smaller amount."
-        notEnoughMoneyError = 'notEnoughFundsForTransaction';
-      }
-
-      // ApiError with logging showcase
-      throw new ApiError(error, {
-        // @ts-ignore ts-migrate(2322) FIXME: Type 'boolean' is not assignable to type 'Record<s... Remove this comment to see the full error message
-        logError: true,
-        msg: 'AdaApi::calculateTransactionFee error',
-      })
-        .set(notEnoughMoneyError, true)
-        .where('code', 'not_enough_money')
-        .set('utxoTooSmall', true, {
-          // @ts-ignore ts-migrate(2339) FIXME: Property 'exec' does not exist on type '{}'.
-          minimumAda: get(
-            /(Expected min coin value: +)([0-9]+.[0-9]+)/.exec(error.message),
-            2,
-            0
-          ),
-        })
-        .where('code', 'utxo_too_small')
-        .set('invalidAddress')
-        .where('code', 'bad_request')
-        .inc('message', 'Unable to decode Address')
-        .result();
+      handleNotEnoughMoneyError(error, {
+        walletBalance,
+        availableBalance,
+        rewardsBalance,
+      });
     }
   };
+
   selectCoins = async (request: {
     walletId: string;
     walletBalance: BigNumber;
@@ -1267,48 +1231,12 @@ export default class AdaApi {
       logger.error('AdaApi::selectCoins error', {
         error,
       });
-      let notEnoughMoneyError;
 
-      if (walletBalance.gt(availableBalance)) {
-        // 1. Amount exceeds availableBalance due to pending transactions:
-        // - walletBalance > availableBalance
-        // = show "Cannot calculate fees while there are pending transactions."
-        notEnoughMoneyError = 'canNotCalculateTransactionFees';
-      } else if (
-        !walletBalance.isZero() &&
-        walletBalance.isEqualTo(rewardsBalance)
-      ) {
-        // 2. Wallet contains only rewards:
-        // - walletBalance === rewardsBalance
-        // = show "Cannot send from a wallet that contains only rewards balances."
-        notEnoughMoneyError = 'inputsDepleted';
-      } else {
-        // 3. Amount exceeds walletBalance:
-        // - walletBalance === availableBalance
-        // = show "Not enough Ada. Try sending a smaller amount."
-        notEnoughMoneyError = 'notEnoughFundsForTransaction';
-      }
-
-      // ApiError with logging showcase
-      throw new ApiError(error, {
-        // @ts-ignore ts-migrate(2322) FIXME: Type 'boolean' is not assignable to type 'Record<s... Remove this comment to see the full error message
-        logError: true,
-        msg: 'AdaApi::calculateTransactionFee error',
-      })
-        .set(notEnoughMoneyError, true)
-        .where('code', 'not_enough_money')
-        .set('utxoTooSmall', true, {
-          minimumAda: get(
-            /(Expected min coin value: +)([0-9]+.[0-9]+)/.exec(error.message),
-            2,
-            0
-          ),
-        })
-        .where('code', 'utxo_too_small')
-        .set('invalidAddress')
-        .where('code', 'bad_request')
-        .inc('message', 'Unable to decode Address')
-        .result();
+      handleNotEnoughMoneyError(error, {
+        walletBalance,
+        availableBalance,
+        rewardsBalance,
+      });
     }
   };
   createExternalTransaction = async (

source/renderer/app/api/errors.ts

@@ -1,5 +1,8 @@
+import BigNumber from 'bignumber.js';
 import { defineMessages } from 'react-intl';
 
+import ApiError, { ErrorType } from '../domains/ApiError';
+
 export const messages = defineMessages({
   // common
   wrongEncryptionPassphrase: {
@@ -119,3 +122,60 @@ export const messages = defineMessages({
       '"Balance after transaction would not leave enough ada in the wallet to support tokens remaining in wallet',
   },
 });
+
+type Balances = {
+  walletBalance: BigNumber;
+  availableBalance: BigNumber;
+  rewardsBalance: BigNumber;
+};
+
+export const handleNotEnoughMoneyError = (
+  error: ErrorType,
+  balance: Balances
+) => {
+  let notEnoughMoneyError;
+
+  const { walletBalance, availableBalance, rewardsBalance } = balance;
+
+  if (walletBalance.gt(availableBalance)) {
+    // 1. Amount exceeds availableBalance due to pending transactions:
+    // - walletBalance > availableBalance
+    // = show "Cannot calculate fees while there are pending transactions."
+    notEnoughMoneyError = 'canNotCalculateTransactionFees';
+  } else if (
+    !walletBalance.isZero() &&
+    walletBalance.isEqualTo(rewardsBalance)
+  ) {
+    // 2. Wallet contains only rewards:
+    // - walletBalance === rewardsBalance
+    // = show "Cannot send from a wallet that contains only rewards balances."
+    notEnoughMoneyError = 'inputsDepleted';
+  } else {
+    // 3. Amount exceeds walletBalance:
+    // - walletBalance === availableBalance
+    // = show "Not enough Ada. Try sending a smaller amount."
+    notEnoughMoneyError = 'notEnoughFundsForTransaction';
+  }
+
+  // ApiError with logging showcase
+  throw new ApiError(error, {
+    // @ts-ignore ts-migrate(2322) FIXME: Type 'boolean' is not assignable to type 'Record<s... Remove this comment to see the full error message
+    logError: true,
+    msg: 'AdaApi::calculateTransactionFee error',
+  })
+    .set(notEnoughMoneyError, true)
+    .where('code', 'not_enough_money')
+    .set('utxoTooSmall', true, {
+      // @ts-ignore ts-migrate(2339) FIXME: Property 'exec' does not exist on type '{}'.
+      minimumAda: get(
+        /(Expected min coin value: +)([0-9]+.[0-9]+)/.exec(error.message),
+        2,
+        0
+      ),
+    })
+    .where('code', 'utxo_too_small')
+    .set('invalidAddress')
+    .where('code', 'bad_request')
+    .inc('message', 'Unable to decode Address')
+    .result();
+};