Merge pull request #3007 from input-output-hk/fix/ddw-1111-non-recommended-decimal-settings-warning-not-shown

[DDW-1111] Non-recommended decimal place setting alert is not displayed before 1st change of settings

Author: danielmain

CHANGELOG.md

@@ -6,6 +6,7 @@
 
 - Fixed downloaded installer being left in Downloads after latest update installs ([PR 2941](https://github.com/input-output-hk/daedalus/pull/2941))
 - Fixed incorrect amount of token sent ([PR 2962](https://github.com/input-output-hk/daedalus/pull/2962))
+- Ensured non-recommended decimal place setting alert is correctly shown ([PR 3007](https://github.com/input-output-hk/daedalus/pull/3007))
 
 ### Chores
 

source/common/types/logging.types.ts

@@ -14,8 +14,8 @@ import type {
 } from '../../renderer/app/api/wallets/types';
 import type { Address } from '../../renderer/app/api/addresses/types';
 import type { GetTransactionsRequest } from '../../renderer/app/api/transactions/types';
-import type { HardwareWalletLocalData } from '../../renderer/app/api/utils/localStorage';
 import type { AdaApiStakePool } from '../../renderer/app/api/staking/types';
+import { HardwareWalletLocalData } from '../../renderer/app/types/localDataTypes';
 
 export type LoggingLevel = 'debug' | 'info' | 'error' | 'warn';
 export type Logger = {

source/renderer/app/api/api.ts

@@ -223,11 +223,11 @@ import type {
   ApiAsset,
   StoredAssetMetadata,
 } from './assets/types';
-import type { AssetLocalData } from './utils/localStorage';
 import Asset from '../domains/Asset';
 import { getAssets } from './assets/requests/getAssets';
 import { getAccountPublicKey } from './wallets/requests/getAccountPublicKey';
 import { doesWalletRequireAdaToRemainToSupportTokens } from './utils/apiHelpers';
+import { AssetLocalData } from '../types/localDataTypes';
 
 export default class AdaApi {
   config: RequestConfig;
@@ -663,14 +663,14 @@ export default class AdaApi {
       logger.debug('AdaApi::getAssets success', {
         assets: response,
       });
-      const assetsLocaldata = await global.daedalus.api.localStorage.getAssetsLocalData();
+      const assetsLocalData = await global.daedalus.api.localStorage.getAssetsLocalData();
       logger.debug('AdaApi::getAssetsLocalData success', {
-        assetsLocaldata,
+        assetsLocalData,
       });
       const assets = response.map((asset) =>
         _createAssetFromServerData(
           asset,
-          assetsLocaldata[asset.policy_id + asset.asset_name] || {},
+          assetsLocalData[asset.policy_id + asset.asset_name] || {},
           this.storedAssetMetadata
         )
       );

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

@@ -2,32 +2,32 @@
 import { includes, without, get } from 'lodash';
 import { toJS } from '../../../../common/utils/helper';
 import { electronStoreConversation } from '../../ipc/electronStoreConversation';
+import type { WalletMigrationStatus } from '../../stores/WalletMigrationStore';
 import { WalletMigrationStatuses } from '../../stores/WalletMigrationStore';
 import {
   STORAGE_TYPES as types,
   STORAGE_KEYS as keys,
 } from '../../../../common/config/electron-store.config';
 import type { NewsTimestamp } from '../news/types';
-import type { WalletMigrationStatus } from '../../stores/WalletMigrationStore';
 import type {
   TransportDevice,
   HardwareWalletExtendedPublicKeyResponse,
-  DeviceType,
 } from '../../../../common/types/hardware-wallets.types';
 import type { StorageKey } from '../../../../common/types/electron-store.types';
 import type { Currency, DeprecatedCurrency } from '../../types/currencyTypes';
 import {
   CURRENCY_IS_ACTIVE_BY_DEFAULT,
   CURRENCY_DEFAULT_SELECTED,
 } from '../../config/currencyConfig';
+import {
+  AssetLocalData,
+  HardwareWalletDevicesType,
+  HardwareWalletLocalData,
+  HardwareWalletsLocalData,
+  UnpairedHardwareWalletData,
+  WalletLocalData,
+} from '../../types/localDataTypes';
 
-export type WalletLocalData = {
-  id: string;
-  recoveryPhraseVerificationDate?: Date | null | undefined;
-  creationDate: Date;
-  showUsedAddresses: boolean;
-};
-export type WalletsLocalData = Record<StorageKey, WalletLocalData>;
 export type SetHardwareWalletLocalDataRequestType = {
   walletId: string;
   data: {
@@ -42,27 +42,6 @@ export type SetHardwareWalletDeviceRequestType = {
   data: UnpairedHardwareWalletData;
 };
 
-export type UnpairedHardwareWalletData = {
-  deviceType?: DeviceType;
-  deviceModel?: string;
-  deviceName?: string;
-  path?: string | null | undefined;
-  paired?: string | null | undefined;
-  disconnected?: boolean;
-};
-
-export type HardwareWalletLocalData = {
-  id: string;
-  deviceType: DeviceType;
-  device: TransportDevice;
-  extendedPublicKey: HardwareWalletExtendedPublicKeyResponse;
-  disconnected: boolean;
-};
-export type HardwareWalletsLocalData = Record<string, HardwareWalletLocalData>;
-export type HardwareWalletDevicesType = Record<string, TransportDevice>;
-export type AssetLocalData = {
-  decimals: number;
-};
 /**
  * This api layer provides access to the electron local storage
  * for user settings that are not synced with any coin backend.

source/renderer/app/components/assets/AssetSettingsDialog.tsx

@@ -17,7 +17,7 @@ import {
   MAX_DECIMAL_PRECISION,
 } from '../../config/assetsConfig';
 import { DiscreetTokenWalletAmount } from '../../features/discreet-mode';
-import { isRecommendedDecimal } from '../wallet/tokens/wallet-token/helpers';
+import { isNonRecommendedDecimalSettingUsed } from '../wallet/tokens/wallet-token/helpers';
 
 const messages = defineMessages({
   title: {
@@ -154,7 +154,7 @@ class AssetSettingsDialog extends Component<Props, State> {
       },
     ];
 
-    const hasWarning = isRecommendedDecimal({
+    const hasWarning = isNonRecommendedDecimalSettingUsed({
       recommendedDecimals,
       decimals: savedDecimals,
     });

source/renderer/app/components/wallet/tokens/wallet-token/WalletToken.tsx

@@ -6,7 +6,7 @@ import AssetContent from '../../../assets/AssetContent';
 import type { AssetToken } from '../../../../api/assets/types';
 import WalletTokenFooter from './WalletTokenFooter';
 import WalletTokenHeader from './WalletTokenHeader';
-import { isRecommendedDecimal } from './helpers';
+import { isNonRecommendedDecimalSettingUsed } from './helpers';
 
 type Props = {
   anyAssetWasHovered: boolean;
@@ -49,7 +49,7 @@ const WalletToken = observer((props: Props) => {
     setIsExpanded(!isExpanded);
   }, [setIsExpanded, isExpanded]);
 
-  const hasWarning = isRecommendedDecimal({
+  const hasWarning = isNonRecommendedDecimalSettingUsed({
     decimals: asset.decimals,
     recommendedDecimals: asset.recommendedDecimals,
   });

source/renderer/app/components/wallet/tokens/wallet-token/helpers.spec.ts

@@ -0,0 +1,69 @@
+import { isNonRecommendedDecimalSettingUsed } from './helpers';
+
+describe('isNonRecommendedDecimalSettingUsed', () => {
+  it('returns false if asset does not have recommended decimals', async () => {
+    expect(
+      isNonRecommendedDecimalSettingUsed({
+        decimals: 0,
+        recommendedDecimals: undefined,
+      })
+    ).toEqual(false);
+
+    expect(
+      isNonRecommendedDecimalSettingUsed({
+        decimals: 5,
+        recommendedDecimals: undefined,
+      })
+    ).toEqual(false);
+  });
+
+  it('returns false if recommended decimal settings are applied by user', async () => {
+    expect(
+      isNonRecommendedDecimalSettingUsed({
+        decimals: 0,
+        recommendedDecimals: 0,
+      })
+    ).toEqual(false);
+
+    expect(
+      isNonRecommendedDecimalSettingUsed({
+        decimals: 5,
+        recommendedDecimals: 5,
+      })
+    ).toEqual(false);
+  });
+
+  it('returns false if 0 (default value) is recommended and user never changed settings', async () => {
+    expect(
+      isNonRecommendedDecimalSettingUsed({
+        decimals: undefined,
+        recommendedDecimals: 0,
+      })
+    ).toEqual(false);
+  });
+
+  it('returns true if non-zero decimals are recommended but user never changed settings', async () => {
+    expect(
+      isNonRecommendedDecimalSettingUsed({
+        decimals: undefined,
+        recommendedDecimals: 3,
+      })
+    ).toEqual(true);
+  });
+
+  it('returns true if user applied non-recommended decimal settings', async () => {
+    expect(
+      isNonRecommendedDecimalSettingUsed({
+        decimals: 3,
+        recommendedDecimals: 0,
+      })
+    ).toEqual(true);
+
+    expect(
+      isNonRecommendedDecimalSettingUsed({
+        decimals: 0,
+        recommendedDecimals: 3,
+      })
+    ).toEqual(true);
+  });
+});

source/renderer/app/components/wallet/tokens/wallet-token/helpers.ts

@@ -1,15 +1,24 @@
-type IsRecommendedDecimal = {
+type IsNonRecommendedDecimalSettingUsedArgs = {
   decimals: number | null | undefined;
   recommendedDecimals: number | null | undefined;
 };
 
-export const isRecommendedDecimal = ({
+export const isNonRecommendedDecimalSettingUsed = ({
   recommendedDecimals,
   decimals,
-}: IsRecommendedDecimal) => {
-  return (
-    typeof recommendedDecimals === 'number' &&
-    typeof decimals === 'number' &&
-    decimals !== recommendedDecimals
-  );
+}: IsNonRecommendedDecimalSettingUsedArgs) => {
+  const hasRecommendedDecimals = typeof recommendedDecimals === 'number';
+  const hasConfiguredDecimals = typeof decimals === 'number';
+
+  if (!hasRecommendedDecimals) {
+    return false;
+  }
+  if (hasConfiguredDecimals) {
+    return decimals !== recommendedDecimals;
+  }
+  if (!hasConfiguredDecimals && recommendedDecimals === 0) {
+    return false;
+  }
+
+  return true;
 };

source/renderer/app/containers/wallet/WalletReceivePage.tsx

@@ -12,7 +12,7 @@ import WalletAddress from '../../domains/WalletAddress';
 import { generateFileNameWithTimestamp } from '../../../../common/utils/files';
 import { ellipsis } from '../../utils/strings';
 import { generateSupportRequestLink } from '../../../../common/utils/reporting';
-import type { WalletLocalData } from '../../api/utils/localStorage';
+import { WalletLocalData } from '../../types/localDataTypes';
 
 const messages = defineMessages({
   address: {

source/renderer/app/stores/HardwareWalletsStore.ts

@@ -84,12 +84,8 @@ import type {
   VotingDataType,
 } from '../api/transactions/types';
 import type {
-  HardwareWalletLocalData,
-  HardwareWalletsLocalData,
-  HardwareWalletDevicesType,
   SetHardwareWalletLocalDataRequestType,
   SetHardwareWalletDeviceRequestType,
-  UnpairedHardwareWalletData,
 } from '../api/utils/localStorage';
 import type {
   TransportDevice,
@@ -101,6 +97,12 @@ import type {
   TrezorWitness,
 } from '../../../common/types/hardware-wallets.types';
 import { logger } from '../utils/logging';
+import {
+  HardwareWalletDevicesType,
+  HardwareWalletLocalData,
+  HardwareWalletsLocalData,
+  UnpairedHardwareWalletData,
+} from '../types/localDataTypes';
 
 export type TxSignRequestTypes = {
   coinSelection: CoinSelectionsResponse;