@xchainjs/xchain-thorchain-query 2.0.7 → 2.0.8

package/lib/index.esm.js

@@ -41,55 +41,55 @@ typeof SuppressedError === "function" ? SuppressedError : function (error, suppr
 // Default attributes for each chain
 const DefaultChainAttributes = {
     BCH: {
-        blockReward: 6.25,
+        blockReward: 6.25, // Block reward for Bitcoin Cash
         avgBlockTimeInSecs: 600, // Average block time for Bitcoin Cash in seconds
     },
     BTC: {
-        blockReward: 6.25,
+        blockReward: 6.25, // Block reward for Bitcoin
         avgBlockTimeInSecs: 600, // Average block time for Bitcoin in seconds
     },
     ETH: {
-        blockReward: 2,
+        blockReward: 2, // Block reward for Ethereum
         avgBlockTimeInSecs: 13, // Average block time for Ethereum in seconds
     },
     AVAX: {
-        blockReward: 2,
+        blockReward: 2, // Block reward for Avalanche
         avgBlockTimeInSecs: 3, // Average block time for Avalanche in seconds
     },
     LTC: {
-        blockReward: 12.5,
+        blockReward: 12.5, // Block reward for Litecoin
         avgBlockTimeInSecs: 150, // Average block time for Litecoin in seconds
     },
     DOGE: {
-        blockReward: 10000,
+        blockReward: 10000, // Block reward for Dogecoin
         avgBlockTimeInSecs: 60, // Average block time for Dogecoin in seconds
     },
     GAIA: {
-        blockReward: 0,
+        blockReward: 0, // No block reward for Gaia
         avgBlockTimeInSecs: 6, // Average block time for Gaia in seconds
     },
     THOR: {
-        blockReward: 0,
+        blockReward: 0, // No block reward for THORChain
         avgBlockTimeInSecs: 6, // Average block time for THORChain in seconds
     },
     BSC: {
-        blockReward: 0,
+        blockReward: 0, // No block reward for Binance Smart Chain
         avgBlockTimeInSecs: 3, // Average block time for Binance Smart Chain in seconds
     },
     MAYA: {
-        blockReward: 0,
+        blockReward: 0, // No block reward for MAYAChain
         avgBlockTimeInSecs: 6, // Average block time for MAYAChain in seconds
     },
     BASE: {
-        blockReward: 0,
+        blockReward: 0, // No block reward for base
         avgBlockTimeInSecs: 2, // Average block time for Base in seconds
     },
     XRP: {
-        blockReward: 0,
+        blockReward: 0, // No block reward for xrp
         avgBlockTimeInSecs: 4, // Average block time for xrp in seconds
     },
     SOL: {
-        blockReward: 0,
+        blockReward: 0, // No block reward for sol
         avgBlockTimeInSecs: 0.4, // Average block time for sol in seconds
     },
 };
@@ -1256,8 +1256,8 @@ class ThorchainQuery {
      * @param quoteSwapParams - Input parameters for the swap quote.
      * @returns Transaction details including memo, address, fees, etc.
      */
-    quoteSwap({ fromAsset, destinationAsset, amount, destinationAddress, streamingInterval, streamingQuantity, liquidityToleranceBps, toleranceBps, affiliateBps, affiliateAddress, height, }) {
-        return __awaiter(this, void 0, void 0, function* () {
+    quoteSwap(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ fromAsset, destinationAsset, amount, destinationAddress, streamingInterval, streamingQuantity, liquidityToleranceBps, toleranceBps, affiliateBps, affiliateAddress, height, }) {
             // Validates swap and pushes error if there is one
             const errors = [];
             const error = yield this.validateAmount(amount);
@@ -1423,7 +1423,7 @@ class ThorchainQuery {
         return __awaiter(this, void 0, void 0, function* () {
             // Return the fees converted to the specified asset
             return {
-                asset: fees.asset,
+                asset: fees.asset, // Shouldn't be asset?
                 // swapFee: await this.convert(fees.swapFee, asset),
                 outboundFee: yield this.convert(fees.outboundFee, asset),
                 affiliateFee: yield this.convert(fees.affiliateFee, asset),
@@ -1672,34 +1672,34 @@ class ThorchainQuery {
             const assetOutbound = calcOutboundFee(params.asset, inboundDetails);
             // Create an EstimateWithdrawLP object
             const estimateLP = {
-                assetAddress: memberDetail.position.asset_address,
-                runeAddress: memberDetail.position.rune_address,
-                slipPercent: slip.times(100),
+                assetAddress: memberDetail.position.asset_address, // Address for the asset
+                runeAddress: memberDetail.position.rune_address, // Address for the rune
+                slipPercent: slip.times(100), // Slip percentage
                 inbound: {
                     minToSend: {
                         // Minimum amount to send
-                        rune: dustValues.rune,
-                        asset: dustValues.asset,
+                        rune: dustValues.rune, // Rune amount
+                        asset: dustValues.asset, // Asset amount
                         total: (yield this.convert(dustValues.asset, AssetRuneNative)).plus(dustValues.rune), // Total amount
                     },
                     fees: {
                         // Inbound fees
-                        rune: runeInbound,
-                        asset: assetInbound,
+                        rune: runeInbound, // Rune fees
+                        asset: assetInbound, // Asset fees
                         total: (yield this.convert(assetInbound, AssetRuneNative)).plus(runeInbound), // Total fees
                     },
                 },
                 outboundFee: {
                     // Outbound fees
-                    asset: assetOutbound,
-                    rune: runeOutbound,
+                    asset: assetOutbound, // Asset fees
+                    rune: runeOutbound, // Rune fees
                     total: (yield this.convert(assetOutbound, AssetRuneNative)).plus(runeOutbound), // Total fees
                 },
-                assetAmount: poolShare.assetShare,
-                runeAmount: poolShare.runeShare,
-                lpGrowth: memberDetail.lpGrowth,
-                estimatedWaitSeconds: waitTimeSeconds,
-                impermanentLossProtection: memberDetail.impermanentLossProtection,
+                assetAmount: poolShare.assetShare, // Asset amount
+                runeAmount: poolShare.runeShare, // Rune amount
+                lpGrowth: memberDetail.lpGrowth, // LP growth
+                estimatedWaitSeconds: waitTimeSeconds, // Estimated wait time in seconds
+                impermanentLossProtection: memberDetail.impermanentLossProtection, // Impermanent loss protection
                 assetPool: assetPool.thornodeDetails.asset, // Asset pool
             };
             return estimateLP; // Return the EstimateWithdrawLP object
@@ -1836,7 +1836,7 @@ class ThorchainQuery {
                 // Affiliate fee
                 new CryptoAmount(baseAmount(depositQuote.fees.affiliate), addAmount.asset), // Convert to base amount
                 assetDecimals),
-                asset: feeAsset,
+                asset: feeAsset, // Asset fee
                 outbound: getCryptoAmountWithNotation(
                 // Outbound fee
                 new CryptoAmount(baseAmount(depositQuote.fees.outbound), feeAsset), // Convert to base amount
@@ -1859,15 +1859,15 @@ class ThorchainQuery {
                 // Estimated deposit value
                 new CryptoAmount(baseAmount(depositQuote.expected_amount_deposit), addAmount.asset), // Convert to base amount
                 assetDecimals),
-                fee: saverFees,
-                expiry: new Date(depositQuote.expiry),
-                toAddress: depositQuote.inbound_address,
-                memo: depositQuote.memo,
-                estimatedWaitTime: depositQuote.inbound_confirmation_seconds || 0,
-                canAddSaver: errors.length === 0,
-                slipBasisPoints: depositQuote.fees.slippage_bps,
-                saverCapFilledPercent,
-                recommendedMinAmountIn: depositQuote.recommended_min_amount_in,
+                fee: saverFees, // Fees
+                expiry: new Date(depositQuote.expiry), // Expiry date
+                toAddress: depositQuote.inbound_address, // Recipient address
+                memo: depositQuote.memo, // Memo
+                estimatedWaitTime: depositQuote.inbound_confirmation_seconds || 0, // Estimated wait time
+                canAddSaver: errors.length === 0, // Can add saver flag
+                slipBasisPoints: depositQuote.fees.slippage_bps, // Slip basis points
+                saverCapFilledPercent, // Saver filled capacity
+                recommendedMinAmountIn: depositQuote.recommended_min_amount_in, // Recommended minimum amount in
                 errors, // Errors
             };
             return estimateAddSaver; // Return the EstimateAddSaver object
@@ -1894,27 +1894,27 @@ class ThorchainQuery {
                     errors.push(checkPositon.errors[i]);
                 }
                 return {
-                    dustAmount: new AssetCryptoAmount(baseAmount(0), getChainAsset(withdrawParams.asset.chain)),
-                    dustThreshold: new AssetCryptoAmount(baseAmount(0), getChainAsset(withdrawParams.asset.chain)),
+                    dustAmount: new AssetCryptoAmount(baseAmount(0), getChainAsset(withdrawParams.asset.chain)), // Dust amount
+                    dustThreshold: new AssetCryptoAmount(baseAmount(0), getChainAsset(withdrawParams.asset.chain)), // Dust threshold
                     expectedAssetAmount: new CryptoAmount(// Expected asset amount
                     assetToBase(assetAmount(checkPositon.redeemableValue.assetAmount.amount())), // Convert to base amount
                     withdrawParams.asset),
                     fee: {
-                        affiliate: new CryptoAmount(assetToBase(assetAmount(0)), withdrawParams.asset),
-                        asset: withdrawParams.asset,
-                        liquidity: new CryptoAmount(baseAmount(0), withdrawParams.asset),
+                        affiliate: new CryptoAmount(assetToBase(assetAmount(0)), withdrawParams.asset), // Affiliate fee
+                        asset: withdrawParams.asset, // Asset
+                        liquidity: new CryptoAmount(baseAmount(0), withdrawParams.asset), // Liquidity fee
                         outbound: new CryptoAmount(// Outbound fee
                         assetToBase(assetAmount(calcOutboundFee(withdrawParams.asset, inboundDetails[withdrawParams.asset.chain]).assetAmount.amount())), withdrawParams.asset),
                         totalBps: 0, // Total basis points
                     },
-                    expiry: new Date(0),
-                    toAddress: '',
-                    memo: '',
-                    inboundDelayBlocks: 0,
-                    inboundDelaySeconds: 0,
-                    outBoundDelayBlocks: 0,
-                    outBoundDelaySeconds: 0,
-                    slipBasisPoints: -1,
+                    expiry: new Date(0), // Expiry date
+                    toAddress: '', // Recipient address
+                    memo: '', // Memo
+                    inboundDelayBlocks: 0, // Number of blocks for inbound delay
+                    inboundDelaySeconds: 0, // Number of seconds for inbound delay
+                    outBoundDelayBlocks: 0, // Number of blocks for outbound delay
+                    outBoundDelaySeconds: 0, // Number of seconds for outbound delay
+                    slipBasisPoints: -1, // Slip basis points (negative value indicates no slip)
                     errors, // Errors array
                 };
             }
@@ -2042,13 +2042,13 @@ class ThorchainQuery {
             const saverGrowth = redeemableAssetAmount.minus(depositAmount).div(depositAmount).times(100);
             // Create and populate a SaversPosition object with the calculated values
             const saversPos = {
-                depositValue: depositAmount,
-                redeemableValue: redeemableAssetAmount,
-                lastAddHeight: Number(savers === null || savers === void 0 ? void 0 : savers.last_add_height),
-                percentageGrowth: saverGrowth.assetAmount.amount().toNumber(),
-                ageInYears: saversAge,
-                ageInDays: saversAge * 365,
-                asset: params.asset,
+                depositValue: depositAmount, // Current deposit value of the saver
+                redeemableValue: redeemableAssetAmount, // Redeemable value of the saver's position
+                lastAddHeight: Number(savers === null || savers === void 0 ? void 0 : savers.last_add_height), // Height at which the last addition was made to the pool
+                percentageGrowth: saverGrowth.assetAmount.amount().toNumber(), // Percentage growth of the saver's position
+                ageInYears: saversAge, // Age of the saver's position in years
+                ageInDays: saversAge * 365, // Age of the saver's position in days
+                asset: params.asset, // Asset of the saver's position
                 errors, // Array of any errors encountered during the calculation
             };
             // Return the SaversPosition object representing the saver's position
@@ -2098,8 +2098,8 @@ class ThorchainQuery {
      * @param loanOpenParams - params needed for the end Point
      * @returns
      */
-    getLoanQuoteOpen({ asset, amount, targetAsset, destination, minOut, affiliateBps, affiliate, height, }) {
-        return __awaiter(this, void 0, void 0, function* () {
+    getLoanQuoteOpen(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ asset, amount, targetAsset, destination, minOut, affiliateBps, affiliate, height, }) {
             const errors = [];
             const loanOpenResp = yield this.thorchainCache.thornode.getLoanQuoteOpen(`${asset.chain}.${asset.symbol}`, amount.baseAmount.amount().toNumber(), `${targetAsset.chain}.${targetAsset.symbol}`, destination, minOut, affiliateBps, affiliate, height);
             const response = JSON.parse(JSON.stringify(loanOpenResp));
@@ -2170,8 +2170,8 @@ class ThorchainQuery {
      * @param loanOpenParams - Parameters needed for the endpoint.
      * @returns A Promise resolving to a LoanOpenQuote.
      */
-    getLoanQuoteClose({ asset, amount, loanAsset, loanOwner, minOut, height, }) {
-        return __awaiter(this, void 0, void 0, function* () {
+    getLoanQuoteClose(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ asset, amount, loanAsset, loanOwner, minOut, height, }) {
             const errors = [];
             // Retrieve loan open response from ThorNode API
             const loanCloseResp = yield this.thorchainCache.thornode.getLoanQuoteClose(`${asset.chain}.${asset.symbol}`, amount.baseAmount.amount().toNumber(), `${loanAsset.chain}.${loanAsset.symbol}`, loanOwner, minOut, height);
@@ -2374,8 +2374,8 @@ class ThorchainQuery {
      * @param {Address[]} params.addresses - List of addresses
      * @returns {SwapsHistory} Swap history
      */
-    getSwapHistory({ addresses }) {
-        return __awaiter(this, void 0, void 0, function* () {
+    getSwapHistory(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ addresses }) {
             const actionsResume = yield this.thorchainCache.midgardQuery.midgardCache.midgard.getActions({
                 address: addresses.join(','),
                 type: 'swap',
@@ -2430,8 +2430,8 @@ class ThorchainQuery {
      * @param {TradeAssetUnitsParams} params Get trade asset unit params
      * @returns {TradeAssetUnits} Returns the total units and depth of a trade asset
      */
-    getTradeAssetUnits({ asset, height }) {
-        return __awaiter(this, void 0, void 0, function* () {
+    getTradeAssetUnits(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ asset, height }) {
             const { units, depth } = yield this.thorchainCache.thornode.getTradeAssetUnits(assetToString(asset), height);
             const decimals = yield this.thorchainCache.midgardQuery.getDecimalForAsset(asset);
             return {
@@ -2449,7 +2449,7 @@ class ThorchainQuery {
     getTradeAssetsUnits(params) {
         return __awaiter(this, void 0, void 0, function* () {
             const tradeAssetsUnits = yield this.thorchainCache.thornode.getTradeAssetsUnits(params === null || params === void 0 ? void 0 : params.height);
-            const parseData = ({ asset, units, depth }) => __awaiter(this, void 0, void 0, function* () {
+            const parseData = (_a) => __awaiter(this, [_a], void 0, function* ({ asset, units, depth }) {
                 const tradeAsset = assetFromStringEx(asset);
                 const decimals = yield this.thorchainCache.midgardQuery.getDecimalForAsset(tradeAsset);
                 return {
@@ -2466,8 +2466,8 @@ class ThorchainQuery {
      * @param {TradeAssetsUnitsParams} params Get trade asset unit params
      * @returns {TradeAssetUnits[]} Returns the total units and depth for each trade asset
      */
-    getAddressTradeAccounts({ address, height, }) {
-        return __awaiter(this, void 0, void 0, function* () {
+    getAddressTradeAccounts(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ address, height, }) {
             const account = yield this.thorchainCache.thornode.getTradeAssetAccount(address, height);
             const parseData = (tradeAssetInfo) => __awaiter(this, void 0, void 0, function* () {
                 const asset = assetFromStringEx(tradeAssetInfo.asset);
@@ -2488,8 +2488,8 @@ class ThorchainQuery {
      * @param {number} height Optional - Block height
      * @returns Returns all trade accounts for an asset
      */
-    getTradeAssetAccounts({ asset, height }) {
-        return __awaiter(this, void 0, void 0, function* () {
+    getTradeAssetAccounts(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ asset, height }) {
             const accounts = yield this.thorchainCache.thornode.getTradeAssetAccounts(assetToString(asset), height);
             const decimals = yield this.thorchainCache.midgardQuery.getDecimalForAsset(asset);
             return accounts.map((account) => {
@@ -2541,8 +2541,8 @@ class ThorchainQuery {
      * @param {RunePoolProviderParams} params Get Rune pool provider position params
      * @returns {RunePoolProvider} Rune pool provider position
      */
-    getRunePoolProvider({ address, height }) {
-        return __awaiter(this, void 0, void 0, function* () {
+    getRunePoolProvider(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ address, height }) {
             const position = yield this.thorchainCache.thornode.getRunePoolProvider(address, height);
             return {
                 address: position.rune_address,
@@ -2763,8 +2763,8 @@ class TransactionStage {
      * @param progress - Transaction progress object.
      */
     checkSwapProgress(txData, progress) {
-        var _a, _b, _c, _d;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d;
             if (progress.inboundObserved) {
                 // Extract memo fields
                 const memo = (_a = txData.tx.tx.memo) !== null && _a !== void 0 ? _a : '';
@@ -2792,7 +2792,7 @@ class TransactionStage {
                     status: swapStatus,
                     expectedOutBlock,
                     expectedOutDate,
-                    expectedAmountOut: minimumAmountOut,
+                    expectedAmountOut: minimumAmountOut, // TODO call estimateSwap()
                     confirmations,
                     minimumAmountOut,
                     affliateFee,
@@ -2837,8 +2837,8 @@ class TransactionStage {
      * @returns Promise<TXProgress> - Transaction progress object.
      */
     determineObserved(txData) {
-        var _a, _b, _c, _d;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d;
             const progress = {
                 txType: TxType.Unknown,
             };
@@ -2874,7 +2874,7 @@ class TransactionStage {
                     : yield this.blockToDate(assetIn.chain, txData);
                 progress.inboundObserved = {
                     status,
-                    date: dateObserved,
+                    date: dateObserved, // date observed?
                     block,
                     expectedConfirmationBlock: finalizeBlock,
                     expectedConfirmationDate,
@@ -2892,8 +2892,8 @@ class TransactionStage {
      * @param progress - Transaction progress object.
      */
     checkAddLpProgress(txData, progress) {
-        var _a;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a;
             if (progress.inboundObserved) {
                 // Extract memo fields
                 const memo = (_a = txData.tx.tx.memo) !== null && _a !== void 0 ? _a : '';
@@ -2924,8 +2924,8 @@ class TransactionStage {
      * @param progress - Transaction progress object.
      */
     checkWithdrawLpProgress(txData, progress) {
-        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b;
             if (progress.inboundObserved) {
                 // Extract memo fields
                 const memo = (_a = txData.tx.tx.memo) !== null && _a !== void 0 ? _a : '';
@@ -2994,8 +2994,8 @@ class TransactionStage {
      * @param progress - Transaction progress object.
      */
     checkWithdrawSaverProgress(txData, progress) {
-        var _a;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a;
             if (progress.inboundObserved) {
                 // Extract memo fields
                 const memo = (_a = txData.tx.tx.memo) !== null && _a !== void 0 ? _a : '';

package/lib/index.js

@@ -49,55 +49,55 @@ typeof SuppressedError === "function" ? SuppressedError : function (error, suppr
 // Default attributes for each chain
 const DefaultChainAttributes = {
     BCH: {
-        blockReward: 6.25,
+        blockReward: 6.25, // Block reward for Bitcoin Cash
         avgBlockTimeInSecs: 600, // Average block time for Bitcoin Cash in seconds
     },
     BTC: {
-        blockReward: 6.25,
+        blockReward: 6.25, // Block reward for Bitcoin
         avgBlockTimeInSecs: 600, // Average block time for Bitcoin in seconds
     },
     ETH: {
-        blockReward: 2,
+        blockReward: 2, // Block reward for Ethereum
         avgBlockTimeInSecs: 13, // Average block time for Ethereum in seconds
     },
     AVAX: {
-        blockReward: 2,
+        blockReward: 2, // Block reward for Avalanche
         avgBlockTimeInSecs: 3, // Average block time for Avalanche in seconds
     },
     LTC: {
-        blockReward: 12.5,
+        blockReward: 12.5, // Block reward for Litecoin
         avgBlockTimeInSecs: 150, // Average block time for Litecoin in seconds
     },
     DOGE: {
-        blockReward: 10000,
+        blockReward: 10000, // Block reward for Dogecoin
         avgBlockTimeInSecs: 60, // Average block time for Dogecoin in seconds
     },
     GAIA: {
-        blockReward: 0,
+        blockReward: 0, // No block reward for Gaia
         avgBlockTimeInSecs: 6, // Average block time for Gaia in seconds
     },
     THOR: {
-        blockReward: 0,
+        blockReward: 0, // No block reward for THORChain
         avgBlockTimeInSecs: 6, // Average block time for THORChain in seconds
     },
     BSC: {
-        blockReward: 0,
+        blockReward: 0, // No block reward for Binance Smart Chain
         avgBlockTimeInSecs: 3, // Average block time for Binance Smart Chain in seconds
     },
     MAYA: {
-        blockReward: 0,
+        blockReward: 0, // No block reward for MAYAChain
         avgBlockTimeInSecs: 6, // Average block time for MAYAChain in seconds
     },
     BASE: {
-        blockReward: 0,
+        blockReward: 0, // No block reward for base
         avgBlockTimeInSecs: 2, // Average block time for Base in seconds
     },
     XRP: {
-        blockReward: 0,
+        blockReward: 0, // No block reward for xrp
         avgBlockTimeInSecs: 4, // Average block time for xrp in seconds
     },
     SOL: {
-        blockReward: 0,
+        blockReward: 0, // No block reward for sol
         avgBlockTimeInSecs: 0.4, // Average block time for sol in seconds
     },
 };
@@ -1264,8 +1264,8 @@ class ThorchainQuery {
      * @param quoteSwapParams - Input parameters for the swap quote.
      * @returns Transaction details including memo, address, fees, etc.
      */
-    quoteSwap({ fromAsset, destinationAsset, amount, destinationAddress, streamingInterval, streamingQuantity, liquidityToleranceBps, toleranceBps, affiliateBps, affiliateAddress, height, }) {
-        return __awaiter(this, void 0, void 0, function* () {
+    quoteSwap(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ fromAsset, destinationAsset, amount, destinationAddress, streamingInterval, streamingQuantity, liquidityToleranceBps, toleranceBps, affiliateBps, affiliateAddress, height, }) {
             // Validates swap and pushes error if there is one
             const errors = [];
             const error = yield this.validateAmount(amount);
@@ -1431,7 +1431,7 @@ class ThorchainQuery {
         return __awaiter(this, void 0, void 0, function* () {
             // Return the fees converted to the specified asset
             return {
-                asset: fees.asset,
+                asset: fees.asset, // Shouldn't be asset?
                 // swapFee: await this.convert(fees.swapFee, asset),
                 outboundFee: yield this.convert(fees.outboundFee, asset),
                 affiliateFee: yield this.convert(fees.affiliateFee, asset),
@@ -1680,34 +1680,34 @@ class ThorchainQuery {
             const assetOutbound = calcOutboundFee(params.asset, inboundDetails);
             // Create an EstimateWithdrawLP object
             const estimateLP = {
-                assetAddress: memberDetail.position.asset_address,
-                runeAddress: memberDetail.position.rune_address,
-                slipPercent: slip.times(100),
+                assetAddress: memberDetail.position.asset_address, // Address for the asset
+                runeAddress: memberDetail.position.rune_address, // Address for the rune
+                slipPercent: slip.times(100), // Slip percentage
                 inbound: {
                     minToSend: {
                         // Minimum amount to send
-                        rune: dustValues.rune,
-                        asset: dustValues.asset,
+                        rune: dustValues.rune, // Rune amount
+                        asset: dustValues.asset, // Asset amount
                         total: (yield this.convert(dustValues.asset, AssetRuneNative)).plus(dustValues.rune), // Total amount
                     },
                     fees: {
                         // Inbound fees
-                        rune: runeInbound,
-                        asset: assetInbound,
+                        rune: runeInbound, // Rune fees
+                        asset: assetInbound, // Asset fees
                         total: (yield this.convert(assetInbound, AssetRuneNative)).plus(runeInbound), // Total fees
                     },
                 },
                 outboundFee: {
                     // Outbound fees
-                    asset: assetOutbound,
-                    rune: runeOutbound,
+                    asset: assetOutbound, // Asset fees
+                    rune: runeOutbound, // Rune fees
                     total: (yield this.convert(assetOutbound, AssetRuneNative)).plus(runeOutbound), // Total fees
                 },
-                assetAmount: poolShare.assetShare,
-                runeAmount: poolShare.runeShare,
-                lpGrowth: memberDetail.lpGrowth,
-                estimatedWaitSeconds: waitTimeSeconds,
-                impermanentLossProtection: memberDetail.impermanentLossProtection,
+                assetAmount: poolShare.assetShare, // Asset amount
+                runeAmount: poolShare.runeShare, // Rune amount
+                lpGrowth: memberDetail.lpGrowth, // LP growth
+                estimatedWaitSeconds: waitTimeSeconds, // Estimated wait time in seconds
+                impermanentLossProtection: memberDetail.impermanentLossProtection, // Impermanent loss protection
                 assetPool: assetPool.thornodeDetails.asset, // Asset pool
             };
             return estimateLP; // Return the EstimateWithdrawLP object
@@ -1844,7 +1844,7 @@ class ThorchainQuery {
                 // Affiliate fee
                 new xchainUtil.CryptoAmount(xchainUtil.baseAmount(depositQuote.fees.affiliate), addAmount.asset), // Convert to base amount
                 assetDecimals),
-                asset: feeAsset,
+                asset: feeAsset, // Asset fee
                 outbound: getCryptoAmountWithNotation(
                 // Outbound fee
                 new xchainUtil.CryptoAmount(xchainUtil.baseAmount(depositQuote.fees.outbound), feeAsset), // Convert to base amount
@@ -1867,15 +1867,15 @@ class ThorchainQuery {
                 // Estimated deposit value
                 new xchainUtil.CryptoAmount(xchainUtil.baseAmount(depositQuote.expected_amount_deposit), addAmount.asset), // Convert to base amount
                 assetDecimals),
-                fee: saverFees,
-                expiry: new Date(depositQuote.expiry),
-                toAddress: depositQuote.inbound_address,
-                memo: depositQuote.memo,
-                estimatedWaitTime: depositQuote.inbound_confirmation_seconds || 0,
-                canAddSaver: errors.length === 0,
-                slipBasisPoints: depositQuote.fees.slippage_bps,
-                saverCapFilledPercent,
-                recommendedMinAmountIn: depositQuote.recommended_min_amount_in,
+                fee: saverFees, // Fees
+                expiry: new Date(depositQuote.expiry), // Expiry date
+                toAddress: depositQuote.inbound_address, // Recipient address
+                memo: depositQuote.memo, // Memo
+                estimatedWaitTime: depositQuote.inbound_confirmation_seconds || 0, // Estimated wait time
+                canAddSaver: errors.length === 0, // Can add saver flag
+                slipBasisPoints: depositQuote.fees.slippage_bps, // Slip basis points
+                saverCapFilledPercent, // Saver filled capacity
+                recommendedMinAmountIn: depositQuote.recommended_min_amount_in, // Recommended minimum amount in
                 errors, // Errors
             };
             return estimateAddSaver; // Return the EstimateAddSaver object
@@ -1902,27 +1902,27 @@ class ThorchainQuery {
                     errors.push(checkPositon.errors[i]);
                 }
                 return {
-                    dustAmount: new xchainUtil.AssetCryptoAmount(xchainUtil.baseAmount(0), getChainAsset(withdrawParams.asset.chain)),
-                    dustThreshold: new xchainUtil.AssetCryptoAmount(xchainUtil.baseAmount(0), getChainAsset(withdrawParams.asset.chain)),
+                    dustAmount: new xchainUtil.AssetCryptoAmount(xchainUtil.baseAmount(0), getChainAsset(withdrawParams.asset.chain)), // Dust amount
+                    dustThreshold: new xchainUtil.AssetCryptoAmount(xchainUtil.baseAmount(0), getChainAsset(withdrawParams.asset.chain)), // Dust threshold
                     expectedAssetAmount: new xchainUtil.CryptoAmount(// Expected asset amount
                     xchainUtil.assetToBase(xchainUtil.assetAmount(checkPositon.redeemableValue.assetAmount.amount())), // Convert to base amount
                     withdrawParams.asset),
                     fee: {
-                        affiliate: new xchainUtil.CryptoAmount(xchainUtil.assetToBase(xchainUtil.assetAmount(0)), withdrawParams.asset),
-                        asset: withdrawParams.asset,
-                        liquidity: new xchainUtil.CryptoAmount(xchainUtil.baseAmount(0), withdrawParams.asset),
+                        affiliate: new xchainUtil.CryptoAmount(xchainUtil.assetToBase(xchainUtil.assetAmount(0)), withdrawParams.asset), // Affiliate fee
+                        asset: withdrawParams.asset, // Asset
+                        liquidity: new xchainUtil.CryptoAmount(xchainUtil.baseAmount(0), withdrawParams.asset), // Liquidity fee
                         outbound: new xchainUtil.CryptoAmount(// Outbound fee
                         xchainUtil.assetToBase(xchainUtil.assetAmount(calcOutboundFee(withdrawParams.asset, inboundDetails[withdrawParams.asset.chain]).assetAmount.amount())), withdrawParams.asset),
                         totalBps: 0, // Total basis points
                     },
-                    expiry: new Date(0),
-                    toAddress: '',
-                    memo: '',
-                    inboundDelayBlocks: 0,
-                    inboundDelaySeconds: 0,
-                    outBoundDelayBlocks: 0,
-                    outBoundDelaySeconds: 0,
-                    slipBasisPoints: -1,
+                    expiry: new Date(0), // Expiry date
+                    toAddress: '', // Recipient address
+                    memo: '', // Memo
+                    inboundDelayBlocks: 0, // Number of blocks for inbound delay
+                    inboundDelaySeconds: 0, // Number of seconds for inbound delay
+                    outBoundDelayBlocks: 0, // Number of blocks for outbound delay
+                    outBoundDelaySeconds: 0, // Number of seconds for outbound delay
+                    slipBasisPoints: -1, // Slip basis points (negative value indicates no slip)
                     errors, // Errors array
                 };
             }
@@ -2050,13 +2050,13 @@ class ThorchainQuery {
             const saverGrowth = redeemableAssetAmount.minus(depositAmount).div(depositAmount).times(100);
             // Create and populate a SaversPosition object with the calculated values
             const saversPos = {
-                depositValue: depositAmount,
-                redeemableValue: redeemableAssetAmount,
-                lastAddHeight: Number(savers === null || savers === void 0 ? void 0 : savers.last_add_height),
-                percentageGrowth: saverGrowth.assetAmount.amount().toNumber(),
-                ageInYears: saversAge,
-                ageInDays: saversAge * 365,
-                asset: params.asset,
+                depositValue: depositAmount, // Current deposit value of the saver
+                redeemableValue: redeemableAssetAmount, // Redeemable value of the saver's position
+                lastAddHeight: Number(savers === null || savers === void 0 ? void 0 : savers.last_add_height), // Height at which the last addition was made to the pool
+                percentageGrowth: saverGrowth.assetAmount.amount().toNumber(), // Percentage growth of the saver's position
+                ageInYears: saversAge, // Age of the saver's position in years
+                ageInDays: saversAge * 365, // Age of the saver's position in days
+                asset: params.asset, // Asset of the saver's position
                 errors, // Array of any errors encountered during the calculation
             };
             // Return the SaversPosition object representing the saver's position
@@ -2106,8 +2106,8 @@ class ThorchainQuery {
      * @param loanOpenParams - params needed for the end Point
      * @returns
      */
-    getLoanQuoteOpen({ asset, amount, targetAsset, destination, minOut, affiliateBps, affiliate, height, }) {
-        return __awaiter(this, void 0, void 0, function* () {
+    getLoanQuoteOpen(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ asset, amount, targetAsset, destination, minOut, affiliateBps, affiliate, height, }) {
             const errors = [];
             const loanOpenResp = yield this.thorchainCache.thornode.getLoanQuoteOpen(`${asset.chain}.${asset.symbol}`, amount.baseAmount.amount().toNumber(), `${targetAsset.chain}.${targetAsset.symbol}`, destination, minOut, affiliateBps, affiliate, height);
             const response = JSON.parse(JSON.stringify(loanOpenResp));
@@ -2178,8 +2178,8 @@ class ThorchainQuery {
      * @param loanOpenParams - Parameters needed for the endpoint.
      * @returns A Promise resolving to a LoanOpenQuote.
      */
-    getLoanQuoteClose({ asset, amount, loanAsset, loanOwner, minOut, height, }) {
-        return __awaiter(this, void 0, void 0, function* () {
+    getLoanQuoteClose(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ asset, amount, loanAsset, loanOwner, minOut, height, }) {
             const errors = [];
             // Retrieve loan open response from ThorNode API
             const loanCloseResp = yield this.thorchainCache.thornode.getLoanQuoteClose(`${asset.chain}.${asset.symbol}`, amount.baseAmount.amount().toNumber(), `${loanAsset.chain}.${loanAsset.symbol}`, loanOwner, minOut, height);
@@ -2382,8 +2382,8 @@ class ThorchainQuery {
      * @param {Address[]} params.addresses - List of addresses
      * @returns {SwapsHistory} Swap history
      */
-    getSwapHistory({ addresses }) {
-        return __awaiter(this, void 0, void 0, function* () {
+    getSwapHistory(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ addresses }) {
             const actionsResume = yield this.thorchainCache.midgardQuery.midgardCache.midgard.getActions({
                 address: addresses.join(','),
                 type: 'swap',
@@ -2438,8 +2438,8 @@ class ThorchainQuery {
      * @param {TradeAssetUnitsParams} params Get trade asset unit params
      * @returns {TradeAssetUnits} Returns the total units and depth of a trade asset
      */
-    getTradeAssetUnits({ asset, height }) {
-        return __awaiter(this, void 0, void 0, function* () {
+    getTradeAssetUnits(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ asset, height }) {
             const { units, depth } = yield this.thorchainCache.thornode.getTradeAssetUnits(xchainUtil.assetToString(asset), height);
             const decimals = yield this.thorchainCache.midgardQuery.getDecimalForAsset(asset);
             return {
@@ -2457,7 +2457,7 @@ class ThorchainQuery {
     getTradeAssetsUnits(params) {
         return __awaiter(this, void 0, void 0, function* () {
             const tradeAssetsUnits = yield this.thorchainCache.thornode.getTradeAssetsUnits(params === null || params === void 0 ? void 0 : params.height);
-            const parseData = ({ asset, units, depth }) => __awaiter(this, void 0, void 0, function* () {
+            const parseData = (_a) => __awaiter(this, [_a], void 0, function* ({ asset, units, depth }) {
                 const tradeAsset = xchainUtil.assetFromStringEx(asset);
                 const decimals = yield this.thorchainCache.midgardQuery.getDecimalForAsset(tradeAsset);
                 return {
@@ -2474,8 +2474,8 @@ class ThorchainQuery {
      * @param {TradeAssetsUnitsParams} params Get trade asset unit params
      * @returns {TradeAssetUnits[]} Returns the total units and depth for each trade asset
      */
-    getAddressTradeAccounts({ address, height, }) {
-        return __awaiter(this, void 0, void 0, function* () {
+    getAddressTradeAccounts(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ address, height, }) {
             const account = yield this.thorchainCache.thornode.getTradeAssetAccount(address, height);
             const parseData = (tradeAssetInfo) => __awaiter(this, void 0, void 0, function* () {
                 const asset = xchainUtil.assetFromStringEx(tradeAssetInfo.asset);
@@ -2496,8 +2496,8 @@ class ThorchainQuery {
      * @param {number} height Optional - Block height
      * @returns Returns all trade accounts for an asset
      */
-    getTradeAssetAccounts({ asset, height }) {
-        return __awaiter(this, void 0, void 0, function* () {
+    getTradeAssetAccounts(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ asset, height }) {
             const accounts = yield this.thorchainCache.thornode.getTradeAssetAccounts(xchainUtil.assetToString(asset), height);
             const decimals = yield this.thorchainCache.midgardQuery.getDecimalForAsset(asset);
             return accounts.map((account) => {
@@ -2549,8 +2549,8 @@ class ThorchainQuery {
      * @param {RunePoolProviderParams} params Get Rune pool provider position params
      * @returns {RunePoolProvider} Rune pool provider position
      */
-    getRunePoolProvider({ address, height }) {
-        return __awaiter(this, void 0, void 0, function* () {
+    getRunePoolProvider(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ address, height }) {
             const position = yield this.thorchainCache.thornode.getRunePoolProvider(address, height);
             return {
                 address: position.rune_address,
@@ -2771,8 +2771,8 @@ class TransactionStage {
      * @param progress - Transaction progress object.
      */
     checkSwapProgress(txData, progress) {
-        var _a, _b, _c, _d;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d;
             if (progress.inboundObserved) {
                 // Extract memo fields
                 const memo = (_a = txData.tx.tx.memo) !== null && _a !== void 0 ? _a : '';
@@ -2800,7 +2800,7 @@ class TransactionStage {
                     status: swapStatus,
                     expectedOutBlock,
                     expectedOutDate,
-                    expectedAmountOut: minimumAmountOut,
+                    expectedAmountOut: minimumAmountOut, // TODO call estimateSwap()
                     confirmations,
                     minimumAmountOut,
                     affliateFee,
@@ -2845,8 +2845,8 @@ class TransactionStage {
      * @returns Promise<TXProgress> - Transaction progress object.
      */
     determineObserved(txData) {
-        var _a, _b, _c, _d;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d;
             const progress = {
                 txType: exports.TxType.Unknown,
             };
@@ -2882,7 +2882,7 @@ class TransactionStage {
                     : yield this.blockToDate(assetIn.chain, txData);
                 progress.inboundObserved = {
                     status,
-                    date: dateObserved,
+                    date: dateObserved, // date observed?
                     block,
                     expectedConfirmationBlock: finalizeBlock,
                     expectedConfirmationDate,
@@ -2900,8 +2900,8 @@ class TransactionStage {
      * @param progress - Transaction progress object.
      */
     checkAddLpProgress(txData, progress) {
-        var _a;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a;
             if (progress.inboundObserved) {
                 // Extract memo fields
                 const memo = (_a = txData.tx.tx.memo) !== null && _a !== void 0 ? _a : '';
@@ -2932,8 +2932,8 @@ class TransactionStage {
      * @param progress - Transaction progress object.
      */
     checkWithdrawLpProgress(txData, progress) {
-        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b;
             if (progress.inboundObserved) {
                 // Extract memo fields
                 const memo = (_a = txData.tx.tx.memo) !== null && _a !== void 0 ? _a : '';
@@ -3002,8 +3002,8 @@ class TransactionStage {
      * @param progress - Transaction progress object.
      */
     checkWithdrawSaverProgress(txData, progress) {
-        var _a;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a;
             if (progress.inboundObserved) {
                 // Extract memo fields
                 const memo = (_a = txData.tx.tx.memo) !== null && _a !== void 0 ? _a : '';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xchainjs/xchain-thorchain-query",
-  "version": "2.0.7",
+  "version": "2.0.8",
   "license": "MIT",
   "description": "Thorchain query module that is responsible for estimating swap calculations and add/remove liquidity for thorchain ",
   "keywords": [
@@ -33,10 +33,10 @@
     "postversion": "git push --follow-tags"
   },
   "dependencies": {
-    "@xchainjs/xchain-client": "2.0.5",
-    "@xchainjs/xchain-midgard-query": "2.0.5",
-    "@xchainjs/xchain-thornode": "1.0.4",
-    "@xchainjs/xchain-util": "2.0.3",
+    "@xchainjs/xchain-client": "2.0.6",
+    "@xchainjs/xchain-midgard-query": "2.0.6",
+    "@xchainjs/xchain-thornode": "1.0.5",
+    "@xchainjs/xchain-util": "2.0.4",
     "axios": "1.8.4",
     "axios-retry": "3.2.5",
     "bignumber.js": "^9.0.0"