@atomiqlabs/sdk 8.7.7 → 8.8.4

package/dist/bitcoin/wallet/IBitcoinWallet.d.ts

@@ -1,78 +1,116 @@
-import { Transaction } from "@scure/btc-signer";
-/**
- * Type guard to check if an object implements {@link IBitcoinWallet}
- *
- * @category Bitcoin
- */
-export declare function isIBitcoinWallet(val: any): val is IBitcoinWallet;
-/**
- * Interface to be implemented by Bitcoin wallets
- *
- * @category Bitcoin
- */
-export interface IBitcoinWallet {
-    /**
-     * Signs and broadcasts a transaction sending `amount` of sats to `address`, optionally with the
-     *  `feeRate` sats/vB fee rate.
-     *
-     * @param address Destination address of the transaction
-     * @param amount Amount of satoshis to send (1 BTC = 100,000,000 sats)
-     * @param feeRate Optional fee rate in sats/vB to use for the transaction
-     */
-    sendTransaction(address: string, amount: bigint, feeRate?: number): Promise<string>;
-    /**
-     * Funds (populates the inputs) for a given PSBT from wallet's UTXO set
-     *
-     * @param psbt PSBT to add the inputs to
-     * @param feeRate Optional fee rate in sats/vB to use for the transaction
-     */
-    fundPsbt(psbt: Transaction, feeRate?: number): Promise<Transaction>;
-    /**
-     * Signs inputs in the provided PSBT
-     *
-     * @param psbt A PSBT to sign
-     * @param signInputs Indices of the inputs to sign
-     */
-    signPsbt(psbt: Transaction, signInputs: number[]): Promise<Transaction>;
-    /**
-     * Returns the current fee rate in sats/vB
-     */
-    getFeeRate(): Promise<number>;
-    /**
-     * Estimates a total fee in satoshis for a given transaction
-     *
-     * @param address Destination address of the transaction
-     * @param amount Amount of satoshis to send (1 BTC = 100,000,000 sats)
-     * @param feeRate Optional fee rate in sats/vB to use for the transaction
-     */
-    getTransactionFee(address: string, amount: bigint, feeRate?: number): Promise<number>;
-    /**
-     * Estimates a total fee in satoshis for a given transaction as identified by the PSBT
-     *
-     * @param psbt A PSBT to which additional inputs from wallet's UTXO set will be added and fee estimated
-     * @param feeRate Optional fee rate in sats/vB to use for the transaction
-     */
-    getFundedPsbtFee(psbt: Transaction, feeRate?: number): Promise<number>;
-    /**
-     * Returns the bitcoin address suitable for receiving funds
-     */
-    getReceiveAddress(): string;
-    /**
-     * Returns confirmed and unconfirmed balance in satoshis of the wallet
-     */
-    getBalance(): Promise<{
-        confirmedBalance: bigint;
-        unconfirmedBalance: bigint;
-    }>;
-    /**
-     * Returns the maximum spendable balance in satoshis given a specific PSBT that should be funded
-     *
-     * @param psbt A PSBT to which additional inputs from wallet's UTXO set will be added and fee estimated
-     * @param feeRate Optional fee rate in sats/vB to use for the transaction
-     */
-    getSpendableBalance(psbt?: Transaction, feeRate?: number): Promise<{
-        balance: bigint;
-        feeRate: number;
-        totalFee: number;
-    }>;
-}
+/// <reference types="node" />
+/// <reference types="node" />
+import { Transaction } from "@scure/btc-signer";
+import { CoinselectAddressTypes } from "../coinselect2";
+/**
+ * UTXO data structure for Bitcoin wallets
+ *
+ * @category Bitcoin
+ */
+export type BitcoinWalletUtxo = {
+    vout: number;
+    txId: string;
+    value: number;
+    type: CoinselectAddressTypes;
+    outputScript: Buffer;
+    address: string;
+    cpfp?: {
+        txVsize: number;
+        txEffectiveFeeRate: number;
+    };
+    confirmed: boolean;
+};
+/**
+ * Base UTXO data structure used for maximum spendable balance calculation, doesn't contain all the fields necessary
+ *  for constructing the full transaction.
+ *
+ * @category Bitcoin
+ */
+export type BitcoinWalletUtxoBase = Omit<BitcoinWalletUtxo, "txId" | "vout" | "outputScript" | "address" | "confirmed">;
+/**
+ * Type guard to check if an object implements {@link IBitcoinWallet}
+ *
+ * @category Bitcoin
+ */
+export declare function isIBitcoinWallet(val: any): val is IBitcoinWallet;
+/**
+ * Interface to be implemented by Bitcoin wallets
+ *
+ * @category Bitcoin
+ */
+export interface IBitcoinWallet {
+    /**
+     * Signs and broadcasts a transaction sending `amount` of sats to `address`, optionally with the
+     *  `feeRate` sats/vB fee rate.
+     *
+     * @param address Destination address of the transaction
+     * @param amount Amount of satoshis to send (1 BTC = 100,000,000 sats)
+     * @param feeRate Optional fee rate in sats/vB to use for the transaction
+     */
+    sendTransaction(address: string, amount: bigint, feeRate?: number): Promise<string>;
+    /**
+     * Funds (populates the inputs) for a given PSBT from wallet's UTXO set
+     *
+     * @param psbt PSBT to add the inputs to
+     * @param feeRate Optional fee rate in sats/vB to use for the transaction
+     * @param utxos Pre-fetched list of UTXOs to spend from
+     * @param spendFully Instructs the wallet to spend all the passed UTXOs in the transaction without creating any
+     *  change output, if the `feeRate` is passed, it will also enforce that the feeRate in sats/vB for the resulting
+     *  transaction is not more than 50% and 10 sats/vB larger (considering also the CPFP adjustments)
+     */
+    fundPsbt(psbt: Transaction, feeRate?: number, utxos?: BitcoinWalletUtxo[], spendFully?: boolean): Promise<Transaction>;
+    /**
+     * Signs inputs in the provided PSBT
+     *
+     * @param psbt A PSBT to sign
+     * @param signInputs Indices of the inputs to sign
+     */
+    signPsbt(psbt: Transaction, signInputs: number[]): Promise<Transaction>;
+    /**
+     * Returns the current fee rate in sats/vB
+     */
+    getFeeRate(): Promise<number>;
+    /**
+     * Estimates a total fee in satoshis for a given transaction
+     *
+     * @param address Destination address of the transaction
+     * @param amount Amount of satoshis to send (1 BTC = 100,000,000 sats)
+     * @param feeRate Optional fee rate in sats/vB to use for the transaction
+     */
+    getTransactionFee(address: string, amount: bigint, feeRate?: number): Promise<number>;
+    /**
+     * Estimates a total fee in satoshis for a given transaction as identified by the PSBT
+     *
+     * @param psbt A PSBT to which additional inputs from wallet's UTXO set will be added and fee estimated
+     * @param feeRate Optional fee rate in sats/vB to use for the transaction
+     */
+    getFundedPsbtFee(psbt: Transaction, feeRate?: number): Promise<number>;
+    /**
+     * Returns the bitcoin address suitable for receiving funds
+     */
+    getReceiveAddress(): string;
+    /**
+     * Returns confirmed and unconfirmed balance in satoshis of the wallet
+     */
+    getBalance(): Promise<{
+        confirmedBalance: bigint;
+        unconfirmedBalance: bigint;
+    }>;
+    /**
+     * Returns the maximum spendable balance in satoshis given a specific PSBT that should be funded
+     *
+     * @param psbt A PSBT to which additional inputs from wallet's UTXO set will be added and fee estimated
+     * @param feeRate Optional fee rate in sats/vB to use for the transaction
+     * @param outputAddressType Expected output address type, if known
+     * @param utxos Optional pre-fetched UTXOs
+     */
+    getSpendableBalance(psbt?: Transaction, feeRate?: number, outputAddressType?: CoinselectAddressTypes, utxos?: BitcoinWalletUtxoBase[]): Promise<{
+        balance: bigint;
+        feeRate: number;
+        totalFee: number;
+    }>;
+    /**
+     * Returns a list of available UTXOs for the wallet
+     */
+    getUtxoPool?(): Promise<BitcoinWalletUtxo[]>;
+}

package/dist/bitcoin/wallet/IBitcoinWallet.js

@@ -1,21 +1,21 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isIBitcoinWallet = void 0;
-/**
- * Type guard to check if an object implements {@link IBitcoinWallet}
- *
- * @category Bitcoin
- */
-function isIBitcoinWallet(val) {
-    return val !== null &&
-        typeof (val.sendTransaction) === "function" &&
-        typeof (val.fundPsbt) === "function" &&
-        typeof (val.signPsbt) === "function" &&
-        typeof (val.getFeeRate) === "function" &&
-        typeof (val.getTransactionFee) === "function" &&
-        typeof (val.getFundedPsbtFee) === "function" &&
-        typeof (val.getReceiveAddress) === "function" &&
-        typeof (val.getBalance) === "function" &&
-        typeof (val.getSpendableBalance) === "function";
-}
-exports.isIBitcoinWallet = isIBitcoinWallet;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isIBitcoinWallet = void 0;
+/**
+ * Type guard to check if an object implements {@link IBitcoinWallet}
+ *
+ * @category Bitcoin
+ */
+function isIBitcoinWallet(val) {
+    return val !== null &&
+        typeof (val.sendTransaction) === "function" &&
+        typeof (val.fundPsbt) === "function" &&
+        typeof (val.signPsbt) === "function" &&
+        typeof (val.getFeeRate) === "function" &&
+        typeof (val.getTransactionFee) === "function" &&
+        typeof (val.getFundedPsbtFee) === "function" &&
+        typeof (val.getReceiveAddress) === "function" &&
+        typeof (val.getBalance) === "function" &&
+        typeof (val.getSpendableBalance) === "function";
+}
+exports.isIBitcoinWallet = isIBitcoinWallet;

package/dist/bitcoin/wallet/SingleAddressBitcoinWallet.d.ts

@@ -1,101 +1,106 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import { CoinselectAddressTypes } from "../coinselect2";
-import { BTC_NETWORK } from "@scure/btc-signer/utils";
-import { Transaction } from "@scure/btc-signer";
-import { Buffer } from "buffer";
-import { BitcoinWallet } from "./BitcoinWallet";
-import { BitcoinNetwork, BitcoinRpcWithAddressIndex } from "@atomiqlabs/base";
-/**
- * Bitcoin wallet implementation deriving a single address from a WIF encoded private key
- *
- * @category Bitcoin
- */
-export declare class SingleAddressBitcoinWallet extends BitcoinWallet {
-    protected readonly privKey?: Uint8Array;
-    protected readonly pubkey: Uint8Array;
-    protected readonly address: string;
-    protected readonly addressType: CoinselectAddressTypes;
-    constructor(mempoolApi: BitcoinRpcWithAddressIndex<any>, _network: BitcoinNetwork | BTC_NETWORK, addressDataOrWIF: string | {
-        address: string;
-        publicKey: string;
-    }, feeMultiplier?: number, feeOverride?: number);
-    /**
-     * Returns all the wallet addresses controlled by the wallet
-     *
-     * @protected
-     */
-    protected toBitcoinWalletAccounts(): [{
-        pubkey: string;
-        address: string;
-        addressType: CoinselectAddressTypes;
-    }];
-    /**
-     * @inheritDoc
-     */
-    sendTransaction(address: string, amount: bigint, feeRate?: number): Promise<string>;
-    /**
-     * @inheritDoc
-     */
-    fundPsbt(inputPsbt: Transaction, feeRate?: number): Promise<Transaction>;
-    /**
-     * @inheritDoc
-     */
-    signPsbt(psbt: Transaction, signInputs: number[]): Promise<Transaction>;
-    /**
-     * @inheritDoc
-     */
-    getTransactionFee(address: string, amount: bigint, feeRate?: number): Promise<number>;
-    /**
-     * @inheritDoc
-     */
-    getFundedPsbtFee(basePsbt: Transaction, feeRate?: number): Promise<number>;
-    /**
-     * @inheritDoc
-     */
-    getReceiveAddress(): string;
-    /**
-     * Returns the public key of the wallet
-     */
-    getPublicKey(): string;
-    /**
-     * @inheritDoc
-     */
-    getBalance(): Promise<{
-        confirmedBalance: bigint;
-        unconfirmedBalance: bigint;
-    }>;
-    /**
-     * @inheritDoc
-     */
-    getSpendableBalance(psbt?: Transaction, feeRate?: number): Promise<{
-        balance: bigint;
-        feeRate: number;
-        totalFee: number;
-    }>;
-    /**
-     * Generates a new random private key WIF that can be used to instantiate the bitcoin wallet instance
-     *
-     * @returns A WIF encoded bitcoin private key
-     */
-    static generateRandomPrivateKey(network?: BitcoinNetwork | BTC_NETWORK): string;
-    /**
-     * Generates a 12-word long mnemonic from any entropy source with 128-bits or more, the entropy is first hashed
-     *  using sha256, and the first 16 bytes of the hash are used to generate the mnemonic
-     *
-     * @param entropy Entropy to use for generating the mnemonic
-     */
-    static mnemonicFromEntropy(entropy: Buffer): string;
-    /**
-     * Generates a random 12-word long mnemonic
-     */
-    static generateRandomMnemonic(): string;
-    /**
-     * Generates a WIF private key from mnemonic phrase
-     *
-     * @param mnemonic Mnemonic to generate the WIF key from
-     * @param network Optional bitcoin network to generate the WIF for
-     * @param derivationPath Optional custom derivation path to use for deriving the wallet
-     */
-    static mnemonicToPrivateKey(mnemonic: string, network?: BitcoinNetwork | BTC_NETWORK, derivationPath?: string): Promise<string>;
-}
+/// <reference types="node" />
+/// <reference types="node" />
+import { CoinselectAddressTypes } from "../coinselect2";
+import { BTC_NETWORK } from "@scure/btc-signer/utils";
+import { Transaction } from "@scure/btc-signer";
+import { Buffer } from "buffer";
+import { BitcoinWallet } from "./BitcoinWallet";
+import { BitcoinNetwork, BitcoinRpcWithAddressIndex } from "@atomiqlabs/base";
+import { BitcoinWalletUtxo, BitcoinWalletUtxoBase } from "./IBitcoinWallet";
+/**
+ * Bitcoin wallet implementation deriving a single address from a WIF encoded private key
+ *
+ * @category Bitcoin
+ */
+export declare class SingleAddressBitcoinWallet extends BitcoinWallet {
+    protected readonly privKey?: Uint8Array;
+    protected readonly pubkey: Uint8Array;
+    protected readonly address: string;
+    protected readonly addressType: CoinselectAddressTypes;
+    constructor(mempoolApi: BitcoinRpcWithAddressIndex<any>, _network: BitcoinNetwork | BTC_NETWORK, addressDataOrWIF: string | {
+        address: string;
+        publicKey: string;
+    }, feeMultiplier?: number, feeOverride?: number);
+    /**
+     * Returns all the wallet addresses controlled by the wallet
+     *
+     * @protected
+     */
+    protected toBitcoinWalletAccounts(): [{
+        pubkey: string;
+        address: string;
+        addressType: CoinselectAddressTypes;
+    }];
+    /**
+     * @inheritDoc
+     */
+    sendTransaction(address: string, amount: bigint, feeRate?: number): Promise<string>;
+    /**
+     * @inheritDoc
+     */
+    fundPsbt(inputPsbt: Transaction, feeRate?: number, utxos?: BitcoinWalletUtxo[], spendFully?: boolean): Promise<Transaction>;
+    /**
+     * @inheritDoc
+     */
+    signPsbt(psbt: Transaction, signInputs: number[]): Promise<Transaction>;
+    /**
+     * @inheritDoc
+     */
+    getTransactionFee(address: string, amount: bigint, feeRate?: number): Promise<number>;
+    /**
+     * @inheritDoc
+     */
+    getFundedPsbtFee(basePsbt: Transaction, feeRate?: number): Promise<number>;
+    /**
+     * @inheritDoc
+     */
+    getReceiveAddress(): string;
+    /**
+     * Returns the public key of the wallet
+     */
+    getPublicKey(): string;
+    /**
+     * @inheritDoc
+     */
+    getBalance(): Promise<{
+        confirmedBalance: bigint;
+        unconfirmedBalance: bigint;
+    }>;
+    /**
+     * @inheritDoc
+     */
+    getSpendableBalance(psbt?: Transaction, feeRate?: number, outputAddressType?: CoinselectAddressTypes, utxos?: BitcoinWalletUtxoBase[]): Promise<{
+        balance: bigint;
+        feeRate: number;
+        totalFee: number;
+    }>;
+    /**
+     * @inheritDoc
+     */
+    getUtxoPool(): Promise<BitcoinWalletUtxo[]>;
+    /**
+     * Generates a new random private key WIF that can be used to instantiate the bitcoin wallet instance
+     *
+     * @returns A WIF encoded bitcoin private key
+     */
+    static generateRandomPrivateKey(network?: BitcoinNetwork | BTC_NETWORK): string;
+    /**
+     * Generates a 12-word long mnemonic from any entropy source with 128-bits or more, the entropy is first hashed
+     *  using sha256, and the first 16 bytes of the hash are used to generate the mnemonic
+     *
+     * @param entropy Entropy to use for generating the mnemonic
+     */
+    static mnemonicFromEntropy(entropy: Buffer): string;
+    /**
+     * Generates a random 12-word long mnemonic
+     */
+    static generateRandomMnemonic(): string;
+    /**
+     * Generates a WIF private key from mnemonic phrase
+     *
+     * @param mnemonic Mnemonic to generate the WIF key from
+     * @param network Optional bitcoin network to generate the WIF for
+     * @param derivationPath Optional custom derivation path to use for deriving the wallet
+     */
+    static mnemonicToPrivateKey(mnemonic: string, network?: BitcoinNetwork | BTC_NETWORK, derivationPath?: string): Promise<string>;
+}