@bitgo/wasm-utxo 4.41.0 → 5.1.0

package/dist/esm/js/descriptorWallet/psbt/findDescriptors.js

@@ -44,11 +44,11 @@ function findDescriptorForDerivationIndex(script, index, descriptorMap) {
 function getDerivationIndexFromPath(path) {
     const indexStr = path.split("/").pop();
     if (!indexStr) {
-        throw new Error(`Invalid derivation path ${path}`);
+        return undefined;
     }
-    const index = parseInt(indexStr, 10);
-    if (index.toString() !== indexStr) {
-        throw new Error(`Invalid derivation path ${path}`);
+    const index = Number(indexStr);
+    if (!Number.isSafeInteger(index) || index < 0 || index.toString() !== indexStr) {
+        return undefined;
     }
     return index;
 }
@@ -59,7 +59,13 @@ function getDerivationIndexFromPath(path) {
  * @param descriptorMap
  */
 function findDescriptorForAnyDerivationPath(script, derivationPaths, descriptorMap) {
-    const derivationIndexSet = new Set(derivationPaths.map((p) => getDerivationIndexFromPath(p)));
+    const derivationIndexSet = new Set();
+    for (const path of derivationPaths) {
+        const index = getDerivationIndexFromPath(path);
+        if (index !== undefined) {
+            derivationIndexSet.add(index);
+        }
+    }
     for (const index of [...derivationIndexSet]) {
         const desc = findDescriptorForDerivationIndex(script, index, descriptorMap);
         if (desc) {
@@ -69,13 +75,11 @@ function findDescriptorForAnyDerivationPath(script, derivationPaths, descriptorM
     return undefined;
 }
 function getDerivationPaths(v) {
-    if ("bip32Derivation" in v && v.bip32Derivation && v.bip32Derivation.length > 0) {
-        return v.bip32Derivation.map((v) => v.path);
-    }
-    if ("tapBip32Derivation" in v && v.tapBip32Derivation && v.tapBip32Derivation.length > 0) {
-        return v.tapBip32Derivation.map((v) => v.path).filter((v) => v !== "" && v !== "m");
-    }
-    return undefined;
+    const paths = [
+        ...(v.bip32Derivation ?? []).map((derivation) => derivation.path),
+        ...(v.tapBip32Derivation ?? []).map((derivation) => derivation.path),
+    ].filter((path) => path !== "" && path !== "m");
+    return paths.length > 0 ? paths : undefined;
 }
 /**
  * @param input

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

@@ -1,3 +1,4 @@
+import { WasmDimensions } from "../wasm/wasm_utxo.js";
 import type { BitGoPsbt, InputScriptType, SignPath } from "./BitGoPsbt.js";
 import type { CoinName } from "../coinName.js";
 import type { OutputScriptType } from "./scriptType.js";
@@ -17,16 +18,6 @@ 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.
  *
@@ -37,7 +28,7 @@ export type FromOutputOptions = {
  */
 export declare class Dimensions {
     private _wasm;
-    private constructor();
+    protected constructor(_wasm: WasmDimensions);
     /**
      * Create empty dimensions (zero weight)
      */
@@ -62,12 +53,10 @@ export declare class Dimensions {
      */
     static fromOutput(script: Uint8Array): Dimensions;
     /**
-     * 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
+     * Create dimensions for a single output from an address, decoded as an ordinary transparent
+     * address for `network`.
      */
-    static fromOutput(address: string, network: CoinName, options?: FromOutputOptions): Dimensions;
+    static fromOutput(address: string, network: CoinName): Dimensions;
     /**
      * Create dimensions for a single output from script length only
      */

package/dist/esm/js/fixedScriptWallet/Dimensions.js

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

package/dist/esm/js/fixedScriptWallet/ZcashDimensions.d.ts

@@ -0,0 +1,45 @@
+import type { CoinName } from "../coinName.js";
+import type { OutputScriptType } from "./scriptType.js";
+import { Dimensions } from "./Dimensions.js";
+/**
+ * Options for {@link ZcashDimensions.fromOutput}.
+ */
+export type ZcashFromOutputOptions = {
+    /**
+     * Set when `address` may be a ZIP-316 Unified Address whose Orchard receiver should be sized
+     * as a shielded output. Forwarded to `zcashAddress.toShieldedReceiverWithCoin`; when unset,
+     * `zcashAddress.toTransparentReceiverWithCoin` is used instead.
+     */
+    isShielded?: boolean;
+};
+/**
+ * Zcash-specific dimensions: resolves ZIP-316 Unified Addresses (transparent or Orchard/Ironwood
+ * shielded receiver) instead of the plain transparent-only decoding {@link Dimensions.fromOutput}
+ * does for every other coin.
+ */
+export declare class ZcashDimensions extends Dimensions {
+    /**
+     * Create dimensions for a single output from script bytes
+     */
+    static fromOutput(script: Uint8Array): Dimensions;
+    /**
+     * Create dimensions for a single output from a Zcash address for `network`.
+     *
+     * Pass `{ isShielded: true }` when `address` may be a ZIP-316 Unified Address whose Orchard
+     * receiver should be sized as a shielded output; otherwise its transparent receiver is
+     * resolved (a UA with no transparent receiver throws rather than falling back to Orchard).
+     */
+    static fromOutput(address: string, network: CoinName, options?: ZcashFromOutputOptions): Dimensions;
+    /**
+     * Create dimensions for a single output from script length only
+     */
+    static fromOutput(params: {
+        length: number;
+    }): Dimensions;
+    /**
+     * Create dimensions for a single output from script type
+     */
+    static fromOutput(params: {
+        scriptType: OutputScriptType;
+    }): Dimensions;
+}

package/dist/esm/js/fixedScriptWallet/ZcashDimensions.js

@@ -0,0 +1,26 @@
+import { WasmDimensions } from "../wasm/wasm_utxo.js";
+import { toShieldedReceiverWithCoin, toTransparentReceiverWithCoin } from "../zcashAddress.js";
+import { Dimensions } from "./Dimensions.js";
+/**
+ * Zcash-specific dimensions: resolves ZIP-316 Unified Addresses (transparent or Orchard/Ironwood
+ * shielded receiver) instead of the plain transparent-only decoding {@link Dimensions.fromOutput}
+ * does for every other coin.
+ */
+export class ZcashDimensions extends Dimensions {
+    static fromOutput(params, network, options) {
+        if (typeof params === "string") {
+            if (network === undefined) {
+                throw new Error("network is required when passing an address string");
+            }
+            const receiver = options?.isShielded
+                ? toShieldedReceiverWithCoin(params, network)
+                : toTransparentReceiverWithCoin(params, network);
+            return new ZcashDimensions(WasmDimensions.from_output_script_length(receiver.length));
+        }
+        if (typeof params === "object" && "scriptType" in params) {
+            return Dimensions.fromOutput(params);
+        }
+        // Both Uint8Array and { length: number } have .length
+        return Dimensions.fromOutput(params);
+    }
+}

package/dist/esm/js/fixedScriptWallet/ZcashUnifiedAddress.d.ts

@@ -15,6 +15,8 @@ import type { ZcashNetworkName } from "./ZcashBitGoPsbt.js";
  * const ua = ZcashUnifiedAddress.parse(uaString, "zec");
  * const ironwood = ua.orchardReceiver;      // 43 bytes, or undefined
  * const script = ua.transparentScript;      // scriptPubKey bytes, or undefined
+ * ua.hasOrchardReceiver;                    // true iff orchardReceiver is present
+ * ua.hasTransparentReceiver;                // true iff transparentScript is present
  * ua.contains(transparentAddress);          // is it one of this UA's receivers?
  * ```
  */
@@ -43,6 +45,20 @@ export declare class ZcashUnifiedAddress {
      * a `TxOut.scriptPubKey`, or `undefined` if the UA has no transparent receiver.
      */
     get transparentScript(): Uint8Array | undefined;
+    /**
+     * Whether this Unified Address carries an Orchard/Ironwood receiver.
+     *
+     * Equivalent to `orchardReceiver !== undefined`; prefer this when only presence
+     * matters, since it avoids copying the receiver bytes.
+     */
+    get hasOrchardReceiver(): boolean;
+    /**
+     * Whether this Unified Address carries a transparent (P2PKH/P2SH) receiver.
+     *
+     * Equivalent to `transparentScript !== undefined`; prefer this when only presence
+     * matters, since it avoids copying the script bytes.
+     */
+    get hasTransparentReceiver(): boolean;
     /**
      * Whether `candidate` is a receiver of this unified address.
      *

package/dist/esm/js/fixedScriptWallet/ZcashUnifiedAddress.js

@@ -14,6 +14,8 @@ import { ZcashUnifiedAddress as WasmZcashUnifiedAddress } from "../wasm/wasm_utx
  * const ua = ZcashUnifiedAddress.parse(uaString, "zec");
  * const ironwood = ua.orchardReceiver;      // 43 bytes, or undefined
  * const script = ua.transparentScript;      // scriptPubKey bytes, or undefined
+ * ua.hasOrchardReceiver;                    // true iff orchardReceiver is present
+ * ua.hasTransparentReceiver;                // true iff transparentScript is present
  * ua.contains(transparentAddress);          // is it one of this UA's receivers?
  * ```
  */
@@ -52,6 +54,24 @@ export class ZcashUnifiedAddress {
     get transparentScript() {
         return this._wasm.transparentScript;
     }
+    /**
+     * Whether this Unified Address carries an Orchard/Ironwood receiver.
+     *
+     * Equivalent to `orchardReceiver !== undefined`; prefer this when only presence
+     * matters, since it avoids copying the receiver bytes.
+     */
+    get hasOrchardReceiver() {
+        return this._wasm.hasOrchardReceiver;
+    }
+    /**
+     * Whether this Unified Address carries a transparent (P2PKH/P2SH) receiver.
+     *
+     * Equivalent to `transparentScript !== undefined`; prefer this when only presence
+     * matters, since it avoids copying the script bytes.
+     */
+    get hasTransparentReceiver() {
+        return this._wasm.hasTransparentReceiver;
+    }
     /**
      * Whether `candidate` is a receiver of this unified address.
      *

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

@@ -1,4 +1,5 @@
 export * as address from "./address.js";
+export * as zcashAddress from "./zcashAddress.js";
 export * as ast from "./ast/index.js";
 export * as bip322 from "./bip322/index.js";
 export * as inscriptions from "./inscriptions.js";
@@ -11,6 +12,7 @@ export * as ecpair from "./ecpair.js";
 export { ECPair } from "./ecpair.js";
 export { BIP32 } from "./bip32.js";
 export { Dimensions } from "./fixedScriptWallet/Dimensions.js";
+export { ZcashDimensions } from "./fixedScriptWallet/ZcashDimensions.js";
 export type WasmUtxoVersionInfo = {
     version: string;
     gitHash: string;
@@ -68,6 +70,21 @@ declare module "./wasm/wasm_utxo.js" {
         bip32Derivation: PsbtBip32Derivation[];
         tapBip32Derivation: PsbtBip32Derivation[];
     }
+    /** A serialized input-map record with a standard PSBT key type. */
+    interface PsbtKnownInputKeyValue {
+        type: "known";
+        key: string;
+        keyData: Uint8Array;
+        value: Uint8Array;
+    }
+    /** A serialized input-map record whose key type is unrecognized. */
+    interface PsbtUnknownInputKeyValue {
+        type: "unknown";
+        keyType: bigint;
+        keyData: Uint8Array;
+        value: Uint8Array;
+    }
+    type PsbtInputKeyValue = PsbtKnownInputKeyValue | PsbtUnknownInputKeyValue;
     /** Raw PSBT output data returned by getOutputs() */
     interface PsbtOutputData {
         script: Uint8Array;
@@ -110,3 +127,4 @@ export { WrapMiniscript as Miniscript } from "./wasm/wasm_utxo.js";
 export { Psbt } from "./descriptorWallet/Psbt.js";
 export { DashTransaction, Transaction, ZcashTransaction, type ITransaction, type ITransactionCommon, } from "./transaction.js";
 export { hasPsbtMagic, type IPsbt, type IPsbtWithAddress } from "./psbt.js";
+export type { PsbtInputKeyValue } from "./wasm/wasm_utxo.js";

package/dist/esm/js/index.js

@@ -6,6 +6,7 @@ void wasm;
 // Most exports are namespaced to avoid polluting the top-level namespace
 // and to make imports more explicit (e.g., `import { address } from '@bitgo/wasm-utxo'`)
 export * as address from "./address.js";
+export * as zcashAddress from "./zcashAddress.js";
 export * as ast from "./ast/index.js";
 export * as bip322 from "./bip322/index.js";
 export * as inscriptions from "./inscriptions.js";
@@ -19,6 +20,7 @@ export * as ecpair from "./ecpair.js";
 export { ECPair } from "./ecpair.js";
 export { BIP32 } from "./bip32.js";
 export { Dimensions } from "./fixedScriptWallet/Dimensions.js";
+export { ZcashDimensions } from "./fixedScriptWallet/ZcashDimensions.js";
 export function getWasmUtxoVersion() {
     return WasmUtxoNamespace.get_wasm_utxo_version();
 }

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

@@ -1,10 +1,11 @@
-import type { PsbtInputData, PsbtOutputData, PsbtOutputDataWithAddress } from "./wasm/wasm_utxo.js";
+import type { PsbtInputData, PsbtInputKeyValue, 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[];
+    getInputKeyValues(index: number): PsbtInputKeyValue[];
     unsignedTxId(): string;
     addInputAtIndex(index: number, txid: string, vout: number, value: bigint, script: Uint8Array, sequence?: number): number;
     addOutputAtIndex(index: number, script: Uint8Array, value: bigint): number;

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

@@ -1,4 +1,4 @@
-import type { PsbtInputData, PsbtOutputData } from "./wasm/wasm_utxo.js";
+import type { PsbtInputData, PsbtInputKeyValue, PsbtOutputData } from "./wasm/wasm_utxo.js";
 import { BIP32 } from "./bip32.js";
 import type { PsbtKvKey } from "./fixedScriptWallet/BitGoKeySubtype.js";
 interface WasmPsbtBase {
@@ -9,6 +9,7 @@ interface WasmPsbtBase {
     unsigned_tx_id(): string;
     serialize(): Uint8Array;
     get_inputs(): unknown;
+    get_input_key_values(index: number): unknown;
     get_outputs(): unknown;
     get_global_xpubs(): unknown;
     remove_input(index: number): void;
@@ -33,6 +34,7 @@ export declare abstract class PsbtBase<W extends WasmPsbtBase> {
     unsignedTxId(): string;
     serialize(): Uint8Array;
     getInputs(): PsbtInputData[];
+    getInputKeyValues(index: number): PsbtInputKeyValue[];
     getOutputs(): PsbtOutputData[];
     getGlobalXpubs(): BIP32[];
     removeInput(index: number): void;

package/dist/esm/js/psbtBase.js

@@ -25,6 +25,9 @@ export class PsbtBase {
     getInputs() {
         return this._wasm.get_inputs();
     }
+    getInputKeyValues(index) {
+        return this._wasm.get_input_key_values(index);
+    }
     getOutputs() {
         return this._wasm.get_outputs();
     }

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

@@ -7,12 +7,9 @@ export class AddressNamespace {
     [Symbol.dispose](): void;
     static from_output_script_with_coin(script: Uint8Array, coin: string, format?: string | null): string;
     /**
-     * `can_be_shielded_output`: when set and `address` is a ZIP-316 unified address carrying an
-     * Orchard/Ironwood receiver, returns that raw 43-byte receiver instead of a transparent
-     * scriptPubKey. See [`to_output_script_or_shielded_receiver_with_coin`] for the exact
-     * fallback/error rules.
+     * Convert `address` to its scriptPubKey bytes for `coin`.
      */
-    static to_output_script_with_coin(address: string, coin: string, can_be_shielded_output?: boolean | null): Uint8Array;
+    static to_output_script_with_coin(address: string, coin: string): Uint8Array;
 }
 
 /**
@@ -491,6 +488,7 @@ export class BitGoPsbt {
      */
     generate_musig2_nonces(xpriv: WasmBIP32, session_id_bytes?: Uint8Array | null): void;
     get_global_xpubs(): any;
+    get_input_key_values(index: number): any;
     get_input_kv(index: number, key: any): Uint8Array | undefined;
     get_inputs(): any;
     get_kv(key: any): Uint8Array | undefined;
@@ -1661,6 +1659,7 @@ export class WrapPsbt {
      */
     finalize_mut_zcash(consensus_branch_id: number, version_group_id?: number | null, expiry_height?: number | null): void;
     get_global_xpubs(): any;
+    get_input_key_values(index: number): any;
     get_input_kv(index: number, key: any): Uint8Array | undefined;
     get_inputs(): any;
     get_kv(key: any): Uint8Array | undefined;
@@ -1798,6 +1797,20 @@ export class ZcashUnifiedAddress {
      * below are infallible. Throws if the address is malformed or on the wrong network.
      */
     static parse(address: string, network: string): ZcashUnifiedAddress;
+    /**
+     * Whether this Unified Address carries an Orchard/Ironwood receiver.
+     *
+     * Equivalent to `orchardReceiver !== undefined`, without cloning the receiver bytes
+     * when the caller only needs presence.
+     */
+    readonly hasOrchardReceiver: boolean;
+    /**
+     * Whether this Unified Address carries a transparent (P2PKH/P2SH) receiver.
+     *
+     * Equivalent to `transparentScript !== undefined`, without cloning the script bytes
+     * when the caller only needs presence.
+     */
+    readonly hasTransparentReceiver: boolean;
     /**
      * The Orchard/Ironwood receiver's raw 43 bytes (diversifier + pk_d), or `undefined`.
      */
@@ -1966,6 +1979,43 @@ export function parsePsbtToJson(psbt_bytes: Uint8Array, coin_name: string): stri
  */
 export function parseTxToJson(tx_bytes: Uint8Array, coin_name: string): string;
 
+/**
+ * Whether `address` is a ZIP-316 unified address for `coin`'s network carrying an
+ * Orchard/Ironwood receiver. `false` (never throws) for a malformed/wrong-network unified
+ * address, an ordinary address, or a UA with no Orchard/Ironwood receiver.
+ */
+export function zcashHasOrchardReceiver(address: string, coin: string): boolean;
+
+/**
+ * Whether `address` has a usable transparent receiver for `coin`'s network: either it's a
+ * unified address carrying a transparent receiver, or it's itself a valid transparent address
+ * for `coin`. `false` (never throws) otherwise.
+ */
+export function zcashHasTransparentReceiver(address: string, coin: string): boolean;
+
+export function zcashToShieldedReceiverWithCoin(address: string, coin: string): Uint8Array;
+
+/**
+ * Resolve the Orchard/Ironwood receiver of a ZIP-316 unified address for `coin`'s network, as
+ * its raw 43 bytes (diversifier + `pk_d`) — there is no scriptPubKey for a shielded output, so
+ * this can't return script bytes uniformly and returns raw receiver bytes instead.
+ *
+ * A UA that has no Orchard/Ironwood receiver (e.g. Sapling-only) throws rather than falling back
+ * to the transparent receiver. If `address` merely looks like a unified address for this coin's
+ * network (right Bech32m HRP) but is malformed, this also throws. `address` must be a unified
+ * address — an ordinary transparent address is rejected, since it can never carry a shielded
+ * receiver; use {@link toOutputScriptWithCoin} in `js/address.ts` for the transparent case.
+ * Resolve the transparent receiver of an `address` for `coin`'s network, as its scriptPubKey
+ * bytes. When `address` is a ZIP-316 unified address, resolves its transparent receiver rather
+ * than rejecting the UA string outright — a UA with no transparent receiver (e.g. Orchard-only)
+ * throws rather than falling back to a shielded one. An ordinary (non-UA) address falls through
+ * to the same transparent codec path as any other coin.
+ *
+ * This is the zcash-aware counterpart of `toOutputScriptWithCoin` in `js/address.ts`, which
+ * dispatches here for zcash/tzec so that non-zcash coins never pay for a unified-address check.
+ */
+export function zcashToTransparentReceiverWithCoin(address: string, coin: string): Uint8Array;
+
 /**
  * Return the Zcash consensus branch ID active at `height` on `network`.
  *

package/dist/esm/js/wasm/wasm_utxo.js

@@ -5,5 +5,5 @@ import { __wbg_set_wasm } from "./wasm_utxo_bg.js";
 __wbg_set_wasm(wasm);
 
 export {
-    AddressNamespace, Bip322Namespace, BitGoPsbt, FixedScriptWalletNamespace, InscriptionsNamespace, IronwoodWitness, MessageNamespace, UtxolibCompatNamespace, WasmBIP32, WasmDashTransaction, WasmDimensions, WasmECPair, WasmReplayProtection, WasmRootWalletKeys, WasmTransaction, WasmUtxoNamespace, WasmZcashTransaction, WrapDescriptor, WrapMiniscript, WrapPsbt, ZcashUnifiedAddress, ZcashV6Transaction, ironwood_build_witness, isInspectEnabled, parsePsbtRawToJson, parsePsbtToJson, parseTxToJson, zcash_branch_id_for_height, zcash_ironwood_version_group_id
+    AddressNamespace, Bip322Namespace, BitGoPsbt, FixedScriptWalletNamespace, InscriptionsNamespace, IronwoodWitness, MessageNamespace, UtxolibCompatNamespace, WasmBIP32, WasmDashTransaction, WasmDimensions, WasmECPair, WasmReplayProtection, WasmRootWalletKeys, WasmTransaction, WasmUtxoNamespace, WasmZcashTransaction, WrapDescriptor, WrapMiniscript, WrapPsbt, ZcashUnifiedAddress, ZcashV6Transaction, ironwood_build_witness, isInspectEnabled, parsePsbtRawToJson, parsePsbtToJson, parseTxToJson, zcashHasOrchardReceiver, zcashHasTransparentReceiver, zcashToShieldedReceiverWithCoin, zcashToTransparentReceiverWithCoin, zcash_branch_id_for_height, zcash_ironwood_version_group_id
 } from "./wasm_utxo_bg.js";