chore(abstract-utxo): deprecate signing override params

BTC-2286

TICKET: BTC-2286

Author: davidkaplanbitgo

modules/abstract-utxo/src/sign.ts

@@ -64,6 +64,7 @@ export function signAndVerifyPsbt(
   signerKeychain: utxolib.BIP32Interface,
   {
     isLastSignature,
+    /** deprecated */
     allowNonSegwitSigningWithoutPrevTx,
   }: { isLastSignature: boolean; allowNonSegwitSigningWithoutPrevTx?: boolean }
 ): utxolib.bitgo.UtxoPsbt | utxolib.bitgo.UtxoTransaction<bigint> {
@@ -85,11 +86,7 @@ export function signAndVerifyPsbt(
       }
 
       try {
-        utxolib.bitgo.withUnsafeNonSegwit(
-          psbt,
-          () => psbt.signInputHD(inputIndex, signerKeychain),
-          !!allowNonSegwitSigningWithoutPrevTx
-        );
+        psbt.signInputHD(inputIndex, signerKeychain);
         debug('Successfully signed input %d of %d', inputIndex + 1, psbt.data.inputs.length);
       } catch (e) {
         return new InputSigningError<bigint>(inputIndex, { id: outputId }, e);
@@ -111,13 +108,7 @@ export function signAndVerifyPsbt(
 
       const outputId = outputIds[inputIndex];
       try {
-        if (
-          !utxolib.bitgo.withUnsafeNonSegwit(
-            psbt,
-            () => psbt.validateSignaturesOfInputHD(inputIndex, signerKeychain),
-            !!allowNonSegwitSigningWithoutPrevTx
-          )
-        ) {
+        if (!psbt.validateSignaturesOfInputHD(inputIndex, signerKeychain)) {
           return new InputSigningError(inputIndex, { id: outputId }, new Error(`invalid signature`));
         }
       } catch (e) {

modules/abstract-utxo/src/transaction/fixedScript/signTransaction.ts

@@ -27,6 +27,7 @@ export async function signTransaction<TNumber extends number | bigint>(
     txInfo: { unspents?: utxolib.bitgo.Unspent<TNumber>[] } | undefined;
     isLastSignature: boolean;
     signingStep: 'signerNonce' | 'cosignerNonce' | 'signerSignature' | undefined;
+    /** deprecated */
     allowNonSegwitSigningWithoutPrevTx: boolean;
     pubs: string[] | undefined;
     cosignerPub: string | undefined;
@@ -47,19 +48,11 @@ export async function signTransaction<TNumber extends number | bigint>(
     isLastSignature = params.isLastSignature;
   }
 
-  const setSignerMusigNonceWithOverride = (
-    psbt: utxolib.bitgo.UtxoPsbt,
-    signerKeychain: utxolib.BIP32Interface,
-    nonSegwitOverride: boolean
-  ) => {
-    utxolib.bitgo.withUnsafeNonSegwit(psbt, () => psbt.setAllInputsMusig2NonceHD(signerKeychain), nonSegwitOverride);
-  };
-
   if (tx instanceof bitgo.UtxoPsbt && isTxWithKeyPathSpendInput) {
     switch (params.signingStep) {
       case 'signerNonce':
         assert(signerKeychain);
-        setSignerMusigNonceWithOverride(tx, signerKeychain, params.allowNonSegwitSigningWithoutPrevTx);
+        tx.setAllInputsMusig2NonceHD(signerKeychain);
         PSBT_CACHE.set(tx.getUnsignedTx().getId(), tx);
         return { txHex: tx.toHex() };
       case 'cosignerNonce':
@@ -80,7 +73,7 @@ export async function signTransaction<TNumber extends number | bigint>(
         // this instance is not an external signer
         assert(params.walletId, 'walletId is required for MuSig2 bitgo nonce');
         assert(signerKeychain);
-        setSignerMusigNonceWithOverride(tx, signerKeychain, params.allowNonSegwitSigningWithoutPrevTx);
+        tx.setAllInputsMusig2NonceHD(signerKeychain);
         const response = await coin.signPsbt(tx.toHex(), params.walletId);
         tx.combine(bitgo.createPsbtFromHex(response.psbt, coin.network));
         break;
@@ -102,7 +95,6 @@ export async function signTransaction<TNumber extends number | bigint>(
     assert(signerKeychain);
     signedTransaction = signAndVerifyPsbt(tx, signerKeychain, {
       isLastSignature,
-      allowNonSegwitSigningWithoutPrevTx: params.allowNonSegwitSigningWithoutPrevTx,
     });
   } else {
     if (tx.ins.length !== params.txInfo?.unspents?.length) {

modules/utxo-lib/src/testutil/psbt.ts

@@ -24,7 +24,6 @@ import {
   UtxoPsbt,
   UtxoTransaction,
   verifySignatureWithUnspent,
-  withUnsafeNonSegwit,
 } from '../bitgo';
 import { Network } from '../networks';
 import { mockReplayProtectionUnspent, mockWalletUnspent } from './mock';
@@ -115,32 +114,21 @@ export function signPsbtInput(
   params?: {
     signers?: { signerName: KeyName; cosignerName?: KeyName };
     deterministic?: boolean;
+    // For backwards compatibility keep this here.
     skipNonWitnessUtxo?: boolean;
   }
 ): void {
-  function signPsbt(psbt: UtxoPsbt, signFunc: () => void, skipNonWitnessUtxo?: boolean) {
-    if (skipNonWitnessUtxo) {
-      withUnsafeNonSegwit(psbt, signFunc);
-    } else {
-      signFunc();
-    }
-  }
-
-  const { signers, deterministic, skipNonWitnessUtxo } = params ?? {};
+  const { signers, deterministic } = params ?? {};
   const { signerName, cosignerName } = signers ? signers : getSigners(input.scriptType);
   if (sign === 'halfsigned') {
     if (input.scriptType === 'p2shP2pk') {
-      signPsbt(psbt, () => psbt.signInput(inputIndex, rootWalletKeys[signerName]), skipNonWitnessUtxo);
+      psbt.signInput(inputIndex, rootWalletKeys[signerName]);
     } else {
-      signPsbt(psbt, () => psbt.signInputHD(inputIndex, rootWalletKeys[signerName]), skipNonWitnessUtxo);
+      psbt.signInputHD(inputIndex, rootWalletKeys[signerName]);
     }
   }
   if (sign === 'fullsigned' && cosignerName && input.scriptType !== 'p2shP2pk') {
-    signPsbt(
-      psbt,
-      () => psbt.signInputHD(inputIndex, rootWalletKeys[cosignerName], { deterministic }),
-      skipNonWitnessUtxo
-    );
+    psbt.signInputHD(inputIndex, rootWalletKeys[cosignerName], { deterministic });
   }
 }
 
@@ -156,12 +144,13 @@ export function signAllPsbtInputs(
   params?: {
     signers?: { signerName: KeyName; cosignerName?: KeyName };
     deterministic?: boolean;
+    // For backwards compatibility keep this here.
     skipNonWitnessUtxo?: boolean;
   }
 ): void {
-  const { signers, deterministic, skipNonWitnessUtxo } = params ?? {};
+  const { signers, deterministic } = params ?? {};
   inputs.forEach((input, inputIndex) => {
-    signPsbtInput(psbt, input, inputIndex, rootWalletKeys, sign, { signers, deterministic, skipNonWitnessUtxo });
+    signPsbtInput(psbt, input, inputIndex, rootWalletKeys, sign, { signers, deterministic });
   });
 }
 

modules/utxo-lib/test/bitgo/psbt/Psbt.ts

@@ -32,7 +32,6 @@ import {
   clonePsbtWithoutNonWitnessUtxo,
   deleteWitnessUtxoForNonSegwitInputs,
   getPsbtInputScriptType,
-  withUnsafeNonSegwit,
   getTransactionAmountsFromPsbt,
   WalletUnspent,
   getDefaultSigHash,
@@ -289,18 +288,14 @@ function runBuildSignSendFlowTest(
       hex = psbtWithoutPrevTx.toHex();
 
       psbtAtHsm = createPsbtFromHex(hex, network);
-      withUnsafeNonSegwit(psbtAtHsm, () => {
-        testutil.signAllPsbtInputs(psbtAtHsm, inputs, rootWalletKeys, 'fullsigned', {
-          signers: {
-            signerName: 'user',
-            cosignerName: 'bitgo',
-          },
-          deterministic: true,
-        });
-      });
-      withUnsafeNonSegwit(psbtAtHsm, () => {
-        assertValidate(psbtAtHsm);
+      testutil.signAllPsbtInputs(psbtAtHsm, inputs, rootWalletKeys, 'fullsigned', {
+        signers: {
+          signerName: 'user',
+          cosignerName: 'bitgo',
+        },
+        deterministic: true,
       });
+      assertValidate(psbtAtHsm);
       hexAtHsm = psbtAtHsm.toHex();
 
       psbtFromHsm = createPsbtFromHex(hexAtHsm, network);