@bitgo/wasm-utxo 1.6.0 → 1.8.0

package/dist/cjs/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/cjs/js/fixedScriptWallet/RootWalletKeys.js

@@ -0,0 +1,108 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RootWalletKeys = void 0;
+const bip32_js_1 = require("../bip32.js");
+const wasm_utxo_js_1 = require("../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_js_1.BIP32.from(key));
+    }
+    // Otherwise it's a triple of strings (xpubs)
+    return keys.map((xpub) => bip32_js_1.BIP32.fromWasm(wasm_utxo_js_1.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
+ */
+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
+            ? wasm_utxo_js_1.WasmRootWalletKeys.with_derivation_prefixes(user.wasm, backup.wasm, bitgo.wasm, derivationPrefixes[0], derivationPrefixes[1], derivationPrefixes[2])
+            : new wasm_utxo_js_1.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) => wasm_utxo_js_1.WasmBIP32.from_xpub(xpub));
+        const wasm = new wasm_utxo_js_1.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) => wasm_utxo_js_1.WasmBIP32.from_xpub(xpub));
+        const wasm = wasm_utxo_js_1.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_js_1.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_js_1.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_js_1.BIP32.fromWasm(wasm);
+    }
+    /**
+     * Get the underlying WASM instance (internal use only)
+     * @internal
+     */
+    get wasm() {
+        return this._wasm;
+    }
+}
+exports.RootWalletKeys = RootWalletKeys;

package/dist/cjs/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/cjs/js/fixedScriptWallet/address.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.outputScript = outputScript;
+exports.address = address;
+const wasm_utxo_js_1 = require("../wasm/wasm_utxo.js");
+const RootWalletKeys_js_1 = require("./RootWalletKeys.js");
+/**
+ * Create the output script for a given wallet keys and chain and index
+ */
+function outputScript(keys, chain, index, network) {
+    const walletKeys = RootWalletKeys_js_1.RootWalletKeys.from(keys);
+    return wasm_utxo_js_1.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.
+ */
+function address(keys, chain, index, network, addressFormat) {
+    const walletKeys = RootWalletKeys_js_1.RootWalletKeys.from(keys);
+    return wasm_utxo_js_1.FixedScriptWalletNamespace.address(walletKeys.wasm, chain, index, network, addressFormat);
+}

package/dist/cjs/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/cjs/js/fixedScriptWallet/index.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BitGoPsbt = exports.address = exports.outputScript = exports.ReplayProtection = exports.RootWalletKeys = void 0;
+var RootWalletKeys_js_1 = require("./RootWalletKeys.js");
+Object.defineProperty(exports, "RootWalletKeys", { enumerable: true, get: function () { return RootWalletKeys_js_1.RootWalletKeys; } });
+var ReplayProtection_js_1 = require("./ReplayProtection.js");
+Object.defineProperty(exports, "ReplayProtection", { enumerable: true, get: function () { return ReplayProtection_js_1.ReplayProtection; } });
+var address_js_1 = require("./address.js");
+Object.defineProperty(exports, "outputScript", { enumerable: true, get: function () { return address_js_1.outputScript; } });
+Object.defineProperty(exports, "address", { enumerable: true, get: function () { return address_js_1.address; } });
+var BitGoPsbt_js_1 = require("./BitGoPsbt.js");
+Object.defineProperty(exports, "BitGoPsbt", { enumerable: true, get: function () { return BitGoPsbt_js_1.BitGoPsbt; } });

package/dist/cjs/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/cjs/js/index.js

@@ -33,15 +33,24 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Psbt = exports.Miniscript = exports.Descriptor = exports.fixedScriptWallet = exports.utxolibCompat = exports.ast = exports.address = void 0;
+exports.Psbt = exports.Miniscript = exports.Descriptor = exports.BIP32 = exports.ECPair = exports.ecpair = exports.bip32 = exports.fixedScriptWallet = exports.utxolibCompat = exports.ast = exports.address = void 0;
 const wasm = __importStar(require("./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'`)
 exports.address = __importStar(require("./address.js"));
 exports.ast = __importStar(require("./ast/index.js"));
 exports.utxolibCompat = __importStar(require("./utxolibCompat.js"));
-exports.fixedScriptWallet = __importStar(require("./fixedScriptWallet.js"));
+exports.fixedScriptWallet = __importStar(require("./fixedScriptWallet/index.js"));
+exports.bip32 = __importStar(require("./bip32.js"));
+exports.ecpair = __importStar(require("./ecpair.js"));
+// Only the most commonly used classes and types are exported at the top level for convenience
+var ecpair_js_1 = require("./ecpair.js");
+Object.defineProperty(exports, "ECPair", { enumerable: true, get: function () { return ecpair_js_1.ECPair; } });
+var bip32_js_1 = require("./bip32.js");
+Object.defineProperty(exports, "BIP32", { enumerable: true, get: function () { return bip32_js_1.BIP32; } });
 var wasm_utxo_js_1 = require("./wasm/wasm_utxo.js");
 Object.defineProperty(exports, "Descriptor", { enumerable: true, get: function () { return wasm_utxo_js_1.WrapDescriptor; } });
 var wasm_utxo_js_2 = require("./wasm/wasm_utxo.js");

package/dist/cjs/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;