@bitgo/wasm-utxo 1.3.0 → 1.5.0

package/dist/{browser → esm}/js/fixedScriptWallet.d.ts

@@ -1,7 +1,7 @@
-import type { UtxolibName, UtxolibNetwork, UtxolibRootWalletKeys } from "./utxolibCompat";
-import type { CoinName } from "./coinName";
-import { Triple } from "./triple";
-import { AddressFormat } from "./address";
+import type { UtxolibName, UtxolibNetwork, UtxolibRootWalletKeys } from "./utxolibCompat.js";
+import type { CoinName } from "./coinName.js";
+import { Triple } from "./triple.js";
+import { AddressFormat } from "./address.js";
 export type NetworkName = UtxolibName | CoinName;
 export type WalletKeys = 
 /** Just an xpub triple, will assume default derivation prefixes  */
@@ -121,5 +121,24 @@ export declare class BitGoPsbt {
      * @throws Error if the input is not a replay protection input, index is out of bounds, or scripts are invalid
      */
     verifyReplayProtectionSignature(inputIndex: number, replayProtection: ReplayProtection): boolean;
+    /**
+     * Serialize the PSBT to bytes
+     *
+     * @returns The serialized PSBT as a byte array
+     */
+    serialize(): Uint8Array;
+    /**
+     * Finalize all inputs in the PSBT
+     *
+     * @throws Error if any input failed to finalize
+     */
+    finalizeAllInputs(): void;
+    /**
+     * Extract the final transaction from a finalized PSBT
+     *
+     * @returns The serialized transaction bytes
+     * @throws Error if the PSBT is not fully finalized or extraction fails
+     */
+    extractTransaction(): Uint8Array;
 }
 export {};

package/dist/{browser → esm}/js/fixedScriptWallet.js

@@ -1,4 +1,4 @@
-import { FixedScriptWalletNamespace } from "./wasm/wasm_utxo";
+import { FixedScriptWalletNamespace } from "./wasm/wasm_utxo.js";
 /**
  * Create the output script for a given wallet keys and chain and index
  */
@@ -20,8 +20,9 @@ export function outputScript(keys, chain, index, network) {
 export function address(keys, chain, index, network, addressFormat) {
     return FixedScriptWalletNamespace.address(keys, chain, index, network, addressFormat);
 }
-import { BitGoPsbt as WasmBitGoPsbt } from "./wasm/wasm_utxo";
+import { BitGoPsbt as WasmBitGoPsbt } from "./wasm/wasm_utxo.js";
 export class BitGoPsbt {
+    wasm;
     constructor(wasm) {
         this.wasm = wasm;
     }
@@ -103,4 +104,29 @@ export class BitGoPsbt {
     verifyReplayProtectionSignature(inputIndex, replayProtection) {
         return this.wasm.verify_replay_protection_signature(inputIndex, replayProtection);
     }
+    /**
+     * Serialize the PSBT to bytes
+     *
+     * @returns The serialized PSBT as a byte array
+     */
+    serialize() {
+        return this.wasm.serialize();
+    }
+    /**
+     * Finalize all inputs in the PSBT
+     *
+     * @throws Error if any input failed to finalize
+     */
+    finalizeAllInputs() {
+        this.wasm.finalize_all_inputs();
+    }
+    /**
+     * Extract the final transaction from a finalized PSBT
+     *
+     * @returns The serialized transaction bytes
+     * @throws Error if the PSBT is not fully finalized or extraction fails
+     */
+    extractTransaction() {
+        return this.wasm.extract_transaction();
+    }
 }

package/dist/{browser → esm}/js/index.d.ts

@@ -1,16 +1,16 @@
-export * as address from "./address";
-export * as ast from "./ast";
-export * as utxolibCompat from "./utxolibCompat";
-export * as fixedScriptWallet from "./fixedScriptWallet";
-export type { CoinName } from "./coinName";
-export type { Triple } from "./triple";
-export type { AddressFormat } from "./address";
+export * as address from "./address.js";
+export * as ast from "./ast/index.js";
+export * as utxolibCompat from "./utxolibCompat.js";
+export * as fixedScriptWallet from "./fixedScriptWallet.js";
+export type { CoinName } from "./coinName.js";
+export type { Triple } from "./triple.js";
+export type { AddressFormat } from "./address.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" {
+declare module "./wasm/wasm_utxo.js" {
     interface WrapDescriptor {
         /** These are not the same types of nodes as in the ast module */
         node(): unknown;
@@ -32,6 +32,6 @@ declare module "./wasm/wasm_utxo" {
         signWithPrv(this: WrapPsbt, prv: Uint8Array): SignPsbtResult;
     }
 }
-export { WrapDescriptor as Descriptor } from "./wasm/wasm_utxo";
-export { WrapMiniscript as Miniscript } from "./wasm/wasm_utxo";
-export { WrapPsbt as Psbt } from "./wasm/wasm_utxo";
+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";

package/dist/esm/js/index.js

@@ -0,0 +1,11 @@
+import * as wasm from "./wasm/wasm_utxo.js";
+// we need to access the wasm module here, otherwise webpack gets all weird
+// and forgets to include it in the bundle
+void wasm;
+export * as address from "./address.js";
+export * as ast from "./ast/index.js";
+export * as utxolibCompat from "./utxolibCompat.js";
+export * as fixedScriptWallet from "./fixedScriptWallet.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";

package/dist/{node → esm}/js/utxolibCompat.d.ts

@@ -1,5 +1,5 @@
-import type { AddressFormat } from "./address";
-import { Triple } from "./triple";
+import type { AddressFormat } from "./address.js";
+import { Triple } from "./triple.js";
 export type UtxolibName = "bitcoin" | "testnet" | "bitcoinTestnet4" | "bitcoinPublicSignet" | "bitcoinBitGoSignet" | "bitcoincash" | "bitcoincashTestnet" | "ecash" | "ecashTest" | "bitcoingold" | "bitcoingoldTestnet" | "bitcoinsv" | "bitcoinsvTestnet" | "dash" | "dashTest" | "dogecoin" | "dogecoinTest" | "litecoin" | "litecoinTest" | "zcash" | "zcashTest";
 export type BIP32Interface = {
     network: {

package/dist/{browser → esm}/js/utxolibCompat.js

@@ -1,4 +1,4 @@
-import { UtxolibCompatNamespace } from "./wasm/wasm_utxo";
+import { UtxolibCompatNamespace } from "./wasm/wasm_utxo.js";
 export function fromOutputScript(script, network, format) {
     return UtxolibCompatNamespace.from_output_script(script, network, format);
 }

package/dist/{browser → esm}/js/wasm/wasm_utxo.d.ts

@@ -36,6 +36,28 @@ export class BitGoPsbt {
    * - `Err(WasmUtxoError)` if the input index is out of bounds, xpub is invalid, derivation fails, or verification fails
    */
   verify_signature(input_index: number, xpub_str: string): boolean;
+  /**
+   * Extract the final transaction from a finalized PSBT
+   *
+   * This method should be called after all inputs have been finalized.
+   * It extracts the fully signed transaction.
+   *
+   * # Returns
+   * - `Ok(Vec<u8>)` containing the serialized transaction bytes
+   * - `Err(WasmUtxoError)` if the PSBT is not fully finalized or extraction fails
+   */
+  extract_transaction(): Uint8Array;
+  /**
+   * Finalize all inputs in the PSBT
+   *
+   * This method attempts to finalize all inputs in the PSBT, computing the final
+   * scriptSig and witness data for each input.
+   *
+   * # Returns
+   * - `Ok(())` if all inputs were successfully finalized
+   * - `Err(WasmUtxoError)` if any input failed to finalize
+   */
+  finalize_all_inputs(): void;
   /**
    * Parse outputs with wallet keys to identify which outputs belong to a wallet
    *
@@ -64,6 +86,13 @@ export class BitGoPsbt {
    * - `Err(WasmUtxoError)` if the input is not a replay protection input, index is out of bounds, or configuration is invalid
    */
   verify_replay_protection_signature(input_index: number, replay_protection: any): boolean;
+  /**
+   * Serialize the PSBT to bytes
+   *
+   * # Returns
+   * The serialized PSBT as a byte array
+   */
+  serialize(): Uint8Array;
 }
 export class FixedScriptWalletNamespace {
   private constructor();

package/dist/{browser → esm}/js/wasm/wasm_utxo_bg.js

@@ -345,6 +345,58 @@ export class BitGoPsbt {
             wasm.__wbindgen_add_to_stack_pointer(16);
         }
     }
+    /**
+     * Extract the final transaction from a finalized PSBT
+     *
+     * This method should be called after all inputs have been finalized.
+     * It extracts the fully signed transaction.
+     *
+     * # Returns
+     * - `Ok(Vec<u8>)` containing the serialized transaction bytes
+     * - `Err(WasmUtxoError)` if the PSBT is not fully finalized or extraction fails
+     * @returns {Uint8Array}
+     */
+    extract_transaction() {
+        try {
+            const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+            wasm.bitgopsbt_extract_transaction(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);
+            var r3 = getDataViewMemory0().getInt32(retptr + 4 * 3, true);
+            if (r3) {
+                throw takeObject(r2);
+            }
+            var v1 = getArrayU8FromWasm0(r0, r1).slice();
+            wasm.__wbindgen_export_3(r0, r1 * 1, 1);
+            return v1;
+        } finally {
+            wasm.__wbindgen_add_to_stack_pointer(16);
+        }
+    }
+    /**
+     * Finalize all inputs in the PSBT
+     *
+     * This method attempts to finalize all inputs in the PSBT, computing the final
+     * scriptSig and witness data for each input.
+     *
+     * # Returns
+     * - `Ok(())` if all inputs were successfully finalized
+     * - `Err(WasmUtxoError)` if any input failed to finalize
+     */
+    finalize_all_inputs() {
+        try {
+            const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+            wasm.bitgopsbt_finalize_all_inputs(retptr, this.__wbg_ptr);
+            var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
+            var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
+            if (r1) {
+                throw takeObject(r0);
+            }
+        } finally {
+            wasm.__wbindgen_add_to_stack_pointer(16);
+        }
+    }
     /**
      * Parse outputs with wallet keys to identify which outputs belong to a wallet
      *
@@ -423,6 +475,31 @@ export class BitGoPsbt {
             wasm.__wbindgen_add_to_stack_pointer(16);
         }
     }
+    /**
+     * Serialize the PSBT to bytes
+     *
+     * # Returns
+     * The serialized PSBT as a byte array
+     * @returns {Uint8Array}
+     */
+    serialize() {
+        try {
+            const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+            wasm.bitgopsbt_serialize(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);
+            var r3 = getDataViewMemory0().getInt32(retptr + 4 * 3, true);
+            if (r3) {
+                throw takeObject(r2);
+            }
+            var v1 = getArrayU8FromWasm0(r0, r1).slice();
+            wasm.__wbindgen_export_3(r0, r1 * 1, 1);
+            return v1;
+        } finally {
+            wasm.__wbindgen_add_to_stack_pointer(16);
+        }
+    }
 }
 if (Symbol.dispose) BitGoPsbt.prototype[Symbol.dispose] = BitGoPsbt.prototype.free;
 

package/dist/{node → esm}/js/wasm/wasm_utxo_bg.wasm.d.ts

@@ -1,29 +1,28 @@
 /* tslint:disable */
 /* eslint-disable */
 export const memory: WebAssembly.Memory;
+export const __wbg_addressnamespace_free: (a: number, b: number) => void;
 export const __wbg_bitgopsbt_free: (a: number, b: number) => void;
 export const __wbg_fixedscriptwalletnamespace_free: (a: number, b: number) => void;
-export const __wbg_wrappsbt_free: (a: number, b: number) => void;
+export const addressnamespace_from_output_script_with_coin: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => void;
+export const addressnamespace_to_output_script_with_coin: (a: number, b: number, c: number, d: number, e: number) => void;
+export const bitgopsbt_extract_transaction: (a: number, b: number) => void;
+export const bitgopsbt_finalize_all_inputs: (a: number, b: number) => void;
 export const bitgopsbt_from_bytes: (a: number, b: number, c: number, d: number, e: number) => void;
 export const bitgopsbt_parse_outputs_with_wallet_keys: (a: number, b: number, c: number) => void;
 export const bitgopsbt_parse_transaction_with_wallet_keys: (a: number, b: number, c: number, d: number) => void;
+export const bitgopsbt_serialize: (a: number, b: number) => void;
 export const bitgopsbt_unsigned_txid: (a: number, b: number) => void;
 export const bitgopsbt_verify_replay_protection_signature: (a: number, b: number, c: number, d: number) => void;
 export const bitgopsbt_verify_signature: (a: number, b: number, c: number, d: number, e: number) => void;
 export const fixedscriptwalletnamespace_address: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => void;
 export const fixedscriptwalletnamespace_output_script: (a: number, b: number, c: number, d: number, e: number) => void;
-export const wrappsbt_clone: (a: number) => number;
-export const wrappsbt_deserialize: (a: number, b: number, c: number) => void;
-export const wrappsbt_finalize: (a: number, b: number) => void;
-export const wrappsbt_serialize: (a: number, b: number) => void;
-export const wrappsbt_signWithPrv: (a: number, b: number, c: number, d: number) => void;
-export const wrappsbt_signWithXprv: (a: number, b: number, c: number, d: number) => void;
-export const wrappsbt_updateInputWithDescriptor: (a: number, b: number, c: number, d: number) => void;
-export const wrappsbt_updateOutputWithDescriptor: (a: number, b: number, c: number, d: number) => void;
-export const __wbg_addressnamespace_free: (a: number, b: number) => void;
-export const addressnamespace_from_output_script_with_coin: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => void;
-export const addressnamespace_to_output_script_with_coin: (a: number, b: number, c: number, d: number, e: number) => void;
+export const __wbg_utxolibcompatnamespace_free: (a: number, b: number) => void;
 export const __wbg_wrapdescriptor_free: (a: number, b: number) => void;
+export const __wbg_wrapminiscript_free: (a: number, b: number) => void;
+export const __wbg_wrappsbt_free: (a: number, b: number) => void;
+export const utxolibcompatnamespace_from_output_script: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
+export const utxolibcompatnamespace_to_output_script: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
 export const wrapdescriptor_atDerivationIndex: (a: number, b: number, c: number) => void;
 export const wrapdescriptor_descType: (a: number, b: number) => void;
 export const wrapdescriptor_encode: (a: number, b: number) => void;
@@ -35,16 +34,20 @@ export const wrapdescriptor_node: (a: number, b: number) => void;
 export const wrapdescriptor_scriptPubkey: (a: number, b: number) => void;
 export const wrapdescriptor_toAsmString: (a: number, b: number) => void;
 export const wrapdescriptor_toString: (a: number, b: number) => void;
-export const __wbg_utxolibcompatnamespace_free: (a: number, b: number) => void;
-export const __wbg_wrapminiscript_free: (a: number, b: number) => void;
-export const utxolibcompatnamespace_from_output_script: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
-export const utxolibcompatnamespace_to_output_script: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
 export const wrapminiscript_encode: (a: number, b: number) => void;
 export const wrapminiscript_fromBitcoinScript: (a: number, b: number, c: number, d: number, e: number) => void;
 export const wrapminiscript_fromString: (a: number, b: number, c: number, d: number, e: number) => void;
 export const wrapminiscript_node: (a: number, b: number) => void;
 export const wrapminiscript_toAsmString: (a: number, b: number) => void;
 export const wrapminiscript_toString: (a: number, b: number) => void;
+export const wrappsbt_clone: (a: number) => number;
+export const wrappsbt_deserialize: (a: number, b: number, c: number) => void;
+export const wrappsbt_finalize: (a: number, b: number) => void;
+export const wrappsbt_serialize: (a: number, b: number) => void;
+export const wrappsbt_signWithPrv: (a: number, b: number, c: number, d: number) => void;
+export const wrappsbt_signWithXprv: (a: number, b: number, c: number, d: number) => void;
+export const wrappsbt_updateInputWithDescriptor: (a: number, b: number, c: number, d: number) => void;
+export const wrappsbt_updateOutputWithDescriptor: (a: number, b: number, c: number, d: number) => void;
 export const rustsecp256k1_v0_10_0_context_create: (a: number) => number;
 export const rustsecp256k1_v0_10_0_context_destroy: (a: number) => void;
 export const rustsecp256k1_v0_10_0_default_error_callback_fn: (a: number, b: number) => void;

package/dist/esm/test/address/utxolibCompat.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/esm/test/address/utxolibCompat.js

@@ -0,0 +1,105 @@
+import * as path from "node:path";
+import * as fs from "node:fs/promises";
+import { fileURLToPath } from "node:url";
+import { dirname } from "node:path";
+import * as utxolib from "@bitgo/utxo-lib";
+import assert from "node:assert";
+import { utxolibCompat, address as addressNs, } from "../../js/index.js";
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+function getCoinNameForNetwork(name) {
+    switch (name) {
+        case "bitcoin":
+            return "btc";
+        case "testnet":
+            return "tbtc";
+        case "bitcoinTestnet4":
+            return "tbtc4";
+        case "bitcoinPublicSignet":
+            return "tbtcsig";
+        case "bitcoinBitGoSignet":
+            return "tbtcbgsig";
+        case "bitcoincash":
+            return "bch";
+        case "bitcoincashTestnet":
+            return "tbch";
+        case "ecash":
+            return "bcha";
+        case "ecashTest":
+            return "tbcha";
+        case "bitcoingold":
+            return "btg";
+        case "bitcoingoldTestnet":
+            return "tbtg";
+        case "bitcoinsv":
+            return "bsv";
+        case "bitcoinsvTestnet":
+            return "tbsv";
+        case "dash":
+            return "dash";
+        case "dashTest":
+            return "tdash";
+        case "dogecoin":
+            return "doge";
+        case "dogecoinTest":
+            return "tdoge";
+        case "litecoin":
+            return "ltc";
+        case "litecoinTest":
+            return "tltc";
+        case "zcash":
+            return "zec";
+        case "zcashTest":
+            return "tzec";
+        default:
+            throw new Error(`Unknown network: ${name}`);
+    }
+}
+async function getFixtures(name, addressFormat) {
+    if (name === "bitcoinBitGoSignet") {
+        name = "bitcoinPublicSignet";
+    }
+    const filename = addressFormat ? `${name}-${addressFormat}` : name;
+    const fixturePath = path.join(__dirname, "..", "fixtures", "address", `${filename}.json`);
+    const fixtures = await fs.readFile(fixturePath, "utf8");
+    return JSON.parse(fixtures);
+}
+function runTest(network, addressFormat) {
+    const name = utxolib.getNetworkName(network);
+    describe(`utxolibCompat ${name} ${addressFormat ?? "default"}`, function () {
+        let fixtures;
+        before(async function () {
+            fixtures = await getFixtures(name, addressFormat);
+        });
+        it("should convert to utxolib compatible network", async function () {
+            for (const fixture of fixtures) {
+                const [_type, script, addressRef] = fixture;
+                const scriptBuf = Buffer.from(script, "hex");
+                const address = utxolibCompat.fromOutputScript(scriptBuf, network, addressFormat);
+                assert.strictEqual(address, addressRef);
+                const scriptFromAddress = utxolibCompat.toOutputScript(address, network, addressFormat);
+                assert.deepStrictEqual(Buffer.from(scriptFromAddress), scriptBuf);
+            }
+        });
+        it("should convert using coin name", async function () {
+            const coinName = getCoinNameForNetwork(name);
+            for (const fixture of fixtures) {
+                const [_type, script, addressRef] = fixture;
+                const scriptBuf = Buffer.from(script, "hex");
+                // Test encoding (script -> address)
+                const address = addressNs.fromOutputScriptWithCoin(scriptBuf, coinName, addressFormat);
+                assert.strictEqual(address, addressRef);
+                // Test decoding (address -> script)
+                const scriptFromAddress = addressNs.toOutputScriptWithCoin(addressRef, coinName);
+                assert.deepStrictEqual(Buffer.from(scriptFromAddress), scriptBuf);
+            }
+        });
+    });
+}
+utxolib.getNetworkList().forEach((network) => {
+    runTest(network);
+    const mainnet = utxolib.getMainnet(network);
+    if (mainnet === utxolib.networks.bitcoincash || mainnet === utxolib.networks.ecash) {
+        runTest(network, "cashaddr");
+    }
+});

package/dist/esm/test/ast/formatNode.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/esm/test/ast/formatNode.js

@@ -0,0 +1,15 @@
+import * as assert from "assert";
+import { formatNode } from "../../js/ast/index.js";
+describe("formatNode", function () {
+    it("formats simple nodes", function () {
+        assert.strictEqual(formatNode({ pk: "lol" }), "pk(lol)");
+        assert.strictEqual(formatNode({ after: 1 }), "after(1)");
+        assert.strictEqual(formatNode({ and_v: [{ after: 1 }, { after: 1 }] }), "and_v(after(1),after(1))");
+        // taproot single key
+        assert.strictEqual(formatNode({ tr: "k" }), "tr(k)");
+        // key with single-node taproot tree
+        assert.strictEqual(formatNode({ tr: ["k", { pk: "k1" }] }), "tr(k,pk(k1))");
+        // key with multi-node taproot tree
+        assert.strictEqual(formatNode({ tr: ["k", [{ pk: "k1" }, { pk: "k2" }]] }), "tr(k,{pk(k1),pk(k2)})");
+    });
+});

package/dist/esm/test/descriptorFixtures.d.ts

@@ -0,0 +1,25 @@
+export declare const fixtures: {
+    valid: ({
+        descriptor: string;
+        script: string;
+        checksumRequired: boolean;
+        index?: undefined;
+    } | {
+        descriptor: string;
+        script: string;
+        index: number;
+        checksumRequired: boolean;
+    } | {
+        descriptor: string;
+        script: string;
+        checksumRequired?: undefined;
+        index?: undefined;
+    })[];
+    invalid: ({
+        descriptor: string;
+        checksumRequired: boolean;
+    } | {
+        descriptor: string;
+        checksumRequired?: undefined;
+    })[];
+};