@bitgo/wasm-utxo 4.3.0 → 4.5.0

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

@@ -8,7 +8,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 ITransaction } from "../transaction.js";
+import { Transaction, DashTransaction, type ITransaction } from "../transaction.js";
 export type { InputScriptType };
 export type NetworkName = UtxolibName | CoinName;
 export type ScriptId = {
@@ -151,12 +151,17 @@ export declare class BitGoPsbt extends PsbtBase<WasmBitGoPsbt> implements IPsbtW
      * with proper wallet metadata (bip32Derivation, scripts, witnessUtxo).
      * Only supports p2sh, p2shP2wsh, and p2wsh inputs (not taproot).
      *
-     * @param txBytes - The serialized half-signed legacy transaction
+     * Supports both Bitcoin-like coins (BTC, LTC, DOGE) and Dash (DASH).
+     * Zcash is NOT supported; use ZcashBitGoPsbt.fromHalfSignedLegacyTransaction instead.
+     *
+     * @param txBytesOrTx - Transaction bytes or decoded transaction instance (Bitcoin-like or Dash)
      * @param network - Network name
      * @param walletKeys - The wallet's root keys
      * @param unspents - Chain, index, and value for each input
+     * @param _options - Reserved for future use and signature compatibility with subclasses
+     * @throws Error if transaction is Zcash (use ZcashBitGoPsbt.fromHalfSignedLegacyTransaction instead)
      */
-    static fromHalfSignedLegacyTransaction(txBytes: Uint8Array, network: NetworkName, walletKeys: WalletKeysArg, unspents: HydrationUnspent[]): BitGoPsbt;
+    static fromHalfSignedLegacyTransaction(txBytesOrTx: Uint8Array | Transaction | DashTransaction, network: NetworkName, walletKeys: WalletKeysArg, unspents: HydrationUnspent[], _options?: unknown): BitGoPsbt;
     /**
      * Add an input to the PSBT
      *

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

@@ -8,6 +8,7 @@ const RootWalletKeys_js_1 = require("./RootWalletKeys.js");
 const ReplayProtection_js_1 = require("./ReplayProtection.js");
 const bip32_js_1 = require("../bip32.js");
 const ecpair_js_1 = require("../ecpair.js");
+const coinName_js_1 = require("../coinName.js");
 const transaction_js_1 = require("../transaction.js");
 class BitGoPsbt extends psbtBase_js_1.PsbtBase {
     constructor(wasm) {
@@ -64,14 +65,32 @@ class BitGoPsbt extends psbtBase_js_1.PsbtBase {
      * with proper wallet metadata (bip32Derivation, scripts, witnessUtxo).
      * Only supports p2sh, p2shP2wsh, and p2wsh inputs (not taproot).
      *
-     * @param txBytes - The serialized half-signed legacy transaction
+     * Supports both Bitcoin-like coins (BTC, LTC, DOGE) and Dash (DASH).
+     * Zcash is NOT supported; use ZcashBitGoPsbt.fromHalfSignedLegacyTransaction instead.
+     *
+     * @param txBytesOrTx - Transaction bytes or decoded transaction instance (Bitcoin-like or Dash)
      * @param network - Network name
      * @param walletKeys - The wallet's root keys
      * @param unspents - Chain, index, and value for each input
+     * @param _options - Reserved for future use and signature compatibility with subclasses
+     * @throws Error if transaction is Zcash (use ZcashBitGoPsbt.fromHalfSignedLegacyTransaction instead)
      */
-    static fromHalfSignedLegacyTransaction(txBytes, network, walletKeys, unspents) {
+    static fromHalfSignedLegacyTransaction(txBytesOrTx, network, walletKeys, unspents, 
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    _options) {
         const keys = RootWalletKeys_js_1.RootWalletKeys.from(walletKeys);
-        const wasm = wasm_utxo_js_1.BitGoPsbt.from_half_signed_legacy_transaction(txBytes, network, keys.wasm, unspents);
+        // Parse bytes to Transaction if needed
+        const tx = txBytesOrTx instanceof Uint8Array
+            ? transaction_js_1.Transaction.fromBytes(txBytesOrTx, (0, coinName_js_1.toCoinName)(network))
+            : txBytesOrTx;
+        // Validate that this is not a Zcash transaction
+        if (tx instanceof transaction_js_1.ZcashTransaction) {
+            throw new Error("Use ZcashBitGoPsbt.fromHalfSignedLegacyTransaction() for Zcash transactions");
+        }
+        // Pass WASM transaction directly to avoid serialization round-trip
+        const wasm = tx instanceof transaction_js_1.DashTransaction
+            ? wasm_utxo_js_1.BitGoPsbt.from_half_signed_legacy_transaction_dash(tx.wasm, network, keys.wasm, unspents)
+            : wasm_utxo_js_1.BitGoPsbt.from_half_signed_legacy_transaction(tx.wasm, network, keys.wasm, unspents);
         return new BitGoPsbt(wasm);
     }
     addInputAtIndex(index, txidOrOptions, voutOrScript, value, script, sequence) {

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

@@ -1,6 +1,6 @@
 import { type WalletKeysArg } from "./RootWalletKeys.js";
-import { BitGoPsbt, type CreateEmptyOptions } from "./BitGoPsbt.js";
-import { ZcashTransaction } from "../transaction.js";
+import { BitGoPsbt, type CreateEmptyOptions, type HydrationUnspent } from "./BitGoPsbt.js";
+import { ZcashTransaction, type ITransaction } from "../transaction.js";
 /** Zcash network names */
 export type ZcashNetworkName = "zcash" | "zcashTest" | "zec" | "tzec";
 /** Options for creating an empty Zcash PSBT (preferred method using block height) */
@@ -101,6 +101,51 @@ export declare class ZcashBitGoPsbt extends BitGoPsbt {
      * @returns A ZcashBitGoPsbt instance
      */
     static fromBytes(bytes: Uint8Array, network: ZcashNetworkName): ZcashBitGoPsbt;
+    /**
+     * Reconstruct a Zcash PSBT from a half-signed legacy transaction
+     *
+     * This is the inverse of `getHalfSignedLegacyFormat()` for Zcash. It decodes the Zcash wire
+     * format (which includes version_group_id, expiry_height, and sapling fields), extracts
+     * partial signatures, and reconstructs a proper Zcash PSBT with consensus metadata.
+     *
+     * Supports two modes for determining consensus_branch_id:
+     * - **Recommended**: Pass `blockHeight` to auto-determine consensus_branch_id via network upgrade activation heights
+     * - **Advanced**: Pass `consensusBranchId` directly if you already know it (e.g., 0xC2D6D0B4 for NU5)
+     *
+     * @param txBytesOrTx - Either serialized Zcash transaction bytes or a decoded ZcashTransaction instance
+     * @param network - Zcash network name ("zcash", "zcashTest", "zec", "tzec")
+     * @param walletKeys - The wallet's root keys
+     * @param unspents - Chain, index, and value for each input
+     * @param options - Either `{ blockHeight: number }` or `{ consensusBranchId: number }`
+     * @returns A ZcashBitGoPsbt instance
+     *
+     * @example
+     * ```typescript
+     * // Round-trip with block height (recommended)
+     * const legacyBytes = psbt.getHalfSignedLegacyFormat();
+     * const reconstructed = ZcashBitGoPsbt.fromHalfSignedLegacyTransaction(
+     *   legacyBytes,
+     *   "zec",
+     *   walletKeys,
+     *   unspents,
+     *   { blockHeight: 1687105 }  // NU5 activation height
+     * );
+     *
+     * // Or with explicit consensus branch ID
+     * const reconstructed = ZcashBitGoPsbt.fromHalfSignedLegacyTransaction(
+     *   legacyBytes,
+     *   "zec",
+     *   walletKeys,
+     *   unspents,
+     *   { consensusBranchId: 0xC2D6D0B4 }  // NU5 branch ID
+     * );
+     * ```
+     */
+    static fromHalfSignedLegacyTransaction(txBytesOrTx: Uint8Array | ITransaction, network: ZcashNetworkName, walletKeys: WalletKeysArg, unspents: HydrationUnspent[], options: {
+        blockHeight: number;
+    } | {
+        consensusBranchId: number;
+    }): ZcashBitGoPsbt;
     /**
      * Get the Zcash version group ID
      * @returns The version group ID (e.g., 0x892F2085 for Sapling)

package/dist/cjs/js/fixedScriptWallet/ZcashBitGoPsbt.js

@@ -96,6 +96,60 @@ class ZcashBitGoPsbt extends BitGoPsbt_js_1.BitGoPsbt {
         const wasm = wasm_utxo_js_1.BitGoPsbt.from_bytes(bytes, network);
         return new ZcashBitGoPsbt(wasm);
     }
+    /**
+     * Reconstruct a Zcash PSBT from a half-signed legacy transaction
+     *
+     * This is the inverse of `getHalfSignedLegacyFormat()` for Zcash. It decodes the Zcash wire
+     * format (which includes version_group_id, expiry_height, and sapling fields), extracts
+     * partial signatures, and reconstructs a proper Zcash PSBT with consensus metadata.
+     *
+     * Supports two modes for determining consensus_branch_id:
+     * - **Recommended**: Pass `blockHeight` to auto-determine consensus_branch_id via network upgrade activation heights
+     * - **Advanced**: Pass `consensusBranchId` directly if you already know it (e.g., 0xC2D6D0B4 for NU5)
+     *
+     * @param txBytesOrTx - Either serialized Zcash transaction bytes or a decoded ZcashTransaction instance
+     * @param network - Zcash network name ("zcash", "zcashTest", "zec", "tzec")
+     * @param walletKeys - The wallet's root keys
+     * @param unspents - Chain, index, and value for each input
+     * @param options - Either `{ blockHeight: number }` or `{ consensusBranchId: number }`
+     * @returns A ZcashBitGoPsbt instance
+     *
+     * @example
+     * ```typescript
+     * // Round-trip with block height (recommended)
+     * const legacyBytes = psbt.getHalfSignedLegacyFormat();
+     * const reconstructed = ZcashBitGoPsbt.fromHalfSignedLegacyTransaction(
+     *   legacyBytes,
+     *   "zec",
+     *   walletKeys,
+     *   unspents,
+     *   { blockHeight: 1687105 }  // NU5 activation height
+     * );
+     *
+     * // Or with explicit consensus branch ID
+     * const reconstructed = ZcashBitGoPsbt.fromHalfSignedLegacyTransaction(
+     *   legacyBytes,
+     *   "zec",
+     *   walletKeys,
+     *   unspents,
+     *   { consensusBranchId: 0xC2D6D0B4 }  // NU5 branch ID
+     * );
+     * ```
+     */
+    static fromHalfSignedLegacyTransaction(txBytesOrTx, network, walletKeys, unspents, options) {
+        const keys = RootWalletKeys_js_1.RootWalletKeys.from(walletKeys);
+        const tx = txBytesOrTx instanceof Uint8Array
+            ? transaction_js_1.ZcashTransaction.fromBytes(txBytesOrTx)
+            : txBytesOrTx;
+        if ("blockHeight" in options) {
+            const wasm = wasm_utxo_js_1.BitGoPsbt.from_half_signed_legacy_transaction_zcash_with_block_height(tx.wasm, network, keys.wasm, unspents, options.blockHeight);
+            return new ZcashBitGoPsbt(wasm);
+        }
+        else {
+            const wasm = wasm_utxo_js_1.BitGoPsbt.from_half_signed_legacy_transaction_zcash_with_branch_id(tx.wasm, network, keys.wasm, unspents, options.consensusBranchId);
+            return new ZcashBitGoPsbt(wasm);
+        }
+    }
     // --- Zcash-specific getters ---
     /**
      * Get the Zcash version group ID

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

@@ -1,6 +1,6 @@
 import type { OutputScriptType } from "./scriptType.js";
 /** All valid chain codes as a const tuple */
-export declare const chainCodes: readonly [0, 1, 10, 11, 20, 21, 30, 31, 40, 41];
+export declare const chainCodes: readonly [0, 1, 10, 11, 20, 21, 30, 31, 40, 41, 360, 361];
 /** A valid chain code value */
 export type ChainCode = (typeof chainCodes)[number];
 /** Whether a chain is for receiving (external) or change (internal) addresses */

package/dist/cjs/js/fixedScriptWallet/chains.js

@@ -10,7 +10,7 @@ exports.assertChainCode = assertChainCode;
  */
 const wasm_utxo_js_1 = require("../wasm/wasm_utxo.js");
 /** All valid chain codes as a const tuple */
-exports.chainCodes = [0, 1, 10, 11, 20, 21, 30, 31, 40, 41];
+exports.chainCodes = [0, 1, 10, 11, 20, 21, 30, 31, 40, 41, 360, 361];
 // Build static lookup tables once at module load time
 const chainCodeSet = new Set(exports.chainCodes);
 const chainToMeta = new Map();

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

@@ -12,10 +12,13 @@ export interface IPsbt extends ITransactionCommon<PsbtInputData, PsbtOutputData>
     removeOutput(index: number): void;
     setKV(key: PsbtKvKey, value: Uint8Array): void;
     getKV(key: PsbtKvKey): Uint8Array | undefined;
+    deleteKV(key: PsbtKvKey): void;
     setInputKV(index: number, key: PsbtKvKey, value: Uint8Array): void;
     getInputKV(index: number, key: PsbtKvKey): Uint8Array | undefined;
+    deleteInputKV(index: number, key: PsbtKvKey): void;
     setOutputKV(index: number, key: PsbtKvKey, value: Uint8Array): void;
     getOutputKV(index: number, key: PsbtKvKey): Uint8Array | undefined;
+    deleteOutputKV(index: number, key: PsbtKvKey): void;
 }
 /** Extended PSBT with address resolution (no coin parameter needed) */
 export interface IPsbtWithAddress extends IPsbt {

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

@@ -15,10 +15,13 @@ interface WasmPsbtBase {
     remove_output(index: number): void;
     set_kv(key: unknown, value: Uint8Array): void;
     get_kv(key: unknown): Uint8Array | null | undefined;
+    delete_kv(key: unknown): void;
     set_input_kv(index: number, key: unknown, value: Uint8Array): void;
     get_input_kv(index: number, key: unknown): Uint8Array | null | undefined;
+    delete_input_kv(index: number, key: unknown): void;
     set_output_kv(index: number, key: unknown, value: Uint8Array): void;
     get_output_kv(index: number, key: unknown): Uint8Array | null | undefined;
+    delete_output_kv(index: number, key: unknown): void;
 }
 export declare abstract class PsbtBase<W extends WasmPsbtBase> {
     protected _wasm: W;
@@ -40,5 +43,8 @@ export declare abstract class PsbtBase<W extends WasmPsbtBase> {
     getInputKV(index: number, key: PsbtKvKey): Uint8Array | undefined;
     setOutputKV(index: number, key: PsbtKvKey, value: Uint8Array): void;
     getOutputKV(index: number, key: PsbtKvKey): Uint8Array | undefined;
+    deleteKV(key: PsbtKvKey): void;
+    deleteInputKV(index: number, key: PsbtKvKey): void;
+    deleteOutputKV(index: number, key: PsbtKvKey): void;
 }
 export {};

package/dist/cjs/js/psbtBase.js

@@ -58,5 +58,14 @@ class PsbtBase {
     getOutputKV(index, key) {
         return this._wasm.get_output_kv(index, key) ?? undefined;
     }
+    deleteKV(key) {
+        this._wasm.delete_kv(key);
+    }
+    deleteInputKV(index, key) {
+        this._wasm.delete_input_kv(index, key);
+    }
+    deleteOutputKV(index, key) {
+        this._wasm.delete_output_kv(index, key);
+    }
 }
 exports.PsbtBase = PsbtBase;

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

@@ -24,11 +24,19 @@ export interface ITransaction extends ITransactionCommon<TxInputData, TxOutputDa
  */
 export declare class Transaction extends TransactionBase<WasmTransaction> {
     private constructor();
+    /**
+     * Check if a coin is supported by this transaction class.
+     * Bitcoin-like transactions support all coins except Zcash and Dash.
+     */
+    static supportsCoin(coin: CoinName): boolean;
     /**
      * Create an empty transaction (version 1, locktime 0)
      */
     static create(): Transaction;
     static fromBytes(bytes: Uint8Array): Transaction;
+    static fromBytes(bytes: Uint8Array, coin: "zec" | "tzec"): ZcashTransaction;
+    static fromBytes(bytes: Uint8Array, coin: "dash" | "tdash"): DashTransaction;
+    static fromBytes(bytes: Uint8Array, coin: CoinName): Transaction | ZcashTransaction | DashTransaction;
     /** @internal Create from WASM instance directly (avoids re-parsing bytes) */
     static fromWasm(wasm: WasmTransaction): Transaction;
     /**
@@ -60,6 +68,11 @@ export declare class Transaction extends TransactionBase<WasmTransaction> {
  */
 export declare class ZcashTransaction extends TransactionBase<WasmZcashTransaction> {
     private constructor();
+    /**
+     * Check if a coin is supported by this transaction class.
+     * Zcash transactions support Zcash mainnet and testnet.
+     */
+    static supportsCoin(coin: CoinName): boolean;
     static fromBytes(bytes: Uint8Array): ZcashTransaction;
     /** @internal Create from WASM instance directly (avoids re-parsing bytes) */
     static fromWasm(wasm: WasmZcashTransaction): ZcashTransaction;
@@ -73,6 +86,11 @@ export declare class ZcashTransaction extends TransactionBase<WasmZcashTransacti
  */
 export declare class DashTransaction extends TransactionBase<WasmDashTransaction> {
     private constructor();
+    /**
+     * Check if a coin is supported by this transaction class.
+     * Dash transactions support Dash mainnet and testnet.
+     */
+    static supportsCoin(coin: CoinName): boolean;
     static fromBytes(bytes: Uint8Array): DashTransaction;
     /** @internal Create from WASM instance directly (avoids re-parsing bytes) */
     static fromWasm(wasm: WasmDashTransaction): DashTransaction;

package/dist/cjs/js/transaction.js

@@ -12,13 +12,26 @@ class Transaction extends transactionBase_js_1.TransactionBase {
     constructor(wasm) {
         super(wasm);
     }
+    /**
+     * Check if a coin is supported by this transaction class.
+     * Bitcoin-like transactions support all coins except Zcash and Dash.
+     */
+    static supportsCoin(coin) {
+        return !ZcashTransaction.supportsCoin(coin) && !DashTransaction.supportsCoin(coin);
+    }
     /**
      * Create an empty transaction (version 1, locktime 0)
      */
     static create() {
         return new Transaction(wasm_utxo_js_1.WasmTransaction.create());
     }
-    static fromBytes(bytes) {
+    static fromBytes(bytes, coin) {
+        if (coin !== undefined) {
+            if (ZcashTransaction.supportsCoin(coin))
+                return ZcashTransaction.fromBytes(bytes);
+            if (DashTransaction.supportsCoin(coin))
+                return DashTransaction.fromBytes(bytes);
+        }
         return new Transaction(wasm_utxo_js_1.WasmTransaction.from_bytes(bytes));
     }
     /** @internal Create from WASM instance directly (avoids re-parsing bytes) */
@@ -69,6 +82,13 @@ class ZcashTransaction extends transactionBase_js_1.TransactionBase {
     constructor(wasm) {
         super(wasm);
     }
+    /**
+     * Check if a coin is supported by this transaction class.
+     * Zcash transactions support Zcash mainnet and testnet.
+     */
+    static supportsCoin(coin) {
+        return coin === "zec" || coin === "tzec";
+    }
     static fromBytes(bytes) {
         return new ZcashTransaction(wasm_utxo_js_1.WasmZcashTransaction.from_bytes(bytes));
     }
@@ -91,6 +111,13 @@ class DashTransaction extends transactionBase_js_1.TransactionBase {
     constructor(wasm) {
         super(wasm);
     }
+    /**
+     * Check if a coin is supported by this transaction class.
+     * Dash transactions support Dash mainnet and testnet.
+     */
+    static supportsCoin(coin) {
+        return coin === "dash" || coin === "tdash";
+    }
     static fromBytes(bytes) {
         return new DashTransaction(wasm_utxo_js_1.WasmDashTransaction.from_bytes(bytes));
     }

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

@@ -221,6 +221,9 @@ export class BitGoPsbt {
      * Returns error if block height is before Overwinter activation
      */
     static create_empty_zcash_at_height(network: string, wallet_keys: WasmRootWalletKeys, block_height: number, version?: number | null, lock_time?: number | null, version_group_id?: number | null, expiry_height?: number | null): BitGoPsbt;
+    delete_input_kv(index: number, key: any): void;
+    delete_kv(key: any): void;
+    delete_output_kv(index: number, key: any): void;
     /**
      * Get the Zcash expiry height (returns None for non-Zcash PSBTs)
      */
@@ -298,12 +301,45 @@ export class BitGoPsbt {
      * Convert a half-signed legacy transaction to a psbt-lite.
      *
      * # Arguments
-     * * `tx_bytes` - The serialized half-signed legacy transaction
+     * * `tx` - The decoded half-signed legacy transaction
      * * `network` - Network name (utxolib or coin name)
      * * `wallet_keys` - The wallet's root keys
      * * `unspents` - Array of `{ chain: number, index: number, value: bigint }` for each input
      */
-    static from_half_signed_legacy_transaction(tx_bytes: Uint8Array, network: string, wallet_keys: WasmRootWalletKeys, unspents: any): BitGoPsbt;
+    static from_half_signed_legacy_transaction(tx: WasmTransaction, network: string, wallet_keys: WasmRootWalletKeys, unspents: any): BitGoPsbt;
+    /**
+     * Convert a half-signed legacy Dash transaction to a psbt-lite.
+     *
+     * # Arguments
+     * * `tx` - The decoded Dash transaction
+     * * `network` - Network name ("dash" or "tdash")
+     * * `wallet_keys` - The wallet's root keys
+     * * `unspents` - Array of `{ chain: number, index: number, value: bigint }` for each input
+     */
+    static from_half_signed_legacy_transaction_dash(tx: WasmDashTransaction, network: string, wallet_keys: WasmRootWalletKeys, unspents: any): BitGoPsbt;
+    /**
+     * Convert a half-signed legacy Zcash transaction to a psbt-lite (with block height).
+     * Thin wrapper: resolves block_height → consensus_branch_id and delegates to the explicit variant.
+     *
+     * # Arguments
+     * * `tx` - The decoded Zcash transaction
+     * * `network` - Network name ("zec" or "tzec")
+     * * `wallet_keys` - The wallet's root keys
+     * * `unspents` - Array of `{ chain: number, index: number, value: bigint }` for each input
+     * * `block_height` - Block height to determine consensus branch ID
+     */
+    static from_half_signed_legacy_transaction_zcash_with_block_height(tx: WasmZcashTransaction, network: string, wallet_keys: WasmRootWalletKeys, unspents: any, block_height: number): BitGoPsbt;
+    /**
+     * Convert a half-signed legacy Zcash transaction to a psbt-lite (with consensus branch ID).
+     *
+     * # Arguments
+     * * `tx` - The decoded Zcash transaction
+     * * `network` - Network name ("zec" or "tzec")
+     * * `wallet_keys` - The wallet's root keys
+     * * `unspents` - Array of `{ chain: number, index: number, value: bigint }` for each input
+     * * `consensus_branch_id` - Zcash consensus branch ID
+     */
+    static from_half_signed_legacy_transaction_zcash_with_branch_id(tx: WasmZcashTransaction, network: string, wallet_keys: WasmRootWalletKeys, unspents: any, consensus_branch_id: number): BitGoPsbt;
     /**
      * Generate and store MuSig2 nonces for all MuSig2 inputs
      *
@@ -1363,6 +1399,9 @@ export class WrapPsbt {
      */
     add_output_at_index(index: number, script: Uint8Array, value: bigint): number;
     clone(): WrapPsbt;
+    delete_input_kv(index: number, key: any): void;
+    delete_kv(key: any): void;
+    delete_output_kv(index: number, key: any): void;
     static deserialize(psbt: Uint8Array): WrapPsbt;
     /**
      * Extract the final transaction from a finalized PSBT