Merge pull request #6631 from BitGo/BTC-2372

feat(bip322): add scriptPubKey field to AddressDetails

Author: davidkaplanbitgo

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

@@ -3,6 +3,7 @@ import { Psbt, Transaction } from '@bitgo/utxo-lib';
 export type AddressDetails = {
   redeemScript?: Buffer;
   witnessScript?: Buffer;
+  scriptPubKey: Buffer;
 };
 
 /**
@@ -15,10 +16,6 @@ export type AddressDetails = {
  * @returns {string} - The hex representation of the constructed PSBT.
  */
 export function buildToSignPsbt(toSpendTx: Transaction<bigint>, addressDetails: AddressDetails): Psbt {
-  if (!addressDetails.redeemScript && !addressDetails.witnessScript) {
-    throw new Error('redeemScript and/or witnessScript must be provided');
-  }
-
   // Create PSBT object for constructing the transaction
   const psbt = new Psbt();
   // Set default value for nVersion and nLockTime
@@ -31,13 +28,15 @@ export function buildToSignPsbt(toSpendTx: Transaction<bigint>, addressDetails:
     sequence: 0, // vin[0].nSequence = 0
     nonWitnessUtxo: toSpendTx.toBuffer(), // previous transaction for us to rebuild later to verify
   });
+  psbt.updateInput(0, {
+    witnessUtxo: { value: BigInt(0), script: addressDetails.scriptPubKey },
+  });
+
   if (addressDetails.redeemScript) {
     psbt.updateInput(0, { redeemScript: addressDetails.redeemScript });
   }
   if (addressDetails.witnessScript) {
-    psbt.updateInput(0, {
-      witnessUtxo: { value: BigInt(0), script: addressDetails.witnessScript },
-    });
+    psbt.updateInput(0, { witnessScript: addressDetails.witnessScript });
   }
 
   // Set the output

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

@@ -1,5 +1,5 @@
 import { Hash } from 'fast-sha256';
-import { Psbt, Transaction } from '@bitgo/utxo-lib';
+import { Psbt, Transaction, bitgo, networks } from '@bitgo/utxo-lib';
 
 export const BIP322_TAG = 'BIP0322-signed-message';
 
@@ -66,3 +66,23 @@ export function buildToSpendTransaction(
   // Return transaction
   return psbt.extractTransaction();
 }
+
+export function buildToSpendTransactionFromChainAndIndex(
+  rootWalletKeys: bitgo.RootWalletKeys,
+  chain: bitgo.ChainCode,
+  index: number,
+  message: string | Buffer,
+  tag = BIP322_TAG
+): Transaction<bigint> {
+  const taprootChains = [...bitgo.chainCodesP2tr, ...bitgo.chainCodesP2trMusig2];
+  if (taprootChains.some((tc) => tc === chain)) {
+    throw new Error('BIP322 is not supported for Taproot script types.');
+  }
+
+  const outputScript = bitgo.outputScripts.createOutputScript2of3(
+    rootWalletKeys.deriveForChainAndIndex(chain, index).publicKeys,
+    bitgo.scriptTypeForChain(chain),
+    networks.bitcoin
+  );
+  return buildToSpendTransaction(outputScript.scriptPubKey, message, tag);
+}

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

@@ -14,5 +14,5 @@ export const BIP322_FIXTURE_HELLO_WORLD_TOSPEND_TX = buildToSpendTransaction(
 );
 
 export const BIP322_FIXTURE_HELLOW_WORLD_TOSIGN_PSBT = buildToSignPsbt(BIP322_FIXTURE_HELLO_WORLD_TOSPEND_TX, {
-  witnessScript: BIP322_PAYMENT_P2WPKH_FIXTURE.output as Buffer,
+  scriptPubKey: BIP322_PAYMENT_P2WPKH_FIXTURE.output as Buffer,
 });

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

@@ -24,7 +24,7 @@ describe('BIP322 toSign', function () {
       it(`should build a to_sign PSBT for message "${message}"`, function () {
         const toSpendTx = bip322.buildToSpendTransaction(scriptPubKey, Buffer.from(message));
         const addressDetails = {
-          witnessScript: scriptPubKey,
+          scriptPubKey,
         };
         const result = bip322.buildToSignPsbt(toSpendTx, addressDetails);
         const computedTxid = result

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

@@ -1,6 +1,12 @@
 import assert from 'assert';
 
-import { buildToSpendTransaction, hashMessageWithTag } from '../../src/bip322';
+import { testutil, bitgo } from '@bitgo/utxo-lib';
+
+import {
+  buildToSpendTransaction,
+  hashMessageWithTag,
+  buildToSpendTransactionFromChainAndIndex,
+} from '../../src/bip322';
 
 import { BIP322_PAYMENT_P2WPKH_FIXTURE } from './bip322.utils';
 
@@ -53,4 +59,46 @@ describe('to_spend', function () {
       });
     });
   });
+
+  describe('buildToSpendTransactionFromChainAndIndex', function () {
+    it('should throw an error for Taproot chains', function () {
+      const taprootChains = [...bitgo.chainCodesP2tr, ...bitgo.chainCodesP2trMusig2];
+      taprootChains.forEach((chain) => {
+        assert.throws(() => {
+          buildToSpendTransactionFromChainAndIndex(
+            testutil.getDefaultWalletKeys(),
+            chain,
+            0,
+            Buffer.from('Hello World')
+          );
+        }, /BIP322 is not supported for Taproot script types/);
+      });
+    });
+
+    describe('should build a to_spend transaction for a non-Taproot chain', function () {
+      function run(chain: bitgo.ChainCode) {
+        it(`scriptType: ${bitgo.scriptTypeForChain(chain)}, chain ${chain}`, function () {
+          const tx = buildToSpendTransactionFromChainAndIndex(
+            testutil.getDefaultWalletKeys(),
+            20,
+            0,
+            Buffer.from('Hello World')
+          );
+          const expectedScriptPubKey = bitgo.outputScripts
+            .createOutputScript2of3(testutil.getDefaultWalletKeys().deriveForChainAndIndex(20, 0).publicKeys, 'p2wsh')
+            .scriptPubKey.toString();
+          const scriptPubKeyFromTx = tx.outs[0].script.toString();
+          assert.deepStrictEqual(
+            scriptPubKeyFromTx,
+            expectedScriptPubKey,
+            'ScriptPubKey does not match expected value'
+          );
+        });
+      }
+
+      ([0, 1, 10, 11, 20, 21] as bitgo.ChainCode[]).forEach((chain) => {
+        run(chain);
+      });
+    });
+  });
 });