Merge pull request #80 from BitGo/BTC-720-disable-warn-sometimes

feat: add flag to disable unsafe sign warning
BitGo · Dec 8, 2023 · 797d833 · 797d833
2 parents bf24f1d + b5e2e3e
commit 797d833
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 18 deletions.
diff --git a/src/psbt.js b/src/psbt.js
@@ -78,6 +78,7 @@ class Psbt {
       // We will disable exporting the Psbt when unsafe sign is active.
       // because it is not BIP174 compliant.
       __UNSAFE_SIGN_NONSEGWIT: false,
+      __WARN_UNSAFE_SIGN_NONSEGWIT: true,
       __TX_FROM_BUFFER: buf =>
         this.constructor.transactionFromBuffer(buf, this.opts.network),
     };
@@ -1016,15 +1017,17 @@ function getHashForSig(inputIndex, input, cache, forValidate, sighashTypes) {
           `${meaningfulScript.toString('hex')}`,
       );
     if (!forValidate && cache.__UNSAFE_SIGN_NONSEGWIT !== false)
-      console.warn(
-        'Warning: Signing non-segwit inputs without the full parent transaction ' +
-          'means there is a chance that a miner could feed you incorrect information ' +
-          "to trick you into paying large fees. This behavior is the same as Psbt's predecesor " +
-          '(TransactionBuilder - now removed) when signing non-segwit scripts. You are not ' +
-          'able to export this Psbt with toBuffer|toBase64|toHex since it is not ' +
-          'BIP174 compliant.\n*********************\nPROCEED WITH CAUTION!\n' +
-          '*********************',
-      );
+      if (cache.__WARN_UNSAFE_SIGN_NONSEGWIT) {
+        console.warn(
+          'Warning: Signing non-segwit inputs without the full parent transaction ' +
+            'means there is a chance that a miner could feed you incorrect information ' +
+            "to trick you into paying large fees. This behavior is the same as Psbt's predecesor " +
+            '(TransactionBuilder - now removed) when signing non-segwit scripts. You are not ' +
+            'able to export this Psbt with toBuffer|toBase64|toHex since it is not ' +
+            'BIP174 compliant.\n*********************\nPROCEED WITH CAUTION!\n' +
+            '*********************',
+        );
+      }
     hash = unsignedTx.hashForSignature(
       inputIndex,
       meaningfulScript,

diff --git a/ts_src/psbt.ts b/ts_src/psbt.ts
@@ -152,6 +152,7 @@ export class Psbt {
       // We will disable exporting the Psbt when unsafe sign is active.
       // because it is not BIP174 compliant.
       __UNSAFE_SIGN_NONSEGWIT: false,
+      __WARN_UNSAFE_SIGN_NONSEGWIT: true,
       __TX_FROM_BUFFER: buf =>
         (this.constructor as typeof Psbt).transactionFromBuffer(
           buf,
@@ -775,6 +776,7 @@ interface PsbtCache {
   __FEE?: bigint;
   __EXTRACTED_TX?: Transaction<bigint>;
   __UNSAFE_SIGN_NONSEGWIT: boolean;
+  __WARN_UNSAFE_SIGN_NONSEGWIT: boolean;
   __TX_FROM_BUFFER: (buf: Buffer) => Transaction<bigint>;
 }
 
@@ -1363,15 +1365,17 @@ function getHashForSig(
           `${meaningfulScript.toString('hex')}`,
       );
     if (!forValidate && cache.__UNSAFE_SIGN_NONSEGWIT !== false)
-      console.warn(
-        'Warning: Signing non-segwit inputs without the full parent transaction ' +
-          'means there is a chance that a miner could feed you incorrect information ' +
-          "to trick you into paying large fees. This behavior is the same as Psbt's predecesor " +
-          '(TransactionBuilder - now removed) when signing non-segwit scripts. You are not ' +
-          'able to export this Psbt with toBuffer|toBase64|toHex since it is not ' +
-          'BIP174 compliant.\n*********************\nPROCEED WITH CAUTION!\n' +
-          '*********************',
-      );
+      if (cache.__WARN_UNSAFE_SIGN_NONSEGWIT) {
+        console.warn(
+          'Warning: Signing non-segwit inputs without the full parent transaction ' +
+            'means there is a chance that a miner could feed you incorrect information ' +
+            "to trick you into paying large fees. This behavior is the same as Psbt's predecesor " +
+            '(TransactionBuilder - now removed) when signing non-segwit scripts. You are not ' +
+            'able to export this Psbt with toBuffer|toBase64|toHex since it is not ' +
+            'BIP174 compliant.\n*********************\nPROCEED WITH CAUTION!\n' +
+            '*********************',
+        );
+      }
     hash = unsignedTx.hashForSignature(
       inputIndex,
       meaningfulScript,