@xchainjs/xchain-bitcoin 0.18.2 → 0.20.0

package/lib/client.d.ts

@@ -1,5 +1,5 @@
-import { Address, Balance, DepositParams, Fee, FeeRate, Tx, TxHash, TxHistoryParams, TxParams, TxsPage, UTXOClient, XChainClientParams } from '@xchainjs/xchain-client';
-import { Asset } from '@xchainjs/xchain-util';
+import { Balance, Fee, FeeRate, Tx, TxHash, TxHistoryParams, TxParams, TxsPage, UTXOClient, XChainClientParams } from '@xchainjs/xchain-client';
+import { Address, Asset } from '@xchainjs/xchain-util';
 import { ClientUrl } from './types/client-types';
 export declare type BitcoinClientParams = XChainClientParams & {
     sochainUrl?: string;
@@ -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,19 +108,11 @@ 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.
-     */
-    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;

package/lib/index.esm.js

@@ -1,11 +1,11 @@
-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';
 import string_decoder$1 from 'string_decoder';
 import crypto$1$1 from 'crypto';
 import readableStream from 'readable-stream';
-import axios$1 from 'axios';
+import axios from 'axios';
 
 /*! *****************************************************************************
 Copyright (c) Microsoft Corporation.
@@ -64849,27 +64849,29 @@ const fixedBN = (value, decimalPlaces = 2) => {
 
 var Chain;
 (function (Chain) {
+    Chain["Avalanche"] = "AVAX";
     Chain["Binance"] = "BNB";
     Chain["Bitcoin"] = "BTC";
     Chain["Ethereum"] = "ETH";
     Chain["THORChain"] = "THOR";
     Chain["Cosmos"] = "GAIA";
-    Chain["Polkadot"] = "POLKA";
     Chain["BitcoinCash"] = "BCH";
     Chain["Litecoin"] = "LTC";
     Chain["Terra"] = "TERRA";
     Chain["Doge"] = "DOGE";
+    Chain["Avax"] = "AVAX";
 })(Chain || (Chain = {}));
+const AvalancheChain = Chain.Avalanche;
 const BNBChain = Chain.Binance;
 const BTCChain = Chain.Bitcoin;
 const ETHChain = Chain.Ethereum;
 const THORChain = Chain.THORChain;
 const CosmosChain = Chain.Cosmos;
-const PolkadotChain = Chain.Polkadot;
 const BCHChain = Chain.BitcoinCash;
 const LTCChain = Chain.Litecoin;
 const TerraChain = Chain.Terra;
 const DOGEChain = Chain.Doge;
+const AVAXChain = Chain.Avax;
 /**
  * Convert chain to string.
  *
@@ -64881,6 +64883,7 @@ const chainToString = Object.assign((chainId) => {
         return 'unknown chain';
     return chainToString[chainId];
 }, {
+    [Chain.Avalanche]: 'Avalanche',
     [Chain.THORChain]: 'Thorchain',
     [Chain.Bitcoin]: 'Bitcoin',
     [Chain.BitcoinCash]: 'Bitcoin Cash',
@@ -64888,10 +64891,9 @@ const chainToString = Object.assign((chainId) => {
     [Chain.Ethereum]: 'Ethereum',
     [Chain.Binance]: 'Binance Chain',
     [Chain.Cosmos]: 'Cosmos',
-    [Chain.Polkadot]: 'Polkadot',
     [Chain.Terra]: 'Terra',
     [Chain.Doge]: 'Dogecoin',
-});
+});
 
 var Denomination;
 (function (Denomination) {
@@ -64914,7 +64916,7 @@ var Denomination;
 const isBigNumberValue = (v) => typeof v === 'string' || typeof v === 'number' || v instanceof bignumber$1;
 /**
  * Default number of asset decimals
- * For history reason and by starting the project on Binance chain assets, it's 8 decimal.
+ * For history reason and by starting the project on Binance chain assets, it's 8 decimal.F
  *
  * For example:
  * ```
@@ -64985,6 +64987,11 @@ const assetToBase = (asset) => {
         .integerValue();
     return baseAmount(value, asset.decimal);
 };
+/**
+ * Base "chain" asset of Avalanche chain.
+ *
+ */
+const AssetAVAX = { chain: Chain.Avalanche, symbol: 'AVAX', ticker: 'AVAX', synth: false };
 /**
  * Base "chain" asset of Binance chain.
  *
@@ -65072,27 +65079,8 @@ const AssetRuneERC20Testnet = {
     ticker: RUNE_TICKER,
     synth: false,
 };
-const SYNTH_DELIMITER = '/';
-const NON_SYNTH_DELIMITER = '.';
-/**
- * Returns an `Asset` as a string using following naming convention:
- *
- * `AAA.BBB-CCC`
- * where
- * chain: `AAA`
- * ticker (optional): `BBB`
- * symbol: `BBB-CCC` or `CCC` (if no ticker available)
- * symbol (synth): `BBB/CCC` or `CCC` (if no ticker available)
- *
- * @see https://docs.thorchain.org/developers/transaction-memos#asset-notation
- *
- * @param {Asset} asset The given asset.
- * @returns {string} The string from the given asset.
- */
-const assetToString = ({ chain, symbol, synth }) => {
-    const delimiter = synth ? SYNTH_DELIMITER : NON_SYNTH_DELIMITER;
-    return `${chain}${delimiter}${symbol}`;
-};
+const AssetAtom = { chain: Chain.Cosmos, symbol: 'ATOM', ticker: 'ATOM', synth: false };
+const AssetLUNA = { chain: Chain.Terra, symbol: 'LUNA', ticker: 'LUNA', synth: false };
 /**
  * Currency symbols currently supported
  */
@@ -65103,77 +65091,7 @@ var AssetCurrencySymbol;
     AssetCurrencySymbol["SATOSHI"] = "\u26A1";
     AssetCurrencySymbol["ETH"] = "\u039E";
     AssetCurrencySymbol["USD"] = "$";
-})(AssetCurrencySymbol || (AssetCurrencySymbol = {}));
-
-/*! *****************************************************************************
-Copyright (c) Microsoft Corporation.
-
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
-REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
-AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
-INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
-LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
-OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-PERFORMANCE OF THIS SOFTWARE.
-***************************************************************************** */
-
-function __awaiter$1(thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-}
-
-const axios = require('axios');
-const midgardBaseUrls = {
-    [Network.Testnet]: ['https://testnet.midgard.thorchain.info'],
-    [Network.Mainnet]: ['https://midgard.ninerealms.com', 'https://midgard.thorswap.net'],
-};
-const getMimirDetails = (network = Network.Mainnet) => __awaiter$1(void 0, void 0, void 0, function* () {
-    const path = '/v2/thorchain/mimir';
-    for (const baseUrl of midgardBaseUrls[network]) {
-        try {
-            const { data } = yield axios.get(`${baseUrl}${path}`);
-            return data;
-        }
-        catch (e) {
-            console.error(e);
-        }
-    }
-    throw new Error('Midgard not responding');
-});
-const getAllInboundDetails = (network = Network.Mainnet) => __awaiter$1(void 0, void 0, void 0, function* () {
-    const path = '/v2/thorchain/inbound_addresses';
-    for (const baseUrl of midgardBaseUrls[network]) {
-        try {
-            const { data } = yield axios.get(`${baseUrl}${path}`);
-            return data;
-        }
-        catch (e) {
-            console.error(e);
-        }
-    }
-    throw new Error('Midgard not responding');
-});
-const getInboundDetails = (chain, network = Network.Mainnet) => __awaiter$1(void 0, void 0, void 0, function* () {
-    const [mimirDetails, allInboundDetails] = yield Promise.all([getMimirDetails(network), getAllInboundDetails(network)]);
-    const inboundDetail = allInboundDetails === null || allInboundDetails === void 0 ? void 0 : allInboundDetails.find((item) => item.chain === chain);
-    const details = {
-        vault: (inboundDetail === null || inboundDetail === void 0 ? void 0 : inboundDetail.address) || '',
-        haltedChain: (inboundDetail === null || inboundDetail === void 0 ? void 0 : inboundDetail.halted) || !!mimirDetails[`HALT${chain}CHAIN`] || !!mimirDetails['HALTCHAINGLOBAL'],
-        haltedTrading: !!mimirDetails['HALTTRADING'] || !!mimirDetails[`HALT${chain}TRADING`],
-        haltedLP: !!mimirDetails['PAUSELP'] || !!mimirDetails[`PAUSELP${chain}`],
-    };
-    if (inboundDetail === null || inboundDetail === void 0 ? void 0 : inboundDetail.router)
-        details.router = inboundDetail.router;
-    return details;
-});
+})(AssetCurrencySymbol || (AssetCurrencySymbol = {}));
 
 var inherits_browser$1 = createCommonjsModule$1(function (module) {
 if (typeof Object.create === 'function') {
@@ -85152,7 +85070,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) => {
@@ -85176,7 +85096,7 @@ const toSochainNetwork = (network) => {
  */
 const getAddress = ({ sochainUrl, network, address }) => __awaiter(void 0, void 0, void 0, function* () {
     const url = `${sochainUrl}/address/${toSochainNetwork(network)}/${address}`;
-    const response = yield axios$1.get(url);
+    const response = yield axios.get(url);
     const addressResponse = response.data;
     return addressResponse.data;
 });
@@ -85192,7 +85112,7 @@ const getAddress = ({ sochainUrl, network, address }) => __awaiter(void 0, void
  */
 const getTx = ({ sochainUrl, network, hash }) => __awaiter(void 0, void 0, void 0, function* () {
     const url = `${sochainUrl}/get_tx/${toSochainNetwork(network)}/${hash}`;
-    const response = yield axios$1.get(url);
+    const response = yield axios.get(url);
     const tx = response.data;
     return tx.data;
 });
@@ -85209,7 +85129,7 @@ const getTx = ({ sochainUrl, network, hash }) => __awaiter(void 0, void 0, void
  */
 const getBalance = ({ sochainUrl, network, address, confirmedOnly, }) => __awaiter(void 0, void 0, void 0, function* () {
     const url = `${sochainUrl}/get_address_balance/${toSochainNetwork(network)}/${address}`;
-    const response = yield axios$1.get(url);
+    const response = yield axios.get(url);
     const balanceResponse = response.data;
     const confirmed = assetAmount(balanceResponse.data.confirmed_balance, BTC_DECIMAL);
     const unconfirmed = assetAmount(balanceResponse.data.unconfirmed_balance, BTC_DECIMAL);
@@ -85237,7 +85157,7 @@ const getUnspentTxs = ({ sochainUrl, network, address, startingFromTxId, }) => _
     ]
         .filter((v) => !!v)
         .join('/');
-    const resp = yield axios$1.get(url);
+    const resp = yield axios.get(url);
     const response = resp.data;
     const txs = response.data.txs;
     if (txs.length === 100) {
@@ -85266,7 +85186,7 @@ const getUnspentTxs = ({ sochainUrl, network, address, startingFromTxId, }) => _
  * @returns {TxConfirmedStatus}
  */
 const getIsTxConfirmed = ({ sochainUrl, network, hash }) => __awaiter(void 0, void 0, void 0, function* () {
-    const { data } = yield axios$1.get(`${sochainUrl}/is_tx_confirmed/${toSochainNetwork(network)}/${hash}`);
+    const { data } = yield axios.get(`${sochainUrl}/is_tx_confirmed/${toSochainNetwork(network)}/${hash}`);
     return data.data;
 });
 /**
@@ -85333,7 +85253,7 @@ const getSuggestedTxFee = () => __awaiter(void 0, void 0, void 0, function* () {
     //So use Bitgo API for fee estimation
     //Refer: https://app.bitgo.com/docs/#operation/v2.tx.getfeeestimate
     try {
-        const response = yield axios$1.get('https://app.bitgo.com/api/v2/btc/tx/fee');
+        const response = yield axios.get('https://app.bitgo.com/api/v2/btc/tx/fee');
         return response.data.feePerKb / 1000; // feePerKb to feePerByte
     }
     catch (error) {
@@ -85460,13 +85380,13 @@ var accumulative = function accumulative (utxos, outputs, feeRate) {
  *
  */
 const getBalance$1 = ({ haskoinUrl, address, confirmedOnly, }) => __awaiter(void 0, void 0, void 0, function* () {
-    const { data: { confirmed, unconfirmed }, } = yield axios$1.get(`${haskoinUrl}/address/${address}/balance`);
+    const { data: { confirmed, unconfirmed }, } = yield axios.get(`${haskoinUrl}/address/${address}/balance`);
     const confirmedAmount = baseAmount(confirmed, BTC_DECIMAL);
     const unconfirmedAmount = baseAmount(unconfirmed, BTC_DECIMAL);
     return confirmedOnly ? confirmedAmount : confirmedAmount.plus(unconfirmedAmount);
 });
 const getUnspentTxs$1 = ({ haskoinUrl, address, }) => __awaiter(void 0, void 0, void 0, function* () {
-    const { data: response } = yield axios$1.get(`${haskoinUrl}/address/${address}/unspent`);
+    const { data: response } = yield axios.get(`${haskoinUrl}/address/${address}/unspent`);
     return response;
 });
 const getConfirmedUnspentTxs$1 = ({ haskoinUrl, sochainUrl, address, network, }) => __awaiter(void 0, void 0, void 0, function* () {
@@ -85497,7 +85417,7 @@ const getConfirmedUnspentTxs$1 = ({ haskoinUrl, sochainUrl, address, network, })
  * @returns {TxHash} Transaction hash.
  */
 const broadcastTx = ({ txHex, haskoinUrl }) => __awaiter(void 0, void 0, void 0, function* () {
-    const instance = axios$1.create();
+    const instance = axios.create();
     const MAX = 5;
     let counter = 0;
     const onFullfilled = (res) => res;
@@ -85710,8 +85630,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 +85748,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 +85760,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 +85978,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
@@ -86072,35 +86001,7 @@ class Client extends UTXOClient {
             return yield broadcastTx$1({ txHex, haskoinUrl });
         });
     }
-    /**
-     * 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.
-     */
-    deposit({ walletIndex = 0, asset = AssetBTC, amount, memo }) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const inboundDetails = yield getInboundDetails(asset.chain, this.network);
-            if (inboundDetails.haltedChain) {
-                throw new Error(`Halted chain for ${assetToString(asset)}`);
-            }
-            if (inboundDetails.haltedTrading) {
-                throw new Error(`Halted trading for ${assetToString(asset)}`);
-            }
-            const txHash = yield this.transfer({
-                walletIndex,
-                asset,
-                amount,
-                recipient: inboundDetails.vault,
-                memo,
-            });
-            return txHash;
-        });
-    }
 }
 
-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