@caravan/psbt 1.7.1 → 1.9.0

package/dist/index.d.ts

@@ -77,12 +77,19 @@ declare abstract class PsbtV2Maps {
  * BIP-defined keytypes. Very few setters and modifier methods exist. As they
  * are added, they should enforce implied and documented rules and limitations.
  *
- * Defining BIPs:
- * https://github.com/bitcoin/bips/blob/master/bip-0174.mediawiki
+ * allowTxnVersion1: A Note
+ * A psbtv2 must have its transaction version GTE 2 to be bip370 compliant. If
+ * this class is instantiated with allowTxnVersion1 set to `true`, then a psbtv2
+ * which has had its txn version forceably set to 1 (for example with
+ * PsbtV2.dangerouslySetGlobalTxVersion1) can be instantiated. This has,
+ * possibly dangerous implications concerning how the locktime might be
+ * interpreted.
+ *
+ * Defining BIPs: https://github.com/bitcoin/bips/blob/master/bip-0174.mediawiki
  * https://github.com/bitcoin/bips/blob/master/bip-0370.mediawiki
  */
 declare class PsbtV2 extends PsbtV2Maps {
-    constructor(psbt?: Buffer | string);
+    constructor(psbt?: Buffer | string, allowTxnVersion1?: boolean);
     /**
      * Globals Getters/Setters
      */

package/dist/index.js

@@ -363,12 +363,12 @@ var PsbtConversionMaps = class extends PsbtV2Maps {
 
 // src/psbtv2/psbtv2.ts
 var PsbtV2 = class _PsbtV2 extends PsbtV2Maps {
-  constructor(psbt) {
+  constructor(psbt, allowTxnVersion1 = false) {
     super(psbt);
     if (!psbt) {
       this.create();
     }
-    this.validate();
+    this.validate(allowTxnVersion1);
   }
   /**
    * Globals Getters/Setters
@@ -736,9 +736,6 @@ var PsbtV2 = class _PsbtV2 extends PsbtV2Maps {
    * set).
    */
   get isReadyForConstructor() {
-    if (this.PSBT_GLOBAL_FALLBACK_LOCKTIME === null) {
-      return false;
-    }
     if (!this.isModifiable(["INPUTS" /* INPUTS */]) && !this.isModifiable(["OUTPUTS" /* OUTPUTS */])) {
       return false;
     }
@@ -880,12 +877,14 @@ var PsbtV2 = class _PsbtV2 extends PsbtV2Maps {
    * constructed with a psbt, this method acts outside of the Creator role to
    * validate the current state of the psbt.
    */
-  validate() {
+  validate(allowTxnVersion1) {
     if (this.PSBT_GLOBAL_VERSION < 2) {
       throw Error("PsbtV2 has a version field set less than 2");
     }
-    if (this.PSBT_GLOBAL_TX_VERSION < 2) {
+    if (!allowTxnVersion1 && this.PSBT_GLOBAL_TX_VERSION < 2) {
       throw Error("PsbtV2 has a tx version field set less than 2");
+    } else if (allowTxnVersion1 && this.PSBT_GLOBAL_TX_VERSION < 2) {
+      console.warn("Dangerously setting PsbtV2.PSBT_GLOBAL_TX_VERSION to 1!");
     }
     for (const prevInTxid of this.PSBT_IN_PREVIOUS_TXID) {
       if (!prevInTxid) {
@@ -898,7 +897,7 @@ var PsbtV2 = class _PsbtV2 extends PsbtV2Maps {
       }
     }
     for (const amount of this.PSBT_OUT_AMOUNT) {
-      if (!amount) {
+      if (amount === void 0 || amount === null) {
         throw Error("PsbtV2 input is missing PSBT_OUT_AMOUNT");
       }
     }

package/dist/index.mjs

@@ -322,12 +322,12 @@ var PsbtConversionMaps = class extends PsbtV2Maps {
 
 // src/psbtv2/psbtv2.ts
 var PsbtV2 = class _PsbtV2 extends PsbtV2Maps {
-  constructor(psbt) {
+  constructor(psbt, allowTxnVersion1 = false) {
     super(psbt);
     if (!psbt) {
       this.create();
     }
-    this.validate();
+    this.validate(allowTxnVersion1);
   }
   /**
    * Globals Getters/Setters
@@ -695,9 +695,6 @@ var PsbtV2 = class _PsbtV2 extends PsbtV2Maps {
    * set).
    */
   get isReadyForConstructor() {
-    if (this.PSBT_GLOBAL_FALLBACK_LOCKTIME === null) {
-      return false;
-    }
     if (!this.isModifiable(["INPUTS" /* INPUTS */]) && !this.isModifiable(["OUTPUTS" /* OUTPUTS */])) {
       return false;
     }
@@ -839,12 +836,14 @@ var PsbtV2 = class _PsbtV2 extends PsbtV2Maps {
    * constructed with a psbt, this method acts outside of the Creator role to
    * validate the current state of the psbt.
    */
-  validate() {
+  validate(allowTxnVersion1) {
     if (this.PSBT_GLOBAL_VERSION < 2) {
       throw Error("PsbtV2 has a version field set less than 2");
     }
-    if (this.PSBT_GLOBAL_TX_VERSION < 2) {
+    if (!allowTxnVersion1 && this.PSBT_GLOBAL_TX_VERSION < 2) {
       throw Error("PsbtV2 has a tx version field set less than 2");
+    } else if (allowTxnVersion1 && this.PSBT_GLOBAL_TX_VERSION < 2) {
+      console.warn("Dangerously setting PsbtV2.PSBT_GLOBAL_TX_VERSION to 1!");
     }
     for (const prevInTxid of this.PSBT_IN_PREVIOUS_TXID) {
       if (!prevInTxid) {
@@ -857,7 +856,7 @@ var PsbtV2 = class _PsbtV2 extends PsbtV2Maps {
       }
     }
     for (const amount of this.PSBT_OUT_AMOUNT) {
-      if (!amount) {
+      if (amount === void 0 || amount === null) {
         throw Error("PsbtV2 input is missing PSBT_OUT_AMOUNT");
       }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caravan/psbt",
-  "version": "1.7.1",
+  "version": "1.9.0",
   "description": "typescript library for working with PSBTs",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",