@caravan/psbt 1.0.1 → 1.2.0

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @caravan/psbt@1.0.1 build
+> @caravan/psbt@1.2.0 build
 > tsup src/index.ts --format cjs,esm --dts
 
 CLI Building entry: src/index.ts
@@ -9,11 +9,11 @@
 CLI Target: esnext
 CJS Build start
 ESM Build start
-ESM dist/index.mjs 29.75 KB
-ESM ⚡️ Build success in 38ms
-CJS dist/index.js 31.42 KB
-CJS ⚡️ Build success in 38ms
+ESM dist/index.mjs 37.44 KB
+ESM ⚡️ Build success in 58ms
+CJS dist/index.js 39.13 KB
+CJS ⚡️ Build success in 58ms
 DTS Build start
-DTS ⚡️ Build success in 2270ms
-DTS dist/index.d.ts  9.90 KB
-DTS dist/index.d.mts 9.90 KB
+DTS ⚡️ Build success in 2355ms
+DTS dist/index.d.ts  13.38 KB
+DTS dist/index.d.mts 13.38 KB

package/.turbo/turbo-lint.log

@@ -1,5 +1,5 @@
 
-> @caravan/psbt@1.0.1 lint
+> @caravan/psbt@1.2.0 lint
 > eslint src
 
 
@@ -12,19 +12,31 @@
   430:13  warning  'signature' is never reassigned. Use 'const' instead  prefer-const
 
 /home/runner/work/caravan/caravan/packages/caravan-psbt/src/psbtv2/psbtv2.test.ts
-  1025:42  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
-  1025:53  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
-  1082:45  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
-  1082:56  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
+   915:14  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
+   919:14  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
+   928:14  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
+   932:14  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
+   940:14  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
+   945:14  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
+   953:14  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
+  1169:42  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
+  1169:53  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
+  1231:45  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
+  1231:56  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
+  1450:19  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
+  1456:21  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
+  1457:21  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
+  1467:23  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
+  1479:29  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
+  1491:24  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
+  1503:30  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
 
 /home/runner/work/caravan/caravan/packages/caravan-psbt/src/psbtv2/psbtv2.ts
-  129:9   warning  'modifiable' is never reassigned. Use 'const' instead  prefer-const
-  476:9   warning  'heights' is never reassigned. Use 'const' instead     prefer-const
-  477:9   warning  'times' is never reassigned. Use 'const' instead       prefer-const
-  945:9   warning  'txInputs' is never reassigned. Use 'const' instead    prefer-const
-  945:19  warning  Unexpected any. Specify a different type               @typescript-eslint/no-explicit-any
-  967:9   warning  'txOutputs' is never reassigned. Use 'const' instead   prefer-const
-  967:20  warning  Unexpected any. Specify a different type               @typescript-eslint/no-explicit-any
+   133:9   warning  'modifiable' is never reassigned. Use 'const' instead  prefer-const
+   677:9   warning  'heights' is never reassigned. Use 'const' instead     prefer-const
+   678:9   warning  'times' is never reassigned. Use 'const' instead       prefer-const
+  1256:21  warning  Unexpected any. Specify a different type               @typescript-eslint/no-explicit-any
+  1278:22  warning  Unexpected any. Specify a different type               @typescript-eslint/no-explicit-any
 
 /home/runner/work/caravan/caravan/packages/caravan-psbt/src/psbtv2/types.ts
   32:3  warning  Duplicate enum member value 01  @typescript-eslint/no-duplicate-enum-values
@@ -44,6 +56,6 @@
   65:3  warning  Duplicate enum member value 07  @typescript-eslint/no-duplicate-enum-values
   66:3  warning  Duplicate enum member value fc  @typescript-eslint/no-duplicate-enum-values
 
-✖ 33 problems (0 errors, 33 warnings)
-  0 errors and 9 warnings potentially fixable with the `--fix` option.
+✖ 45 problems (0 errors, 45 warnings)
+  0 errors and 7 warnings potentially fixable with the `--fix` option.
 

package/.turbo/turbo-test.log

@@ -1,5 +1,5 @@
 
-> @caravan/psbt@1.0.1 test
+> @caravan/psbt@1.2.0 test
 > jest src
 
 PASS src/psbt.test.ts
@@ -9,62 +9,62 @@ PASS src/psbtv2/psbtv2.test.ts
     console.warn
       Dangerously setting PsbtV2.PSBT_GLOBAL_TX_VERSION to 1!
 
-      592 |    */
-      593 |   public dangerouslySetGlobalTxVersion1() {
-    > 594 |     console.warn("Dangerously setting PsbtV2.PSBT_GLOBAL_TX_VERSION to 1!");
+      806 |       );
+      807 |     }
+    > 808 |     console.warn("Dangerously setting PsbtV2.PSBT_GLOBAL_TX_VERSION to 1!");
           |             ^
-      595 |     const bw = new BufferWriter();
-      596 |     bw.writeI32(1);
-      597 |     this.globalMap.set(KeyType.PSBT_GLOBAL_TX_VERSION, bw.render());
+      809 |     const bw = new BufferWriter();
+      810 |     bw.writeI32(1);
+      811 |     this.globalMap.set(KeyType.PSBT_GLOBAL_TX_VERSION, bw.render());
 
-      at PsbtV2.dangerouslySetGlobalTxVersion1 (src/psbtv2/psbtv2.ts:594:13)
-      at Function.FromV0 (src/psbtv2/psbtv2.ts:928:14)
-      at t (src/psbtv2/psbtv2.test.ts:947:34)
+      at PsbtV2.dangerouslySetGlobalTxVersion1 (src/psbtv2/psbtv2.ts:808:13)
+      at Function.FromV0 (src/psbtv2/psbtv2.ts:1240:14)
+      at t (src/psbtv2/psbtv2.test.ts:1091:34)
       at Object.<anonymous> (../../node_modules/expect/build/toThrowMatchers.js:74:11)
       at Object.throwingMatcher [as toThrow] (../../node_modules/expect/build/index.js:320:21)
-      at src/psbtv2/psbtv2.test.ts:948:25
+      at src/psbtv2/psbtv2.test.ts:1092:25
 
     console.warn
       Dangerously setting PsbtV2.PSBT_GLOBAL_TX_VERSION to 1!
 
-      592 |    */
-      593 |   public dangerouslySetGlobalTxVersion1() {
-    > 594 |     console.warn("Dangerously setting PsbtV2.PSBT_GLOBAL_TX_VERSION to 1!");
+      806 |       );
+      807 |     }
+    > 808 |     console.warn("Dangerously setting PsbtV2.PSBT_GLOBAL_TX_VERSION to 1!");
           |             ^
-      595 |     const bw = new BufferWriter();
-      596 |     bw.writeI32(1);
-      597 |     this.globalMap.set(KeyType.PSBT_GLOBAL_TX_VERSION, bw.render());
+      809 |     const bw = new BufferWriter();
+      810 |     bw.writeI32(1);
+      811 |     this.globalMap.set(KeyType.PSBT_GLOBAL_TX_VERSION, bw.render());
 
-      at PsbtV2.dangerouslySetGlobalTxVersion1 (src/psbtv2/psbtv2.ts:594:13)
-      at Function.FromV0 (src/psbtv2/psbtv2.ts:928:14)
-      at t (src/psbtv2/psbtv2.test.ts:947:34)
+      at PsbtV2.dangerouslySetGlobalTxVersion1 (src/psbtv2/psbtv2.ts:808:13)
+      at Function.FromV0 (src/psbtv2/psbtv2.ts:1240:14)
+      at t (src/psbtv2/psbtv2.test.ts:1091:34)
       at Object.<anonymous> (../../node_modules/expect/build/toThrowMatchers.js:74:11)
       at Object.throwingMatcher [as toThrow] (../../node_modules/expect/build/index.js:320:21)
-      at src/psbtv2/psbtv2.test.ts:948:25
+      at src/psbtv2/psbtv2.test.ts:1092:25
 
     console.warn
       Dangerously setting PsbtV2.PSBT_GLOBAL_TX_VERSION to 1!
 
-      592 |    */
-      593 |   public dangerouslySetGlobalTxVersion1() {
-    > 594 |     console.warn("Dangerously setting PsbtV2.PSBT_GLOBAL_TX_VERSION to 1!");
+      806 |       );
+      807 |     }
+    > 808 |     console.warn("Dangerously setting PsbtV2.PSBT_GLOBAL_TX_VERSION to 1!");
           |             ^
-      595 |     const bw = new BufferWriter();
-      596 |     bw.writeI32(1);
-      597 |     this.globalMap.set(KeyType.PSBT_GLOBAL_TX_VERSION, bw.render());
+      809 |     const bw = new BufferWriter();
+      810 |     bw.writeI32(1);
+      811 |     this.globalMap.set(KeyType.PSBT_GLOBAL_TX_VERSION, bw.render());
 
-      at PsbtV2.dangerouslySetGlobalTxVersion1 (src/psbtv2/psbtv2.ts:594:13)
-      at Function.FromV0 (src/psbtv2/psbtv2.ts:928:14)
-      at src/psbtv2/psbtv2.test.ts:959:25
+      at PsbtV2.dangerouslySetGlobalTxVersion1 (src/psbtv2/psbtv2.ts:808:13)
+      at Function.FromV0 (src/psbtv2/psbtv2.ts:1240:14)
+      at src/psbtv2/psbtv2.test.ts:1103:25
 
     console.error
       Error: 
-          at PsbtV2.<anonymous> (/home/runner/work/caravan/caravan/packages/caravan-psbt/src/psbtv2/psbtv2.test.ts:1044:13)
+          at PsbtV2.<anonymous> (/home/runner/work/caravan/caravan/packages/caravan-psbt/src/psbtv2/psbtv2.test.ts:1193:13)
           at /home/runner/work/caravan/caravan/node_modules/jest-mock/build/index.js:397:39
           at PsbtV2.<anonymous> (/home/runner/work/caravan/caravan/node_modules/jest-mock/build/index.js:404:13)
           at PsbtV2.mockConstructor [as handleSighashType] (/home/runner/work/caravan/caravan/node_modules/jest-mock/build/index.js:148:19)
-          at PsbtV2.addPartialSig (/home/runner/work/caravan/caravan/packages/caravan-psbt/src/psbtv2/psbtv2.ts:833:12)
-          at Object.<anonymous> (/home/runner/work/caravan/caravan/packages/caravan-psbt/src/psbtv2/psbtv2.test.ts:1049:10)
+          at PsbtV2.addPartialSig (/home/runner/work/caravan/caravan/packages/caravan-psbt/src/psbtv2/psbtv2.ts:1078:12)
+          at Object.<anonymous> (/home/runner/work/caravan/caravan/packages/caravan-psbt/src/psbtv2/psbtv2.test.ts:1198:10)
           at Promise.then.completed (/home/runner/work/caravan/caravan/node_modules/jest-circus/build/utils.js:298:28)
           at new Promise (<anonymous>)
           at callAsyncCircusFn (/home/runner/work/caravan/caravan/node_modules/jest-circus/build/utils.js:231:10)
@@ -80,20 +80,20 @@ PASS src/psbtv2/psbtv2.test.ts
           at runTest (/home/runner/work/caravan/caravan/node_modules/jest-runner/build/runTest.js:444:34)
           at Object.worker (/home/runner/work/caravan/caravan/node_modules/jest-runner/build/testWorker.js:106:12)
 
-      833 |       this.handleSighashType(sig);
-      834 |     } catch (err) {
-    > 835 |       console.error(err);
-          |               ^
-      836 |       // To remain atomic, attempt to reset everything to the way it was.
-      837 |       this.inputMaps[inputIndex].delete(key);
-      838 |       this.PSBT_GLOBAL_TX_MODIFIABLE = modBackup;
+      1078 |       this.handleSighashType(sig);
+      1079 |     } catch (err) {
+    > 1080 |       console.error(err);
+           |               ^
+      1081 |       // To remain atomic, attempt to reset everything to the way it was.
+      1082 |       this.inputMaps[inputIndex].delete(key);
+      1083 |       this.PSBT_GLOBAL_TX_MODIFIABLE = modBackup;
 
-      at PsbtV2.addPartialSig (src/psbtv2/psbtv2.ts:835:15)
-      at Object.<anonymous> (src/psbtv2/psbtv2.test.ts:1049:10)
+      at PsbtV2.addPartialSig (src/psbtv2/psbtv2.ts:1080:15)
+      at Object.<anonymous> (src/psbtv2/psbtv2.test.ts:1198:10)
 
 
 Test Suites: 2 passed, 2 total
-Tests:       177 passed, 177 total
+Tests:       197 passed, 197 total
 Snapshots:   0 total
-Time:        5.102 s
+Time:        5.325 s
 Ran all test suites matching /src/i.

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @caravan/psbt
 
+## 1.2.0
+
+### Minor Changes
+
+- [#73](https://github.com/caravan-bitcoin/caravan/pull/73) [`c58f786`](https://github.com/caravan-bitcoin/caravan/commit/c58f786c3409795e12a17a4fe9a3ff4fbf7c6517) Thanks [@Shadouts](https://github.com/Shadouts)! - PsbtV2 public setProprietaryValue allows for proprietary value mapping on the psbt.
+
+## 1.1.0
+
+### Minor Changes
+
+- [#65](https://github.com/caravan-bitcoin/caravan/pull/65) [`514b72f`](https://github.com/caravan-bitcoin/caravan/commit/514b72fe071ee39db833d4d6b6c4a95df288008e) Thanks [@Shadouts](https://github.com/Shadouts)! - PsbtV2 operator role validation getters are added to provide a way for validating role readiness. These getters are used in some Constructor and Signer methods. For example, an error will be thrown if `addPartialSig` is called when the PsbtV2 is not ready for a Signer.
+
 ## 1.0.1
 
 ### Patch Changes

package/README.md

@@ -19,6 +19,12 @@ A set of utilities for working with PSBTs.
 - [PSBTv2](#psbtv2)
   - [Exports](#psbtv2-exports)
     - [`class PsbtV2`](#class-psbtv2)
+      - [`get isReadyForConstructor`](#get-isreadyforconstructor)
+      - [`get isReadyForUpdater`](#get-isreadyforupdater)
+      - [`get isReadyForSigner`](#get-isreadyforsigner)
+      - [`get isReadyForCombiner`](#get-isreadyforcombiner)
+      - [`get isReadyForInputFinalizer`](#get-isreadyforinputfinalizer)
+      - [`get isReadyForTransactionExtractor`](#get-isreadyfortransactionextractor)
       - [`get nLockTime`](#get-nlocktime)
       - [`public dangerouslySetGlobalTxVersion1`](#public-dangerouslysetglobaltxversion1)
       - [`public addGlobalXpub`](#public-addglobalxpub)
@@ -28,10 +34,9 @@ A set of utilities for working with PSBTs.
       - [`public deleteOutput`](#public-deleteoutput)
       - [`public addPartialSig`](#public-addpartialsig)
       - [`public removePartialSig`](#public-removepartialsig)
+      - [`public setProprietaryValue`](#public-setproprietaryvalue)
       - [`static PsbtV2.FromV0`](#static-psbtv2fromv0)
     - [`function getPsbtVersionNumber`](#function-getpsbtversionnumber)
-    - [`abstract class PsbtV2Maps`](#abstract-class-psbtv2maps)
-      - [`public copy`](#public-copy)
 - [Concepts](#concepts)
   - [The operator role saga](#the-operator-role-saga)
 - [TODO](#todo)
@@ -104,6 +109,56 @@ An object class representing a PSBTv2 and its current state. While not yet compl
 
 Getters and setters are provided for the keytypes defined in [BIP 174](https://github.com/bitcoin/bips/blob/master/bip-0174.mediawiki) and [BIP 370](https://github.com/bitcoin/bips/blob/master/bip-0370.mediawiki). These getters/setters are named after the keytype in ALL_CAPS_SNAKE like `PsbtV2.PSBT_GLOBAL_VERSION`. Additional getters/setters may be listed in the following API documentation.
 
+##### `get isReadyForConstructor`
+
+A getter to check readiness for an operator role. Operator roles are defined in [BIP 174](https://github.com/bitcoin/bips/blob/master/bip-0174.mediawiki#user-content-Roles) and [BIP 370](https://github.com/bitcoin/bips/blob/master/bip-0370.mediawiki#user-content-Roles).
+
+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 isReadyForUpdater`
+
+A getter to check readiness for an operator role. Operator roles are defined in [BIP 174](https://github.com/bitcoin/bips/blob/master/bip-0174.mediawiki#user-content-Roles) and [BIP 370](https://github.com/bitcoin/bips/blob/master/bip-0370.mediawiki#user-content-Roles).
+
+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 isReadyForSigner`
+
+A getter to check readiness for an operator role. Operator roles are defined in [BIP 174](https://github.com/bitcoin/bips/blob/master/bip-0174.mediawiki#user-content-Roles) and [BIP 370](https://github.com/bitcoin/bips/blob/master/bip-0370.mediawiki#user-content-Roles).
+
+Returns `true` if the PsbtV2 is ready for an operator taking the Signer role.
+
+Right now, this method only checks for two things: There is an input for signing and `this.isReadyForTransactionExtractor === false`. The point of the latter is to check that the PsbtV2 has not been finalized.
+
+A future improvement to this method might be to more thoroughly check inputs to determine if the PsbtV2 does or does not need to collect more signatures.
+
+##### `get isReadyForCombiner`
+
+A getter to check readiness for an operator role. Operator roles are defined in [BIP 174](https://github.com/bitcoin/bips/blob/master/bip-0174.mediawiki#user-content-Roles) and [BIP 370](https://github.com/bitcoin/bips/blob/master/bip-0370.mediawiki#user-content-Roles).
+
+Returns `true` if the PsbtV2 is ready for an operator taking the Combiner role.
+
+Since a Combiner can potentially provide everything needed to a mostly blank PsbtV2, instances of a PsbtV2 are likely to return true as long as inputs have not been finalized.
+
+##### `get isReadyForInputFinalizer`
+
+A getter to check readiness for an operator role. Operator roles are defined in [BIP 174](https://github.com/bitcoin/bips/blob/master/bip-0174.mediawiki#user-content-Roles) and [BIP 370](https://github.com/bitcoin/bips/blob/master/bip-0370.mediawiki#user-content-Roles).
+
+Callable, but unimplemented. Returns `undefined`.
+
+##### `get isReadyForTransactionExtractor`
+
+A getter to check readiness for an operator role. Operator roles are defined in [BIP 174](https://github.com/bitcoin/bips/blob/master/bip-0174.mediawiki#user-content-Roles) and [BIP 370](https://github.com/bitcoin/bips/blob/master/bip-0370.mediawiki#user-content-Roles).
+
+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 nLockTime`
 
 Returns the `nLockTime` field for the psbt as if it were a bitcoin transaction.
@@ -114,7 +169,7 @@ From BIP 370:
 
 ##### `public dangerouslySetGlobalTxVersion1`
 
-A helper method for compatibility, but seems to no-longer be required.
+A helper method for compatibility. Some devices require a psbtV2 configured with a transaction version of 1. BIP370 leaves room for this if the Creator is also the Constructor.
 
 ##### `public addGlobalXpub`
 
@@ -163,23 +218,27 @@ The Signer, when it creates a signature, must add the partial sig keypair to the
 
 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.
 
-##### `static PsbtV2.FromV0`
+##### `public setProprietaryValue`
 
-Attempts to return a `PsbtV2` by converting from a PSBTv0 string or Buffer
+Sets values on the proprietary keytype for a global, input, or output map. BIP 174 allows for proprietary values to be set on all maps with the keytype `0xFC`. This method sets byte data to key values defined by the args.
 
-#### `function getPsbtVersionNumber`
+Args:
 
-Attempts to extract the version number as uint32LE from raw psbt regardless of psbt validity.
+- `mapSelector` selects which map to set the proprietary value. If this value is not `"global"`, then a tuple must be provided with `"inputs"` or `"outputs"` as the first element and the index `number` on the second element representing which input or output map to set the value to. An example looks like `["inputs", 0]`. If the map name doesn't match, the values will be set to the global map. If the index is missing on `"inputs"` or `"outputs"`, then it will throw.
+- `identifier` should be the bytes identifier for the set of proprietary keytypes.
+- `subkeyType` accepts bytes proprietary keytype.
+- `subkeyData` accepts bytes proprietary keydata.
+- `valueData` accepts bytes which will be written as the proprietary value.
 
-#### `abstract class PsbtV2Maps`
+From the provided args, a key with the following format will be generated: `0xFC<compact uint identifier length><bytes identifier><bytes subtype><bytes subkeydata>`
 
-This is provided for utility for compatibility and to allow for mapping, map copying, and serialization operations for psbts. This does almost no validation, so do not rely on it for ensuring a valid psbt.
+##### `static PsbtV2.FromV0`
 
-##### `public copy`
+Attempts to return a `PsbtV2` by converting from a PSBTv0 string or Buffer
 
-Copies the maps in this PsbtV2 object to another PsbtV2 object.
+#### `function getPsbtVersionNumber`
 
-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.
+Attempts to extract the version number as uint32LE from raw psbt regardless of psbt validity.
 
 ## Concepts
 
@@ -189,9 +248,20 @@ The PSBT is a resource which may be passed between several operators or services
 
 ### TODO
 
-Work remains on PSBTv2 for determining the next valid operator role(s) and restricting actions based on PSBT state. In other words, if the state of the PSBT suggests the PSBT might be in role A and is ready for role B, it should only allow actions within the context of role A or B.
+#### PsbtV2
+
+##### Operator role validation
+
+Work remains for determining readiness for operator roles Input Finalizer and Transaction Extractor. The getters responsible for these checks are `isReadyForInputFinalizer` and `isReadyForTransactionExtractor`. Work also remains to expand the PsbtV2 method functionality beyond the Signer role. A huge benefit might be gained from building methods aimed at the Combiner role.
+
+##### Class constructor
+
+The constructor must be able to handle values which the Creator role is responsible for. Currently, the constructor can only accept an optional psbt which it parses to configure itself. It would be ideal if a fresh PsbtV2 instance could be initialized with minimal arguments for which the Creator role is responsible. See `private create()`.
+
+##### Add input timelocks
+
+The `public addInput` must be able to properly handle input locktimes which interact with the global value.
 
-The following list is a non-comprehensive list of validation checks which must be performed:
+##### Add input sighash_single
 
-- Check ready for Updater role on `addInput`, `addOutput`, `deleteInput`, and `deleteOuput`.
-- Check ready for Signer role on `addPartialSig`.
+The `public addInput` must be able to properly handle new inputs when the psbt has a `SIGHASH_SINGLE` flag on `PSBT_GLOBAL_TX_MODIFIABLE`.

package/dist/index.d.mts

@@ -24,6 +24,8 @@ declare enum PsbtGlobalTxModifiableBits {
     OUTPUTS = "OUTPUTS",// 0b00000010
     SIGHASH_SINGLE = "SIGHASH_SINGLE"
 }
+type InputOutputIndexType = number;
+type MapSelectorType = "global" | ["inputs", InputOutputIndexType] | ["outputs", InputOutputIndexType];
 
 /**
  * Attempts to extract the version number as uint32LE from raw psbt regardless
@@ -74,7 +76,7 @@ declare class PsbtV2 extends PsbtV2Maps {
     /**
      * Globals Getters/Setters
      */
-    get PSBT_GLOBAL_XPUB(): NonUniqueKeyTypeValue[] | NonUniqueKeyTypeValue[][];
+    get PSBT_GLOBAL_XPUB(): NonUniqueKeyTypeValue[];
     get PSBT_GLOBAL_TX_VERSION(): number;
     set PSBT_GLOBAL_TX_VERSION(version: number);
     get PSBT_GLOBAL_FALLBACK_LOCKTIME(): number | null;
@@ -87,7 +89,7 @@ declare class PsbtV2 extends PsbtV2Maps {
     set PSBT_GLOBAL_TX_MODIFIABLE(modifiable: PsbtGlobalTxModifiableBits[]);
     get PSBT_GLOBAL_VERSION(): number;
     set PSBT_GLOBAL_VERSION(version: number);
-    get PSBT_GLOBAL_PROPRIETARY(): NonUniqueKeyTypeValue[] | NonUniqueKeyTypeValue[][];
+    get PSBT_GLOBAL_PROPRIETARY(): NonUniqueKeyTypeValue[];
     /**
      * Input Getters/Setters
      */
@@ -97,23 +99,23 @@ declare class PsbtV2 extends PsbtV2Maps {
     get PSBT_IN_SIGHASH_TYPE(): (number | null)[];
     get PSBT_IN_REDEEM_SCRIPT(): (string | null)[];
     get PSBT_IN_WITNESS_SCRIPT(): (string | null)[];
-    get PSBT_IN_BIP32_DERIVATION(): NonUniqueKeyTypeValue[] | NonUniqueKeyTypeValue[][];
+    get PSBT_IN_BIP32_DERIVATION(): NonUniqueKeyTypeValue[][];
     get PSBT_IN_FINAL_SCRIPTSIG(): (string | null)[];
     get PSBT_IN_FINAL_SCRIPTWITNESS(): (string | null)[];
     get PSBT_IN_POR_COMMITMENT(): (string | null)[];
-    get PSBT_IN_RIPEMD160(): NonUniqueKeyTypeValue[] | NonUniqueKeyTypeValue[][];
-    get PSBT_IN_SHA256(): NonUniqueKeyTypeValue[] | NonUniqueKeyTypeValue[][];
-    get PSBT_IN_HASH160(): NonUniqueKeyTypeValue[] | NonUniqueKeyTypeValue[][];
-    get PSBT_IN_HASH256(): NonUniqueKeyTypeValue[] | NonUniqueKeyTypeValue[][];
+    get PSBT_IN_RIPEMD160(): NonUniqueKeyTypeValue[][];
+    get PSBT_IN_SHA256(): NonUniqueKeyTypeValue[][];
+    get PSBT_IN_HASH160(): NonUniqueKeyTypeValue[][];
+    get PSBT_IN_HASH256(): NonUniqueKeyTypeValue[][];
     get PSBT_IN_PREVIOUS_TXID(): string[];
     get PSBT_IN_OUTPUT_INDEX(): number[];
     get PSBT_IN_SEQUENCE(): (number | null)[];
     get PSBT_IN_REQUIRED_TIME_LOCKTIME(): (number | null)[];
     get PSBT_IN_REQUIRED_HEIGHT_LOCKTIME(): (number | null)[];
     get PSBT_IN_TAP_KEY_SIG(): (string | null)[];
-    get PSBT_IN_TAP_SCRIPT_SIG(): NonUniqueKeyTypeValue[] | NonUniqueKeyTypeValue[][];
-    get PSBT_IN_TAP_LEAF_SCRIPT(): NonUniqueKeyTypeValue[] | NonUniqueKeyTypeValue[][];
-    get PSBT_IN_TAP_BIP32_DERIVATION(): NonUniqueKeyTypeValue[] | NonUniqueKeyTypeValue[][];
+    get PSBT_IN_TAP_SCRIPT_SIG(): NonUniqueKeyTypeValue[][];
+    get PSBT_IN_TAP_LEAF_SCRIPT(): NonUniqueKeyTypeValue[][];
+    get PSBT_IN_TAP_BIP32_DERIVATION(): NonUniqueKeyTypeValue[][];
     get PSBT_IN_TAP_INTERNAL_KEY(): (string | null)[];
     get PSBT_IN_TAP_MERKLE_ROOT(): (string | null)[];
     get PSBT_IN_PROPRIETARY(): NonUniqueKeyTypeValue[] | NonUniqueKeyTypeValue[][];
@@ -129,6 +131,57 @@ declare class PsbtV2 extends PsbtV2Maps {
     get PSBT_OUT_TAP_TREE(): (string | null)[];
     get PSBT_OUT_TAP_BIP32_DERIVATION(): NonUniqueKeyTypeValue[] | NonUniqueKeyTypeValue[][];
     get PSBT_OUT_PROPRIETARY(): NonUniqueKeyTypeValue[] | NonUniqueKeyTypeValue[][];
+    /**
+     * 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(): boolean;
+    /**
+     * 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(): boolean;
+    /**
+     * Returns true if the PsbtV2 is ready for an operator taking the Signer role.
+     */
+    get isReadyForSigner(): boolean;
+    /**
+     * Returns true if the PsbtV2 is ready for an operator taking the Combiner
+     * role.
+     */
+    get isReadyForCombiner(): boolean;
+    /**
+     * Unimplemented. Returns false.
+     */
+    get isReadyForInputFinalizer(): boolean;
+    /**
+     * 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(): boolean;
     /**
      * Other Getters/Setters
      */
@@ -205,7 +258,7 @@ declare class PsbtV2 extends PsbtV2Maps {
      */
     deleteOutput(index: number): void;
     /**
-     * Checks that provided flags are present in PSBT_GLOBAL_TX_MODIFIABLE.
+     * Checks that all provided flags are present in PSBT_GLOBAL_TX_MODIFIABLE.
      */
     private isModifiable;
     /**
@@ -228,13 +281,42 @@ declare class PsbtV2 extends PsbtV2Maps {
      * the pubkey exists.
      */
     removePartialSig(inputIndex: number, pubkey?: Buffer): void;
+    /**
+     * Sets values on the proprietary keytype for a global, input, or output map.
+     * BIP 174 allows for proprietary values to be set on all maps with the
+     * keytype `0xFC`. This method sets byte data to key values defined by the
+     * args.
+     *
+     * Args:
+     * - `mapSelector` selects which map to set the proprietary value. If this
+     *   value is not `"global"`, then a tuple must be provided with `"inputs"` or
+     *   `"outputs"` as the first element and the index `number` on the second
+     *   element representing which input or output map to set the value to. An
+     *   example looks like `["inputs", 0]`. If the map name doesn't match, the
+     *   values will be set to the global map. If the index is missing on
+     *   `"inputs"` or `"outputs"`, then it will throw.
+     * - `identifier` should be the bytes identifier for the set of proprietary
+     *   keytypes.
+     * - `subkeyType` accepts bytes proprietary keytype.
+     * - `subkeyData` accepts bytes proprietary keydata.
+     * - `valueData` accepts bytes which will be written as the proprietary value.
+     *
+     * From the provided args, a key with the following format will be generated:
+     * `0xFC<compact uint identifier length><bytes identifier><bytes
+     * subtype><bytes subkeydata>`
+     */
+    setProprietaryValue(mapSelector: MapSelectorType, identifier: Buffer, subkeyType: Buffer, subkeyData: Buffer, valueData: Buffer): void;
     /**
      * 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
      */
     private handleSighashType;
     /**
-     * Attempts 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: string | Buffer, allowTxnVersion1?: boolean): PsbtV2;
 }