Merge pull request #2966 from input-output-hk/fix/ddw-1086-fix-phrasing-of-insufficient-funds-for-tokens-message

[DDW-1086] Fix phrasing of insufficient funds for tokens message

Author: DominikGuzei

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## vNext
+
+### Fixes
+
+- Fixed phrasing of insufficient funds for tokens message ([PR 2966](https://github.com/input-output-hk/daedalus/pull/2966))
+
 ## 4.10.0
 
 ### Features

source/renderer/app/api/api.ts

@@ -906,13 +906,15 @@ export default class AdaApi {
 
       const {
         requiresAdaToRemainToSupportNativeTokens,
-        adaToRemain,
+        adaToProceed,
       } = doesWalletRequireAdaToRemainToSupportTokens(
         error,
         hasAssetsRemainingAfterTransaction
       );
       if (requiresAdaToRemainToSupportNativeTokens) {
-        apiError.set('cannotLeaveWalletEmpty', true, { adaToRemain });
+        apiError.set('cannotLeaveWalletEmpty', true, {
+          adaAmount: adaToProceed,
+        });
       }
 
       throw apiError.result();

source/renderer/app/api/errors.ts

@@ -114,7 +114,7 @@ export const messages = defineMessages({
   cannotLeaveWalletEmpty: {
     id: 'api.errors.NotEnoughFundsForTransactionFeesErrorWithTokens',
     defaultMessage:
-      '!!!Insufficient funds to support tokens. A minimum of {adaToRemain} ADA must remain in the wallet after this transaction.',
+      '!!!Insufficient funds to support tokens. You need at least an additional {adaAmount} ADA in your wallet to process this transaction.',
     description:
       '"Balance after transaction would not leave enough ada in the wallet to support tokens remaining in wallet',
   },

source/renderer/app/api/utils/apiHelpers.spec.ts

@@ -48,20 +48,8 @@ describe('throw error if not enough Ada to support tokens', () => {
       requiresAdaToRemainToSupportNativeTokens: false,
     });
   });
-  it('should throw if there are tokens remaining in wallet after transaction and error is "cannot_cover_fee" and round to 2 minimum ada', () => {
-    const error: ErrorType = {
-      message:
-        'I am unable to finalize the transaction, as there is not enough ada available to pay for the fee and also pay for the minimum ada quantities of all change outputs. I need approximately 0.629344 ada to proceed. Try increasing your wallet balance or sending a smaller amount.',
-      code: 'cannot_cover_fee',
-    };
-
-    expect(doesWalletRequireAdaToRemainToSupportTokens(error, true)).toEqual({
-      requiresAdaToRemainToSupportNativeTokens: true,
-      adaToRemain: 2,
-    });
-  });
 
-  it('should throw if there are tokens remaining in wallet after transaction and error is "cannot_cover_fee" and round to 2 nearest whole value provided by error', () => {
+  it('should throw if there are tokens remaining in wallet after transaction and error is "cannot_cover_fee"', () => {
     const error: ErrorType = {
       message:
         'I am unable to finalize the transaction, as there is not enough ada available to pay for the fee and also pay for the minimum ada quantities of all change outputs. I need approximately 2.629344 ada to proceed. Try increasing your wallet balance or sending a smaller amount.',
@@ -70,7 +58,7 @@ describe('throw error if not enough Ada to support tokens', () => {
 
     expect(doesWalletRequireAdaToRemainToSupportTokens(error, true)).toEqual({
       requiresAdaToRemainToSupportNativeTokens: true,
-      adaToRemain: 3,
+      adaToProceed: 3,
     });
   });
 });

source/renderer/app/api/utils/apiHelpers.ts

@@ -27,22 +27,21 @@ export const doesWalletRequireAdaToRemainToSupportTokens = (
   hasAssetsRemainingAfterTransaction?: boolean
 ): {
   requiresAdaToRemainToSupportNativeTokens: boolean;
-  adaToRemain?: number;
+  adaToProceed?: number;
 } => {
-  const adaToProceedRegex = new RegExp(
-    /.*I need approximately([\s\d.,]+)ada to proceed.*/
-  );
+  const adaToProceedRegex = /I need approximately\s+([\d.,]+)\s+ada to proceed/;
+
+  const [, adaToProceed] = adaToProceedRegex.exec(error.message) ?? [];
 
   if (
     error.code === 'cannot_cover_fee' &&
     hasAssetsRemainingAfterTransaction &&
-    adaToProceedRegex.test(error.message)
+    adaToProceed
   ) {
-    const roundedAda = Math.ceil(
-      Number(error.message.replace(adaToProceedRegex, '$1'))
-    );
-    const adaToRemain = roundedAda > 2 ? roundedAda : 2;
-    return { requiresAdaToRemainToSupportNativeTokens: true, adaToRemain };
+    return {
+      requiresAdaToRemainToSupportNativeTokens: true,
+      adaToProceed: Math.ceil(Number(adaToProceed)),
+    };
   }
   return { requiresAdaToRemainToSupportNativeTokens: false };
 };

source/renderer/app/containers/wallet/dialogs/send-confirmation/helpers.spec.ts

@@ -0,0 +1,88 @@
+import BigNumber from 'bignumber.js';
+import { hasAssetsAfterTransaction } from './helpers';
+
+const assetWithOneQuantity = {
+  policyId: 'policyId1',
+  assetName: '54657374636f696e',
+  quantity: new BigNumber(1),
+  fingerprint: 'policyId154657374636f696e',
+  metadata: {
+    name: 'Testcoin',
+    description: 'Test coin',
+  },
+  uniqueId: 'uniqueId1',
+  decimals: 1,
+  recommendedDecimals: null,
+};
+
+const assetWithTenQuantity = {
+  policyId: 'policyId2',
+  assetName: '436f696e74657374',
+  quantity: new BigNumber(10),
+  fingerprint: 'policyId2436f696e74657374',
+  uniqueId: 'uniqueId2',
+  decimals: 1,
+  recommendedDecimals: null,
+};
+
+describe('hasAssetsAfterTransaction', () => {
+  test('Should be true when wallet has assets and tx sending no assets', () => {
+    expect(
+      hasAssetsAfterTransaction({
+        assetTokens: [assetWithOneQuantity, assetWithTenQuantity],
+        selectedAssets: [],
+        assetsAmounts: [],
+      })
+    ).toEqual(true);
+  });
+
+  test('Should be true when wallet has assets and tx is not sending all asset types', () => {
+    expect(
+      hasAssetsAfterTransaction({
+        assetTokens: [assetWithOneQuantity, assetWithTenQuantity],
+        selectedAssets: [assetWithTenQuantity],
+        assetsAmounts: ['5'],
+      })
+    ).toEqual(true);
+  });
+
+  test('Should be true when wallet has assets and tx is not sending all assets', () => {
+    expect(
+      hasAssetsAfterTransaction({
+        assetTokens: [assetWithOneQuantity, assetWithTenQuantity],
+        selectedAssets: [assetWithOneQuantity, assetWithTenQuantity],
+        assetsAmounts: ['1', '5'],
+      })
+    ).toEqual(true);
+  });
+
+  test('Should be false when wallet has no assets', () => {
+    expect(
+      hasAssetsAfterTransaction({
+        assetTokens: [],
+        selectedAssets: [],
+        assetsAmounts: [],
+      })
+    ).toEqual(false);
+  });
+
+  test('Should be false when tx is sending all assets (1 asset)', () => {
+    expect(
+      hasAssetsAfterTransaction({
+        assetTokens: [assetWithOneQuantity],
+        selectedAssets: [assetWithOneQuantity],
+        assetsAmounts: ['1'],
+      })
+    ).toEqual(false);
+  });
+
+  test('Should be false when tx is sending all assets (2 assets)', () => {
+    expect(
+      hasAssetsAfterTransaction({
+        assetTokens: [assetWithOneQuantity, assetWithTenQuantity],
+        selectedAssets: [assetWithOneQuantity, assetWithTenQuantity],
+        assetsAmounts: ['1', '10'],
+      })
+    ).toEqual(false);
+  });
+});

source/renderer/app/containers/wallet/dialogs/send-confirmation/helpers.ts

@@ -7,7 +7,12 @@ import { AssetToken } from '../../../../api/assets/types';
 import { HwDeviceStatuses } from '../../../../domains/Wallet';
 import { FORM_VALIDATION_DEBOUNCE_WAIT } from '../../../../config/timingConfig';
 import { formattedTokenWalletAmount } from '../../../../utils/formatters';
-import { CreateForm, FormFields, HasAssetsAfterTransaction } from './types';
+import {
+  CreateForm,
+  FormFields,
+  HasAssetsAfterTransaction,
+  IsSendingAllFromSelected,
+} from './types';
 
 export const doTermsNeedAcceptance = ({ isFlight, areTermsAccepted }) =>
   !areTermsAccepted && isFlight;
@@ -25,13 +30,32 @@ export const isNotEnoughFundsForTokenError = (errorId) =>
 export const isPasswordValid = ({ isHardwareWallet, isValid }) =>
   isHardwareWallet || isValid;
 
+export const isSendingAllFromSelected = ({
+  selectedAssets = [],
+  assetsAmounts = [],
+}: IsSendingAllFromSelected) =>
+  Boolean(selectedAssets.length) &&
+  selectedAssets.every(({ quantity }, i) =>
+    quantity.isEqualTo(assetsAmounts?.[i])
+  );
+
 export const hasAssetsAfterTransaction = ({
   selectedAssets = [],
   assetTokens = [],
-}: HasAssetsAfterTransaction) =>
-  selectedAssets.length
-    ? selectedAssets.length < assetTokens.length
-    : assetTokens.length > 0;
+  assetsAmounts = [],
+}: HasAssetsAfterTransaction) => {
+  const sendingTokens = Boolean(selectedAssets.length);
+  const hasTokens = Boolean(assetTokens.length);
+  const sendingAllTokenTypes = selectedAssets.length === assetTokens.length;
+  const sendingAllFromSelected = isSendingAllFromSelected({
+    assetsAmounts,
+    selectedAssets,
+  });
+
+  return sendingTokens
+    ? !(sendingAllTokenTypes && sendingAllFromSelected)
+    : hasTokens;
+};
 
 export const getFormattedAssetAmount = (
   { metadata, decimals }: AssetToken,

source/renderer/app/containers/wallet/dialogs/send-confirmation/hooks.ts

@@ -39,6 +39,7 @@ export const useForm = ({
             hasAssetsRemainingAfterTransaction: hasAssetsAfterTransaction({
               assetTokens,
               selectedAssets,
+              assetsAmounts,
             }),
             ...(selectedAssets.length
               ? { assets: selectedAssets, assetsAmounts }

source/renderer/app/containers/wallet/dialogs/send-confirmation/types.ts

@@ -94,5 +94,10 @@ export type CreateForm = Pick<ViewProps, 'intl' | 'isHardwareWallet'>;
 
 export type HasAssetsAfterTransaction = Pick<
   ViewProps,
-  'assetTokens' | 'selectedAssets'
+  'assetTokens' | 'selectedAssets' | 'assetsAmounts'
+>;
+
+export type IsSendingAllFromSelected = Pick<
+  ViewProps,
+  'selectedAssets' | 'assetsAmounts'
 >;

source/renderer/app/i18n/locales/defaultMessages.json

@@ -287,7 +287,7 @@
         }
       },
       {
-        "defaultMessage": "!!!Insufficient funds to support tokens. A minimum of {adaToRemain} ADA must remain in the wallet after this transaction.",
+        "defaultMessage": "!!!Insufficient funds to support tokens. You need at least an additional {adaAmount} ADA in your wallet to process this transaction.",
         "description": "\"Balance after transaction would not leave enough ada in the wallet to support tokens remaining in wallet",
         "end": {
           "column": 3,