@bitgo/wasm-utxo 2.1.0 → 3.0.0

package/dist/esm/js/descriptorWallet/Psbt.js

@@ -0,0 +1,122 @@
+import { WrapPsbt as WasmPsbt, } from "../wasm/wasm_utxo.js";
+import { Transaction } from "../transaction.js";
+export class Psbt {
+    _wasm;
+    constructor(versionOrWasm, lockTime) {
+        if (versionOrWasm instanceof WasmPsbt) {
+            this._wasm = versionOrWasm;
+        }
+        else {
+            this._wasm = new WasmPsbt(versionOrWasm, lockTime);
+        }
+    }
+    /** @internal Access the underlying WASM instance */
+    get wasm() {
+        return this._wasm;
+    }
+    // -- Static / Factory --
+    static create(version, lockTime) {
+        return new Psbt(new WasmPsbt(version, lockTime));
+    }
+    static deserialize(bytes) {
+        return new Psbt(WasmPsbt.deserialize(bytes));
+    }
+    // -- Serialization --
+    serialize() {
+        return this._wasm.serialize();
+    }
+    clone() {
+        return new Psbt(this._wasm.clone());
+    }
+    // -- IPsbt: introspection --
+    inputCount() {
+        return this._wasm.input_count();
+    }
+    outputCount() {
+        return this._wasm.output_count();
+    }
+    version() {
+        return this._wasm.version();
+    }
+    lockTime() {
+        return this._wasm.lock_time();
+    }
+    unsignedTxId() {
+        return this._wasm.unsigned_tx_id();
+    }
+    getInputs() {
+        return this._wasm.get_inputs();
+    }
+    getOutputs() {
+        return this._wasm.get_outputs();
+    }
+    getGlobalXpubs() {
+        return this._wasm.get_global_xpubs();
+    }
+    getOutputsWithAddress(coin) {
+        return this._wasm.get_outputs_with_address(coin);
+    }
+    // -- IPsbt: mutation --
+    addInputAtIndex(index, txid, vout, value, script, sequence) {
+        return this._wasm.add_input_at_index(index, txid, vout, value, script, sequence);
+    }
+    addInput(txid, vout, value, script, sequence) {
+        return this._wasm.add_input(txid, vout, value, script, sequence);
+    }
+    addOutputAtIndex(index, script, value) {
+        return this._wasm.add_output_at_index(index, script, value);
+    }
+    addOutput(script, value) {
+        return this._wasm.add_output(script, value);
+    }
+    removeInput(index) {
+        this._wasm.remove_input(index);
+    }
+    removeOutput(index) {
+        this._wasm.remove_output(index);
+    }
+    // -- Descriptor updates --
+    updateInputWithDescriptor(inputIndex, descriptor) {
+        this._wasm.update_input_with_descriptor(inputIndex, descriptor);
+    }
+    updateOutputWithDescriptor(outputIndex, descriptor) {
+        this._wasm.update_output_with_descriptor(outputIndex, descriptor);
+    }
+    // -- Signing --
+    signWithXprv(xprv) {
+        return this._wasm.sign_with_xprv(xprv);
+    }
+    signWithPrv(prv) {
+        return this._wasm.sign_with_prv(prv);
+    }
+    signAll(key) {
+        return this._wasm.sign_all(key);
+    }
+    signAllWithEcpair(key) {
+        return this._wasm.sign_all_with_ecpair(key);
+    }
+    // -- Signature introspection --
+    getPartialSignatures(inputIndex) {
+        return this._wasm.get_partial_signatures(inputIndex);
+    }
+    hasPartialSignatures(inputIndex) {
+        return this._wasm.has_partial_signatures(inputIndex);
+    }
+    // -- Validation --
+    validateSignatureAtInput(inputIndex, pubkey) {
+        return this._wasm.validate_signature_at_input(inputIndex, pubkey);
+    }
+    verifySignatureWithKey(inputIndex, key) {
+        return this._wasm.verify_signature_with_key(inputIndex, key);
+    }
+    // -- Transaction extraction --
+    getUnsignedTx() {
+        return this._wasm.get_unsigned_tx();
+    }
+    finalize() {
+        this._wasm.finalize_mut();
+    }
+    extractTransaction() {
+        return Transaction.fromWasm(this._wasm.extract_transaction());
+    }
+}

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

@@ -40,4 +40,5 @@ export * from "./DescriptorOutput.js";
 export * from "./address.js";
 export * from "./VirtualSize.js";
 export * from "./psbt/index.js";
+export { Psbt, type SignPsbtResult } from "./Psbt.js";
 export * from "./parse/PatternMatcher.js";

package/dist/esm/js/descriptorWallet/index.js

@@ -42,5 +42,7 @@ export * from "./address.js";
 export * from "./VirtualSize.js";
 // PSBT utilities
 export * from "./psbt/index.js";
+// PSBT wrapper
+export { Psbt } from "./Psbt.js";
 // Pattern matching
 export * from "./parse/PatternMatcher.js";

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

@@ -17,9 +17,6 @@ export type { AddressFormat } from "./address.js";
 export type { TapLeafScript, PreparedInscriptionRevealData } from "./inscriptions.js";
 export type DescriptorPkType = "derivable" | "definite" | "string";
 export type ScriptContext = "tap" | "segwitv0" | "legacy";
-export type SignPsbtResult = {
-    [inputIndex: number]: [pubkey: string][];
-};
 declare module "./wasm/wasm_utxo.js" {
     interface WrapDescriptor {
         /** These are not the same types of nodes as in the ast module */
@@ -64,36 +61,9 @@ declare module "./wasm/wasm_utxo.js" {
     interface PsbtOutputDataWithAddress extends PsbtOutputData {
         address: string;
     }
-    interface WrapPsbt {
-        signWithXprv(this: WrapPsbt, xprv: string): SignPsbtResult;
-        signWithPrv(this: WrapPsbt, prv: Uint8Array): SignPsbtResult;
-        signAll(this: WrapPsbt, key: WasmBIP32): SignPsbtResult;
-        signAllWithEcpair(this: WrapPsbt, key: WasmECPair): SignPsbtResult;
-        inputCount(): number;
-        outputCount(): number;
-        getInputs(): PsbtInputData[];
-        getOutputs(): PsbtOutputData[];
-        getOutputsWithAddress(coin: import("./coinName.js").CoinName): PsbtOutputDataWithAddress[];
-        getGlobalXpubs(): WasmBIP32[];
-        getPartialSignatures(inputIndex: number): Array<{
-            pubkey: Uint8Array;
-            signature: Uint8Array;
-        }>;
-        hasPartialSignatures(inputIndex: number): boolean;
-        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;
-    }
 }
 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 { Psbt } from "./descriptorWallet/Psbt.js";
 export { DashTransaction, Transaction, ZcashTransaction } from "./transaction.js";
 export { hasPsbtMagic, type IPsbt, type IPsbtWithAddress } from "./psbt.js";

package/dist/esm/js/index.js

@@ -21,6 +21,6 @@ export { Dimensions } from "./fixedScriptWallet/Dimensions.js";
 export { getMainnet, isMainnet, isTestnet, isCoinName } from "./coinName.js";
 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 { Psbt } from "./descriptorWallet/Psbt.js";
 export { DashTransaction, Transaction, ZcashTransaction } from "./transaction.js";
 export { hasPsbtMagic } from "./psbt.js";

package/dist/esm/js/testutils/AcidTest.d.ts

@@ -94,7 +94,7 @@ export { inputScriptTypes, outputScriptTypes };
  * - psbt-lite: Only witness_utxo (no non_witness_utxo)
  */
 export declare class AcidTest {
-    readonly network: CoinName;
+    readonly coin: CoinName;
     readonly signStage: SignStage;
     readonly txFormat: TxFormat;
     readonly rootWalletKeys: RootWalletKeys;
@@ -104,11 +104,11 @@ export declare class AcidTest {
     private readonly userXprv;
     private readonly backupXprv;
     private readonly bitgoXprv;
-    constructor(network: CoinName, signStage: SignStage, txFormat: TxFormat, rootWalletKeys: RootWalletKeys, otherWalletKeys: RootWalletKeys, inputs: Input[], outputs: Output[], xprvTriple: Triple<BIP32>);
+    constructor(coin: CoinName, signStage: SignStage, txFormat: TxFormat, rootWalletKeys: RootWalletKeys, otherWalletKeys: RootWalletKeys, inputs: Input[], outputs: Output[], xprvTriple: Triple<BIP32>);
     /**
      * Create an AcidTest with specific configuration
      */
-    static withConfig(network: CoinName, signStage: SignStage, txFormat: TxFormat, suiteConfig?: SuiteConfig): AcidTest;
+    static withConfig(coin: CoinName, signStage: SignStage, txFormat: TxFormat, suiteConfig?: SuiteConfig): AcidTest;
     /**
      * Get a human-readable name for this test configuration
      */

package/dist/esm/js/testutils/AcidTest.js

@@ -1,13 +1,29 @@
 import { BitGoPsbt } from "../fixedScriptWallet/BitGoPsbt.js";
 import { ZcashBitGoPsbt } from "../fixedScriptWallet/ZcashBitGoPsbt.js";
 import { ECPair } from "../ecpair.js";
-import { assertChainCode, ChainCode, createOpReturnScript, inputScriptTypes, outputScript, outputScriptTypes, supportsScriptType, } from "../fixedScriptWallet/index.js";
+import { Transaction } from "../transaction.js";
+import { ChainCode, createOpReturnScript, inputScriptTypes, outputScript, outputScriptTypes, p2shP2pkOutputScript, supportsScriptType, } from "../fixedScriptWallet/index.js";
 import { coinNames, isMainnet } from "../coinName.js";
 import { getDefaultWalletKeys, getWalletKeysForSeed, getKeyTriple } from "./keys.js";
 export const signStages = ["unsigned", "halfsigned", "fullsigned"];
 export const txFormats = ["psbt", "psbt-lite"];
 // Re-export for convenience
 export { inputScriptTypes, outputScriptTypes };
+/** Map InputScriptType to the OutputScriptType used for chain code derivation */
+function inputScriptTypeToOutputScriptType(scriptType) {
+    switch (scriptType) {
+        case "p2sh":
+        case "p2shP2wsh":
+        case "p2wsh":
+        case "p2trLegacy":
+            return scriptType;
+        case "p2shP2pk":
+            return "p2sh";
+        case "p2trMusig2ScriptPath":
+        case "p2trMusig2KeyPath":
+            return "p2trMusig2";
+    }
+}
 /**
  * Creates a valid PSBT with as many features as possible (kitchen sink).
  *
@@ -30,7 +46,7 @@ export { inputScriptTypes, outputScriptTypes };
  * - psbt-lite: Only witness_utxo (no non_witness_utxo)
  */
 export class AcidTest {
-    network;
+    coin;
     signStage;
     txFormat;
     rootWalletKeys;
@@ -41,8 +57,8 @@ export class AcidTest {
     userXprv;
     backupXprv;
     bitgoXprv;
-    constructor(network, signStage, txFormat, rootWalletKeys, otherWalletKeys, inputs, outputs, xprvTriple) {
-        this.network = network;
+    constructor(coin, signStage, txFormat, rootWalletKeys, otherWalletKeys, inputs, outputs, xprvTriple) {
+        this.coin = coin;
         this.signStage = signStage;
         this.txFormat = txFormat;
         this.rootWalletKeys = rootWalletKeys;
@@ -56,7 +72,7 @@ export class AcidTest {
     /**
      * Create an AcidTest with specific configuration
      */
-    static withConfig(network, signStage, txFormat, suiteConfig = {}) {
+    static withConfig(coin, signStage, txFormat, suiteConfig = {}) {
         const rootWalletKeys = getDefaultWalletKeys();
         const otherWalletKeys = getWalletKeysForSeed("too many secrets");
         // Filter inputs based on network support
@@ -67,9 +83,9 @@ export class AcidTest {
                 return true;
             // Map input script types to output script types for support check
             if (scriptType === "p2trMusig2KeyPath" || scriptType === "p2trMusig2ScriptPath") {
-                return supportsScriptType(network, "p2trMusig2");
+                return supportsScriptType(coin, "p2trMusig2");
             }
-            return supportsScriptType(network, scriptType);
+            return supportsScriptType(coin, scriptType);
         })
             .filter((scriptType) => (suiteConfig.includeP2trMusig2ScriptPath ?? false) ||
             scriptType !== "p2trMusig2ScriptPath")
@@ -79,7 +95,7 @@ export class AcidTest {
         }));
         // Filter outputs based on network support
         const outputs = outputScriptTypes
-            .filter((scriptType) => supportsScriptType(network, scriptType))
+            .filter((scriptType) => supportsScriptType(coin, scriptType))
             .map((scriptType, index) => ({
             scriptType,
             value: BigInt(900 + index * 100), // Deterministic amounts
@@ -92,13 +108,13 @@ export class AcidTest {
         outputs.push({ opReturn: "setec astronomy", value: BigInt(0) });
         // Get private keys for signing
         const xprvTriple = getKeyTriple("default");
-        return new AcidTest(network, signStage, txFormat, rootWalletKeys, otherWalletKeys, inputs, outputs, xprvTriple);
+        return new AcidTest(coin, signStage, txFormat, rootWalletKeys, otherWalletKeys, inputs, outputs, xprvTriple);
     }
     /**
      * Get a human-readable name for this test configuration
      */
     get name() {
-        return `${this.network} ${this.signStage} ${this.txFormat}`;
+        return `${this.coin} ${this.signStage} ${this.txFormat}`;
     }
     /**
      * Get the BIP32 user key for replay protection (p2shP2pk)
@@ -111,58 +127,55 @@ export class AcidTest {
      */
     createPsbt() {
         // Use ZcashBitGoPsbt for Zcash networks
-        const isZcash = this.network === "zec" || this.network === "tzec";
+        const isZcash = this.coin === "zec" || this.coin === "tzec";
         const psbt = isZcash
-            ? ZcashBitGoPsbt.createEmptyWithConsensusBranchId(this.network, this.rootWalletKeys, {
-                version: 2,
-                lockTime: 0,
-                consensusBranchId: 0xc2d6d0b4, // NU5
+            ? ZcashBitGoPsbt.createEmpty(this.coin, this.rootWalletKeys, {
+                // Sapling activation height: mainnet=419200, testnet=280000
+                blockHeight: this.coin === "zec" ? 419200 : 280000,
             })
-            : BitGoPsbt.createEmpty(this.network, this.rootWalletKeys, {
+            : BitGoPsbt.createEmpty(this.coin, this.rootWalletKeys, {
                 version: 2,
                 lockTime: 0,
             });
+        // Build a fake previous transaction for non_witness_utxo (psbt format)
+        const usePrevTx = this.txFormat === "psbt" && !isZcash;
+        const buildPrevTx = (vout, script, value) => {
+            if (!usePrevTx)
+                return undefined;
+            const tx = Transaction.create();
+            tx.addInput("0".repeat(64), 0xffffffff);
+            for (let i = 0; i < vout; i++) {
+                tx.addOutput(new Uint8Array(0), 0n);
+            }
+            tx.addOutput(script, value);
+            return tx.toBytes();
+        };
         // Add inputs with deterministic outpoints
         this.inputs.forEach((input, index) => {
-            // Resolve scriptId: either from explicit scriptId or from scriptType + index
-            const scriptId = input.scriptId ?? {
-                chain: ChainCode.value("p2sh", "external"),
-                index: input.index ?? index,
-            };
             const walletKeys = input.walletKeys ?? this.rootWalletKeys;
-            // Get scriptType: either explicit or derive from scriptId chain
-            const scriptType = input.scriptType ?? ChainCode.scriptType(assertChainCode(scriptId.chain));
-            if (scriptType === "p2shP2pk") {
-                // Add replay protection input
-                const replayKey = this.getReplayProtectionKey();
-                // Convert BIP32 to ECPair using public key
-                const ecpair = ECPair.fromPublicKey(replayKey.publicKey);
-                psbt.addReplayProtectionInput({
-                    txid: "0".repeat(64),
-                    vout: index,
-                    value: input.value,
-                }, ecpair);
+            const outpoint = { txid: "0".repeat(64), vout: index, value: input.value };
+            // scriptId variant: caller provides explicit chain + index
+            if (input.scriptId) {
+                const script = outputScript(walletKeys, input.scriptId.chain, input.scriptId.index, this.coin);
+                psbt.addWalletInput({ ...outpoint, prevTx: buildPrevTx(index, script, input.value) }, walletKeys, { scriptId: input.scriptId, signPath: { signer: "user", cosigner: "bitgo" } });
+                return;
             }
-            else {
-                // Determine signing path based on input type
-                let signPath;
-                if (scriptType === "p2trMusig2ScriptPath") {
-                    // Script path uses user + backup
-                    signPath = { signer: "user", cosigner: "backup" };
-                }
-                else {
-                    // Default: user + bitgo
-                    signPath = { signer: "user", cosigner: "bitgo" };
-                }
-                psbt.addWalletInput({
-                    txid: "0".repeat(64),
-                    vout: index,
-                    value: input.value,
-                }, walletKeys, {
-                    scriptId,
-                    signPath,
-                });
+            const scriptType = input.scriptType ?? "p2sh";
+            if (scriptType === "p2shP2pk") {
+                const ecpair = ECPair.fromPublicKey(this.getReplayProtectionKey().publicKey);
+                const script = p2shP2pkOutputScript(ecpair.publicKey);
+                psbt.addReplayProtectionInput({ ...outpoint, prevTx: buildPrevTx(index, script, input.value) }, ecpair);
+                return;
             }
+            const scriptId = {
+                chain: ChainCode.value(inputScriptTypeToOutputScriptType(scriptType), "external"),
+                index: input.index ?? index,
+            };
+            const signPath = scriptType === "p2trMusig2ScriptPath"
+                ? { signer: "user", cosigner: "backup" }
+                : { signer: "user", cosigner: "bitgo" };
+            const script = outputScript(walletKeys, scriptId.chain, scriptId.index, this.coin);
+            psbt.addWalletInput({ ...outpoint, prevTx: buildPrevTx(index, script, input.value) }, walletKeys, { scriptId, signPath });
         });
         // Add outputs
         this.outputs.forEach((output, index) => {
@@ -193,7 +206,7 @@ export class AcidTest {
                         chain: scriptId.chain,
                         index: output.index ?? 1000 + index,
                     };
-                    const script = outputScript(this.rootWalletKeys, externalScriptId.chain, externalScriptId.index, this.network);
+                    const script = outputScript(this.rootWalletKeys, externalScriptId.chain, externalScriptId.index, this.coin);
                     psbt.addOutput(script, output.value);
                 }
                 else {
@@ -224,36 +237,22 @@ export class AcidTest {
         // Generate MuSig2 nonces for user if needed
         const hasMusig2Inputs = this.inputs.some((input) => input.scriptType === "p2trMusig2KeyPath" || input.scriptType === "p2trMusig2ScriptPath");
         if (hasMusig2Inputs) {
-            const isZcash = this.network === "zec" || this.network === "tzec";
-            if (isZcash) {
+            if (this.coin === "zec" || this.coin === "tzec") {
                 throw new Error("Zcash does not support MuSig2/Taproot inputs");
             }
-            // Generate nonces with user key
+            // MuSig2 requires ALL participant nonces before ANY signing.
+            // Generate nonces directly on the same PSBT for each participant key.
             psbt.generateMusig2Nonces(userKey);
-            if (this.signStage === "fullsigned") {
-                // Create a second PSBT with cosigner nonces for combination
-                // For p2trMusig2ScriptPath use backup, for p2trMusig2KeyPath use bitgo
-                // Since we might have both types, we need to generate nonces separately
-                const bytes = psbt.serialize();
-                const hasKeyPath = this.inputs.some((input) => input.scriptType === "p2trMusig2KeyPath");
-                const hasScriptPath = this.inputs.some((input) => input.scriptType === "p2trMusig2ScriptPath");
-                if (hasKeyPath && !hasScriptPath) {
-                    // Only key path inputs - generate bitgo nonces for all
-                    const psbt2 = BitGoPsbt.fromBytes(bytes, this.network);
-                    psbt2.generateMusig2Nonces(bitgoKey);
-                    psbt.combineMusig2Nonces(psbt2);
-                }
-                else if (hasScriptPath && !hasKeyPath) {
-                    // Only script path inputs - generate backup nonces for all
-                    const psbt2 = BitGoPsbt.fromBytes(bytes, this.network);
-                    psbt2.generateMusig2Nonces(backupKey);
-                    psbt.combineMusig2Nonces(psbt2);
-                }
-                else {
-                    const psbt2 = BitGoPsbt.fromBytes(bytes, this.network);
-                    psbt2.generateMusig2Nonces(bitgoKey);
-                    psbt.combineMusig2Nonces(psbt2);
-                }
+            const hasKeyPath = this.inputs.some((input) => input.scriptType === "p2trMusig2KeyPath");
+            const hasScriptPath = this.inputs.some((input) => input.scriptType === "p2trMusig2ScriptPath");
+            // Key path uses user+bitgo, script path uses user+backup.
+            // generateMusig2Nonces fails if the key isn't a participant in any musig2 input,
+            // so we only call it for keys that match.
+            if (hasKeyPath) {
+                psbt.generateMusig2Nonces(bitgoKey);
+            }
+            if (hasScriptPath) {
+                psbt.generateMusig2Nonces(backupKey);
             }
         }
         // Sign all wallet inputs with user key (bulk - more efficient)
@@ -296,7 +295,7 @@ export class AcidTest {
      */
     static forAllNetworksSignStagesTxFormats(suiteConfig = {}) {
         return coinNames
-            .filter((network) => isMainnet(network) && network !== "bsv") // Exclude bitcoinsv
+            .filter((network) => isMainnet(network) && network !== "bsv")
             .flatMap((network) => signStages.flatMap((signStage) => txFormats.map((txFormat) => AcidTest.withConfig(network, signStage, txFormat, suiteConfig))));
     }
 }