@bitgo/wasm-utxo 1.40.0 → 1.42.0

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

@@ -1,4 +1,5 @@
-import { BitGoPsbt as WasmBitGoPsbt } from "../wasm/wasm_utxo.js";
+import { BitGoPsbt as WasmBitGoPsbt, type PsbtInputData, type PsbtOutputData, type PsbtOutputDataWithAddress } from "../wasm/wasm_utxo.js";
+import type { IPsbtIntrospectionWithAddress } from "../psbt.js";
 import { type WalletKeysArg } from "./RootWalletKeys.js";
 import { type ReplayProtectionArg } from "./ReplayProtection.js";
 import { type BIP32Arg } from "../bip32.js";
@@ -90,7 +91,14 @@ export type AddWalletOutputOptions = {
     /** Value in satoshis */
     value: bigint;
 };
-export declare class BitGoPsbt {
+export type ParseTransactionOptions = {
+    replayProtection: ReplayProtectionArg;
+    payGoPubkeys?: ECPairArg[];
+};
+export type ParseOutputsOptions = {
+    payGoPubkeys?: ECPairArg[];
+};
+export declare class BitGoPsbt implements IPsbtIntrospectionWithAddress {
     protected _wasm: WasmBitGoPsbt;
     protected constructor(_wasm: WasmBitGoPsbt);
     /**
@@ -305,11 +313,12 @@ export declare class BitGoPsbt {
     /**
      * Parse transaction with wallet keys to identify wallet inputs/outputs
      * @param walletKeys - The wallet keys to use for identification
-     * @param replayProtection - Scripts that are allowed as inputs without wallet validation
-     * @param payGoPubkeys - Optional public keys for PayGo attestation verification
+     * @param options - Options for parsing
+     * @param options.replayProtection - Scripts that are allowed as inputs without wallet validation
+     * @param options.payGoPubkeys - Optional public keys for PayGo attestation verification
      * @returns Parsed transaction information
      */
-    parseTransactionWithWalletKeys(walletKeys: WalletKeysArg, replayProtection: ReplayProtectionArg, payGoPubkeys?: ECPairArg[]): ParsedTransaction;
+    parseTransactionWithWalletKeys(walletKeys: WalletKeysArg, options: ParseTransactionOptions): ParsedTransaction;
     /**
      * Parse outputs with wallet keys to identify which outputs belong to a wallet
      * with the given wallet keys.
@@ -318,11 +327,12 @@ export declare class BitGoPsbt {
      * wallet than the inputs.
      *
      * @param walletKeys - The wallet keys to use for identification
-     * @param payGoPubkeys - Optional public keys for PayGo attestation verification
+     * @param options - Optional options for parsing
+     * @param options.payGoPubkeys - Optional public keys for PayGo attestation verification
      * @returns Array of parsed outputs
      * @note This method does NOT validate wallet inputs. It only parses outputs.
      */
-    parseOutputsWithWalletKeys(walletKeys: WalletKeysArg, payGoPubkeys?: ECPairArg[]): ParsedOutput[];
+    parseOutputsWithWalletKeys(walletKeys: WalletKeysArg, options?: ParseOutputsOptions): ParsedOutput[];
     /**
      * Add a PayGo attestation to a PSBT output
      *
@@ -502,7 +512,7 @@ export declare class BitGoPsbt {
      * const counterpartyPsbt = BitGoPsbt.fromBytes(counterpartyPsbtBytes, network);
      * psbt.combineMusig2Nonces(counterpartyPsbt);
      * // Sign MuSig2 key path inputs
-     * const parsed = psbt.parseTransactionWithWalletKeys(walletKeys, replayProtection);
+     * const parsed = psbt.parseTransactionWithWalletKeys(walletKeys, { replayProtection });
      * for (let i = 0; i < parsed.inputs.length; i++) {
      *   if (parsed.inputs[i].scriptType === "p2trMusig2KeyPath") {
      *     psbt.sign(i, userXpriv);
@@ -570,4 +580,50 @@ export declare class BitGoPsbt {
      * ```
      */
     getHalfSignedLegacyFormat(): Uint8Array;
+    /**
+     * Get the number of inputs in the PSBT
+     * @returns The number of inputs
+     */
+    get inputCount(): number;
+    /**
+     * Get the number of outputs in the PSBT
+     * @returns The number of outputs
+     */
+    get outputCount(): number;
+    /**
+     * Get all PSBT inputs as an array
+     *
+     * Returns raw PSBT input data including witness_utxo and derivation info.
+     * For parsed transaction data with address identification, use
+     * parseTransactionWithWalletKeys() instead.
+     *
+     * @returns Array of PsbtInputData objects
+     */
+    getInputs(): PsbtInputData[];
+    /**
+     * Get all PSBT outputs as an array
+     *
+     * Returns raw PSBT output data without address resolution.
+     * For output data with addresses, use getOutputsWithAddress().
+     *
+     * @returns Array of PsbtOutputData objects
+     */
+    getOutputs(): PsbtOutputData[];
+    /**
+     * Get all PSBT outputs with resolved address strings
+     *
+     * Unlike the generic Psbt class which requires a coin parameter,
+     * BitGoPsbt automatically uses the network it was created with to resolve addresses.
+     *
+     * @returns Array of PsbtOutputDataWithAddress objects
+     *
+     * @example
+     * ```typescript
+     * const outputs = psbt.getOutputsWithAddress();
+     * for (const output of outputs) {
+     *   console.log(`${output.address}: ${output.value} satoshis`);
+     * }
+     * ```
+     */
+    getOutputsWithAddress(): PsbtOutputDataWithAddress[];
 }

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

@@ -221,14 +221,15 @@ class BitGoPsbt {
     /**
      * Parse transaction with wallet keys to identify wallet inputs/outputs
      * @param walletKeys - The wallet keys to use for identification
-     * @param replayProtection - Scripts that are allowed as inputs without wallet validation
-     * @param payGoPubkeys - Optional public keys for PayGo attestation verification
+     * @param options - Options for parsing
+     * @param options.replayProtection - Scripts that are allowed as inputs without wallet validation
+     * @param options.payGoPubkeys - Optional public keys for PayGo attestation verification
      * @returns Parsed transaction information
      */
-    parseTransactionWithWalletKeys(walletKeys, replayProtection, payGoPubkeys) {
+    parseTransactionWithWalletKeys(walletKeys, options) {
         const keys = RootWalletKeys_js_1.RootWalletKeys.from(walletKeys);
-        const rp = ReplayProtection_js_1.ReplayProtection.from(replayProtection, this._wasm.network());
-        const pubkeys = payGoPubkeys?.map((arg) => ecpair_js_1.ECPair.from(arg).wasm);
+        const rp = ReplayProtection_js_1.ReplayProtection.from(options.replayProtection, this._wasm.network());
+        const pubkeys = options.payGoPubkeys?.map((arg) => ecpair_js_1.ECPair.from(arg).wasm);
         return this._wasm.parse_transaction_with_wallet_keys(keys.wasm, rp.wasm, pubkeys);
     }
     /**
@@ -239,13 +240,14 @@ class BitGoPsbt {
      * wallet than the inputs.
      *
      * @param walletKeys - The wallet keys to use for identification
-     * @param payGoPubkeys - Optional public keys for PayGo attestation verification
+     * @param options - Optional options for parsing
+     * @param options.payGoPubkeys - Optional public keys for PayGo attestation verification
      * @returns Array of parsed outputs
      * @note This method does NOT validate wallet inputs. It only parses outputs.
      */
-    parseOutputsWithWalletKeys(walletKeys, payGoPubkeys) {
+    parseOutputsWithWalletKeys(walletKeys, options) {
         const keys = RootWalletKeys_js_1.RootWalletKeys.from(walletKeys);
-        const pubkeys = payGoPubkeys?.map((arg) => ecpair_js_1.ECPair.from(arg).wasm);
+        const pubkeys = options?.payGoPubkeys?.map((arg) => ecpair_js_1.ECPair.from(arg).wasm);
         return this._wasm.parse_outputs_with_wallet_keys(keys.wasm, pubkeys);
     }
     /**
@@ -447,7 +449,7 @@ class BitGoPsbt {
      * const counterpartyPsbt = BitGoPsbt.fromBytes(counterpartyPsbtBytes, network);
      * psbt.combineMusig2Nonces(counterpartyPsbt);
      * // Sign MuSig2 key path inputs
-     * const parsed = psbt.parseTransactionWithWalletKeys(walletKeys, replayProtection);
+     * const parsed = psbt.parseTransactionWithWalletKeys(walletKeys, { replayProtection });
      * for (let i = 0; i < parsed.inputs.length; i++) {
      *   if (parsed.inputs[i].scriptType === "p2trMusig2KeyPath") {
      *     psbt.sign(i, userXpriv);
@@ -535,5 +537,61 @@ class BitGoPsbt {
     getHalfSignedLegacyFormat() {
         return this._wasm.extract_half_signed_legacy_tx();
     }
+    /**
+     * Get the number of inputs in the PSBT
+     * @returns The number of inputs
+     */
+    get inputCount() {
+        return this._wasm.input_count();
+    }
+    /**
+     * Get the number of outputs in the PSBT
+     * @returns The number of outputs
+     */
+    get outputCount() {
+        return this._wasm.output_count();
+    }
+    /**
+     * Get all PSBT inputs as an array
+     *
+     * Returns raw PSBT input data including witness_utxo and derivation info.
+     * For parsed transaction data with address identification, use
+     * parseTransactionWithWalletKeys() instead.
+     *
+     * @returns Array of PsbtInputData objects
+     */
+    getInputs() {
+        return this._wasm.get_inputs();
+    }
+    /**
+     * Get all PSBT outputs as an array
+     *
+     * Returns raw PSBT output data without address resolution.
+     * For output data with addresses, use getOutputsWithAddress().
+     *
+     * @returns Array of PsbtOutputData objects
+     */
+    getOutputs() {
+        return this._wasm.get_outputs();
+    }
+    /**
+     * Get all PSBT outputs with resolved address strings
+     *
+     * Unlike the generic Psbt class which requires a coin parameter,
+     * BitGoPsbt automatically uses the network it was created with to resolve addresses.
+     *
+     * @returns Array of PsbtOutputDataWithAddress objects
+     *
+     * @example
+     * ```typescript
+     * const outputs = psbt.getOutputsWithAddress();
+     * for (const output of outputs) {
+     *   console.log(`${output.address}: ${output.value} satoshis`);
+     * }
+     * ```
+     */
+    getOutputsWithAddress() {
+        return this._wasm.get_outputs_with_address();
+    }
 }
 exports.BitGoPsbt = BitGoPsbt;

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

@@ -5,8 +5,9 @@ export { outputScript, address } from "./address.js";
 export { Dimensions } from "./Dimensions.js";
 export { outputScriptTypes, inputScriptTypes, type OutputScriptType, type InputScriptType, type ScriptType, } from "./scriptType.js";
 export { ChainCode, chainCodes, assertChainCode, type Scope } from "./chains.js";
-export { BitGoPsbt, type NetworkName, type ScriptId, type ParsedInput, type ParsedOutput, type ParsedTransaction, type SignPath, type CreateEmptyOptions, type AddInputOptions, type AddOutputOptions, type AddWalletInputOptions, type AddWalletOutputOptions, } from "./BitGoPsbt.js";
+export { BitGoPsbt, 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, } from "./BitGoPsbt.js";
 export { ZcashBitGoPsbt, type ZcashNetworkName, type CreateEmptyZcashOptions, } from "./ZcashBitGoPsbt.js";
+export type { PsbtBip32Derivation, PsbtInputData, PsbtOutputData, PsbtOutputDataWithAddress, PsbtWitnessUtxo, } from "../wasm/wasm_utxo.js";
 import type { ScriptType } from "./scriptType.js";
 /**
  * Check if a network supports a given fixed-script wallet script type

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

@@ -91,4 +91,4 @@ export { WrapDescriptor as Descriptor } from "./wasm/wasm_utxo.js";
 export { WrapMiniscript as Miniscript } from "./wasm/wasm_utxo.js";
 export { WrapPsbt as Psbt } from "./wasm/wasm_utxo.js";
 export { DashTransaction, Transaction, ZcashTransaction } from "./transaction.js";
-export { hasPsbtMagic } from "./psbt.js";
+export { hasPsbtMagic, type IPsbtIntrospection, type IPsbtIntrospectionWithAddress, } from "./psbt.js";

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

@@ -1,3 +1,15 @@
+import type { PsbtInputData, PsbtOutputData, PsbtOutputDataWithAddress } from "./wasm/wasm_utxo.js";
+/** Common interface for PSBT introspection methods */
+export interface IPsbtIntrospection {
+    readonly inputCount: number;
+    readonly outputCount: number;
+    getInputs(): PsbtInputData[];
+    getOutputs(): PsbtOutputData[];
+}
+/** Extended introspection with address resolution (no coin parameter needed) */
+export interface IPsbtIntrospectionWithAddress extends IPsbtIntrospection {
+    getOutputsWithAddress(): PsbtOutputDataWithAddress[];
+}
 /**
  * Check if a byte array has the PSBT magic bytes
  *

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

@@ -384,6 +384,13 @@ export class BitGoPsbt {
      * generated for security. Custom session_id is only allowed on testnets for testing purposes.
      */
     generate_musig2_nonces(xpriv: WasmBIP32, session_id_bytes?: Uint8Array | null): void;
+    /**
+     * Get all PSBT inputs as an array of PsbtInputData
+     *
+     * Returns an array with witness_utxo, bip32_derivation, and tap_bip32_derivation
+     * for each input.
+     */
+    get_inputs(): any;
     /**
      * Get the network type for transaction extraction
      *
@@ -391,6 +398,24 @@ export class BitGoPsbt {
      * wrapper class should be used in TypeScript.
      */
     get_network_type(): string;
+    /**
+     * Get all PSBT outputs as an array of PsbtOutputData
+     *
+     * Returns an array with script, value, bip32_derivation, and tap_bip32_derivation
+     * for each output.
+     */
+    get_outputs(): any;
+    /**
+     * Get all PSBT outputs with resolved address strings.
+     *
+     * Unlike the generic WrapPsbt which requires a coin parameter, BitGoPsbt
+     * uses the network it was created/deserialized with to resolve addresses.
+     */
+    get_outputs_with_address(): any;
+    /**
+     * Get the number of inputs in the PSBT
+     */
+    input_count(): number;
     /**
      * Check if an input is a MuSig2 keypath input.
      *
@@ -413,6 +438,10 @@ export class BitGoPsbt {
      * Get the network of the PSBT
      */
     network(): string;
+    /**
+     * Get the number of outputs in the PSBT
+     */
+    output_count(): number;
     /**
      * Parse outputs with wallet keys to identify which outputs belong to a wallet
      *

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

@@ -1015,6 +1015,28 @@ class BitGoPsbt {
             wasm.__wbindgen_add_to_stack_pointer(16);
         }
     }
+    /**
+     * Get all PSBT inputs as an array of PsbtInputData
+     *
+     * Returns an array with witness_utxo, bip32_derivation, and tap_bip32_derivation
+     * for each input.
+     * @returns {any}
+     */
+    get_inputs() {
+        try {
+            const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+            wasm.bitgopsbt_get_inputs(retptr, this.__wbg_ptr);
+            var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
+            var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
+            var r2 = getDataViewMemory0().getInt32(retptr + 4 * 2, true);
+            if (r2) {
+                throw takeObject(r1);
+            }
+            return takeObject(r0);
+        } finally {
+            wasm.__wbindgen_add_to_stack_pointer(16);
+        }
+    }
     /**
      * Get the network type for transaction extraction
      *
@@ -1038,6 +1060,58 @@ class BitGoPsbt {
             wasm.__wbindgen_export4(deferred1_0, deferred1_1, 1);
         }
     }
+    /**
+     * Get all PSBT outputs as an array of PsbtOutputData
+     *
+     * Returns an array with script, value, bip32_derivation, and tap_bip32_derivation
+     * for each output.
+     * @returns {any}
+     */
+    get_outputs() {
+        try {
+            const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+            wasm.bitgopsbt_get_outputs(retptr, this.__wbg_ptr);
+            var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
+            var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
+            var r2 = getDataViewMemory0().getInt32(retptr + 4 * 2, true);
+            if (r2) {
+                throw takeObject(r1);
+            }
+            return takeObject(r0);
+        } finally {
+            wasm.__wbindgen_add_to_stack_pointer(16);
+        }
+    }
+    /**
+     * Get all PSBT outputs with resolved address strings.
+     *
+     * Unlike the generic WrapPsbt which requires a coin parameter, BitGoPsbt
+     * uses the network it was created/deserialized with to resolve addresses.
+     * @returns {any}
+     */
+    get_outputs_with_address() {
+        try {
+            const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+            wasm.bitgopsbt_get_outputs_with_address(retptr, this.__wbg_ptr);
+            var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
+            var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
+            var r2 = getDataViewMemory0().getInt32(retptr + 4 * 2, true);
+            if (r2) {
+                throw takeObject(r1);
+            }
+            return takeObject(r0);
+        } finally {
+            wasm.__wbindgen_add_to_stack_pointer(16);
+        }
+    }
+    /**
+     * Get the number of inputs in the PSBT
+     * @returns {number}
+     */
+    input_count() {
+        const ret = wasm.bitgopsbt_input_count(this.__wbg_ptr);
+        return ret >>> 0;
+    }
     /**
      * Check if an input is a MuSig2 keypath input.
      *
@@ -1085,6 +1159,14 @@ class BitGoPsbt {
             wasm.__wbindgen_export4(deferred1_0, deferred1_1, 1);
         }
     }
+    /**
+     * Get the number of outputs in the PSBT
+     * @returns {number}
+     */
+    output_count() {
+        const ret = wasm.bitgopsbt_output_count(this.__wbg_ptr);
+        return ret >>> 0;
+    }
     /**
      * Parse outputs with wallet keys to identify which outputs belong to a wallet
      *