@atomiqlabs/sdk 8.6.6 → 8.6.8

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

@@ -1,128 +1,130 @@
-import { CoinselectAddressTypes } from "../coinselect2";
-import { BTC_NETWORK } from "@scure/btc-signer/utils";
-import { Transaction } from "@scure/btc-signer";
-import { IBitcoinWallet } from "./IBitcoinWallet";
-import { Buffer } from "buffer";
-import { BitcoinNetwork, BitcoinRpcWithAddressIndex } from "@atomiqlabs/base";
-/**
- * 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;
-};
-/**
- * Identifies the address type of a Bitcoin address
- *
- * @category Bitcoin
- */
-export declare function identifyAddressType(address: string, network: BTC_NETWORK): CoinselectAddressTypes;
-/**
- * Abstract base class for Bitcoin wallet implementations, using bitcoin rpc with address index
- *  as a backend for fetching balances, UTXOs, etc.
- *
- * @category Bitcoin
- */
-export declare abstract class BitcoinWallet implements IBitcoinWallet {
-    protected readonly rpc: BitcoinRpcWithAddressIndex<any>;
-    protected readonly network: BTC_NETWORK;
-    protected feeMultiplier: number;
-    protected feeOverride?: number;
-    constructor(mempoolApi: BitcoinRpcWithAddressIndex<any>, network: BitcoinNetwork | BTC_NETWORK, feeMultiplier?: number, feeOverride?: number);
-    /**
-     * @inheritDoc
-     */
-    getFeeRate(): Promise<number>;
-    /**
-     * Internal helper function for sending a raw transaction through the underlying RPC
-     *
-     * @param rawHex Serialized bitcoin transaction in hexadecimal format
-     * @returns txId Transaction ID of the submitted bitcoin transaction
-     *
-     * @protected
-     */
-    protected _sendTransaction(rawHex: string): Promise<string>;
-    /**
-     * Internal helper function for fetching the balance of the wallet given a specific bitcoin wallet address
-     *
-     * @param address
-     * @protected
-     */
-    protected _getBalance(address: string): Promise<{
-        confirmedBalance: bigint;
-        unconfirmedBalance: bigint;
-    }>;
-    /**
-     * Internal helper function for fetching the UTXO set of a given wallet address
-     *
-     * @param sendingAddress
-     * @param sendingAddressType
-     * @protected
-     */
-    protected _getUtxoPool(sendingAddress: string, sendingAddressType: CoinselectAddressTypes): Promise<BitcoinWalletUtxo[]>;
-    /**
-     *
-     * @param sendingAccounts
-     * @param recipient
-     * @param amount
-     * @param feeRate
-     * @protected
-     */
-    protected _getPsbt(sendingAccounts: {
-        pubkey: string;
-        address: string;
-        addressType: CoinselectAddressTypes;
-    }[], recipient: string, amount: number, feeRate?: number): Promise<{
-        fee: number;
-        psbt?: Transaction;
-        inputAddressIndexes?: {
-            [address: string]: number[];
-        };
-    }>;
-    protected _fundPsbt(sendingAccounts: {
-        pubkey: string;
-        address: string;
-        addressType: CoinselectAddressTypes;
-    }[], psbt: Transaction, feeRate?: number): Promise<{
-        fee: number;
-        psbt?: Transaction;
-        inputAddressIndexes?: {
-            [address: string]: number[];
-        };
-    }>;
-    protected _getSpendableBalance(sendingAccounts: {
-        address: string;
-        addressType: CoinselectAddressTypes;
-    }[], psbt?: Transaction, feeRate?: number): Promise<{
-        balance: bigint;
-        feeRate: number;
-        totalFee: number;
-    }>;
-    abstract sendTransaction(address: string, amount: bigint, feeRate?: number): Promise<string>;
-    abstract fundPsbt(psbt: Transaction, feeRate?: number): Promise<Transaction>;
-    abstract signPsbt(psbt: Transaction, signInputs: number[]): Promise<Transaction>;
-    abstract getTransactionFee(address: string, amount: bigint, feeRate?: number): Promise<number>;
-    abstract getFundedPsbtFee(psbt: Transaction, feeRate?: number): Promise<number>;
-    abstract getReceiveAddress(): string;
-    abstract getBalance(): Promise<{
-        confirmedBalance: bigint;
-        unconfirmedBalance: bigint;
-    }>;
-    abstract getSpendableBalance(psbt?: Transaction, feeRate?: number): Promise<{
-        balance: bigint;
-        feeRate: number;
-        totalFee: number;
-    }>;
-    static bitcoinNetworkToObject(network: BitcoinNetwork): BTC_NETWORK;
-}
+/// <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 { IBitcoinWallet } from "./IBitcoinWallet";
+import { Buffer } from "buffer";
+import { BitcoinNetwork, BitcoinRpcWithAddressIndex } from "@atomiqlabs/base";
+/**
+ * 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;
+};
+/**
+ * Identifies the address type of a Bitcoin address
+ *
+ * @category Bitcoin
+ */
+export declare function identifyAddressType(address: string, network: BTC_NETWORK): CoinselectAddressTypes;
+/**
+ * Abstract base class for Bitcoin wallet implementations, using bitcoin rpc with address index
+ *  as a backend for fetching balances, UTXOs, etc.
+ *
+ * @category Bitcoin
+ */
+export declare abstract class BitcoinWallet implements IBitcoinWallet {
+    protected readonly rpc: BitcoinRpcWithAddressIndex<any>;
+    protected readonly network: BTC_NETWORK;
+    protected feeMultiplier: number;
+    protected feeOverride?: number;
+    constructor(mempoolApi: BitcoinRpcWithAddressIndex<any>, network: BitcoinNetwork | BTC_NETWORK, feeMultiplier?: number, feeOverride?: number);
+    /**
+     * @inheritDoc
+     */
+    getFeeRate(): Promise<number>;
+    /**
+     * Internal helper function for sending a raw transaction through the underlying RPC
+     *
+     * @param rawHex Serialized bitcoin transaction in hexadecimal format
+     * @returns txId Transaction ID of the submitted bitcoin transaction
+     *
+     * @protected
+     */
+    protected _sendTransaction(rawHex: string): Promise<string>;
+    /**
+     * Internal helper function for fetching the balance of the wallet given a specific bitcoin wallet address
+     *
+     * @param address
+     * @protected
+     */
+    protected _getBalance(address: string): Promise<{
+        confirmedBalance: bigint;
+        unconfirmedBalance: bigint;
+    }>;
+    /**
+     * Internal helper function for fetching the UTXO set of a given wallet address
+     *
+     * @param sendingAddress
+     * @param sendingAddressType
+     * @protected
+     */
+    protected _getUtxoPool(sendingAddress: string, sendingAddressType: CoinselectAddressTypes): Promise<BitcoinWalletUtxo[]>;
+    /**
+     *
+     * @param sendingAccounts
+     * @param recipient
+     * @param amount
+     * @param feeRate
+     * @protected
+     */
+    protected _getPsbt(sendingAccounts: {
+        pubkey: string;
+        address: string;
+        addressType: CoinselectAddressTypes;
+    }[], recipient: string, amount: number, feeRate?: number): Promise<{
+        fee: number;
+        psbt?: Transaction;
+        inputAddressIndexes?: {
+            [address: string]: number[];
+        };
+    }>;
+    protected _fundPsbt(sendingAccounts: {
+        pubkey: string;
+        address: string;
+        addressType: CoinselectAddressTypes;
+    }[], psbt: Transaction, feeRate?: number): Promise<{
+        fee: number;
+        psbt?: Transaction;
+        inputAddressIndexes?: {
+            [address: string]: number[];
+        };
+    }>;
+    protected _getSpendableBalance(sendingAccounts: {
+        address: string;
+        addressType: CoinselectAddressTypes;
+    }[], psbt?: Transaction, feeRate?: number): Promise<{
+        balance: bigint;
+        feeRate: number;
+        totalFee: number;
+    }>;
+    abstract sendTransaction(address: string, amount: bigint, feeRate?: number): Promise<string>;
+    abstract fundPsbt(psbt: Transaction, feeRate?: number): Promise<Transaction>;
+    abstract signPsbt(psbt: Transaction, signInputs: number[]): Promise<Transaction>;
+    abstract getTransactionFee(address: string, amount: bigint, feeRate?: number): Promise<number>;
+    abstract getFundedPsbtFee(psbt: Transaction, feeRate?: number): Promise<number>;
+    abstract getReceiveAddress(): string;
+    abstract getBalance(): Promise<{
+        confirmedBalance: bigint;
+        unconfirmedBalance: bigint;
+    }>;
+    abstract getSpendableBalance(psbt?: Transaction, feeRate?: number): Promise<{
+        balance: bigint;
+        feeRate: number;
+        totalFee: number;
+    }>;
+    static bitcoinNetworkToObject(network: BitcoinNetwork): BTC_NETWORK;
+}