Taproot feature support

packages/snap/integration-test/blockchain-utils.ts

@@ -174,4 +174,17 @@ export class BlockchainTestUtils {
     const balanceSats = await this.getBalance(address);
     return Number(balanceSats) / 100_000_000;
   }
+
+  /**
+   * Generate a new Bitcoin address from the regtest node wallet.
+   *
+   * @param addressType - The address type to generate. Defaults to 'bech32'.
+   * Valid values: 'legacy', 'p2sh-segwit', 'bech32', 'bech32m'.
+   * @returns A new Bitcoin address.
+   */
+  async getNewAddress(
+    addressType: 'legacy' | 'p2sh-segwit' | 'bech32' | 'bech32m' = 'bech32',
+  ): Promise<string> {
+    return this.#execCli(`-rpcwallet=default getnewaddress "" ${addressType}`);
+  }
 }

packages/snap/integration-test/constants.ts

@@ -9,6 +9,13 @@ export const TEST_ADDRESS_REGTEST =
   'bcrt1qjtgffm20l9vu6a7gacxvpu2ej4kdcsgcgnly6t';
 export const TEST_ADDRESS_MAINNET =
   'bc1q832zlt4tgnqy88vd20mazw77dlt0j0wf2naw8q';
+
+// P2TR (Taproot) addresses
+export const TEST_ADDRESS_P2TR_MAINNET =
+  'bc1p4rue37y0v9snd4z3fvw43d29u97qxf9j3fva72xy2t7hekg24dzsaz40mz';
+export const TEST_ADDRESS_P2TR_TESTNET =
+  'tb1pwwjax3vpq6h69965hcr22vkpm4qdvyu2pz67wyj8eagp9vxkcz0q0ya20h';
+
 export const ORIGIN = 'metamask';
 export const FUNDING_TX = {
   account: expect.any(Number),
@@ -50,3 +57,7 @@ export const scopeToCoinType: Record<BtcScope, string> = {
   [BtcScope.Signet]: "1'",
   [BtcScope.Regtest]: "1'",
 };
+
+// PSBTs can be decoded here: https://bitcoincore.tech/apps/bitcoinjs-ui/index.html
+export const TEMPLATE_PSBT =
+  'cHNidP8BAI4CAAAAAAM1gwEAAAAAACJRIORP1Ndiq325lSC/jMG0RlhATHYmuuULfXgEHUM3u5i4AAAAAAAAAAAxai8AAUSx+i9Igg4HWdcpyagCs8mzuRCklgA7nRMkm69rAAAAAAAAAAAAAQACAAAAACp2AAAAAAAAFgAUgpMvYEJ/dp36svRJyRtNnpSo7bQAAAAAAAAAAAA=';

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

@@ -1,10 +1,11 @@
-import type { KeyringAccount, KeyringRequest } from '@metamask/keyring-api';
+import type { KeyringAccount } from '@metamask/keyring-api';
 import { BtcScope } from '@metamask/keyring-api';
 import type { Snap } from '@metamask/snaps-jest';
 import { assertIsConfirmationDialog, installSnap } from '@metamask/snaps-jest';
 
 import { BlockchainTestUtils } from './blockchain-utils';
-import { MNEMONIC, ORIGIN } from './constants';
+import { MNEMONIC, ORIGIN, TEMPLATE_PSBT } from './constants';
+import { getRequiredOutpoint } from './test-helpers';
 import { AccountCapability } from '../src/entities';
 import type { FillPsbtResponse } from '../src/handlers/KeyringRequestHandler';
 
@@ -81,7 +82,7 @@ describe('KeyringRequestHandler', () => {
         request: {
           method: AccountCapability.SignPsbt,
         },
-      } as KeyringRequest,
+      },
     });
 
     expect(response).toRespondWithError({
@@ -104,7 +105,7 @@ describe('KeyringRequestHandler', () => {
         request: {
           method: 'invalidMethod',
         },
-      } as KeyringRequest,
+      },
     });
 
     expect(response).toRespondWithError({
@@ -134,7 +135,7 @@ describe('KeyringRequestHandler', () => {
           request: {
             method: AccountCapability.ListUtxos,
           },
-        } as KeyringRequest,
+        },
       });
 
       expect(response).toRespondWith({
@@ -155,6 +156,7 @@ describe('KeyringRequestHandler', () => {
       const utxos = (
         response.response as { result: { result: { outpoint: string }[] } }
       ).result.result;
+      const outpoint = getRequiredOutpoint(utxos);
 
       response = await snap.onKeyringRequest({
         origin: ORIGIN,
@@ -167,10 +169,10 @@ describe('KeyringRequestHandler', () => {
           request: {
             method: AccountCapability.GetUtxo,
             params: {
-              outpoint: utxos[0]?.outpoint,
+              outpoint,
             },
           },
-        } as KeyringRequest,
+        },
       });
 
       expect(response).toRespondWith({
@@ -191,7 +193,7 @@ describe('KeyringRequestHandler', () => {
           request: {
             method: AccountCapability.PublicDescriptor,
           },
-        } as KeyringRequest,
+        },
       });
 
       expect(response).toRespondWith({
@@ -203,9 +205,6 @@ describe('KeyringRequestHandler', () => {
   });
 
   describe('signPsbt', () => {
-    // PSBTs can be decoded here: https://bitcoincore.tech/apps/bitcoinjs-ui/index.html
-    const TEMPLATE_PSBT =
-      'cHNidP8BAI4CAAAAAAM1gwEAAAAAACJRIORP1Ndiq325lSC/jMG0RlhATHYmuuULfXgEHUM3u5i4AAAAAAAAAAAxai8AAUSx+i9Igg4HWdcpyagCs8mzuRCklgA7nRMkm69rAAAAAAAAAAAAAQACAAAAACp2AAAAAAAAFgAUgpMvYEJ/dp36svRJyRtNnpSo7bQAAAAAAAAAAAA=';
     const SIGNED_PSBT =
       'cHNidP8BAI4CAAAAAAM1gwEAAAAAACJRIORP1Ndiq325lSC/jMG0RlhATHYmuuULfXgEHUM3u5i4AAAAAAAAAAAxai8AAUSx+i9Igg4HWdcpyagCs8mzuRCklgA7nRMkm69rAAAAAAAAAAAAAQACAAAAACp2AAAAAAAAFgAUgpMvYEJ/dp36svRJyRtNnpSo7bQAAAAAAAAAAA==';
 
@@ -229,7 +228,7 @@ describe('KeyringRequestHandler', () => {
               },
             },
           },
-        } as KeyringRequest,
+        },
       });
 
       expect(response).toRespondWith({
@@ -261,7 +260,7 @@ describe('KeyringRequestHandler', () => {
               },
             },
           },
-        } as KeyringRequest,
+        },
       });
 
       expect(response).toRespondWith({
@@ -293,7 +292,7 @@ describe('KeyringRequestHandler', () => {
               },
             },
           },
-        } as KeyringRequest,
+        },
       });
 
       expect(response).toRespondWith({
@@ -324,7 +323,7 @@ describe('KeyringRequestHandler', () => {
               },
             },
           },
-        } as KeyringRequest,
+        },
       });
 
       expect(response).toRespondWithError({
@@ -353,7 +352,7 @@ describe('KeyringRequestHandler', () => {
               psbt: TEMPLATE_PSBT,
             },
           },
-        } as KeyringRequest,
+        },
       });
 
       expect(response).toRespondWithError({
@@ -366,10 +365,6 @@ describe('KeyringRequestHandler', () => {
   });
 
   describe('fillPsbt', () => {
-    // PSBTs can be decoded here: https://bitcoincore.tech/apps/bitcoinjs-ui/index.html
-    const TEMPLATE_PSBT =
-      'cHNidP8BAI4CAAAAAAM1gwEAAAAAACJRIORP1Ndiq325lSC/jMG0RlhATHYmuuULfXgEHUM3u5i4AAAAAAAAAAAxai8AAUSx+i9Igg4HWdcpyagCs8mzuRCklgA7nRMkm69rAAAAAAAAAAAAAQACAAAAACp2AAAAAAAAFgAUgpMvYEJ/dp36svRJyRtNnpSo7bQAAAAAAAAAAAA=';
-
     it('fills a PSBT successfully', async () => {
       const response = await snap.onKeyringRequest({
         origin: ORIGIN,
@@ -386,7 +381,7 @@ describe('KeyringRequestHandler', () => {
               feeRate: 3,
             },
           },
-        } as KeyringRequest,
+        },
       });
 
       expect(response).toRespondWith({
@@ -412,7 +407,7 @@ describe('KeyringRequestHandler', () => {
               psbt: 'notAPsbt',
             },
           },
-        } as KeyringRequest,
+        },
       });
 
       expect(response).toRespondWithError({
@@ -428,10 +423,6 @@ describe('KeyringRequestHandler', () => {
   });
 
   describe('computeFee', () => {
-    // PSBTs can be decoded here: https://bitcoincore.tech/apps/bitcoinjs-ui/index.html
-    const TEMPLATE_PSBT =
-      'cHNidP8BAI4CAAAAAAM1gwEAAAAAACJRIORP1Ndiq325lSC/jMG0RlhATHYmuuULfXgEHUM3u5i4AAAAAAAAAAAxai8AAUSx+i9Igg4HWdcpyagCs8mzuRCklgA7nRMkm69rAAAAAAAAAAAAAQACAAAAACp2AAAAAAAAFgAUgpMvYEJ/dp36svRJyRtNnpSo7bQAAAAAAAAAAAA=';
-
     it('computes the fee for a PSBT successfully', async () => {
       const response = await snap.onKeyringRequest({
         origin: ORIGIN,
@@ -448,7 +439,7 @@ describe('KeyringRequestHandler', () => {
               feeRate: 3,
             },
           },
-        } as KeyringRequest,
+        },
       });
 
       expect(response).toRespondWith({
@@ -474,7 +465,7 @@ describe('KeyringRequestHandler', () => {
               psbt: 'notAPsbt',
             },
           },
-        } as KeyringRequest,
+        },
       });
 
       expect(response).toRespondWithError({
@@ -490,10 +481,6 @@ describe('KeyringRequestHandler', () => {
   });
 
   describe('broadcastPsbt', () => {
-    // PSBTs can be decoded here: https://bitcoincore.tech/apps/bitcoinjs-ui/index.html
-    const TEMPLATE_PSBT =
-      'cHNidP8BAI4CAAAAAAM1gwEAAAAAACJRIORP1Ndiq325lSC/jMG0RlhATHYmuuULfXgEHUM3u5i4AAAAAAAAAAAxai8AAUSx+i9Igg4HWdcpyagCs8mzuRCklgA7nRMkm69rAAAAAAAAAAAAAQACAAAAACp2AAAAAAAAFgAUgpMvYEJ/dp36svRJyRtNnpSo7bQAAAAAAAAAAAA=';
-
     it('broadcasts a PSBT successfully', async () => {
       // Prepare the PSBT to broadcast so we have a valid PSBT to broadcast
       let response = await snap.onKeyringRequest({
@@ -515,7 +502,7 @@ describe('KeyringRequestHandler', () => {
               },
             },
           },
-        } as KeyringRequest,
+        },
       });
 
       const { result } = (
@@ -536,7 +523,7 @@ describe('KeyringRequestHandler', () => {
               psbt: result.psbt,
             },
           },
-        } as KeyringRequest,
+        },
       });
 
       expect(response).toRespondWith({
@@ -562,7 +549,7 @@ describe('KeyringRequestHandler', () => {
               psbt: 'notAPsbt',
             },
           },
-        } as KeyringRequest,
+        },
       });
 
       expect(response).toRespondWithError({
@@ -603,7 +590,7 @@ describe('KeyringRequestHandler', () => {
               feeRate: 3,
             },
           },
-        } as KeyringRequest,
+        },
       });
 
       expect(response).toRespondWith({
@@ -629,7 +616,7 @@ describe('KeyringRequestHandler', () => {
               recipients: [{ address: 'notAnAddress', amount: '1000' }],
             },
           },
-        } as KeyringRequest,
+        },
       });
 
       expect(response).toRespondWithError({
@@ -657,7 +644,7 @@ describe('KeyringRequestHandler', () => {
               message: 'Hello, world!',
             },
           },
-        } as KeyringRequest,
+        },
       });
 
       const ui = await response.getInterface();