@xchainjs/xchain-bitcoin 0.23.4 → 0.23.7

package/README.md

@@ -99,20 +99,20 @@ import { SochainNetwork,  SochainProvider } from '@xchainjs/xchain-utxo-provider
 import { Network, UtxoClientParams } from '@xchainjs/xchain-client'
 
 // override with your API key
-SochainDataProviders[Network.Mainnet].apiKey = 'YOU_SOCHAIN_API_KEY'
+SochainDataProviders[Network.Mainnet].apiKey = 'YOUR_SOCHAIN_API_KEY'
 
 // or set in env variables so default config can access.
-`SOCHAIN_API_KEY={YOURKEY}`
-`BLOCKCYPHER_API_KEY={YOURKEY}`
+`SOCHAIN_API_KEY={YOUR_SOCHAIN_API_KEY}`
+`BLOCKCYPHER_API_KEY={YOUR_BLOCKCYPHER_API_KEY}`
 //Default config can access.
-process.env["BLOCKCYPHER_API_KEY"]
-process.env["SOCHAIN_API_KEY"]
+process.env.BLOCKCYPHER_API_KEY
+process.env.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,
+  phrase: process.env.PHRASE,
 }
 const btcClient = new Client(sochainParams)
 

package/lib/client.d.ts

@@ -1,12 +1,12 @@
 /// <reference types="node" />
-import { AssetInfo, FeeRate, PreparedTx, TxHash, TxParams, UTXO, UTXOClient, UtxoClientParams } from '@xchainjs/xchain-client';
+import { AssetInfo, FeeRate, PreparedTx, TxParams, UTXO, UTXOClient, UtxoClientParams } from '@xchainjs/xchain-client';
 import { Address } from '@xchainjs/xchain-util';
 import * as Bitcoin from 'bitcoinjs-lib';
 export declare const defaultBTCParams: UtxoClientParams;
 /**
  * Custom Bitcoin client
  */
-declare class Client extends UTXOClient {
+declare abstract class Client extends UTXOClient {
     /**
      * Constructor
      * Client is initialised with network type
@@ -14,39 +14,11 @@ declare class Client extends UTXOClient {
      * @param {UtxoClientParams} params
      */
     constructor(params?: UtxoClientParams);
-    /**
-     * @deprecated this function eventually will be removed use getAddressAsync instead
-     */
-    getAddress(index?: number): Address;
-    /**
-     * Get the current address.
-     *
-     * Generates a network-specific key-pair by first converting the buffer to a Wallet-Import-Format (WIF)
-     * The address is then decoded into type P2WPKH and returned.
-     *
-     * @returns {Address} The current address.
-     *
-     * @throws {"Phrase must be provided"} Thrown if phrase has not been set before.
-     * @throws {"Address not defined"} Thrown if failed creating account from phrase.
-     */
-    getAddressAsync(index?: number): Promise<string>;
     /**
      *
      * @returns BTC asset info
      */
     getAssetInfo(): AssetInfo;
-    /**
-     * @private
-     * Get private key.
-     *
-     * Private function to get keyPair from the this.phrase
-     *
-     * @param {string} phrase The phrase to be used for generating privkey
-     * @returns {ECPairInterface} The privkey generated from the given phrase
-     *
-     * @throws {"Could not get private key from phrase"} Throws an error if failed creating BTC keys from the given phrase
-     * */
-    private getBtcKeys;
     /**
      * Validate the given address.
      *
@@ -54,7 +26,6 @@ declare class Client extends UTXOClient {
      * @returns {boolean} `true` or `false`
      */
     validateAddress(address: string): boolean;
-    protected getSuggestedFeeRate(): Promise<FeeRate>;
     /**
      * Compile memo.
      *
@@ -71,17 +42,6 @@ declare class Client extends UTXOClient {
      * @returns {number} The fee amount.
      */
     protected getFeeFromUtxos(inputs: UTXO[], feeRate: FeeRate, data?: Buffer | null): number;
-    /**
-     * Transfer BTC.
-     *
-     * @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>;
     /**
      *
      * @param param0

package/lib/clientKeystore.d.ts

@@ -0,0 +1,48 @@
+import { FeeRate, TxHash, TxParams } from '@xchainjs/xchain-client';
+import { Address } from '@xchainjs/xchain-util';
+import { Client } from './client';
+/**
+ * Custom Bitcoin client
+ */
+declare class ClientKeystore extends Client {
+    /**
+     * @deprecated this function eventually will be removed use getAddressAsync instead
+     */
+    getAddress(index?: number): Address;
+    /**
+     * Get the current address.
+     *
+     * Generates a network-specific key-pair by first converting the buffer to a Wallet-Import-Format (WIF)
+     * The address is then decoded into type P2WPKH and returned.
+     *
+     * @returns {Address} The current address.
+     *
+     * @throws {"Phrase must be provided"} Thrown if phrase has not been set before.
+     * @throws {"Address not defined"} Thrown if failed creating account from phrase.
+     */
+    getAddressAsync(index?: number): Promise<string>;
+    /**
+     * @private
+     * Get private key.
+     *
+     * Private function to get keyPair from the this.phrase
+     *
+     * @param {string} phrase The phrase to be used for generating privkey
+     * @returns {ECPairInterface} The privkey generated from the given phrase
+     *
+     * @throws {"Could not get private key from phrase"} Throws an error if failed creating BTC keys from the given phrase
+     * */
+    private getBtcKeys;
+    /**
+     * Transfer BTC.
+     *
+     * @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>;
+}
+export { ClientKeystore };

package/lib/clientLedger.d.ts

@@ -0,0 +1,21 @@
+import AppBtc from '@ledgerhq/hw-app-btc';
+import { FeeRate, TxHash, TxParams, UtxoClientParams } from '@xchainjs/xchain-client';
+import { Address } from '@xchainjs/xchain-util';
+import { Client } from './client';
+/**
+ * Custom Ledger Bitcoin client
+ */
+declare class ClientLedger extends Client {
+    private transport;
+    private app;
+    constructor(params: UtxoClientParams & {
+        transport: any;
+    });
+    getApp(): Promise<AppBtc>;
+    getAddress(): string;
+    getAddressAsync(index?: number): Promise<Address>;
+    transfer(params: TxParams & {
+        feeRate?: FeeRate;
+    }): Promise<TxHash>;
+}
+export { ClientLedger };

package/lib/const.d.ts

@@ -8,7 +8,7 @@ import { Asset } from '@xchainjs/xchain-util';
 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;
+export declare const UPPER_FEE_BOUND = 1000;
 export declare const BTC_SYMBOL = "\u20BF";
 export declare const BTC_SATOSHI_SYMBOL = "\u26A1";
 /**
@@ -31,3 +31,4 @@ export declare const blockstreamExplorerProviders: {
 export declare const SochainDataProviders: UtxoOnlineDataProviders;
 export declare const HaskoinDataProviders: UtxoOnlineDataProviders;
 export declare const BlockcypherDataProviders: UtxoOnlineDataProviders;
+export declare const BitgoProviders: UtxoOnlineDataProviders;

package/lib/index.d.ts

@@ -1,4 +1,6 @@
 export * from './types';
-export * from './client';
+export { ClientKeystore as Client } from './clientKeystore';
+export { ClientLedger } from './clientLedger';
+export { defaultBTCParams } from './client';
 export * from './const';
 export { getPrefix, validateAddress } from './utils';