@xchainjs/xchain-doge 0.2.0 → 0.2.1

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# v.0.2.1 (2022-05-05)
+
+## Update
+
+- Add `deposit` function to Doge `Client`
+- Update latest dependencies
+- Add tests for `deposit` 
+
+## Fix
+
+- Fix import of `xchain-client`
+
 # v.0.2.0 (2022-03-23)
 
 ## Update

package/README.md

@@ -16,6 +16,13 @@ Following peer dependencies have to be installed into your project. These are no
 yarn add @xchainjs/xchain-client @xchainjs/xchain-crypto @xchainjs/xchain-util axios bitcoinjs-lib coininfo wif
 ```
 
+## Documentation
+
+### [`xchain doge`](http://docs.xchainjs.org/xchain-client/xchain-doge/)
+[`How xchain-doge works`](http://docs.xchainjs.org/xchain-client/xchain-doge/how-it-works.html)\
+[`How to use xchain-doge`](http://docs.xchainjs.org/xchain-client/xchain-doge/how-to-use.html)
+
+
 ## Service Providers
 
 This package uses the following service providers:
@@ -32,42 +39,3 @@ This package uses the following service providers:
 Sochain API rate limits: https://sochain.com/api#rate-limits (300 requests/minute)
 
 BlockCypher API rate limits: https://api.blockcypher.com/v1/doge/main (5 requests/second)
-
-## Usage
-
-Initialize client and use class methods:
-
-```
-import { Client, Network } from '../src/client'
-
-// Create a new client interface
-const dogeClient = new Client({ network: Network.Testnet })
-
-// Set phrase
-dogeClient.setPhrase('phrase here')
-
-// Get address
-const address = dogeClient.getAddress()
-
-// Get balance
-const balance = await dogeClient.getBalance()
-
-// Transfer with feeRate
-const txid = await dogeClient.transfer({ asset: AssetDoge, recipient: 'recipient address here', amount: baseAmount(100, DOGE_DECIMAL), feeRate: 1 })
-
-// Transfer with default feeRate (default is `fast`)
-const txid = await dogeClient.transfer({ asset: AssetDoge, recipient: 'recipient address here', amount: baseAmount(100, DOGE_DECIMAL) })
-
-// Get fee estimations
-const { fast, fastest, average } = await dogeClient.getFees()
-
-// Get feeRate estimations
-const { fast, fastest, average } = await dogeClient.getFeeRates()
-
-// Search transactions
-const transactions = await dogeClient.getTransactions({ address: 'address here', limit: 4 })
-
-// Get a transaction with a given txId/hash
-const txData = await dogeClient.getTransactionData('b660ee07167cfa32681e2623f3a29dc64a089cabd9a3a07dd17f9028ac956eb8')
-
-```

package/lib/blockcypher-api.d.ts

@@ -1,4 +1,4 @@
-import { Network } from '@xchainjs/xchain-client/lib';
+import { Network } from '@xchainjs/xchain-client';
 /**
  * Get Dogecoin suggested transaction fee.
  *

package/lib/client.d.ts

@@ -1,4 +1,4 @@
-import { Address, Balance, Fee, FeeRate, Tx, TxHash, TxHistoryParams, TxParams, TxsPage, UTXOClient, XChainClientParams } from '@xchainjs/xchain-client';
+import { Address, Balance, DepositParams, Fee, FeeRate, Tx, TxHash, TxHistoryParams, TxParams, TxsPage, UTXOClient, XChainClientParams } from '@xchainjs/xchain-client';
 export declare type DogecoinClientParams = XChainClientParams & {
     sochainUrl?: string;
     blockcypherUrl?: string;
@@ -115,5 +115,15 @@ 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/index.esm.js

@@ -5,7 +5,7 @@ import stream from 'stream';
 import string_decoder$1 from 'string_decoder';
 import crypto$1$1 from 'crypto';
 import readableStream from 'readable-stream';
-import axios from 'axios';
+import axios$1 from 'axios';
 
 /*! *****************************************************************************
 Copyright (c) Microsoft Corporation.
@@ -61858,7 +61858,7 @@ var sha256$2 = createCommonjsModule(function (module, exports) {
  * @param {string} phrase
  * @returns {boolean} `true` or `false`
  */
-var validatePhrase = function (phrase) {
+const validatePhrase = (phrase) => {
     return src_6(phrase);
 };
 /**
@@ -61869,7 +61869,7 @@ var validatePhrase = function (phrase) {
  *
  * @throws {"Invalid BIP39 phrase"} Thrown if phrase is an invalid one.
  */
-var getSeed = function (phrase) {
+const getSeed = (phrase) => {
     if (!validatePhrase(phrase)) {
         throw new Error('Invalid BIP39 phrase');
     }
@@ -64796,14 +64796,14 @@ var bignumber$1 = createCommonjsModule$1(function (module) {
  * @param {string | number | BigNumber.Instance} value
  * @returns {BigNumber} The BigNumber interface from the given value.
  */
-var bn$1 = function (value) { return new bignumber$1(value); };
+const bn$1 = (value) => new bignumber$1(value);
 /**
  * Helper to check whether a BigNumber is valid or not
  *
  * @param {BigNumber} value
  * @returns {boolean} `true` or `false`.
  * */
-var isValidBN = function (value) { return !value.isNaN(); };
+const isValidBN = (value) => !value.isNaN();
 /**
  * The enumuration for symbol position.
  * `before` or `after`
@@ -64821,14 +64821,12 @@ var SymbolPosition;
  * @param {number} decimalPlaces The decimal place. (optional)
  * @returns {BigNumber} The BigNumber interface from the given value and decimal.
  * */
-var fixedBN = function (value, decimalPlaces) {
-    if (decimalPlaces === void 0) { decimalPlaces = 2; }
-    var n = bn$1(value || 0);
-    var fixedBN = isValidBN(n) ? n.toFixed(decimalPlaces) : bn$1(0).toFixed(decimalPlaces);
+const fixedBN = (value, decimalPlaces = 2) => {
+    const n = bn$1(value || 0);
+    const fixedBN = isValidBN(n) ? n.toFixed(decimalPlaces) : bn$1(0).toFixed(decimalPlaces);
     return bn$1(fixedBN);
 };
 
-var _a;
 var Chain;
 (function (Chain) {
     Chain["Binance"] = "BNB";
@@ -64842,38 +64840,38 @@ var Chain;
     Chain["Terra"] = "TERRA";
     Chain["Doge"] = "DOGE";
 })(Chain || (Chain = {}));
-var BNBChain = Chain.Binance;
-var BTCChain = Chain.Bitcoin;
-var ETHChain = Chain.Ethereum;
-var THORChain = Chain.THORChain;
-var CosmosChain = Chain.Cosmos;
-var PolkadotChain = Chain.Polkadot;
-var BCHChain = Chain.BitcoinCash;
-var LTCChain = Chain.Litecoin;
-var LUNAChain = Chain.Terra;
-var DOGEChain = Chain.Doge;
+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;
 /**
  * Convert chain to string.
  *
  * @param {Chain} chainId.
  * @returns {string} The string based on the given chain type.
  */
-var chainToString = Object.assign(function (chainId) {
+const chainToString = Object.assign((chainId) => {
     if (!(chainId in chainToString))
         return 'unknown chain';
     return chainToString[chainId];
-}, (_a = {},
-    _a[Chain.THORChain] = 'Thorchain',
-    _a[Chain.Bitcoin] = 'Bitcoin',
-    _a[Chain.BitcoinCash] = 'Bitcoin Cash',
-    _a[Chain.Litecoin] = 'Litecoin',
-    _a[Chain.Ethereum] = 'Ethereum',
-    _a[Chain.Binance] = 'Binance Chain',
-    _a[Chain.Cosmos] = 'Cosmos',
-    _a[Chain.Polkadot] = 'Polkadot',
-    _a[Chain.Terra] = 'Terra',
-    _a[Chain.Doge] = 'Dogecoin',
-    _a));
+}, {
+    [Chain.THORChain]: 'Thorchain',
+    [Chain.Bitcoin]: 'Bitcoin',
+    [Chain.BitcoinCash]: 'Bitcoin Cash',
+    [Chain.Litecoin]: 'Litecoin',
+    [Chain.Ethereum]: 'Ethereum',
+    [Chain.Binance]: 'Binance Chain',
+    [Chain.Cosmos]: 'Cosmos',
+    [Chain.Polkadot]: 'Polkadot',
+    [Chain.Terra]: 'Terra',
+    [Chain.Doge]: 'Dogecoin',
+});
 
 var Denomination;
 (function (Denomination) {
@@ -64893,9 +64891,7 @@ var Denomination;
  * @param {unknown} v
  * @returns {boolean} `true` or `false`.
  * */
-var isBigNumberValue = function (v) {
-    return typeof v === 'string' || typeof v === 'number' || v instanceof bignumber$1;
-};
+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.
@@ -64906,7 +64902,7 @@ var isBigNumberValue = function (v) {
  * 0.00000001 RUNE == 1 ð (tor)
  * ```
  * */
-var ASSET_DECIMAL = 8;
+const ASSET_DECIMAL = 8;
 /**
  * Factory to create values of assets (e.g. RUNE)
  *
@@ -64915,34 +64911,21 @@ var ASSET_DECIMAL = 8;
  * @returns {AssetAmount} The asset amount from the given value and decimal.
  *
  **/
-var assetAmount = function (value, decimal) {
-    if (decimal === void 0) { decimal = ASSET_DECIMAL; }
-    var amount = fixedBN(value, decimal);
+const assetAmount = (value, decimal = ASSET_DECIMAL) => {
+    const amount = fixedBN(value, decimal);
     return {
         type: Denomination.Asset,
-        amount: function () { return amount; },
-        plus: function (v, d) {
-            if (d === void 0) { d = decimal; }
-            return assetAmount(amount.plus(isBigNumberValue(v) ? v : v.amount()), d);
-        },
-        minus: function (v, d) {
-            if (d === void 0) { d = decimal; }
-            return assetAmount(amount.minus(isBigNumberValue(v) ? v : v.amount()), d);
-        },
-        times: function (v, d) {
-            if (d === void 0) { d = decimal; }
-            return assetAmount(amount.times(isBigNumberValue(v) ? v : v.amount()), d);
-        },
-        div: function (v, d) {
-            if (d === void 0) { d = decimal; }
-            return assetAmount(amount.div(isBigNumberValue(v) ? v : v.amount()), d);
-        },
-        lt: function (v) { return amount.lt(isBigNumberValue(v) ? v : v.amount()); },
-        lte: function (v) { return amount.lte(isBigNumberValue(v) ? v : v.amount()); },
-        gt: function (v) { return amount.gt(isBigNumberValue(v) ? v : v.amount()); },
-        gte: function (v) { return amount.gte(isBigNumberValue(v) ? v : v.amount()); },
-        eq: function (v) { return amount.eq(isBigNumberValue(v) ? v : v.amount()); },
-        decimal: decimal,
+        amount: () => amount,
+        plus: (v, d = decimal) => assetAmount(amount.plus(isBigNumberValue(v) ? v : v.amount()), d),
+        minus: (v, d = decimal) => assetAmount(amount.minus(isBigNumberValue(v) ? v : v.amount()), d),
+        times: (v, d = decimal) => assetAmount(amount.times(isBigNumberValue(v) ? v : v.amount()), d),
+        div: (v, d = decimal) => assetAmount(amount.div(isBigNumberValue(v) ? v : v.amount()), d),
+        lt: (v) => amount.lt(isBigNumberValue(v) ? v : v.amount()),
+        lte: (v) => amount.lte(isBigNumberValue(v) ? v : v.amount()),
+        gt: (v) => amount.gt(isBigNumberValue(v) ? v : v.amount()),
+        gte: (v) => amount.gte(isBigNumberValue(v) ? v : v.amount()),
+        eq: (v) => amount.eq(isBigNumberValue(v) ? v : v.amount()),
+        decimal,
     };
 };
 /**
@@ -64952,34 +64935,21 @@ var assetAmount = function (value, decimal) {
  * @param {number} decimal The decimal places of its associated AssetAmount. (optional)
  * @returns {BaseAmount} The base amount from the given value and decimal.
  **/
-var baseAmount = function (value, decimal) {
-    if (decimal === void 0) { decimal = ASSET_DECIMAL; }
-    var amount = fixedBN(value, 0);
+const baseAmount = (value, decimal = ASSET_DECIMAL) => {
+    const amount = fixedBN(value, 0);
     return {
         type: Denomination.Base,
-        amount: function () { return amount; },
-        plus: function (v, d) {
-            if (d === void 0) { d = decimal; }
-            return baseAmount(amount.plus(isBigNumberValue(v) ? v : v.amount()), d);
-        },
-        minus: function (v, d) {
-            if (d === void 0) { d = decimal; }
-            return baseAmount(amount.minus(isBigNumberValue(v) ? v : v.amount()), d);
-        },
-        times: function (v, d) {
-            if (d === void 0) { d = decimal; }
-            return baseAmount(amount.times(isBigNumberValue(v) ? v : v.amount()), d);
-        },
-        div: function (v, d) {
-            if (d === void 0) { d = decimal; }
-            return baseAmount(amount.div(isBigNumberValue(v) ? v : v.amount()).decimalPlaces(0, bignumber$1.ROUND_DOWN), d);
-        },
-        lt: function (v) { return amount.lt(isBigNumberValue(v) ? v : v.amount()); },
-        lte: function (v) { return amount.lte(isBigNumberValue(v) ? v : v.amount()); },
-        gt: function (v) { return amount.gt(isBigNumberValue(v) ? v : v.amount()); },
-        gte: function (v) { return amount.gte(isBigNumberValue(v) ? v : v.amount()); },
-        eq: function (v) { return amount.eq(isBigNumberValue(v) ? v : v.amount()); },
-        decimal: decimal,
+        amount: () => amount,
+        plus: (v, d = decimal) => baseAmount(amount.plus(isBigNumberValue(v) ? v : v.amount()), d),
+        minus: (v, d = decimal) => baseAmount(amount.minus(isBigNumberValue(v) ? v : v.amount()), d),
+        times: (v, d = decimal) => baseAmount(amount.times(isBigNumberValue(v) ? v : v.amount()), d),
+        div: (v, d = decimal) => baseAmount(amount.div(isBigNumberValue(v) ? v : v.amount()).decimalPlaces(0, bignumber$1.ROUND_DOWN), d),
+        lt: (v) => amount.lt(isBigNumberValue(v) ? v : v.amount()),
+        lte: (v) => amount.lte(isBigNumberValue(v) ? v : v.amount()),
+        gt: (v) => amount.gt(isBigNumberValue(v) ? v : v.amount()),
+        gte: (v) => amount.gte(isBigNumberValue(v) ? v : v.amount()),
+        eq: (v) => amount.eq(isBigNumberValue(v) ? v : v.amount()),
+        decimal,
     };
 };
 /**
@@ -64988,8 +64958,8 @@ var baseAmount = function (value, decimal) {
  * @param {AssetAmount} asset
  * @returns {BaseAmount} The base amount from the given AssetAmount.
  * */
-var assetToBase = function (asset) {
-    var value = asset
+const assetToBase = (asset) => {
+    const value = asset
         .amount()
         .multipliedBy(Math.pow(10, asset.decimal))
         .integerValue();
@@ -65001,78 +64971,72 @@ var assetToBase = function (asset) {
  * Based on definition in Thorchain `common`
  * @see https://gitlab.com/thorchain/thornode/-/blob/master/common/asset.go#L12-24
  */
-var AssetBNB = { chain: Chain.Binance, symbol: 'BNB', ticker: 'BNB', synth: false };
+const AssetBNB = { chain: Chain.Binance, symbol: 'BNB', ticker: 'BNB', synth: false };
 /**
  * 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
  */
-var AssetBTC = { chain: Chain.Bitcoin, symbol: 'BTC', ticker: 'BTC', synth: false };
+const AssetBTC = { chain: Chain.Bitcoin, symbol: 'BTC', ticker: 'BTC', synth: false };
 /**
  * Base "chain" asset on bitcoin cash main net.
  *
  * Based on definition in Thorchain `common`
  * @see https://gitlab.com/thorchain/thornode/-/blob/master/common/asset.go#L12-24
  */
-var AssetBCH = { chain: Chain.BitcoinCash, symbol: 'BCH', ticker: 'BCH', synth: false };
+const AssetBCH = { chain: Chain.BitcoinCash, symbol: 'BCH', ticker: 'BCH', synth: false };
 /**
  * Base "chain" asset on litecoin main net.
  *
  * Based on definition in Thorchain `common`
  * @see https://gitlab.com/thorchain/thornode/-/blob/master/common/asset.go#L12-24
  */
-var AssetLTC = { chain: Chain.Litecoin, symbol: 'LTC', ticker: 'LTC', synth: false };
+const AssetLTC = { chain: Chain.Litecoin, symbol: 'LTC', ticker: 'LTC', synth: false };
 /**
  * Dogecoin asset
  * Based on definition in Thorchain
  * @see https://gitlab.com/thorchain/thornode/-/blob/781-add-doge-chain/common/asset.go#L24
  */
-var AssetDOGE = { chain: Chain.Doge, symbol: 'DOGE', ticker: 'DOGE', synth: false };
-/**
- * Luna asset
- * Based on definition in Thorchain
- * @see TBD
- */
-var AssetLUNA = { chain: Chain.Terra, symbol: 'LUNA', ticker: 'LUNA', synth: false };
-var RUNE_TICKER = 'RUNE';
+const AssetDOGE = { chain: Chain.Doge, symbol: 'DOGE', ticker: 'DOGE', synth: false };
+const RUNE_TICKER = 'RUNE';
 /**
  * Base "chain" asset on ethereum main net.
  *
  * Based on definition in Thorchain `common`
  * @see https://gitlab.com/thorchain/thornode/-/blob/master/common/asset.go#L12-24
  */
-var AssetETH = { chain: Chain.Ethereum, symbol: 'ETH', ticker: 'ETH', synth: false };
+const AssetETH = { chain: Chain.Ethereum, symbol: 'ETH', ticker: 'ETH', synth: false };
 /**
  * Base "chain" asset for RUNE-67C on Binance test net.
  *
  * Based on definition in Thorchain `common`
  * @see https://gitlab.com/thorchain/thornode/-/blob/master/common/asset.go#L12-24
  */
-var AssetRune67C = { chain: Chain.Binance, symbol: 'RUNE-67C', ticker: RUNE_TICKER, synth: false };
+const AssetRune67C = { chain: Chain.Binance, symbol: 'RUNE-67C', ticker: RUNE_TICKER, synth: false };
 /**
  * Base "chain" asset for RUNE-B1A on Binance main net.
  *
  * Based on definition in Thorchain `common`
  * @see https://gitlab.com/thorchain/thornode/-/blob/master/common/asset.go#L12-24
  */
-var AssetRuneB1A = { chain: Chain.Binance, symbol: 'RUNE-B1A', ticker: RUNE_TICKER, synth: false };
+const AssetRuneB1A = { chain: Chain.Binance, symbol: 'RUNE-B1A', ticker: RUNE_TICKER, synth: false };
 /**
  * Base "chain" asset on thorchain main net.
  *
  * Based on definition in Thorchain `common`
  * @see https://gitlab.com/thorchain/thornode/-/blob/master/common/asset.go#L12-24
  */
-var AssetRuneNative = { chain: Chain.THORChain, symbol: RUNE_TICKER, ticker: RUNE_TICKER, synth: false };
+const AssetRuneNative = { chain: Chain.THORChain, symbol: RUNE_TICKER, ticker: RUNE_TICKER, synth: false };
 /**
  * Base "chain" asset for RUNE on ethereum main net.
  *
  * Based on definition in Thorchain `common`
  * @see https://gitlab.com/thorchain/thornode/-/blob/master/common/asset.go#L12-24
  */
-var AssetRuneERC20 = {
+const AssetRuneERC20 = {
     chain: Chain.Ethereum,
-    symbol: RUNE_TICKER + "-0x3155ba85d5f96b2d030a4966af206230e46849cb",
+    symbol: `${RUNE_TICKER}-0x3155ba85d5f96b2d030a4966af206230e46849cb`,
     ticker: RUNE_TICKER,
     synth: false,
 };
@@ -65082,12 +65046,33 @@ var AssetRuneERC20 = {
  * Based on definition in Thorchain `common`
  * @see https://gitlab.com/thorchain/thornode/-/blob/master/common/asset.go#L12-24
  */
-var AssetRuneERC20Testnet = {
+const AssetRuneERC20Testnet = {
     chain: Chain.Ethereum,
-    symbol: RUNE_TICKER + "-0xd601c6A3a36721320573885A8d8420746dA3d7A0",
+    symbol: `${RUNE_TICKER}-0xd601c6A3a36721320573885A8d8420746dA3d7A0`,
     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
  */
@@ -65098,7 +65083,77 @@ var AssetCurrencySymbol;
     AssetCurrencySymbol["SATOSHI"] = "\u26A1";
     AssetCurrencySymbol["ETH"] = "\u039E";
     AssetCurrencySymbol["USD"] = "$";
-})(AssetCurrencySymbol || (AssetCurrencySymbol = {}));
+})(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;
+});
 
 var inherits_browser$1 = createCommonjsModule$1(function (module) {
 if (typeof Object.create === 'function') {
@@ -85079,7 +85134,7 @@ const DEFAULT_SUGGESTED_TRANSACTION_FEE = 150000;
  */
 const getSuggestedTxFee = ({ blockcypherUrl }) => __awaiter(void 0, void 0, void 0, function* () {
     try {
-        const response = yield axios.get(`${blockcypherUrl}/doge/main`);
+        const response = yield axios$1.get(`${blockcypherUrl}/doge/main`);
         return response.data.low_fee_per_kb / 1000; // feePerKb to feePerByte
     }
     catch (error) {
@@ -85128,7 +85183,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.get(url);
+    const response = yield axios$1.get(url);
     const addressResponse = response.data;
     return addressResponse.data;
 });
@@ -85144,7 +85199,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.get(url);
+    const response = yield axios$1.get(url);
     const tx = response.data;
     return tx.data;
 });
@@ -85160,7 +85215,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.get(url);
+    const response = yield axios$1.get(url);
     const balanceResponse = response.data;
     const confirmed = assetAmount(balanceResponse.data.confirmed_balance, DOGE_DECIMAL);
     const unconfirmed = assetAmount(balanceResponse.data.unconfirmed_balance, DOGE_DECIMAL);
@@ -85181,10 +85236,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.get(`${sochainUrl}/get_tx_unspent/${toSochainNetwork(network)}/${address}/${startingFromTxId}`);
+        resp = yield axios$1.get(`${sochainUrl}/get_tx_unspent/${toSochainNetwork(network)}/${address}/${startingFromTxId}`);
     }
     else {
-        resp = yield axios.get(`${sochainUrl}/get_tx_unspent/${toSochainNetwork(network)}/${address}`);
+        resp = yield axios$1.get(`${sochainUrl}/get_tx_unspent/${toSochainNetwork(network)}/${address}`);
     }
     const response = resp.data;
     const txs = response.data.txs;
@@ -86531,7 +86586,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.post(nodeUrl, {
+    const response = (yield axios$1.post(nodeUrl, {
         tx_hex: txHex,
     })).data;
     if (response.error) {
@@ -86547,7 +86602,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.post(nodeUrl, {
+    const response = (yield axios$1.post(nodeUrl, {
         tx: txHex,
     })).data;
     if (response.error) {
@@ -87100,6 +87155,34 @@ 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;
+        });
+    }
 }
 
 /**