@xchainjs/xchain-bitcoin 0.20.8 → 0.21.0

package/README.md

@@ -60,3 +60,53 @@ register9Rheader(cosmosclient.config.globalAxios)
 ```
 
 For a complete example please see this [test](https://github.com/xchainjs/xchainjs-lib/blob/master/packages/xchain-thorchain-amm/__e2e__/wallet.e2e.ts)
+
+### UtxoOnlineDataProviders
+
+## default providers
+
+Creating a no-arg BTC Client will default to the following settings:
+
+```typescript
+const defaultBTCParams: UtxoClientParams = {
+  network: Network.Mainnet,
+  phrase: '',
+  explorerProviders: blockstreamExplorerProviders,
+  dataProviders: [BlockcypherDataProviders],
+  rootDerivationPaths: {
+    [Network.Mainnet]: `84'/0'/0'/0/`,
+    [Network.Testnet]: `84'/1'/0'/0/`,
+    [Network.Stagenet]: `84'/0'/0'/0/`,
+  },
+  feeBounds: {
+    lower: LOWER_FEE_BOUND,
+    upper: UPPER_FEE_BOUND,
+  },
+}
+```
+
+Note: BlockCypher is the default online data provider (to fetch realtime utxos, balances, etc)
+
+## Overriding providers
+
+You can specify own array of providers, whoch will be executed in array-order, to provide automated failover to the subsequent providers if calls to the first providers fail
+
+### example sochain v3, blockcypher backup
+
+```typescript
+import { Client, defaultBTCParams, AssetBTC, SochainDataProviders, BlockcypherDataProviders } from '@xchainjs/xchain-bitcoin'
+import { SochainNetwork,  SochainProvider } from '@xchainjs/xchain-utxo-providers'
+import { Network, UtxoClientParams } from '@xchainjs/xchain-client'
+
+// override with your API key
+SochainDataProviders[Network.Mainnet].apiKey = 'YOU_SOCHAIN_API_KEY'
+
+//overridde the default init params with your onfig
+const initParams: UtxoClientParams = {
+  ...defaultBTCParams,
+  dataProviders: [SochainDataProviders, BlockcypherDataProviders]// use sochain first and blockcypher as fallback
+  phrase: process.env.YOURPHRASE,
+}
+const btcClient = new Client(sochainParams)
+
+```

package/lib/client.d.ts

@@ -1,50 +1,17 @@
-import { Balance, Fee, FeeRate, Tx, TxHash, TxHistoryParams, TxParams, TxsPage, UTXOClient, XChainClientParams } from '@xchainjs/xchain-client';
-import { Address, Asset } from '@xchainjs/xchain-util';
-import { ClientUrl } from './types/client-types';
-export declare type BitcoinClientParams = XChainClientParams & {
-    sochainUrl?: string;
-    haskoinUrl?: ClientUrl;
-};
+import { Fee, FeeRate, TxHash, TxParams, UTXOClient, UtxoClientParams } from '@xchainjs/xchain-client';
+import { Address } from '@xchainjs/xchain-util';
+export declare const defaultBTCParams: UtxoClientParams;
 /**
  * Custom Bitcoin client
  */
 declare class Client extends UTXOClient {
-    private sochainUrl;
-    private haskoinUrl;
     /**
      * Constructor
      * Client is initialised with network type
      *
-     * @param {BitcoinClientParams} params
+     * @param {UtxoClientParams} params
      */
-    constructor({ network, feeBounds, sochainUrl, haskoinUrl, rootDerivationPaths, phrase, }: BitcoinClientParams);
-    /**
-     * Set/Update the sochain url.
-     *
-     * @param {string} url The new sochain url.
-     * @returns {void}
-     */
-    setSochainUrl(url: string): void;
-    /**
-     * 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;
+    constructor(params?: UtxoClientParams);
     /**
      * Get the current address.
      *
@@ -76,31 +43,6 @@ declare class Client extends UTXOClient {
      * @returns {boolean} `true` or `false`
      */
     validateAddress(address: string): boolean;
-    /**
-     * Gets BTC balances of a given address.
-     *
-     * @param {Address} BTC 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[]>;
-    /**
-     * 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>;
     protected getSuggestedFeeRate(): Promise<FeeRate>;
     protected calcFee(feeRate: FeeRate, memo?: string): Promise<Fee>;
     /**
@@ -114,5 +56,6 @@ declare class Client extends UTXOClient {
     transfer(params: TxParams & {
         feeRate?: FeeRate;
     }): Promise<TxHash>;
+    private buildTx;
 }
 export { Client };

package/lib/const.d.ts

@@ -1,3 +1,4 @@
+import { ExplorerProvider, UtxoOnlineDataProviders } from '@xchainjs/xchain-client';
 import { Asset } from '@xchainjs/xchain-util';
 /**
  * Minimum transaction fee
@@ -22,3 +23,11 @@ export declare const BTCChain: "BTC";
  * @see https://gitlab.com/thorchain/thornode/-/blob/master/common/asset.go#L12-24
  */
 export declare const AssetBTC: Asset;
+export declare const blockstreamExplorerProviders: {
+    testnet: ExplorerProvider;
+    stagenet: ExplorerProvider;
+    mainnet: ExplorerProvider;
+};
+export declare const SochainDataProviders: UtxoOnlineDataProviders;
+export declare const HaskoinDataProviders: UtxoOnlineDataProviders;
+export declare const BlockcypherDataProviders: UtxoOnlineDataProviders;

package/lib/index.d.ts

@@ -1,4 +1,4 @@
 export * from './types';
 export * from './client';
 export * from './const';
-export { broadcastTx, getDefaultFees, getDefaultFeesWithRates, getPrefix, scanUTXOs, buildTx, validateAddress, calcFee, getBalance, } from './utils';
+export { getDefaultFees, getDefaultFeesWithRates, getPrefix, validateAddress, calcFee } from './utils';