@caravan/psbt 1.0.0 → 1.1.0

package/dist/index.js

@@ -38,9 +38,8 @@ module.exports = __toCommonJS(src_exports);
 // ../../node_modules/esbuild-plugin-polyfill-node/polyfills/buffer.js
 var import_buffer = require("buffer");
 
-// src/psbtv2.ts
+// src/psbtv2/functions.ts
 var import_bufio = require("bufio");
-var import_bitcoinjs_lib2 = require("bitcoinjs-lib");
 var import_bitcoin3 = require("@caravan/bitcoin");
 
 // src/psbt.ts
@@ -51,10 +50,12 @@ var import_bitcoin2 = require("@caravan/bitcoin");
 var import_bignumber = __toESM(require("bignumber.js"));
 var PSBT_MAGIC_BYTES = import_buffer.Buffer.from([112, 115, 98, 116, 255]);
 
-// src/psbtv2.ts
+// src/psbtv2/values.ts
 var PSBT_MAP_SEPARATOR = import_buffer.Buffer.from([0]);
 var BIP_32_NODE_REGEX = /(\/[0-9]+'?)/gi;
 var BIP_32_HARDENING_OFFSET = 2147483648;
+
+// src/psbtv2/functions.ts
 function bufferize(psbt) {
   if (import_buffer.Buffer.isBuffer(psbt)) {
     return psbt;
@@ -131,8 +132,23 @@ function serializeMap(map, bw) {
   });
   bw.writeBytes(PSBT_MAP_SEPARATOR);
 }
+function getPsbtVersionNumber(psbt) {
+  const map = /* @__PURE__ */ new Map();
+  const buf = bufferize(psbt);
+  const br = new import_bufio.BufferReader(buf.slice(import_bitcoin3.PSBT_MAGIC_BYTES.length));
+  readAndSetKeyPairs(map, br);
+  return map.get("fb" /* PSBT_GLOBAL_VERSION */)?.readUInt32LE(0) || 0;
+}
+
+// src/psbtv2/psbtv2.ts
+var import_bufio3 = require("bufio");
+var import_bitcoinjs_lib2 = require("bitcoinjs-lib");
+
+// src/psbtv2/psbtv2maps.ts
+var import_bufio2 = require("bufio");
 var PsbtV2Maps = class {
-  // These maps directly correspond to the maps defined in BIP0174
+  // These maps directly correspond to the maps defined in BIP0174 and extended
+  // in BIP0370
   globalMap = /* @__PURE__ */ new Map();
   inputMaps = [];
   outputMaps = [];
@@ -141,7 +157,7 @@ var PsbtV2Maps = class {
       return;
     }
     const buf = bufferize(psbt);
-    const br = new import_bufio.BufferReader(buf);
+    const br = new import_bufio2.BufferReader(buf);
     if (!br.readBytes(PSBT_MAGIC_BYTES.length, true).equals(PSBT_MAGIC_BYTES)) {
       throw Error("PsbtV2 magic bytes are incorrect.");
     }
@@ -165,9 +181,11 @@ var PsbtV2Maps = class {
       this.outputMaps.push(map);
     }
   }
-  // Return the current state of the psbt as a string in the specified format.
+  /**
+   * Return the current state of the psbt as a string in the specified format.
+   */
   serialize(format = "base64") {
-    let bw = new import_bufio.BufferWriter();
+    const bw = new import_bufio2.BufferWriter();
     bw.writeBytes(PSBT_MAGIC_BYTES);
     serializeMap(this.globalMap, bw);
     for (const map of this.inputMaps) {
@@ -178,12 +196,15 @@ var PsbtV2Maps = class {
     }
     return bw.render().toString(format);
   }
-  // NOTE: This set of copy methods is made available to
-  // achieve parity with the PSBT api required by ledger-bitcoin
-  // for creating merklized PSBTs. HOWEVER, it is not recommended
-  // to use this when avoidable as copying maps bypasses the validation
-  // defined in the constructor, so it could create a psbtv2 in an invalid psbt status.
-  // PsbtV2.serialize is preferable whenever possible.
+  /**
+   * Copies the maps in this PsbtV2 object to another PsbtV2 object.
+   *
+   * NOTE: This copy method is made available to achieve parity with the PSBT
+   * api required by `ledger-bitcoin` for creating merklized PSBTs. HOWEVER, it
+   * is not recommended to use this when avoidable as copying maps bypasses the
+   * validation defined in the constructor, so it could create a psbtv2 in an
+   * invalid psbt state. PsbtV2.serialize is preferable whenever possible.
+   */
   copy(to) {
     this.copyMap(this.globalMap, to.globalMap);
     this.copyMaps(this.inputMaps, to.inputMaps);
@@ -196,11 +217,12 @@ var PsbtV2Maps = class {
       to[index] = to_index;
     });
   }
-  // eslint-disable-next-line class-methods-use-this
   copyMap(from, to) {
     from.forEach((v, k) => to.set(k, import_buffer.Buffer.from(v)));
   }
 };
+
+// src/psbtv2/psbtv2.ts
 var PsbtV2 = class _PsbtV2 extends PsbtV2Maps {
   constructor(psbt) {
     super(psbt);
@@ -213,7 +235,10 @@ var PsbtV2 = class _PsbtV2 extends PsbtV2Maps {
    * Globals Getters/Setters
    */
   get PSBT_GLOBAL_XPUB() {
-    return getNonUniqueKeyTypeValues(this.globalMap, "01" /* PSBT_GLOBAL_XPUB */);
+    return getNonUniqueKeyTypeValues(
+      this.globalMap,
+      "01" /* PSBT_GLOBAL_XPUB */
+    );
   }
   get PSBT_GLOBAL_TX_VERSION() {
     const val = this.globalMap.get("02" /* PSBT_GLOBAL_TX_VERSION */);
@@ -228,7 +253,7 @@ var PsbtV2 = class _PsbtV2 extends PsbtV2Maps {
         `PsbtV2 cannot have a global tx version less than 2. Version ${version} specified.`
       );
     }
-    const bw = new import_bufio.BufferWriter();
+    const bw = new import_bufio3.BufferWriter();
     bw.writeI32(version);
     this.globalMap.set("02" /* PSBT_GLOBAL_TX_VERSION */, bw.render());
   }
@@ -239,7 +264,7 @@ var PsbtV2 = class _PsbtV2 extends PsbtV2Maps {
     if (locktime === null) {
       this.globalMap.delete("03" /* PSBT_GLOBAL_FALLBACK_LOCKTIME */);
     } else {
-      const bw = new import_bufio.BufferWriter();
+      const bw = new import_bufio3.BufferWriter();
       bw.writeI32(locktime);
       this.globalMap.set("03" /* PSBT_GLOBAL_FALLBACK_LOCKTIME */, bw.render());
     }
@@ -252,7 +277,7 @@ var PsbtV2 = class _PsbtV2 extends PsbtV2Maps {
     return val.readUInt8(0);
   }
   set PSBT_GLOBAL_INPUT_COUNT(count) {
-    const bw = new import_bufio.BufferWriter();
+    const bw = new import_bufio3.BufferWriter();
     bw.writeU8(count);
     this.globalMap.set("04" /* PSBT_GLOBAL_INPUT_COUNT */, bw.render());
   }
@@ -264,7 +289,7 @@ var PsbtV2 = class _PsbtV2 extends PsbtV2Maps {
     return val.readUInt8(0);
   }
   set PSBT_GLOBAL_OUTPUT_COUNT(count) {
-    const bw = new import_bufio.BufferWriter();
+    const bw = new import_bufio3.BufferWriter();
     bw.writeU8(count);
     this.globalMap.set("05" /* PSBT_GLOBAL_OUTPUT_COUNT */, bw.render());
   }
@@ -293,7 +318,7 @@ var PsbtV2 = class _PsbtV2 extends PsbtV2Maps {
     if (modifiable.includes("SIGHASH_SINGLE" /* SIGHASH_SINGLE */)) {
       val |= 4;
     }
-    const br = new import_bufio.BufferWriter();
+    const br = new import_bufio3.BufferWriter();
     br.writeU8(val);
     this.globalMap.set("06" /* PSBT_GLOBAL_TX_MODIFIABLE */, br.render());
   }
@@ -313,7 +338,7 @@ var PsbtV2 = class _PsbtV2 extends PsbtV2Maps {
       );
       workingVersion = 2;
     }
-    const bw = new import_bufio.BufferWriter();
+    const bw = new import_bufio3.BufferWriter();
     bw.writeU32(workingVersion);
     this.globalMap.set("fb" /* PSBT_GLOBAL_VERSION */, bw.render());
   }
@@ -387,16 +412,28 @@ var PsbtV2 = class _PsbtV2 extends PsbtV2Maps {
     );
   }
   get PSBT_IN_RIPEMD160() {
-    return getNonUniqueKeyTypeValues(this.inputMaps, "0a" /* PSBT_IN_RIPEMD160 */);
+    return getNonUniqueKeyTypeValues(
+      this.inputMaps,
+      "0a" /* PSBT_IN_RIPEMD160 */
+    );
   }
   get PSBT_IN_SHA256() {
-    return getNonUniqueKeyTypeValues(this.inputMaps, "0b" /* PSBT_IN_SHA256 */);
+    return getNonUniqueKeyTypeValues(
+      this.inputMaps,
+      "0b" /* PSBT_IN_SHA256 */
+    );
   }
   get PSBT_IN_HASH160() {
-    return getNonUniqueKeyTypeValues(this.inputMaps, "0c" /* PSBT_IN_HASH160 */);
+    return getNonUniqueKeyTypeValues(
+      this.inputMaps,
+      "0c" /* PSBT_IN_HASH160 */
+    );
   }
   get PSBT_IN_HASH256() {
-    return getNonUniqueKeyTypeValues(this.inputMaps, "0d" /* PSBT_IN_HASH256 */);
+    return getNonUniqueKeyTypeValues(
+      this.inputMaps,
+      "0d" /* PSBT_IN_HASH256 */
+    );
   }
   get PSBT_IN_PREVIOUS_TXID() {
     const indices = [];
@@ -508,7 +545,7 @@ var PsbtV2 = class _PsbtV2 extends PsbtV2Maps {
       if (!value) {
         throw Error("PSBT_OUT_AMOUNT not set for an output");
       }
-      const br = new import_bufio.BufferReader(value);
+      const br = new import_bufio3.BufferReader(value);
       indices.push(br.readBigI64(value));
     }
     return indices;
@@ -548,9 +585,113 @@ var PsbtV2 = class _PsbtV2 extends PsbtV2Maps {
       "fc" /* PSBT_OUT_PROPRIETARY */
     );
   }
+  /**
+   * Operator Role Validation Getters
+   */
+  /**
+   * Returns true if the PsbtV2 is ready for an operator taking the Constructor
+   * role.
+   *
+   * This check assumes that the Creator used this class's constructor method to
+   * initialize the PsbtV2 without passing a psbt (constructor  defaults were
+   * set).
+   */
+  get isReadyForConstructor() {
+    if (this.PSBT_GLOBAL_FALLBACK_LOCKTIME === null) {
+      return false;
+    }
+    if (!this.isModifiable(["INPUTS" /* INPUTS */]) && !this.isModifiable(["OUTPUTS" /* OUTPUTS */])) {
+      return false;
+    }
+    return true;
+  }
+  /**
+   * Returns true if the PsbtV2 is ready for an operator taking the Updater
+   * role.
+   *
+   * Before signatures are added, but after an input is added, a PsbtV2 is
+   * likely to be ready for Constructor, ready for Updater, and ready for Signer
+   * simultaneously.
+   *
+   * According to BIP370, the Updater can modify the sequence number, but it is
+   * unclear if the Updater retains permissions provided in psbtv0 (BIP174). It
+   * is likely not the case that the Updater has the same permissions as
+   * previously because it seems to now be the realm of the Constructor to add
+   * inputs and outputs.
+   */
+  get isReadyForUpdater() {
+    if (this.PSBT_GLOBAL_INPUT_COUNT === 0) {
+      return false;
+    }
+    if (!this.isModifiable(["INPUTS" /* INPUTS */])) {
+      return false;
+    }
+    return true;
+  }
+  /**
+   * Returns true if the PsbtV2 is ready for an operator taking the Signer role.
+   */
+  get isReadyForSigner() {
+    if (this.PSBT_GLOBAL_INPUT_COUNT === 0) {
+      return false;
+    }
+    if (this.isReadyForTransactionExtractor) {
+      return false;
+    }
+    return true;
+  }
+  /**
+   * Returns true if the PsbtV2 is ready for an operator taking the Combiner
+   * role.
+   */
+  get isReadyForCombiner() {
+    return this.isReadyForConstructor || this.isReadyForUpdater || this.isReadyForSigner;
+  }
+  /**
+   * Unimplemented. Returns false.
+   */
+  get isReadyForInputFinalizer() {
+    console.warn(
+      "PsbtV2.isReadyForInputFinalizer has been called, however, this getter is unimplemented and shouldn't be used."
+    );
+    return false;
+  }
+  /**
+   * Returns true if the PsbtV2 is ready for an operator taking the Transaction
+   * Extractor role.
+   *
+   * If all the inputs have been finalized, then the psbt is ready for the
+   * Transaction Extractor. According to BIP 174, it's the responsibility of the
+   * Input Finalizer to add scriptSigs or scriptWitnesses and then remove other
+   * details besides the UTXO. This getter checks that the Input Finalizer has
+   * finished its job.
+   */
+  get isReadyForTransactionExtractor() {
+    for (let i = 0; i < this.PSBT_GLOBAL_INPUT_COUNT; i++) {
+      if (!this.PSBT_IN_FINAL_SCRIPTSIG[i] && !this.PSBT_IN_FINAL_SCRIPTWITNESS[i]) {
+        return false;
+      }
+      if (this.PSBT_IN_FINAL_SCRIPTSIG[i] && !this.PSBT_IN_NON_WITNESS_UTXO[i] || this.PSBT_IN_FINAL_SCRIPTWITNESS[i] && !this.PSBT_IN_WITNESS_UTXO[i]) {
+        return false;
+      }
+      if (
+        // Strings
+        this.PSBT_IN_REDEEM_SCRIPT[i] || this.PSBT_IN_WITNESS_SCRIPT[i] || this.PSBT_IN_POR_COMMITMENT[i] || this.PSBT_IN_TAP_KEY_SIG[i] || this.PSBT_IN_TAP_INTERNAL_KEY[i] || this.PSBT_IN_TAP_MERKLE_ROOT[i] || // Numbers
+        this.PSBT_IN_SIGHASH_TYPE[i] !== null || this.PSBT_IN_SEQUENCE[i] !== null || this.PSBT_IN_REQUIRED_TIME_LOCKTIME[i] !== null || this.PSBT_IN_REQUIRED_HEIGHT_LOCKTIME[i] !== null || // Arrays of non-unique keytype values
+        this.PSBT_IN_PARTIAL_SIG[i].filter((el) => el !== null).length > 0 || this.PSBT_IN_BIP32_DERIVATION[i].filter((el) => el !== null).length > 0 || this.PSBT_IN_RIPEMD160[i].filter((el) => el !== null).length > 0 || this.PSBT_IN_SHA256[i].filter((el) => el !== null).length > 0 || this.PSBT_IN_HASH160[i].filter((el) => el !== null).length > 0 || this.PSBT_IN_HASH256[i].filter((el) => el !== null).length > 0 || this.PSBT_IN_TAP_SCRIPT_SIG[i].filter((el) => el !== null).length > 0 || this.PSBT_IN_TAP_LEAF_SCRIPT[i].filter((el) => el !== null).length > 0 || this.PSBT_IN_TAP_BIP32_DERIVATION[i].filter((el) => el !== null).length > 0
+      ) {
+        return false;
+      }
+    }
+    return true;
+  }
   /**
    * Other Getters/Setters
    */
+  /**
+   * Returns the `nLockTime` field for the psbt as if it were a bitcoin
+   * transaction.
+   */
   get nLockTime() {
     const inputCount = this.PSBT_GLOBAL_INPUT_COUNT;
     const heightLocks = this.PSBT_IN_REQUIRED_HEIGHT_LOCKTIME;
@@ -579,20 +720,27 @@ var PsbtV2 = class _PsbtV2 extends PsbtV2Maps {
   /**
    * Creator/Constructor Methods
    */
-  // This method ensures that global fields have initial values required by a
-  // PsbtV2 Creator. It is called by the constructor if constructed without a
-  // psbt.
+  /**
+   * Ensures that global fields have initial values required by a PsbtV2
+   * Creator. It is called by the constructor if constructed without a psbt.
+   */
   create() {
     this.PSBT_GLOBAL_VERSION = 2;
     this.PSBT_GLOBAL_TX_VERSION = 2;
     this.PSBT_GLOBAL_INPUT_COUNT = 0;
     this.PSBT_GLOBAL_OUTPUT_COUNT = 0;
     this.PSBT_GLOBAL_FALLBACK_LOCKTIME = 0;
+    this.PSBT_GLOBAL_TX_MODIFIABLE = [
+      "INPUTS" /* INPUTS */,
+      "OUTPUTS" /* OUTPUTS */
+    ];
   }
-  // This method should check initial construction of any valid PsbtV2. It is
-  // called when a psbt is passed to the constructor or when a new psbt is being
-  // created. If constructed with a psbt, this method acts outside of the
-  // Creator role to validate the current state of the psbt.
+  /**
+   * Checks initial construction of any valid PsbtV2. It is called when a psbt
+   * is passed to the constructor or when a new psbt is being created. If
+   * constructed with a psbt, this method acts outside of the Creator role to
+   * validate the current state of the psbt.
+   */
   validate() {
     if (this.PSBT_GLOBAL_VERSION < 2) {
       throw Error("PsbtV2 has a version field set less than 2");
@@ -631,25 +779,32 @@ var PsbtV2 = class _PsbtV2 extends PsbtV2Maps {
       }
     }
   }
-  // This method is provided for compatibility issues and probably shouldn't be
-  // used since a PsbtV2 with PSBT_GLOBAL_TX_VERSION = 1 is BIP0370
-  // non-compliant. No guarantees can be made here that a serialized PsbtV2
-  // which used this method will be compatible with outside consumers.
-  //
-  // One may wish to instance this class from a partially signed
-  // PSBTv0 with a txn version 1 by using the static PsbtV2.FromV0. This method
-  // provides a way to override validation logic for the txn version and roles
-  // lifecycle defined for PsbtV2.
+  /**
+   * This method is provided for compatibility issues and probably shouldn't be
+   * used since a PsbtV2 with PSBT_GLOBAL_TX_VERSION = 1 is BIP0370
+   * non-compliant. No guarantees can be made here that a serialized PsbtV2
+   * which used this method will be compatible with outside consumers.
+   *
+   * One may wish to instance this class from a partially signed PSBTv0 with a
+   * txn version 1 by using the static PsbtV2.FromV0. This method provides a way
+   * to override validation logic for the txn version and roles lifecycle
+   * defined for PsbtV2.
+   */
   dangerouslySetGlobalTxVersion1() {
+    if (!this.isReadyForConstructor) {
+      throw Error(
+        "The PsbtV2 is not ready for a Constructor. The PSBT_GLOBAL_TX_VERSION should not be forced to version 1."
+      );
+    }
     console.warn("Dangerously setting PsbtV2.PSBT_GLOBAL_TX_VERSION to 1!");
-    const bw = new import_bufio.BufferWriter();
+    const bw = new import_bufio3.BufferWriter();
     bw.writeI32(1);
     this.globalMap.set("02" /* PSBT_GLOBAL_TX_VERSION */, bw.render());
   }
-  // Is this a Creator/Constructor role action, or something else. BIPs don't
+  // Is this a Creator/Constructor role action, or something else? BIPs don't
   // define it well.
   addGlobalXpub(xpub, fingerprint, path) {
-    const bw = new import_bufio.BufferWriter();
+    const bw = new import_bufio3.BufferWriter();
     bw.writeBytes(import_buffer.Buffer.from("01" /* PSBT_GLOBAL_XPUB */, "hex"));
     bw.writeBytes(xpub);
     const key = bw.render().toString("hex");
@@ -669,13 +824,18 @@ var PsbtV2 = class _PsbtV2 extends PsbtV2Maps {
     witnessScript,
     bip32Derivation
   }) {
+    if (!this.isReadyForConstructor) {
+      throw Error(
+        "The PsbtV2 is not ready for a Constructor. Inputs cannot be added."
+      );
+    }
     if (!this.isModifiable(["INPUTS" /* INPUTS */])) {
       throw Error(
         "PsbtV2.PSBT_GLOBAL_TX_MODIFIABLE inputs cannot be modified."
       );
     }
     const map = /* @__PURE__ */ new Map();
-    const bw = new import_bufio.BufferWriter();
+    const bw = new import_bufio3.BufferWriter();
     const prevTxIdBuf = bufferize(previousTxId);
     bw.writeBytes(prevTxIdBuf);
     map.set("0e" /* PSBT_IN_PREVIOUS_TXID */, bw.render());
@@ -722,13 +882,18 @@ var PsbtV2 = class _PsbtV2 extends PsbtV2Maps {
     witnessScript,
     bip32Derivation
   }) {
+    if (!this.isReadyForConstructor) {
+      throw Error(
+        "The PsbtV2 is not ready for a Constructor. Outputs cannot be added."
+      );
+    }
     if (!this.isModifiable(["OUTPUTS" /* OUTPUTS */])) {
       throw Error(
         "PsbtV2.PSBT_GLOBAL_TX_MODIFIABLE outputs cannot be modified."
       );
     }
     const map = /* @__PURE__ */ new Map();
-    const bw = new import_bufio.BufferWriter();
+    const bw = new import_bufio3.BufferWriter();
     bw.writeI64(amount);
     map.set("03" /* PSBT_OUT_AMOUNT */, bw.render());
     bw.writeBytes(script);
@@ -757,8 +922,15 @@ var PsbtV2 = class _PsbtV2 extends PsbtV2Maps {
   /**
    * Updater/Signer Methods
    */
-  // Removes an input-map from inputMaps
+  /**
+   * Removes an input-map from inputMaps.
+   */
   deleteInput(index) {
+    if (!this.isReadyForConstructor) {
+      throw Error(
+        "The PsbtV2 is not ready for a Constructor. Inputs cannot be removed."
+      );
+    }
     if (!this.isModifiable(["INPUTS" /* INPUTS */])) {
       throw Error(
         "PsbtV2.PSBT_GLOBAL_TX_MODIFIABLE inputs cannot be modified."
@@ -768,8 +940,15 @@ var PsbtV2 = class _PsbtV2 extends PsbtV2Maps {
     this.inputMaps = newInputs;
     this.PSBT_GLOBAL_INPUT_COUNT = this.inputMaps.length;
   }
-  // Removes an output-map from outputMaps
+  /**
+   * Removes an output-map from outputMaps.
+   */
   deleteOutput(index) {
+    if (!this.isReadyForConstructor) {
+      throw Error(
+        "The PsbtV2 is not ready for a Constructor. Outputs cannot be removed."
+      );
+    }
     if (!this.isModifiable(["OUTPUTS" /* OUTPUTS */])) {
       throw Error(
         "PsbtV2.PSBT_GLOBAL_TX_MODIFIABLE outputs cannot be modified."
@@ -782,7 +961,9 @@ var PsbtV2 = class _PsbtV2 extends PsbtV2Maps {
     this.outputMaps = newOutputs;
     this.PSBT_GLOBAL_OUTPUT_COUNT = this.outputMaps.length;
   }
-  // Checks that provided flags are present in PSBT_GLOBAL_TX_MODIFIABLE.
+  /**
+   * Checks that all provided flags are present in PSBT_GLOBAL_TX_MODIFIABLE.
+   */
   isModifiable(flags) {
     for (const flag of flags) {
       if (!this.PSBT_GLOBAL_TX_MODIFIABLE.includes(flag)) {
@@ -791,13 +972,25 @@ var PsbtV2 = class _PsbtV2 extends PsbtV2Maps {
     }
     return true;
   }
-  // The Signer, when it creates a signature, must add the partial sig keypair
-  // to the psbt for the input which it is signing. In the case that a
-  // particular signer does not, this method can be used to add a signature to
-  // the psbt. This method assumes the Signer did the validation outlined in
-  // BIP0174 before creating a signature.
-  // https://github.com/bitcoin/bips/blob/master/bip-0174.mediawiki#signer
+  /**
+   * Adds a signature for an input. Validates that the input is mapped and does
+   * not already have a signature for the pubkey. Also validates for sighash.
+   * Other validation is incomplete. Also validates for required args in case
+   * typescript is not being used to call the method.
+   *
+   * The Signer, when it creates a signature, must add the partial sig keypair
+   * to the psbt for the input which it is signing. In the case that a
+   * particular signer does not, this method can be used to add a signature to
+   * the psbt. This method assumes the Signer did the validation outlined in
+   * BIP0174 before creating a signature.
+   * https://github.com/bitcoin/bips/blob/master/bip-0174.mediawiki#signer
+   */
   addPartialSig(inputIndex, pubkey, sig) {
+    if (!this.isReadyForSigner) {
+      throw Error(
+        "The PsbtV2 is not ready for a Signer. Partial sigs cannot be added."
+      );
+    }
     if (!this.inputMaps[inputIndex]) {
       throw Error(`PsbtV2 has no input at ${inputIndex}`);
     }
@@ -822,7 +1015,11 @@ var PsbtV2 = class _PsbtV2 extends PsbtV2Maps {
       this.PSBT_GLOBAL_TX_MODIFIABLE = modBackup;
     }
   }
-  // Removes all sigs for an input unless a pubkey is specified.
+  /**
+   * Removes all sigs for an input unless a pubkey is specified. Validates that
+   * the input exists. When providing a pubkey, this validates that a sig for
+   * the pubkey exists.
+   */
   removePartialSig(inputIndex, pubkey) {
     const input = this.inputMaps[inputIndex];
     if (!input) {
@@ -846,11 +1043,12 @@ var PsbtV2 = class _PsbtV2 extends PsbtV2Maps {
       }
     }
   }
-  // Used to ensure the PSBT is in the proper state when adding a partial sig
-  // keypair.
-  // https://github.com/bitcoin/bips/blob/master/bip-0370.mediawiki#signer
+  /**
+   * Ensures the PSBT is in the proper state when adding a partial sig keypair.
+   * https://github.com/bitcoin/bips/blob/master/bip-0370.mediawiki#signer
+   */
   handleSighashType(sig) {
-    const br = new import_bufio.BufferReader(sig.slice(-1));
+    const br = new import_bufio3.BufferReader(sig.slice(-1));
     let sighashVal = br.readU8();
     let modifiable = this.PSBT_GLOBAL_TX_MODIFIABLE;
     if (!(sighashVal & 128 /* SIGHASH_ANYONECANPAY */)) {
@@ -870,16 +1068,18 @@ var PsbtV2 = class _PsbtV2 extends PsbtV2Maps {
     }
     this.PSBT_GLOBAL_TX_MODIFIABLE = modifiable;
   }
-  // Attempt to return a PsbtV2 by converting from a PsbtV0 string or Buffer
+  /**
+   * Attempts to return a PsbtV2 by converting from a PsbtV0 string or Buffer.
+   *
+   * This method first starts with a fresh PsbtV2 having just been created. It
+   * then takes the PsbtV2 through its operator saga through the Signer role. In
+   * this sense validation for each operator role will be performed.
+   */
   static FromV0(psbt, allowTxnVersion1 = false) {
     const psbtv0Buf = bufferize(psbt);
     const psbtv0 = import_bitcoinjs_lib2.Psbt.fromBuffer(psbtv0Buf);
     const psbtv0GlobalMap = psbtv0.data.globalMap;
     const psbtv2 = new _PsbtV2();
-    psbtv2.PSBT_GLOBAL_TX_MODIFIABLE = [
-      "INPUTS" /* INPUTS */,
-      "OUTPUTS" /* OUTPUTS */
-    ];
     const txVersion = psbtv0.data.getTransaction().readInt32LE(0);
     if (txVersion === 1 && allowTxnVersion1) {
       psbtv2.dangerouslySetGlobalTxVersion1();
@@ -893,7 +1093,7 @@ var PsbtV2 = class _PsbtV2 extends PsbtV2Maps {
         globalXpub.path
       );
     }
-    let txInputs = [];
+    const txInputs = [];
     for (const [index, txInput] of psbtv0.txInputs.entries()) {
       txInputs[index] = txInput;
     }
@@ -913,7 +1113,7 @@ var PsbtV2 = class _PsbtV2 extends PsbtV2Maps {
         bip32Derivation: input.bip32Derivation
       });
     }
-    let txOutputs = [];
+    const txOutputs = [];
     for (const [index, txOutput] of psbtv0.txOutputs.entries()) {
       txOutputs[index] = txOutput;
     }
@@ -935,13 +1135,6 @@ var PsbtV2 = class _PsbtV2 extends PsbtV2Maps {
     return psbtv2;
   }
 };
-function getPsbtVersionNumber(psbt) {
-  const map = /* @__PURE__ */ new Map();
-  const buf = bufferize(psbt);
-  const br = new import_bufio.BufferReader(buf.slice(PSBT_MAGIC_BYTES.length));
-  readAndSetKeyPairs(map, br);
-  return map.get("fb" /* PSBT_GLOBAL_VERSION */)?.readUInt32LE(0) || 0;
-}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   PsbtV2,