feat: add support for setSelectedAccounts

packages/snap/package.json

@@ -38,8 +38,8 @@
     "@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",

packages/snap/snap.manifest.json

@@ -1,13 +1,13 @@
 {
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "Manage Bitcoin using MetaMask",
   "proposedName": "Bitcoin",
   "repository": {
     "type": "git",
     "url": "https://github.com/MetaMask/snap-bitcoin-wallet.git"
   },
   "source": {
-    "shasum": "6Tzrjzyccj6Ane17A/FBIUEVNaB6pgoUEWRTQUbpB4o=",
+    "shasum": "hEGVUC7N1d/6dL1ejo2APeWUY70YKz7OEN7721KEmVU=",
     "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 () => {
+      (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;
 

packages/snap/src/handlers/KeyringHandler.ts

@@ -13,6 +13,7 @@ import {
   ListAccountsRequestStruct,
   ListAccountTransactionsRequestStruct,
   MetaMaskOptionsStruct,
+  SetSelectedAccountsRequestStruct,
   SubmitRequestRequestStruct,
 } from '@metamask/keyring-api';
 import type {
@@ -60,6 +61,7 @@ import {
   mapToKeyringAccount,
   mapToTransaction,
 } from './mappings';
+import { validateSelectedAccounts } from './validation';
 import type { AccountUseCases } from '../use-cases/AccountUseCases';
 
 export const CreateAccountRequest = object({
@@ -143,6 +145,11 @@ export class KeyringHandler implements Keyring {
         assert(request, SubmitRequestRequestStruct);
         return this.submitRequest(request.params);
       }
+      case `${KeyringRpcMethod.SetSelectedAccounts}`: {
+        assert(request, SetSelectedAccountsRequestStruct);
+        await this.setSelectedAccounts(request.params.accounts);
+        return null;
+      }
 
       default: {
         throw new InexistentMethodError('Keyring method not supported', {
@@ -174,7 +181,7 @@ export class KeyringHandler implements Keyring {
       index,
       derivationPath,
       addressType,
-      synchronize = true,
+      synchronize = false,
       accountNameSuggestion,
     } = options;
 
@@ -257,10 +264,7 @@ export class KeyringHandler implements Keyring {
       ),
     );
 
-    // Return only accounts with history.
-    return accounts
-      .filter((account) => account.listTransactions().length > 0)
-      .map(mapToDiscoveredAccount);
+    return accounts.map(mapToDiscoveredAccount);
   }
 
   async getAccountBalances(
@@ -330,6 +334,26 @@ export class KeyringHandler implements Keyring {
     return this.#keyringRequest.route(request);
   }
 
+  async setSelectedAccounts(accounts: string[]): Promise<void> {
+    const accountIdSet = new Set(accounts);
+    const allAccounts = await this.#accountsUseCases.list();
+
+    validateSelectedAccounts(
+      accountIdSet,
+      allAccounts.map((acc) => acc.id),
+    );
+
+    const selectedAccounts = allAccounts.filter((account) =>
+      accountIdSet.has(account.id),
+    );
+
+    const scanPromises = selectedAccounts.map(async (account) => {
+      await this.#accountsUseCases.fullScan(account);
+    });
+
+    await Promise.all(scanPromises);
+  }
+
   #extractAddressType(path: string): AddressType {
     const segments = path.split('/');
     if (segments.length < 4) {

packages/snap/src/handlers/validation.ts

@@ -14,6 +14,7 @@ import {
 } from 'superstruct';
 
 import type { BitcoinAccount, CodifiedError, Logger } from '../entities';
+import { ValidationError } from '../entities';
 
 export enum RpcMethod {
   StartSendTransactionFlow = 'startSendTransactionFlow',
@@ -149,3 +150,25 @@ export function validateAccountBalance(
 
   return NO_ERRORS_RESPONSE;
 }
+
+/**
+ * Validates that all account IDs are part of the existing accounts.
+ *
+ * @param accountIds - Set of account IDs to validate
+ * @param existingAccountIds - Array of existing account IDs
+ * @throws {ValidationError} If any account ID is not part of existing accounts
+ */
+export function validateSelectedAccounts(
+  accountIds: Set<string>,
+  existingAccountIds: string[],
+): void {
+  const isSubset = (first: Set<string>, second: Set<string>): boolean => {
+    return Array.from(first).every((element) => second.has(element));
+  };
+
+  if (!isSubset(accountIds, new Set(existingAccountIds))) {
+    throw new ValidationError(
+      'Account IDs were not part of existing accounts.',
+    );
+  }
+}

packages/snap/src/index.ts

@@ -89,6 +89,7 @@ const cronHandler = new CronHandler(
   accountsUseCases,
   sendFlowUseCases,
   snapClient,
+  snap,
 );
 const rpcHandler = new RpcHandler(sendFlowUseCases, accountsUseCases, logger);
 const userInputHandler = new UserInputHandler(

packages/snap/src/use-cases/AccountUseCases.test.ts

@@ -326,7 +326,6 @@ describe('AccountUseCases', () => {
           discoverParams.network,
           tAddressType,
         );
-        expect(mockChain.fullScan).toHaveBeenCalledWith(mockAccount);
       },
     );
 
@@ -359,7 +358,6 @@ describe('AccountUseCases', () => {
           tNetwork,
           discoverParams.addressType,
         );
-        expect(mockChain.fullScan).toHaveBeenCalledWith(mockAccount);
       },
     );
 
@@ -393,17 +391,6 @@ describe('AccountUseCases', () => {
       expect(mockRepository.getByDerivationPath).toHaveBeenCalled();
       expect(mockRepository.create).toHaveBeenCalled();
     });
-
-    it('propagates an error if fullScan throws', async () => {
-      const error = new Error('fullScan failed');
-      mockChain.fullScan.mockRejectedValue(error);
-
-      await expect(useCases.discover(discoverParams)).rejects.toBe(error);
-
-      expect(mockRepository.getByDerivationPath).toHaveBeenCalled();
-      expect(mockRepository.create).toHaveBeenCalled();
-      expect(mockChain.fullScan).toHaveBeenCalled();
-    });
   });
 
   describe('synchronize', () => {

packages/snap/src/use-cases/AccountUseCases.ts

@@ -128,12 +128,6 @@ export class AccountUseCases {
       addressType,
     );
 
-    await this.#chain.fullScan(newAccount);
-
-    this.#logger.info(
-      'Bitcoin account discovered successfully. Request: %o',
-      req,
-    );
     return newAccount;
   }
 

yarn.lock

@@ -2879,8 +2879,8 @@ __metadata:
     "@jest/globals": "npm:^30.0.5"
     "@metamask/bitcoindevkit": "npm:^0.1.13"
     "@metamask/key-tree": "npm:^10.1.1"
-    "@metamask/keyring-api": "npm:^20.1.1"
-    "@metamask/keyring-snap-sdk": "npm:^6.0.0"
+    "@metamask/keyring-api": "npm:^21.1.0"
+    "@metamask/keyring-snap-sdk": "npm:^7.1.0"
     "@metamask/slip44": "npm:^4.2.0"
     "@metamask/snaps-cli": "npm:^8.3.0"
     "@metamask/snaps-jest": "npm:^9.4.0"
@@ -3159,19 +3159,31 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@metamask/keyring-snap-sdk@npm:^6.0.0":
-  version: 6.0.0
-  resolution: "@metamask/keyring-snap-sdk@npm:6.0.0"
+"@metamask/keyring-api@npm:^21.1.0":
+  version: 21.1.0
+  resolution: "@metamask/keyring-api@npm:21.1.0"
+  dependencies:
+    "@metamask/keyring-utils": "npm:^3.1.0"
+    "@metamask/superstruct": "npm:^3.1.0"
+    "@metamask/utils": "npm:^11.1.0"
+    bitcoin-address-validation: "npm:^2.2.3"
+  checksum: 10/3371a5ab0e9ba0e9b23b30b03a7d83d029e223def5485ab1aa2ec793ba18ff3738422dbe3c47f9cf82411d2ca6ca918928bf998741f0977055071b7bf3042314
+  languageName: node
+  linkType: hard
+
+"@metamask/keyring-snap-sdk@npm:^7.1.0":
+  version: 7.1.0
+  resolution: "@metamask/keyring-snap-sdk@npm:7.1.0"
   dependencies:
     "@metamask/keyring-utils": "npm:^3.1.0"
     "@metamask/snaps-sdk": "npm:^9.0.0"
     "@metamask/superstruct": "npm:^3.1.0"
     "@metamask/utils": "npm:^11.1.0"
     webextension-polyfill: "npm:^0.12.0"
   peerDependencies:
-    "@metamask/keyring-api": ^20.0.0
+    "@metamask/keyring-api": ^21.1.0
     "@metamask/providers": ^19.0.0
-  checksum: 10/c306615cee12f5669a1e5e5a22a7e0d1a8aa8eb981578ff4cd125067d8aa9fbf788d02ffc17e123ef47458133b6ec8b5a01966599800ea443b4b07f0cdd0ee7e
+  checksum: 10/1a1809733c1f21af87f3491d292c499c5441afa0780e848718ec2b6aff50d76bb03ea44ee93ecaa80d79453a98926d84cd13ff406256ab6a2136d9e31250faa8
   languageName: node
   linkType: hard