@xchainjs/xchain-bitcoin 0.18.2 → 0.18.4

package/lib/client.d.ts

@@ -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,6 +108,8 @@ 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;
@@ -120,6 +122,7 @@ declare class Client extends UTXOClient {
      *
      * @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>;
 }

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;

package/lib/index.esm.js

@@ -1,4 +1,4 @@
-import { Network, standardFeeRates, FeeOption, calcFees, UTXOClient, TxType } from '@xchainjs/xchain-client';
+import { Network, standardFeeRates, FeeOption, calcFees, UTXOClient, TxType, checkFeeBounds } from '@xchainjs/xchain-client';
 import buffer from 'buffer';
 import events from 'events';
 import stream from 'stream';
@@ -85152,7 +85152,9 @@ var src_12 = src$3.TransactionBuilder;
  * @see https://github.com/bitcoin/bitcoin/blob/db88db47278d2e7208c50d16ab10cb355067d071/src/validation.h#L56
  */
 const MIN_TX_FEE = 1000;
-const BTC_DECIMAL = 8;
+const BTC_DECIMAL = 8;
+const LOWER_FEE_BOUND = 1;
+const UPPER_FEE_BOUND = 500;
 
 const DEFAULT_SUGGESTED_TRANSACTION_FEE = 127;
 const toSochainNetwork = (network) => {
@@ -85710,8 +85712,11 @@ withTxHex = false, }) => __awaiter(void 0, void 0, void 0, function* () {
     // search only confirmed UTXOs if pending UTXO is not allowed
     const confirmedOnly = !spendPendingUTXO;
     const utxos = yield scanUTXOs({ sochainUrl, haskoinUrl, network, address: sender, confirmedOnly, withTxHex });
+    if (memo && memo.length > 80) {
+        throw new Error('memo too long, must not be longer than 80 chars.');
+    }
     if (utxos.length === 0)
-        throw new Error('No utxos to send');
+        throw new Error('No confirmed UTXOs. Please wait until your balance has been confirmed on-chain.');
     if (!validateAddress(recipient, network))
         throw new Error('Invalid address');
     const feeRateWhole = Math.ceil(feeRate);
@@ -85825,7 +85830,10 @@ class Client extends UTXOClient {
      *
      * @param {BitcoinClientParams} params
      */
-    constructor({ network = Network.Testnet, sochainUrl = 'https://sochain.com/api/v2', haskoinUrl = {
+    constructor({ network = Network.Testnet, feeBounds = {
+        lower: LOWER_FEE_BOUND,
+        upper: UPPER_FEE_BOUND,
+    }, sochainUrl = 'https://sochain.com/api/v2', haskoinUrl = {
         [Network.Testnet]: 'https://api.haskoin.com/btctest',
         [Network.Mainnet]: 'https://api.haskoin.com/btc',
         [Network.Stagenet]: 'https://api.haskoin.com/btc',
@@ -85834,7 +85842,7 @@ class Client extends UTXOClient {
         [Network.Testnet]: `84'/1'/0'/0/`,
         [Network.Stagenet]: `84'/0'/0'/0/`,
     }, phrase = '', }) {
-        super(Chain.Bitcoin, { network, rootDerivationPaths, phrase });
+        super(Chain.Bitcoin, { network, rootDerivationPaths, phrase, feeBounds });
         this.sochainUrl = '';
         this.setSochainUrl(sochainUrl);
         this.haskoinUrl = haskoinUrl;
@@ -86052,12 +86060,15 @@ 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) {
         return __awaiter(this, void 0, void 0, function* () {
             const fromAddressIndex = (params === null || params === void 0 ? void 0 : params.walletIndex) || 0;
             // set the default fee rate to `fast`
             const feeRate = params.feeRate || (yield this.getFeeRates())[FeeOption.Fast];
+            checkFeeBounds(this.feeBounds, feeRate);
             /**
              * do not spend pending UTXOs when adding a memo
              * https://github.com/xchainjs/xchainjs-lib/issues/330
@@ -86080,6 +86091,7 @@ class Client extends UTXOClient {
      *
      * @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 = 0, asset = AssetBTC, amount, memo }) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -86102,5 +86114,5 @@ class Client extends UTXOClient {
     }
 }
 
-export { BTC_DECIMAL, Client, MIN_TX_FEE, broadcastTx$1 as broadcastTx, buildTx, calcFee, getBalance$2 as getBalance, getDefaultFees, getDefaultFeesWithRates, getPrefix, scanUTXOs, validateAddress };
+export { BTC_DECIMAL, Client, LOWER_FEE_BOUND, MIN_TX_FEE, UPPER_FEE_BOUND, broadcastTx$1 as broadcastTx, buildTx, calcFee, getBalance$2 as getBalance, getDefaultFees, getDefaultFeesWithRates, getPrefix, scanUTXOs, validateAddress };
 //# sourceMappingURL=index.esm.js.map