@xchainjs/xchain-bitcoin 0.18.0 → 0.18.4

package/README.md

@@ -1,4 +1,4 @@
-# `@xchainjs/xchain-client`
+# `@xchainjs/xchain-bitcoin`
 
 ## Modules
 
@@ -16,6 +16,13 @@ Following peer dependencies have to be installed into your project. These are no
 yarn add @xchainjs/xchain-client @xchainjs/xchain-crypto @xchainjs/xchain-util axios bitcoinjs-lib wif
 ```
 
+## Documentation
+
+### [`xchain bitcoin`](http://docs.xchainjs.org/xchain-client/xchain-bitcoin/)
+[`How xchain-bitcoin works`](http://docs.xchainjs.org/xchain-client/xchain-bitcoin/how-it-works.html)\
+[`How to use xchain-bitcoin`](http://docs.xchainjs.org/xchain-client/xchain-bitcoin/how-to-use.html)
+
+
 ## Service Providers
 
 This package uses the following service providers:
@@ -33,46 +40,7 @@ Sochain API rate limits: https://sochain.com/api#rate-limits (300 requests/minut
 
 Bitgo API rate limits: https://app.bitgo.com/docs/#section/Rate-Limiting (10 requests/second)
 
-## Usage
-
-Initialize client and use class methods:
-
-```
-
-import { Client, Network } from '../src/client'
-
-// Create a new client interface
-const btcClient = new Client({ network: Network.Mainnet, nodeUrl: 'https://sochain.com/api/v2' })
-
-// Set phrase
-btcClient.setPhrase('phrase here')
-
-// Get address
-const address = btcClient.getAddress()
 
-// Get balance
-const balance = await btcClient.getBalance()
 
-// Transfer with feeRate
-const txid = await btcClient.transfer({ asset: AssetBTC, recipient: 'recipient address here', amount: baseAmount(100, BTC_DECIMAL), feeRate: 1 })
 
-// Transfer with default feeRate (default is `fast`)
-const txid = await btcClient.transfer({ asset: AssetBTC, recipient: 'recipient address here', amount: baseAmount(100, BTC_DECIMAL) })
 
-// Get fee estimations
-const { fast, fastest, average } = await btcClient.getFees()
-
-// Get feeRate estimations
-const { fast, fastest, average } = await btcClient.getFeeRates()
-
-// Search transactions
-const transactions = await btcClient.getTransactions({ address: 'address here', limit: 4 })
-
-// Get a transaction with a given txId/hash
-const txData = await btcClient.getTransactionData('b660ee07167cfa32681e2623f3a29dc64a089cabd9a3a07dd17f9028ac956eb8')
-
-```
-
-```
-
-```

package/lib/client.d.ts

@@ -1,4 +1,4 @@
-import { Address, Balance, Fee, FeeRate, Tx, TxHash, TxHistoryParams, TxParams, TxsPage, UTXOClient, XChainClientParams } from '@xchainjs/xchain-client';
+import { Address, Balance, DepositParams, Fee, FeeRate, Tx, TxHash, TxHistoryParams, TxParams, TxsPage, UTXOClient, XChainClientParams } from '@xchainjs/xchain-client';
 import { Asset } from '@xchainjs/xchain-util';
 import { ClientUrl } from './types/client-types';
 export declare type BitcoinClientParams = XChainClientParams & {
@@ -17,7 +17,7 @@ declare class Client extends UTXOClient {
      *
      * @param {BitcoinClientParams} params
      */
-    constructor({ network, sochainUrl, haskoinUrl, rootDerivationPaths, phrase, }: BitcoinClientParams);
+    constructor({ network, feeBounds, sochainUrl, haskoinUrl, rootDerivationPaths, phrase, }: BitcoinClientParams);
     /**
      * Set/Update the sochain url.
      *
@@ -108,9 +108,22 @@ declare class Client extends UTXOClient {
      *
      * @param {TxParams&FeeRate} params The transfer options.
      * @returns {TxHash} The transaction hash.
+     *
+     * @throws {"memo too long"} Thrown if memo longer than  80 chars.
      */
     transfer(params: TxParams & {
         feeRate?: FeeRate;
     }): Promise<TxHash>;
+    /**
+     * Transaction to THORChain inbound address.
+     *
+     * @param {DepositParams} params The transaction options.
+     * @returns {TxHash} The transaction hash.
+     *
+     * @throws {"halted chain"} Thrown if chain is halted.
+     * @throws {"halted trading"} Thrown if trading is halted.
+     * @throws {"memo too long"} Thrown if memo longer than  80 chars.
+     */
+    deposit({ walletIndex, asset, amount, memo }: DepositParams): Promise<TxHash>;
 }
 export { Client };

package/lib/const.d.ts

@@ -5,3 +5,5 @@
  */
 export declare const MIN_TX_FEE = 1000;
 export declare const BTC_DECIMAL = 8;
+export declare const LOWER_FEE_BOUND = 1;
+export declare const UPPER_FEE_BOUND = 500;