fix(receive): address review comments

Author: OriginalEveres

packages/suite/src/storage/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Storage changelog
 
+## 26.8.0
+
+- rename receive `revealedAddresses` to `touchedAddresses`
+- remove `isVerified` flag from receive address entries
+
 ## 26.6.0
 
 - purge desktop trading form draft keys (`trading-buy/*`, `trading-sell/`, `trading-exchange/`) from `formDrafts`

packages/suite/src/storage/migrations/versions/26.8.0.ts

@@ -0,0 +1,35 @@
+import { createMigration } from '@suite/idb-migration-utils';
+
+import { type SuiteDBSchema } from 'src/storage/definitions';
+
+import { updateAll } from '../utils';
+
+type LegacyReceiveInfo = {
+    path: string;
+    address: string;
+};
+
+type LegacyReceiveAccountState = {
+    touchedAddresses?: LegacyReceiveInfo[];
+    revealedAddresses?: (LegacyReceiveInfo & { isVerified?: boolean })[];
+    currentFreshAddress?: LegacyReceiveInfo;
+};
+
+export default createMigration<SuiteDBSchema>('26.8.0', async (_db, tx) => {
+    await updateAll<'receive', LegacyReceiveAccountState>(tx, 'receive', oldReceiveState => {
+        const sourceAddresses =
+            oldReceiveState.touchedAddresses ?? oldReceiveState.revealedAddresses;
+
+        if (!sourceAddresses) {
+            return undefined;
+        }
+
+        return {
+            touchedAddresses: sourceAddresses.map(({ path, address }) => ({
+                path,
+                address,
+            })),
+            currentFreshAddress: oldReceiveState.currentFreshAddress,
+        };
+    });
+});

packages/suite/src/storage/migrations/versions/__tests__/26.8.0.test.ts

@@ -0,0 +1,65 @@
+import '@suite-common/test-utils/src/globalOverrides';
+import { type IDBPDatabase, deleteDB, openDB } from 'idb';
+
+import { type SuiteDBSchema } from 'src/storage/definitions';
+
+import migration from '../26.8.0';
+
+const DB_NAME = 'suite-idb-test-26.8.0';
+const INITIAL_VERSION = 1;
+
+const runMigration = () =>
+    openDB(DB_NAME, INITIAL_VERSION + 1, {
+        upgrade(db: IDBPDatabase<SuiteDBSchema>, _oldVersion, _newVersion, tx) {
+            migration.migrate(db, tx);
+        },
+    });
+
+describe('migration 26.8.0', () => {
+    beforeEach(async () => {
+        await deleteDB(DB_NAME);
+    });
+
+    test('renames receive revealed addresses to touched addresses', async () => {
+        const db = await openDB(DB_NAME, INITIAL_VERSION, {
+            upgrade(db) {
+                db.createObjectStore('receive');
+            },
+        });
+        await db.put(
+            'receive',
+            {
+                revealedAddresses: [
+                    {
+                        path: 'btc-path',
+                        address: 'btc-address',
+                        isVerified: true,
+                    },
+                ],
+                currentFreshAddress: {
+                    path: 'fresh-btc-path',
+                    address: 'fresh-btc-address',
+                },
+            },
+            'btc-account-key',
+        );
+        db.close();
+
+        const migratedDb = await runMigration();
+
+        expect(await migratedDb.get('receive', 'btc-account-key')).toEqual({
+            touchedAddresses: [
+                {
+                    path: 'btc-path',
+                    address: 'btc-address',
+                },
+            ],
+            currentFreshAddress: {
+                path: 'fresh-btc-path',
+                address: 'fresh-btc-address',
+            },
+        });
+
+        migratedDb.close();
+    });
+});

packages/suite/src/storage/migrations/versions/index.ts

@@ -27,3 +27,4 @@ export { default as m26_6_0_2 } from './26.6.0.2';
 export { default as m26_7_0 } from './26.7.0';
 export { default as m26_7_0_1 } from './26.7.0.1';
 export { default as m26_7_0_2 } from './26.7.0.2';
+export { default as m26_8_0 } from './26.8.0';

packages/suite/src/views/wallet/sign-verify/index.tsx

@@ -1,7 +1,7 @@
 import { useEffect, useState } from 'react';
 import { type FieldError } from 'react-hook-form';
 
-import { selectFullSelectedAccount } from '@suite/account';
+import { selectSelectedAccount, selectSelectedAccountKey } from '@suite/account';
 import { useDevice } from '@suite/device';
 import { Translation, type TranslationKey, useTranslation } from '@suite/intl';
 import { type ReceiveRootState, selectTouchedAddresses } from '@suite-common/receive';
@@ -41,9 +41,11 @@ const SignVerify = () => {
     const [page, setPage] = useState<'sign' | 'verify'>('sign');
     const [isCompleted, setIsCompleted] = useState(false);
 
-    const selectedAccount = useSelector(selectFullSelectedAccount);
+    const selectedAccount = useSelector(selectSelectedAccount);
+    const selectedAccountKey = useSelector(selectSelectedAccountKey);
+    const selectedNetwork = useSelector(state => state.wallet.selectedAccount.network);
     const touchedAddresses = useSelector((state: ReceiveRootState) =>
-        selectTouchedAddresses(state, selectedAccount.account?.key),
+        selectTouchedAddresses(state, selectedAccountKey),
     );
     const dispatch = useDispatch();
 
@@ -63,11 +65,11 @@ const SignVerify = () => {
         pathField,
         isElectrumField,
         cardanoPubKeyCoseField,
-    } = useSignVerifyForm(isSignPage, selectedAccount.account!);
+    } = useSignVerifyForm(isSignPage, selectedAccount!);
 
     const { isLocked, device } = useDevice();
     const { translationString } = useTranslation();
-    const { canCopy, copy } = useCopySignedMessage(formValues, selectedAccount.network);
+    const { canCopy, copy } = useCopySignedMessage(formValues, selectedNetwork);
 
     const getErrorMessage = (error?: FieldError) =>
         error ? translationString(error.message as TranslationKey) : undefined;

suite-common/receive/src/__tests__/receiveSlice.test.ts

@@ -17,47 +17,6 @@ const ethereumAccount = mockWalletAccount({ symbol: 'eth' }, networkSpecificDefa
 const receiveReducer = prepareReceiveReducer(extraDependenciesCommonMock);
 
 describe('receiveSlice', () => {
-    it('loads persisted accounts and strips legacy verification flag on @storage/load', () => {
-        const state = receiveReducer(undefined, {
-            type: extraDependenciesCommonMock.actionTypes.storageLoad,
-            payload: {
-                receive: [
-                    {
-                        key: bitcoinAccount.key,
-                        value: {
-                            revealedAddresses: [
-                                {
-                                    path: 'btc-path',
-                                    address: 'btc-address',
-                                    isVerified: true,
-                                },
-                            ],
-                            currentFreshAddress: {
-                                path: 'fresh-btc',
-                                address: 'btc-fresh-address',
-                            },
-                        },
-                    },
-                ],
-            },
-        });
-
-        expect(state.accounts).toEqual({
-            [bitcoinAccount.key]: {
-                touchedAddresses: [
-                    {
-                        path: 'btc-path',
-                        address: 'btc-address',
-                    },
-                ],
-                currentFreshAddress: {
-                    path: 'fresh-btc',
-                    address: 'btc-fresh-address',
-                },
-            },
-        });
-    });
-
     it('loads persisted accounts with touched addresses on @storage/load', () => {
         const state = receiveReducer(undefined, {
             type: extraDependenciesCommonMock.actionTypes.storageLoad,

suite-common/receive/src/receiveSlice.ts

@@ -1,6 +1,6 @@
 import { type PayloadAction } from '@reduxjs/toolkit';
 
-import { type AnyAction, createSliceWithExtraDeps } from '@suite-common/redux-utils';
+import { createSliceWithExtraDeps, createWeakMapSelector } from '@suite-common/redux-utils';
 import { accountsActions } from '@suite-common/wallet-core';
 import { type AccountKey, type ReceiveInfo } from '@suite-common/wallet-types';
 
@@ -33,12 +33,6 @@ type SetCurrentFreshAddressPayload = {
     currentFreshAddress?: CurrentFreshAddress;
 };
 
-type PersistedReceiveAccountState = {
-    touchedAddresses?: ReceiveInfo[];
-    revealedAddresses?: ReceiveInfo[];
-    currentFreshAddress?: CurrentFreshAddress;
-};
-
 export const receiveInitialState: ReceiveState = {
     accounts: {},
 };
@@ -103,44 +97,54 @@ export const receiveSlice = createSliceWithExtraDeps({
                 });
             })
             .addCase(extra.actionTypes.storageLoad, (state, action) => {
-                const actionWithPayload = action as AnyAction;
-
-                state.accounts = (
-                    (actionWithPayload.payload?.receive ?? []) as {
-                        key: string;
-                        value: PersistedReceiveAccountState;
-                    }[]
-                ).reduce<ReceiveState['accounts']>((accounts, { key, value }) => {
-                    const touchedAddresses =
-                        value.touchedAddresses ?? value.revealedAddresses ?? [];
-
-                    accounts[key as AccountKey] = {
-                        touchedAddresses: touchedAddresses.map(({ path, address }) => ({
-                            path,
-                            address,
-                        })),
-                        currentFreshAddress: value.currentFreshAddress,
-                    };
-
-                    return accounts;
-                }, {});
+                const entries = action.payload?.receive as
+                    | {
+                          key: string;
+                          value: ReceiveAccountState;
+                      }[]
+                    | undefined;
+
+                state.accounts =
+                    entries?.reduce<ReceiveState['accounts']>((accounts, { key, value }) => {
+                        accounts[key as AccountKey] = {
+                            touchedAddresses: value.touchedAddresses.map(({ path, address }) => ({
+                                path,
+                                address,
+                            })),
+                            currentFreshAddress: value.currentFreshAddress,
+                        };
+
+                        return accounts;
+                    }, {}) ?? {};
             });
     },
 });
 
-const selectReceiveAccountState = (state: ReceiveRootState, accountKey?: AccountKey) => {
-    if (!accountKey) {
-        return emptyReceiveAccountState;
-    }
+const createMemoizedSelector = createWeakMapSelector.withTypes<ReceiveRootState>();
 
-    return state.receive.accounts[accountKey] ?? emptyReceiveAccountState;
-};
+const selectReceiveAccountState = createMemoizedSelector(
+    [
+        (state: ReceiveRootState) => state.receive.accounts,
+        (_state: ReceiveRootState, accountKey?: AccountKey) => accountKey,
+    ],
+    (accounts, accountKey) => {
+        if (!accountKey) {
+            return emptyReceiveAccountState;
+        }
+
+        return accounts[accountKey] ?? emptyReceiveAccountState;
+    },
+);
 
-export const selectTouchedAddresses = (state: ReceiveRootState, accountKey?: AccountKey) =>
-    selectReceiveAccountState(state, accountKey).touchedAddresses;
+export const selectTouchedAddresses = createMemoizedSelector(
+    [selectReceiveAccountState],
+    accountState => accountState.touchedAddresses,
+);
 
-export const selectCurrentFreshAddress = (state: ReceiveRootState, accountKey?: AccountKey) =>
-    selectReceiveAccountState(state, accountKey).currentFreshAddress;
+export const selectCurrentFreshAddress = createMemoizedSelector(
+    [selectReceiveAccountState],
+    accountState => accountState.currentFreshAddress,
+);
 
 export const receiveActions = receiveSlice.actions;
 export const prepareReceiveReducer = receiveSlice.prepareReducer;