Only subscribe to selected accounts (#543)

Here are some demos
- https://www.loom.com/share/334a4f109b44498894be89f86afe5a5a
-
https://www.loom.com/share/bbafb65d3d624adea0bdf13269d25818?sid=ebf0d5c5-290a-480c-a919-7ecf8b00a0c0

Includes:
- Only subscribe to selected accounts
- Turn off account full sync on account creation







<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> Monitors WebSocket subscriptions only for user-selected accounts, adds
a SetSelectedAccounts API and test-dapp UI, removes background sync on
account creation, and refactors subscription/state handling with
dependency updates.
> 
> - **Snap core**:
> - **Account monitoring**: Replace per-account monitor with
`setMonitoredAccounts` to start/stop subscriptions based on selection;
sync only monitored accounts on connection recovery.
> - **Selection API**: Add `keyring.setSelectedAccounts` (validates
UUIDs) and expose test-dapp RPC `setAccountSelected`; permit via
`permissions`.
> - **Background events**: Remove `OnSyncAccount` handler and stop
scheduling sync on account creation.
> - **Keyring**: Stop auto-monitoring on create/delete and remove sync
scheduling; emit events unchanged.
> - **Accounts service**: Add `getAllSelected` using
`getSelectedAccounts` from `@metamask/keyring-snap-sdk`.
>   - **Subscriptions**: 
> - Add unsubscription confirmation handling; delete repo entry
immediately on unsubscribe.
> - Tighten confirmation parsing; maintain re-subscribe and expiry
flows.
> - **Initialization**:
> - Add `MonitoredAccountsInitializer` to monitor selected accounts on
`onActive`.
> - **State**:
> - Change `deleteKey` to use `snap_setState` with `undefined` sentinel;
update tests.
> - **Test dapp (site)**:
> - Add UI to list/select accounts and inform snap via
`setAccountSelected`; keep manual sync action.
> - **Configs/manifest**:
>   - Update `snap.manifest.json` shasum.
>   - Permissions updated for new methods.
> - **Dependencies**:
> - Bump `@metamask/keyring-api` to `^21.1.0` and
`@metamask/keyring-snap-sdk` to `^7.1.0` (root, snap, site).
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
e37a143. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

Author: xavier-brochard

package.json

@@ -35,9 +35,6 @@
       "yarn lint:fix"
     ]
   },
-  "resolutions": {
-    "@metamask/snaps-sdk": "9.3.0"
-  },
   "devDependencies": {
     "@commitlint/cli": "^17.7.1",
     "@commitlint/config-conventional": "^17.7.0",
@@ -47,6 +44,7 @@
     "@metamask/eslint-config-jest": "^12.1.0",
     "@metamask/eslint-config-nodejs": "^12.1.0",
     "@metamask/eslint-config-typescript": "^12.1.0",
+    "@metamask/keyring-snap-sdk": "^7.1.0",
     "@metamask/utils": "^10.0.0",
     "@types/jest": "^27.5.2",
     "@types/react": "^18.0.15",

packages/site/package.json

@@ -31,7 +31,7 @@
   "dependencies": {
     "@chakra-ui/react": "^3.0.2",
     "@emotion/react": "^11.13.3",
-    "@metamask/keyring-api": "^18.0.0",
+    "@metamask/keyring-api": "^21.1.0",
     "@metamask/providers": "^18.1.0",
     "@solana-program/compute-budget": "^0.7.0",
     "@solana-program/system": "^0.7.0",

packages/site/src/components/Handlers/Accounts.tsx

@@ -1,12 +1,36 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
-import { Button, Card, Flex } from '@chakra-ui/react';
+import { Button, Card, Flex, Heading } from '@chakra-ui/react';
+import { KeyringRpcMethod, type KeyringAccount } from '@metamask/keyring-api';
+import { useEffect, useState } from 'react';
 
 import { TestDappRpcRequestMethod } from '../../../../snap/src/core/handlers/onRpcRequest/types';
-import { useInvokeSnap } from '../../hooks';
+import { useInvokeKeyring, useInvokeSnap } from '../../hooks';
 import { toaster } from '../Toaster/Toaster';
 
 export const Accounts = () => {
   const invokeSnap = useInvokeSnap();
+  const invokeKeyring = useInvokeKeyring();
+  const [accounts, setAccounts] = useState<KeyringAccount[]>([]);
+  const [selectedAccounts, setSelectedAccounts] = useState<KeyringAccount[]>(
+    [],
+  );
+
+  useEffect(() => {
+    const fetchAndSetAccounts = async () => {
+      const accountsToSet = (await invokeKeyring({
+        method: KeyringRpcMethod.ListAccounts,
+      })
+        .then((accountsResponse) => {
+          return accountsResponse ?? [];
+        })
+        .catch((error) => {
+          console.error('Error fetching accounts', error);
+          return [];
+        })) as KeyringAccount[];
+      setAccounts(accountsToSet);
+    };
+    fetchAndSetAccounts();
+  }, []);
 
   const synchronize = async () => {
     const promise = invokeSnap({
@@ -26,17 +50,58 @@ export const Accounts = () => {
     });
   };
 
+  const informSnapAboutSelectedAccounts = async (
+    selectedAccountsToInform: KeyringAccount[],
+  ) => {
+    await invokeSnap({
+      method: TestDappRpcRequestMethod.SetAccountSelected,
+      params: {
+        accountIds: selectedAccountsToInform.map((account) => account.id),
+      },
+    });
+  };
+
   return (
     <Card.Root>
       <Card.Header>
         <Card.Title>Accounts</Card.Title>
       </Card.Header>
       <Card.Body gap="2">
         <Flex direction="column" gap="4">
-          <Flex direction="column" gap="1">
-            <Button variant="outline" onClick={synchronize}>
-              Synchronize
-            </Button>
+          <Button variant="outline" onClick={synchronize}>
+            Synchronize
+          </Button>
+          <Flex direction="column" gap="2">
+            <Heading as="h2" size="md">
+              Selected accounts
+            </Heading>
+            {accounts.map((account) => (
+              <Flex align="center" gap="2" key={account.id}>
+                <input
+                  type="checkbox"
+                  checked={selectedAccounts.includes(account)}
+                  onChange={(evnt) => {
+                    const isChecked = evnt.target.checked;
+                    let newSelectedAccounts = selectedAccounts;
+                    if (isChecked) {
+                      newSelectedAccounts = [...selectedAccounts, account];
+                    } else {
+                      newSelectedAccounts = selectedAccounts.filter(
+                        (selectedAccount) => selectedAccount !== account,
+                      );
+                    }
+                    setSelectedAccounts(
+                      Array.from(new Set(newSelectedAccounts)),
+                    );
+                    informSnapAboutSelectedAccounts(newSelectedAccounts);
+                  }}
+                  id={`account-checkbox-${account.id}`}
+                />
+                <label htmlFor={`account-checkbox-${account.id}`}>
+                  {account.id}
+                </label>
+              </Flex>
+            ))}
           </Flex>
         </Flex>
       </Card.Body>

packages/snap/package.json

@@ -41,8 +41,8 @@
     "@jest/globals": "^29.5.0",
     "@metamask/auto-changelog": "4.0.0",
     "@metamask/key-tree": "9.1.2",
-    "@metamask/keyring-api": "^18.0.0",
-    "@metamask/keyring-snap-sdk": "^4.0.0",
+    "@metamask/keyring-api": "^21.1.0",
+    "@metamask/keyring-snap-sdk": "^7.1.0",
     "@metamask/snaps-cli": "^8.1.1",
     "@metamask/snaps-jest": "9.3.0",
     "@metamask/snaps-sdk": "^9.3.0",

packages/snap/snap.manifest.json

@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snap-solana-wallet.git"
   },
   "source": {
-    "shasum": "/34yob4VJK1Jr7PMxj4Txlrmv3y2oSJmtx70glfAQ1w=",
+    "shasum": "Z3x68DtN7fwk0qJJAOHmq2AKuNOgm+IdmFUkF1h0juM=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",

packages/snap/src/core/handlers/onCronjob/backgroundEvents/ScheduleBackgroundEventMethod.ts

@@ -5,8 +5,6 @@ export enum ScheduleBackgroundEventMethod {
   OnTransactionApproved = 'onTransactionApproved',
   /** Triggered when a transaction is rejected */
   OnTransactionRejected = 'onTransactionRejected',
-  /** Use it to schedule a background event to asynchronously fetch the assets and transactions of an account */
-  OnSyncAccount = 'onSyncAccount',
   /** Use it to schedule a background event to refresh the send form */
   RefreshSend = 'refreshSend',
   /** Use it to schedule a background event to refresh the confirmation estimation */

packages/snap/src/core/handlers/onCronjob/backgroundEvents/index.ts

@@ -1,7 +1,6 @@
 import type { OnCronjobHandler } from '@metamask/snaps-sdk';
 
 import { closeWebSocketConnections } from './closeWebSocketConnections';
-import { onSyncAccount } from './onSyncAccount';
 import { onTransactionAdded } from './onTransactionAdded';
 import { onTransactionApproved } from './onTransactionApproved';
 import { onTransactionRejected } from './onTransactionRejected';
@@ -16,7 +15,6 @@ export const handlers: Record<ScheduleBackgroundEventMethod, OnCronjobHandler> =
       onTransactionApproved,
     [ScheduleBackgroundEventMethod.OnTransactionRejected]:
       onTransactionRejected,
-    [ScheduleBackgroundEventMethod.OnSyncAccount]: onSyncAccount,
     [ScheduleBackgroundEventMethod.RefreshSend]: refreshSend,
     [ScheduleBackgroundEventMethod.RefreshConfirmationEstimation]:
       refreshConfirmationEstimation,

packages/snap/src/core/handlers/onCronjob/backgroundEvents/onSyncAccount.ts

@@ -2,7 +2,11 @@
 /* eslint-disable jest/prefer-strict-equal */
 import type { KeyringRequest } from '@metamask/keyring-api';
 import { SolMethod } from '@metamask/keyring-api';
-import type { CaipAssetType, JsonRpcRequest } from '@metamask/snaps-sdk';
+import {
+  InvalidParamsError,
+  type CaipAssetType,
+  type JsonRpcRequest,
+} from '@metamask/snaps-sdk';
 import { signature } from '@solana/kit';
 
 import type { AssetEntity } from '../../../entities';
@@ -44,7 +48,6 @@ import {
 import { getBip32EntropyMock } from '../../test/mocks/utils/getBip32Entropy';
 import { getBip32Entropy } from '../../utils/getBip32Entropy';
 import logger from '../../utils/logger';
-import { ScheduleBackgroundEventMethod } from '../onCronjob/backgroundEvents/ScheduleBackgroundEventMethod';
 import { SolanaKeyring } from './Keyring';
 
 jest.mock('@metamask/keyring-snap-sdk', () => ({
@@ -121,8 +124,7 @@ describe('SolanaKeyring', () => {
     } as unknown as jest.Mocked<TransactionsService>;
 
     mockKeyringAccountMonitor = {
-      monitorKeyringAccount: jest.fn(),
-      stopMonitorKeyringAccount: jest.fn(),
+      setMonitoredAccounts: jest.fn(),
     } as unknown as KeyringAccountMonitor;
 
     keyring = new SolanaKeyring({
@@ -531,21 +533,6 @@ describe('SolanaKeyring', () => {
         expect(account).toEqual(asStrictKeyringAccount(existingAccount));
         expect(stateUpdateSpy).not.toHaveBeenCalled();
       });
-
-      it('schedules a background event to sync the account', async () => {
-        await keyring.createAccount();
-
-        expect(snap.request).toHaveBeenCalledWith(
-          expect.objectContaining({
-            method: 'snap_scheduleBackgroundEvent',
-            params: expect.objectContaining({
-              request: expect.objectContaining({
-                method: ScheduleBackgroundEventMethod.OnSyncAccount,
-              }),
-            }),
-          }),
-        );
-      });
     });
 
     describe('when an account name suggestion is provided', () => {
@@ -563,18 +550,6 @@ describe('SolanaKeyring', () => {
       });
     });
 
-    it('monitors the account assets', async () => {
-      await keyring.createAccount();
-
-      expect(
-        mockKeyringAccountMonitor.monitorKeyringAccount,
-      ).toHaveBeenCalledWith(
-        expect.objectContaining({
-          id: expect.any(String),
-        }),
-      );
-    });
-
     it('throws when deriving address fails', async () => {
       jest.mocked(getBip32Entropy).mockImplementationOnce(async () => {
         return Promise.reject(new Error('Error deriving address'));
@@ -611,14 +586,6 @@ describe('SolanaKeyring', () => {
       expect(accountAfterDeletion).toBeUndefined();
     });
 
-    it('stops monitoring the account assets', async () => {
-      await keyring.deleteAccount(MOCK_SOLANA_KEYRING_ACCOUNT_1.id);
-
-      expect(
-        mockKeyringAccountMonitor.stopMonitorKeyringAccount,
-      ).toHaveBeenCalledWith(MOCK_SOLANA_KEYRING_ACCOUNT_1);
-    });
-
     it('throws an error if account provided is not a uuid', async () => {
       await expect(keyring.deleteAccount('non-existent-id')).rejects.toThrow(
         /Expected a string matching/u,
@@ -993,4 +960,26 @@ describe('SolanaKeyring', () => {
       ).not.toHaveBeenCalled();
     });
   });
+
+  describe('setSelectedAccounts', () => {
+    it('sets the monitored accounts', async () => {
+      const accountIds = MOCK_SOLANA_KEYRING_ACCOUNTS.map(
+        (account) => account.id,
+      );
+      await keyring.setSelectedAccounts(accountIds);
+
+      expect(
+        mockKeyringAccountMonitor.setMonitoredAccounts,
+      ).toHaveBeenCalledWith(accountIds);
+    });
+
+    it('rejects if an account id is not valid', async () => {
+      await expect(
+        keyring.setSelectedAccounts([
+          MOCK_SOLANA_KEYRING_ACCOUNT_0.id,
+          'not-a-uuid',
+        ]),
+      ).rejects.toThrow(InvalidParamsError);
+    });
+  });
 });