@caravan/psbt 1.1.0 → 1.2.0

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @caravan/psbt@1.1.0 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
-CJS dist/index.js 36.78 KB
-CJS ⚡️ Build success in 59ms
-ESM dist/index.mjs 35.12 KB
-ESM ⚡️ Build success in 60ms
+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 2379ms
-DTS dist/index.d.ts  11.83 KB
-DTS dist/index.d.mts 11.83 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.1.0 lint
+> @caravan/psbt@1.2.0 lint
 > eslint src
 
 
@@ -23,13 +23,20 @@
   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
-   132:9   warning  'modifiable' is never reassigned. Use 'const' instead  prefer-const
-   676:9   warning  'heights' is never reassigned. Use 'const' instead     prefer-const
-   677:9   warning  'times' is never reassigned. Use 'const' instead       prefer-const
-  1189:21  warning  Unexpected any. Specify a different type               @typescript-eslint/no-explicit-any
-  1211:22  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
@@ -49,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
 
-✖ 38 problems (0 errors, 38 warnings)
+✖ 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.1.0 test
+> @caravan/psbt@1.2.0 test
 > jest src
 
 PASS src/psbt.test.ts
@@ -9,16 +9,16 @@ PASS src/psbtv2/psbtv2.test.ts
     console.warn
       Dangerously setting PsbtV2.PSBT_GLOBAL_TX_VERSION to 1!
 
-      805 |       );
-      806 |     }
-    > 807 |     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!");
           |             ^
-      808 |     const bw = new BufferWriter();
-      809 |     bw.writeI32(1);
-      810 |     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:807:13)
-      at Function.FromV0 (src/psbtv2/psbtv2.ts:1173:14)
+      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)
@@ -27,16 +27,16 @@ PASS src/psbtv2/psbtv2.test.ts
     console.warn
       Dangerously setting PsbtV2.PSBT_GLOBAL_TX_VERSION to 1!
 
-      805 |       );
-      806 |     }
-    > 807 |     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!");
           |             ^
-      808 |     const bw = new BufferWriter();
-      809 |     bw.writeI32(1);
-      810 |     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:807:13)
-      at Function.FromV0 (src/psbtv2/psbtv2.ts:1173:14)
+      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)
@@ -45,16 +45,16 @@ PASS src/psbtv2/psbtv2.test.ts
     console.warn
       Dangerously setting PsbtV2.PSBT_GLOBAL_TX_VERSION to 1!
 
-      805 |       );
-      806 |     }
-    > 807 |     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!");
           |             ^
-      808 |     const bw = new BufferWriter();
-      809 |     bw.writeI32(1);
-      810 |     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:807:13)
-      at Function.FromV0 (src/psbtv2/psbtv2.ts:1173:14)
+      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
@@ -63,7 +63,7 @@ PASS src/psbtv2/psbtv2.test.ts
           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:1077:12)
+          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>)
@@ -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)
 
-      1077 |       this.handleSighashType(sig);
-      1078 |     } catch (err) {
-    > 1079 |       console.error(err);
+      1078 |       this.handleSighashType(sig);
+      1079 |     } catch (err) {
+    > 1080 |       console.error(err);
            |               ^
-      1080 |       // To remain atomic, attempt to reset everything to the way it was.
-      1081 |       this.inputMaps[inputIndex].delete(key);
-      1082 |       this.PSBT_GLOBAL_TX_MODIFIABLE = modBackup;
+      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:1079:15)
+      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:       192 passed, 192 total
+Tests:       197 passed, 197 total
 Snapshots:   0 total
-Time:        5.211 s
+Time:        5.325 s
 Ran all test suites matching /src/i.

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @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

package/README.md

@@ -34,6 +34,7 @@ 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)
 - [Concepts](#concepts)
@@ -217,6 +218,20 @@ 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.
 
+##### `public setProprietaryValue`
+
+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>`
+
 ##### `static PsbtV2.FromV0`
 
 Attempts to return a `PsbtV2` by converting from a PSBTv0 string or Buffer

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
@@ -279,6 +281,31 @@ 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

package/dist/index.d.ts

@@ -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
@@ -279,6 +281,31 @@ 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

package/dist/index.js

@@ -1043,6 +1043,58 @@ var PsbtV2 = class _PsbtV2 extends PsbtV2Maps {
       }
     }
   }
+  /**
+   * 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, identifier, subkeyType, subkeyData, valueData) {
+    if ((mapSelector[0] === "inputs" || mapSelector[0] === "outputs") && typeof mapSelector[1] !== "number") {
+      throw Error(
+        "Must specify an index when setting proprietary values to inputs or outputs."
+      );
+    }
+    let classMap = this.globalMap, keyType = "fc" /* PSBT_GLOBAL_PROPRIETARY */;
+    if (mapSelector[0] === "inputs") {
+      classMap = this.inputMaps[mapSelector[1]];
+      keyType = "fc" /* PSBT_IN_PROPRIETARY */;
+    } else if (mapSelector[0] === "outputs") {
+      classMap = this.outputMaps[mapSelector[1]];
+      keyType = "fc" /* PSBT_OUT_PROPRIETARY */;
+    }
+    if (!classMap) {
+      throw Error("Map does not exist at that index.");
+    }
+    const bw = new import_bufio3.BufferWriter();
+    bw.writeBytes(import_buffer.Buffer.from(keyType, "hex"));
+    bw.writeU8(identifier.length);
+    bw.writeBytes(identifier);
+    bw.writeBytes(subkeyType);
+    bw.writeBytes(subkeyData);
+    const key = bw.render().toString("hex");
+    bw.writeBytes(valueData);
+    const value = bw.render();
+    classMap.set(key, value);
+  }
   /**
    * 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

package/dist/index.mjs

@@ -1024,6 +1024,58 @@ var PsbtV2 = class _PsbtV2 extends PsbtV2Maps {
       }
     }
   }
+  /**
+   * 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, identifier, subkeyType, subkeyData, valueData) {
+    if ((mapSelector[0] === "inputs" || mapSelector[0] === "outputs") && typeof mapSelector[1] !== "number") {
+      throw Error(
+        "Must specify an index when setting proprietary values to inputs or outputs."
+      );
+    }
+    let classMap = this.globalMap, keyType = "fc" /* PSBT_GLOBAL_PROPRIETARY */;
+    if (mapSelector[0] === "inputs") {
+      classMap = this.inputMaps[mapSelector[1]];
+      keyType = "fc" /* PSBT_IN_PROPRIETARY */;
+    } else if (mapSelector[0] === "outputs") {
+      classMap = this.outputMaps[mapSelector[1]];
+      keyType = "fc" /* PSBT_OUT_PROPRIETARY */;
+    }
+    if (!classMap) {
+      throw Error("Map does not exist at that index.");
+    }
+    const bw = new BufferWriter3();
+    bw.writeBytes(Buffer.from(keyType, "hex"));
+    bw.writeU8(identifier.length);
+    bw.writeBytes(identifier);
+    bw.writeBytes(subkeyType);
+    bw.writeBytes(subkeyData);
+    const key = bw.render().toString("hex");
+    bw.writeBytes(valueData);
+    const value = bw.render();
+    classMap.set(key, value);
+  }
   /**
    * 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

package/package.json

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

package/src/psbtv2/psbtv2.test.ts

@@ -1388,3 +1388,200 @@ describe("PsbtV2.isModifiable (private)", () => {
     },
   );
 });
+
+describe("PsbtV2.setProprietaryValue", () => {
+  const identifier = Buffer.from("satoshi");
+  const idLength = Buffer.from([identifier.length]);
+  const keytype1 = Buffer.from("00", "hex");
+  const keytype2 = Buffer.from("01", "hex");
+  const keydata1 = Buffer.from("0001", "hex");
+  const keydata2 = Buffer.from("0002", "hex");
+  const valuedata1 = Buffer.from("000001", "hex");
+  const valuedata2 = Buffer.from("000002", "hex");
+
+  const key1 = Buffer.from([
+    0xfc,
+    ...idLength,
+    ...identifier,
+    ...keytype1,
+    ...keydata1,
+  ]).toString("hex");
+  const key2 = Buffer.from([
+    0xfc,
+    ...idLength,
+    ...identifier,
+    ...keytype2,
+    ...keydata2,
+  ]).toString("hex");
+
+  let psbt: PsbtV2;
+
+  beforeEach(() => {
+    psbt = new PsbtV2();
+  });
+
+  it("sets values to the global map", () => {
+    psbt.setProprietaryValue(
+      "global",
+      identifier,
+      keytype1,
+      keydata1,
+      valuedata1,
+    );
+    psbt.setProprietaryValue(
+      "global",
+      identifier,
+      keytype2,
+      keydata2,
+      valuedata2,
+    );
+    expect(psbt.PSBT_GLOBAL_PROPRIETARY[0].key).toBe(key1);
+    expect(psbt.PSBT_GLOBAL_PROPRIETARY[0].value).toBe(
+      valuedata1.toString("hex"),
+    );
+    expect(psbt.PSBT_GLOBAL_PROPRIETARY[1].key).toBe(key2);
+    expect(psbt.PSBT_GLOBAL_PROPRIETARY[1].value).toBe(
+      valuedata2.toString("hex"),
+    );
+  });
+
+  it("defaults to setting global maps when the map selector is malformed", () => {
+    psbt.setProprietaryValue(
+      "inputs" as any,
+      identifier,
+      keytype1,
+      keydata1,
+      valuedata1,
+    );
+    expect((psbt as any).inputMaps.length).toBe(0);
+    expect((psbt as any).outputMaps.length).toBe(0);
+    expect(psbt.PSBT_GLOBAL_PROPRIETARY[0].key).toBe(key1);
+    expect(psbt.PSBT_GLOBAL_PROPRIETARY[0].value).toBe(
+      valuedata1.toString("hex"),
+    );
+  });
+
+  it("throws when input or output map are missing an index", () => {
+    expect(() =>
+      psbt.setProprietaryValue(
+        ["inputs"] as any,
+        identifier,
+        keytype1,
+        keydata1,
+        valuedata1,
+      ),
+    ).toThrow(
+      "Must specify an index when setting proprietary values to inputs or outputs.",
+    );
+
+    expect(() =>
+      psbt.setProprietaryValue(
+        ["inputs", null] as any,
+        identifier,
+        keytype1,
+        keydata1,
+        valuedata1,
+      ),
+    ).toThrow(
+      "Must specify an index when setting proprietary values to inputs or outputs.",
+    );
+
+    expect(() =>
+      psbt.setProprietaryValue(
+        ["outputs"] as any,
+        identifier,
+        keytype1,
+        keydata1,
+        valuedata1,
+      ),
+    ).toThrow(
+      "Must specify an index when setting proprietary values to inputs or outputs.",
+    );
+
+    expect(() =>
+      psbt.setProprietaryValue(
+        ["outputs", null] as any,
+        identifier,
+        keytype1,
+        keydata1,
+        valuedata1,
+      ),
+    ).toThrow(
+      "Must specify an index when setting proprietary values to inputs or outputs.",
+    );
+  });
+
+  it("throws when input or output map is uninitialized", () => {
+    expect(() =>
+      psbt.setProprietaryValue(
+        ["inputs", 0],
+        identifier,
+        keytype1,
+        keydata1,
+        valuedata1,
+      ),
+    ).toThrow("Map does not exist at that index.");
+
+    expect(() =>
+      psbt.setProprietaryValue(
+        ["outputs", 0],
+        identifier,
+        keytype1,
+        keydata1,
+        valuedata1,
+      ),
+    ).toThrow("Map does not exist at that index.");
+  });
+
+  it("sets values to input and output maps", () => {
+    psbt.addInput({ previousTxId: Buffer.from([0x00]), outputIndex: 0 });
+    psbt.addInput({ previousTxId: Buffer.from([0x01]), outputIndex: 1 });
+    psbt.addOutput({ amount: 1, script: Buffer.from([0x00]) });
+    psbt.addOutput({ amount: 2, script: Buffer.from([0x01]) });
+    psbt.setProprietaryValue(
+      ["inputs", 0],
+      identifier,
+      keytype1,
+      keydata1,
+      valuedata1,
+    );
+    psbt.setProprietaryValue(
+      ["inputs", 1],
+      identifier,
+      keytype2,
+      keydata2,
+      valuedata2,
+    );
+    psbt.setProprietaryValue(
+      ["outputs", 0],
+      identifier,
+      keytype1,
+      keydata1,
+      valuedata1,
+    );
+    psbt.setProprietaryValue(
+      ["outputs", 1],
+      identifier,
+      keytype2,
+      keydata2,
+      valuedata2,
+    );
+
+    expect(psbt.PSBT_IN_PROPRIETARY[0][0].key).toBe(key1);
+    expect(psbt.PSBT_IN_PROPRIETARY[0][0].value).toBe(
+      valuedata1.toString("hex"),
+    );
+    expect(psbt.PSBT_IN_PROPRIETARY[1][0].key).toBe(key2);
+    expect(psbt.PSBT_IN_PROPRIETARY[1][0].value).toBe(
+      valuedata2.toString("hex"),
+    );
+    expect(psbt.PSBT_OUT_PROPRIETARY[0][0].key).toBe(key1);
+    expect(psbt.PSBT_OUT_PROPRIETARY[0][0].value).toBe(
+      valuedata1.toString("hex"),
+    );
+    expect(psbt.PSBT_OUT_PROPRIETARY[1][0].key).toBe(key2);
+    expect(psbt.PSBT_OUT_PROPRIETARY[1][0].value).toBe(
+      valuedata2.toString("hex"),
+    );
+  });
+});

package/src/psbtv2/psbtv2.ts

@@ -8,6 +8,7 @@ import {
   KeyType,
   PsbtGlobalTxModifiableBits,
   SighashType,
+  MapSelectorType,
 } from "./types";
 import {
   bufferize,
@@ -1120,6 +1121,72 @@ export class PsbtV2 extends PsbtV2Maps {
     }
   }
 
+  /**
+   * 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>`
+   */
+  public setProprietaryValue(
+    mapSelector: MapSelectorType,
+    identifier: Buffer,
+    subkeyType: Buffer,
+    subkeyData: Buffer,
+    valueData: Buffer,
+  ) {
+    if (
+      (mapSelector[0] === "inputs" || mapSelector[0] === "outputs") &&
+      typeof mapSelector[1] !== "number"
+    ) {
+      throw Error(
+        "Must specify an index when setting proprietary values to inputs or outputs.",
+      );
+    }
+
+    let classMap: Map<string, Buffer> = this.globalMap,
+      keyType = KeyType.PSBT_GLOBAL_PROPRIETARY;
+    if (mapSelector[0] === "inputs") {
+      classMap = this.inputMaps[mapSelector[1]];
+      keyType = KeyType.PSBT_IN_PROPRIETARY;
+    } else if (mapSelector[0] === "outputs") {
+      classMap = this.outputMaps[mapSelector[1]];
+      keyType = KeyType.PSBT_OUT_PROPRIETARY;
+    }
+
+    if (!classMap) {
+      throw Error("Map does not exist at that index.");
+    }
+
+    const bw = new BufferWriter();
+    bw.writeBytes(Buffer.from(keyType, "hex"));
+    bw.writeU8(identifier.length);
+    bw.writeBytes(identifier);
+    bw.writeBytes(subkeyType);
+    bw.writeBytes(subkeyData);
+    const key = bw.render().toString("hex");
+    bw.writeBytes(valueData);
+    const value = bw.render();
+    classMap.set(key, value);
+  }
+
   /**
    * 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

package/src/psbtv2/types.ts

@@ -83,3 +83,9 @@ export enum SighashType {
   SIGHASH_SINGLE = 0x03,
   SIGHASH_ANYONECANPAY = 0x80,
 }
+
+type InputOutputIndexType = number;
+export type MapSelectorType =
+  | "global"
+  | ["inputs", InputOutputIndexType]
+  | ["outputs", InputOutputIndexType];