@bitgo/wasm-utxo 1.14.1 → 1.16.0

package/README.md

@@ -20,7 +20,16 @@ This project is under active development.
 | Descriptor Wallet: Address Support      | ✅ Complete | 🚫          | 🚫          | 🚫          | 🚫          | 🚫          | 🚫          |
 | Descriptor Wallet: Transaction Support  | ✅ Complete | 🚫          | 🚫          | 🚫          | 🚫          | 🚫          | 🚫          |
 | FixedScript Wallet: Address Generation  | ✅ Complete | ✅ Complete | ✅ Complete | ✅ Complete | ✅ Complete | ✅ Complete | ✅ Complete |
-| FixedScript Wallet: Transaction Support | ✅ Complete | ✅ Complete | ✅ Complete | ⏳ TODO     | ⏳ TODO     | ✅ Complete | ⏳ TODO     |
+| FixedScript Wallet: Transaction Support | ✅ Complete | ✅ Complete | ✅ Complete | ⏳ TODO     | ⏳ TODO     | ✅ Complete | ✅ Complete |
+
+### Zcash Features
+
+Zcash support includes:
+
+- **Network Upgrade Awareness**: Automatic consensus branch ID determination based on block height
+- **All Network Upgrades**: Support for Overwinter, Sapling, Blossom, Heartwood, Canopy, Nu5, Nu6, and Nu6_1
+- **Height-Based API**: Preferred `createEmpty()` method automatically selects correct consensus rules
+- **Parity Testing**: Validated against `zebra-chain` for accuracy across all network upgrades
 
 ## Building
 

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

@@ -1,3 +1,4 @@
+import { BitGoPsbt as WasmBitGoPsbt } from "../wasm/wasm_utxo.js";
 import { type WalletKeysArg } from "./RootWalletKeys.js";
 import { type ReplayProtectionArg } from "./ReplayProtection.js";
 import { type BIP32Arg } from "../bip32.js";
@@ -21,6 +22,7 @@ export type ParsedInput = {
     value: bigint;
     scriptId: ScriptId | null;
     scriptType: InputScriptType;
+    sequence: number;
 };
 export type ParsedOutput = {
     address: string | null;
@@ -36,9 +38,79 @@ export type ParsedTransaction = {
     minerFee: bigint;
     virtualSize: number;
 };
+export type CreateEmptyOptions = {
+    /** Transaction version (default: 2) */
+    version?: number;
+    /** Lock time (default: 0) */
+    lockTime?: number;
+};
+export type AddInputOptions = {
+    /** Previous transaction ID (hex string) */
+    txid: string;
+    /** Output index being spent */
+    vout: number;
+    /** Value in satoshis (for witness_utxo) */
+    value: bigint;
+    /** Sequence number (default: 0xFFFFFFFE for RBF) */
+    sequence?: number;
+    /** Full previous transaction (for non-segwit strict compliance) */
+    prevTx?: Uint8Array;
+};
+export type AddOutputOptions = {
+    /** Output script (scriptPubKey) */
+    script: Uint8Array;
+    /** Value in satoshis */
+    value: bigint;
+};
+/** Key identifier for signing ("user", "backup", or "bitgo") */
+export type SignerKey = "user" | "backup" | "bitgo";
+/** Specifies signer and cosigner for Taproot inputs */
+export type SignPath = {
+    /** Key that will sign */
+    signer: SignerKey;
+    /** Key that will co-sign */
+    cosigner: SignerKey;
+};
+export type AddWalletInputOptions = {
+    /** Script location in wallet (chain + index) */
+    scriptId: ScriptId;
+    /** Sign path - required for p2tr/p2trMusig2 (chains 30-41) */
+    signPath?: SignPath;
+};
+export type AddWalletOutputOptions = {
+    /** Chain code (0/1=p2sh, 10/11=p2shP2wsh, 20/21=p2wsh, 30/31=p2tr, 40/41=p2trMusig2) */
+    chain: number;
+    /** Derivation index */
+    index: number;
+    /** Value in satoshis */
+    value: bigint;
+};
 export declare class BitGoPsbt {
-    private wasm;
-    private constructor();
+    protected wasm: WasmBitGoPsbt;
+    protected constructor(wasm: WasmBitGoPsbt);
+    /**
+     * Create an empty PSBT for the given network with wallet keys
+     *
+     * The wallet keys are used to set global xpubs in the PSBT, which identifies
+     * the keys that will be used for signing.
+     *
+     * For Zcash networks, use ZcashBitGoPsbt.createEmpty() instead.
+     *
+     * @param network - Network name (utxolib name like "bitcoin" or coin name like "btc")
+     * @param walletKeys - The wallet's root keys (sets global xpubs in the PSBT)
+     * @param options - Optional transaction parameters (version, lockTime)
+     * @returns A new empty BitGoPsbt instance
+     *
+     * @example
+     * ```typescript
+     * // Create empty PSBT with wallet keys
+     * const psbt = BitGoPsbt.createEmpty("bitcoin", walletKeys);
+     *
+     * // Create with custom version and lockTime
+     * const psbt = BitGoPsbt.createEmpty("bitcoin", walletKeys, { version: 1, lockTime: 500000 });
+     * ```
+     */
+    static createEmpty(network: NetworkName, walletKeys: WalletKeysArg, options?: CreateEmptyOptions): BitGoPsbt;
     /**
      * Deserialize a PSBT from bytes
      * @param bytes - The PSBT bytes
@@ -46,11 +118,147 @@ export declare class BitGoPsbt {
      * @returns A BitGoPsbt instance
      */
     static fromBytes(bytes: Uint8Array, network: NetworkName): BitGoPsbt;
+    /**
+     * Add an input to the PSBT
+     *
+     * This adds a transaction input and corresponding PSBT input metadata.
+     * The witness_utxo is automatically populated for modern signing compatibility.
+     *
+     * @param options - Input options (txid, vout, value, sequence)
+     * @param script - Output script of the UTXO being spent
+     * @returns The index of the newly added input
+     *
+     * @example
+     * ```typescript
+     * const inputIndex = psbt.addInput({
+     *   txid: "abc123...",
+     *   vout: 0,
+     *   value: 100000n,
+     * }, outputScript);
+     * ```
+     */
+    addInput(options: AddInputOptions, script: Uint8Array): number;
+    /**
+     * Add an output to the PSBT
+     *
+     * @param options - Output options (script, value)
+     * @returns The index of the newly added output
+     *
+     * @example
+     * ```typescript
+     * const outputIndex = psbt.addOutput({
+     *   script: outputScript,
+     *   value: 50000n,
+     * });
+     * ```
+     */
+    addOutput(options: AddOutputOptions): number;
+    /**
+     * Add a wallet input with full PSBT metadata
+     *
+     * This is a higher-level method that adds an input and populates all required
+     * PSBT fields (scripts, derivation info, etc.) based on the wallet's chain type.
+     *
+     * For p2sh/p2shP2wsh/p2wsh: Sets bip32Derivation, witnessScript, redeemScript (signPath not needed)
+     * For p2tr/p2trMusig2 script path: Sets tapLeafScript, tapBip32Derivation (signPath required)
+     * For p2trMusig2 key path: Sets tapInternalKey, tapMerkleRoot, tapBip32Derivation, musig2 participants (signPath required)
+     *
+     * @param inputOptions - Common input options (txid, vout, value, sequence)
+     * @param walletKeys - The wallet's root keys
+     * @param walletOptions - Wallet-specific options (scriptId, signPath, prevTx)
+     * @returns The index of the newly added input
+     *
+     * @example
+     * ```typescript
+     * // Add a p2shP2wsh input (signPath not needed)
+     * const inputIndex = psbt.addWalletInput(
+     *   { txid: "abc123...", vout: 0, value: 100000n },
+     *   walletKeys,
+     *   { scriptId: { chain: 10, index: 0 } },  // p2shP2wsh external
+     * );
+     *
+     * // Add a p2trMusig2 key path input (signPath required)
+     * const inputIndex = psbt.addWalletInput(
+     *   { txid: "def456...", vout: 1, value: 50000n },
+     *   walletKeys,
+     *   { scriptId: { chain: 40, index: 5 }, signPath: { signer: "user", cosigner: "bitgo" } },
+     * );
+     *
+     * // Add p2trMusig2 with backup key (script path spend)
+     * const inputIndex = psbt.addWalletInput(
+     *   { txid: "ghi789...", vout: 0, value: 75000n },
+     *   walletKeys,
+     *   { scriptId: { chain: 40, index: 3 }, signPath: { signer: "user", cosigner: "backup" } },
+     * );
+     * ```
+     */
+    addWalletInput(inputOptions: AddInputOptions, walletKeys: WalletKeysArg, walletOptions: AddWalletInputOptions): number;
+    /**
+     * Add a wallet output with full PSBT metadata
+     *
+     * This creates a verifiable wallet output (typically for change) with all required
+     * PSBT fields (scripts, derivation info) based on the wallet's chain type.
+     *
+     * For p2sh/p2shP2wsh/p2wsh: Sets bip32Derivation, witnessScript, redeemScript
+     * For p2tr/p2trMusig2: Sets tapInternalKey, tapBip32Derivation
+     *
+     * @param walletKeys - The wallet's root keys
+     * @param options - Output options including chain, index, and value
+     * @returns The index of the newly added output
+     *
+     * @example
+     * ```typescript
+     * // Add a p2shP2wsh change output
+     * const outputIndex = psbt.addWalletOutput(walletKeys, {
+     *   chain: 11,  // p2shP2wsh internal (change)
+     *   index: 0,
+     *   value: 50000n,
+     * });
+     *
+     * // Add a p2trMusig2 change output
+     * const outputIndex = psbt.addWalletOutput(walletKeys, {
+     *   chain: 41,  // p2trMusig2 internal (change)
+     *   index: 5,
+     *   value: 25000n,
+     * });
+     * ```
+     */
+    addWalletOutput(walletKeys: WalletKeysArg, options: AddWalletOutputOptions): number;
+    /**
+     * Add a replay protection input to the PSBT
+     *
+     * Replay protection inputs are P2SH-P2PK inputs used on forked networks to prevent
+     * transaction replay attacks. They use a simple pubkey script without wallet derivation.
+     *
+     * @param inputOptions - Common input options (txid, vout, value, sequence)
+     * @param key - ECPair containing the public key for the replay protection input
+     * @returns The index of the newly added input
+     *
+     * @example
+     * ```typescript
+     * // Add a replay protection input using ECPair
+     * const inputIndex = psbt.addReplayProtectionInput(
+     *   { txid: "abc123...", vout: 0, value: 1000n },
+     *   replayProtectionKey,
+     * );
+     * ```
+     */
+    addReplayProtectionInput(inputOptions: AddInputOptions, key: ECPairArg): number;
     /**
      * Get the unsigned transaction ID
      * @returns The unsigned transaction ID
      */
     unsignedTxid(): string;
+    /**
+     * Get the transaction version
+     * @returns The transaction version number
+     */
+    get version(): number;
+    /**
+     * Get the transaction lock time
+     * @returns The transaction lock time
+     */
+    get lockTime(): number;
     /**
      * 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

@@ -11,6 +11,33 @@ class BitGoPsbt {
     constructor(wasm) {
         this.wasm = wasm;
     }
+    /**
+     * Create an empty PSBT for the given network with wallet keys
+     *
+     * The wallet keys are used to set global xpubs in the PSBT, which identifies
+     * the keys that will be used for signing.
+     *
+     * For Zcash networks, use ZcashBitGoPsbt.createEmpty() instead.
+     *
+     * @param network - Network name (utxolib name like "bitcoin" or coin name like "btc")
+     * @param walletKeys - The wallet's root keys (sets global xpubs in the PSBT)
+     * @param options - Optional transaction parameters (version, lockTime)
+     * @returns A new empty BitGoPsbt instance
+     *
+     * @example
+     * ```typescript
+     * // Create empty PSBT with wallet keys
+     * const psbt = BitGoPsbt.createEmpty("bitcoin", walletKeys);
+     *
+     * // Create with custom version and lockTime
+     * const psbt = BitGoPsbt.createEmpty("bitcoin", walletKeys, { version: 1, lockTime: 500000 });
+     * ```
+     */
+    static createEmpty(network, walletKeys, options) {
+        const keys = RootWalletKeys_js_1.RootWalletKeys.from(walletKeys);
+        const wasm = wasm_utxo_js_1.BitGoPsbt.create_empty(network, keys.wasm, options?.version, options?.lockTime);
+        return new BitGoPsbt(wasm);
+    }
     /**
      * Deserialize a PSBT from bytes
      * @param bytes - The PSBT bytes
@@ -21,6 +48,145 @@ class BitGoPsbt {
         const wasm = wasm_utxo_js_1.BitGoPsbt.from_bytes(bytes, network);
         return new BitGoPsbt(wasm);
     }
+    /**
+     * Add an input to the PSBT
+     *
+     * This adds a transaction input and corresponding PSBT input metadata.
+     * The witness_utxo is automatically populated for modern signing compatibility.
+     *
+     * @param options - Input options (txid, vout, value, sequence)
+     * @param script - Output script of the UTXO being spent
+     * @returns The index of the newly added input
+     *
+     * @example
+     * ```typescript
+     * const inputIndex = psbt.addInput({
+     *   txid: "abc123...",
+     *   vout: 0,
+     *   value: 100000n,
+     * }, outputScript);
+     * ```
+     */
+    addInput(options, script) {
+        return this.wasm.add_input(options.txid, options.vout, options.value, script, options.sequence, options.prevTx);
+    }
+    /**
+     * Add an output to the PSBT
+     *
+     * @param options - Output options (script, value)
+     * @returns The index of the newly added output
+     *
+     * @example
+     * ```typescript
+     * const outputIndex = psbt.addOutput({
+     *   script: outputScript,
+     *   value: 50000n,
+     * });
+     * ```
+     */
+    addOutput(options) {
+        return this.wasm.add_output(options.script, options.value);
+    }
+    /**
+     * Add a wallet input with full PSBT metadata
+     *
+     * This is a higher-level method that adds an input and populates all required
+     * PSBT fields (scripts, derivation info, etc.) based on the wallet's chain type.
+     *
+     * For p2sh/p2shP2wsh/p2wsh: Sets bip32Derivation, witnessScript, redeemScript (signPath not needed)
+     * For p2tr/p2trMusig2 script path: Sets tapLeafScript, tapBip32Derivation (signPath required)
+     * For p2trMusig2 key path: Sets tapInternalKey, tapMerkleRoot, tapBip32Derivation, musig2 participants (signPath required)
+     *
+     * @param inputOptions - Common input options (txid, vout, value, sequence)
+     * @param walletKeys - The wallet's root keys
+     * @param walletOptions - Wallet-specific options (scriptId, signPath, prevTx)
+     * @returns The index of the newly added input
+     *
+     * @example
+     * ```typescript
+     * // Add a p2shP2wsh input (signPath not needed)
+     * const inputIndex = psbt.addWalletInput(
+     *   { txid: "abc123...", vout: 0, value: 100000n },
+     *   walletKeys,
+     *   { scriptId: { chain: 10, index: 0 } },  // p2shP2wsh external
+     * );
+     *
+     * // Add a p2trMusig2 key path input (signPath required)
+     * const inputIndex = psbt.addWalletInput(
+     *   { txid: "def456...", vout: 1, value: 50000n },
+     *   walletKeys,
+     *   { scriptId: { chain: 40, index: 5 }, signPath: { signer: "user", cosigner: "bitgo" } },
+     * );
+     *
+     * // Add p2trMusig2 with backup key (script path spend)
+     * const inputIndex = psbt.addWalletInput(
+     *   { txid: "ghi789...", vout: 0, value: 75000n },
+     *   walletKeys,
+     *   { scriptId: { chain: 40, index: 3 }, signPath: { signer: "user", cosigner: "backup" } },
+     * );
+     * ```
+     */
+    addWalletInput(inputOptions, walletKeys, walletOptions) {
+        const keys = RootWalletKeys_js_1.RootWalletKeys.from(walletKeys);
+        return this.wasm.add_wallet_input(inputOptions.txid, inputOptions.vout, inputOptions.value, keys.wasm, walletOptions.scriptId.chain, walletOptions.scriptId.index, walletOptions.signPath?.signer, walletOptions.signPath?.cosigner, inputOptions.sequence, inputOptions.prevTx);
+    }
+    /**
+     * Add a wallet output with full PSBT metadata
+     *
+     * This creates a verifiable wallet output (typically for change) with all required
+     * PSBT fields (scripts, derivation info) based on the wallet's chain type.
+     *
+     * For p2sh/p2shP2wsh/p2wsh: Sets bip32Derivation, witnessScript, redeemScript
+     * For p2tr/p2trMusig2: Sets tapInternalKey, tapBip32Derivation
+     *
+     * @param walletKeys - The wallet's root keys
+     * @param options - Output options including chain, index, and value
+     * @returns The index of the newly added output
+     *
+     * @example
+     * ```typescript
+     * // Add a p2shP2wsh change output
+     * const outputIndex = psbt.addWalletOutput(walletKeys, {
+     *   chain: 11,  // p2shP2wsh internal (change)
+     *   index: 0,
+     *   value: 50000n,
+     * });
+     *
+     * // Add a p2trMusig2 change output
+     * const outputIndex = psbt.addWalletOutput(walletKeys, {
+     *   chain: 41,  // p2trMusig2 internal (change)
+     *   index: 5,
+     *   value: 25000n,
+     * });
+     * ```
+     */
+    addWalletOutput(walletKeys, options) {
+        const keys = RootWalletKeys_js_1.RootWalletKeys.from(walletKeys);
+        return this.wasm.add_wallet_output(options.chain, options.index, options.value, keys.wasm);
+    }
+    /**
+     * Add a replay protection input to the PSBT
+     *
+     * Replay protection inputs are P2SH-P2PK inputs used on forked networks to prevent
+     * transaction replay attacks. They use a simple pubkey script without wallet derivation.
+     *
+     * @param inputOptions - Common input options (txid, vout, value, sequence)
+     * @param key - ECPair containing the public key for the replay protection input
+     * @returns The index of the newly added input
+     *
+     * @example
+     * ```typescript
+     * // Add a replay protection input using ECPair
+     * const inputIndex = psbt.addReplayProtectionInput(
+     *   { txid: "abc123...", vout: 0, value: 1000n },
+     *   replayProtectionKey,
+     * );
+     * ```
+     */
+    addReplayProtectionInput(inputOptions, key) {
+        const ecpair = ecpair_js_1.ECPair.from(key);
+        return this.wasm.add_replay_protection_input(ecpair.wasm, inputOptions.txid, inputOptions.vout, inputOptions.value, inputOptions.sequence);
+    }
     /**
      * Get the unsigned transaction ID
      * @returns The unsigned transaction ID
@@ -28,6 +194,20 @@ class BitGoPsbt {
     unsignedTxid() {
         return this.wasm.unsigned_txid();
     }
+    /**
+     * Get the transaction version
+     * @returns The transaction version number
+     */
+    get version() {
+        return this.wasm.version();
+    }
+    /**
+     * Get the transaction lock time
+     * @returns The transaction lock time
+     */
+    get lockTime() {
+        return this.wasm.lock_time();
+    }
     /**
      * Parse transaction with wallet keys to identify wallet inputs/outputs
      * @param walletKeys - The wallet keys to use for identification

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

@@ -0,0 +1,113 @@
+import { type WalletKeysArg } from "./RootWalletKeys.js";
+import { BitGoPsbt, type CreateEmptyOptions } from "./BitGoPsbt.js";
+/** Zcash network names */
+export type ZcashNetworkName = "zcash" | "zcashTest" | "zec" | "tzec";
+/** Options for creating an empty Zcash PSBT (preferred method using block height) */
+export type CreateEmptyZcashOptions = CreateEmptyOptions & {
+    /** Block height to determine consensus branch ID automatically */
+    blockHeight: number;
+    /** Zcash version group ID (defaults to Sapling: 0x892F2085) */
+    versionGroupId?: number;
+    /** Zcash transaction expiry height */
+    expiryHeight?: number;
+};
+/** Options for creating an empty Zcash PSBT with explicit consensus branch ID (advanced use) */
+export type CreateEmptyZcashWithConsensusBranchIdOptions = CreateEmptyOptions & {
+    /** Zcash consensus branch ID (required, e.g., 0xC2D6D0B4 for NU5, 0x76B809BB for Sapling) */
+    consensusBranchId: number;
+    /** Zcash version group ID (defaults to Sapling: 0x892F2085) */
+    versionGroupId?: number;
+    /** Zcash transaction expiry height */
+    expiryHeight?: number;
+};
+/**
+ * Zcash-specific PSBT implementation
+ *
+ * This class extends BitGoPsbt with Zcash-specific functionality:
+ * - Required consensus branch ID for sighash computation
+ * - Version group ID for Zcash transaction format
+ * - Expiry height for transaction validity
+ *
+ * All Zcash-specific getters return non-optional types since they're
+ * guaranteed to be present for Zcash PSBTs.
+ *
+ * @example
+ * ```typescript
+ * // Create a new Zcash PSBT
+ * const psbt = ZcashBitGoPsbt.createEmpty("zcash", walletKeys, {
+ *   consensusBranchId: 0x76B809BB,  // Sapling
+ * });
+ *
+ * // Deserialize from bytes
+ * const psbt = ZcashBitGoPsbt.fromBytes(bytes, "zcash");
+ * ```
+ */
+export declare class ZcashBitGoPsbt extends BitGoPsbt {
+    /**
+     * Create an empty Zcash PSBT with consensus branch ID determined from block height
+     *
+     * **This is the preferred method for creating Zcash PSBTs.** It automatically determines
+     * the correct consensus branch ID based on the network and block height using Zcash
+     * network upgrade activation heights, eliminating the need to manually look up branch IDs.
+     *
+     * @param network - Zcash network name ("zcash", "zcashTest", "zec", "tzec")
+     * @param walletKeys - The wallet's root keys (sets global xpubs in the PSBT)
+     * @param options - Options including blockHeight to determine consensus rules
+     * @returns A new ZcashBitGoPsbt instance
+     * @throws Error if block height is before Overwinter activation
+     *
+     * @example
+     * ```typescript
+     * // Create PSBT for a specific block height (recommended)
+     * const psbt = ZcashBitGoPsbt.createEmpty("zcash", walletKeys, {
+     *   blockHeight: 1687104,  // Automatically uses Nu5 branch ID
+     * });
+     *
+     * // Create PSBT for current block height
+     * const currentHeight = await getBlockHeight();
+     * const psbt = ZcashBitGoPsbt.createEmpty("zcash", walletKeys, {
+     *   blockHeight: currentHeight,
+     * });
+     * ```
+     */
+    static createEmpty(network: ZcashNetworkName, walletKeys: WalletKeysArg, options: CreateEmptyZcashOptions): ZcashBitGoPsbt;
+    /**
+     * Create an empty Zcash PSBT with explicit consensus branch ID
+     *
+     * **Advanced use only.** This method requires manually specifying the consensus branch ID.
+     * In most cases, you should use `createEmpty()` instead, which automatically determines
+     * the correct branch ID from the block height.
+     *
+     * @param network - Zcash network name ("zcash", "zcashTest", "zec", "tzec")
+     * @param walletKeys - The wallet's root keys (sets global xpubs in the PSBT)
+     * @param options - Zcash-specific options including required consensusBranchId
+     * @returns A new ZcashBitGoPsbt instance
+     *
+     * @example
+     * ```typescript
+     * // Only use this if you need explicit control over the branch ID
+     * const psbt = ZcashBitGoPsbt.createEmptyWithConsensusBranchId("zcash", walletKeys, {
+     *   consensusBranchId: 0xC2D6D0B4,  // Nu5 branch ID
+     * });
+     * ```
+     */
+    static createEmptyWithConsensusBranchId(network: ZcashNetworkName, walletKeys: WalletKeysArg, options: CreateEmptyZcashWithConsensusBranchIdOptions): ZcashBitGoPsbt;
+    /**
+     * Deserialize a Zcash PSBT from bytes
+     *
+     * @param bytes - The PSBT bytes
+     * @param network - Zcash network name ("zcash", "zcashTest", "zec", "tzec")
+     * @returns A ZcashBitGoPsbt instance
+     */
+    static fromBytes(bytes: Uint8Array, network: ZcashNetworkName): ZcashBitGoPsbt;
+    /**
+     * Get the Zcash version group ID
+     * @returns The version group ID (e.g., 0x892F2085 for Sapling)
+     */
+    get versionGroupId(): number;
+    /**
+     * Get the Zcash expiry height
+     * @returns The expiry height (0 if not set)
+     */
+    get expiryHeight(): number;
+}

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

@@ -0,0 +1,114 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ZcashBitGoPsbt = void 0;
+const wasm_utxo_js_1 = require("../wasm/wasm_utxo.js");
+const RootWalletKeys_js_1 = require("./RootWalletKeys.js");
+const BitGoPsbt_js_1 = require("./BitGoPsbt.js");
+/**
+ * Zcash-specific PSBT implementation
+ *
+ * This class extends BitGoPsbt with Zcash-specific functionality:
+ * - Required consensus branch ID for sighash computation
+ * - Version group ID for Zcash transaction format
+ * - Expiry height for transaction validity
+ *
+ * All Zcash-specific getters return non-optional types since they're
+ * guaranteed to be present for Zcash PSBTs.
+ *
+ * @example
+ * ```typescript
+ * // Create a new Zcash PSBT
+ * const psbt = ZcashBitGoPsbt.createEmpty("zcash", walletKeys, {
+ *   consensusBranchId: 0x76B809BB,  // Sapling
+ * });
+ *
+ * // Deserialize from bytes
+ * const psbt = ZcashBitGoPsbt.fromBytes(bytes, "zcash");
+ * ```
+ */
+class ZcashBitGoPsbt extends BitGoPsbt_js_1.BitGoPsbt {
+    /**
+     * Create an empty Zcash PSBT with consensus branch ID determined from block height
+     *
+     * **This is the preferred method for creating Zcash PSBTs.** It automatically determines
+     * the correct consensus branch ID based on the network and block height using Zcash
+     * network upgrade activation heights, eliminating the need to manually look up branch IDs.
+     *
+     * @param network - Zcash network name ("zcash", "zcashTest", "zec", "tzec")
+     * @param walletKeys - The wallet's root keys (sets global xpubs in the PSBT)
+     * @param options - Options including blockHeight to determine consensus rules
+     * @returns A new ZcashBitGoPsbt instance
+     * @throws Error if block height is before Overwinter activation
+     *
+     * @example
+     * ```typescript
+     * // Create PSBT for a specific block height (recommended)
+     * const psbt = ZcashBitGoPsbt.createEmpty("zcash", walletKeys, {
+     *   blockHeight: 1687104,  // Automatically uses Nu5 branch ID
+     * });
+     *
+     * // Create PSBT for current block height
+     * const currentHeight = await getBlockHeight();
+     * const psbt = ZcashBitGoPsbt.createEmpty("zcash", walletKeys, {
+     *   blockHeight: currentHeight,
+     * });
+     * ```
+     */
+    static createEmpty(network, walletKeys, options) {
+        const keys = RootWalletKeys_js_1.RootWalletKeys.from(walletKeys);
+        const wasm = wasm_utxo_js_1.BitGoPsbt.create_empty_zcash_at_height(network, keys.wasm, options.blockHeight, options.version, options.lockTime, options.versionGroupId, options.expiryHeight);
+        return new ZcashBitGoPsbt(wasm);
+    }
+    /**
+     * Create an empty Zcash PSBT with explicit consensus branch ID
+     *
+     * **Advanced use only.** This method requires manually specifying the consensus branch ID.
+     * In most cases, you should use `createEmpty()` instead, which automatically determines
+     * the correct branch ID from the block height.
+     *
+     * @param network - Zcash network name ("zcash", "zcashTest", "zec", "tzec")
+     * @param walletKeys - The wallet's root keys (sets global xpubs in the PSBT)
+     * @param options - Zcash-specific options including required consensusBranchId
+     * @returns A new ZcashBitGoPsbt instance
+     *
+     * @example
+     * ```typescript
+     * // Only use this if you need explicit control over the branch ID
+     * const psbt = ZcashBitGoPsbt.createEmptyWithConsensusBranchId("zcash", walletKeys, {
+     *   consensusBranchId: 0xC2D6D0B4,  // Nu5 branch ID
+     * });
+     * ```
+     */
+    static createEmptyWithConsensusBranchId(network, walletKeys, options) {
+        const keys = RootWalletKeys_js_1.RootWalletKeys.from(walletKeys);
+        const wasm = wasm_utxo_js_1.BitGoPsbt.create_empty_zcash(network, keys.wasm, options.consensusBranchId, options.version, options.lockTime, options.versionGroupId, options.expiryHeight);
+        return new ZcashBitGoPsbt(wasm);
+    }
+    /**
+     * Deserialize a Zcash PSBT from bytes
+     *
+     * @param bytes - The PSBT bytes
+     * @param network - Zcash network name ("zcash", "zcashTest", "zec", "tzec")
+     * @returns A ZcashBitGoPsbt instance
+     */
+    static fromBytes(bytes, network) {
+        const wasm = wasm_utxo_js_1.BitGoPsbt.from_bytes(bytes, network);
+        return new ZcashBitGoPsbt(wasm);
+    }
+    // --- Zcash-specific getters ---
+    /**
+     * Get the Zcash version group ID
+     * @returns The version group ID (e.g., 0x892F2085 for Sapling)
+     */
+    get versionGroupId() {
+        return this.wasm.version_group_id();
+    }
+    /**
+     * Get the Zcash expiry height
+     * @returns The expiry height (0 if not set)
+     */
+    get expiryHeight() {
+        return this.wasm.expiry_height();
+    }
+}
+exports.ZcashBitGoPsbt = ZcashBitGoPsbt;