@xchainjs/xchain-bitcoin 0.21.3 → 0.22.0

package/lib/client.d.ts

@@ -1,71 +1,71 @@
-import { Fee, FeeRate, TxHash, 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 {
-    /**
-     * Constructor
-     * Client is initialised with network type
-     *
-     * @param {UtxoClientParams} params
-     */
-    constructor(params?: UtxoClientParams);
-    /**
-     * 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.
-     */
-    getAddress(index?: number): Address;
-    /**
-     * @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.
-     *
-     * @param {Address} address
-     * @returns {boolean} `true` or `false`
-     */
-    validateAddress(address: string): boolean;
-    protected getSuggestedFeeRate(): Promise<FeeRate>;
-    protected calcFee(feeRate: FeeRate, memo?: string): Promise<Fee>;
-    /**
-     * 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>;
-    buildTx({ amount, recipient, memo, feeRate, sender, spendPendingUTXO, }: TxParams & {
-        feeRate: FeeRate;
-        sender: Address;
-        spendPendingUTXO?: boolean;
-        withTxHex?: boolean;
-    }): Promise<{
-        psbt: Bitcoin.Psbt;
-        utxos: UTXO[];
-        inputs: UTXO[];
-    }>;
-}
-export { Client };
+import { Fee, FeeRate, TxHash, 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 {
+    /**
+     * Constructor
+     * Client is initialised with network type
+     *
+     * @param {UtxoClientParams} params
+     */
+    constructor(params?: UtxoClientParams);
+    /**
+     * 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.
+     */
+    getAddress(index?: number): Address;
+    /**
+     * @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.
+     *
+     * @param {Address} address
+     * @returns {boolean} `true` or `false`
+     */
+    validateAddress(address: string): boolean;
+    protected getSuggestedFeeRate(): Promise<FeeRate>;
+    protected calcFee(feeRate: FeeRate, memo?: string): Promise<Fee>;
+    /**
+     * 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>;
+    buildTx({ amount, recipient, memo, feeRate, sender, spendPendingUTXO, }: TxParams & {
+        feeRate: FeeRate;
+        sender: Address;
+        spendPendingUTXO?: boolean;
+        withTxHex?: boolean;
+    }): Promise<{
+        psbt: Bitcoin.Psbt;
+        utxos: UTXO[];
+        inputs: UTXO[];
+    }>;
+}
+export { Client };

package/lib/const.d.ts

@@ -1,33 +1,33 @@
-import { ExplorerProvider, UtxoOnlineDataProviders } from '@xchainjs/xchain-client';
-import { Asset } from '@xchainjs/xchain-util';
-/**
- * Minimum transaction fee
- * 1000 satoshi/kB (similar to current `minrelaytxfee`)
- * @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;
-export declare const LOWER_FEE_BOUND = 1;
-export declare const UPPER_FEE_BOUND = 500;
-export declare const BTC_SYMBOL = "\u20BF";
-export declare const BTC_SATOSHI_SYMBOL = "\u26A1";
-/**
- * Chain identifier for Bitcoin mainnet
- *
- */
-export declare const BTCChain: "BTC";
-/**
- * Base "chain" asset on bitcoin main net.
- *
- * Based on definition in Thorchain `common`
- * @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;
+import { ExplorerProvider, UtxoOnlineDataProviders } from '@xchainjs/xchain-client';
+import { Asset } from '@xchainjs/xchain-util';
+/**
+ * Minimum transaction fee
+ * 1000 satoshi/kB (similar to current `minrelaytxfee`)
+ * @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;
+export declare const LOWER_FEE_BOUND = 1;
+export declare const UPPER_FEE_BOUND = 500;
+export declare const BTC_SYMBOL = "\u20BF";
+export declare const BTC_SATOSHI_SYMBOL = "\u26A1";
+/**
+ * Chain identifier for Bitcoin mainnet
+ *
+ */
+export declare const BTCChain: "BTC";
+/**
+ * Base "chain" asset on bitcoin main net.
+ *
+ * Based on definition in Thorchain `common`
+ * @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 { getDefaultFees, getDefaultFeesWithRates, getPrefix, validateAddress, calcFee } from './utils';
+export * from './types';
+export * from './client';
+export * from './const';
+export { getDefaultFees, getDefaultFeesWithRates, getPrefix, validateAddress, calcFee } from './utils';