@xchainjs/xchain-thorchain-query 0.4.5 → 0.4.7

package/lib/index.esm.js

@@ -543,6 +543,25 @@ class Midgard {
             throw Error(`Midgard not responding`);
         });
     }
+    /**
+     * Function to return member details based on valid liquidity position
+     * @param address - query can also be multiple addresses should be separated by comma
+     * @returns - object type of Member Detail
+     */
+    getSavers(address) {
+        return __awaiter(this, void 0, void 0, function* () {
+            for (const api of this.midgardApis) {
+                try {
+                    const saverDetails = (yield api.getSaverDetail(address)).data;
+                    return saverDetails;
+                }
+                catch (e) {
+                    //console.error(e)
+                }
+            }
+            throw Error(`Midgard not responding`);
+        });
+    }
     /**
      * Function to return pool statistics for a particular asset
      * @param asset - asset string to query its pool stats
@@ -960,11 +979,11 @@ class Thornode {
      * @param height - block height
      * @returns quotes swap object response
      */
-    getSwapQuote(fromAsset, toAsset, amount, destinationAddress, fromAddress, toleranceBps, affiliateBps, affiliate, height) {
+    getSwapQuote(fromAsset, toAsset, amount, destinationAddress, streamingInterval, streamingQuantity, fromAddress, toleranceBps, affiliateBps, affiliate, height) {
         return __awaiter(this, void 0, void 0, function* () {
             for (const api of this.quoteApi) {
                 try {
-                    const resp = (yield api.quoteswap(height, fromAsset, toAsset, amount, destinationAddress, fromAddress, toleranceBps, affiliateBps, affiliate)).data;
+                    const resp = (yield api.quoteswap(height, fromAsset, toAsset, amount, destinationAddress, streamingInterval, streamingQuantity, fromAddress, toleranceBps, affiliateBps, affiliate)).data;
                     return resp;
                 }
                 catch (e) {
@@ -1376,26 +1395,23 @@ class ThorchainQuery {
      * @param quoteSwapParams -  input params
      * @returns
      */
-    quoteSwap({ fromAsset, destinationAsset, amount, destinationAddress, fromAddress, toleranceBps, interfaceID = '555', affiliateBps, affiliateAddress, height, }) {
+    quoteSwap({ fromAsset, destinationAsset, amount, destinationAddress, streamingInterval, streamingQuantity, fromAddress, toleranceBps, affiliateBps, affiliateAddress, height, }) {
         return __awaiter(this, void 0, void 0, function* () {
             const errors = [];
             const fromAssetString = assetToString(fromAsset);
             const toAssetString = assetToString(destinationAsset);
             const inputAmount = getBaseAmountWithDiffDecimals(amount, 8);
             // fetch quote
-            const swapQuote = yield this.thorchainCache.thornode.getSwapQuote(fromAssetString, toAssetString, inputAmount.toNumber(), destinationAddress, fromAddress, toleranceBps, affiliateBps, affiliateAddress, height);
-            // error handling
+            const swapQuote = yield this.thorchainCache.thornode.getSwapQuote(fromAssetString, toAssetString, inputAmount.toNumber(), destinationAddress, streamingInterval, streamingQuantity, fromAddress, toleranceBps, affiliateBps, affiliateAddress, height);
+            // error handling for fetch response
             const response = JSON.parse(JSON.stringify(swapQuote));
             if (response.error)
                 errors.push(`Thornode request quote: ${response.error}`);
-            //The recommended minimum inbound amount for this transaction type & inbound asset.
-            // Sending less than this amount could result in failed refunds
-            if (swapQuote.recommended_min_amount_in && inputAmount.toNumber() < +swapQuote.recommended_min_amount_in)
-                errors.push(`Error amount in: ${inputAmount.toNumber()} is less than reccommended Min Amount: ${swapQuote.recommended_min_amount_in}`);
             if (errors.length > 0) {
                 return {
                     memo: ``,
                     toAddress: ``,
+                    dustThreshold: new CryptoAmount(baseAmount(0), AssetRuneNative),
                     expiry: new Date(),
                     txEstimate: {
                         totalFees: {
@@ -1409,14 +1425,29 @@ class ThorchainQuery {
                         inboundConfirmationSeconds: 0,
                         canSwap: false,
                         errors,
+                        netOutputStreaming: new CryptoAmount(baseAmount(0), AssetRuneNative),
+                        maxStreamingQuantity: 0,
+                        outboundDelayBlocks: 0,
+                        streamingSlipBasisPoints: 0,
+                        streamingSwapBlocks: 0,
+                        totalSwapSeconds: 0,
+                        warning: '',
                     },
                 };
             }
-            // Return quote
+            // The recommended minimum inbound amount for this transaction type & inbound asset.
+            // Sending less than this amount could result in failed refunds
             const feeAsset = assetFromStringEx(swapQuote.fees.asset);
+            if (swapQuote.recommended_min_amount_in && inputAmount.toNumber() < +swapQuote.recommended_min_amount_in)
+                errors.push(`Error amount in: ${inputAmount.toNumber()} is less than reccommended Min Amount: ${swapQuote.recommended_min_amount_in}`);
+            // Check to see if memo is undefined
+            if (swapQuote.memo === undefined)
+                errors.push(`Error parsing swap quote: Memo is ${swapQuote.memo}`);
+            // No errors ? and memo is returned ? return quote flag canSwap to true
             const txDetails = {
-                memo: this.constructSwapMemo(`${swapQuote.memo}`, interfaceID),
-                toAddress: `${swapQuote.inbound_address}`,
+                memo: swapQuote.memo ? swapQuote.memo : '',
+                dustThreshold: new CryptoAmount(baseAmount(swapQuote.dust_threshold), fromAsset),
+                toAddress: swapQuote.inbound_address ? swapQuote.inbound_address : '',
                 expiry: new Date(swapQuote.expiry * 1000),
                 txEstimate: {
                     totalFees: {
@@ -1426,34 +1457,41 @@ class ThorchainQuery {
                     },
                     slipBasisPoints: swapQuote.slippage_bps,
                     netOutput: new CryptoAmount(baseAmount(swapQuote.expected_amount_out), destinationAsset),
+                    netOutputStreaming: new CryptoAmount(baseAmount(swapQuote.expected_amount_out), destinationAsset),
                     outboundDelaySeconds: swapQuote.outbound_delay_seconds,
                     inboundConfirmationSeconds: swapQuote.inbound_confirmation_seconds,
                     recommendedMinAmountIn: swapQuote.recommended_min_amount_in,
-                    canSwap: true,
+                    maxStreamingQuantity: swapQuote.max_streaming_quantity ? swapQuote.max_streaming_quantity : 0,
+                    outboundDelayBlocks: swapQuote.outbound_delay_blocks,
+                    streamingSlipBasisPoints: swapQuote.streaming_slippage_bps,
+                    streamingSwapBlocks: swapQuote.streaming_swap_blocks ? swapQuote.streaming_swap_blocks : 0,
+                    totalSwapSeconds: swapQuote.total_swap_seconds ? swapQuote.total_swap_seconds : 0,
+                    canSwap: !swapQuote.memo || errors.length > 0 ? false : true,
                     errors,
+                    warning: swapQuote.warning,
                 },
             };
             return txDetails;
         });
     }
-    /**
-     *
-     * @param params - swap object
-     * @returns - constructed memo string
-     */
-    constructSwapMemo(memo, interfaceID) {
-        const memoPart = memo.split(':');
-        if (memoPart.length > 3) {
-            memoPart[3] =
-                memoPart[3].length >= 3 ? memoPart[3].substring(0, memoPart[3].length - 3).concat(interfaceID) : interfaceID;
-            let outmemo = '';
-            for (let i = 0; i < memoPart.length; i++) {
-                outmemo = outmemo.concat(`${memoPart[i]}:`);
-            }
-            return outmemo.substring(0, outmemo.length - 1);
-        }
-        return memo;
-    }
+    // /**
+    //  * This is no longer used
+    //  * @param params - swap object
+    //  * @returns - constructed memo string
+    //  */
+    // private constructSwapMemo(memo: string, interfaceID: string): string {
+    //   const memoPart = memo.split(':')
+    //   if (memoPart.length > 3) {
+    //     memoPart[3] =
+    //       memoPart[3].length >= 3 ? memoPart[3].substring(0, memoPart[3].length - 3).concat(interfaceID) : interfaceID
+    //     let outmemo = ''
+    //     for (let i = 0; i < memoPart.length; i++) {
+    //       outmemo = outmemo.concat(`${memoPart[i]}:`)
+    //     }
+    //     return outmemo.substring(0, outmemo.length - 1)
+    //   }
+    //   return memo
+    // }
     /**
      * Works out how long an outbound Tx will be held by THORChain before sending.
      *
@@ -2035,11 +2073,53 @@ class ThorchainQuery {
                 percentageGrowth: saverGrowth.assetAmount.amount().toNumber(),
                 ageInYears: saversAge,
                 ageInDays: saversAge * 365,
+                asset: params.asset,
                 errors,
             };
             return saversPos;
         });
     }
+    getSaverPositions(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const addresses = new Set();
+            params.forEach((param) => addresses.add(param.address));
+            const addressesString = Array.from(addresses).join(',');
+            const saversDetail = yield this.thorchainCache.midgard.getSavers(addressesString);
+            const pools = yield this.thorchainCache.getPools();
+            const inboundDetails = yield this.thorchainCache.getInboundDetails();
+            const errors = [];
+            const saversPositions = [];
+            saversDetail.pools.forEach((saver) => {
+                const asset = assetFromString(saver.pool);
+                if (asset) {
+                    const outboundFee = calcOutboundFee(asset, inboundDetails[asset.chain]);
+                    const convertToBaseEight = getBaseAmountWithDiffDecimals(outboundFee, 8);
+                    if (Number(saver === null || saver === void 0 ? void 0 : saver.assetRedeem) < convertToBaseEight.toNumber())
+                        errors.push(`Unlikely to withdraw balance as outbound fee is greater than redeemable amount`);
+                    const liquidityPool = pools[`${asset.chain}.${asset.ticker}`];
+                    const depositAmount = new CryptoAmount(baseAmount(saver.assetAdded).minus(saver.assetWithdrawn), asset);
+                    const ownerUnits = Number(saver === null || saver === void 0 ? void 0 : saver.saverUnits);
+                    const saverUnits = Number(liquidityPool.pool.saversUnits);
+                    const assetDepth = Number(liquidityPool.pool.saversDepth);
+                    const redeemableValue = (ownerUnits / saverUnits) * assetDepth;
+                    const redeemableAssetAmount = new CryptoAmount(baseAmount(redeemableValue), asset);
+                    const saverGrowth = redeemableAssetAmount.minus(depositAmount).div(depositAmount).times(100);
+                    const saversAge = (Date.now() / 1000 - Number(saver.dateLastAdded)) / (365 * 86400);
+                    saversPositions.push({
+                        depositValue: depositAmount,
+                        redeemableValue: redeemableAssetAmount,
+                        lastAddHeight: -1,
+                        percentageGrowth: saverGrowth.assetAmount.amount().toNumber(),
+                        ageInYears: saversAge,
+                        ageInDays: saversAge * 365,
+                        asset,
+                        errors,
+                    });
+                }
+            });
+            return saversPositions;
+        });
+    }
     getAddSaversEstimateErrors(addAmount) {
         return __awaiter(this, void 0, void 0, function* () {
             const errors = [];