@xchainjs/xchain-utxo-providers 0.2.6 → 0.2.8

package/lib/index.esm.js

@@ -1,6 +1,6 @@
 import { assetAmount, assetToBase, baseAmount, delay } from '@xchainjs/xchain-util';
 import axios from 'axios';
-import { TxType } from '@xchainjs/xchain-client';
+import { TxType, FeeOption } from '@xchainjs/xchain-client';
 import PromisePool from '@supercharge/promise-pool';
 
 var SochainNetwork;
@@ -298,6 +298,12 @@ class SochainProvider {
             }
         });
     }
+    /**
+     *  @throws {Error} Method not implemented.
+     */
+    getFeeRates() {
+        throw new Error('Method not implemented.');
+    }
     mapUTXOs(utxos) {
         return utxos.map((utxo) => ({
             hash: utxo.hash,
@@ -726,6 +732,12 @@ class HaskoinProvider {
             }
         });
     }
+    /**
+     *  @throws {Error} Method not implemented.
+     */
+    getFeeRates() {
+        throw new Error('Method not implemented.');
+    }
     /**
      *
      * @param utxos
@@ -817,6 +829,19 @@ const broadcastTx = ({ apiKey, baseUrl, network, txHex, }) => __awaiter(void 0,
     const broadcastResponse = response.data;
     return broadcastResponse.tx.hash;
 });
+/**
+ * Get general information about a blockchain
+ * @param {string} baseUrl The base url for the chain to interact with.
+ * @param {string} apiKey API key provided by Blockcypher.
+ * @returns {ChainResponse}
+ */
+const getBlockchainData = ({ baseUrl, apiKey, }) => __awaiter(void 0, void 0, void 0, function* () {
+    const params = {};
+    if (apiKey)
+        params['token'] = apiKey;
+    const chainResponse = yield axios.get(`${baseUrl}`, { params });
+    return chainResponse.data;
+});
 
 class BlockcypherProvider {
     constructor(baseUrl = 'https://api.blockcypher.com/v1/', chain, asset, assetDecimals, blockcypherNetwork, apiKey) {
@@ -911,6 +936,23 @@ class BlockcypherProvider {
             }
         });
     }
+    /**
+     * Returns a fee rate estimation from Blockcypher API service.
+     * @returns {FeeRates} Estimated fee rates
+     */
+    getFeeRates() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const chainResponse = yield getBlockchainData({
+                baseUrl: `${this.baseUrl}/${this.blockcypherNetwork}`,
+                apiKey: this._apiKey,
+            });
+            return {
+                [FeeOption.Average]: chainResponse.low_fee_per_kb / 1000,
+                [FeeOption.Fast]: chainResponse.medium_fee_per_kb / 1000,
+                [FeeOption.Fastest]: chainResponse.high_fee_per_kb / 1000,
+            };
+        });
+    }
     mapTransactionToTx(rawTx) {
         return {
             asset: this.asset,
@@ -1037,4 +1079,80 @@ var BlockcypherNetwork;
     BlockcypherNetwork["DASH"] = "dash/main";
 })(BlockcypherNetwork || (BlockcypherNetwork = {}));
 
-export { BlockcypherNetwork, BlockcypherProvider, HaskoinNetwork, HaskoinProvider, SochainNetwork, SochainProvider, broadcastTx$1 as broadcastTx, getAccount, getAddress, getBalance$1 as getBalance, getConfirmedTxStatus, getConfirmedUnspentTxs, getIsTxConfirmed, getTx$1 as getTx, getTxs$1 as getTxs, getUnspentTxs };
+/**
+ * Returns the estimated fee for a transaction. UTXO coins will return a fee per kB
+ * @param {string} baseUrl Bitgo base url of chain to interact with. For example: https://app.bitgo.com/api/v2/btc
+ * @param {GetFeeEstimateRequest} request Get fee estimate params
+ * @returns {GetFeeEstimateResponse} Get fee estimate response
+ */
+const getFeeEstimate = (baseUrl, request) => __awaiter(void 0, void 0, void 0, function* () {
+    const response = yield axios.get(`${baseUrl}/tx/fee`, { params: request });
+    return response.data;
+});
+
+class BitgoProvider {
+    constructor(config) {
+        this.baseUrl = config.baseUrl;
+        this.blockchainId = `${config.isTestnet ? 't' : ''}${config.chain.toLowerCase()}`;
+    }
+    /**
+     * Returns a fee rate estimation from Bitgo API service. If low and medium rates can not be retrieve from node, the will be 50% and 75% of fastest fee rate
+     * @returns {FeeRates} Estimated fee rates
+     */
+    getFeeRates() {
+        var _a, _b, _c, _d;
+        return __awaiter(this, void 0, void 0, function* () {
+            const gasFeeEstimateResponse = yield getFeeEstimate(`${this.baseUrl}/api/v2/${this.blockchainId}`, {
+                numBlocks: 2,
+            });
+            const fastestRate = gasFeeEstimateResponse.feePerKb / 1000;
+            return {
+                [FeeOption.Average]: ((_a = gasFeeEstimateResponse.feeByBlockTarget) === null || _a === void 0 ? void 0 : _a['6'])
+                    ? ((_b = gasFeeEstimateResponse.feeByBlockTarget) === null || _b === void 0 ? void 0 : _b['6']) / 1000
+                    : fastestRate * 0.5,
+                [FeeOption.Fast]: ((_c = gasFeeEstimateResponse.feeByBlockTarget) === null || _c === void 0 ? void 0 : _c['3'])
+                    ? ((_d = gasFeeEstimateResponse.feeByBlockTarget) === null || _d === void 0 ? void 0 : _d['3']) / 1000
+                    : fastestRate * 0.75,
+                [FeeOption.Fastest]: fastestRate,
+            };
+        });
+    }
+    /**
+     *  @throws {Error} Method not implemented.
+     */
+    getConfirmedUnspentTxs() {
+        throw new Error('Method not implemented.');
+    }
+    /**
+     *  @throws {Error} Method not implemented.
+     */
+    getUnspentTxs() {
+        throw new Error('Method not implemented.');
+    }
+    /**
+     *  @throws {Error} Method not implemented.
+     */
+    broadcastTx() {
+        throw new Error('Method not implemented.');
+    }
+    /**
+     *  @throws {Error} Method not implemented.
+     */
+    getBalance() {
+        throw new Error('Method not implemented.');
+    }
+    /**
+     *  @throws {Error} Method not implemented.
+     */
+    getTransactions() {
+        throw new Error('Method not implemented.');
+    }
+    /**
+     *  @throws {Error} Method not implemented.
+     */
+    getTransactionData() {
+        throw new Error('Method not implemented.');
+    }
+}
+
+export { BitgoProvider, BlockcypherNetwork, BlockcypherProvider, HaskoinNetwork, HaskoinProvider, SochainNetwork, SochainProvider, broadcastTx$1 as broadcastTx, getAccount, getAddress, getBalance$1 as getBalance, getConfirmedTxStatus, getConfirmedUnspentTxs, getIsTxConfirmed, getTx$1 as getTx, getTxs$1 as getTxs, getUnspentTxs };

package/lib/index.js

@@ -307,6 +307,12 @@ class SochainProvider {
             }
         });
     }
+    /**
+     *  @throws {Error} Method not implemented.
+     */
+    getFeeRates() {
+        throw new Error('Method not implemented.');
+    }
     mapUTXOs(utxos) {
         return utxos.map((utxo) => ({
             hash: utxo.hash,
@@ -735,6 +741,12 @@ class HaskoinProvider {
             }
         });
     }
+    /**
+     *  @throws {Error} Method not implemented.
+     */
+    getFeeRates() {
+        throw new Error('Method not implemented.');
+    }
     /**
      *
      * @param utxos
@@ -826,6 +838,19 @@ const broadcastTx = ({ apiKey, baseUrl, network, txHex, }) => __awaiter(void 0,
     const broadcastResponse = response.data;
     return broadcastResponse.tx.hash;
 });
+/**
+ * Get general information about a blockchain
+ * @param {string} baseUrl The base url for the chain to interact with.
+ * @param {string} apiKey API key provided by Blockcypher.
+ * @returns {ChainResponse}
+ */
+const getBlockchainData = ({ baseUrl, apiKey, }) => __awaiter(void 0, void 0, void 0, function* () {
+    const params = {};
+    if (apiKey)
+        params['token'] = apiKey;
+    const chainResponse = yield axios__default["default"].get(`${baseUrl}`, { params });
+    return chainResponse.data;
+});
 
 class BlockcypherProvider {
     constructor(baseUrl = 'https://api.blockcypher.com/v1/', chain, asset, assetDecimals, blockcypherNetwork, apiKey) {
@@ -920,6 +945,23 @@ class BlockcypherProvider {
             }
         });
     }
+    /**
+     * Returns a fee rate estimation from Blockcypher API service.
+     * @returns {FeeRates} Estimated fee rates
+     */
+    getFeeRates() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const chainResponse = yield getBlockchainData({
+                baseUrl: `${this.baseUrl}/${this.blockcypherNetwork}`,
+                apiKey: this._apiKey,
+            });
+            return {
+                [xchainClient.FeeOption.Average]: chainResponse.low_fee_per_kb / 1000,
+                [xchainClient.FeeOption.Fast]: chainResponse.medium_fee_per_kb / 1000,
+                [xchainClient.FeeOption.Fastest]: chainResponse.high_fee_per_kb / 1000,
+            };
+        });
+    }
     mapTransactionToTx(rawTx) {
         return {
             asset: this.asset,
@@ -1046,6 +1088,83 @@ exports.BlockcypherNetwork = void 0;
     BlockcypherNetwork["DASH"] = "dash/main";
 })(exports.BlockcypherNetwork || (exports.BlockcypherNetwork = {}));
 
+/**
+ * Returns the estimated fee for a transaction. UTXO coins will return a fee per kB
+ * @param {string} baseUrl Bitgo base url of chain to interact with. For example: https://app.bitgo.com/api/v2/btc
+ * @param {GetFeeEstimateRequest} request Get fee estimate params
+ * @returns {GetFeeEstimateResponse} Get fee estimate response
+ */
+const getFeeEstimate = (baseUrl, request) => __awaiter(void 0, void 0, void 0, function* () {
+    const response = yield axios__default["default"].get(`${baseUrl}/tx/fee`, { params: request });
+    return response.data;
+});
+
+class BitgoProvider {
+    constructor(config) {
+        this.baseUrl = config.baseUrl;
+        this.blockchainId = `${config.isTestnet ? 't' : ''}${config.chain.toLowerCase()}`;
+    }
+    /**
+     * Returns a fee rate estimation from Bitgo API service. If low and medium rates can not be retrieve from node, the will be 50% and 75% of fastest fee rate
+     * @returns {FeeRates} Estimated fee rates
+     */
+    getFeeRates() {
+        var _a, _b, _c, _d;
+        return __awaiter(this, void 0, void 0, function* () {
+            const gasFeeEstimateResponse = yield getFeeEstimate(`${this.baseUrl}/api/v2/${this.blockchainId}`, {
+                numBlocks: 2,
+            });
+            const fastestRate = gasFeeEstimateResponse.feePerKb / 1000;
+            return {
+                [xchainClient.FeeOption.Average]: ((_a = gasFeeEstimateResponse.feeByBlockTarget) === null || _a === void 0 ? void 0 : _a['6'])
+                    ? ((_b = gasFeeEstimateResponse.feeByBlockTarget) === null || _b === void 0 ? void 0 : _b['6']) / 1000
+                    : fastestRate * 0.5,
+                [xchainClient.FeeOption.Fast]: ((_c = gasFeeEstimateResponse.feeByBlockTarget) === null || _c === void 0 ? void 0 : _c['3'])
+                    ? ((_d = gasFeeEstimateResponse.feeByBlockTarget) === null || _d === void 0 ? void 0 : _d['3']) / 1000
+                    : fastestRate * 0.75,
+                [xchainClient.FeeOption.Fastest]: fastestRate,
+            };
+        });
+    }
+    /**
+     *  @throws {Error} Method not implemented.
+     */
+    getConfirmedUnspentTxs() {
+        throw new Error('Method not implemented.');
+    }
+    /**
+     *  @throws {Error} Method not implemented.
+     */
+    getUnspentTxs() {
+        throw new Error('Method not implemented.');
+    }
+    /**
+     *  @throws {Error} Method not implemented.
+     */
+    broadcastTx() {
+        throw new Error('Method not implemented.');
+    }
+    /**
+     *  @throws {Error} Method not implemented.
+     */
+    getBalance() {
+        throw new Error('Method not implemented.');
+    }
+    /**
+     *  @throws {Error} Method not implemented.
+     */
+    getTransactions() {
+        throw new Error('Method not implemented.');
+    }
+    /**
+     *  @throws {Error} Method not implemented.
+     */
+    getTransactionData() {
+        throw new Error('Method not implemented.');
+    }
+}
+
+exports.BitgoProvider = BitgoProvider;
 exports.BlockcypherProvider = BlockcypherProvider;
 exports.HaskoinProvider = HaskoinProvider;
 exports.SochainProvider = SochainProvider;

package/lib/providers/bitgo/bitgo-api-types.d.ts

@@ -0,0 +1,11 @@
+export type GetFeeEstimateRequest = {
+    numBlocks?: number;
+};
+export type GetFeeEstimateResponse = {
+    feePerKb: number;
+    cpfpFeePerKb?: number;
+    numBlocks: string;
+    confidence?: number;
+    multiplier?: number;
+    feeByBlockTarget?: Record<string, number>;
+};

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

@@ -0,0 +1,8 @@
+import { GetFeeEstimateRequest, GetFeeEstimateResponse } from './bitgo-api-types';
+/**
+ * Returns the estimated fee for a transaction. UTXO coins will return a fee per kB
+ * @param {string} baseUrl Bitgo base url of chain to interact with. For example: https://app.bitgo.com/api/v2/btc
+ * @param {GetFeeEstimateRequest} request Get fee estimate params
+ * @returns {GetFeeEstimateResponse} Get fee estimate response
+ */
+export declare const getFeeEstimate: (baseUrl: string, request: GetFeeEstimateRequest) => Promise<GetFeeEstimateResponse>;

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

@@ -0,0 +1,41 @@
+import { Balance, FeeRates, Tx, TxsPage, UTXO, UtxoOnlineDataProvider } from '@xchainjs/xchain-client';
+import { Chain } from '@xchainjs/xchain-util';
+export interface BitgoConfig {
+    baseUrl: string;
+    chain: Chain;
+    isTestnet?: boolean;
+}
+export declare class BitgoProvider implements UtxoOnlineDataProvider {
+    private baseUrl;
+    private blockchainId;
+    constructor(config: BitgoConfig);
+    /**
+     * Returns a fee rate estimation from Bitgo API service. If low and medium rates can not be retrieve from node, the will be 50% and 75% of fastest fee rate
+     * @returns {FeeRates} Estimated fee rates
+     */
+    getFeeRates(): Promise<FeeRates>;
+    /**
+     *  @throws {Error} Method not implemented.
+     */
+    getConfirmedUnspentTxs(): Promise<UTXO[]>;
+    /**
+     *  @throws {Error} Method not implemented.
+     */
+    getUnspentTxs(): Promise<UTXO[]>;
+    /**
+     *  @throws {Error} Method not implemented.
+     */
+    broadcastTx(): Promise<string>;
+    /**
+     *  @throws {Error} Method not implemented.
+     */
+    getBalance(): Promise<Balance[]>;
+    /**
+     *  @throws {Error} Method not implemented.
+     */
+    getTransactions(): Promise<TxsPage>;
+    /**
+     *  @throws {Error} Method not implemented.
+     */
+    getTransactionData(): Promise<Tx>;
+}

package/lib/providers/blockcypher/blockcypher-api-types.d.ts

@@ -99,3 +99,19 @@ export type TxConfirmedStatus = {
     confirmations: number;
     is_confirmed: boolean;
 };
+export type Blockchain = {
+    name: string;
+    height: number;
+    hash: string;
+    time: string;
+    latest_url: string;
+    previous_hash: string;
+    previous_url: string;
+    high_fee_per_kb: number;
+    medium_fee_per_kb: number;
+    low_fee_per_kb: number;
+    unconfirmed_count: number;
+    last_fork_height?: number;
+    last_fork_hash?: number;
+};
+export type ChainResponse = Blockchain;

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

@@ -1,6 +1,6 @@
 import { TxHash } from '@xchainjs/xchain-client';
 import { BaseAmount } from '@xchainjs/xchain-util';
-import { BalanceParams, BlockcypherNetwork, GetTxsDTO, Transaction, TxConfirmedStatus, TxHashParams } from './blockcypher-api-types';
+import { BalanceParams, BlockcypherNetwork, ChainResponse, GetTxsDTO, Transaction, TxConfirmedStatus, TxHashParams } from './blockcypher-api-types';
 /**
  * Get transaction by hash.
  *
@@ -67,3 +67,13 @@ export declare const broadcastTx: ({ apiKey, baseUrl, network, txHex, }: {
     txHex: string;
     network: BlockcypherNetwork;
 }) => Promise<TxHash>;
+/**
+ * Get general information about a blockchain
+ * @param {string} baseUrl The base url for the chain to interact with.
+ * @param {string} apiKey API key provided by Blockcypher.
+ * @returns {ChainResponse}
+ */
+export declare const getBlockchainData: ({ baseUrl, apiKey, }: {
+    baseUrl: string;
+    apiKey?: string | undefined;
+}) => Promise<ChainResponse>;

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

@@ -1,4 +1,4 @@
-import { Balance, Tx, TxHash, TxHistoryParams, TxsPage, UTXO, UtxoOnlineDataProvider } from '@xchainjs/xchain-client';
+import { Balance, FeeRates, Tx, TxHash, TxHistoryParams, TxsPage, UTXO, UtxoOnlineDataProvider } from '@xchainjs/xchain-client';
 import { Address, Asset, Chain } from '@xchainjs/xchain-util';
 import { BlockcypherNetwork } from './blockcypher-api-types';
 export declare class BlockcypherProvider implements UtxoOnlineDataProvider {
@@ -30,6 +30,11 @@ export declare class BlockcypherProvider implements UtxoOnlineDataProvider {
      * @returns {Tx} The transaction details of the given transaction id.
      */
     getTransactionData(txId: string): Promise<Tx>;
+    /**
+     * Returns a fee rate estimation from Blockcypher API service.
+     * @returns {FeeRates} Estimated fee rates
+     */
+    getFeeRates(): Promise<FeeRates>;
     private mapTransactionToTx;
     private mapUTXOs;
     /**

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

@@ -1,4 +1,4 @@
-import { Balance, Tx, TxHash, TxHistoryParams, TxsPage, UTXO, UtxoOnlineDataProvider } from '@xchainjs/xchain-client';
+import { Balance, FeeRates, Tx, TxHash, TxHistoryParams, TxsPage, UTXO, UtxoOnlineDataProvider } from '@xchainjs/xchain-client';
 import { Address, Asset, Chain } from '@xchainjs/xchain-util';
 import { HaskoinNetwork } from './haskoin-api-types';
 export declare class HaskoinProvider implements UtxoOnlineDataProvider {
@@ -28,6 +28,10 @@ export declare class HaskoinProvider implements UtxoOnlineDataProvider {
      * @returns {Tx} The transaction details of the given transaction id.
      */
     getTransactionData(txId: string): Promise<Tx>;
+    /**
+     *  @throws {Error} Method not implemented.
+     */
+    getFeeRates(): Promise<FeeRates>;
     /**
      *
      * @param utxos

package/lib/providers/index.d.ts

@@ -6,3 +6,4 @@ export { getAddress, getBalance, getConfirmedTxStatus, getConfirmedUnspentTxs, g
 export * from './haskoin/haskoin-data-provider';
 export * from './blockcypher/blockcypher-data-provider';
 export { BlockcypherNetwork } from './blockcypher/blockcypher-api-types';
+export { BitgoProvider } from './bitgo/bitgo-data-provider';

package/lib/providers/sochainv3/sochain-data-provider.d.ts

@@ -1,4 +1,4 @@
-import { Balance, Tx, TxHash, TxHistoryParams, TxsPage, UTXO, UtxoOnlineDataProvider } from '@xchainjs/xchain-client';
+import { Balance, FeeRates, Tx, TxHash, TxHistoryParams, TxsPage, UTXO, UtxoOnlineDataProvider } from '@xchainjs/xchain-client';
 import { Address, Asset, Chain } from '@xchainjs/xchain-util';
 import { SochainNetwork } from './sochain-api-types';
 export declare class SochainProvider implements UtxoOnlineDataProvider {
@@ -30,6 +30,10 @@ export declare class SochainProvider implements UtxoOnlineDataProvider {
      * @returns {Tx} The transaction details of the given transaction id.
      */
     getTransactionData(txId: string): Promise<Tx>;
+    /**
+     *  @throws {Error} Method not implemented.
+     */
+    getFeeRates(): Promise<FeeRates>;
     private mapUTXOs;
     /**
      * helper function tto limit adding to an array

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xchainjs/xchain-utxo-providers",
-  "version": "0.2.6",
+  "version": "0.2.8",
   "license": "MIT",
   "main": "lib/index.js",
   "module": "lib/index.esm.js",
@@ -27,13 +27,13 @@
     "access": "public"
   },
   "devDependencies": {
-    "@xchainjs/xchain-client": "^0.15.1",
+    "@xchainjs/xchain-client": "^0.15.4",
     "@xchainjs/xchain-crypto": "^0.3.0",
     "@xchainjs/xchain-util": "^0.13.1",
     "axios": "^1.3.6"
   },
   "peerDependencies": {
-    "@xchainjs/xchain-client": "^0.15.1",
+    "@xchainjs/xchain-client": "^0.15.4",
     "@xchainjs/xchain-crypto": "^0.3.0",
     "@xchainjs/xchain-util": "^0.13.1",
     "axios": "^1.3.6"