Merge pull request #6711 from BitGo/BTC-2385.refactor

refactor(utxo-core): enhance BIP322 with support for multiple inputs

Author: davidkaplanbitgo

modules/utxo-core/src/bip322/toSign.ts

@@ -8,9 +8,35 @@ export type AddressDetails = {
   witnessScript?: Buffer;
   scriptPubKey: Buffer;
 };
+export const MAX_NUM_BIP322_INPUTS = 200;
 
 /**
- * Construct the toSign PSBT for a BIP322 verification.
+ * Create the base PSBT for the to_sign transaction for BIP322 signing.
+ * There will be ever 1 output.
+ */
+export function createBaseToSignPsbt(rootWalletKeys?: bitgo.RootWalletKeys): Psbt {
+  // Create PSBT object for constructing the transaction
+  const psbt = new Psbt();
+  // Set default value for nVersion and nLockTime
+  psbt.setVersion(0); // nVersion = 0
+  psbt.setLocktime(0); // nLockTime = 0
+
+  // Set the output
+  psbt.addOutput({
+    value: BigInt(0), // vout[0].nValue = 0
+    script: Buffer.from([0x6a]), // vout[0].scriptPubKey = OP_RETURN
+  });
+
+  // If rootWalletKeys are provided, add them to the PSBT as global xpubs
+  if (rootWalletKeys) {
+    bitgo.addXpubsToPsbt(psbt, rootWalletKeys);
+  }
+
+  return psbt;
+}
+
+/**
+ * Add a BIP322 input to the PSBT.
  * Source implementation:
  * https://github.com/bitcoin/bips/blob/master/bip-0322.mediawiki#full
  *
@@ -19,44 +45,38 @@ export type AddressDetails = {
  * @param {string} [tag=BIP322_TAG] - The tag to use for hashing, defaults to BIP322_TAG.
  * @returns {Psbt} - The hex representation of the constructed PSBT.
  */
-export function buildToSignPsbt(message: string, addressDetails: AddressDetails, tag = BIP322_TAG): Psbt {
+export function addBip322Input(psbt: Psbt, message: string, addressDetails: AddressDetails, tag = BIP322_TAG): void {
   const toSpendTx = buildToSpendTransaction(addressDetails.scriptPubKey, message, tag);
+  if (psbt.data.inputs.length >= MAX_NUM_BIP322_INPUTS) {
+    throw new Error(`Exceeded maximum number of BIP322 inputs (${MAX_NUM_BIP322_INPUTS})`);
+  }
 
-  // Create PSBT object for constructing the transaction
-  const psbt = new Psbt();
-  // Set default value for nVersion and nLockTime
-  psbt.setVersion(0); // nVersion = 0
-  psbt.setLocktime(0); // nLockTime = 0
-  // Set the input
   psbt.addInput({
     hash: toSpendTx.getId(), // vin[0].prevout.hash = to_spend.txid
     index: 0, // vin[0].prevout.n = 0
     sequence: 0, // vin[0].nSequence = 0
     nonWitnessUtxo: toSpendTx.toBuffer(), // previous transaction for us to rebuild later to verify
   });
-  psbt.updateInput(0, {
+  const inputIndex = psbt.data.inputs.length - 1;
+  psbt.updateInput(inputIndex, {
     witnessUtxo: { value: BigInt(0), script: addressDetails.scriptPubKey },
   });
 
   if (addressDetails.redeemScript) {
-    psbt.updateInput(0, { redeemScript: addressDetails.redeemScript });
+    psbt.updateInput(inputIndex, { redeemScript: addressDetails.redeemScript });
   }
   if (addressDetails.witnessScript) {
-    psbt.updateInput(0, { witnessScript: addressDetails.witnessScript });
+    psbt.updateInput(inputIndex, {
+      witnessScript: addressDetails.witnessScript,
+    });
   }
 
   // Add the message as a proprietary key value to the PSBT so we can verify it later
-  addBip322ProofMessage(psbt, 0, Buffer.from(message));
-
-  // Set the output
-  psbt.addOutput({
-    value: BigInt(0), // vout[0].nValue = 0
-    script: Buffer.from([0x6a]), // vout[0].scriptPubKey = OP_RETURN
-  });
-  return psbt;
+  addBip322ProofMessage(psbt, inputIndex, Buffer.from(message));
 }
 
-export function buildToSignPsbtForChainAndIndex(
+export function addBip322InputWithChainAndIndex(
+  psbt: Psbt,
   message: string,
   rootWalletKeys: bitgo.RootWalletKeys,
   chain: bitgo.ChainCode,
@@ -68,17 +88,17 @@ export function buildToSignPsbtForChainAndIndex(
   const walletKeys = rootWalletKeys.deriveForChainAndIndex(chain, index);
   const output = bitgo.outputScripts.createOutputScript2of3(walletKeys.publicKeys, bitgo.scriptTypeForChain(chain));
 
-  const psbt = buildToSignPsbt(message, {
+  addBip322Input(psbt, message, {
     scriptPubKey: output.scriptPubKey,
     redeemScript: output.redeemScript,
     witnessScript: output.witnessScript,
   });
 
+  const inputIndex = psbt.data.inputs.length - 1;
   psbt.updateInput(
-    0,
+    inputIndex,
     bitgo.getPsbtBip32DerivationOutputUpdate(rootWalletKeys, walletKeys, bitgo.scriptTypeForChain(chain))
   );
-  bitgo.addXpubsToPsbt(psbt, rootWalletKeys);
 
   return psbt;
 }

modules/utxo-core/test/bip322/bip322.utils.ts

@@ -1,6 +1,6 @@
 import { payments, ECPair } from '@bitgo/utxo-lib';
 
-import { buildToSignPsbt, buildToSpendTransaction } from '../../src/bip322';
+import { addBip322Input, createBaseToSignPsbt, buildToSpendTransaction } from '../../src/bip322';
 
 export const BIP322_WIF_FIXTURE = 'L3VFeEujGtevx9w18HD1fhRbCH67Az2dpCymeRE1SoPK6XQtaN2k';
 export const BIP322_PRV_FIXTURE = ECPair.fromWIF(BIP322_WIF_FIXTURE);
@@ -13,6 +13,7 @@ export const BIP322_FIXTURE_HELLO_WORLD_TOSPEND_TX = buildToSpendTransaction(
   Buffer.from('Hello World')
 );
 
-export const BIP322_FIXTURE_HELLO_WORLD_TOSIGN_PSBT = buildToSignPsbt('Hello World', {
+export const BIP322_FIXTURE_HELLO_WORLD_TOSIGN_PSBT = createBaseToSignPsbt();
+addBip322Input(BIP322_FIXTURE_HELLO_WORLD_TOSIGN_PSBT, 'Hello World', {
   scriptPubKey: BIP322_PAYMENT_P2WPKH_FIXTURE.output as Buffer,
 });

modules/utxo-core/test/bip322/toSign.ts

@@ -23,7 +23,8 @@ describe('BIP322 toSign', function () {
 
     fixtures.forEach(({ message, txid }) => {
       it(`should build a to_sign PSBT for message "${message}"`, function () {
-        const result = bip322.buildToSignPsbt(message, {
+        const result = bip322.createBaseToSignPsbt();
+        bip322.addBip322Input(result, message, {
           scriptPubKey,
         });
         const computedTxid = result
@@ -51,7 +52,8 @@ describe('BIP322 toSign', function () {
           return;
         }
         const toSpendTx = bip322.buildToSpendTransactionFromChainAndIndex(rootWalletKeys, chain, index, message);
-        const toSignPsbt = bip322.buildToSignPsbtForChainAndIndex(message, rootWalletKeys, chain, index);
+        const toSignPsbt = bip322.createBaseToSignPsbt(rootWalletKeys);
+        bip322.addBip322InputWithChainAndIndex(toSignPsbt, message, rootWalletKeys, chain, index);
 
         // Can sign the PSBT with the keys
         // Should be able to use HD because we have the bip32Derivation information