@xchainjs/xchain-utxo 0.1.1

package/lib/client.d.ts

@@ -0,0 +1,81 @@
+/// <reference types="node" />
+import { Balance, BaseXChainClient, ExplorerProviders, FeeEstimateOptions, FeeRate, FeeRates, Fees, FeesWithRates, Protocol, Tx, TxHash, TxHistoryParams, TxsPage } from '@xchainjs/xchain-client';
+import { Address, Asset, Chain } from '@xchainjs/xchain-util';
+import { UTXO, UtxoOnlineDataProviders } from '@xchainjs/xchain-utxo-providers';
+import { UtxoClientParams } from './types';
+export declare abstract class Client extends BaseXChainClient {
+    protected explorerProviders: ExplorerProviders;
+    protected dataProviders: UtxoOnlineDataProviders[];
+    /**
+     * Constructor
+     * Client is initialized with network type
+     *
+     * @param {Chain} chain Chain to instantiate the client with
+     * @param {UtxoClientParams} params
+     */
+    constructor(chain: Chain, params: UtxoClientParams);
+    /**
+     * Get the explorer url.
+     *
+     * @returns {string} The explorer url based on the network.
+     */
+    getExplorerUrl(): string;
+    /**
+     * Get the explorer url for the given address.
+     *
+     * @param {Address} address
+     * @returns {string} The explorer url for the given address based on the network.
+     */
+    getExplorerAddressUrl(address: string): string;
+    /**
+     * Get the explorer url for the given transaction id.
+     *
+     * @param {string} txID The transaction id
+     * @returns {string} The explorer url for the given transaction id based on the network.
+     */
+    getExplorerTxUrl(txID: string): string;
+    /**
+     * Get transaction history of a given address with pagination options.
+     * By default it will return the transaction history of the current wallet.
+     *
+     * @param {TxHistoryParams} params The options to get transaction history. (optional)
+     * @returns {TxsPage} The transaction history.
+     */
+    getTransactions(params?: TxHistoryParams): Promise<TxsPage>;
+    /**
+     * Get the transaction details of a given transaction id.
+     *
+     * @param {string} txId The transaction id.
+     * @returns {Tx} The transaction details of the given transaction id.
+     */
+    getTransactionData(txId: string): Promise<Tx>;
+    /**
+     * Gets balance of a given address.
+     *
+     * @param {Address} address to get balances from
+     * @param {undefined} Needed for legacy only to be in common with `XChainClient` interface - will be removed by a next version
+     * @param {confirmedOnly} Flag to get balances of confirmed txs only
+     *
+     * @returns {Balance[]} BTC balances
+     */
+    getBalance(address: Address, _assets?: Asset[], confirmedOnly?: boolean): Promise<Balance[]>;
+    protected scanUTXOs(address: string, confirmedOnly?: boolean): Promise<UTXO[]>;
+    getFeesWithRates(options?: FeeEstimateOptions): Promise<FeesWithRates>;
+    getFees(options?: FeeEstimateOptions): Promise<Fees>;
+    /**
+     * Get fee rates
+     * @param {Protocol} protocol Protocol to interact with. If there's no protocol provided, fee rates are retrieved from chain data providers
+     *
+     * @returns {FeeRates} The fee rates (average, fast, fastest) in `Satoshis/byte`
+     */
+    getFeeRates(protocol?: Protocol): Promise<FeeRates>;
+    broadcastTx(txHex: string): Promise<TxHash>;
+    protected roundRobinGetBalance(address: Address): Promise<Balance[]>;
+    protected roundRobinGetUnspentTxs(address: Address, confirmed: boolean): Promise<UTXO[]>;
+    protected roundRobinGetTransactionData(txid: string): Promise<Tx>;
+    protected roundRobinGetTransactions(params: TxHistoryParams): Promise<TxsPage>;
+    protected roundRobinBroadcastTx(txHex: string): Promise<string>;
+    protected abstract compileMemo(memo: string): Buffer;
+    protected abstract getFeeFromUtxos(inputs: UTXO[], feeRate: FeeRate, data: Buffer | null): number;
+    protected roundRobinGetFeeRates(): Promise<FeeRates>;
+}

package/lib/index.d.ts

@@ -0,0 +1,3 @@
+import { Client } from './client';
+import { PreparedTx, UTXO, UtxoClientParams, Witness } from './types';
+export { Client, UTXO, UtxoClientParams, Witness, PreparedTx };

package/lib/index.esm.js

@@ -0,0 +1,275 @@
+import { BaseXChainClient, FeeType, Protocol, standardFeeRates } from '@xchainjs/xchain-client';
+import { baseAmount } from '@xchainjs/xchain-util';
+
+/******************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+
+function __awaiter(thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+}
+
+class Client extends BaseXChainClient {
+    /**
+     * Constructor
+     * Client is initialized with network type
+     *
+     * @param {Chain} chain Chain to instantiate the client with
+     * @param {UtxoClientParams} params
+     */
+    constructor(chain, params) {
+        super(chain, {
+            network: params.network,
+            rootDerivationPaths: params.rootDerivationPaths,
+            phrase: params.phrase,
+            feeBounds: params.feeBounds,
+        });
+        this.explorerProviders = params.explorerProviders;
+        this.dataProviders = params.dataProviders;
+    }
+    /**
+     * Get the explorer url.
+     *
+     * @returns {string} The explorer url based on the network.
+     */
+    getExplorerUrl() {
+        return this.explorerProviders[this.network].getExplorerUrl();
+    }
+    /**
+     * Get the explorer url for the given address.
+     *
+     * @param {Address} address
+     * @returns {string} The explorer url for the given address based on the network.
+     */
+    getExplorerAddressUrl(address) {
+        return this.explorerProviders[this.network].getExplorerAddressUrl(address);
+    }
+    /**
+     * Get the explorer url for the given transaction id.
+     *
+     * @param {string} txID The transaction id
+     * @returns {string} The explorer url for the given transaction id based on the network.
+     */
+    getExplorerTxUrl(txID) {
+        return this.explorerProviders[this.network].getExplorerTxUrl(txID);
+    }
+    /**
+     * Get transaction history of a given address with pagination options.
+     * By default it will return the transaction history of the current wallet.
+     *
+     * @param {TxHistoryParams} params The options to get transaction history. (optional)
+     * @returns {TxsPage} The transaction history.
+     */
+    getTransactions(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const filteredParams = {
+                address: (params === null || params === void 0 ? void 0 : params.address) || (yield this.getAddress()),
+                offset: params === null || params === void 0 ? void 0 : params.offset,
+                limit: params === null || params === void 0 ? void 0 : params.limit,
+                startTime: params === null || params === void 0 ? void 0 : params.startTime,
+                asset: params === null || params === void 0 ? void 0 : params.asset,
+            };
+            return yield this.roundRobinGetTransactions(filteredParams);
+        });
+    }
+    /**
+     * Get the transaction details of a given transaction id.
+     *
+     * @param {string} txId The transaction id.
+     * @returns {Tx} The transaction details of the given transaction id.
+     */
+    getTransactionData(txId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.roundRobinGetTransactionData(txId);
+        });
+    }
+    /**
+     * Gets balance of a given address.
+     *
+     * @param {Address} address to get balances from
+     * @param {undefined} Needed for legacy only to be in common with `XChainClient` interface - will be removed by a next version
+     * @param {confirmedOnly} Flag to get balances of confirmed txs only
+     *
+     * @returns {Balance[]} BTC balances
+     */
+    // TODO (@xchain-team|@veado) Change params to be an object to be extendable more easily
+    // see changes for `xchain-bitcoin` https://github.com/xchainjs/xchainjs-lib/pull/490
+    getBalance(address, _assets /* not used */, confirmedOnly) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.roundRobinGetBalance(address);
+        });
+    }
+    scanUTXOs(address, confirmedOnly = true) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.roundRobinGetUnspentTxs(address, confirmedOnly);
+        });
+    }
+    getFeesWithRates(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const utxos = (options === null || options === void 0 ? void 0 : options.sender) ? yield this.scanUTXOs(options.sender, false) : [];
+            const compiledMemo = (options === null || options === void 0 ? void 0 : options.memo) ? this.compileMemo(options.memo) : null;
+            const rates = yield this.getFeeRates();
+            return {
+                fees: {
+                    average: baseAmount(this.getFeeFromUtxos(utxos, rates.average, compiledMemo)),
+                    fast: baseAmount(this.getFeeFromUtxos(utxos, rates.fast, compiledMemo)),
+                    fastest: baseAmount(this.getFeeFromUtxos(utxos, rates.fastest, compiledMemo)),
+                    type: FeeType.PerByte,
+                },
+                rates,
+            };
+        });
+    }
+    getFees(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { fees } = yield this.getFeesWithRates(options);
+            return fees;
+        });
+    }
+    /**
+     * Get fee rates
+     * @param {Protocol} protocol Protocol to interact with. If there's no protocol provided, fee rates are retrieved from chain data providers
+     *
+     * @returns {FeeRates} The fee rates (average, fast, fastest) in `Satoshis/byte`
+     */
+    getFeeRates(protocol) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!protocol) {
+                try {
+                    const feeRates = yield this.roundRobinGetFeeRates();
+                    return feeRates;
+                }
+                catch (error) {
+                    console.warn('Can not retrieve fee rates from provider');
+                }
+            }
+            if (!protocol || Protocol.THORCHAIN) {
+                try {
+                    const feeRate = yield this.getFeeRateFromThorchain();
+                    return standardFeeRates(feeRate);
+                }
+                catch (error) {
+                    console.warn(`Can not retrieve fee rates from Thorchain`);
+                }
+            }
+            // TODO: Return default value
+            throw Error('Can not retrieve fee rates');
+        });
+    }
+    broadcastTx(txHex) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.roundRobinBroadcastTx(txHex);
+        });
+    }
+    roundRobinGetBalance(address) {
+        return __awaiter(this, void 0, void 0, function* () {
+            for (const provider of this.dataProviders) {
+                try {
+                    const prov = provider[this.network];
+                    if (prov)
+                        return yield prov.getBalance(address, undefined);
+                }
+                catch (error) {
+                    console.warn(error);
+                }
+            }
+            throw Error('no provider able to get balance');
+        });
+    }
+    roundRobinGetUnspentTxs(address, confirmed) {
+        return __awaiter(this, void 0, void 0, function* () {
+            for (const provider of this.dataProviders) {
+                try {
+                    const prov = provider[this.network];
+                    if (prov) {
+                        return confirmed ? yield prov.getConfirmedUnspentTxs(address) : yield prov.getUnspentTxs(address);
+                    }
+                }
+                catch (error) {
+                    console.warn(error);
+                }
+            }
+            throw Error('no provider able to GetUnspentTxs');
+        });
+    }
+    roundRobinGetTransactionData(txid) {
+        return __awaiter(this, void 0, void 0, function* () {
+            for (const provider of this.dataProviders) {
+                try {
+                    const prov = provider[this.network];
+                    if (prov)
+                        return yield prov.getTransactionData(txid);
+                }
+                catch (error) {
+                    console.warn(error);
+                }
+            }
+            throw Error('no provider able to GetTransactionData');
+        });
+    }
+    roundRobinGetTransactions(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            for (const provider of this.dataProviders) {
+                try {
+                    const prov = provider[this.network];
+                    if (prov)
+                        return yield prov.getTransactions(params);
+                }
+                catch (error) {
+                    console.warn(error);
+                }
+            }
+            throw Error('no provider able to GetTransactions');
+        });
+    }
+    roundRobinBroadcastTx(txHex) {
+        return __awaiter(this, void 0, void 0, function* () {
+            for (const provider of this.dataProviders) {
+                try {
+                    const prov = provider[this.network];
+                    if (prov)
+                        return yield prov.broadcastTx(txHex);
+                }
+                catch (error) {
+                    console.warn(error);
+                }
+            }
+            throw Error('no provider able to BroadcastTx');
+        });
+    }
+    roundRobinGetFeeRates() {
+        return __awaiter(this, void 0, void 0, function* () {
+            for (const provider of this.dataProviders) {
+                try {
+                    const prov = provider[this.network];
+                    if (prov)
+                        return yield prov.getFeeRates();
+                }
+                catch (error) {
+                    console.warn(error);
+                }
+            }
+            throw Error('no provider able to get fee rates');
+        });
+    }
+}
+
+export { Client };
+//# sourceMappingURL=index.esm.js.map

package/lib/index.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.esm.js","sources":["../src/client.ts"],"sourcesContent":["import {\n  Balance,\n  BaseXChainClient,\n  ExplorerProviders,\n  FeeEstimateOptions,\n  FeeRate,\n  FeeRates,\n  FeeType,\n  Fees,\n  FeesWithRates,\n  Protocol,\n  Tx,\n  TxHash,\n  TxHistoryParams,\n  TxsPage,\n  standardFeeRates,\n} from '@xchainjs/xchain-client'\nimport { Address, Asset, Chain, baseAmount } from '@xchainjs/xchain-util'\nimport { UTXO, UtxoOnlineDataProviders } from '@xchainjs/xchain-utxo-providers'\n\nimport { UtxoClientParams } from './types'\n\nexport abstract class Client extends BaseXChainClient {\n  protected explorerProviders: ExplorerProviders\n  protected dataProviders: UtxoOnlineDataProviders[]\n\n  /**\n   * Constructor\n   * Client is initialized with network type\n   *\n   * @param {Chain} chain Chain to instantiate the client with\n   * @param {UtxoClientParams} params\n   */\n  constructor(chain: Chain, params: UtxoClientParams) {\n    super(chain, {\n      network: params.network,\n      rootDerivationPaths: params.rootDerivationPaths,\n      phrase: params.phrase,\n      feeBounds: params.feeBounds,\n    })\n    this.explorerProviders = params.explorerProviders\n    this.dataProviders = params.dataProviders\n  }\n\n  /**\n   * Get the explorer url.\n   *\n   * @returns {string} The explorer url based on the network.\n   */\n  getExplorerUrl(): string {\n    return this.explorerProviders[this.network].getExplorerUrl()\n  }\n\n  /**\n   * Get the explorer url for the given address.\n   *\n   * @param {Address} address\n   * @returns {string} The explorer url for the given address based on the network.\n   */\n  getExplorerAddressUrl(address: string): string {\n    return this.explorerProviders[this.network].getExplorerAddressUrl(address)\n  }\n\n  /**\n   * Get the explorer url for the given transaction id.\n   *\n   * @param {string} txID The transaction id\n   * @returns {string} The explorer url for the given transaction id based on the network.\n   */\n  getExplorerTxUrl(txID: string): string {\n    return this.explorerProviders[this.network].getExplorerTxUrl(txID)\n  }\n\n  /**\n   * Get transaction history of a given address with pagination options.\n   * By default it will return the transaction history of the current wallet.\n   *\n   * @param {TxHistoryParams} params The options to get transaction history. (optional)\n   * @returns {TxsPage} The transaction history.\n   */\n  async getTransactions(params?: TxHistoryParams): Promise<TxsPage> {\n    const filteredParams: TxHistoryParams = {\n      address: params?.address || (await this.getAddress()),\n      offset: params?.offset,\n      limit: params?.limit,\n      startTime: params?.startTime,\n      asset: params?.asset,\n    }\n\n    return await this.roundRobinGetTransactions(filteredParams)\n  }\n\n  /**\n   * Get the transaction details of a given transaction id.\n   *\n   * @param {string} txId The transaction id.\n   * @returns {Tx} The transaction details of the given transaction id.\n   */\n  async getTransactionData(txId: string): Promise<Tx> {\n    return await this.roundRobinGetTransactionData(txId)\n  }\n\n  /**\n   * Gets balance of a given address.\n   *\n   * @param {Address} address to get balances from\n   * @param {undefined} Needed for legacy only to be in common with `XChainClient` interface - will be removed by a next version\n   * @param {confirmedOnly} Flag to get balances of confirmed txs only\n   *\n   * @returns {Balance[]} BTC balances\n   */\n  // TODO (@xchain-team|@veado) Change params to be an object to be extendable more easily\n  // see changes for `xchain-bitcoin` https://github.com/xchainjs/xchainjs-lib/pull/490\n  async getBalance(address: Address, _assets?: Asset[] /* not used */, confirmedOnly?: boolean): Promise<Balance[]> {\n    // TODO figure this out ---> !!confirmedOnly)\n    confirmedOnly\n    return await this.roundRobinGetBalance(address)\n  }\n\n  protected async scanUTXOs(\n    address: string,\n    confirmedOnly = true, // default: scan only confirmed UTXOs\n  ): Promise<UTXO[]> {\n    return this.roundRobinGetUnspentTxs(address, confirmedOnly)\n  }\n\n  async getFeesWithRates(options?: FeeEstimateOptions): Promise<FeesWithRates> {\n    const utxos = options?.sender ? await this.scanUTXOs(options.sender, false) : []\n    const compiledMemo = options?.memo ? this.compileMemo(options.memo) : null\n\n    const rates = await this.getFeeRates()\n\n    return {\n      fees: {\n        average: baseAmount(this.getFeeFromUtxos(utxos, rates.average, compiledMemo)),\n        fast: baseAmount(this.getFeeFromUtxos(utxos, rates.fast, compiledMemo)),\n        fastest: baseAmount(this.getFeeFromUtxos(utxos, rates.fastest, compiledMemo)),\n        type: FeeType.PerByte,\n      },\n      rates,\n    }\n  }\n\n  async getFees(options?: FeeEstimateOptions): Promise<Fees> {\n    const { fees } = await this.getFeesWithRates(options)\n    return fees\n  }\n\n  /**\n   * Get fee rates\n   * @param {Protocol} protocol Protocol to interact with. If there's no protocol provided, fee rates are retrieved from chain data providers\n   *\n   * @returns {FeeRates} The fee rates (average, fast, fastest) in `Satoshis/byte`\n   */\n  async getFeeRates(protocol?: Protocol): Promise<FeeRates> {\n    if (!protocol) {\n      try {\n        const feeRates = await this.roundRobinGetFeeRates()\n        return feeRates\n      } catch (error) {\n        console.warn('Can not retrieve fee rates from provider')\n      }\n    }\n\n    if (!protocol || Protocol.THORCHAIN) {\n      try {\n        const feeRate = await this.getFeeRateFromThorchain()\n        return standardFeeRates(feeRate)\n      } catch (error) {\n        console.warn(`Can not retrieve fee rates from Thorchain`)\n      }\n    }\n    // TODO: Return default value\n    throw Error('Can not retrieve fee rates')\n  }\n\n  async broadcastTx(txHex: string): Promise<TxHash> {\n    return await this.roundRobinBroadcastTx(txHex)\n  }\n\n  protected async roundRobinGetBalance(address: Address) {\n    for (const provider of this.dataProviders) {\n      try {\n        const prov = provider[this.network]\n        if (prov) return await prov.getBalance(address, undefined)\n      } catch (error) {\n        console.warn(error)\n      }\n    }\n    throw Error('no provider able to get balance')\n  }\n\n  protected async roundRobinGetUnspentTxs(address: Address, confirmed: boolean) {\n    for (const provider of this.dataProviders) {\n      try {\n        const prov = provider[this.network]\n        if (prov) {\n          return confirmed ? await prov.getConfirmedUnspentTxs(address) : await prov.getUnspentTxs(address)\n        }\n      } catch (error) {\n        console.warn(error)\n      }\n    }\n    throw Error('no provider able to GetUnspentTxs')\n  }\n\n  protected async roundRobinGetTransactionData(txid: string) {\n    for (const provider of this.dataProviders) {\n      try {\n        const prov = provider[this.network]\n        if (prov) return await prov.getTransactionData(txid)\n      } catch (error) {\n        console.warn(error)\n      }\n    }\n    throw Error('no provider able to GetTransactionData')\n  }\n\n  protected async roundRobinGetTransactions(params: TxHistoryParams) {\n    for (const provider of this.dataProviders) {\n      try {\n        const prov = provider[this.network]\n        if (prov) return await prov.getTransactions(params)\n      } catch (error) {\n        console.warn(error)\n      }\n    }\n    throw Error('no provider able to GetTransactions')\n  }\n\n  protected async roundRobinBroadcastTx(txHex: string) {\n    for (const provider of this.dataProviders) {\n      try {\n        const prov = provider[this.network]\n        if (prov) return await prov.broadcastTx(txHex)\n      } catch (error) {\n        console.warn(error)\n      }\n    }\n    throw Error('no provider able to BroadcastTx')\n  }\n\n  protected abstract compileMemo(memo: string): Buffer\n  protected abstract getFeeFromUtxos(inputs: UTXO[], feeRate: FeeRate, data: Buffer | null): number\n  protected async roundRobinGetFeeRates(): Promise<FeeRates> {\n    for (const provider of this.dataProviders) {\n      try {\n        const prov = provider[this.network]\n        if (prov) return await prov.getFeeRates()\n      } catch (error) {\n        console.warn(error)\n      }\n    }\n    throw Error('no provider able to get fee rates')\n  }\n}\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsBM,MAAgB,MAAO,SAAQ,gBAAgB,CAAA;AAInD;;;;;;AAMG;IACH,WAAY,CAAA,KAAY,EAAE,MAAwB,EAAA;QAChD,KAAK,CAAC,KAAK,EAAE;YACX,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,mBAAmB,EAAE,MAAM,CAAC,mBAAmB;YAC/C,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,SAAS,EAAE,MAAM,CAAC,SAAS;AAC5B,SAAA,CAAC,CAAA;AACF,QAAA,IAAI,CAAC,iBAAiB,GAAG,MAAM,CAAC,iBAAiB,CAAA;AACjD,QAAA,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,aAAa,CAAA;KAC1C;AAED;;;;AAIG;IACH,cAAc,GAAA;QACZ,OAAO,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,cAAc,EAAE,CAAA;KAC7D;AAED;;;;;AAKG;AACH,IAAA,qBAAqB,CAAC,OAAe,EAAA;AACnC,QAAA,OAAO,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAA;KAC3E;AAED;;;;;AAKG;AACH,IAAA,gBAAgB,CAAC,IAAY,EAAA;AAC3B,QAAA,OAAO,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAA;KACnE;AAED;;;;;;AAMG;AACG,IAAA,eAAe,CAAC,MAAwB,EAAA;;AAC5C,YAAA,MAAM,cAAc,GAAoB;AACtC,gBAAA,OAAO,EAAE,CAAA,MAAM,KAAN,IAAA,IAAA,MAAM,uBAAN,MAAM,CAAE,OAAO,MAAK,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;AACrD,gBAAA,MAAM,EAAE,MAAM,KAAA,IAAA,IAAN,MAAM,KAAN,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,MAAM,CAAE,MAAM;AACtB,gBAAA,KAAK,EAAE,MAAM,KAAA,IAAA,IAAN,MAAM,KAAN,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,MAAM,CAAE,KAAK;AACpB,gBAAA,SAAS,EAAE,MAAM,KAAA,IAAA,IAAN,MAAM,KAAN,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,MAAM,CAAE,SAAS;AAC5B,gBAAA,KAAK,EAAE,MAAM,KAAA,IAAA,IAAN,MAAM,KAAN,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,MAAM,CAAE,KAAK;aACrB,CAAA;AAED,YAAA,OAAO,MAAM,IAAI,CAAC,yBAAyB,CAAC,cAAc,CAAC,CAAA;SAC5D,CAAA,CAAA;AAAA,KAAA;AAED;;;;;AAKG;AACG,IAAA,kBAAkB,CAAC,IAAY,EAAA;;AACnC,YAAA,OAAO,MAAM,IAAI,CAAC,4BAA4B,CAAC,IAAI,CAAC,CAAA;SACrD,CAAA,CAAA;AAAA,KAAA;AAED;;;;;;;;AAQG;;;AAGG,IAAA,UAAU,CAAC,OAAgB,EAAE,OAAiB,iBAAiB,aAAuB,EAAA;;AAG1F,YAAA,OAAO,MAAM,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAA;SAChD,CAAA,CAAA;AAAA,KAAA;AAEe,IAAA,SAAS,CACvB,OAAe,EACf,aAAa,GAAG,IAAI,EAAA;;YAEpB,OAAO,IAAI,CAAC,uBAAuB,CAAC,OAAO,EAAE,aAAa,CAAC,CAAA;SAC5D,CAAA,CAAA;AAAA,KAAA;AAEK,IAAA,gBAAgB,CAAC,OAA4B,EAAA;;AACjD,YAAA,MAAM,KAAK,GAAG,CAAA,OAAO,KAAP,IAAA,IAAA,OAAO,KAAP,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,OAAO,CAAE,MAAM,IAAG,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,EAAE,CAAA;YAChF,MAAM,YAAY,GAAG,CAAA,OAAO,KAAA,IAAA,IAAP,OAAO,KAAP,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,OAAO,CAAE,IAAI,IAAG,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;AAE1E,YAAA,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,WAAW,EAAE,CAAA;YAEtC,OAAO;AACL,gBAAA,IAAI,EAAE;AACJ,oBAAA,OAAO,EAAE,UAAU,CAAC,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,KAAK,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;AAC7E,oBAAA,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;AACvE,oBAAA,OAAO,EAAE,UAAU,CAAC,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,KAAK,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;oBAC7E,IAAI,EAAE,OAAO,CAAC,OAAO;AACtB,iBAAA;gBACD,KAAK;aACN,CAAA;SACF,CAAA,CAAA;AAAA,KAAA;AAEK,IAAA,OAAO,CAAC,OAA4B,EAAA;;YACxC,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAA;AACrD,YAAA,OAAO,IAAI,CAAA;SACZ,CAAA,CAAA;AAAA,KAAA;AAED;;;;;AAKG;AACG,IAAA,WAAW,CAAC,QAAmB,EAAA;;YACnC,IAAI,CAAC,QAAQ,EAAE;gBACb,IAAI;AACF,oBAAA,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,qBAAqB,EAAE,CAAA;AACnD,oBAAA,OAAO,QAAQ,CAAA;AAChB,iBAAA;AAAC,gBAAA,OAAO,KAAK,EAAE;AACd,oBAAA,OAAO,CAAC,IAAI,CAAC,0CAA0C,CAAC,CAAA;AACzD,iBAAA;AACF,aAAA;AAED,YAAA,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,SAAS,EAAE;gBACnC,IAAI;AACF,oBAAA,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,uBAAuB,EAAE,CAAA;AACpD,oBAAA,OAAO,gBAAgB,CAAC,OAAO,CAAC,CAAA;AACjC,iBAAA;AAAC,gBAAA,OAAO,KAAK,EAAE;AACd,oBAAA,OAAO,CAAC,IAAI,CAAC,CAAA,yCAAA,CAA2C,CAAC,CAAA;AAC1D,iBAAA;AACF,aAAA;;AAED,YAAA,MAAM,KAAK,CAAC,4BAA4B,CAAC,CAAA;SAC1C,CAAA,CAAA;AAAA,KAAA;AAEK,IAAA,WAAW,CAAC,KAAa,EAAA;;AAC7B,YAAA,OAAO,MAAM,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAA;SAC/C,CAAA,CAAA;AAAA,KAAA;AAEe,IAAA,oBAAoB,CAAC,OAAgB,EAAA;;AACnD,YAAA,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,aAAa,EAAE;gBACzC,IAAI;oBACF,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;AACnC,oBAAA,IAAI,IAAI;wBAAE,OAAO,MAAM,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;AAC3D,iBAAA;AAAC,gBAAA,OAAO,KAAK,EAAE;AACd,oBAAA,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;AACpB,iBAAA;AACF,aAAA;AACD,YAAA,MAAM,KAAK,CAAC,iCAAiC,CAAC,CAAA;SAC/C,CAAA,CAAA;AAAA,KAAA;IAEe,uBAAuB,CAAC,OAAgB,EAAE,SAAkB,EAAA;;AAC1E,YAAA,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,aAAa,EAAE;gBACzC,IAAI;oBACF,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;AACnC,oBAAA,IAAI,IAAI,EAAE;wBACR,OAAO,SAAS,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAA;AAClG,qBAAA;AACF,iBAAA;AAAC,gBAAA,OAAO,KAAK,EAAE;AACd,oBAAA,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;AACpB,iBAAA;AACF,aAAA;AACD,YAAA,MAAM,KAAK,CAAC,mCAAmC,CAAC,CAAA;SACjD,CAAA,CAAA;AAAA,KAAA;AAEe,IAAA,4BAA4B,CAAC,IAAY,EAAA;;AACvD,YAAA,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,aAAa,EAAE;gBACzC,IAAI;oBACF,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;AACnC,oBAAA,IAAI,IAAI;AAAE,wBAAA,OAAO,MAAM,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAA;AACrD,iBAAA;AAAC,gBAAA,OAAO,KAAK,EAAE;AACd,oBAAA,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;AACpB,iBAAA;AACF,aAAA;AACD,YAAA,MAAM,KAAK,CAAC,wCAAwC,CAAC,CAAA;SACtD,CAAA,CAAA;AAAA,KAAA;AAEe,IAAA,yBAAyB,CAAC,MAAuB,EAAA;;AAC/D,YAAA,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,aAAa,EAAE;gBACzC,IAAI;oBACF,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;AACnC,oBAAA,IAAI,IAAI;AAAE,wBAAA,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAA;AACpD,iBAAA;AAAC,gBAAA,OAAO,KAAK,EAAE;AACd,oBAAA,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;AACpB,iBAAA;AACF,aAAA;AACD,YAAA,MAAM,KAAK,CAAC,qCAAqC,CAAC,CAAA;SACnD,CAAA,CAAA;AAAA,KAAA;AAEe,IAAA,qBAAqB,CAAC,KAAa,EAAA;;AACjD,YAAA,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,aAAa,EAAE;gBACzC,IAAI;oBACF,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;AACnC,oBAAA,IAAI,IAAI;AAAE,wBAAA,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAA;AAC/C,iBAAA;AAAC,gBAAA,OAAO,KAAK,EAAE;AACd,oBAAA,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;AACpB,iBAAA;AACF,aAAA;AACD,YAAA,MAAM,KAAK,CAAC,iCAAiC,CAAC,CAAA;SAC/C,CAAA,CAAA;AAAA,KAAA;IAIe,qBAAqB,GAAA;;AACnC,YAAA,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,aAAa,EAAE;gBACzC,IAAI;oBACF,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;AACnC,oBAAA,IAAI,IAAI;AAAE,wBAAA,OAAO,MAAM,IAAI,CAAC,WAAW,EAAE,CAAA;AAC1C,iBAAA;AAAC,gBAAA,OAAO,KAAK,EAAE;AACd,oBAAA,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;AACpB,iBAAA;AACF,aAAA;AACD,YAAA,MAAM,KAAK,CAAC,mCAAmC,CAAC,CAAA;SACjD,CAAA,CAAA;AAAA,KAAA;AACF;;;;"}

package/lib/index.js

@@ -0,0 +1,279 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var xchainClient = require('@xchainjs/xchain-client');
+var xchainUtil = require('@xchainjs/xchain-util');
+
+/******************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+
+function __awaiter(thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+}
+
+class Client extends xchainClient.BaseXChainClient {
+    /**
+     * Constructor
+     * Client is initialized with network type
+     *
+     * @param {Chain} chain Chain to instantiate the client with
+     * @param {UtxoClientParams} params
+     */
+    constructor(chain, params) {
+        super(chain, {
+            network: params.network,
+            rootDerivationPaths: params.rootDerivationPaths,
+            phrase: params.phrase,
+            feeBounds: params.feeBounds,
+        });
+        this.explorerProviders = params.explorerProviders;
+        this.dataProviders = params.dataProviders;
+    }
+    /**
+     * Get the explorer url.
+     *
+     * @returns {string} The explorer url based on the network.
+     */
+    getExplorerUrl() {
+        return this.explorerProviders[this.network].getExplorerUrl();
+    }
+    /**
+     * Get the explorer url for the given address.
+     *
+     * @param {Address} address
+     * @returns {string} The explorer url for the given address based on the network.
+     */
+    getExplorerAddressUrl(address) {
+        return this.explorerProviders[this.network].getExplorerAddressUrl(address);
+    }
+    /**
+     * Get the explorer url for the given transaction id.
+     *
+     * @param {string} txID The transaction id
+     * @returns {string} The explorer url for the given transaction id based on the network.
+     */
+    getExplorerTxUrl(txID) {
+        return this.explorerProviders[this.network].getExplorerTxUrl(txID);
+    }
+    /**
+     * Get transaction history of a given address with pagination options.
+     * By default it will return the transaction history of the current wallet.
+     *
+     * @param {TxHistoryParams} params The options to get transaction history. (optional)
+     * @returns {TxsPage} The transaction history.
+     */
+    getTransactions(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const filteredParams = {
+                address: (params === null || params === void 0 ? void 0 : params.address) || (yield this.getAddress()),
+                offset: params === null || params === void 0 ? void 0 : params.offset,
+                limit: params === null || params === void 0 ? void 0 : params.limit,
+                startTime: params === null || params === void 0 ? void 0 : params.startTime,
+                asset: params === null || params === void 0 ? void 0 : params.asset,
+            };
+            return yield this.roundRobinGetTransactions(filteredParams);
+        });
+    }
+    /**
+     * Get the transaction details of a given transaction id.
+     *
+     * @param {string} txId The transaction id.
+     * @returns {Tx} The transaction details of the given transaction id.
+     */
+    getTransactionData(txId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.roundRobinGetTransactionData(txId);
+        });
+    }
+    /**
+     * Gets balance of a given address.
+     *
+     * @param {Address} address to get balances from
+     * @param {undefined} Needed for legacy only to be in common with `XChainClient` interface - will be removed by a next version
+     * @param {confirmedOnly} Flag to get balances of confirmed txs only
+     *
+     * @returns {Balance[]} BTC balances
+     */
+    // TODO (@xchain-team|@veado) Change params to be an object to be extendable more easily
+    // see changes for `xchain-bitcoin` https://github.com/xchainjs/xchainjs-lib/pull/490
+    getBalance(address, _assets /* not used */, confirmedOnly) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.roundRobinGetBalance(address);
+        });
+    }
+    scanUTXOs(address, confirmedOnly = true) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.roundRobinGetUnspentTxs(address, confirmedOnly);
+        });
+    }
+    getFeesWithRates(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const utxos = (options === null || options === void 0 ? void 0 : options.sender) ? yield this.scanUTXOs(options.sender, false) : [];
+            const compiledMemo = (options === null || options === void 0 ? void 0 : options.memo) ? this.compileMemo(options.memo) : null;
+            const rates = yield this.getFeeRates();
+            return {
+                fees: {
+                    average: xchainUtil.baseAmount(this.getFeeFromUtxos(utxos, rates.average, compiledMemo)),
+                    fast: xchainUtil.baseAmount(this.getFeeFromUtxos(utxos, rates.fast, compiledMemo)),
+                    fastest: xchainUtil.baseAmount(this.getFeeFromUtxos(utxos, rates.fastest, compiledMemo)),
+                    type: xchainClient.FeeType.PerByte,
+                },
+                rates,
+            };
+        });
+    }
+    getFees(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { fees } = yield this.getFeesWithRates(options);
+            return fees;
+        });
+    }
+    /**
+     * Get fee rates
+     * @param {Protocol} protocol Protocol to interact with. If there's no protocol provided, fee rates are retrieved from chain data providers
+     *
+     * @returns {FeeRates} The fee rates (average, fast, fastest) in `Satoshis/byte`
+     */
+    getFeeRates(protocol) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!protocol) {
+                try {
+                    const feeRates = yield this.roundRobinGetFeeRates();
+                    return feeRates;
+                }
+                catch (error) {
+                    console.warn('Can not retrieve fee rates from provider');
+                }
+            }
+            if (!protocol || xchainClient.Protocol.THORCHAIN) {
+                try {
+                    const feeRate = yield this.getFeeRateFromThorchain();
+                    return xchainClient.standardFeeRates(feeRate);
+                }
+                catch (error) {
+                    console.warn(`Can not retrieve fee rates from Thorchain`);
+                }
+            }
+            // TODO: Return default value
+            throw Error('Can not retrieve fee rates');
+        });
+    }
+    broadcastTx(txHex) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.roundRobinBroadcastTx(txHex);
+        });
+    }
+    roundRobinGetBalance(address) {
+        return __awaiter(this, void 0, void 0, function* () {
+            for (const provider of this.dataProviders) {
+                try {
+                    const prov = provider[this.network];
+                    if (prov)
+                        return yield prov.getBalance(address, undefined);
+                }
+                catch (error) {
+                    console.warn(error);
+                }
+            }
+            throw Error('no provider able to get balance');
+        });
+    }
+    roundRobinGetUnspentTxs(address, confirmed) {
+        return __awaiter(this, void 0, void 0, function* () {
+            for (const provider of this.dataProviders) {
+                try {
+                    const prov = provider[this.network];
+                    if (prov) {
+                        return confirmed ? yield prov.getConfirmedUnspentTxs(address) : yield prov.getUnspentTxs(address);
+                    }
+                }
+                catch (error) {
+                    console.warn(error);
+                }
+            }
+            throw Error('no provider able to GetUnspentTxs');
+        });
+    }
+    roundRobinGetTransactionData(txid) {
+        return __awaiter(this, void 0, void 0, function* () {
+            for (const provider of this.dataProviders) {
+                try {
+                    const prov = provider[this.network];
+                    if (prov)
+                        return yield prov.getTransactionData(txid);
+                }
+                catch (error) {
+                    console.warn(error);
+                }
+            }
+            throw Error('no provider able to GetTransactionData');
+        });
+    }
+    roundRobinGetTransactions(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            for (const provider of this.dataProviders) {
+                try {
+                    const prov = provider[this.network];
+                    if (prov)
+                        return yield prov.getTransactions(params);
+                }
+                catch (error) {
+                    console.warn(error);
+                }
+            }
+            throw Error('no provider able to GetTransactions');
+        });
+    }
+    roundRobinBroadcastTx(txHex) {
+        return __awaiter(this, void 0, void 0, function* () {
+            for (const provider of this.dataProviders) {
+                try {
+                    const prov = provider[this.network];
+                    if (prov)
+                        return yield prov.broadcastTx(txHex);
+                }
+                catch (error) {
+                    console.warn(error);
+                }
+            }
+            throw Error('no provider able to BroadcastTx');
+        });
+    }
+    roundRobinGetFeeRates() {
+        return __awaiter(this, void 0, void 0, function* () {
+            for (const provider of this.dataProviders) {
+                try {
+                    const prov = provider[this.network];
+                    if (prov)
+                        return yield prov.getFeeRates();
+                }
+                catch (error) {
+                    console.warn(error);
+                }
+            }
+            throw Error('no provider able to get fee rates');
+        });
+    }
+}
+
+exports.Client = Client;
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../src/client.ts"],"sourcesContent":["import {\n  Balance,\n  BaseXChainClient,\n  ExplorerProviders,\n  FeeEstimateOptions,\n  FeeRate,\n  FeeRates,\n  FeeType,\n  Fees,\n  FeesWithRates,\n  Protocol,\n  Tx,\n  TxHash,\n  TxHistoryParams,\n  TxsPage,\n  standardFeeRates,\n} from '@xchainjs/xchain-client'\nimport { Address, Asset, Chain, baseAmount } from '@xchainjs/xchain-util'\nimport { UTXO, UtxoOnlineDataProviders } from '@xchainjs/xchain-utxo-providers'\n\nimport { UtxoClientParams } from './types'\n\nexport abstract class Client extends BaseXChainClient {\n  protected explorerProviders: ExplorerProviders\n  protected dataProviders: UtxoOnlineDataProviders[]\n\n  /**\n   * Constructor\n   * Client is initialized with network type\n   *\n   * @param {Chain} chain Chain to instantiate the client with\n   * @param {UtxoClientParams} params\n   */\n  constructor(chain: Chain, params: UtxoClientParams) {\n    super(chain, {\n      network: params.network,\n      rootDerivationPaths: params.rootDerivationPaths,\n      phrase: params.phrase,\n      feeBounds: params.feeBounds,\n    })\n    this.explorerProviders = params.explorerProviders\n    this.dataProviders = params.dataProviders\n  }\n\n  /**\n   * Get the explorer url.\n   *\n   * @returns {string} The explorer url based on the network.\n   */\n  getExplorerUrl(): string {\n    return this.explorerProviders[this.network].getExplorerUrl()\n  }\n\n  /**\n   * Get the explorer url for the given address.\n   *\n   * @param {Address} address\n   * @returns {string} The explorer url for the given address based on the network.\n   */\n  getExplorerAddressUrl(address: string): string {\n    return this.explorerProviders[this.network].getExplorerAddressUrl(address)\n  }\n\n  /**\n   * Get the explorer url for the given transaction id.\n   *\n   * @param {string} txID The transaction id\n   * @returns {string} The explorer url for the given transaction id based on the network.\n   */\n  getExplorerTxUrl(txID: string): string {\n    return this.explorerProviders[this.network].getExplorerTxUrl(txID)\n  }\n\n  /**\n   * Get transaction history of a given address with pagination options.\n   * By default it will return the transaction history of the current wallet.\n   *\n   * @param {TxHistoryParams} params The options to get transaction history. (optional)\n   * @returns {TxsPage} The transaction history.\n   */\n  async getTransactions(params?: TxHistoryParams): Promise<TxsPage> {\n    const filteredParams: TxHistoryParams = {\n      address: params?.address || (await this.getAddress()),\n      offset: params?.offset,\n      limit: params?.limit,\n      startTime: params?.startTime,\n      asset: params?.asset,\n    }\n\n    return await this.roundRobinGetTransactions(filteredParams)\n  }\n\n  /**\n   * Get the transaction details of a given transaction id.\n   *\n   * @param {string} txId The transaction id.\n   * @returns {Tx} The transaction details of the given transaction id.\n   */\n  async getTransactionData(txId: string): Promise<Tx> {\n    return await this.roundRobinGetTransactionData(txId)\n  }\n\n  /**\n   * Gets balance of a given address.\n   *\n   * @param {Address} address to get balances from\n   * @param {undefined} Needed for legacy only to be in common with `XChainClient` interface - will be removed by a next version\n   * @param {confirmedOnly} Flag to get balances of confirmed txs only\n   *\n   * @returns {Balance[]} BTC balances\n   */\n  // TODO (@xchain-team|@veado) Change params to be an object to be extendable more easily\n  // see changes for `xchain-bitcoin` https://github.com/xchainjs/xchainjs-lib/pull/490\n  async getBalance(address: Address, _assets?: Asset[] /* not used */, confirmedOnly?: boolean): Promise<Balance[]> {\n    // TODO figure this out ---> !!confirmedOnly)\n    confirmedOnly\n    return await this.roundRobinGetBalance(address)\n  }\n\n  protected async scanUTXOs(\n    address: string,\n    confirmedOnly = true, // default: scan only confirmed UTXOs\n  ): Promise<UTXO[]> {\n    return this.roundRobinGetUnspentTxs(address, confirmedOnly)\n  }\n\n  async getFeesWithRates(options?: FeeEstimateOptions): Promise<FeesWithRates> {\n    const utxos = options?.sender ? await this.scanUTXOs(options.sender, false) : []\n    const compiledMemo = options?.memo ? this.compileMemo(options.memo) : null\n\n    const rates = await this.getFeeRates()\n\n    return {\n      fees: {\n        average: baseAmount(this.getFeeFromUtxos(utxos, rates.average, compiledMemo)),\n        fast: baseAmount(this.getFeeFromUtxos(utxos, rates.fast, compiledMemo)),\n        fastest: baseAmount(this.getFeeFromUtxos(utxos, rates.fastest, compiledMemo)),\n        type: FeeType.PerByte,\n      },\n      rates,\n    }\n  }\n\n  async getFees(options?: FeeEstimateOptions): Promise<Fees> {\n    const { fees } = await this.getFeesWithRates(options)\n    return fees\n  }\n\n  /**\n   * Get fee rates\n   * @param {Protocol} protocol Protocol to interact with. If there's no protocol provided, fee rates are retrieved from chain data providers\n   *\n   * @returns {FeeRates} The fee rates (average, fast, fastest) in `Satoshis/byte`\n   */\n  async getFeeRates(protocol?: Protocol): Promise<FeeRates> {\n    if (!protocol) {\n      try {\n        const feeRates = await this.roundRobinGetFeeRates()\n        return feeRates\n      } catch (error) {\n        console.warn('Can not retrieve fee rates from provider')\n      }\n    }\n\n    if (!protocol || Protocol.THORCHAIN) {\n      try {\n        const feeRate = await this.getFeeRateFromThorchain()\n        return standardFeeRates(feeRate)\n      } catch (error) {\n        console.warn(`Can not retrieve fee rates from Thorchain`)\n      }\n    }\n    // TODO: Return default value\n    throw Error('Can not retrieve fee rates')\n  }\n\n  async broadcastTx(txHex: string): Promise<TxHash> {\n    return await this.roundRobinBroadcastTx(txHex)\n  }\n\n  protected async roundRobinGetBalance(address: Address) {\n    for (const provider of this.dataProviders) {\n      try {\n        const prov = provider[this.network]\n        if (prov) return await prov.getBalance(address, undefined)\n      } catch (error) {\n        console.warn(error)\n      }\n    }\n    throw Error('no provider able to get balance')\n  }\n\n  protected async roundRobinGetUnspentTxs(address: Address, confirmed: boolean) {\n    for (const provider of this.dataProviders) {\n      try {\n        const prov = provider[this.network]\n        if (prov) {\n          return confirmed ? await prov.getConfirmedUnspentTxs(address) : await prov.getUnspentTxs(address)\n        }\n      } catch (error) {\n        console.warn(error)\n      }\n    }\n    throw Error('no provider able to GetUnspentTxs')\n  }\n\n  protected async roundRobinGetTransactionData(txid: string) {\n    for (const provider of this.dataProviders) {\n      try {\n        const prov = provider[this.network]\n        if (prov) return await prov.getTransactionData(txid)\n      } catch (error) {\n        console.warn(error)\n      }\n    }\n    throw Error('no provider able to GetTransactionData')\n  }\n\n  protected async roundRobinGetTransactions(params: TxHistoryParams) {\n    for (const provider of this.dataProviders) {\n      try {\n        const prov = provider[this.network]\n        if (prov) return await prov.getTransactions(params)\n      } catch (error) {\n        console.warn(error)\n      }\n    }\n    throw Error('no provider able to GetTransactions')\n  }\n\n  protected async roundRobinBroadcastTx(txHex: string) {\n    for (const provider of this.dataProviders) {\n      try {\n        const prov = provider[this.network]\n        if (prov) return await prov.broadcastTx(txHex)\n      } catch (error) {\n        console.warn(error)\n      }\n    }\n    throw Error('no provider able to BroadcastTx')\n  }\n\n  protected abstract compileMemo(memo: string): Buffer\n  protected abstract getFeeFromUtxos(inputs: UTXO[], feeRate: FeeRate, data: Buffer | null): number\n  protected async roundRobinGetFeeRates(): Promise<FeeRates> {\n    for (const provider of this.dataProviders) {\n      try {\n        const prov = provider[this.network]\n        if (prov) return await prov.getFeeRates()\n      } catch (error) {\n        console.warn(error)\n      }\n    }\n    throw Error('no provider able to get fee rates')\n  }\n}\n"],"names":["BaseXChainClient","baseAmount","FeeType","Protocol","standardFeeRates"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsBM,MAAgB,MAAO,SAAQA,6BAAgB,CAAA;AAInD;;;;;;AAMG;IACH,WAAY,CAAA,KAAY,EAAE,MAAwB,EAAA;QAChD,KAAK,CAAC,KAAK,EAAE;YACX,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,mBAAmB,EAAE,MAAM,CAAC,mBAAmB;YAC/C,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,SAAS,EAAE,MAAM,CAAC,SAAS;AAC5B,SAAA,CAAC,CAAA;AACF,QAAA,IAAI,CAAC,iBAAiB,GAAG,MAAM,CAAC,iBAAiB,CAAA;AACjD,QAAA,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,aAAa,CAAA;KAC1C;AAED;;;;AAIG;IACH,cAAc,GAAA;QACZ,OAAO,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,cAAc,EAAE,CAAA;KAC7D;AAED;;;;;AAKG;AACH,IAAA,qBAAqB,CAAC,OAAe,EAAA;AACnC,QAAA,OAAO,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAA;KAC3E;AAED;;;;;AAKG;AACH,IAAA,gBAAgB,CAAC,IAAY,EAAA;AAC3B,QAAA,OAAO,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAA;KACnE;AAED;;;;;;AAMG;AACG,IAAA,eAAe,CAAC,MAAwB,EAAA;;AAC5C,YAAA,MAAM,cAAc,GAAoB;AACtC,gBAAA,OAAO,EAAE,CAAA,MAAM,KAAN,IAAA,IAAA,MAAM,uBAAN,MAAM,CAAE,OAAO,MAAK,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;AACrD,gBAAA,MAAM,EAAE,MAAM,KAAA,IAAA,IAAN,MAAM,KAAN,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,MAAM,CAAE,MAAM;AACtB,gBAAA,KAAK,EAAE,MAAM,KAAA,IAAA,IAAN,MAAM,KAAN,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,MAAM,CAAE,KAAK;AACpB,gBAAA,SAAS,EAAE,MAAM,KAAA,IAAA,IAAN,MAAM,KAAN,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,MAAM,CAAE,SAAS;AAC5B,gBAAA,KAAK,EAAE,MAAM,KAAA,IAAA,IAAN,MAAM,KAAN,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,MAAM,CAAE,KAAK;aACrB,CAAA;AAED,YAAA,OAAO,MAAM,IAAI,CAAC,yBAAyB,CAAC,cAAc,CAAC,CAAA;SAC5D,CAAA,CAAA;AAAA,KAAA;AAED;;;;;AAKG;AACG,IAAA,kBAAkB,CAAC,IAAY,EAAA;;AACnC,YAAA,OAAO,MAAM,IAAI,CAAC,4BAA4B,CAAC,IAAI,CAAC,CAAA;SACrD,CAAA,CAAA;AAAA,KAAA;AAED;;;;;;;;AAQG;;;AAGG,IAAA,UAAU,CAAC,OAAgB,EAAE,OAAiB,iBAAiB,aAAuB,EAAA;;AAG1F,YAAA,OAAO,MAAM,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAA;SAChD,CAAA,CAAA;AAAA,KAAA;AAEe,IAAA,SAAS,CACvB,OAAe,EACf,aAAa,GAAG,IAAI,EAAA;;YAEpB,OAAO,IAAI,CAAC,uBAAuB,CAAC,OAAO,EAAE,aAAa,CAAC,CAAA;SAC5D,CAAA,CAAA;AAAA,KAAA;AAEK,IAAA,gBAAgB,CAAC,OAA4B,EAAA;;AACjD,YAAA,MAAM,KAAK,GAAG,CAAA,OAAO,KAAP,IAAA,IAAA,OAAO,KAAP,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,OAAO,CAAE,MAAM,IAAG,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,EAAE,CAAA;YAChF,MAAM,YAAY,GAAG,CAAA,OAAO,KAAA,IAAA,IAAP,OAAO,KAAP,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,OAAO,CAAE,IAAI,IAAG,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;AAE1E,YAAA,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,WAAW,EAAE,CAAA;YAEtC,OAAO;AACL,gBAAA,IAAI,EAAE;AACJ,oBAAA,OAAO,EAAEC,qBAAU,CAAC,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,KAAK,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;AAC7E,oBAAA,IAAI,EAAEA,qBAAU,CAAC,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;AACvE,oBAAA,OAAO,EAAEA,qBAAU,CAAC,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,KAAK,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;oBAC7E,IAAI,EAAEC,oBAAO,CAAC,OAAO;AACtB,iBAAA;gBACD,KAAK;aACN,CAAA;SACF,CAAA,CAAA;AAAA,KAAA;AAEK,IAAA,OAAO,CAAC,OAA4B,EAAA;;YACxC,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAA;AACrD,YAAA,OAAO,IAAI,CAAA;SACZ,CAAA,CAAA;AAAA,KAAA;AAED;;;;;AAKG;AACG,IAAA,WAAW,CAAC,QAAmB,EAAA;;YACnC,IAAI,CAAC,QAAQ,EAAE;gBACb,IAAI;AACF,oBAAA,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,qBAAqB,EAAE,CAAA;AACnD,oBAAA,OAAO,QAAQ,CAAA;AAChB,iBAAA;AAAC,gBAAA,OAAO,KAAK,EAAE;AACd,oBAAA,OAAO,CAAC,IAAI,CAAC,0CAA0C,CAAC,CAAA;AACzD,iBAAA;AACF,aAAA;AAED,YAAA,IAAI,CAAC,QAAQ,IAAIC,qBAAQ,CAAC,SAAS,EAAE;gBACnC,IAAI;AACF,oBAAA,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,uBAAuB,EAAE,CAAA;AACpD,oBAAA,OAAOC,6BAAgB,CAAC,OAAO,CAAC,CAAA;AACjC,iBAAA;AAAC,gBAAA,OAAO,KAAK,EAAE;AACd,oBAAA,OAAO,CAAC,IAAI,CAAC,CAAA,yCAAA,CAA2C,CAAC,CAAA;AAC1D,iBAAA;AACF,aAAA;;AAED,YAAA,MAAM,KAAK,CAAC,4BAA4B,CAAC,CAAA;SAC1C,CAAA,CAAA;AAAA,KAAA;AAEK,IAAA,WAAW,CAAC,KAAa,EAAA;;AAC7B,YAAA,OAAO,MAAM,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAA;SAC/C,CAAA,CAAA;AAAA,KAAA;AAEe,IAAA,oBAAoB,CAAC,OAAgB,EAAA;;AACnD,YAAA,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,aAAa,EAAE;gBACzC,IAAI;oBACF,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;AACnC,oBAAA,IAAI,IAAI;wBAAE,OAAO,MAAM,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;AAC3D,iBAAA;AAAC,gBAAA,OAAO,KAAK,EAAE;AACd,oBAAA,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;AACpB,iBAAA;AACF,aAAA;AACD,YAAA,MAAM,KAAK,CAAC,iCAAiC,CAAC,CAAA;SAC/C,CAAA,CAAA;AAAA,KAAA;IAEe,uBAAuB,CAAC,OAAgB,EAAE,SAAkB,EAAA;;AAC1E,YAAA,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,aAAa,EAAE;gBACzC,IAAI;oBACF,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;AACnC,oBAAA,IAAI,IAAI,EAAE;wBACR,OAAO,SAAS,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAA;AAClG,qBAAA;AACF,iBAAA;AAAC,gBAAA,OAAO,KAAK,EAAE;AACd,oBAAA,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;AACpB,iBAAA;AACF,aAAA;AACD,YAAA,MAAM,KAAK,CAAC,mCAAmC,CAAC,CAAA;SACjD,CAAA,CAAA;AAAA,KAAA;AAEe,IAAA,4BAA4B,CAAC,IAAY,EAAA;;AACvD,YAAA,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,aAAa,EAAE;gBACzC,IAAI;oBACF,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;AACnC,oBAAA,IAAI,IAAI;AAAE,wBAAA,OAAO,MAAM,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAA;AACrD,iBAAA;AAAC,gBAAA,OAAO,KAAK,EAAE;AACd,oBAAA,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;AACpB,iBAAA;AACF,aAAA;AACD,YAAA,MAAM,KAAK,CAAC,wCAAwC,CAAC,CAAA;SACtD,CAAA,CAAA;AAAA,KAAA;AAEe,IAAA,yBAAyB,CAAC,MAAuB,EAAA;;AAC/D,YAAA,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,aAAa,EAAE;gBACzC,IAAI;oBACF,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;AACnC,oBAAA,IAAI,IAAI;AAAE,wBAAA,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAA;AACpD,iBAAA;AAAC,gBAAA,OAAO,KAAK,EAAE;AACd,oBAAA,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;AACpB,iBAAA;AACF,aAAA;AACD,YAAA,MAAM,KAAK,CAAC,qCAAqC,CAAC,CAAA;SACnD,CAAA,CAAA;AAAA,KAAA;AAEe,IAAA,qBAAqB,CAAC,KAAa,EAAA;;AACjD,YAAA,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,aAAa,EAAE;gBACzC,IAAI;oBACF,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;AACnC,oBAAA,IAAI,IAAI;AAAE,wBAAA,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAA;AAC/C,iBAAA;AAAC,gBAAA,OAAO,KAAK,EAAE;AACd,oBAAA,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;AACpB,iBAAA;AACF,aAAA;AACD,YAAA,MAAM,KAAK,CAAC,iCAAiC,CAAC,CAAA;SAC/C,CAAA,CAAA;AAAA,KAAA;IAIe,qBAAqB,GAAA;;AACnC,YAAA,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,aAAa,EAAE;gBACzC,IAAI;oBACF,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;AACnC,oBAAA,IAAI,IAAI;AAAE,wBAAA,OAAO,MAAM,IAAI,CAAC,WAAW,EAAE,CAAA;AAC1C,iBAAA;AAAC,gBAAA,OAAO,KAAK,EAAE;AACd,oBAAA,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;AACpB,iBAAA;AACF,aAAA;AACD,YAAA,MAAM,KAAK,CAAC,mCAAmC,CAAC,CAAA;SACjD,CAAA,CAAA;AAAA,KAAA;AACF;;;;"}

package/lib/types/index.d.ts

@@ -0,0 +1,2 @@
+import { PreparedTx, UTXO, UtxoClientParams, Witness } from './types';
+export { UTXO, UtxoClientParams, Witness, PreparedTx };

package/lib/types/types.d.ts

@@ -0,0 +1,10 @@
+import { ExplorerProviders, PreparedTx as BasePreparedTx, XChainClientParams } from '@xchainjs/xchain-client';
+import { UTXO, UtxoOnlineDataProviders, Witness } from '@xchainjs/xchain-utxo-providers';
+export type UtxoClientParams = XChainClientParams & {
+    explorerProviders: ExplorerProviders;
+    dataProviders: UtxoOnlineDataProviders[];
+};
+export type PreparedTx = BasePreparedTx & {
+    utxos: UTXO[];
+};
+export { UTXO, Witness };

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@xchainjs/xchain-utxo",
+  "version": "0.1.1",
+  "description": "Genereic UTXO client for XChainJS",
+  "keywords": [
+    "XChain",
+    "UTXO"
+  ],
+  "author": "XChainJS",
+  "homepage": "https://github.com/xchainjs/xchainjs-lib",
+  "license": "MIT",
+  "main": "lib/index.js",
+  "module": "lib/index.esm.js",
+  "typings": "lib/index.d.ts",
+  "directories": {
+    "lib": "lib",
+    "test": "__tests__"
+  },
+  "files": [
+    "lib"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:xchainjs/xchainjs-lib.git"
+  },
+  "scripts": {
+    "clean": "rimraf lib/**",
+    "build": "yarn clean && rollup -c",
+    "lint": "eslint \"{src,__tests__, __mocks__}/**/*.ts\" --fix --max-warnings 0",
+    "prepublishOnly": "yarn build"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@xchainjs/xchain-client": "^0.16.0",
+    "@xchainjs/xchain-crypto": "^0.3.0",
+    "@xchainjs/xchain-util": "^0.13.1",
+    "@xchainjs/xchain-utxo-providers": "^0.2.10",
+    "axios": "^1.3.6"
+  },
+  "peerDependencies": {
+    "@xchainjs/xchain-client": "^0.16.0",
+    "@xchainjs/xchain-crypto": "^0.3.0",
+    "@xchainjs/xchain-util": "^0.13.1",
+    "@xchainjs/xchain-utxo-providers": "^0.2.10",
+    "axios": "^1.3.6"
+  }
+}