@bitgo/wasm-utxo 1.5.0 → 1.7.0

package/dist/esm/js/fixedScriptWallet/ReplayProtection.d.ts

@@ -0,0 +1,58 @@
+import { WasmReplayProtection } from "../wasm/wasm_utxo.js";
+import { type ECPairArg } from "../ecpair.js";
+/**
+ * ReplayProtectionArg represents the various forms that replay protection can take
+ * before being converted to a WasmReplayProtection instance
+ */
+export type ReplayProtectionArg = ReplayProtection | WasmReplayProtection | {
+    publicKeys: ECPairArg[];
+} | {
+    /** @deprecated - use publicKeys instead */
+    outputScripts: Uint8Array[];
+} | {
+    /** @deprecated - use publicKeys instead */
+    addresses: string[];
+};
+/**
+ * ReplayProtection wrapper class for PSBT replay protection inputs
+ */
+export declare class ReplayProtection {
+    private _wasm;
+    private constructor();
+    /**
+     * Create a ReplayProtection instance from a WasmReplayProtection instance (internal use)
+     * @internal
+     */
+    static fromWasm(wasm: WasmReplayProtection): ReplayProtection;
+    /**
+     * Convert ReplayProtectionArg to ReplayProtection instance
+     * @param arg - The replay protection in various formats
+     * @param network - Optional network string (required for addresses variant)
+     * @returns ReplayProtection instance
+     */
+    static from(arg: ReplayProtectionArg, network?: string): ReplayProtection;
+    /**
+     * Create from public keys (derives P2SH-P2PK output scripts)
+     * @param publicKeys - Array of ECPair instances or arguments
+     * @returns ReplayProtection instance
+     */
+    static fromPublicKeys(publicKeys: ECPairArg[]): ReplayProtection;
+    /**
+     * Create from output scripts
+     * @param outputScripts - Array of output script buffers
+     * @returns ReplayProtection instance
+     */
+    static fromOutputScripts(outputScripts: Uint8Array[]): ReplayProtection;
+    /**
+     * Create from addresses
+     * @param addresses - Array of address strings
+     * @param network - Network string (e.g., "bitcoin", "testnet", "btc", "tbtc")
+     * @returns ReplayProtection instance
+     */
+    static fromAddresses(addresses: string[], network: string): ReplayProtection;
+    /**
+     * Get the underlying WASM instance (internal use only)
+     * @internal
+     */
+    get wasm(): WasmReplayProtection;
+}

package/dist/esm/js/fixedScriptWallet/ReplayProtection.js

@@ -0,0 +1,85 @@
+import { WasmReplayProtection } from "../wasm/wasm_utxo.js";
+import { ECPair } from "../ecpair.js";
+/**
+ * ReplayProtection wrapper class for PSBT replay protection inputs
+ */
+export class ReplayProtection {
+    _wasm;
+    constructor(_wasm) {
+        this._wasm = _wasm;
+    }
+    /**
+     * Create a ReplayProtection instance from a WasmReplayProtection instance (internal use)
+     * @internal
+     */
+    static fromWasm(wasm) {
+        return new ReplayProtection(wasm);
+    }
+    /**
+     * Convert ReplayProtectionArg to ReplayProtection instance
+     * @param arg - The replay protection in various formats
+     * @param network - Optional network string (required for addresses variant)
+     * @returns ReplayProtection instance
+     */
+    static from(arg, network) {
+        // Short-circuit if already a ReplayProtection instance
+        if (arg instanceof ReplayProtection) {
+            return arg;
+        }
+        // If it's a WasmReplayProtection instance, wrap it
+        if (arg instanceof WasmReplayProtection) {
+            return new ReplayProtection(arg);
+        }
+        // Handle object variants
+        if ("publicKeys" in arg) {
+            // Convert ECPairArg to public key bytes
+            const publicKeyBytes = arg.publicKeys.map((key) => ECPair.from(key).publicKey);
+            const wasm = WasmReplayProtection.from_public_keys(publicKeyBytes);
+            return new ReplayProtection(wasm);
+        }
+        if ("outputScripts" in arg) {
+            const wasm = WasmReplayProtection.from_output_scripts(arg.outputScripts);
+            return new ReplayProtection(wasm);
+        }
+        if ("addresses" in arg) {
+            if (!network) {
+                throw new Error("Network is required when using addresses variant");
+            }
+            const wasm = WasmReplayProtection.from_addresses(arg.addresses, network);
+            return new ReplayProtection(wasm);
+        }
+        throw new Error("Invalid ReplayProtectionArg type");
+    }
+    /**
+     * Create from public keys (derives P2SH-P2PK output scripts)
+     * @param publicKeys - Array of ECPair instances or arguments
+     * @returns ReplayProtection instance
+     */
+    static fromPublicKeys(publicKeys) {
+        return ReplayProtection.from({ publicKeys });
+    }
+    /**
+     * Create from output scripts
+     * @param outputScripts - Array of output script buffers
+     * @returns ReplayProtection instance
+     */
+    static fromOutputScripts(outputScripts) {
+        return ReplayProtection.from({ outputScripts });
+    }
+    /**
+     * Create from addresses
+     * @param addresses - Array of address strings
+     * @param network - Network string (e.g., "bitcoin", "testnet", "btc", "tbtc")
+     * @returns ReplayProtection instance
+     */
+    static fromAddresses(addresses, network) {
+        return ReplayProtection.from({ addresses }, network);
+    }
+    /**
+     * Get the underlying WASM instance (internal use only)
+     * @internal
+     */
+    get wasm() {
+        return this._wasm;
+    }
+}

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

@@ -0,0 +1,66 @@
+import type { BIP32Interface } from "../bip32.js";
+import { BIP32 } from "../bip32.js";
+import { Triple } from "../triple.js";
+import { WasmRootWalletKeys } from "../wasm/wasm_utxo.js";
+/**
+ * IWalletKeys represents the various forms that wallet keys can take
+ * before being converted to a RootWalletKeys instance
+ */
+export type IWalletKeys = {
+    triple: Triple<BIP32Interface>;
+    derivationPrefixes: Triple<string>;
+};
+export type WalletKeysArg = 
+/** Just an xpub triple, will assume default derivation prefixes  */
+Triple<string>
+/** Compatible with utxolib RootWalletKeys */
+ | IWalletKeys
+/** RootWalletKeys instance */
+ | RootWalletKeys;
+/**
+ * RootWalletKeys represents a set of three extended public keys with their derivation prefixes
+ */
+export declare class RootWalletKeys {
+    private _wasm;
+    private constructor();
+    /**
+     * Create a RootWalletKeys from various input formats
+     * @param keys - Can be a triple of xpub strings, an IWalletKeys object, or another RootWalletKeys instance
+     * @returns A RootWalletKeys instance
+     */
+    static from(keys: WalletKeysArg): RootWalletKeys;
+    /**
+     * Create a RootWalletKeys from three xpub strings
+     * Uses default derivation prefix of m/0/0 for all three keys
+     * @param xpubs - Triple of xpub strings
+     * @returns A RootWalletKeys instance
+     */
+    static fromXpubs(xpubs: Triple<string>): RootWalletKeys;
+    /**
+     * Create a RootWalletKeys from three xpub strings with custom derivation prefixes
+     * @param xpubs - Triple of xpub strings
+     * @param derivationPrefixes - Triple of derivation path strings (e.g., ["0/0", "0/0", "0/0"])
+     * @returns A RootWalletKeys instance
+     */
+    static withDerivationPrefixes(xpubs: Triple<string>, derivationPrefixes: Triple<string>): RootWalletKeys;
+    /**
+     * Get the user key (first xpub)
+     * @returns The user key as a BIP32 instance
+     */
+    userKey(): BIP32;
+    /**
+     * Get the backup key (second xpub)
+     * @returns The backup key as a BIP32 instance
+     */
+    backupKey(): BIP32;
+    /**
+     * Get the BitGo key (third xpub)
+     * @returns The BitGo key as a BIP32 instance
+     */
+    bitgoKey(): BIP32;
+    /**
+     * Get the underlying WASM instance (internal use only)
+     * @internal
+     */
+    get wasm(): WasmRootWalletKeys;
+}

package/dist/esm/js/fixedScriptWallet/RootWalletKeys.js

@@ -0,0 +1,104 @@
+import { BIP32 } from "../bip32.js";
+import { WasmRootWalletKeys, WasmBIP32 } from "../wasm/wasm_utxo.js";
+/**
+ * Convert WalletKeysArg to a triple of BIP32 instances
+ */
+function toBIP32Triple(keys) {
+    if (keys instanceof RootWalletKeys) {
+        return [keys.userKey(), keys.backupKey(), keys.bitgoKey()];
+    }
+    // Check if it's an IWalletKeys object
+    if (typeof keys === "object" && "triple" in keys) {
+        // Extract BIP32 keys from the triple
+        return keys.triple.map((key) => BIP32.from(key));
+    }
+    // Otherwise it's a triple of strings (xpubs)
+    return keys.map((xpub) => BIP32.fromWasm(WasmBIP32.from_xpub(xpub)));
+}
+/**
+ * Extract derivation prefixes from WalletKeysArg, if present
+ */
+function extractDerivationPrefixes(keys) {
+    if (typeof keys === "object" && "derivationPrefixes" in keys) {
+        return keys.derivationPrefixes;
+    }
+    return null;
+}
+/**
+ * RootWalletKeys represents a set of three extended public keys with their derivation prefixes
+ */
+export class RootWalletKeys {
+    _wasm;
+    constructor(_wasm) {
+        this._wasm = _wasm;
+    }
+    /**
+     * Create a RootWalletKeys from various input formats
+     * @param keys - Can be a triple of xpub strings, an IWalletKeys object, or another RootWalletKeys instance
+     * @returns A RootWalletKeys instance
+     */
+    static from(keys) {
+        if (keys instanceof RootWalletKeys) {
+            return keys;
+        }
+        const [user, backup, bitgo] = toBIP32Triple(keys);
+        const derivationPrefixes = extractDerivationPrefixes(keys);
+        const wasm = derivationPrefixes
+            ? WasmRootWalletKeys.with_derivation_prefixes(user.wasm, backup.wasm, bitgo.wasm, derivationPrefixes[0], derivationPrefixes[1], derivationPrefixes[2])
+            : new WasmRootWalletKeys(user.wasm, backup.wasm, bitgo.wasm);
+        return new RootWalletKeys(wasm);
+    }
+    /**
+     * Create a RootWalletKeys from three xpub strings
+     * Uses default derivation prefix of m/0/0 for all three keys
+     * @param xpubs - Triple of xpub strings
+     * @returns A RootWalletKeys instance
+     */
+    static fromXpubs(xpubs) {
+        const [user, backup, bitgo] = xpubs.map((xpub) => WasmBIP32.from_xpub(xpub));
+        const wasm = new WasmRootWalletKeys(user, backup, bitgo);
+        return new RootWalletKeys(wasm);
+    }
+    /**
+     * Create a RootWalletKeys from three xpub strings with custom derivation prefixes
+     * @param xpubs - Triple of xpub strings
+     * @param derivationPrefixes - Triple of derivation path strings (e.g., ["0/0", "0/0", "0/0"])
+     * @returns A RootWalletKeys instance
+     */
+    static withDerivationPrefixes(xpubs, derivationPrefixes) {
+        const [user, backup, bitgo] = xpubs.map((xpub) => WasmBIP32.from_xpub(xpub));
+        const wasm = WasmRootWalletKeys.with_derivation_prefixes(user, backup, bitgo, derivationPrefixes[0], derivationPrefixes[1], derivationPrefixes[2]);
+        return new RootWalletKeys(wasm);
+    }
+    /**
+     * Get the user key (first xpub)
+     * @returns The user key as a BIP32 instance
+     */
+    userKey() {
+        const wasm = this._wasm.user_key();
+        return BIP32.fromWasm(wasm);
+    }
+    /**
+     * Get the backup key (second xpub)
+     * @returns The backup key as a BIP32 instance
+     */
+    backupKey() {
+        const wasm = this._wasm.backup_key();
+        return BIP32.fromWasm(wasm);
+    }
+    /**
+     * Get the BitGo key (third xpub)
+     * @returns The BitGo key as a BIP32 instance
+     */
+    bitgoKey() {
+        const wasm = this._wasm.bitgo_key();
+        return BIP32.fromWasm(wasm);
+    }
+    /**
+     * Get the underlying WASM instance (internal use only)
+     * @internal
+     */
+    get wasm() {
+        return this._wasm;
+    }
+}

package/dist/esm/js/fixedScriptWallet/address.d.ts

@@ -0,0 +1,20 @@
+import { type WalletKeysArg } from "./RootWalletKeys.js";
+import type { UtxolibNetwork } from "../utxolibCompat.js";
+import { AddressFormat } from "../address.js";
+/**
+ * Create the output script for a given wallet keys and chain and index
+ */
+export declare function outputScript(keys: WalletKeysArg, chain: number, index: number, network: UtxolibNetwork): Uint8Array;
+/**
+ * Create the address for a given wallet keys and chain and index and network.
+ * Wrapper for outputScript that also encodes the script to an address.
+ * @param keys - The wallet keys to use.
+ * @param chain - The chain to use.
+ * @param index - The index to use.
+ * @param network - The network to use.
+ * @param addressFormat - The address format to use.
+ *   Only relevant for Bitcoin Cash and eCash networks, where:
+ *   - "default" means base58check,
+ *   - "cashaddr" means cashaddr.
+ */
+export declare function address(keys: WalletKeysArg, chain: number, index: number, network: UtxolibNetwork, addressFormat?: AddressFormat): string;

package/dist/esm/js/fixedScriptWallet/address.js

@@ -0,0 +1,25 @@
+import { FixedScriptWalletNamespace } from "../wasm/wasm_utxo.js";
+import { RootWalletKeys } from "./RootWalletKeys.js";
+/**
+ * Create the output script for a given wallet keys and chain and index
+ */
+export function outputScript(keys, chain, index, network) {
+    const walletKeys = RootWalletKeys.from(keys);
+    return FixedScriptWalletNamespace.output_script(walletKeys.wasm, chain, index, network);
+}
+/**
+ * Create the address for a given wallet keys and chain and index and network.
+ * Wrapper for outputScript that also encodes the script to an address.
+ * @param keys - The wallet keys to use.
+ * @param chain - The chain to use.
+ * @param index - The index to use.
+ * @param network - The network to use.
+ * @param addressFormat - The address format to use.
+ *   Only relevant for Bitcoin Cash and eCash networks, where:
+ *   - "default" means base58check,
+ *   - "cashaddr" means cashaddr.
+ */
+export function address(keys, chain, index, network, addressFormat) {
+    const walletKeys = RootWalletKeys.from(keys);
+    return FixedScriptWalletNamespace.address(walletKeys.wasm, chain, index, network, addressFormat);
+}

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

@@ -0,0 +1,4 @@
+export { RootWalletKeys, type WalletKeysArg, type IWalletKeys } from "./RootWalletKeys.js";
+export { ReplayProtection, type ReplayProtectionArg } from "./ReplayProtection.js";
+export { outputScript, address } from "./address.js";
+export { BitGoPsbt, type NetworkName, type ScriptId, type InputScriptType, type ParsedInput, type ParsedOutput, type ParsedTransaction, } from "./BitGoPsbt.js";

package/dist/esm/js/fixedScriptWallet/index.js

@@ -0,0 +1,4 @@
+export { RootWalletKeys } from "./RootWalletKeys.js";
+export { ReplayProtection } from "./ReplayProtection.js";
+export { outputScript, address } from "./address.js";
+export { BitGoPsbt, } from "./BitGoPsbt.js";

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

@@ -1,7 +1,11 @@
 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 * as fixedScriptWallet from "./fixedScriptWallet/index.js";
+export * as bip32 from "./bip32.js";
+export * as ecpair from "./ecpair.js";
+export { ECPair } from "./ecpair.js";
+export { BIP32 } from "./bip32.js";
 export type { CoinName } from "./coinName.js";
 export type { Triple } from "./triple.js";
 export type { AddressFormat } from "./address.js";

package/dist/esm/js/index.js

@@ -2,10 +2,17 @@ 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;
+// Most exports are namespaced to avoid polluting the top-level namespace
+// and to make imports more explicit (e.g., `import { address } from '@bitgo/wasm-utxo'`)
 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 * as fixedScriptWallet from "./fixedScriptWallet/index.js";
+export * as bip32 from "./bip32.js";
+export * as ecpair from "./ecpair.js";
+// Only the most commonly used classes and types are exported at the top level for convenience
+export { ECPair } from "./ecpair.js";
+export { BIP32 } from "./bip32.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/esm/js/utxolibCompat.d.ts

@@ -1,23 +1,5 @@
 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: {
-        bip32: {
-            public: number;
-        };
-    };
-    depth: number;
-    parentFingerprint: number;
-    index: number;
-    chainCode: Uint8Array;
-    publicKey: Uint8Array;
-    toBase58?(): string;
-};
-export type UtxolibRootWalletKeys = {
-    triple: Triple<BIP32Interface>;
-    derivationPrefixes: Triple<string>;
-};
 export type UtxolibNetwork = {
     pubKeyHash: number;
     scriptHash: number;