@bitgo/wasm-utxo 4.37.2 → 4.39.0

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

@@ -20,6 +20,8 @@ export declare class Psbt extends PsbtBase<WasmPsbt> implements IPsbt {
     addOutput(script: Uint8Array, value: bigint): number;
     updateInputWithDescriptor(inputIndex: number, descriptor: WrapDescriptor): void;
     updateOutputWithDescriptor(outputIndex: number, descriptor: WrapDescriptor): void;
+    /** Add a 32-byte SHA256 preimage for Miniscript descriptor finalization. */
+    addSha256Preimage(inputIndex: number, preimage: Uint8Array): void;
     signWithXprv(xprv: string): SignPsbtResult;
     signWithPrv(prv: Uint8Array): SignPsbtResult;
     signAll(key: WasmBIP32): SignPsbtResult;
@@ -33,5 +35,7 @@ export declare class Psbt extends PsbtBase<WasmPsbt> implements IPsbt {
     verifySignatureWithKey(inputIndex: number, key: WasmBIP32): boolean;
     getUnsignedTx(): Uint8Array;
     finalize(): void;
+    /** Finalize one Miniscript input without requiring all inputs to be complete. */
+    finalizeInput(inputIndex: number): void;
     extractTransaction(): Transaction;
 }

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

@@ -47,6 +47,10 @@ class Psbt extends psbtBase_js_1.PsbtBase {
     updateOutputWithDescriptor(outputIndex, descriptor) {
         this._wasm.update_output_with_descriptor(outputIndex, descriptor);
     }
+    /** Add a 32-byte SHA256 preimage for Miniscript descriptor finalization. */
+    addSha256Preimage(inputIndex, preimage) {
+        this._wasm.add_sha256_preimage(inputIndex, preimage);
+    }
     // -- Signing --
     signWithXprv(xprv) {
         return this._wasm.sign_with_xprv(xprv);
@@ -81,6 +85,10 @@ class Psbt extends psbtBase_js_1.PsbtBase {
     finalize() {
         this._wasm.finalize_mut();
     }
+    /** Finalize one Miniscript input without requiring all inputs to be complete. */
+    finalizeInput(inputIndex) {
+        this._wasm.finalize_input(inputIndex);
+    }
     extractTransaction() {
         return transaction_js_1.Transaction.fromWasm(this._wasm.extract_transaction());
     }

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

@@ -17,6 +17,16 @@ export type FromInputOptions = {
      */
     utxolibCompat?: boolean;
 };
+/**
+ * Options for output dimension calculation
+ */
+export type FromOutputOptions = {
+    /**
+     * Set when `address` may be a ZIP-316 Unified Address whose Orchard receiver should be sized
+     * as a shielded output. Forwarded to `toOutputScriptWithCoin`'s `canBeShieldedOutput`.
+     */
+    isShielded?: boolean;
+};
 /**
  * Dimensions class for estimating transaction virtual size.
  *
@@ -52,9 +62,12 @@ export declare class Dimensions {
      */
     static fromOutput(script: Uint8Array): Dimensions;
     /**
-     * Create dimensions for a single output from an address
+     * Create dimensions for a single output from an address.
+     *
+     * Pass `{ isShielded: true }` when `address` may be a ZIP-316 Unified Address whose Orchard
+     * receiver should be sized as a shielded output
      */
-    static fromOutput(address: string, network: CoinName): Dimensions;
+    static fromOutput(address: string, network: CoinName, options?: FromOutputOptions): Dimensions;
     /**
      * Create dimensions for a single output from script length only
      */

package/dist/cjs/js/fixedScriptWallet/Dimensions.js

@@ -45,12 +45,12 @@ class Dimensions {
         }
         return new Dimensions(wasm_utxo_js_1.WasmDimensions.from_input(params.chain, params.signPath?.signer, params.signPath?.cosigner, compat));
     }
-    static fromOutput(params, network) {
+    static fromOutput(params, network, options) {
         if (typeof params === "string") {
             if (network === undefined) {
                 throw new Error("network is required when passing an address string");
             }
-            const script = (0, address_js_1.toOutputScriptWithCoin)(params, network);
+            const script = (0, address_js_1.toOutputScriptWithCoin)(params, network, options?.isShielded);
             return new Dimensions(wasm_utxo_js_1.WasmDimensions.from_output_script_length(script.length));
         }
         if (typeof params === "object" && "scriptType" in params) {

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

@@ -146,6 +146,27 @@ export declare class ZcashIronwoodBitGoPsbt extends ZcashBitGoPsbt {
         ovk?: Uint8Array;
         unifiedAddress?: string;
     }): void;
+    /**
+     * Add one or more shielded outputs (Constructor role) as a single orchard PCZT — the
+     * multi-recipient counterpart to {@link addShieldedOutput}. Every recipient must be passed in
+     * one call: only one call to `addShieldedOutput`/`addShieldedOutputs` is supported per PSBT (see
+     * {@link addShieldedOutput}).
+     *
+     * @param outputs - one entry per recipient; `memo` defaults per-entry to the ZIP-302 "no memo"
+     *   encoding, exactly as {@link addShieldedOutput}'s does
+     * @param anchor - 32-byte Ironwood note-commitment-tree root, shared by every output
+     * @returns the action index assigned to each output, in the same order as `outputs` — the
+     *   orchard builder pads/reorders actions, so a client-managed-`ovk` caller must use these
+     *   indices (not the position in `outputs`) when later calling
+     *   `setIronwoodOutCiphertext`/`setIronwoodOutCiphertextForUser` for a specific recipient.
+     */
+    addShieldedOutputs(outputs: Array<{
+        recipient: Uint8Array;
+        amount: bigint;
+        memo?: Uint8Array;
+        ovk?: Uint8Array;
+        unifiedAddress?: string;
+    }>, anchor: Uint8Array): number[];
     /**
      * Client-managed `ovk`: re-encrypt the shielded output's `out_ciphertext` under **this wallet's**
      * `ovk`, derived as the ECDH agreement of `rootWalletKeys.bitgoKey()` and `userKey`. Both are root

package/dist/cjs/js/fixedScriptWallet/ZcashIronwoodBitGoPsbt.js

@@ -143,6 +143,29 @@ class ZcashIronwoodBitGoPsbt extends ZcashBitGoPsbt_js_1.ZcashBitGoPsbt {
         const memo = options.memo ?? zip302NoMemo();
         this.wasm.add_ironwood_output(recipient, amount, options.ovk, options.anchor, memo, options.unifiedAddress);
     }
+    /**
+     * Add one or more shielded outputs (Constructor role) as a single orchard PCZT — the
+     * multi-recipient counterpart to {@link addShieldedOutput}. Every recipient must be passed in
+     * one call: only one call to `addShieldedOutput`/`addShieldedOutputs` is supported per PSBT (see
+     * {@link addShieldedOutput}).
+     *
+     * @param outputs - one entry per recipient; `memo` defaults per-entry to the ZIP-302 "no memo"
+     *   encoding, exactly as {@link addShieldedOutput}'s does
+     * @param anchor - 32-byte Ironwood note-commitment-tree root, shared by every output
+     * @returns the action index assigned to each output, in the same order as `outputs` — the
+     *   orchard builder pads/reorders actions, so a client-managed-`ovk` caller must use these
+     *   indices (not the position in `outputs`) when later calling
+     *   `setIronwoodOutCiphertext`/`setIronwoodOutCiphertextForUser` for a specific recipient.
+     */
+    addShieldedOutputs(outputs, anchor) {
+        return Array.from(this.wasm.add_ironwood_outputs(outputs.map((o) => ({
+            recipient: o.recipient,
+            amount: o.amount,
+            memo: o.memo ?? zip302NoMemo(),
+            ovk: o.ovk,
+            unifiedAddress: o.unifiedAddress,
+        })), anchor));
+    }
     /**
      * Client-managed `ovk`: re-encrypt the shielded output's `out_ciphertext` under **this wallet's**
      * `ovk`, derived as the ECDH agreement of `rootWalletKeys.bitgoKey()` and `userKey`. Both are root

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

@@ -161,6 +161,21 @@ export class BitGoPsbt {
      * [`MEMO_SIZE`]: crate::zcash::ironwood_build::MEMO_SIZE
      */
     add_ironwood_output(recipient: Uint8Array, amount: bigint, ovk: Uint8Array | null | undefined, anchor: Uint8Array, memo: Uint8Array, unified_address?: string | null): void;
+    /**
+     * Constructor: add one or more shielded Ironwood outputs as a single orchard PCZT stored in
+     * the PSBT — the multi-recipient counterpart to [`Self::add_ironwood_output`].
+     *
+     * `outputs` is an array of `{ recipient: Uint8Array, amount: bigint, memo: Uint8Array,
+     * ovk?: Uint8Array, unifiedAddress?: string }`, one entry per recipient — see
+     * [`Self::add_ironwood_output`] for the meaning of each field. `anchor` is shared by every
+     * output.
+     *
+     * Returns the action index assigned to each output, in the same order as `outputs` — the
+     * orchard builder pads/reorders actions, so a client-managed-`ovk` caller must use these
+     * indices (not the position in `outputs`) when later calling `set_ironwood_out_ciphertext`
+     * for a specific recipient.
+     */
+    add_ironwood_outputs(outputs: any, anchor: Uint8Array): Uint32Array;
     /**
      * Ingest a transparent-input signature (`sig`: DER ECDSA with the trailing SIGHASH_ALL byte)
      * after verifying it against `ironwood_v6_transparent_sighash(index)`.
@@ -1556,6 +1571,13 @@ export class WrapPsbt {
      * The index of the newly added output
      */
     add_output_at_index(index: number, script: Uint8Array, value: bigint): number;
+    /**
+     * Add a 32-byte SHA256 preimage to an input's standard BIP174 metadata.
+     *
+     * Descriptor finalization uses this metadata to satisfy `sha256(H)`
+     * Miniscript fragments when `H == sha256(preimage)`.
+     */
+    add_sha256_preimage(input_index: number, preimage: Uint8Array): void;
     clone(): WrapPsbt;
     delete_input_kv(index: number, key: any): void;
     delete_kv(key: any): void;
@@ -1582,6 +1604,10 @@ export class WrapPsbt {
      * * `expiry_height` - Transaction expiry height (default: 0)
      */
     extract_zcash_transaction(version_group_id?: number | null, expiry_height?: number | null): WasmZcashTransaction;
+    /**
+     * Finalize one Miniscript input, preserving any other incomplete inputs.
+     */
+    finalize_input(input_index: number): void;
     finalize_mut(): void;
     /**
      * Finalize all Zcash transparent inputs using ZIP-243 sighash verification.

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

@@ -521,6 +521,43 @@ class BitGoPsbt {
             wasm.__wbindgen_add_to_stack_pointer(16);
         }
     }
+    /**
+     * Constructor: add one or more shielded Ironwood outputs as a single orchard PCZT stored in
+     * the PSBT — the multi-recipient counterpart to [`Self::add_ironwood_output`].
+     *
+     * `outputs` is an array of `{ recipient: Uint8Array, amount: bigint, memo: Uint8Array,
+     * ovk?: Uint8Array, unifiedAddress?: string }`, one entry per recipient — see
+     * [`Self::add_ironwood_output`] for the meaning of each field. `anchor` is shared by every
+     * output.
+     *
+     * Returns the action index assigned to each output, in the same order as `outputs` — the
+     * orchard builder pads/reorders actions, so a client-managed-`ovk` caller must use these
+     * indices (not the position in `outputs`) when later calling `set_ironwood_out_ciphertext`
+     * for a specific recipient.
+     * @param {any} outputs
+     * @param {Uint8Array} anchor
+     * @returns {Uint32Array}
+     */
+    add_ironwood_outputs(outputs, anchor) {
+        try {
+            const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+            const ptr0 = passArray8ToWasm0(anchor, wasm.__wbindgen_export);
+            const len0 = WASM_VECTOR_LEN;
+            wasm.bitgopsbt_add_ironwood_outputs(retptr, this.__wbg_ptr, addHeapObject(outputs), ptr0, len0);
+            var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
+            var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
+            var r2 = getDataViewMemory0().getInt32(retptr + 4 * 2, true);
+            var r3 = getDataViewMemory0().getInt32(retptr + 4 * 3, true);
+            if (r3) {
+                throw takeObject(r2);
+            }
+            var v2 = getArrayU32FromWasm0(r0, r1).slice();
+            wasm.__wbindgen_export4(r0, r1 * 4, 4);
+            return v2;
+        } finally {
+            wasm.__wbindgen_add_to_stack_pointer(16);
+        }
+    }
     /**
      * Ingest a transparent-input signature (`sig`: DER ECDSA with the trailing SIGHASH_ALL byte)
      * after verifying it against `ironwood_v6_transparent_sighash(index)`.
@@ -5743,6 +5780,29 @@ class WrapPsbt {
             wasm.__wbindgen_add_to_stack_pointer(16);
         }
     }
+    /**
+     * Add a 32-byte SHA256 preimage to an input's standard BIP174 metadata.
+     *
+     * Descriptor finalization uses this metadata to satisfy `sha256(H)`
+     * Miniscript fragments when `H == sha256(preimage)`.
+     * @param {number} input_index
+     * @param {Uint8Array} preimage
+     */
+    add_sha256_preimage(input_index, preimage) {
+        try {
+            const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+            const ptr0 = passArray8ToWasm0(preimage, wasm.__wbindgen_export);
+            const len0 = WASM_VECTOR_LEN;
+            wasm.wrappsbt_add_sha256_preimage(retptr, this.__wbg_ptr, input_index, ptr0, len0);
+            var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
+            var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
+            if (r1) {
+                throw takeObject(r0);
+            }
+        } finally {
+            wasm.__wbindgen_add_to_stack_pointer(16);
+        }
+    }
     /**
      * @returns {WrapPsbt}
      */
@@ -5874,6 +5934,23 @@ class WrapPsbt {
             wasm.__wbindgen_add_to_stack_pointer(16);
         }
     }
+    /**
+     * Finalize one Miniscript input, preserving any other incomplete inputs.
+     * @param {number} input_index
+     */
+    finalize_input(input_index) {
+        try {
+            const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+            wasm.wrappsbt_finalize_input(retptr, this.__wbg_ptr, input_index);
+            var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
+            var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
+            if (r1) {
+                throw takeObject(r0);
+            }
+        } finally {
+            wasm.__wbindgen_add_to_stack_pointer(16);
+        }
+    }
     finalize_mut() {
         try {
             const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
@@ -7174,6 +7251,10 @@ function __wbg_get_imports() {
             getDataViewMemory0().setInt32(arg0 + 4 * 1, len1, true);
             getDataViewMemory0().setInt32(arg0 + 4 * 0, ptr1, true);
         },
+        __wbg___wbindgen_is_bigint_31b12575b56f32fc: function(arg0) {
+            const ret = typeof(getObject(arg0)) === 'bigint';
+            return ret;
+        },
         __wbg___wbindgen_is_function_0095a73b8b156f76: function(arg0) {
             const ret = typeof(getObject(arg0)) === 'function';
             return ret;