@caravan/psbt 1.0.0 → 1.1.0

package/src/psbtv2/psbtv2maps.ts

@@ -0,0 +1,111 @@
+import { BufferReader, BufferWriter } from "bufio";
+
+import { bufferize, readAndSetKeyPairs, serializeMap } from "./functions";
+import { Key, KeyType, Value } from "./types";
+import { PSBT_MAGIC_BYTES } from "../psbt";
+import { PsbtV2 } from "./psbtv2";
+
+/**
+ * This abstract class is provided for utility 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.
+ */
+export abstract class PsbtV2Maps {
+  // These maps directly correspond to the maps defined in BIP0174 and extended
+  // in BIP0370
+  protected globalMap: Map<Key, Value> = new Map();
+  protected inputMaps: Map<Key, Value>[] = [];
+  protected outputMaps: Map<Key, Value>[] = [];
+
+  constructor(psbt?: Buffer | string) {
+    if (!psbt) {
+      return;
+    }
+
+    const buf = bufferize(psbt);
+    const br = new BufferReader(buf);
+    if (!br.readBytes(PSBT_MAGIC_BYTES.length, true).equals(PSBT_MAGIC_BYTES)) {
+      throw Error("PsbtV2 magic bytes are incorrect.");
+    }
+    // Build globalMap
+    readAndSetKeyPairs(this.globalMap, br);
+    if (
+      // Assuming that psbt being passed in is a valid psbtv2
+      !this.globalMap.has(KeyType.PSBT_GLOBAL_VERSION) ||
+      !this.globalMap.has(KeyType.PSBT_GLOBAL_TX_VERSION) ||
+      !this.globalMap.has(KeyType.PSBT_GLOBAL_INPUT_COUNT) ||
+      !this.globalMap.has(KeyType.PSBT_GLOBAL_OUTPUT_COUNT) ||
+      this.globalMap.has("00") // PsbtV2 must exclude key 0x00
+    ) {
+      throw Error("Provided PsbtV2 not valid. Missing required global keys.");
+    }
+
+    // Build inputMaps
+    const inputCount =
+      this.globalMap.get(KeyType.PSBT_GLOBAL_INPUT_COUNT)?.readUInt8(0) ?? 0;
+    for (let i = 0; i < inputCount; i++) {
+      const map = new Map<Key, Value>();
+      readAndSetKeyPairs(map, br);
+      this.inputMaps.push(map);
+    }
+
+    // Build outputMaps
+    const outputCount =
+      this.globalMap.get(KeyType.PSBT_GLOBAL_OUTPUT_COUNT)?.readUInt8(0) ?? 0;
+    for (let i = 0; i < outputCount; i++) {
+      const map = new Map<Key, Value>();
+      readAndSetKeyPairs(map, br);
+      this.outputMaps.push(map);
+    }
+  }
+
+  /**
+   * Return the current state of the psbt as a string in the specified format.
+   */
+  public serialize(format: "base64" | "hex" = "base64"): string {
+    // Build hex string from maps
+    const bw = new BufferWriter();
+    bw.writeBytes(PSBT_MAGIC_BYTES);
+    serializeMap(this.globalMap, bw);
+
+    for (const map of this.inputMaps) {
+      serializeMap(map, bw);
+    }
+
+    for (const map of this.outputMaps) {
+      serializeMap(map, bw);
+    }
+
+    return bw.render().toString(format);
+  }
+
+  /**
+   * 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.
+   */
+  public copy(to: PsbtV2) {
+    this.copyMap(this.globalMap, to.globalMap);
+    this.copyMaps(this.inputMaps, to.inputMaps);
+    this.copyMaps(this.outputMaps, to.outputMaps);
+  }
+
+  private copyMaps(
+    from: readonly ReadonlyMap<string, Buffer>[],
+    to: Map<string, Buffer>[],
+  ) {
+    from.forEach((m, index) => {
+      const to_index = new Map<Key, Value>();
+      this.copyMap(m, to_index);
+      to[index] = to_index;
+    });
+  }
+
+  private copyMap(from: ReadonlyMap<string, Buffer>, to: Map<string, Buffer>) {
+    from.forEach((v, k) => to.set(k, Buffer.from(v)));
+  }
+}

package/src/psbtv2/types.ts

@@ -0,0 +1,85 @@
+/**
+ * Hex encoded string containing `<keytype><keydata>`. A string is needed for
+ * Map.get() since it matches by identity. Most commonly, a `Key` only contains a
+ * keytype byte, however, some with keydata can allow for multiple unique keys
+ * of the same type.
+ */
+export type Key = string;
+
+/**
+ * Values can be of various different types or formats. Here we leave them as
+ * Buffers so that getters can decide how they should be formatted.
+ */
+export type Value = Buffer;
+
+export type NonUniqueKeyTypeValue = { key: string; value: string | null };
+
+/**
+ * KeyTypes are hex bytes, but within this module are used as string enums to
+ * assist in Map lookups. See type `Key` for more info.
+ */
+export enum KeyType {
+  PSBT_GLOBAL_XPUB = "01",
+  PSBT_GLOBAL_TX_VERSION = "02",
+  PSBT_GLOBAL_FALLBACK_LOCKTIME = "03",
+  PSBT_GLOBAL_INPUT_COUNT = "04",
+  PSBT_GLOBAL_OUTPUT_COUNT = "05",
+  PSBT_GLOBAL_TX_MODIFIABLE = "06",
+  PSBT_GLOBAL_VERSION = "fb",
+  PSBT_GLOBAL_PROPRIETARY = "fc",
+
+  PSBT_IN_NON_WITNESS_UTXO = "00",
+  PSBT_IN_WITNESS_UTXO = "01",
+  PSBT_IN_PARTIAL_SIG = "02",
+  PSBT_IN_SIGHASH_TYPE = "03",
+  PSBT_IN_REDEEM_SCRIPT = "04",
+  PSBT_IN_WITNESS_SCRIPT = "05",
+  PSBT_IN_BIP32_DERIVATION = "06",
+  PSBT_IN_FINAL_SCRIPTSIG = "07",
+  PSBT_IN_FINAL_SCRIPTWITNESS = "08",
+  PSBT_IN_POR_COMMITMENT = "09",
+  PSBT_IN_RIPEMD160 = "0a",
+  PSBT_IN_SHA256 = "0b",
+  PSBT_IN_HASH160 = "0c",
+  PSBT_IN_HASH256 = "0d",
+  PSBT_IN_PREVIOUS_TXID = "0e",
+  PSBT_IN_OUTPUT_INDEX = "0f",
+  PSBT_IN_SEQUENCE = "10",
+  PSBT_IN_REQUIRED_TIME_LOCKTIME = "11",
+  PSBT_IN_REQUIRED_HEIGHT_LOCKTIME = "12",
+  PSBT_IN_TAP_KEY_SIG = "13",
+  PSBT_IN_TAP_SCRIPT_SIG = "14",
+  PSBT_IN_TAP_LEAF_SCRIPT = "15",
+  PSBT_IN_TAP_BIP32_DERIVATION = "16",
+  PSBT_IN_TAP_INTERNAL_KEY = "17",
+  PSBT_IN_TAP_MERKLE_ROOT = "18",
+  PSBT_IN_PROPRIETARY = "fc",
+
+  PSBT_OUT_REDEEM_SCRIPT = "00",
+  PSBT_OUT_WITNESS_SCRIPT = "01",
+  PSBT_OUT_BIP32_DERIVATION = "02",
+  PSBT_OUT_AMOUNT = "03",
+  PSBT_OUT_SCRIPT = "04",
+  PSBT_OUT_TAP_INTERNAL_KEY = "05",
+  PSBT_OUT_TAP_TREE = "06",
+  PSBT_OUT_TAP_BIP32_DERIVATION = "07",
+  PSBT_OUT_PROPRIETARY = "fc",
+}
+
+/**
+ * Provided to friendly-format the `PSBT_GLOBAL_TX_MODIFIABLE` bitmask from
+ * `PsbtV2.PSBT_GLOBAL_TX_MODIFIABLE` which returns
+ * `PsbtGlobalTxModifiableBits[]`.
+ */
+export enum PsbtGlobalTxModifiableBits {
+  INPUTS = "INPUTS", // 0b00000001
+  OUTPUTS = "OUTPUTS", // 0b00000010
+  SIGHASH_SINGLE = "SIGHASH_SINGLE", // 0b00000100
+}
+
+export enum SighashType {
+  SIGHASH_ALL = 0x01,
+  SIGHASH_NONE = 0x02,
+  SIGHASH_SINGLE = 0x03,
+  SIGHASH_ANYONECANPAY = 0x80,
+}

package/src/psbtv2/values.ts

@@ -0,0 +1,4 @@
+export { PSBT_MAGIC_BYTES } from "../psbt";
+export const PSBT_MAP_SEPARATOR = Buffer.from([0x00]);
+export const BIP_32_NODE_REGEX = /(\/[0-9]+'?)/gi;
+export const BIP_32_HARDENING_OFFSET = 0x80000000;

package/.turbo/turbo-ci.log

@@ -1,258 +0,0 @@
-
-
-> @caravan/psbt@0.0.0 ci
-> npm run lint && npm run test
-
-
-> @caravan/psbt@0.0.0 lint
-> eslint src
-
-
-/Users/atreides/repos/caravan-monorepo/packages/caravan-psbt/src/psbt.ts
-   43:54  warning  Unexpected any. Specify a different type              @typescript-eslint/no-explicit-any
-  113:23  warning  Unexpected any. Specify a different type              @typescript-eslint/no-explicit-any
-  268:7   warning  'localPSBT' is never reassigned. Use 'const' instead  prefer-const
-  376:7   warning  'psbt' is never reassigned. Use 'const' instead       prefer-const
-  415:7   warning  'psbt' is never reassigned. Use 'const' instead       prefer-const
-  430:13  warning  'signature' is never reassigned. Use 'const' instead  prefer-const
-
-/Users/atreides/repos/caravan-monorepo/packages/caravan-psbt/src/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
-
-/Users/atreides/repos/caravan-monorepo/packages/caravan-psbt/src/psbtv2.ts
-    47:3   warning  Duplicate enum member value 01                         @typescript-eslint/no-duplicate-enum-values
-    48:3   warning  Duplicate enum member value 02                         @typescript-eslint/no-duplicate-enum-values
-    49:3   warning  Duplicate enum member value 03                         @typescript-eslint/no-duplicate-enum-values
-    50:3   warning  Duplicate enum member value 04                         @typescript-eslint/no-duplicate-enum-values
-    51:3   warning  Duplicate enum member value 05                         @typescript-eslint/no-duplicate-enum-values
-    52:3   warning  Duplicate enum member value 06                         @typescript-eslint/no-duplicate-enum-values
-    71:3   warning  Duplicate enum member value fc                         @typescript-eslint/no-duplicate-enum-values
-    73:3   warning  Duplicate enum member value 00                         @typescript-eslint/no-duplicate-enum-values
-    74:3   warning  Duplicate enum member value 01                         @typescript-eslint/no-duplicate-enum-values
-    75:3   warning  Duplicate enum member value 02                         @typescript-eslint/no-duplicate-enum-values
-    76:3   warning  Duplicate enum member value 03                         @typescript-eslint/no-duplicate-enum-values
-    77:3   warning  Duplicate enum member value 04                         @typescript-eslint/no-duplicate-enum-values
-    78:3   warning  Duplicate enum member value 05                         @typescript-eslint/no-duplicate-enum-values
-    79:3   warning  Duplicate enum member value 06                         @typescript-eslint/no-duplicate-enum-values
-    80:3   warning  Duplicate enum member value 07                         @typescript-eslint/no-duplicate-enum-values
-    81:3   warning  Duplicate enum member value fc                         @typescript-eslint/no-duplicate-enum-values
-   296:9   warning  'bw' is never reassigned. Use 'const' instead          prefer-const
-   438:9   warning  'modifiable' is never reassigned. Use 'const' instead  prefer-const
-   781:9   warning  'heights' is never reassigned. Use 'const' instead     prefer-const
-   782:9   warning  'times' is never reassigned. Use 'const' instead       prefer-const
-  1225:9   warning  'txInputs' is never reassigned. Use 'const' instead    prefer-const
-  1225:19  warning  Unexpected any. Specify a different type               @typescript-eslint/no-explicit-any
-  1247:9   warning  'txOutputs' is never reassigned. Use 'const' instead   prefer-const
-  1247:20  warning  Unexpected any. Specify a different type               @typescript-eslint/no-explicit-any
-
-✖ 34 problems (0 errors, 34 warnings)
-  0 errors and 10 warnings potentially fixable with the `--fix` option.
-
-
-> @caravan/psbt@0.0.0 test
-> jest src
-
-Determining test suites to run...
-
-Test Suites: 0 of 2 total
-Tests:       0 total
-Snapshots:   0 total
-Time:        0 s, estimated 6 s
-████████████████████████████████████████
- RUNS  src/psbtv2.test.ts
- RUNS  src/psbt.test.ts
-
-Test Suites: 0 of 2 total
-Tests:       0 total
-Snapshots:   0 total
-Time:        0 s, estimated 6 s
-████████████████████████████████████████
- RUNS  src/psbtv2.test.ts
- RUNS  src/psbt.test.ts
-
-Test Suites: 0 of 2 total
-Tests:       0 total
-Snapshots:   0 total
-Time:        1 s, estimated 6 s
-████████████████████████████████████████
- RUNS  src/psbtv2.test.ts
- RUNS  src/psbt.test.ts
-
-Test Suites: 0 of 2 total
-Tests:       0 total
-Snapshots:   0 total
-Time:        2 s, estimated 6 s
-████████████████████████████████████████
- RUNS  src/psbtv2.test.ts
- RUNS  src/psbt.test.ts
-
-Test Suites: 0 of 2 total
-Tests:       0 total
-Snapshots:   0 total
-Time:        3 s, estimated 6 s
-████████████████████████████████████████
- RUNS  src/psbtv2.test.ts
- RUNS  src/psbt.test.ts
-
-Test Suites: 0 of 2 total
-Tests:       0 total
-Snapshots:   0 total
-Time:        4 s, estimated 6 s
-████████████████████████████████████████
- RUNS  src/psbtv2.test.ts
- RUNS  src/psbt.test.ts
-
-Test Suites: 0 of 2 total
-Tests:       0 total
-Snapshots:   0 total
-Time:        5 s, estimated 6 s
-████████████████████████████████████████
- RUNS  src/psbtv2.test.ts
- RUNS  src/psbt.test.ts
-
-Test Suites: 0 of 2 total
-Tests:       14 passed, 14 total
-Snapshots:   0 total
-Time:        5 s, estimated 6 s
-████████████████████████████████████████
-
- RUNS  src/psbtv2.test.ts
- RUNS  src/psbt.test.ts
-
-Test Suites: 0 of 2 total
-Tests:       14 passed, 14 total
-Snapshots:   0 total
-Time:        5 s, estimated 6 s
-████████████████████████████████████████
- RUNS  src/psbtv2.test.ts
- RUNS  src/psbt.test.ts
-
-Test Suites: 0 of 2 total
-Tests:       14 passed, 14 total
-Snapshots:   0 total
-Time:        5 s, estimated 6 s
-████████████████████████████████████████
- RUNS  src/psbtv2.test.ts
-
-Test Suites: 1 passed, 1 of 2 total
-Tests:       24 passed, 24 total
-Snapshots:   0 total
-Time:        5 s, estimated 6 s
-████████████████████████████████████████
- RUNS  src/psbtv2.test.ts
-
-Test Suites: 1 passed, 1 of 2 total
-Tests:       101 passed, 101 total
-Snapshots:   0 total
-Time:        5 s, estimated 6 s
-████████████████████████████████████████
-
- RUNS  src/psbtv2.test.ts
-
-Test Suites: 1 passed, 1 of 2 total
-Tests:       101 passed, 101 total
-Snapshots:   0 total
-Time:        5 s, estimated 6 s
-████████████████████████████████████████
-
-    console.warn
-      Dangerously setting PsbtV2.PSBT_GLOBAL_TX_VERSION to 1!
-
-      892 |   // lifecycle defined for PsbtV2.
-      893 |   public dangerouslySetGlobalTxVersion1() {
-    > 894 |     console.warn("Dangerously setting PsbtV2.PSBT_GLOBAL_TX_VERSION to 1!");
-          |             ^
-      895 |     const bw = new BufferWriter();
-      896 |     bw.writeI32(1);
-      897 |     this.globalMap.set(KeyType.PSBT_GLOBAL_TX_VERSION, bw.render());
-
-      at PsbtV2.dangerouslySetGlobalTxVersion1 (src/psbtv2.ts:894:13)
-      at Function.FromV0 (src/psbtv2.ts:1208:14)
-      at t (src/psbtv2.test.ts:947: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.test.ts:948:25
-
-    console.warn
-      Dangerously setting PsbtV2.PSBT_GLOBAL_TX_VERSION to 1!
-
-      892 |   // lifecycle defined for PsbtV2.
-      893 |   public dangerouslySetGlobalTxVersion1() {
-    > 894 |     console.warn("Dangerously setting PsbtV2.PSBT_GLOBAL_TX_VERSION to 1!");
-          |             ^
-      895 |     const bw = new BufferWriter();
-      896 |     bw.writeI32(1);
-      897 |     this.globalMap.set(KeyType.PSBT_GLOBAL_TX_VERSION, bw.render());
-
-      at PsbtV2.dangerouslySetGlobalTxVersion1 (src/psbtv2.ts:894:13)
-      at Function.FromV0 (src/psbtv2.ts:1208:14)
-      at t (src/psbtv2.test.ts:947: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.test.ts:948:25
-
-    console.warn
-      Dangerously setting PsbtV2.PSBT_GLOBAL_TX_VERSION to 1!
-
-      892 |   // lifecycle defined for PsbtV2.
-      893 |   public dangerouslySetGlobalTxVersion1() {
-    > 894 |     console.warn("Dangerously setting PsbtV2.PSBT_GLOBAL_TX_VERSION to 1!");
-          |             ^
-      895 |     const bw = new BufferWriter();
-      896 |     bw.writeI32(1);
-      897 |     this.globalMap.set(KeyType.PSBT_GLOBAL_TX_VERSION, bw.render());
-
-      at PsbtV2.dangerouslySetGlobalTxVersion1 (src/psbtv2.ts:894:13)
-      at Function.FromV0 (src/psbtv2.ts:1208:14)
-      at src/psbtv2.test.ts:959:25
-
-    console.error
-      Error: 
-          at PsbtV2.<anonymous> (/Users/atreides/repos/caravan-monorepo/packages/caravan-psbt/src/psbtv2.test.ts:1044:13)
-          at /Users/atreides/repos/caravan-monorepo/node_modules/jest-mock/build/index.js:397:39
-          at PsbtV2.<anonymous> (/Users/atreides/repos/caravan-monorepo/node_modules/jest-mock/build/index.js:404:13)
-          at PsbtV2.mockConstructor [as handleSighashType] (/Users/atreides/repos/caravan-monorepo/node_modules/jest-mock/build/index.js:148:19)
-          at PsbtV2.addPartialSig (/Users/atreides/repos/caravan-monorepo/packages/caravan-psbt/src/psbtv2.ts:1120:12)
-          at Object.<anonymous> (/Users/atreides/repos/caravan-monorepo/packages/caravan-psbt/src/psbtv2.test.ts:1049:10)
-          at Promise.then.completed (/Users/atreides/repos/caravan-monorepo/node_modules/jest-circus/build/utils.js:298:28)
-          at new Promise (<anonymous>)
-          at callAsyncCircusFn (/Users/atreides/repos/caravan-monorepo/node_modules/jest-circus/build/utils.js:231:10)
-          at _callCircusTest (/Users/atreides/repos/caravan-monorepo/node_modules/jest-circus/build/run.js:316:40)
-          at processTicksAndRejections (node:internal/process/task_queues:95:5)
-          at _runTest (/Users/atreides/repos/caravan-monorepo/node_modules/jest-circus/build/run.js:252:3)
-          at _runTestsForDescribeBlock (/Users/atreides/repos/caravan-monorepo/node_modules/jest-circus/build/run.js:126:9)
-          at _runTestsForDescribeBlock (/Users/atreides/repos/caravan-monorepo/node_modules/jest-circus/build/run.js:121:9)
-          at run (/Users/atreides/repos/caravan-monorepo/node_modules/jest-circus/build/run.js:71:3)
-          at runAndTransformResultsToJestFormat (/Users/atreides/repos/caravan-monorepo/node_modules/jest-circus/build/legacy-code-todo-rewrite/jestAdapterInit.js:122:21)
-          at jestAdapter (/Users/atreides/repos/caravan-monorepo/node_modules/jest-circus/build/legacy-code-todo-rewrite/jestAdapter.js:79:19)
-          at runTestInternal (/Users/atreides/repos/caravan-monorepo/node_modules/jest-runner/build/runTest.js:367:16)
-          at runTest (/Users/atreides/repos/caravan-monorepo/node_modules/jest-runner/build/runTest.js:444:34)
-          at Object.worker (/Users/atreides/repos/caravan-monorepo/node_modules/jest-runner/build/testWorker.js:106:12)
-
-      1120 |       this.handleSighashType(sig);
-      1121 |     } catch (err) {
-    > 1122 |       console.error(err);
-           |               ^
-      1123 |       // To remain atomic, attempt to reset everything to the way it was.
-      1124 |       this.inputMaps[inputIndex].delete(key);
-      1125 |       this.PSBT_GLOBAL_TX_MODIFIABLE = modBackup;
-
-      at PsbtV2.addPartialSig (src/psbtv2.ts:1122:15)
-      at Object.<anonymous> (src/psbtv2.test.ts:1049:10)
-
-
- RUNS  src/psbtv2.test.ts
-
-Test Suites: 1 passed, 1 of 2 total
-Tests:       101 passed, 101 total
-Snapshots:   0 total
-Time:        5 s, estimated 6 s
-████████████████████████████████████████
-Test Suites: 2 passed, 2 total
-Tests:       177 passed, 177 total
-Snapshots:   0 total
-Time:        5.726 s, estimated 6 s
-Ran all test suites matching /src/i.