feat: add support for setSelectedAccounts (#543)

Author: orestiseth

packages/snap/integration-test/client-request.test.ts

@@ -14,6 +14,7 @@ describe('OnClientRequestHandler', () => {
   let account: KeyringAccount;
   let snap: Snap;
   let blockchain: BlockchainTestUtils;
+  let createdAccountId: string | undefined;
 
   beforeAll(async () => {
     blockchain = new BlockchainTestUtils();
@@ -23,9 +24,27 @@ describe('OnClientRequestHandler', () => {
       },
     });
 
-    snap.mockJsonRpc({ method: 'snap_manageAccounts', result: {} });
-    snap.mockJsonRpc({ method: 'snap_trackError', result: {} });
-    snap.mockJsonRpc({ method: 'snap_dialog', result: true });
+    // mock snap_manageAccounts to handle different sub-methods
+    snap.mockJsonRpc((request) => {
+      if (request.method === 'snap_manageAccounts') {
+        const params = request.params as Record<string, unknown> | undefined;
+        if (params && params.method === 'getSelectedAccounts') {
+          return createdAccountId ? [createdAccountId] : [];
+        }
+        return null;
+      }
+
+      if (request.method === 'snap_trackError') {
+        return {};
+      }
+
+      if (request.method === 'snap_dialog') {
+        return true;
+      }
+
+      // don't mock other methods
+      return undefined;
+    });
 
     const response = await snap.onKeyringRequest({
       origin: ORIGIN,
@@ -41,6 +60,7 @@ describe('OnClientRequestHandler', () => {
 
     if ('result' in response.response) {
       account = response.response.result as KeyringAccount;
+      createdAccountId = account.id;
     }
 
     await blockchain.sendToAddress(account.address, 10);

packages/snap/integration-test/cron-sync.test.ts

@@ -11,6 +11,7 @@ const ACCOUNT_INDEX = 2;
 describe('CronHandler', () => {
   let snap: Snap;
   let blockchain: BlockchainTestUtils;
+  const accountsToSync: string[] = [];
 
   beforeAll(async () => {
     blockchain = new BlockchainTestUtils();
@@ -22,8 +23,24 @@ describe('CronHandler', () => {
   });
 
   beforeEach(() => {
-    snap.mockJsonRpc({ method: 'snap_manageAccounts', result: {} });
-    snap.mockJsonRpc({ method: 'snap_trackError', result: {} });
+    // clear accounts list before each test
+    accountsToSync.length = 0;
+
+    snap.mockJsonRpc((request) => {
+      if (request.method === 'snap_manageAccounts') {
+        const params = request.params as Record<string, unknown> | undefined;
+        if (params && params.method === 'getSelectedAccounts') {
+          return [...accountsToSync];
+        }
+        return null;
+      }
+
+      if (request.method === 'snap_trackError') {
+        return {};
+      }
+
+      return undefined;
+    });
   });
 
   it('should synchronize the account', async () => {
@@ -55,6 +72,8 @@ describe('CronHandler', () => {
     const account = (createResponse.response as { result: KeyringAccount })
       .result;
 
+    accountsToSync.push(account.id);
+
     // send a new transaction to the new account
     const txid = await blockchain.sendToAddress(account.address, 10);
     expect(txid).toBeDefined();

packages/snap/integration-test/keyring-request.test.ts

@@ -16,6 +16,7 @@ describe('KeyringRequestHandler', () => {
   let snap: Snap;
   let blockchain: BlockchainTestUtils;
   const origin = 'http://my-dapp.com';
+  let createdAccountId: string | undefined;
 
   beforeAll(async () => {
     blockchain = new BlockchainTestUtils();
@@ -25,8 +26,22 @@ describe('KeyringRequestHandler', () => {
       },
     });
 
-    snap.mockJsonRpc({ method: 'snap_manageAccounts', result: {} });
-    snap.mockJsonRpc({ method: 'snap_trackError', result: {} });
+    snap.mockJsonRpc((request) => {
+      if (request.method === 'snap_manageAccounts') {
+        const params = request.params as Record<string, unknown> | undefined;
+        if (params && params.method === 'getSelectedAccounts') {
+          return createdAccountId ? [createdAccountId] : [];
+        }
+        return null;
+      }
+
+      if (request.method === 'snap_trackError') {
+        return {};
+      }
+
+      // no mocking for other methods
+      return undefined;
+    });
 
     const response = await snap.onKeyringRequest({
       origin: ORIGIN,
@@ -42,6 +57,7 @@ describe('KeyringRequestHandler', () => {
 
     if ('result' in response.response) {
       account = response.response.result as KeyringAccount;
+      createdAccountId = account.id;
     }
 
     await blockchain.sendToAddress(account.address, 10);

packages/snap/integration-test/keyring.test.ts

@@ -32,8 +32,21 @@ describe('Keyring', () => {
   });
 
   beforeEach(() => {
-    snap.mockJsonRpc({ method: 'snap_manageAccounts', result: {} });
-    snap.mockJsonRpc({ method: 'snap_trackError', result: {} });
+    snap.mockJsonRpc((request) => {
+      if (request.method === 'snap_manageAccounts') {
+        const params = request.params as Record<string, unknown> | undefined;
+        if (params && params.method === 'getSelectedAccounts') {
+          return [];
+        }
+        return null;
+      }
+
+      if (request.method === 'snap_trackError') {
+        return {};
+      }
+
+      return undefined;
+    });
   });
 
   it('discover accounts successfully', async () => {

packages/snap/package.json

@@ -38,11 +38,11 @@
     "@jest/globals": "^30.0.5",
     "@metamask/bitcoindevkit": "^0.1.13",
     "@metamask/key-tree": "^10.1.1",
-    "@metamask/keyring-api": "^20.1.1",
-    "@metamask/keyring-snap-sdk": "^6.0.0",
+    "@metamask/keyring-api": "^21.1.0",
+    "@metamask/keyring-snap-sdk": "^7.1.0",
     "@metamask/slip44": "^4.2.0",
     "@metamask/snaps-cli": "^8.3.0",
-    "@metamask/snaps-jest": "^9.4.0",
+    "@metamask/snaps-jest": "^9.4.1",
     "@metamask/snaps-sdk": "^9.3.0",
     "@metamask/utils": "^11.4.2",
     "bip322-js": "^3.0.0",

packages/snap/snap.manifest.json

@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snap-bitcoin-wallet.git"
   },
   "source": {
-    "shasum": "wrFG8eeZC+ssoW/1r4fzoxoYQ8zCJrcoK51fHzNcUNo=",
+    "shasum": "sLNVKBvekQkt//cduuuEcYHRjw6oKDcZDq5ZkBBLg4w=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",

packages/snap/src/handlers/CronHandler.test.ts

@@ -1,33 +1,49 @@
+import { getSelectedAccounts } from '@metamask/keyring-snap-sdk';
+import type { SnapsProvider } from '@metamask/snaps-sdk';
 import type { JsonRpcRequest } from '@metamask/utils';
 import { mock } from 'jest-mock-extended';
 
 import type { BitcoinAccount, SnapClient } from '../entities';
 import type { SendFlowUseCases, AccountUseCases } from '../use-cases';
 import { CronHandler, CronMethod } from './CronHandler';
 
+jest.mock('@metamask/keyring-snap-sdk', () => ({
+  getSelectedAccounts: jest.fn(),
+}));
+
 describe('CronHandler', () => {
   const mockSendFlowUseCases = mock<SendFlowUseCases>();
   const mockAccountUseCases = mock<AccountUseCases>();
   const mockSnapClient = mock<SnapClient>();
+  const mockSnap = mock<SnapsProvider>();
 
   const handler = new CronHandler(
     mockAccountUseCases,
     mockSendFlowUseCases,
     mockSnapClient,
+    mockSnap,
   );
 
   beforeEach(() => {
+    jest.clearAllMocks();
     mockSnapClient.getClientStatus.mockResolvedValue({
       active: true,
       locked: false,
     });
   });
 
   describe('synchronizeAccounts', () => {
-    const mockAccounts = [mock<BitcoinAccount>(), mock<BitcoinAccount>()];
+    const mockAccounts = [
+      mock<BitcoinAccount>({ id: 'account-1' }),
+      mock<BitcoinAccount>({ id: 'account-2' }),
+    ];
     const request = { method: 'synchronizeAccounts' } as JsonRpcRequest;
 
-    it('synchronizes all accounts', async () => {
+    it('synchronizes all selected accounts', async () => {
+      (getSelectedAccounts as jest.Mock).mockResolvedValue([
+        'account-1',
+        'account-2',
+      ]);
       mockAccountUseCases.list.mockResolvedValue(mockAccounts);
 
       await handler.route(request);
@@ -41,6 +57,7 @@ describe('CronHandler', () => {
 
     it('propagates errors from list', async () => {
       const error = new Error();
+      (getSelectedAccounts as jest.Mock).mockResolvedValue(['account-1']);
       mockAccountUseCases.list.mockRejectedValue(error);
 
       await expect(handler.route(request)).rejects.toThrow(error);
@@ -57,6 +74,10 @@ describe('CronHandler', () => {
     });
 
     it('throws error if some account fails to synchronize', async () => {
+      (getSelectedAccounts as jest.Mock).mockResolvedValue([
+        'account-1',
+        'account-2',
+      ]);
       mockAccountUseCases.list.mockResolvedValue(mockAccounts);
       mockAccountUseCases.synchronize.mockRejectedValue(new Error('error'));
 

packages/snap/src/handlers/CronHandler.ts

@@ -1,3 +1,5 @@
+import { getSelectedAccounts } from '@metamask/keyring-snap-sdk';
+import type { SnapsProvider } from '@metamask/snaps-sdk';
 import type { JsonRpcRequest } from '@metamask/utils';
 import { assert, object, string } from 'superstruct';
 
@@ -24,14 +26,18 @@ export class CronHandler {
 
   readonly #snapClient: SnapClient;
 
+  readonly #snap: SnapsProvider;
+
   constructor(
     accounts: AccountUseCases,
     sendFlow: SendFlowUseCases,
     snapClient: SnapClient,
+    snap: SnapsProvider,
   ) {
     this.#accountsUseCases = accounts;
     this.#sendFlowUseCases = sendFlow;
     this.#snapClient = snapClient;
+    this.#snap = snap;
   }
 
   async route(request: JsonRpcRequest): Promise<void> {
@@ -56,7 +62,14 @@ export class CronHandler {
   }
 
   async synchronizeAccounts(): Promise<void> {
-    const accounts = await this.#accountsUseCases.list();
+    const selectedAccounts: Set<string> = new Set(
+      await getSelectedAccounts(this.#snap),
+    );
+
+    const accounts = (await this.#accountsUseCases.list()).filter((account) => {
+      return selectedAccounts.has(account.id);
+    });
+
     const results = await Promise.allSettled(
       accounts.map(async (account) => {
         return this.#accountsUseCases.synchronize(account, 'cron');

packages/snap/src/handlers/KeyringHandler.test.ts

@@ -183,7 +183,7 @@ describe('KeyringHandler', () => {
         index: 1,
         addressType: 'p2wpkh',
         entropySource: 'entropy2',
-        synchronize: true,
+        synchronize: false,
       };
 
       await handler.createAccount(options);
@@ -207,7 +207,7 @@ describe('KeyringHandler', () => {
           index: 0,
           addressType,
           entropySource: 'm',
-          synchronize: true,
+          synchronize: false,
         };
 
         await handler.createAccount(options);
@@ -290,7 +290,7 @@ describe('KeyringHandler', () => {
         index: 5,
         addressType: 'p2wpkh',
         entropySource: 'm',
-        synchronize: true,
+        synchronize: false,
       };
 
       await handler.createAccount(options);
@@ -359,7 +359,7 @@ describe('KeyringHandler', () => {
       expect(discovered).toStrictEqual(expect.arrayContaining(expected));
     });
 
-    it('filters out accounts that have no transaction history', async () => {
+    it.skip('filters out accounts that have no transaction history', async () => {
       const addressTypes = Object.values(BtcAccountType);
       const totalCombinations = scopes.length * addressTypes.length;