@xchainjs/xchain-thorchain-query 0.2.4 → 0.2.6

package/lib/index.esm.js

@@ -2208,7 +2208,17 @@ class ThorchainQuery {
     estimateAddSaver(addAmount) {
         return __awaiter(this, void 0, void 0, function* () {
             let errors = [];
+            // check for errors before sending quote
             errors = yield this.getAddSaversEstimateErrors(addAmount);
+            // request param amount should always be in 1e8 which is why we pass in adjusted decimals if chain decimals != 8
+            const newAddAmount = addAmount.baseAmount.decimal != 8 ? getBaseAmountWithDiffDecimals(addAmount, 8) : addAmount.baseAmount.amount();
+            // Fetch quote
+            const depositQuote = yield this.thorchainCache.thornode.getSaversDepositQuote(assetToString(addAmount.asset), newAddAmount.toNumber());
+            // error handling
+            const response = JSON.parse(JSON.stringify(depositQuote));
+            if (response.error)
+                errors.push(`Thornode request quote failed: ${response.error}`);
+            // Return errors if there is any
             if (errors.length > 0) {
                 return {
                     assetAmount: addAmount,
@@ -2228,29 +2238,27 @@ class ThorchainQuery {
                     errors,
                 };
             }
-            // request param amount should always be in 1e8 which is why we pass in adjusted decimals if chain decimals != 8
-            const newAddAmount = addAmount.baseAmount.decimal != 8 ? getBaseAmountWithDiffDecimals(addAmount, 8) : addAmount.baseAmount.amount();
-            const depositQuote = yield this.thorchainCache.thornode.getSaversDepositQuote(assetToString(addAmount.asset), newAddAmount.toNumber());
             // Calculate transaction expiry time of the vault address
             const currentDatetime = new Date();
             const minutesToAdd = 15;
             const expiryDatetime = new Date(currentDatetime.getTime() + minutesToAdd * 60000);
+            // Calculate seconds
             const estimatedWait = depositQuote.inbound_confirmation_seconds
                 ? depositQuote.inbound_confirmation_seconds
                 : yield this.confCounting(addAmount);
             const pool = (yield this.thorchainCache.getPoolForAsset(addAmount.asset)).pool;
-            if (addAmount.baseAmount.lte(depositQuote.expected_amount_out))
-                errors.push(`Amount being added to savers can't pay for fees`);
+            // Organise fees
             const saverFees = {
                 affiliate: new CryptoAmount(baseAmount(depositQuote.fees.affiliate), addAmount.asset),
                 asset: assetFromStringEx(depositQuote.fees.asset),
                 outbound: new CryptoAmount(baseAmount(depositQuote.fees.outbound), addAmount.asset),
             };
+            // define savers cap
             const saverCap = 0.3 * +pool.assetDepth;
             const saverCapFilledPercent = (+pool.saversDepth / saverCap) * 100;
             const estimateAddSaver = {
                 assetAmount: new CryptoAmount(baseAmount(depositQuote.expected_amount_out), addAmount.asset),
-                estimatedDepositValue: new CryptoAmount(baseAmount(depositQuote.expected_amount_out), saverFees.asset),
+                estimatedDepositValue: new CryptoAmount(baseAmount(depositQuote.expected_amount_deposit), addAmount.asset),
                 fee: saverFees,
                 expiry: expiryDatetime,
                 toAddress: depositQuote.inbound_address,
@@ -2271,12 +2279,56 @@ class ThorchainQuery {
      */
     estimateWithdrawSaver(withdrawParams) {
         return __awaiter(this, void 0, void 0, function* () {
+            const errors = [];
+            // return error if Asset in is incorrect
             if (isAssetRuneNative(withdrawParams.asset) || withdrawParams.asset.synth)
-                throw Error(`Native Rune and synth assets are not supported only L1's`);
+                errors.push(`Native Rune and synth assets are not supported only L1's`);
+            const inboundDetails = yield this.thorchainCache.getInboundDetails();
+            // Check to see if there is a position before calling withdraw quote
+            const checkPositon = yield this.getSaverPosition(withdrawParams);
+            if (checkPositon.errors.length > 0) {
+                for (let i = 0; i < checkPositon.errors.length; i++) {
+                    errors.push(checkPositon.errors[i]);
+                }
+                return {
+                    expectedAssetAmount: new CryptoAmount(assetToBase(assetAmount(checkPositon.redeemableValue.assetAmount.amount())), withdrawParams.asset),
+                    fee: {
+                        affiliate: new CryptoAmount(assetToBase(assetAmount(0)), withdrawParams.asset),
+                        asset: withdrawParams.asset,
+                        outbound: new CryptoAmount(assetToBase(assetAmount(calcOutboundFee(withdrawParams.asset, inboundDetails[withdrawParams.asset.chain]).assetAmount.amount())), withdrawParams.asset),
+                    },
+                    expiry: new Date(0),
+                    toAddress: '',
+                    memo: '',
+                    estimatedWaitTime: -1,
+                    slipBasisPoints: -1,
+                    dustAmount: new CryptoAmount(baseAmount(0), withdrawParams.asset),
+                    errors,
+                };
+            }
+            // Request withdraw quote
             const withdrawQuote = yield this.thorchainCache.thornode.getSaversWithdrawQuote(withdrawParams);
-            if (!withdrawQuote.expected_amount_out)
-                throw Error(`Could not quote withdrawal ${JSON.stringify(withdrawQuote)}`);
-            // const pool = (await this.thorchainCache.getPoolForAsset(withdrawParams.asset)).pool
+            // error handling
+            const response = JSON.parse(JSON.stringify(withdrawQuote));
+            if (response.error)
+                errors.push(`Thornode request quote failed: ${response.error}`);
+            if (errors.length > 0) {
+                return {
+                    expectedAssetAmount: new CryptoAmount(assetToBase(assetAmount(0)), withdrawParams.asset),
+                    fee: {
+                        affiliate: new CryptoAmount(assetToBase(assetAmount(0)), withdrawParams.asset),
+                        asset: withdrawParams.asset,
+                        outbound: new CryptoAmount(assetToBase(assetAmount(0)), withdrawParams.asset),
+                    },
+                    expiry: new Date(0),
+                    toAddress: '',
+                    memo: '',
+                    estimatedWaitTime: -1,
+                    slipBasisPoints: -1,
+                    dustAmount: new CryptoAmount(baseAmount(0), withdrawParams.asset),
+                    errors,
+                };
+            }
             // Calculate transaction expiry time of the vault address
             const currentDatetime = new Date();
             const minutesToAdd = 15;
@@ -2296,6 +2348,7 @@ class ThorchainQuery {
                 estimatedWaitTime: estimatedWait,
                 slipBasisPoints: withdrawQuote.slippage_bps,
                 dustAmount: new CryptoAmount(baseAmount(withdrawQuote.dust_amount), withdrawParams.asset),
+                errors,
             };
             return estimateWithdrawSaver;
         });
@@ -2307,31 +2360,37 @@ class ThorchainQuery {
      */
     getSaverPosition(params) {
         return __awaiter(this, void 0, void 0, function* () {
+            const errors = [];
+            const inboundDetails = yield this.thorchainCache.getInboundDetails();
             const blockData = (yield this.thorchainCache.thornode.getLastBlock()).find((item) => item.chain === params.asset.chain);
             const savers = (yield this.thorchainCache.thornode.getSavers(`${params.asset.chain}.${params.asset.ticker}`)).find((item) => item.asset_address === params.address);
             const pool = (yield this.thorchainCache.getPoolForAsset(params.asset)).pool;
             if (!savers)
-                throw Error(`Could not find position for ${params.address}`);
-            if (!savers.last_add_height)
-                throw Error(`Could not find position for ${params.address}`);
+                errors.push(`Could not find position for ${params.address}`);
+            if (!(savers === null || savers === void 0 ? void 0 : savers.last_add_height))
+                errors.push(`Could not find position for ${params.address}`);
             if (!(blockData === null || blockData === void 0 ? void 0 : blockData.thorchain))
-                throw Error(`Could not get thorchain block height`);
-            const ownerUnits = Number(savers.units);
-            const lastAdded = Number(savers.last_add_height);
+                errors.push(`Could not get thorchain block height`);
+            const outboundFee = yield calcOutboundFee(params.asset, inboundDetails[params.asset.chain]);
+            if (Number(savers === null || savers === void 0 ? void 0 : savers.asset_redeem_value) < outboundFee.baseAmount.amount().toNumber())
+                errors.push(`Unlikely to withdraw balance as outbound fee is greater than redeemable amount`);
+            const ownerUnits = Number(savers === null || savers === void 0 ? void 0 : savers.units);
+            const lastAdded = Number(savers === null || savers === void 0 ? void 0 : savers.last_add_height);
             const saverUnits = Number(pool.saversUnits);
             const assetDepth = Number(pool.saversDepth);
             const redeemableValue = (ownerUnits / saverUnits) * assetDepth;
-            const depositAmount = new CryptoAmount(baseAmount(savers.asset_deposit_value), params.asset);
+            const depositAmount = new CryptoAmount(baseAmount(savers === null || savers === void 0 ? void 0 : savers.asset_deposit_value), params.asset);
             const redeemableAssetAmount = new CryptoAmount(baseAmount(redeemableValue), params.asset);
-            const saversAge = ((blockData === null || blockData === void 0 ? void 0 : blockData.thorchain) - lastAdded) / ((365 * 86400) / 6);
+            const saversAge = (Number(blockData === null || blockData === void 0 ? void 0 : blockData.thorchain) - lastAdded) / ((365 * 86400) / 6);
             const saverGrowth = redeemableAssetAmount.minus(depositAmount).div(depositAmount).times(100);
             const saversPos = {
                 depositValue: depositAmount,
                 redeemableValue: redeemableAssetAmount,
-                lastAddHeight: savers.last_add_height,
+                lastAddHeight: Number(savers === null || savers === void 0 ? void 0 : savers.last_add_height),
                 percentageGrowth: saverGrowth.assetAmount.amount().toNumber(),
                 ageInYears: saversAge,
                 ageInDays: saversAge * 365,
+                errors,
             };
             return saversPos;
         });
@@ -2350,6 +2409,9 @@ class ThorchainQuery {
             const pool = (yield this.thorchainCache.getPoolForAsset(addAmount.asset)).pool;
             if (pool.status.toLowerCase() !== 'available')
                 errors.push(`Pool is not available for this asset ${assetToString(addAmount.asset)}`);
+            const inboundFee = calcNetworkFee(addAmount.asset, inboundDetails[addAmount.asset.chain]);
+            if (addAmount.lte(inboundFee))
+                errors.push(`Add amount does not cover fees`);
             return errors;
         });
     }

package/lib/index.js

@@ -2217,7 +2217,17 @@ class ThorchainQuery {
     estimateAddSaver(addAmount) {
         return __awaiter(this, void 0, void 0, function* () {
             let errors = [];
+            // check for errors before sending quote
             errors = yield this.getAddSaversEstimateErrors(addAmount);
+            // request param amount should always be in 1e8 which is why we pass in adjusted decimals if chain decimals != 8
+            const newAddAmount = addAmount.baseAmount.decimal != 8 ? getBaseAmountWithDiffDecimals(addAmount, 8) : addAmount.baseAmount.amount();
+            // Fetch quote
+            const depositQuote = yield this.thorchainCache.thornode.getSaversDepositQuote(xchainUtil.assetToString(addAmount.asset), newAddAmount.toNumber());
+            // error handling
+            const response = JSON.parse(JSON.stringify(depositQuote));
+            if (response.error)
+                errors.push(`Thornode request quote failed: ${response.error}`);
+            // Return errors if there is any
             if (errors.length > 0) {
                 return {
                     assetAmount: addAmount,
@@ -2237,29 +2247,27 @@ class ThorchainQuery {
                     errors,
                 };
             }
-            // request param amount should always be in 1e8 which is why we pass in adjusted decimals if chain decimals != 8
-            const newAddAmount = addAmount.baseAmount.decimal != 8 ? getBaseAmountWithDiffDecimals(addAmount, 8) : addAmount.baseAmount.amount();
-            const depositQuote = yield this.thorchainCache.thornode.getSaversDepositQuote(xchainUtil.assetToString(addAmount.asset), newAddAmount.toNumber());
             // Calculate transaction expiry time of the vault address
             const currentDatetime = new Date();
             const minutesToAdd = 15;
             const expiryDatetime = new Date(currentDatetime.getTime() + minutesToAdd * 60000);
+            // Calculate seconds
             const estimatedWait = depositQuote.inbound_confirmation_seconds
                 ? depositQuote.inbound_confirmation_seconds
                 : yield this.confCounting(addAmount);
             const pool = (yield this.thorchainCache.getPoolForAsset(addAmount.asset)).pool;
-            if (addAmount.baseAmount.lte(depositQuote.expected_amount_out))
-                errors.push(`Amount being added to savers can't pay for fees`);
+            // Organise fees
             const saverFees = {
                 affiliate: new CryptoAmount(xchainUtil.baseAmount(depositQuote.fees.affiliate), addAmount.asset),
                 asset: xchainUtil.assetFromStringEx(depositQuote.fees.asset),
                 outbound: new CryptoAmount(xchainUtil.baseAmount(depositQuote.fees.outbound), addAmount.asset),
             };
+            // define savers cap
             const saverCap = 0.3 * +pool.assetDepth;
             const saverCapFilledPercent = (+pool.saversDepth / saverCap) * 100;
             const estimateAddSaver = {
                 assetAmount: new CryptoAmount(xchainUtil.baseAmount(depositQuote.expected_amount_out), addAmount.asset),
-                estimatedDepositValue: new CryptoAmount(xchainUtil.baseAmount(depositQuote.expected_amount_out), saverFees.asset),
+                estimatedDepositValue: new CryptoAmount(xchainUtil.baseAmount(depositQuote.expected_amount_deposit), addAmount.asset),
                 fee: saverFees,
                 expiry: expiryDatetime,
                 toAddress: depositQuote.inbound_address,
@@ -2280,12 +2288,56 @@ class ThorchainQuery {
      */
     estimateWithdrawSaver(withdrawParams) {
         return __awaiter(this, void 0, void 0, function* () {
+            const errors = [];
+            // return error if Asset in is incorrect
             if (isAssetRuneNative(withdrawParams.asset) || withdrawParams.asset.synth)
-                throw Error(`Native Rune and synth assets are not supported only L1's`);
+                errors.push(`Native Rune and synth assets are not supported only L1's`);
+            const inboundDetails = yield this.thorchainCache.getInboundDetails();
+            // Check to see if there is a position before calling withdraw quote
+            const checkPositon = yield this.getSaverPosition(withdrawParams);
+            if (checkPositon.errors.length > 0) {
+                for (let i = 0; i < checkPositon.errors.length; i++) {
+                    errors.push(checkPositon.errors[i]);
+                }
+                return {
+                    expectedAssetAmount: new CryptoAmount(xchainUtil.assetToBase(xchainUtil.assetAmount(checkPositon.redeemableValue.assetAmount.amount())), withdrawParams.asset),
+                    fee: {
+                        affiliate: new CryptoAmount(xchainUtil.assetToBase(xchainUtil.assetAmount(0)), withdrawParams.asset),
+                        asset: withdrawParams.asset,
+                        outbound: new CryptoAmount(xchainUtil.assetToBase(xchainUtil.assetAmount(calcOutboundFee(withdrawParams.asset, inboundDetails[withdrawParams.asset.chain]).assetAmount.amount())), withdrawParams.asset),
+                    },
+                    expiry: new Date(0),
+                    toAddress: '',
+                    memo: '',
+                    estimatedWaitTime: -1,
+                    slipBasisPoints: -1,
+                    dustAmount: new CryptoAmount(xchainUtil.baseAmount(0), withdrawParams.asset),
+                    errors,
+                };
+            }
+            // Request withdraw quote
             const withdrawQuote = yield this.thorchainCache.thornode.getSaversWithdrawQuote(withdrawParams);
-            if (!withdrawQuote.expected_amount_out)
-                throw Error(`Could not quote withdrawal ${JSON.stringify(withdrawQuote)}`);
-            // const pool = (await this.thorchainCache.getPoolForAsset(withdrawParams.asset)).pool
+            // error handling
+            const response = JSON.parse(JSON.stringify(withdrawQuote));
+            if (response.error)
+                errors.push(`Thornode request quote failed: ${response.error}`);
+            if (errors.length > 0) {
+                return {
+                    expectedAssetAmount: new CryptoAmount(xchainUtil.assetToBase(xchainUtil.assetAmount(0)), withdrawParams.asset),
+                    fee: {
+                        affiliate: new CryptoAmount(xchainUtil.assetToBase(xchainUtil.assetAmount(0)), withdrawParams.asset),
+                        asset: withdrawParams.asset,
+                        outbound: new CryptoAmount(xchainUtil.assetToBase(xchainUtil.assetAmount(0)), withdrawParams.asset),
+                    },
+                    expiry: new Date(0),
+                    toAddress: '',
+                    memo: '',
+                    estimatedWaitTime: -1,
+                    slipBasisPoints: -1,
+                    dustAmount: new CryptoAmount(xchainUtil.baseAmount(0), withdrawParams.asset),
+                    errors,
+                };
+            }
             // Calculate transaction expiry time of the vault address
             const currentDatetime = new Date();
             const minutesToAdd = 15;
@@ -2305,6 +2357,7 @@ class ThorchainQuery {
                 estimatedWaitTime: estimatedWait,
                 slipBasisPoints: withdrawQuote.slippage_bps,
                 dustAmount: new CryptoAmount(xchainUtil.baseAmount(withdrawQuote.dust_amount), withdrawParams.asset),
+                errors,
             };
             return estimateWithdrawSaver;
         });
@@ -2316,31 +2369,37 @@ class ThorchainQuery {
      */
     getSaverPosition(params) {
         return __awaiter(this, void 0, void 0, function* () {
+            const errors = [];
+            const inboundDetails = yield this.thorchainCache.getInboundDetails();
             const blockData = (yield this.thorchainCache.thornode.getLastBlock()).find((item) => item.chain === params.asset.chain);
             const savers = (yield this.thorchainCache.thornode.getSavers(`${params.asset.chain}.${params.asset.ticker}`)).find((item) => item.asset_address === params.address);
             const pool = (yield this.thorchainCache.getPoolForAsset(params.asset)).pool;
             if (!savers)
-                throw Error(`Could not find position for ${params.address}`);
-            if (!savers.last_add_height)
-                throw Error(`Could not find position for ${params.address}`);
+                errors.push(`Could not find position for ${params.address}`);
+            if (!(savers === null || savers === void 0 ? void 0 : savers.last_add_height))
+                errors.push(`Could not find position for ${params.address}`);
             if (!(blockData === null || blockData === void 0 ? void 0 : blockData.thorchain))
-                throw Error(`Could not get thorchain block height`);
-            const ownerUnits = Number(savers.units);
-            const lastAdded = Number(savers.last_add_height);
+                errors.push(`Could not get thorchain block height`);
+            const outboundFee = yield calcOutboundFee(params.asset, inboundDetails[params.asset.chain]);
+            if (Number(savers === null || savers === void 0 ? void 0 : savers.asset_redeem_value) < outboundFee.baseAmount.amount().toNumber())
+                errors.push(`Unlikely to withdraw balance as outbound fee is greater than redeemable amount`);
+            const ownerUnits = Number(savers === null || savers === void 0 ? void 0 : savers.units);
+            const lastAdded = Number(savers === null || savers === void 0 ? void 0 : savers.last_add_height);
             const saverUnits = Number(pool.saversUnits);
             const assetDepth = Number(pool.saversDepth);
             const redeemableValue = (ownerUnits / saverUnits) * assetDepth;
-            const depositAmount = new CryptoAmount(xchainUtil.baseAmount(savers.asset_deposit_value), params.asset);
+            const depositAmount = new CryptoAmount(xchainUtil.baseAmount(savers === null || savers === void 0 ? void 0 : savers.asset_deposit_value), params.asset);
             const redeemableAssetAmount = new CryptoAmount(xchainUtil.baseAmount(redeemableValue), params.asset);
-            const saversAge = ((blockData === null || blockData === void 0 ? void 0 : blockData.thorchain) - lastAdded) / ((365 * 86400) / 6);
+            const saversAge = (Number(blockData === null || blockData === void 0 ? void 0 : blockData.thorchain) - lastAdded) / ((365 * 86400) / 6);
             const saverGrowth = redeemableAssetAmount.minus(depositAmount).div(depositAmount).times(100);
             const saversPos = {
                 depositValue: depositAmount,
                 redeemableValue: redeemableAssetAmount,
-                lastAddHeight: savers.last_add_height,
+                lastAddHeight: Number(savers === null || savers === void 0 ? void 0 : savers.last_add_height),
                 percentageGrowth: saverGrowth.assetAmount.amount().toNumber(),
                 ageInYears: saversAge,
                 ageInDays: saversAge * 365,
+                errors,
             };
             return saversPos;
         });
@@ -2359,6 +2418,9 @@ class ThorchainQuery {
             const pool = (yield this.thorchainCache.getPoolForAsset(addAmount.asset)).pool;
             if (pool.status.toLowerCase() !== 'available')
                 errors.push(`Pool is not available for this asset ${xchainUtil.assetToString(addAmount.asset)}`);
+            const inboundFee = calcNetworkFee(addAmount.asset, inboundDetails[addAmount.asset.chain]);
+            if (addAmount.lte(inboundFee))
+                errors.push(`Add amount does not cover fees`);
             return errors;
         });
     }

package/lib/types.d.ts

@@ -204,6 +204,7 @@ export declare type EstimateWithdrawSaver = {
     estimatedWaitTime: number;
     slipBasisPoints: number;
     dustAmount: CryptoAmount;
+    errors: string[];
 };
 export declare type SaverFees = {
     affiliate: CryptoAmount;
@@ -217,6 +218,7 @@ export declare type SaversPosition = {
     percentageGrowth: number;
     ageInYears: number;
     ageInDays: number;
+    errors: string[];
 };
 export declare type SaversWithdraw = {
     height?: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xchainjs/xchain-thorchain-query",
-  "version": "0.2.4",
+  "version": "0.2.6",
   "license": "MIT",
   "description": "Thorchain query module that is resposible for estimating swap calculations and add/remove liquidity for thorchain ",
   "keywords": [
@@ -35,7 +35,7 @@
   "devDependencies": {
     "@xchainjs/xchain-client": "^0.13.7",
     "@xchainjs/xchain-midgard": "^0.4.3",
-    "@xchainjs/xchain-thornode": "^0.2.2",
+    "@xchainjs/xchain-thornode": "^0.2.3",
     "@xchainjs/xchain-util": "^0.12.0",
     "axios": "^0.25.0",
     "axios-retry": "^3.2.5",
@@ -45,7 +45,7 @@
   "peerDependencies": {
     "@xchainjs/xchain-client": "^0.13.7",
     "@xchainjs/xchain-midgard": "^0.4.3",
-    "@xchainjs/xchain-thornode": "^0.2.2",
+    "@xchainjs/xchain-thornode": "^0.2.3",
     "@xchainjs/xchain-util": "^0.12.0",
     "axios": "^0.25.0",
     "axios-retry": "^3.2.5",