@bitgo/wasm-utxo 1.44.0 → 2.1.0

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

@@ -1,8 +1,8 @@
 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 { IPsbtWithAddress } from "../psbt.js";
+import { type WalletKeysArg, RootWalletKeys } from "./RootWalletKeys.js";
 import { type ReplayProtectionArg } from "./ReplayProtection.js";
-import { type BIP32Arg } from "../bip32.js";
+import { type BIP32Arg, BIP32 } from "../bip32.js";
 import { type ECPairArg } from "../ecpair.js";
 import type { UtxolibName } from "../utxolibCompat.js";
 import type { CoinName } from "../coinName.js";
@@ -98,7 +98,7 @@ export type ParseTransactionOptions = {
 export type ParseOutputsOptions = {
     payGoPubkeys?: ECPairArg[];
 };
-export declare class BitGoPsbt implements IPsbtIntrospectionWithAddress {
+export declare class BitGoPsbt implements IPsbtWithAddress {
     protected _wasm: WasmBitGoPsbt;
     protected constructor(_wasm: WasmBitGoPsbt);
     /**
@@ -155,6 +155,8 @@ export declare class BitGoPsbt implements IPsbtIntrospectionWithAddress {
      * }, outputScript);
      * ```
      */
+    addInputAtIndex(index: number, txid: string, vout: number, value: bigint, script: Uint8Array, sequence?: number): number;
+    addInputAtIndex(index: number, options: AddInputOptions, script: Uint8Array): number;
     addInput(options: AddInputOptions, script: Uint8Array): number;
     /**
      * Add an output to the PSBT
@@ -168,41 +170,11 @@ export declare class BitGoPsbt implements IPsbtIntrospectionWithAddress {
      * const outputIndex = psbt.addOutput(outputScript, 50000n);
      * ```
      */
+    addOutputAtIndex(index: number, script: Uint8Array, value: bigint): number;
+    addOutputAtIndex(index: number, address: string, value: bigint): number;
+    addOutputAtIndex(index: number, options: AddOutputOptions): number;
     addOutput(script: Uint8Array, value: bigint): number;
-    /**
-     * Add an output to the PSBT by address
-     *
-     * @param address - The destination address
-     * @param value - Value in satoshis
-     * @returns The index of the newly added output
-     *
-     * @example
-     * ```typescript
-     * const outputIndex = psbt.addOutput("bc1q...", 50000n);
-     * ```
-     */
     addOutput(address: string, value: bigint): number;
-    /**
-     * Add an output to the PSBT
-     *
-     * @param options - Output options (script or address, and value)
-     * @returns The index of the newly added output
-     *
-     * @example
-     * ```typescript
-     * // Using script
-     * const outputIndex = psbt.addOutput({
-     *   script: outputScript,
-     *   value: 50000n,
-     * });
-     *
-     * // Using address
-     * const outputIndex = psbt.addOutput({
-     *   address: "bc1qw508d6qejxtdg4y5r3zarvary0c5xw7kv8f3t4",
-     *   value: 50000n,
-     * });
-     * ```
-     */
     addOutput(options: AddOutputOptions): number;
     /**
      * Add a wallet input with full PSBT metadata
@@ -243,6 +215,7 @@ export declare class BitGoPsbt implements IPsbtIntrospectionWithAddress {
      * );
      * ```
      */
+    addWalletInputAtIndex(index: number, inputOptions: AddInputOptions, walletKeys: WalletKeysArg, walletOptions: AddWalletInputOptions): number;
     addWalletInput(inputOptions: AddInputOptions, walletKeys: WalletKeysArg, walletOptions: AddWalletInputOptions): number;
     /**
      * Add a wallet output with full PSBT metadata
@@ -274,6 +247,7 @@ export declare class BitGoPsbt implements IPsbtIntrospectionWithAddress {
      * });
      * ```
      */
+    addWalletOutputAtIndex(index: number, walletKeys: WalletKeysArg, options: AddWalletOutputOptions): number;
     addWalletOutput(walletKeys: WalletKeysArg, options: AddWalletOutputOptions): number;
     /**
      * Add a replay protection input to the PSBT
@@ -294,22 +268,21 @@ export declare class BitGoPsbt implements IPsbtIntrospectionWithAddress {
      * );
      * ```
      */
+    addReplayProtectionInputAtIndex(index: number, inputOptions: AddInputOptions, key: ECPairArg): number;
     addReplayProtectionInput(inputOptions: AddInputOptions, key: ECPairArg): number;
+    removeInput(index: number): void;
+    removeOutput(index: number): void;
     /**
      * Get the unsigned transaction ID
      * @returns The unsigned transaction ID
      */
-    unsignedTxid(): string;
+    unsignedTxId(): string;
     /**
      * Get the transaction version
      * @returns The transaction version number
      */
-    get version(): number;
-    /**
-     * Get the transaction lock time
-     * @returns The transaction lock time
-     */
-    get lockTime(): number;
+    version(): number;
+    lockTime(): number;
     /**
      * Parse transaction with wallet keys to identify wallet inputs/outputs
      * @param walletKeys - The wallet keys to use for identification
@@ -584,12 +557,8 @@ export declare class BitGoPsbt implements IPsbtIntrospectionWithAddress {
      * 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;
+    inputCount(): number;
+    outputCount(): number;
     /**
      * Get all PSBT inputs as an array
      *
@@ -626,4 +595,19 @@ export declare class BitGoPsbt implements IPsbtIntrospectionWithAddress {
      * ```
      */
     getOutputsWithAddress(): PsbtOutputDataWithAddress[];
+    /**
+     * Returns the unordered global xpubs from this PSBT as BIP32 instances.
+     */
+    getGlobalXpubs(): BIP32[];
 }
+/**
+ * Extract sorted wallet keys from a PSBT's global xpub fields.
+ *
+ * This should only be used in exceptional circumstances where the real wallet
+ * keys are not available — for example, legacy cold wallets where the PSBT
+ * was built with derived keys (from coldDerivationSeed) but the caller only
+ * has root xpubs. Prefer passing wallet keys explicitly wherever possible.
+ *
+ * @returns Sorted [user, backup, bitgo] RootWalletKeys
+ */
+export declare function getWalletKeysFromPsbt(psbt: BitGoPsbt, xpubs: BIP32[]): RootWalletKeys;

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

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BitGoPsbt = void 0;
+exports.getWalletKeysFromPsbt = getWalletKeysFromPsbt;
 const wasm_utxo_js_1 = require("../wasm/wasm_utxo.js");
 const RootWalletKeys_js_1 = require("./RootWalletKeys.js");
 const ReplayProtection_js_1 = require("./ReplayProtection.js");
@@ -56,28 +57,35 @@ class BitGoPsbt {
         const wasm = wasm_utxo_js_1.BitGoPsbt.from_bytes(bytes, network);
         return new BitGoPsbt(wasm);
     }
-    /**
-     * Add an input to the PSBT
-     *
-     * This adds a transaction input and corresponding PSBT input metadata.
-     * The witness_utxo is automatically populated for modern signing compatibility.
-     *
-     * @param options - Input options (txid, vout, value, sequence)
-     * @param script - Output script of the UTXO being spent
-     * @returns The index of the newly added input
-     *
-     * @example
-     * ```typescript
-     * const inputIndex = psbt.addInput({
-     *   txid: "abc123...",
-     *   vout: 0,
-     *   value: 100000n,
-     * }, outputScript);
-     * ```
-     */
+    addInputAtIndex(index, txidOrOptions, voutOrScript, value, script, sequence) {
+        if (typeof txidOrOptions === "string") {
+            return this._wasm.add_input_at_index(index, txidOrOptions, voutOrScript, value, script, sequence);
+        }
+        const options = txidOrOptions;
+        return this._wasm.add_input_at_index(index, options.txid, options.vout, options.value, voutOrScript, options.sequence, options.prevTx);
+    }
     addInput(options, script) {
         return this._wasm.add_input(options.txid, options.vout, options.value, script, options.sequence, options.prevTx);
     }
+    addOutputAtIndex(index, scriptOrOptions, value) {
+        if (scriptOrOptions instanceof Uint8Array || typeof scriptOrOptions === "string") {
+            if (value === undefined) {
+                throw new Error("Value is required when passing a script or address");
+            }
+            if (scriptOrOptions instanceof Uint8Array) {
+                return this._wasm.add_output_at_index(index, scriptOrOptions, value);
+            }
+            return this._wasm.add_output_with_address_at_index(index, scriptOrOptions, value);
+        }
+        const options = scriptOrOptions;
+        if ("script" in options) {
+            return this._wasm.add_output_at_index(index, options.script, options.value);
+        }
+        if ("address" in options) {
+            return this._wasm.add_output_with_address_at_index(index, options.address, options.value);
+        }
+        throw new Error("Invalid output options");
+    }
     addOutput(scriptOrOptions, value) {
         if (scriptOrOptions instanceof Uint8Array || typeof scriptOrOptions === "string") {
             if (value === undefined) {
@@ -136,6 +144,10 @@ class BitGoPsbt {
      * );
      * ```
      */
+    addWalletInputAtIndex(index, inputOptions, walletKeys, walletOptions) {
+        const keys = RootWalletKeys_js_1.RootWalletKeys.from(walletKeys);
+        return this._wasm.add_wallet_input_at_index(index, inputOptions.txid, inputOptions.vout, inputOptions.value, keys.wasm, walletOptions.scriptId.chain, walletOptions.scriptId.index, walletOptions.signPath?.signer, walletOptions.signPath?.cosigner, inputOptions.sequence, inputOptions.prevTx);
+    }
     addWalletInput(inputOptions, walletKeys, walletOptions) {
         const keys = RootWalletKeys_js_1.RootWalletKeys.from(walletKeys);
         return this._wasm.add_wallet_input(inputOptions.txid, inputOptions.vout, inputOptions.value, keys.wasm, walletOptions.scriptId.chain, walletOptions.scriptId.index, walletOptions.signPath?.signer, walletOptions.signPath?.cosigner, inputOptions.sequence, inputOptions.prevTx);
@@ -170,6 +182,10 @@ class BitGoPsbt {
      * });
      * ```
      */
+    addWalletOutputAtIndex(index, walletKeys, options) {
+        const keys = RootWalletKeys_js_1.RootWalletKeys.from(walletKeys);
+        return this._wasm.add_wallet_output_at_index(index, options.chain, options.index, options.value, keys.wasm);
+    }
     addWalletOutput(walletKeys, options) {
         const keys = RootWalletKeys_js_1.RootWalletKeys.from(walletKeys);
         return this._wasm.add_wallet_output(options.chain, options.index, options.value, keys.wasm);
@@ -193,29 +209,35 @@ class BitGoPsbt {
      * );
      * ```
      */
+    addReplayProtectionInputAtIndex(index, inputOptions, key) {
+        const ecpair = ecpair_js_1.ECPair.from(key);
+        return this._wasm.add_replay_protection_input_at_index(index, ecpair.wasm, inputOptions.txid, inputOptions.vout, inputOptions.value, inputOptions.sequence, inputOptions.prevTx);
+    }
     addReplayProtectionInput(inputOptions, key) {
         const ecpair = ecpair_js_1.ECPair.from(key);
         return this._wasm.add_replay_protection_input(ecpair.wasm, inputOptions.txid, inputOptions.vout, inputOptions.value, inputOptions.sequence, inputOptions.prevTx);
     }
+    removeInput(index) {
+        this._wasm.remove_input(index);
+    }
+    removeOutput(index) {
+        this._wasm.remove_output(index);
+    }
     /**
      * Get the unsigned transaction ID
      * @returns The unsigned transaction ID
      */
-    unsignedTxid() {
+    unsignedTxId() {
         return this._wasm.unsigned_txid();
     }
     /**
      * Get the transaction version
      * @returns The transaction version number
      */
-    get version() {
+    version() {
         return this._wasm.version();
     }
-    /**
-     * Get the transaction lock time
-     * @returns The transaction lock time
-     */
-    get lockTime() {
+    lockTime() {
         return this._wasm.lock_time();
     }
     /**
@@ -541,14 +563,10 @@ class BitGoPsbt {
      * Get the number of inputs in the PSBT
      * @returns The number of inputs
      */
-    get inputCount() {
+    inputCount() {
         return this._wasm.input_count();
     }
-    /**
-     * Get the number of outputs in the PSBT
-     * @returns The number of outputs
-     */
-    get outputCount() {
+    outputCount() {
         return this._wasm.output_count();
     }
     /**
@@ -593,5 +611,26 @@ class BitGoPsbt {
     getOutputsWithAddress() {
         return this._wasm.get_outputs_with_address();
     }
+    /**
+     * Returns the unordered global xpubs from this PSBT as BIP32 instances.
+     */
+    getGlobalXpubs() {
+        const result = this._wasm.get_global_xpubs();
+        return result.map((w) => bip32_js_1.BIP32.fromWasm(w));
+    }
 }
 exports.BitGoPsbt = BitGoPsbt;
+/**
+ * Extract sorted wallet keys from a PSBT's global xpub fields.
+ *
+ * This should only be used in exceptional circumstances where the real wallet
+ * keys are not available — for example, legacy cold wallets where the PSBT
+ * was built with derived keys (from coldDerivationSeed) but the caller only
+ * has root xpubs. Prefer passing wallet keys explicitly wherever possible.
+ *
+ * @returns Sorted [user, backup, bitgo] RootWalletKeys
+ */
+function getWalletKeysFromPsbt(psbt, xpubs) {
+    const wasmKeys = wasm_utxo_js_1.FixedScriptWalletNamespace.to_wallet_keys(psbt.wasm, xpubs[0].wasm, xpubs[1].wasm, xpubs[2].wasm);
+    return RootWalletKeys_js_1.RootWalletKeys.fromWasm(wasmKeys);
+}

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

@@ -23,6 +23,11 @@ Triple<string>
 export declare class RootWalletKeys {
     private _wasm;
     private constructor();
+    /**
+     * Create a RootWalletKeys instance from a WasmRootWalletKeys instance (internal use)
+     * @internal
+     */
+    static fromWasm(wasm: WasmRootWalletKeys): RootWalletKeys;
     /**
      * Create a RootWalletKeys from various input formats
      * @param keys - Can be a triple of xpub strings, an IWalletKeys object, or another RootWalletKeys instance

package/dist/cjs/js/fixedScriptWallet/RootWalletKeys.js

@@ -35,6 +35,13 @@ class RootWalletKeys {
     constructor(_wasm) {
         this._wasm = _wasm;
     }
+    /**
+     * Create a RootWalletKeys instance from a WasmRootWalletKeys instance (internal use)
+     * @internal
+     */
+    static fromWasm(wasm) {
+        return new RootWalletKeys(wasm);
+    }
     /**
      * Create a RootWalletKeys from various input formats
      * @param keys - Can be a triple of xpub strings, an IWalletKeys object, or another RootWalletKeys instance

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

@@ -5,7 +5,7 @@ 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, type ParseTransactionOptions, type ParseOutputsOptions, } from "./BitGoPsbt.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, } 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";

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ZcashBitGoPsbt = exports.BitGoPsbt = exports.assertChainCode = exports.chainCodes = exports.ChainCode = exports.inputScriptTypes = exports.outputScriptTypes = exports.Dimensions = exports.address = exports.outputScript = exports.ReplayProtection = exports.RootWalletKeys = void 0;
+exports.ZcashBitGoPsbt = exports.getWalletKeysFromPsbt = exports.BitGoPsbt = 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;
@@ -24,6 +24,7 @@ Object.defineProperty(exports, "assertChainCode", { enumerable: true, get: funct
 // Bitcoin-like PSBT (for all non-Zcash networks)
 var BitGoPsbt_js_1 = require("./BitGoPsbt.js");
 Object.defineProperty(exports, "BitGoPsbt", { enumerable: true, get: function () { return BitGoPsbt_js_1.BitGoPsbt; } });
+Object.defineProperty(exports, "getWalletKeysFromPsbt", { enumerable: true, get: function () { return BitGoPsbt_js_1.getWalletKeysFromPsbt; } });
 // Zcash-specific PSBT subclass
 var ZcashBitGoPsbt_js_1 = require("./ZcashBitGoPsbt.js");
 Object.defineProperty(exports, "ZcashBitGoPsbt", { enumerable: true, get: function () { return ZcashBitGoPsbt_js_1.ZcashBitGoPsbt; } });

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

@@ -74,6 +74,7 @@ declare module "./wasm/wasm_utxo.js" {
         getInputs(): PsbtInputData[];
         getOutputs(): PsbtOutputData[];
         getOutputsWithAddress(coin: import("./coinName.js").CoinName): PsbtOutputDataWithAddress[];
+        getGlobalXpubs(): WasmBIP32[];
         getPartialSignatures(inputIndex: number): Array<{
             pubkey: Uint8Array;
             signature: Uint8Array;
@@ -82,6 +83,10 @@ declare module "./wasm/wasm_utxo.js" {
         validateSignatureAtInput(inputIndex: number, pubkey: Uint8Array): boolean;
         verifySignatureWithKey(inputIndex: number, key: WasmBIP32): boolean;
         extractTransaction(): WasmTransaction;
+        addInputAtIndex(index: number, txid: string, vout: number, value: bigint, script: Uint8Array, sequence?: number): number;
+        addOutputAtIndex(index: number, script: Uint8Array, value: bigint): number;
+        removeInput(index: number): void;
+        removeOutput(index: number): void;
         unsignedTxId(): string;
         lockTime(): number;
         version(): number;
@@ -91,4 +96,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, type IPsbtIntrospection, type IPsbtIntrospectionWithAddress, } from "./psbt.js";
+export { hasPsbtMagic, type IPsbt, type IPsbtWithAddress } from "./psbt.js";

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

@@ -1,13 +1,22 @@
 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;
+import type { BIP32 } from "./bip32.js";
+/** Common interface for PSBT types */
+export interface IPsbt {
+    inputCount(): number;
+    outputCount(): number;
     getInputs(): PsbtInputData[];
     getOutputs(): PsbtOutputData[];
+    getGlobalXpubs(): BIP32[];
+    version(): number;
+    lockTime(): number;
+    unsignedTxId(): string;
+    addInputAtIndex(index: number, txid: string, vout: number, value: bigint, script: Uint8Array, sequence?: number): number;
+    addOutputAtIndex(index: number, script: Uint8Array, value: bigint): number;
+    removeInput(index: number): void;
+    removeOutput(index: number): void;
 }
-/** Extended introspection with address resolution (no coin parameter needed) */
-export interface IPsbtIntrospectionWithAddress extends IPsbtIntrospection {
+/** Extended PSBT with address resolution (no coin parameter needed) */
+export interface IPsbtWithAddress extends IPsbt {
     getOutputsWithAddress(): PsbtOutputDataWithAddress[];
 }
 /**

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

@@ -30,13 +30,9 @@ export declare class Transaction implements ITransaction {
      * @param sequence - Optional sequence number (default: 0xFFFFFFFF)
      * @returns The index of the newly added input
      */
+    addInputAtIndex(index: number, txid: string, vout: number, sequence?: number): number;
     addInput(txid: string, vout: number, sequence?: number): number;
-    /**
-     * Add an output to the transaction
-     * @param script - Output script (scriptPubKey)
-     * @param value - Value in satoshis
-     * @returns The index of the newly added output
-     */
+    addOutputAtIndex(index: number, script: Uint8Array, value: bigint): number;
     addOutput(script: Uint8Array, value: bigint): number;
     toBytes(): Uint8Array;
     /**

package/dist/cjs/js/transaction.js

@@ -34,15 +34,15 @@ class Transaction {
      * @param sequence - Optional sequence number (default: 0xFFFFFFFF)
      * @returns The index of the newly added input
      */
+    addInputAtIndex(index, txid, vout, sequence) {
+        return this._wasm.add_input_at_index(index, txid, vout, sequence);
+    }
     addInput(txid, vout, sequence) {
         return this._wasm.add_input(txid, vout, sequence);
     }
-    /**
-     * Add an output to the transaction
-     * @param script - Output script (scriptPubKey)
-     * @param value - Value in satoshis
-     * @returns The index of the newly added output
-     */
+    addOutputAtIndex(index, script, value) {
+        return this._wasm.add_output_at_index(index, script, value);
+    }
     addOutput(script, value) {
         return this._wasm.add_output(script, value);
     }