@xchainjs/xchain-doge 0.2.1 → 0.3.0

package/lib/client.d.ts

@@ -1,4 +1,4 @@
-import { Address, Balance, DepositParams, Fee, FeeRate, Tx, TxHash, TxHistoryParams, TxParams, TxsPage, UTXOClient, XChainClientParams } from '@xchainjs/xchain-client';
+import { Address, Balance, Fee, FeeRate, Tx, TxHash, TxHistoryParams, TxParams, TxsPage, UTXOClient, XChainClientParams } from '@xchainjs/xchain-client';
 export declare type DogecoinClientParams = XChainClientParams & {
     sochainUrl?: string;
     blockcypherUrl?: string;
@@ -16,7 +16,7 @@ declare class Client extends UTXOClient {
      *
      * @param {DogecoinClientParams} params
      */
-    constructor({ network, sochainUrl, blockcypherUrl, phrase, rootDerivationPaths, }: DogecoinClientParams);
+    constructor({ network, feeBounds, sochainUrl, blockcypherUrl, phrase, rootDerivationPaths, }: DogecoinClientParams);
     /**
      * Set/Update the sochain url.
      *
@@ -115,15 +115,5 @@ declare class Client extends UTXOClient {
     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 = 100000;
 export declare const DOGE_DECIMAL = 8;
+export declare const LOWER_FEE_BOUND = 40000;
+export declare const UPPER_FEE_BOUND = 20000000;

package/lib/index.esm.js

@@ -1,11 +1,11 @@
-import { Network, standardFeeRates, calcFees, UTXOClient, TxType } from '@xchainjs/xchain-client';
+import { Network, standardFeeRates, 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.
@@ -64871,7 +64871,7 @@ const chainToString = Object.assign((chainId) => {
     [Chain.Polkadot]: 'Polkadot',
     [Chain.Terra]: 'Terra',
     [Chain.Doge]: 'Dogecoin',
-});
+});
 
 var Denomination;
 (function (Denomination) {
@@ -65052,27 +65052,6 @@ 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}`;
-};
 /**
  * Currency symbols currently supported
  */
@@ -65083,77 +65062,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') {
@@ -85134,7 +85043,7 @@ const DEFAULT_SUGGESTED_TRANSACTION_FEE = 150000;
  */
 const getSuggestedTxFee = ({ blockcypherUrl }) => __awaiter(void 0, void 0, void 0, function* () {
     try {
-        const response = yield axios$1.get(`${blockcypherUrl}/doge/main`);
+        const response = yield axios.get(`${blockcypherUrl}/doge/main`);
         return response.data.low_fee_per_kb / 1000; // feePerKb to feePerByte
     }
     catch (error) {
@@ -85156,7 +85065,9 @@ const getSendTxUrl = ({ blockcypherUrl, network }) => {
  * @see https://github.com/dogecoin/dogecoin/blob/master/src/validation.h#L58
  */
 const MIN_TX_FEE = 100000;
-const DOGE_DECIMAL = 8;
+const DOGE_DECIMAL = 8;
+const LOWER_FEE_BOUND = 40000;
+const UPPER_FEE_BOUND = 20000000;
 
 const toSochainNetwork = (network) => {
     switch (network) {
@@ -85183,7 +85094,7 @@ const getSendTxUrl$1 = ({ sochainUrl, 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;
 });
@@ -85199,7 +85110,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;
 });
@@ -85215,7 +85126,7 @@ const getTx = ({ sochainUrl, network, hash }) => __awaiter(void 0, void 0, void
  */
 const getBalance = ({ sochainUrl, network, address, }) => __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, DOGE_DECIMAL);
     const unconfirmed = assetAmount(balanceResponse.data.unconfirmed_balance, DOGE_DECIMAL);
@@ -85236,10 +85147,10 @@ const getBalance = ({ sochainUrl, network, address, }) => __awaiter(void 0, void
 const getUnspentTxs = ({ sochainUrl, network, address, startingFromTxId, }) => __awaiter(void 0, void 0, void 0, function* () {
     let resp = null;
     if (startingFromTxId) {
-        resp = yield axios$1.get(`${sochainUrl}/get_tx_unspent/${toSochainNetwork(network)}/${address}/${startingFromTxId}`);
+        resp = yield axios.get(`${sochainUrl}/get_tx_unspent/${toSochainNetwork(network)}/${address}/${startingFromTxId}`);
     }
     else {
-        resp = yield axios$1.get(`${sochainUrl}/get_tx_unspent/${toSochainNetwork(network)}/${address}`);
+        resp = yield axios.get(`${sochainUrl}/get_tx_unspent/${toSochainNetwork(network)}/${address}`);
     }
     const response = resp.data;
     const txs = response.data.txs;
@@ -86586,7 +86497,7 @@ var accumulative = function accumulative (utxos, outputs, feeRate) {
  * @returns {string} Transaction ID.
  */
 const broadcastTxToSochain = ({ txHex, nodeUrl }) => __awaiter(void 0, void 0, void 0, function* () {
-    const response = (yield axios$1.post(nodeUrl, {
+    const response = (yield axios.post(nodeUrl, {
         tx_hex: txHex,
     })).data;
     if (response.error) {
@@ -86602,7 +86513,7 @@ const broadcastTxToSochain = ({ txHex, nodeUrl }) => __awaiter(void 0, void 0, v
  * @returns {string} Transaction ID.
  */
 const broadcastTxToBlockCypher = ({ txHex, nodeUrl }) => __awaiter(void 0, void 0, void 0, function* () {
-    const response = (yield axios$1.post(nodeUrl, {
+    const response = (yield axios.post(nodeUrl, {
         tx: txHex,
     })).data;
     if (response.error) {
@@ -86886,12 +86797,15 @@ class Client extends UTXOClient {
      *
      * @param {DogecoinClientParams} params
      */
-    constructor({ network = Network.Testnet, sochainUrl = 'https://sochain.com/api/v2', blockcypherUrl = 'https://api.blockcypher.com/v1', phrase, rootDerivationPaths = {
+    constructor({ network = Network.Testnet, feeBounds = {
+        lower: LOWER_FEE_BOUND,
+        upper: UPPER_FEE_BOUND,
+    }, sochainUrl = 'https://sochain.com/api/v2', blockcypherUrl = 'https://api.blockcypher.com/v1', phrase, rootDerivationPaths = {
         [Network.Mainnet]: `m/44'/3'/0'/0/`,
         [Network.Stagenet]: `m/44'/3'/0'/0/`,
         [Network.Testnet]: `m/44'/1'/0'/0/`,
     }, }) {
-        super(Chain.Doge, { network, rootDerivationPaths, phrase });
+        super(Chain.Doge, { network, rootDerivationPaths, phrase, feeBounds });
         this.sochainUrl = '';
         this.blockcypherUrl = '';
         this.setSochainUrl(sochainUrl);
@@ -87124,6 +87038,7 @@ class Client extends UTXOClient {
         return __awaiter(this, void 0, void 0, function* () {
             const fromAddressIndex = (params === null || params === void 0 ? void 0 : params.walletIndex) || 0;
             const feeRate = params.feeRate || (yield this.getSuggestedFeeRate());
+            checkFeeBounds(this.feeBounds, feeRate);
             const { psbt } = yield buildTx({
                 amount: params.amount,
                 recipient: params.recipient,
@@ -87155,34 +87070,6 @@ class Client extends UTXOClient {
             });
         });
     }
-    /**
-     * 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 = AssetDOGE, 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;
-        });
-    }
 }
 
 /**
@@ -87199,5 +87086,5 @@ const createTxInfo = (params) => __awaiter(void 0, void 0, void 0, function* ()
     };
 });
 
-export { Client, DOGE_DECIMAL, MIN_TX_FEE, broadcastTx, buildTx, calcFee, createTxInfo, getDefaultFees, getDefaultFeesWithRates, getPrefix, getSendTxUrl, scanUTXOs, validateAddress };
+export { Client, DOGE_DECIMAL, LOWER_FEE_BOUND, MIN_TX_FEE, UPPER_FEE_BOUND, broadcastTx, buildTx, calcFee, createTxInfo, getDefaultFees, getDefaultFeesWithRates, getPrefix, getSendTxUrl, scanUTXOs, validateAddress };
 //# sourceMappingURL=index.esm.js.map