feat(bitcoin-snap): update to keyring v2

packages/bitcoin-wallet-snap/CHANGELOG.md

@@ -7,6 +7,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add support for keyring API v2, including `bip44:derive-path`, `bip44:derive-index`, `bip44:derive-index-range`, and `bip44:discover` account creation types ([#43](https://github.com/MetaMask/internal-snaps/pull/43))
+- Add `exportAccount` method supporting WIF (base58) private key export ([#43](https://github.com/MetaMask/internal-snaps/pull/43))
+- Add `parseDerivationPath` to validate and parse BIP-44 derivation paths for native segwit (BIP-84) accounts ([#43](https://github.com/MetaMask/internal-snaps/pull/43))
+
+### Changed
+
+- **BREAKING** Remove v1 keyring API support (`createAccount`, v1 `Keyring` interface) in favour of v2 ([#43](https://github.com/MetaMask/internal-snaps/pull/43))
+- Migrate `KeyringHandler` to implement `KeyringSnapRpc` from `@metamask/keyring-api/v2` ([#43](https://github.com/MetaMask/internal-snaps/pull/43))
+- Update `snap.manifest.json` to declare `derivePath` capability in the `bip44` keyring block ([#43](https://github.com/MetaMask/internal-snaps/pull/43))
+- Mark accounts as exportable in the keyring account mapping ([#43](https://github.com/MetaMask/internal-snaps/pull/43))
+
 ## [1.15.2]
 
 ### Fixed

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

@@ -52,18 +52,18 @@ describe('OnClientRequestHandler', () => {
 
     const response = await snap.onKeyringRequest({
       origin: ORIGIN,
-      method: 'keyring_createAccount',
+      method: 'keyring_createAccounts',
       params: {
-        options: {
-          scope: BtcScope.Regtest,
-          synchronize: false,
-          index: ACCOUNT_INDEX,
-        },
+        type: 'bip44:derive-path',
+        entropySource: 'm',
+        derivationPath: `m/84'/1'/${ACCOUNT_INDEX}'`,
       },
     });
 
     if ('result' in response.response) {
-      account = response.response.result as KeyringAccount;
+      account = (
+        response.response.result as KeyringAccount[]
+      )[0] as KeyringAccount;
       createdAccountId = account.id;
     }
 

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

@@ -60,22 +60,19 @@ describe('CronHandler', () => {
     // create account without initial sync
     const createResponse = await snap.onKeyringRequest({
       origin: ORIGIN,
-      method: 'keyring_createAccount',
+      method: 'keyring_createAccounts',
       params: {
-        options: {
-          scope: BtcScope.Regtest,
-          addressType: BtcAccountType.P2wpkh,
-          synchronize: false,
-          index: ACCOUNT_INDEX,
-        },
+        type: 'bip44:derive-path',
+        entropySource: 'm',
+        derivationPath: `m/84'/1'/${ACCOUNT_INDEX}'`,
       },
     });
 
     expect(createResponse.response).toBeDefined();
     expect('result' in createResponse.response).toBe(true);
 
-    const account = (createResponse.response as { result: KeyringAccount })
-      .result;
+    const account = (createResponse.response as { result: KeyringAccount[] })
+      .result[0] as KeyringAccount;
 
     accountsToSync.push(account.id);
 

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

@@ -50,18 +50,18 @@ describe('KeyringRequestHandler', () => {
 
     const response = await snap.onKeyringRequest({
       origin: ORIGIN,
-      method: 'keyring_createAccount',
+      method: 'keyring_createAccounts',
       params: {
-        options: {
-          scope: BtcScope.Regtest,
-          synchronize: false,
-          index: ACCOUNT_INDEX,
-        },
+        type: 'bip44:derive-path',
+        entropySource: 'm',
+        derivationPath: `m/84'/1'/${ACCOUNT_INDEX}'`,
       },
     });
 
     if ('result' in response.response) {
-      account = response.response.result as KeyringAccount;
+      account = (
+        response.response.result as KeyringAccount[]
+      )[0] as KeyringAccount;
       createdAccountId = account.id;
     }
 
@@ -86,9 +86,9 @@ describe('KeyringRequestHandler', () => {
     });
 
     expect(response).toRespondWithError({
-      code: -32000,
+      code: -32603,
       message:
-        'Invalid format: At path: params.account -- Expected a value of type `UuidV4`, but received: `"notAUUID"`',
+        'At path: params.account -- Expected a value of type `UuidV4`, but received: `"notAUUID"`',
       stack: expect.anything(),
     });
   });
@@ -109,14 +109,8 @@ describe('KeyringRequestHandler', () => {
     });
 
     expect(response).toRespondWithError({
-      code: -32601,
-      data: {
-        account: account.id,
-        cause: null,
-        method: 'invalidMethod',
-      },
-      message:
-        'Method not implemented or not supported: Unrecognized Bitcoin account capability',
+      code: -32603,
+      message: 'Unrecognized Bitcoin account capability',
       stack: expect.anything(),
     });
   });
@@ -381,12 +375,8 @@ describe('KeyringRequestHandler', () => {
       });
 
       expect(response).toRespondWithError({
-        code: -32000,
-        message: 'Invalid format: Invalid PSBT',
-        data: {
-          cause: null,
-          transaction: 'notAPsbt',
-        },
+        code: -32603,
+        message: 'Invalid PSBT',
         stack: expect.anything(),
       });
     });
@@ -415,9 +405,9 @@ describe('KeyringRequestHandler', () => {
       });
 
       expect(response).toRespondWithError({
-        code: -32000,
+        code: -32603,
         message:
-          'Invalid format: At path: account -- Expected an object, but received: undefined',
+          'At path: account -- Expected an object, but received: undefined',
         stack: expect.anything(),
       });
     });
@@ -442,9 +432,9 @@ describe('KeyringRequestHandler', () => {
       });
 
       expect(response).toRespondWithError({
-        code: -32000,
+        code: -32603,
         message:
-          'Invalid format: At path: options -- Expected an object, but received: undefined',
+          'At path: options -- Expected an object, but received: undefined',
         stack: expect.anything(),
       });
     });
@@ -503,12 +493,8 @@ describe('KeyringRequestHandler', () => {
       });
 
       expect(response).toRespondWithError({
-        code: -32000,
-        message: 'Invalid format: Invalid PSBT',
-        data: {
-          cause: null,
-          transaction: 'notAPsbt',
-        },
+        code: -32603,
+        message: 'Invalid PSBT',
         stack: expect.anything(),
       });
     });
@@ -567,12 +553,8 @@ describe('KeyringRequestHandler', () => {
       });
 
       expect(response).toRespondWithError({
-        code: -32000,
-        message: 'Invalid format: Invalid PSBT',
-        data: {
-          cause: null,
-          transaction: 'notAPsbt',
-        },
+        code: -32603,
+        message: 'Invalid PSBT',
         stack: expect.anything(),
       });
     });
@@ -665,12 +647,8 @@ describe('KeyringRequestHandler', () => {
       });
 
       expect(response).toRespondWithError({
-        code: -32000,
-        message: 'Invalid format: Invalid PSBT',
-        data: {
-          cause: null,
-          transaction: 'notAPsbt',
-        },
+        code: -32603,
+        message: 'Invalid PSBT',
         stack: expect.anything(),
       });
     });
@@ -737,9 +715,8 @@ describe('KeyringRequestHandler', () => {
       });
 
       expect(response).toRespondWithError({
-        code: -32602,
-        data: { address: 'notAnAddress', amount: '1000', cause: null },
-        message: 'Validation failed: Invalid recipient',
+        code: -32603,
+        message: 'Invalid recipient',
         stack: expect.anything(),
       });
     });