@bitgo/wasm-utxo 4.0.2 → 4.1.0

package/dist/cjs/js/descriptorWallet/Psbt.d.ts

@@ -1,5 +1,6 @@
 import { WrapPsbt as WasmPsbt, type WasmBIP32, type WasmECPair, type WrapDescriptor, type PsbtInputData, type PsbtOutputData, type PsbtOutputDataWithAddress } from "../wasm/wasm_utxo.js";
 import type { IPsbt } from "../psbt.js";
+import type { PsbtKvKey } from "../fixedScriptWallet/BitGoKeySubtype.js";
 import type { CoinName } from "../coinName.js";
 import type { BIP32 } from "../bip32.js";
 import { Transaction } from "../transaction.js";
@@ -30,6 +31,12 @@ export declare class Psbt implements IPsbt {
     addOutput(script: Uint8Array, value: bigint): number;
     removeInput(index: number): void;
     removeOutput(index: number): void;
+    setKV(key: PsbtKvKey, value: Uint8Array): void;
+    getKV(key: PsbtKvKey): Uint8Array | undefined;
+    setInputKV(index: number, key: PsbtKvKey, value: Uint8Array): void;
+    getInputKV(index: number, key: PsbtKvKey): Uint8Array | undefined;
+    setOutputKV(index: number, key: PsbtKvKey, value: Uint8Array): void;
+    getOutputKV(index: number, key: PsbtKvKey): Uint8Array | undefined;
     updateInputWithDescriptor(inputIndex: number, descriptor: WrapDescriptor): void;
     updateOutputWithDescriptor(outputIndex: number, descriptor: WrapDescriptor): void;
     signWithXprv(xprv: string): SignPsbtResult;

package/dist/cjs/js/descriptorWallet/Psbt.js

@@ -78,6 +78,24 @@ class Psbt {
     removeOutput(index) {
         this._wasm.remove_output(index);
     }
+    setKV(key, value) {
+        this._wasm.set_kv(key, value);
+    }
+    getKV(key) {
+        return this._wasm.get_kv(key) ?? undefined;
+    }
+    setInputKV(index, key, value) {
+        this._wasm.set_input_kv(index, key, value);
+    }
+    getInputKV(index, key) {
+        return this._wasm.get_input_kv(index, key) ?? undefined;
+    }
+    setOutputKV(index, key, value) {
+        this._wasm.set_output_kv(index, key, value);
+    }
+    getOutputKV(index, key) {
+        return this._wasm.get_output_kv(index, key) ?? undefined;
+    }
     // -- Descriptor updates --
     updateInputWithDescriptor(inputIndex, descriptor) {
         this._wasm.update_input_with_descriptor(inputIndex, descriptor);

package/dist/cjs/js/fixedScriptWallet/BitGoKeySubtype.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Subtype constants for BitGo proprietary PSBT key-values.
+ * Values are loaded from the Rust enum at module init time — no duplication.
+ * The type shape is declared here for IDE support.
+ */
+export type BitGoKeySubtypeMap = {
+    readonly ZecConsensusBranchId: number;
+    readonly Musig2ParticipantPubKeys: number;
+    readonly Musig2PubNonce: number;
+    readonly Musig2PartialSig: number;
+    readonly PayGoAddressAttestationProof: number;
+    readonly Bip322Message: number;
+    readonly WasmUtxoSignedWith: number;
+};
+export declare const BitGoKeySubtype: BitGoKeySubtypeMap;
+export type BitGoKeySubtype = BitGoKeySubtypeMap[keyof BitGoKeySubtypeMap];
+/**
+ * A composable PSBT key for use with `setKV` / `getKV` / `setInputKV` / `getInputKV` etc.
+ *
+ * - `"unknown"`: stored in the PSBT `unknown` map (raw BIP-174 key-value pair)
+ * - `"proprietary"`: stored in the PSBT `proprietary` map with an arbitrary prefix
+ * - `"bitgo"`: stored in the PSBT `proprietary` map with the `BITGO` prefix
+ */
+export type PsbtKvKey = {
+    type: "unknown";
+    keyType: number;
+    data?: Uint8Array;
+} | {
+    type: "proprietary";
+    prefix: Uint8Array;
+    subtype: number;
+    key?: Uint8Array;
+} | {
+    type: "bitgo";
+    subtype: number;
+    key?: Uint8Array;
+};

package/dist/cjs/js/fixedScriptWallet/BitGoKeySubtype.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BitGoKeySubtype = void 0;
+const wasm_utxo_js_1 = require("../wasm/wasm_utxo.js");
+exports.BitGoKeySubtype = wasm_utxo_js_1.FixedScriptWalletNamespace.get_bitgo_key_subtypes();

package/dist/cjs/js/fixedScriptWallet/BitGoPsbt.d.ts

@@ -7,6 +7,7 @@ import { type ECPairArg } from "../ecpair.js";
 import type { UtxolibName } from "../utxolibCompat.js";
 import type { CoinName } from "../coinName.js";
 import type { InputScriptType } from "./scriptType.js";
+import type { PsbtKvKey } from "./BitGoKeySubtype.js";
 import { type ITransaction } from "../transaction.js";
 export type { InputScriptType };
 export type NetworkName = UtxolibName | CoinName;
@@ -301,6 +302,18 @@ export declare class BitGoPsbt implements IPsbtWithAddress {
      */
     version(): number;
     lockTime(): number;
+    /** Set an arbitrary KV pair on the PSBT global map. */
+    setKV(key: PsbtKvKey, value: Uint8Array): void;
+    /** Get a KV value from the PSBT global map. Returns `undefined` if not present. */
+    getKV(key: PsbtKvKey): Uint8Array | undefined;
+    /** Set an arbitrary KV pair on a specific PSBT input. */
+    setInputKV(index: number, key: PsbtKvKey, value: Uint8Array): void;
+    /** Get a KV value from a specific PSBT input. Returns `undefined` if not present. */
+    getInputKV(index: number, key: PsbtKvKey): Uint8Array | undefined;
+    /** Set an arbitrary KV pair on a specific PSBT output. */
+    setOutputKV(index: number, key: PsbtKvKey, value: Uint8Array): void;
+    /** Get a KV value from a specific PSBT output. Returns `undefined` if not present. */
+    getOutputKV(index: number, key: PsbtKvKey): Uint8Array | undefined;
     /**
      * Parse transaction with wallet keys to identify wallet inputs/outputs
      * @param walletKeys - The wallet keys to use for identification

package/dist/cjs/js/fixedScriptWallet/BitGoPsbt.js

@@ -257,6 +257,30 @@ class BitGoPsbt {
     lockTime() {
         return this._wasm.lock_time();
     }
+    /** Set an arbitrary KV pair on the PSBT global map. */
+    setKV(key, value) {
+        this._wasm.set_kv(key, value);
+    }
+    /** Get a KV value from the PSBT global map. Returns `undefined` if not present. */
+    getKV(key) {
+        return this._wasm.get_kv(key) ?? undefined;
+    }
+    /** Set an arbitrary KV pair on a specific PSBT input. */
+    setInputKV(index, key, value) {
+        this._wasm.set_input_kv(index, key, value);
+    }
+    /** Get a KV value from a specific PSBT input. Returns `undefined` if not present. */
+    getInputKV(index, key) {
+        return this._wasm.get_input_kv(index, key) ?? undefined;
+    }
+    /** Set an arbitrary KV pair on a specific PSBT output. */
+    setOutputKV(index, key, value) {
+        this._wasm.set_output_kv(index, key, value);
+    }
+    /** Get a KV value from a specific PSBT output. Returns `undefined` if not present. */
+    getOutputKV(index, key) {
+        return this._wasm.get_output_kv(index, key) ?? undefined;
+    }
     /**
      * Parse transaction with wallet keys to identify wallet inputs/outputs
      * @param walletKeys - The wallet keys to use for identification

package/dist/cjs/js/fixedScriptWallet/index.d.ts

@@ -6,8 +6,8 @@ export { Dimensions } from "./Dimensions.js";
 export { outputScriptTypes, inputScriptTypes, type OutputScriptType, type InputScriptType, type ScriptType, } from "./scriptType.js";
 export { ChainCode, chainCodes, assertChainCode, type Scope } from "./chains.js";
 export { BitGoPsbt, getWalletKeysFromPsbt, type NetworkName, type ScriptId, type ParsedInput, type ParsedOutput, type ParsedTransaction, type SignPath, type CreateEmptyOptions, type AddInputOptions, type AddOutputOptions, type AddWalletInputOptions, type AddWalletOutputOptions, type ParseTransactionOptions, type ParseOutputsOptions, type HydrationUnspent, } from "./BitGoPsbt.js";
+export { BitGoKeySubtype, type PsbtKvKey } from "./BitGoKeySubtype.js";
 export { ZcashBitGoPsbt, type ZcashNetworkName, type CreateEmptyZcashOptions, } from "./ZcashBitGoPsbt.js";
-export type { PsbtBip32Derivation, PsbtInputData, PsbtOutputData, PsbtOutputDataWithAddress, PsbtWitnessUtxo, } from "../wasm/wasm_utxo.js";
 import type { ScriptType } from "./scriptType.js";
 /**
  * Check if a network supports a given fixed-script wallet script type

package/dist/cjs/js/fixedScriptWallet/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ZcashBitGoPsbt = exports.getWalletKeysFromPsbt = exports.BitGoPsbt = exports.assertChainCode = exports.chainCodes = exports.ChainCode = exports.inputScriptTypes = exports.outputScriptTypes = exports.Dimensions = exports.address = exports.outputScript = exports.ReplayProtection = exports.RootWalletKeys = void 0;
+exports.ZcashBitGoPsbt = exports.BitGoKeySubtype = exports.getWalletKeysFromPsbt = exports.BitGoPsbt = exports.assertChainCode = exports.chainCodes = exports.ChainCode = exports.inputScriptTypes = exports.outputScriptTypes = exports.Dimensions = exports.address = exports.outputScript = exports.ReplayProtection = exports.RootWalletKeys = void 0;
 exports.supportsScriptType = supportsScriptType;
 exports.createOpReturnScript = createOpReturnScript;
 exports.p2shP2pkOutputScript = p2shP2pkOutputScript;
@@ -25,6 +25,8 @@ Object.defineProperty(exports, "assertChainCode", { enumerable: true, get: funct
 var BitGoPsbt_js_1 = require("./BitGoPsbt.js");
 Object.defineProperty(exports, "BitGoPsbt", { enumerable: true, get: function () { return BitGoPsbt_js_1.BitGoPsbt; } });
 Object.defineProperty(exports, "getWalletKeysFromPsbt", { enumerable: true, get: function () { return BitGoPsbt_js_1.getWalletKeysFromPsbt; } });
+var BitGoKeySubtype_js_1 = require("./BitGoKeySubtype.js");
+Object.defineProperty(exports, "BitGoKeySubtype", { enumerable: true, get: function () { return BitGoKeySubtype_js_1.BitGoKeySubtype; } });
 // Zcash-specific PSBT subclass
 var ZcashBitGoPsbt_js_1 = require("./ZcashBitGoPsbt.js");
 Object.defineProperty(exports, "ZcashBitGoPsbt", { enumerable: true, get: function () { return ZcashBitGoPsbt_js_1.ZcashBitGoPsbt; } });

package/dist/cjs/js/index.d.ts

@@ -11,6 +11,11 @@ export * as ecpair from "./ecpair.js";
 export { ECPair } from "./ecpair.js";
 export { BIP32 } from "./bip32.js";
 export { Dimensions } from "./fixedScriptWallet/Dimensions.js";
+export type WasmUtxoVersionInfo = {
+    version: string;
+    gitHash: string;
+};
+export declare function getWasmUtxoVersion(): WasmUtxoVersionInfo;
 export { type CoinName, getMainnet, isMainnet, isTestnet, isCoinName } from "./coinName.js";
 export type { Triple } from "./triple.js";
 export type { AddressFormat } from "./address.js";

package/dist/cjs/js/index.js

@@ -34,7 +34,9 @@ var __importStar = (this && this.__importStar) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.hasPsbtMagic = exports.ZcashTransaction = exports.Transaction = exports.DashTransaction = exports.Psbt = exports.Miniscript = exports.Descriptor = exports.isCoinName = exports.isTestnet = exports.isMainnet = exports.getMainnet = exports.Dimensions = exports.BIP32 = exports.ECPair = exports.ecpair = exports.bip32 = exports.descriptorWallet = exports.fixedScriptWallet = exports.utxolibCompat = exports.message = exports.inscriptions = exports.bip322 = exports.ast = exports.address = void 0;
+exports.getWasmUtxoVersion = getWasmUtxoVersion;
 const wasm = __importStar(require("./wasm/wasm_utxo.js"));
+const wasm_utxo_js_1 = require("./wasm/wasm_utxo.js");
 // we need to access the wasm module here, otherwise webpack gets all weird
 // and forgets to include it in the bundle
 void wasm;
@@ -57,15 +59,18 @@ var bip32_js_1 = require("./bip32.js");
 Object.defineProperty(exports, "BIP32", { enumerable: true, get: function () { return bip32_js_1.BIP32; } });
 var Dimensions_js_1 = require("./fixedScriptWallet/Dimensions.js");
 Object.defineProperty(exports, "Dimensions", { enumerable: true, get: function () { return Dimensions_js_1.Dimensions; } });
+function getWasmUtxoVersion() {
+    return wasm_utxo_js_1.WasmUtxoNamespace.get_wasm_utxo_version();
+}
 var coinName_js_1 = require("./coinName.js");
 Object.defineProperty(exports, "getMainnet", { enumerable: true, get: function () { return coinName_js_1.getMainnet; } });
 Object.defineProperty(exports, "isMainnet", { enumerable: true, get: function () { return coinName_js_1.isMainnet; } });
 Object.defineProperty(exports, "isTestnet", { enumerable: true, get: function () { return coinName_js_1.isTestnet; } });
 Object.defineProperty(exports, "isCoinName", { enumerable: true, get: function () { return coinName_js_1.isCoinName; } });
-var wasm_utxo_js_1 = require("./wasm/wasm_utxo.js");
-Object.defineProperty(exports, "Descriptor", { enumerable: true, get: function () { return wasm_utxo_js_1.WrapDescriptor; } });
 var wasm_utxo_js_2 = require("./wasm/wasm_utxo.js");
-Object.defineProperty(exports, "Miniscript", { enumerable: true, get: function () { return wasm_utxo_js_2.WrapMiniscript; } });
+Object.defineProperty(exports, "Descriptor", { enumerable: true, get: function () { return wasm_utxo_js_2.WrapDescriptor; } });
+var wasm_utxo_js_3 = require("./wasm/wasm_utxo.js");
+Object.defineProperty(exports, "Miniscript", { enumerable: true, get: function () { return wasm_utxo_js_3.WrapMiniscript; } });
 var Psbt_js_1 = require("./descriptorWallet/Psbt.js");
 Object.defineProperty(exports, "Psbt", { enumerable: true, get: function () { return Psbt_js_1.Psbt; } });
 var transaction_js_1 = require("./transaction.js");

package/dist/cjs/js/psbt.d.ts

@@ -1,6 +1,7 @@
 import type { PsbtInputData, PsbtOutputData, PsbtOutputDataWithAddress } from "./wasm/wasm_utxo.js";
 import type { BIP32 } from "./bip32.js";
 import type { ITransactionCommon } from "./transaction.js";
+import type { PsbtKvKey } from "./fixedScriptWallet/BitGoKeySubtype.js";
 /** Common interface for PSBT types */
 export interface IPsbt extends ITransactionCommon<PsbtInputData, PsbtOutputData> {
     getGlobalXpubs(): BIP32[];
@@ -9,6 +10,12 @@ export interface IPsbt extends ITransactionCommon<PsbtInputData, PsbtOutputData>
     addOutputAtIndex(index: number, script: Uint8Array, value: bigint): number;
     removeInput(index: number): void;
     removeOutput(index: number): void;
+    setKV(key: PsbtKvKey, value: Uint8Array): void;
+    getKV(key: PsbtKvKey): Uint8Array | undefined;
+    setInputKV(index: number, key: PsbtKvKey, value: Uint8Array): void;
+    getInputKV(index: number, key: PsbtKvKey): Uint8Array | undefined;
+    setOutputKV(index: number, key: PsbtKvKey, value: Uint8Array): void;
+    getOutputKV(index: number, key: PsbtKvKey): Uint8Array | undefined;
 }
 /** Extended PSBT with address resolution (no coin parameter needed) */
 export interface IPsbtWithAddress extends IPsbt {

package/dist/cjs/js/wasm/wasm_utxo.d.ts

@@ -334,7 +334,15 @@ export class BitGoPsbt {
      */
     generate_musig2_nonces(xpriv: WasmBIP32, session_id_bytes?: Uint8Array | null): void;
     get_global_xpubs(): any;
+    /**
+     * Get a KV value from a specific PSBT input. Returns `undefined` if not present.
+     */
+    get_input_kv(index: number, key: any): Uint8Array | undefined;
     get_inputs(): any;
+    /**
+     * Get a KV value from the PSBT global map. Returns `undefined` if not present.
+     */
+    get_kv(key: any): Uint8Array | undefined;
     /**
      * Get the network type for transaction extraction
      *
@@ -342,6 +350,10 @@ export class BitGoPsbt {
      * wrapper class should be used in TypeScript.
      */
     get_network_type(): string;
+    /**
+     * Get a KV value from a specific PSBT output. Returns `undefined` if not present.
+     */
+    get_output_kv(index: number, key: any): Uint8Array | undefined;
     get_outputs(): any;
     get_outputs_with_address(): any;
     input_count(): number;
@@ -384,6 +396,21 @@ export class BitGoPsbt {
      * The serialized PSBT as a byte array
      */
     serialize(): Uint8Array;
+    /**
+     * Set an arbitrary KV pair on a specific PSBT input.
+     */
+    set_input_kv(index: number, key: any, value: Uint8Array): void;
+    /**
+     * Set an arbitrary KV pair on the PSBT global map.
+     * `key` must be `{ type: "unknown", keyType: number, data?: Uint8Array }` or
+     * `{ type: "proprietary", prefix: Uint8Array, subtype: number, key?: Uint8Array }` or
+     * `{ type: "bitgo", subtype: number, key?: Uint8Array }`.
+     */
+    set_kv(key: any, value: Uint8Array): void;
+    /**
+     * Set an arbitrary KV pair on a specific PSBT output.
+     */
+    set_output_kv(index: number, key: any, value: Uint8Array): void;
     /**
      * Sign all MuSig2 keypath inputs in a single pass with optimized sighash computation.
      *
@@ -676,6 +703,11 @@ export class FixedScriptWalletNamespace {
      * The OP_RETURN script as bytes
      */
     static create_op_return_script(data?: Uint8Array | null): Uint8Array;
+    /**
+     * Returns an object mapping BitGo proprietary key subtype names to their `u8` values.
+     * Values are loaded directly from the Rust enum at build time — no duplication in TypeScript.
+     */
+    static get_bitgo_key_subtypes(): any;
     static output_script(keys: WasmRootWalletKeys, chain: number, index: number, network: any): Uint8Array;
     static output_script_with_network_str(keys: WasmRootWalletKeys, chain: number, index: number, network: string): Uint8Array;
     /**
@@ -1234,6 +1266,19 @@ export class WasmTransaction {
     version(): number;
 }
 
+/**
+ * Top-level package info namespace
+ */
+export class WasmUtxoNamespace {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Returns the wasm-utxo build version as `{ version: string, gitHash: string }`.
+     */
+    static get_wasm_utxo_version(): any;
+}
+
 /**
  * A Zcash transaction with network-specific fields
  *
@@ -1356,7 +1401,10 @@ export class WrapPsbt {
     extract_transaction(): WasmTransaction;
     finalize_mut(): void;
     get_global_xpubs(): any;
+    get_input_kv(index: number, key: any): Uint8Array | undefined;
     get_inputs(): any;
+    get_kv(key: any): Uint8Array | undefined;
+    get_output_kv(index: number, key: any): Uint8Array | undefined;
     get_outputs(): any;
     get_outputs_with_address(coin: string): any;
     get_partial_signatures(input_index: number): any;
@@ -1382,6 +1430,9 @@ export class WrapPsbt {
     remove_input(index: number): void;
     remove_output(index: number): void;
     serialize(): Uint8Array;
+    set_input_kv(index: number, key: any, value: Uint8Array): void;
+    set_kv(key: any, value: Uint8Array): void;
+    set_output_kv(index: number, key: any, value: Uint8Array): void;
     /**
      * Sign all inputs with a WasmBIP32 key
      *