@xchainjs/xchain-bitcoin 0.15.10 → 0.16.0

package/CHANGELOG.md

@@ -1,3 +1,21 @@
+# v.0.16.0 (2021-12-29)
+
+## Breaking change
+
+- Add stagenet environment handling for `Network` and `BaseXChainClient` changes client to default to mainnet values until stagenet is configured.
+
+# v.0.15.13 (2021-11-12)
+
+- updated haskoin api URL
+
+# v.0.15.12 (2021-09-03)
+
+- updated to the latest dependencies
+
+# v.0.15.11 (2021-07-07)
+
+- Use latest `xchain-client@0.10.1` + `xchain-util@0.3.0`
+
 # v.0.15.10 (2021-07-03)
 
 - refactored client methods to use regular method syntax (not fat arrow) in order for bcall to super.xxx() to work properly

package/README.md

@@ -42,7 +42,7 @@ Initialize client and use class methods:
 import { Client, Network } from '../src/client'
 
 // Create a new client interface
-const btcClient = new Client({ network: 'mainnet', nodeUrl: 'https://sochain.com/api/v2' })
+const btcClient = new Client({ network: Network.Mainnet, nodeUrl: 'https://sochain.com/api/v2' })
 
 // Set phrase
 btcClient.setPhrase('phrase here')

package/lib/client.d.ts

@@ -1,12 +1,4 @@
-import { BaseXChainClient, TxHistoryParams, TxsPage, Address, XChainClient, Tx, TxParams, TxHash, Balance, Network, Fees, XChainClientParams, FeeRates, FeeRate, FeesWithRates } from '@xchainjs/xchain-client';
-/**
- * BitcoinClient Interface
- */
-interface BitcoinClient {
-    getFeesWithRates(memo?: string): Promise<FeesWithRates>;
-    getFeesWithMemo(memo: string): Promise<Fees>;
-    getFeeRates(): Promise<FeeRates>;
-}
+import { Address, Balance, Fee, FeeRate, Tx, TxHash, TxHistoryParams, TxParams, TxsPage, UTXOClient, XChainClientParams } from '@xchainjs/xchain-client';
 export declare type BitcoinClientParams = XChainClientParams & {
     sochainUrl?: string;
     blockstreamUrl?: string;
@@ -14,7 +6,7 @@ export declare type BitcoinClientParams = XChainClientParams & {
 /**
  * Custom Bitcoin client
  */
-declare class Client extends BaseXChainClient implements BitcoinClient, XChainClient {
+declare class Client extends UTXOClient {
     private sochainUrl;
     private blockstreamUrl;
     /**
@@ -93,7 +85,7 @@ declare class Client extends BaseXChainClient implements BitcoinClient, XChainCl
      * Get the BTC balance of a given address.
      *
      * @param {Address} the BTC address
-     * @returns {Array<Balance>} The BTC balance of the address.
+     * @returns {Balance[]} The BTC balance of the address.
      */
     getBalance(address: Address): Promise<Balance[]>;
     /**
@@ -111,34 +103,8 @@ declare class Client extends BaseXChainClient implements BitcoinClient, XChainCl
      * @returns {Tx} The transaction details of the given transaction id.
      */
     getTransactionData(txId: string): Promise<Tx>;
-    /**
-     * Get the rates and fees.
-     *
-     * @param {string} memo The memo to be used for fee calculation (optional)
-     * @returns {FeesWithRates} The fees and rates
-     */
-    getFeesWithRates(memo?: string): Promise<FeesWithRates>;
-    /**
-     * Get the current fees.
-     *
-     * @returns {Fees} The fees without memo
-     */
-    getFees(): Promise<Fees>;
-    /**
-     * Get the fees for transactions with memo.
-     * If you want to get `Fees` and `FeeRates` at once, use `getFeesAndRates` method
-     *
-     * @param {string} memo
-     * @returns {Fees} The fees with memo
-     */
-    getFeesWithMemo(memo: string): Promise<Fees>;
-    /**
-     * Get the fee rates for transactions without a memo.
-     * If you want to get `Fees` and `FeeRates` at once, use `getFeesAndRates` method
-     *
-     * @returns {FeeRates} The fee rate
-     */
-    getFeeRates(): Promise<FeeRates>;
+    protected getSuggestedFeeRate(): Promise<FeeRate>;
+    protected calcFee(feeRate: FeeRate, memo?: string): Promise<Fee>;
     /**
      * Transfer BTC.
      *
@@ -149,4 +115,4 @@ declare class Client extends BaseXChainClient implements BitcoinClient, XChainCl
         feeRate?: FeeRate;
     }): Promise<TxHash>;
 }
-export { Client, Network };
+export { Client };

package/lib/const.d.ts

@@ -4,3 +4,4 @@
  * @see https://github.com/bitcoin/bitcoin/blob/db88db47278d2e7208c50d16ab10cb355067d071/src/validation.h#L56
  */
 export declare const MIN_TX_FEE = 1000;
+export declare const BTC_DECIMAL = 8;

package/lib/haskoin-api.d.ts

@@ -1,5 +1,5 @@
-import { Address } from '@xchainjs/xchain-client/lib';
-import { BaseAmount } from '@xchainjs/xchain-util/lib';
+import { Address } from '@xchainjs/xchain-client';
+import { BaseAmount } from '@xchainjs/xchain-util';
 export declare type UtxoData = {
     txid: string;
     index: number;

package/lib/index.d.ts

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