@xchainjs/xchain-thorchain-query 0.2.1 → 0.2.2

package/README.md

@@ -1,6 +1,7 @@
 # `@xchainjs/xchain-thorchain-query`
 
-Thorchain-query module to query thorchain for estimation of swaps. Returns a TxDetail object with all the information needed to conduct a swap.
+Thorchain-query module to query thorchain for estimation of swaps/ add and remove Liquidity and checking a transaction stage. 
+Returns a TxDetail object with all the information needed to conduct a swap, or add liquidity. This includes estimateAddSavers()
 
 ## Installation
 
@@ -41,11 +42,72 @@ Estimation example from a swap of 2 BTC to RUNE
 }
 ```
 
+Estimation of add symetric liquidity
+```ts
+{
+  rune: 'ᚱ 12,000',
+  asset: '⚡ 0',
+  slipPercent: '0.0747',
+  lpUnits: '154224962883',
+  runeToAssetRatio: '20064.69985077',
+  transactionFee: { assetFee: '⚡ 0', runeFee: 'ᚱ 0.02', totalFees: 'ᚱ 0.02' },
+  estimatedWaitSeconds: 6,
+  errors: [],
+  canAdd: true
+}
+```
+
+Estimation of remove Liquidity
+```ts
+{
+  asset: { chain: 'BTC', symbol: 'BTC', ticker: 'BTC', synth: false },
+  percentage: 100,
+  assetAddress: 'bc1qufc5hvfvszphksqawadpc63ujarhjpn26je2jn',
+  runeAddress: ''
+}
+{
+  slipPercent: '0.0000',
+  runeAmount: 'ᚱ 1,664,891.55918601',
+  assetAmount: '₿ 83.01517361',
+  inbound: {
+    assetFee: '⚡ 10,000',
+    runeFee: 'ᚱ 0.02',
+    totalFees: 'ᚱ 2.02552681'
+  },
+  impermanentLossProtection: {
+    ILProtection: CryptoAmount { asset: [Object], baseAmount: [Object] },
+    totalDays: '346.62'
+  },
+  estimatedWaitSeconds: 8400
+}
+```
+
+Estimation of Add Saver
+```ts
+{
+  assetAmount: '₿ 0.5',
+  estimatedDepositValue: '₿ 0.49937395',
+  fee: {
+    affiliateFee: '⚡ 0',
+    asset: { chain: 'BTC', symbol: 'BTC', ticker: 'BTC', synth: true },
+    outbound: '⚡ 0'
+  },
+  expiry: 2023-03-29T05:58:34.415Z,
+  toAddress: 'bc1qucjrczghvwl5d66klz6npv7tshkpwpzlw0zzj8',
+  memo: '+:BTC/BTC',
+  estimateWaitTime: 600,
+  saverCapFilledPercent: 266.3662135203711,
+  slipBasisPoints: 12,
+  canAdd: true,
+  errors: []
+}
+```
+
 ## Documentation
 
 [`Overview `](https://dev.thorchain.org/thorchain-dev/xchainjs-integration-guide/query-package)
 
-For bash exmples, see example folder at the base of this repository xchainjs/xchainjs-lib.
+For bash exmples, see example folder at the base of this repository xchainjs/xchainjs-lib/examples/liquidity.
 
 ### [`xchain-thorchain-query`](http://docs.xchainjs.org/xchain-thorchain-query/)
 
@@ -63,6 +125,8 @@ Get Network Values: https://replit.com/@thorchain/networkValues#index.ts\
 
 Estimate AddSaver() & WithdrawSaver() & getSaverPosition() https://replit.com/@thorchain/quoteDepositTS#index.ts
 
+Check transaction Stage 
+
 ### Setting Headers for Nine Realms endpoints
 
 If you plan on using the publically accessible endpoints provided by Nine Realms(listed below), ensure that you add a valid 'x-client-id' to all requests
@@ -71,7 +135,7 @@ If you plan on using the publically accessible endpoints provided by Nine Realms
 - https://haskoin.ninerealms.com (BTC/BCH/LTC)
 - https://thornode.ninerealms.com
 
-Example
+## Example
 
 ```typescript
 import cosmosclient from '@cosmos-client/core'

package/lib/index.esm.js

@@ -1018,7 +1018,7 @@ class ThorchainCache {
         this.expireInboundDetailsCacheMillis = expireInboundDetailsCacheMillis;
         this.expireNetworkValuesCacheMillis = expireNetworkValuesCacheMillis;
         //initialize the cache
-        this.refereshPoolCache();
+        this.refreshPoolCache();
     }
     /**
      * Gets the exchange rate of the from asset in terms on the to asset
@@ -1085,7 +1085,7 @@ class ThorchainCache {
             const millisSinceLastRefeshed = Date.now() - (((_a = this.poolCache) === null || _a === void 0 ? void 0 : _a.lastRefreshed) || 0);
             if (millisSinceLastRefeshed > this.expirePoolCacheMillis) {
                 try {
-                    yield this.refereshPoolCache();
+                    yield this.refreshPoolCache();
                 }
                 catch (e) {
                     console.error(e);
@@ -1102,25 +1102,35 @@ class ThorchainCache {
     /**
      * Refreshes the Pool Cache
      *
-     * NOTE: do not call refereshPoolCache() directly, call getPools() instead
+     * NOTE: do not call refreshPoolCache() directly, call getPools() instead
      * which will refresh the cache if it's expired
      */
-    refereshPoolCache() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const [thornodePools, midgardPools] = yield Promise.all([this.thornode.getPools(), this.midgard.getPools()]);
-            const poolMap = {};
-            if (midgardPools) {
-                for (const pool of midgardPools) {
-                    const thornodePool = thornodePools.find((p) => p.asset === pool.asset);
-                    if (!thornodePool)
-                        throw Error(`Could not find thornode pool ${pool.asset}`);
-                    const lp = new LiquidityPool(pool, thornodePool);
-                    poolMap[`${lp.asset.chain}.${lp.asset.ticker}`] = lp;
+    refreshPoolCache() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const [thornodePools, midgardPools] = yield Promise.all([this.thornode.getPools(), this.midgard.getPools()]);
+                const poolMap = {};
+                if (midgardPools) {
+                    for (const pool of midgardPools) {
+                        try {
+                            const thornodePool = thornodePools.find((p) => p.asset === pool.asset);
+                            if (!thornodePool)
+                                throw Error(`Could not find thornode pool ${pool.asset}`);
+                            const lp = new LiquidityPool(pool, thornodePool);
+                            poolMap[`${lp.asset.chain}.${lp.asset.ticker}`] = lp;
+                        }
+                        catch (error) {
+                            console.log(error);
+                        }
+                    }
+                    this.poolCache = {
+                        lastRefreshed: Date.now(),
+                        pools: poolMap,
+                    };
                 }
-                this.poolCache = {
-                    lastRefreshed: Date.now(),
-                    pools: poolMap,
-                };
+            }
+            catch (error) {
+                console.error('Error refreshing pool cache:', error);
             }
         });
     }
@@ -2169,7 +2179,9 @@ class ThorchainQuery {
                     errors,
                 };
             }
-            const depositQuote = yield this.thorchainCache.thornode.getSaversDepositQuote(`${addAmount.asset.chain}.${addAmount.asset.ticker}`, addAmount.baseAmount.amount().toNumber());
+            // 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;
@@ -2181,14 +2193,14 @@ class ThorchainQuery {
             if (addAmount.baseAmount.lte(depositQuote.expected_amount_out))
                 errors.push(`Amount being added to savers can't pay for fees`);
             const saverFees = {
-                affiliate: new CryptoAmount(baseAmount(depositQuote.fees.affiliate, +pool.nativeDecimal), addAmount.asset),
+                affiliate: new CryptoAmount(baseAmount(depositQuote.fees.affiliate), addAmount.asset),
                 asset: assetFromStringEx(depositQuote.fees.asset),
-                outbound: new CryptoAmount(baseAmount(depositQuote.fees.outbound, +pool.nativeDecimal), addAmount.asset),
+                outbound: new CryptoAmount(baseAmount(depositQuote.fees.outbound), addAmount.asset),
             };
             const saverCap = 0.3 * +pool.assetDepth;
             const saverCapFilledPercent = (+pool.saversDepth / saverCap) * 100;
             const estimateAddSaver = {
-                assetAmount: addAmount,
+                assetAmount: new CryptoAmount(baseAmount(depositQuote.expected_amount_out), addAmount.asset),
                 estimatedDepositValue: new CryptoAmount(baseAmount(depositQuote.expected_amount_out), saverFees.asset),
                 fee: saverFees,
                 expiry: expiryDatetime,

package/lib/index.js

@@ -1027,7 +1027,7 @@ class ThorchainCache {
         this.expireInboundDetailsCacheMillis = expireInboundDetailsCacheMillis;
         this.expireNetworkValuesCacheMillis = expireNetworkValuesCacheMillis;
         //initialize the cache
-        this.refereshPoolCache();
+        this.refreshPoolCache();
     }
     /**
      * Gets the exchange rate of the from asset in terms on the to asset
@@ -1094,7 +1094,7 @@ class ThorchainCache {
             const millisSinceLastRefeshed = Date.now() - (((_a = this.poolCache) === null || _a === void 0 ? void 0 : _a.lastRefreshed) || 0);
             if (millisSinceLastRefeshed > this.expirePoolCacheMillis) {
                 try {
-                    yield this.refereshPoolCache();
+                    yield this.refreshPoolCache();
                 }
                 catch (e) {
                     console.error(e);
@@ -1111,25 +1111,35 @@ class ThorchainCache {
     /**
      * Refreshes the Pool Cache
      *
-     * NOTE: do not call refereshPoolCache() directly, call getPools() instead
+     * NOTE: do not call refreshPoolCache() directly, call getPools() instead
      * which will refresh the cache if it's expired
      */
-    refereshPoolCache() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const [thornodePools, midgardPools] = yield Promise.all([this.thornode.getPools(), this.midgard.getPools()]);
-            const poolMap = {};
-            if (midgardPools) {
-                for (const pool of midgardPools) {
-                    const thornodePool = thornodePools.find((p) => p.asset === pool.asset);
-                    if (!thornodePool)
-                        throw Error(`Could not find thornode pool ${pool.asset}`);
-                    const lp = new LiquidityPool(pool, thornodePool);
-                    poolMap[`${lp.asset.chain}.${lp.asset.ticker}`] = lp;
+    refreshPoolCache() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const [thornodePools, midgardPools] = yield Promise.all([this.thornode.getPools(), this.midgard.getPools()]);
+                const poolMap = {};
+                if (midgardPools) {
+                    for (const pool of midgardPools) {
+                        try {
+                            const thornodePool = thornodePools.find((p) => p.asset === pool.asset);
+                            if (!thornodePool)
+                                throw Error(`Could not find thornode pool ${pool.asset}`);
+                            const lp = new LiquidityPool(pool, thornodePool);
+                            poolMap[`${lp.asset.chain}.${lp.asset.ticker}`] = lp;
+                        }
+                        catch (error) {
+                            console.log(error);
+                        }
+                    }
+                    this.poolCache = {
+                        lastRefreshed: Date.now(),
+                        pools: poolMap,
+                    };
                 }
-                this.poolCache = {
-                    lastRefreshed: Date.now(),
-                    pools: poolMap,
-                };
+            }
+            catch (error) {
+                console.error('Error refreshing pool cache:', error);
             }
         });
     }
@@ -2178,7 +2188,9 @@ class ThorchainQuery {
                     errors,
                 };
             }
-            const depositQuote = yield this.thorchainCache.thornode.getSaversDepositQuote(`${addAmount.asset.chain}.${addAmount.asset.ticker}`, addAmount.baseAmount.amount().toNumber());
+            // 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;
@@ -2190,14 +2202,14 @@ class ThorchainQuery {
             if (addAmount.baseAmount.lte(depositQuote.expected_amount_out))
                 errors.push(`Amount being added to savers can't pay for fees`);
             const saverFees = {
-                affiliate: new CryptoAmount(xchainUtil.baseAmount(depositQuote.fees.affiliate, +pool.nativeDecimal), addAmount.asset),
+                affiliate: new CryptoAmount(xchainUtil.baseAmount(depositQuote.fees.affiliate), addAmount.asset),
                 asset: xchainUtil.assetFromStringEx(depositQuote.fees.asset),
-                outbound: new CryptoAmount(xchainUtil.baseAmount(depositQuote.fees.outbound, +pool.nativeDecimal), addAmount.asset),
+                outbound: new CryptoAmount(xchainUtil.baseAmount(depositQuote.fees.outbound), addAmount.asset),
             };
             const saverCap = 0.3 * +pool.assetDepth;
             const saverCapFilledPercent = (+pool.saversDepth / saverCap) * 100;
             const estimateAddSaver = {
-                assetAmount: addAmount,
+                assetAmount: new CryptoAmount(xchainUtil.baseAmount(depositQuote.expected_amount_out), addAmount.asset),
                 estimatedDepositValue: new CryptoAmount(xchainUtil.baseAmount(depositQuote.expected_amount_out), saverFees.asset),
                 fee: saverFees,
                 expiry: expiryDatetime,

package/lib/thorchain-cache.d.ts

@@ -52,10 +52,10 @@ export declare class ThorchainCache {
     /**
      * Refreshes the Pool Cache
      *
-     * NOTE: do not call refereshPoolCache() directly, call getPools() instead
+     * NOTE: do not call refreshPoolCache() directly, call getPools() instead
      * which will refresh the cache if it's expired
      */
-    private refereshPoolCache;
+    private refreshPoolCache;
     /**
      * Refreshes the InboundDetailCache Cache
      *

package/lib/types.d.ts

@@ -42,6 +42,7 @@ export declare type EstimateSwapParams = {
     affiliateAddress?: Address;
     affiliateFeeBasisPoints?: number;
     interfaceID?: string;
+    feeOption?: FeeOption;
 };
 export declare type SwapOutput = {
     output: CryptoAmount;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xchainjs/xchain-thorchain-query",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "license": "MIT",
   "description": "Thorchain query module that is resposible for estimating swap calculations and add/remove liquidity for thorchain ",
   "keywords": [
@@ -33,15 +33,15 @@
     "postversion": "git push --follow-tags"
   },
   "devDependencies": {
-    "@xchainjs/xchain-avax": "^0.1.4",
+    "@xchainjs/xchain-avax": "^0.1.5",
     "@xchainjs/xchain-binance": "^5.6.7",
-    "@xchainjs/xchain-bitcoin": "^0.21.0",
-    "@xchainjs/xchain-bitcoincash": "^0.15.8",
+    "@xchainjs/xchain-bitcoin": "^0.21.2",
+    "@xchainjs/xchain-bitcoincash": "^0.15.9",
     "@xchainjs/xchain-client": "^0.13.5",
     "@xchainjs/xchain-cosmos": "^0.20.8",
-    "@xchainjs/xchain-doge": "^0.5.9",
+    "@xchainjs/xchain-doge": "^0.5.1",
     "@xchainjs/xchain-ethereum": "^0.27.7",
-    "@xchainjs/xchain-litecoin": "^0.11.0",
+    "@xchainjs/xchain-litecoin": "^0.11.2",
     "@xchainjs/xchain-midgard": "^0.4.3",
     "@xchainjs/xchain-thorchain": "^0.27.9",
     "@xchainjs/xchain-thornode": "^0.2.1",
@@ -52,15 +52,15 @@
     "rimraf": "~3.0.2"
   },
   "peerDependencies": {
-    "@xchainjs/xchain-avax": "^0.1.4",
+    "@xchainjs/xchain-avax": "^0.1.5",
     "@xchainjs/xchain-binance": "^5.6.7",
-    "@xchainjs/xchain-bitcoin": "^0.21.0",
-    "@xchainjs/xchain-bitcoincash": "^0.15.8",
+    "@xchainjs/xchain-bitcoin": "^0.21.2",
+    "@xchainjs/xchain-bitcoincash": "^0.15.9",
     "@xchainjs/xchain-client": "^0.13.5",
     "@xchainjs/xchain-cosmos": "^0.20.8",
-    "@xchainjs/xchain-doge": "^0.5.9",
+    "@xchainjs/xchain-doge": "^0.5.11",
     "@xchainjs/xchain-ethereum": "^0.27.7",
-    "@xchainjs/xchain-litecoin": "^0.11.0",
+    "@xchainjs/xchain-litecoin": "^0.11.2",
     "@xchainjs/xchain-midgard": "^0.4.3",
     "@xchainjs/xchain-thorchain": "^0.27.9",
     "@xchainjs/xchain-thornode": "^0.2.1",