@bitgo/wasm-utxo 2.1.0 → 3.1.0

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

@@ -36,6 +36,11 @@ export class Bip322Namespace {
      * The index of the added input
      */
     static add_bip322_input(psbt: BitGoPsbt, message: string, chain: number, index: number, wallet_keys: WasmRootWalletKeys, signer?: string | null, cosigner?: string | null, tag?: string | null): number;
+    /**
+     * Get the BIP322 message stored at a PSBT input index.
+     * Returns null if no message is stored.
+     */
+    static get_bip322_message(psbt: BitGoPsbt, input_index: number): string | undefined;
     /**
      * Verify a single input of a BIP-0322 PSBT proof
      *
@@ -318,16 +323,7 @@ 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;
-    /**
-     * Returns the global xpubs from the PSBT as an array of WasmBIP32 instances.
-     */
     get_global_xpubs(): any;
-    /**
-     * 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
@@ -336,23 +332,8 @@ 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.
@@ -368,17 +349,11 @@ export class BitGoPsbt {
      * - `false` otherwise (or if input_index is out of bounds)
      */
     is_musig2_input(input_index: number): boolean;
-    /**
-     * Get the transaction lock time
-     */
     lock_time(): number;
     /**
      * 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
@@ -659,9 +634,6 @@ export class BitGoPsbt {
      * - `Err(WasmUtxoError)` if the input index is out of bounds, derivation fails, or verification fails
      */
     verify_signature_with_xpub(input_index: number, xpub: WasmBIP32): boolean;
-    /**
-     * Get the transaction version
-     */
     version(): number;
     /**
      * Get the Zcash version group ID (returns None for non-Zcash PSBTs)
@@ -1311,7 +1283,7 @@ export class WrapMiniscript {
 export class WrapPsbt {
     free(): void;
     [Symbol.dispose](): void;
-    addInput(txid: string, vout: number, value: bigint, script: Uint8Array, sequence?: number | null): number;
+    add_input(txid: string, vout: number, value: bigint, script: Uint8Array, sequence?: number | null): number;
     /**
      * Add an input to the PSBT
      *
@@ -1325,8 +1297,8 @@ export class WrapPsbt {
      * # Returns
      * The index of the newly added input
      */
-    addInputAtIndex(index: number, txid: string, vout: number, value: bigint, script: Uint8Array, sequence?: number | null): number;
-    addOutput(script: Uint8Array, value: bigint): number;
+    add_input_at_index(index: number, txid: string, vout: number, value: bigint, script: Uint8Array, sequence?: number | null): number;
+    add_output(script: Uint8Array, value: bigint): number;
     /**
      * Add an output to the PSBT
      *
@@ -1337,7 +1309,7 @@ export class WrapPsbt {
      * # Returns
      * The index of the newly added output
      */
-    addOutputAtIndex(index: number, script: Uint8Array, value: bigint): number;
+    add_output_at_index(index: number, script: Uint8Array, value: bigint): number;
     clone(): WrapPsbt;
     static deserialize(psbt: Uint8Array): WrapPsbt;
     /**
@@ -1350,57 +1322,23 @@ export class WrapPsbt {
      * - `Ok(WasmTransaction)` containing the extracted transaction
      * - `Err(WasmUtxoError)` if the PSBT is not fully finalized or extraction fails
      */
-    extractTransaction(): WasmTransaction;
-    finalize(): void;
-    /**
-     * Get global xpubs from the PSBT as an array of WasmBIP32 instances.
-     */
-    getGlobalXpubs(): any;
-    /**
-     * Get all PSBT inputs as an array of PsbtInputData
-     *
-     * Returns an array with witness_utxo, bip32_derivation, and tap_bip32_derivation
-     * for each input. This is useful for introspecting the PSBT structure.
-     */
-    getInputs(): any;
-    /**
-     * Get all PSBT outputs as an array of PsbtOutputData
-     *
-     * Returns an array with script, value, bip32_derivation, and tap_bip32_derivation
-     * for each output. This is useful for introspecting the PSBT structure.
-     */
-    getOutputs(): any;
-    /**
-     * Get all PSBT outputs with resolved address strings.
-     *
-     * Like `getOutputs()` but each element also includes an `address` field
-     * derived from the output script using the given coin name (e.g. "btc", "tbtc").
-     */
-    getOutputsWithAddress(coin: string): any;
-    /**
-     * Get partial signatures for an input
-     * Returns array of { pubkey: Uint8Array, signature: Uint8Array }
-     */
-    getPartialSignatures(input_index: number): any;
+    extract_transaction(): WasmTransaction;
+    finalize_mut(): void;
+    get_global_xpubs(): any;
+    get_inputs(): any;
+    get_outputs(): any;
+    get_outputs_with_address(coin: string): any;
+    get_partial_signatures(input_index: number): any;
     /**
      * Get the unsigned transaction bytes
      *
      * # Returns
      * The serialized unsigned transaction
      */
-    getUnsignedTx(): Uint8Array;
-    /**
-     * Check if an input has any partial signatures
-     */
-    hasPartialSignatures(input_index: number): boolean;
-    /**
-     * Get the number of inputs in the PSBT
-     */
-    inputCount(): number;
-    /**
-     * Get the transaction lock time
-     */
-    lockTime(): number;
+    get_unsigned_tx(): Uint8Array;
+    has_partial_signatures(input_index: number): boolean;
+    input_count(): number;
+    lock_time(): number;
     /**
      * Create an empty PSBT
      *
@@ -1409,12 +1347,9 @@ export class WrapPsbt {
      * * `lock_time` - Transaction lock time (default: 0)
      */
     constructor(version?: number | null, lock_time?: number | null);
-    /**
-     * Get the number of outputs in the PSBT
-     */
-    outputCount(): number;
-    removeInput(index: number): void;
-    removeOutput(index: number): void;
+    output_count(): number;
+    remove_input(index: number): void;
+    remove_output(index: number): void;
     serialize(): Uint8Array;
     /**
      * Sign all inputs with a WasmBIP32 key
@@ -1428,7 +1363,7 @@ export class WrapPsbt {
      * # Returns
      * A SigningKeysMap converted to JsValue (object mapping input indices to signing keys)
      */
-    signAll(key: WasmBIP32): any;
+    sign_all(key: WasmBIP32): any;
     /**
      * Sign all inputs with a WasmECPair key
      *
@@ -1441,23 +1376,13 @@ export class WrapPsbt {
      * # Returns
      * A SigningKeysMap converted to JsValue (object mapping input indices to signing keys)
      */
-    signAllWithEcpair(key: WasmECPair): any;
-    signWithPrv(prv: Uint8Array): any;
-    signWithXprv(xprv: string): any;
-    /**
-     * Get the unsigned transaction ID as a hex string
-     */
-    unsignedTxId(): string;
-    updateInputWithDescriptor(input_index: number, descriptor: WrapDescriptor): void;
-    updateOutputWithDescriptor(output_index: number, descriptor: WrapDescriptor): void;
-    /**
-     * Validate a signature at a specific input against a pubkey
-     * Returns true if the signature is valid
-     *
-     * This method handles both ECDSA (legacy/SegWit) and Schnorr (Taproot) signatures.
-     * The pubkey should be provided as bytes (33 bytes for compressed ECDSA, 32 bytes for x-only Schnorr).
-     */
-    validateSignatureAtInput(input_index: number, pubkey: Uint8Array): boolean;
+    sign_all_with_ecpair(key: WasmECPair): any;
+    sign_with_prv(prv: Uint8Array): any;
+    sign_with_xprv(xprv: string): any;
+    unsigned_tx_id(): string;
+    update_input_with_descriptor(input_index: number, descriptor: WrapDescriptor): void;
+    update_output_with_descriptor(output_index: number, descriptor: WrapDescriptor): void;
+    validate_signature_at_input(input_index: number, pubkey: Uint8Array): boolean;
     /**
      * Verify a signature at a specific input using a WasmBIP32 key
      *
@@ -1474,10 +1399,7 @@ export class WrapPsbt {
      * # Returns
      * `true` if a valid signature exists for the key, `false` otherwise
      */
-    verifySignatureWithKey(input_index: number, key: WasmBIP32): boolean;
-    /**
-     * Get the transaction version
-     */
+    verify_signature_with_key(input_index: number, key: WasmBIP32): boolean;
     version(): number;
 }