@caravan/psbt 1.2.0 → 1.3.1

package/src/psbtv2/psbtv2maps.ts

@@ -1,111 +0,0 @@
-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

@@ -1,91 +0,0 @@
-/**
- * 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,
-}
-
-type InputOutputIndexType = number;
-export type MapSelectorType =
-  | "global"
-  | ["inputs", InputOutputIndexType]
-  | ["outputs", InputOutputIndexType];

package/src/psbtv2/values.ts

@@ -1,4 +0,0 @@
-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/tsconfig.json

@@ -1,3 +0,0 @@
-{
-  "extends": "@caravan/typescript-config/base.json"
-}

package/tsup.config.ts

@@ -1,6 +0,0 @@
-import { defineConfig } from 'tsup'
-import { polyfillNode } from "esbuild-plugin-polyfill-node";
-
-export default defineConfig({
-  esbuildPlugins: [polyfillNode()],
-})