@bitgo/wasm-utxo 4.25.0 → 4.27.0

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

@@ -0,0 +1,57 @@
+import { ZcashUnifiedAddress as WasmZcashUnifiedAddress } from "../wasm/wasm_utxo.js";
+import type { ZcashNetworkName } from "./ZcashBitGoPsbt.js";
+/**
+ * A parsed ZIP-316 Unified Address.
+ *
+ * Decode once with {@link ZcashUnifiedAddress.parse}, then read each component
+ * through its accessor (returns `undefined` when the receiver is absent). Membership
+ * of another address is answered by {@link contains}.
+ *
+ * Ironwood reuses the Orchard receiver, so {@link orchardReceiver} is the shielded
+ * receiver used to construct an Ironwood output note.
+ *
+ * @example
+ * ```typescript
+ * const ua = ZcashUnifiedAddress.parse(uaString, "zec");
+ * const ironwood = ua.orchardReceiver;      // 43 bytes, or undefined
+ * const script = ua.transparentScript;      // scriptPubKey bytes, or undefined
+ * ua.contains(transparentAddress);          // is it one of this UA's receivers?
+ * ```
+ */
+export declare class ZcashUnifiedAddress {
+    private _wasm;
+    private constructor();
+    /**
+     * Parse a Unified Address.
+     *
+     * @param address - The Bech32m unified address string
+     * @param network - Zcash network name ("zcash", "zcashTest", "zec", "tzec")
+     * @throws If the address is malformed or on the wrong network
+     */
+    static parse(address: string, network: ZcashNetworkName): ZcashUnifiedAddress;
+    /**
+     * The Orchard (a.k.a. Ironwood) receiver — 43 raw bytes (11-byte diversifier +
+     * 32-byte pk_d) — or `undefined` if the UA has no Orchard receiver.
+     */
+    get orchardReceiver(): Uint8Array | undefined;
+    /**
+     * The Sapling receiver — 43 raw bytes (diversifier + pk_d) — or `undefined`.
+     */
+    get saplingReceiver(): Uint8Array | undefined;
+    /**
+     * The transparent receiver as scriptPubKey bytes (P2PKH or P2SH), ready to use as
+     * a `TxOut.scriptPubKey`, or `undefined` if the UA has no transparent receiver.
+     */
+    get transparentScript(): Uint8Array | undefined;
+    /**
+     * Whether `candidate` is a receiver of this unified address.
+     *
+     * @param candidate - Another Unified Address (matches if all of its receivers are
+     *   contained here) or a transparent Zcash address (matches this UA's transparent
+     *   receiver). Must be on the same network as this UA.
+     * @throws If `candidate` is malformed or on the wrong network
+     */
+    contains(candidate: string): boolean;
+    /** @internal */
+    get wasm(): WasmZcashUnifiedAddress;
+}

package/dist/cjs/js/fixedScriptWallet/ZcashUnifiedAddress.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ZcashUnifiedAddress = void 0;
+const wasm_utxo_js_1 = require("../wasm/wasm_utxo.js");
+/**
+ * A parsed ZIP-316 Unified Address.
+ *
+ * Decode once with {@link ZcashUnifiedAddress.parse}, then read each component
+ * through its accessor (returns `undefined` when the receiver is absent). Membership
+ * of another address is answered by {@link contains}.
+ *
+ * Ironwood reuses the Orchard receiver, so {@link orchardReceiver} is the shielded
+ * receiver used to construct an Ironwood output note.
+ *
+ * @example
+ * ```typescript
+ * const ua = ZcashUnifiedAddress.parse(uaString, "zec");
+ * const ironwood = ua.orchardReceiver;      // 43 bytes, or undefined
+ * const script = ua.transparentScript;      // scriptPubKey bytes, or undefined
+ * ua.contains(transparentAddress);          // is it one of this UA's receivers?
+ * ```
+ */
+class ZcashUnifiedAddress {
+    _wasm;
+    constructor(_wasm) {
+        this._wasm = _wasm;
+    }
+    /**
+     * Parse a Unified Address.
+     *
+     * @param address - The Bech32m unified address string
+     * @param network - Zcash network name ("zcash", "zcashTest", "zec", "tzec")
+     * @throws If the address is malformed or on the wrong network
+     */
+    static parse(address, network) {
+        return new ZcashUnifiedAddress(wasm_utxo_js_1.ZcashUnifiedAddress.parse(address, network));
+    }
+    /**
+     * The Orchard (a.k.a. Ironwood) receiver — 43 raw bytes (11-byte diversifier +
+     * 32-byte pk_d) — or `undefined` if the UA has no Orchard receiver.
+     */
+    get orchardReceiver() {
+        return this._wasm.orchardReceiver;
+    }
+    /**
+     * The Sapling receiver — 43 raw bytes (diversifier + pk_d) — or `undefined`.
+     */
+    get saplingReceiver() {
+        return this._wasm.saplingReceiver;
+    }
+    /**
+     * The transparent receiver as scriptPubKey bytes (P2PKH or P2SH), ready to use as
+     * a `TxOut.scriptPubKey`, or `undefined` if the UA has no transparent receiver.
+     */
+    get transparentScript() {
+        return this._wasm.transparentScript;
+    }
+    /**
+     * Whether `candidate` is a receiver of this unified address.
+     *
+     * @param candidate - Another Unified Address (matches if all of its receivers are
+     *   contained here) or a transparent Zcash address (matches this UA's transparent
+     *   receiver). Must be on the same network as this UA.
+     * @throws If `candidate` is malformed or on the wrong network
+     */
+    contains(candidate) {
+        return this._wasm.contains(candidate);
+    }
+    /** @internal */
+    get wasm() {
+        return this._wasm;
+    }
+}
+exports.ZcashUnifiedAddress = ZcashUnifiedAddress;

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

@@ -0,0 +1,45 @@
+import { ZcashV6Transaction as WasmZcashV6Transaction } from "../wasm/wasm_utxo.js";
+/**
+ * A parsed Zcash v6 (Ironwood / NU6.3) transaction — for inspection and txid.
+ *
+ * The transaction id is an instance method ({@link getId}) returning the canonical
+ * display-order hex, consistent with the `getId()` convention on the other
+ * transaction/PSBT wrappers. Callers never pass raw bytes to a txid function or have
+ * to reverse internal byte order themselves.
+ *
+ * @example
+ * ```typescript
+ * const tx = ZcashV6Transaction.fromBytes(rawV6Bytes);
+ * tx.getId();                 // canonical (display-order) txid hex
+ * tx.ironwoodActionCount;     // 0 when the Ironwood slot is empty
+ * ```
+ */
+export declare class ZcashV6Transaction {
+    private _wasm;
+    private constructor();
+    /**
+     * Decode a v6 transaction from raw wire bytes.
+     * @throws If the bytes are not a valid v6 (Ironwood) transaction
+     */
+    static fromBytes(bytes: Uint8Array): ZcashV6Transaction;
+    /** Serialize back to raw v6 wire bytes. */
+    toBytes(): Uint8Array;
+    /** The canonical (display-order) ZIP-244 txid as a lowercase hex string. */
+    getId(): string;
+    /** The ZIP-244 txid in internal (non-reversed) byte order. */
+    txidBytes(): Uint8Array;
+    /** Consensus branch id carried in the v6 header. */
+    get consensusBranchId(): number;
+    /** Expiry height. */
+    get expiryHeight(): number;
+    /** Number of Ironwood actions (0 when the Ironwood slot is empty). */
+    get ironwoodActionCount(): number;
+    /** Net value crossing the Ironwood pool boundary (0 when there is no bundle). */
+    get ironwoodValueBalance(): bigint;
+    /** The Ironwood bundle flag byte, or `undefined` when there is no bundle. */
+    get ironwoodFlags(): number | undefined;
+    /** The Ironwood note-commitment tree anchor (32 bytes), or `undefined`. */
+    get ironwoodAnchor(): Uint8Array | undefined;
+    /** @internal */
+    get wasm(): WasmZcashV6Transaction;
+}

package/dist/cjs/js/fixedScriptWallet/ZcashV6Transaction.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ZcashV6Transaction = void 0;
+const wasm_utxo_js_1 = require("../wasm/wasm_utxo.js");
+/**
+ * A parsed Zcash v6 (Ironwood / NU6.3) transaction — for inspection and txid.
+ *
+ * The transaction id is an instance method ({@link getId}) returning the canonical
+ * display-order hex, consistent with the `getId()` convention on the other
+ * transaction/PSBT wrappers. Callers never pass raw bytes to a txid function or have
+ * to reverse internal byte order themselves.
+ *
+ * @example
+ * ```typescript
+ * const tx = ZcashV6Transaction.fromBytes(rawV6Bytes);
+ * tx.getId();                 // canonical (display-order) txid hex
+ * tx.ironwoodActionCount;     // 0 when the Ironwood slot is empty
+ * ```
+ */
+class ZcashV6Transaction {
+    _wasm;
+    constructor(_wasm) {
+        this._wasm = _wasm;
+    }
+    /**
+     * Decode a v6 transaction from raw wire bytes.
+     * @throws If the bytes are not a valid v6 (Ironwood) transaction
+     */
+    static fromBytes(bytes) {
+        return new ZcashV6Transaction(wasm_utxo_js_1.ZcashV6Transaction.fromBytes(bytes));
+    }
+    /** Serialize back to raw v6 wire bytes. */
+    toBytes() {
+        return this._wasm.toBytes();
+    }
+    /** The canonical (display-order) ZIP-244 txid as a lowercase hex string. */
+    getId() {
+        return this._wasm.getId();
+    }
+    /** The ZIP-244 txid in internal (non-reversed) byte order. */
+    txidBytes() {
+        return this._wasm.txidBytes();
+    }
+    /** Consensus branch id carried in the v6 header. */
+    get consensusBranchId() {
+        return this._wasm.consensusBranchId;
+    }
+    /** Expiry height. */
+    get expiryHeight() {
+        return this._wasm.expiryHeight;
+    }
+    /** Number of Ironwood actions (0 when the Ironwood slot is empty). */
+    get ironwoodActionCount() {
+        return this._wasm.ironwoodActionCount;
+    }
+    /** Net value crossing the Ironwood pool boundary (0 when there is no bundle). */
+    get ironwoodValueBalance() {
+        return this._wasm.ironwoodValueBalance;
+    }
+    /** The Ironwood bundle flag byte, or `undefined` when there is no bundle. */
+    get ironwoodFlags() {
+        return this._wasm.ironwoodFlags;
+    }
+    /** The Ironwood note-commitment tree anchor (32 bytes), or `undefined`. */
+    get ironwoodAnchor() {
+        return this._wasm.ironwoodAnchor;
+    }
+    /** @internal */
+    get wasm() {
+        return this._wasm;
+    }
+}
+exports.ZcashV6Transaction = ZcashV6Transaction;

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

@@ -9,6 +9,8 @@ export { requiresPrevTxForP2sh } from "./prevTx.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 { ZcashUnifiedAddress } from "./ZcashUnifiedAddress.js";
+export { ZcashV6Transaction } from "./ZcashV6Transaction.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.BitGoKeySubtype = exports.getWalletKeysFromPsbt = exports.BitGoPsbt = exports.requiresPrevTxForP2sh = exports.assertChainCode = exports.chainCodes = exports.ChainCode = exports.inputScriptTypes = exports.outputScriptTypes = exports.Dimensions = exports.address = exports.outputScript = exports.ReplayProtection = exports.RootWalletKeys = void 0;
+exports.ZcashV6Transaction = exports.ZcashUnifiedAddress = exports.ZcashBitGoPsbt = exports.BitGoKeySubtype = exports.getWalletKeysFromPsbt = exports.BitGoPsbt = exports.requiresPrevTxForP2sh = 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;
@@ -33,6 +33,12 @@ Object.defineProperty(exports, "BitGoKeySubtype", { enumerable: true, get: funct
 // Zcash-specific PSBT subclass
 var ZcashBitGoPsbt_js_1 = require("./ZcashBitGoPsbt.js");
 Object.defineProperty(exports, "ZcashBitGoPsbt", { enumerable: true, get: function () { return ZcashBitGoPsbt_js_1.ZcashBitGoPsbt; } });
+// Zcash ZIP-316 Unified Address
+var ZcashUnifiedAddress_js_1 = require("./ZcashUnifiedAddress.js");
+Object.defineProperty(exports, "ZcashUnifiedAddress", { enumerable: true, get: function () { return ZcashUnifiedAddress_js_1.ZcashUnifiedAddress; } });
+// Zcash v6 (Ironwood / NU6.3) transaction
+var ZcashV6Transaction_js_1 = require("./ZcashV6Transaction.js");
+Object.defineProperty(exports, "ZcashV6Transaction", { enumerable: true, get: function () { return ZcashV6Transaction_js_1.ZcashV6Transaction; } });
 /**
  * Check if a network supports a given fixed-script wallet script type
  *

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

@@ -1584,6 +1584,101 @@ export class WrapPsbt {
     version(): number;
 }
 
+/**
+ * A parsed ZIP-316 Unified Address.
+ *
+ * Decode once with [`ZcashUnifiedAddress::parse`], then read each component through
+ * its accessor (returns `undefined` when absent). Ironwood reuses the Orchard
+ * receiver, so `orchardReceiver` is the shielded receiver for Ironwood output notes.
+ */
+export class ZcashUnifiedAddress {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Whether `candidate` (another Unified Address, or a transparent Zcash address
+     * on the same network) is a receiver of this Unified Address.
+     */
+    contains(candidate: string): boolean;
+    /**
+     * Parse a Unified Address for `network` ("zcash"/"zec" or "zcashTest"/"tzec").
+     *
+     * All receiver components are resolved and validated eagerly, so the accessors
+     * below are infallible. Throws if the address is malformed or on the wrong network.
+     */
+    static parse(address: string, network: string): ZcashUnifiedAddress;
+    /**
+     * The Orchard/Ironwood receiver's raw 43 bytes (diversifier + pk_d), or `undefined`.
+     */
+    readonly orchardReceiver: Uint8Array | undefined;
+    /**
+     * The Sapling receiver's raw 43 bytes (diversifier + pk_d), or `undefined`.
+     */
+    readonly saplingReceiver: Uint8Array | undefined;
+    /**
+     * The transparent receiver as scriptPubKey bytes (P2PKH/P2SH), or `undefined`.
+     */
+    readonly transparentScript: Uint8Array | undefined;
+}
+
+/**
+ * A parsed Zcash v6 (Ironwood / NU6.3) transaction — for inspection and txid.
+ *
+ * This wraps the raw v6 wire codec. The transaction id is exposed as an instance
+ * method [`ZcashV6Transaction::get_id`] (canonical display-order hex), matching the
+ * `getId()` convention used by the other transaction/PSBT wrappers, so callers never
+ * pass raw bytes to a txid function or juggle internal vs display byte order.
+ */
+export class ZcashV6Transaction {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Decode a v6 transaction from raw wire bytes. Throws if the bytes are not a
+     * valid v6 (Ironwood) transaction.
+     */
+    static fromBytes(bytes: Uint8Array): ZcashV6Transaction;
+    /**
+     * The canonical (display-order) ZIP-244 txid as a lowercase hex string.
+     *
+     * `Txid`'s `Display` emits display-order (byte-reversed) hex, matching how a
+     * transaction id is printed everywhere else in the codebase.
+     */
+    getId(): string;
+    /**
+     * Serialize back to raw v6 wire bytes.
+     */
+    toBytes(): Uint8Array;
+    /**
+     * The ZIP-244 txid in internal (non-reversed) byte order.
+     */
+    txidBytes(): Uint8Array;
+    /**
+     * Consensus branch id carried in the v6 header.
+     */
+    readonly consensusBranchId: number;
+    /**
+     * Expiry height.
+     */
+    readonly expiryHeight: number;
+    /**
+     * Number of Ironwood actions (0 when the Ironwood slot is empty).
+     */
+    readonly ironwoodActionCount: number;
+    /**
+     * The Ironwood note-commitment tree anchor (32 bytes), or `undefined`.
+     */
+    readonly ironwoodAnchor: Uint8Array | undefined;
+    /**
+     * The Ironwood bundle flag byte, or `undefined` when there is no bundle.
+     */
+    readonly ironwoodFlags: number | undefined;
+    /**
+     * Net value crossing the Ironwood pool boundary (0 when there is no bundle).
+     */
+    readonly ironwoodValueBalance: bigint;
+}
+
 /**
  * Check if the inspect feature is enabled.
  *
@@ -1661,5 +1756,8 @@ export function parseTxToJson(tx_bytes: Uint8Array, coin_name: string): string;
  * `network`: "zcash" / "zec" for mainnet, "zcashTest" / "tzec" for testnet.
  * Returns `None` if `height` is before Overwinter activation.
  * Throws if `network` is not a recognised Zcash network name.
+ *
+ * Errors are thrown as the crate-standard [`WasmUtxoError`] (a marked `js_sys::Error`
+ * with `.message` and `.code`), not a bare string.
  */
 export function zcash_branch_id_for_height(network: string, height: number): number | undefined;