@xchainjs/xchain-utxo-providers 2.0.17 → 2.1.0

package/lib/providers/blockbook/blockbook-api.d.ts

@@ -0,0 +1,38 @@
+import { TxHash } from '@xchainjs/xchain-client';
+import { BaseAmount } from '@xchainjs/xchain-util';
+import { AddressUTXO, BalanceParams, Transaction, TxHashParams } from './blockbook-api-types';
+export declare const getTx: ({ apiKey, baseUrl, hash }: TxHashParams) => Promise<Transaction>;
+export declare const getTxs: ({ apiKey, address, baseUrl, limit, }: {
+    apiKey?: string;
+    address: string;
+    baseUrl: string;
+    limit: number;
+}) => Promise<{
+    transactions: Transaction[];
+    total: number;
+}>;
+export declare const getUTXOs: ({ apiKey, address, baseUrl, isConfirmed, }: {
+    apiKey?: string;
+    address: string;
+    baseUrl: string;
+    isConfirmed?: boolean;
+}) => Promise<AddressUTXO[]>;
+export declare const getBalance: ({ apiKey, baseUrl, address, confirmedOnly, assetDecimals, }: BalanceParams) => Promise<BaseAmount>;
+export declare const broadcastTx: ({ apiKey, baseUrl, txHex, }: {
+    apiKey?: string;
+    baseUrl: string;
+    txHex: string;
+}) => Promise<TxHash>;
+/**
+ * Fetches fee estimate using Blockbook's V2 REST endpoint.
+ *
+ * Docs: https://github.com/trezor/blockbook/blob/master/docs/api.md
+ *
+ * @param numberOfBlocks Target block confirmation count
+ * @returns Estimated fee rate in sat/byte
+ */
+export declare const getFeeEstimate: ({ apiKey, baseUrl, numberOfBlocks, }: {
+    apiKey?: string;
+    baseUrl: string;
+    numberOfBlocks: number;
+}) => Promise<number>;

package/lib/providers/blockbook/blockbook-data-provider.d.ts

@@ -0,0 +1,29 @@
+import { FeeOption, FeeRates, TxHash, TxHistoryParams } from '@xchainjs/xchain-client';
+import { Address, Asset } from '@xchainjs/xchain-util';
+import { Balance, Tx, TxsPage, UTXO, UtxoOnlineDataProvider } from '../../types';
+export declare class BlockbookProvider implements UtxoOnlineDataProvider {
+    private baseUrl;
+    private _apiKey?;
+    private asset;
+    private assetDecimals;
+    private readonly normalizeAddressForApi?;
+    constructor(baseUrl: string, asset: Asset, assetDecimals: number, options?: {
+        apiKey?: string;
+        normalizeAddressForApi?: (address: string) => string;
+    });
+    private toApiAddress;
+    get apiKey(): string | undefined;
+    set apiKey(value: string | undefined);
+    broadcastTx(txHex: string): Promise<TxHash>;
+    getConfirmedUnspentTxs(address: string): Promise<UTXO[]>;
+    getUnspentTxs(address: string): Promise<UTXO[]>;
+    getBalance(address: Address, confirmedOnly?: boolean): Promise<Balance[]>;
+    getTransactions(params?: TxHistoryParams): Promise<TxsPage>;
+    getTransactionData(txId: string): Promise<Tx>;
+    private static readonly BLOCK_TARGETS;
+    getFeeRate(feeOption: FeeOption): Promise<number>;
+    getFeeRates(): Promise<FeeRates>;
+    private mapTransactionToTx;
+    private mapUTXOs;
+    private getRawTransactions;
+}

package/lib/providers/index.d.ts

@@ -9,3 +9,4 @@ export * from './blockcypher/blockcypher-data-provider';
 export { BlockcypherNetwork } from './blockcypher/blockcypher-api-types';
 export { BitgoProvider } from './bitgo/bitgo-data-provider';
 export { NownodesProvider } from './nownodes/nownodes-data-provider';
+export { BlockbookProvider } from './blockbook/blockbook-data-provider';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xchainjs/xchain-utxo-providers",
-  "version": "2.0.17",
+  "version": "2.1.0",
   "license": "MIT",
   "main": "lib/index.js",
   "module": "lib/index.esm.js",
@@ -29,7 +29,7 @@
   },
   "dependencies": {
     "@supercharge/promise-pool": "2.4.0",
-    "@xchainjs/xchain-client": "2.0.15",
+    "@xchainjs/xchain-client": "2.0.16",
     "@xchainjs/xchain-util": "2.0.7",
     "axios": "1.16.1"
   },