@xchainjs/xchain-midgard-query 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 THORChain
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,16 @@
+# `@xchainjs/xchain-midgard-query`
+
+Midgard-query module to query Midgard for read-only data. Midgard is a layer 2 REST API that provides front-end consumers with semi real-time rolled up data and analytics of the THORChain network. Most requests to the network will come through Midgard. This daemon is here to keep the chain itself from fielding large quantities of requests. You can think of it as a “read-only slave” to the chain. This keeps the resources of the network focused on processing transactions.
+
+## Installation
+
+```
+yarn add @xchainjs/xchain-midgard-query
+```
+
+Following peer dependencies have to be installed into your project. These are not included in `@xchainjs/xchain-midgard-query`.
+
+```
+yarn add @xchainjs/xchain-client @xchainjs/xchain-util @xchainjs/xchain-midgard axios
+
+```

package/lib/index.d.ts

@@ -0,0 +1,4 @@
+export * from './midgard-query';
+export * from './midgard-cache';
+export * from './types';
+export * from './utils';

package/lib/index.esm.js

@@ -0,0 +1,204 @@
+import { CachedValue, assetFromStringEx, assetToString, assetFromString, CryptoAmount, baseAmount } from '@xchainjs/xchain-util';
+import { Network } from '@xchainjs/xchain-client';
+import { MidgardApi, Configuration } from '@xchainjs/xchain-midgard';
+import axios from 'axios';
+import axiosRetry from 'axios-retry';
+
+/******************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+
+function __awaiter(thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+}
+
+const defaultMidgardConfig = {
+    mainnet: {
+        apiRetries: 3,
+        midgardBaseUrls: ['https://midgard.ninerealms.com'],
+    },
+    stagenet: {
+        apiRetries: 3,
+        midgardBaseUrls: ['https://stagenet-midgard.ninerealms.com'],
+    },
+    testnet: {
+        apiRetries: 3,
+        midgardBaseUrls: ['https://testnet.midgard.thorchain.info'],
+    },
+};
+class Midgard {
+    constructor(network = Network.Mainnet, config) {
+        this.network = network;
+        this.config = config !== null && config !== void 0 ? config : defaultMidgardConfig[this.network];
+        axiosRetry(axios, { retries: this.config.apiRetries, retryDelay: axiosRetry.exponentialDelay });
+        this.midgardApis = this.config.midgardBaseUrls.map((url) => new MidgardApi(new Configuration({ basePath: url })));
+    }
+    /**
+     * 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`);
+        });
+    }
+    /**
+     *
+     * @returns an array of Pools
+     */
+    getPools() {
+        return __awaiter(this, void 0, void 0, function* () {
+            for (const api of this.midgardApis) {
+                try {
+                    return (yield api.getPools()).data;
+                }
+                catch (e) {
+                    //console.error(e)
+                }
+            }
+            throw new Error(`Midgard not responding`);
+        });
+    }
+}
+
+const MILLISECOND_CACHE_POOLS = 5000;
+const MILLISECOND_CACHE_SAVERS = 5000;
+const defaultMidgard = new Midgard();
+/**
+ * This class manages retrieving information from Midgard API and cached it
+ */
+class MidgardCache {
+    /**
+     * Constructor to create a ThorchainCache
+     *
+     * @param midgard - an instance of the midgard API (could be pointing to stagenet,testnet,mainnet)
+     * @returns MidgardCache
+     */
+    constructor(midgard = defaultMidgard) {
+        this.midgard = midgard;
+        this.cachedPools = new CachedValue(() => this.midgard.getPools(), MILLISECOND_CACHE_POOLS);
+        this.cachedSavers = new CachedValue(() => this.midgard.getSavers(''), MILLISECOND_CACHE_SAVERS);
+    }
+    getPools() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.cachedPools.getValue();
+        });
+    }
+    getSavers(address) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.cachedSavers.getValue(address);
+        });
+    }
+}
+
+assetFromStringEx('AVAX.AVAX');
+assetFromStringEx('BTC.BTC');
+assetFromStringEx('GAIA.ATOM');
+const AssetRuneNative = assetFromStringEx('THOR.RUNE');
+const isAssetRuneNative = (asset) => assetToString(asset) === assetToString(AssetRuneNative);
+
+const DEFAULT_THORCHAIN_DECIMALS = 8;
+const defaultCache = new MidgardCache();
+/**
+ * THORChain Class for getting  data from Midgard API (THORChain L2 Api).
+ */
+class MidgardQuery {
+    /**
+     * Contructor to create a ThorchainAMM
+     *
+     * @param midgardCache - an instance of the midgardCache (could be pointing to stagenet,testnet,mainnet)
+     * @returns ThorchainAMM
+     */
+    constructor(midgardCache = defaultCache) {
+        this.midgardCache = midgardCache;
+    }
+    getPool(asset) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const pools = yield this.midgardCache.getPools();
+            const pool = pools.find((pool) => pool.asset === asset);
+            if (!pool) {
+                throw new Error(`Can't find pool for asset: ${asset}`);
+            }
+            return pool;
+        });
+    }
+    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.midgardCache.getSavers(addressesString);
+            const errors = [];
+            const saversPositions = [];
+            const allPositionsPromises = saversDetail.pools.map((saver) => __awaiter(this, void 0, void 0, function* () {
+                const asset = assetFromString(saver.pool);
+                if (asset) {
+                    const poolDetail = yield this.getPool(saver.pool);
+                    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(poolDetail.saversUnits);
+                    const assetDepth = Number(poolDetail.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,
+                    });
+                }
+            }));
+            yield Promise.all(allPositionsPromises);
+            return saversPositions;
+        });
+    }
+    getDecimalForAsset(asset) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!isAssetRuneNative(asset)) {
+                const pool = yield this.getPool(assetToString(asset));
+                const decimals = Number(pool.nativeDecimal);
+                if (decimals > 0)
+                    return decimals;
+                else
+                    return DEFAULT_THORCHAIN_DECIMALS;
+            }
+            return DEFAULT_THORCHAIN_DECIMALS;
+        });
+    }
+}
+
+export { Midgard, MidgardCache, MidgardQuery };
+//# sourceMappingURL=index.esm.js.map

package/lib/index.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.esm.js","sources":["../src/utils/midgard.ts","../src/midgard-cache.ts","../src/utils/const.ts","../src/midgard-query.ts"],"sourcesContent":["import { Network } from '@xchainjs/xchain-client'\nimport { Configuration, MidgardApi, PoolDetail, SaverDetails } from '@xchainjs/xchain-midgard'\nimport axios from 'axios'\nimport axiosRetry from 'axios-retry'\n\nimport { MidgardConfig } from '../types'\n\nconst defaultMidgardConfig: Record<Network, MidgardConfig> = {\n  mainnet: {\n    apiRetries: 3,\n    midgardBaseUrls: ['https://midgard.ninerealms.com'],\n  },\n  stagenet: {\n    apiRetries: 3,\n    midgardBaseUrls: ['https://stagenet-midgard.ninerealms.com'],\n  },\n  testnet: {\n    apiRetries: 3,\n    midgardBaseUrls: ['https://testnet.midgard.thorchain.info'],\n  },\n}\n\nexport class Midgard {\n  private config: MidgardConfig\n  readonly network: Network\n  private midgardApis: MidgardApi[]\n\n  constructor(network: Network = Network.Mainnet, config?: MidgardConfig) {\n    this.network = network\n    this.config = config ?? defaultMidgardConfig[this.network]\n    axiosRetry(axios, { retries: this.config.apiRetries, retryDelay: axiosRetry.exponentialDelay })\n    this.midgardApis = this.config.midgardBaseUrls.map(\n      (url: string) => new MidgardApi(new Configuration({ basePath: url })),\n    )\n  }\n\n  /**\n   * Function to return member details based on valid liquidity position\n   * @param address - query can also be multiple addresses should be separated by comma\n   * @returns - object type of Member Detail\n   */\n  public async getSavers(address: string): Promise<SaverDetails> {\n    for (const api of this.midgardApis) {\n      try {\n        const saverDetails = (await api.getSaverDetail(address)).data\n        return saverDetails\n      } catch (e) {\n        //console.error(e)\n      }\n    }\n    throw Error(`Midgard not responding`)\n  }\n\n  /**\n   *\n   * @returns an array of Pools\n   */\n  async getPools(): Promise<PoolDetail[]> {\n    for (const api of this.midgardApis) {\n      try {\n        return (await api.getPools()).data\n      } catch (e) {\n        //console.error(e)\n      }\n    }\n    throw new Error(`Midgard not responding`)\n  }\n}\n","import { PoolDetail, SaverDetails } from '@xchainjs/xchain-midgard'\nimport { CachedValue } from '@xchainjs/xchain-util'\n\nimport { Midgard } from './utils/midgard'\n\nconst MILLISECOND_CACHE_POOLS = 5000\nconst MILLISECOND_CACHE_SAVERS = 5000\n\nconst defaultMidgard = new Midgard()\n\n/**\n * This class manages retrieving information from Midgard API and cached it\n */\nexport class MidgardCache {\n  private readonly midgard: Midgard\n  private readonly cachedPools: CachedValue<PoolDetail[]>\n  private readonly cachedSavers: CachedValue<SaverDetails>\n  /**\n   * Constructor to create a ThorchainCache\n   *\n   * @param midgard - an instance of the midgard API (could be pointing to stagenet,testnet,mainnet)\n   * @returns MidgardCache\n   */\n  constructor(midgard = defaultMidgard) {\n    this.midgard = midgard\n    this.cachedPools = new CachedValue<PoolDetail[]>(() => this.midgard.getPools(), MILLISECOND_CACHE_POOLS)\n    this.cachedSavers = new CachedValue<SaverDetails>(() => this.midgard.getSavers(''), MILLISECOND_CACHE_SAVERS)\n  }\n\n  public async getPools(): Promise<PoolDetail[]> {\n    return this.cachedPools.getValue()\n  }\n\n  public async getSavers(address: string): Promise<SaverDetails> {\n    return this.cachedSavers.getValue(address)\n  }\n}\n","import { Asset, assetFromStringEx, assetToString } from '@xchainjs/xchain-util'\n\nexport const AssetAVAX = assetFromStringEx('AVAX.AVAX')\nexport const AssetBTC = assetFromStringEx('BTC.BTC')\nexport const AssetATOM = assetFromStringEx('GAIA.ATOM')\nexport const AssetRuneNative = assetFromStringEx('THOR.RUNE')\n\nexport const BTCChain = 'BTC'\nexport const GAIAChain = 'GAIA'\nexport const AVAXChain = 'AVAX'\n\nexport const isAssetRuneNative = (asset: Asset): boolean => assetToString(asset) === assetToString(AssetRuneNative)\n","import { PoolDetail } from '@xchainjs/xchain-midgard'\nimport { Asset, CryptoAmount, assetFromString, assetToString, baseAmount } from '@xchainjs/xchain-util'\n\nimport { MidgardCache } from './midgard-cache'\nimport { SaversPosition, getSaver } from './types'\nimport { isAssetRuneNative } from './utils/const'\n\nconst DEFAULT_THORCHAIN_DECIMALS = 8\n\nconst defaultCache = new MidgardCache()\n\n/**\n * THORChain Class for getting  data from Midgard API (THORChain L2 Api).\n */\nexport class MidgardQuery {\n  readonly midgardCache: MidgardCache\n\n  /**\n   * Contructor to create a ThorchainAMM\n   *\n   * @param midgardCache - an instance of the midgardCache (could be pointing to stagenet,testnet,mainnet)\n   * @returns ThorchainAMM\n   */\n  constructor(midgardCache = defaultCache) {\n    this.midgardCache = midgardCache\n  }\n\n  private async getPool(asset: string): Promise<PoolDetail> {\n    const pools = await this.midgardCache.getPools()\n    const pool = pools.find((pool) => pool.asset === asset)\n    if (!pool) {\n      throw new Error(`Can't find pool for asset: ${asset}`)\n    }\n    return pool\n  }\n\n  public async getSaverPositions(params: getSaver[]): Promise<SaversPosition[]> {\n    const addresses: Set<string> = new Set<string>()\n    params.forEach((param) => addresses.add(param.address))\n    const addressesString: string = Array.from(addresses).join(',')\n    const saversDetail = await this.midgardCache.getSavers(addressesString)\n    const errors: string[] = []\n\n    const saversPositions: SaversPosition[] = []\n    const allPositionsPromises = saversDetail.pools.map(async (saver) => {\n      const asset = assetFromString(saver.pool)\n\n      if (asset) {\n        const poolDetail = await this.getPool(saver.pool)\n        const depositAmount = new CryptoAmount(baseAmount(saver.assetAdded).minus(saver.assetWithdrawn), asset)\n        const ownerUnits = Number(saver?.saverUnits)\n        const saverUnits = Number(poolDetail.saversUnits)\n        const assetDepth = Number(poolDetail.saversDepth)\n        const redeemableValue = (ownerUnits / saverUnits) * assetDepth\n        const redeemableAssetAmount = new CryptoAmount(baseAmount(redeemableValue), asset)\n        const saverGrowth = redeemableAssetAmount.minus(depositAmount).div(depositAmount).times(100)\n        const saversAge = (Date.now() / 1000 - Number(saver.dateLastAdded)) / (365 * 86400)\n\n        saversPositions.push({\n          depositValue: depositAmount,\n          redeemableValue: redeemableAssetAmount,\n          lastAddHeight: -1,\n          percentageGrowth: saverGrowth.assetAmount.amount().toNumber(),\n          ageInYears: saversAge,\n          ageInDays: saversAge * 365,\n          asset,\n          errors,\n        })\n      }\n    })\n    await Promise.all(allPositionsPromises)\n    return saversPositions\n  }\n\n  public async getDecimalForAsset(asset: Asset): Promise<number> {\n    if (!isAssetRuneNative(asset)) {\n      const pool = await this.getPool(assetToString(asset))\n      const decimals = Number(pool.nativeDecimal)\n      if (decimals > 0) return decimals\n      else return DEFAULT_THORCHAIN_DECIMALS\n    }\n    return DEFAULT_THORCHAIN_DECIMALS\n  }\n}\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAOA,MAAM,oBAAoB,GAAmC;AAC3D,IAAA,OAAO,EAAE;AACP,QAAA,UAAU,EAAE,CAAC;QACb,eAAe,EAAE,CAAC,gCAAgC,CAAC;AACpD,KAAA;AACD,IAAA,QAAQ,EAAE;AACR,QAAA,UAAU,EAAE,CAAC;QACb,eAAe,EAAE,CAAC,yCAAyC,CAAC;AAC7D,KAAA;AACD,IAAA,OAAO,EAAE;AACP,QAAA,UAAU,EAAE,CAAC;QACb,eAAe,EAAE,CAAC,wCAAwC,CAAC;AAC5D,KAAA;CACF,CAAA;MAEY,OAAO,CAAA;AAKlB,IAAA,WAAA,CAAY,OAAmB,GAAA,OAAO,CAAC,OAAO,EAAE,MAAsB,EAAA;AACpE,QAAA,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;AACtB,QAAA,IAAI,CAAC,MAAM,GAAG,MAAM,aAAN,MAAM,KAAA,KAAA,CAAA,GAAN,MAAM,GAAI,oBAAoB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;AAC1D,QAAA,UAAU,CAAC,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,UAAU,EAAE,UAAU,CAAC,gBAAgB,EAAE,CAAC,CAAA;AAC/F,QAAA,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,GAAG,CAChD,CAAC,GAAW,KAAK,IAAI,UAAU,CAAC,IAAI,aAAa,CAAC,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC,CAAC,CACtE,CAAA;KACF;AAED;;;;AAIG;AACU,IAAA,SAAS,CAAC,OAAe,EAAA;;AACpC,YAAA,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,WAAW,EAAE;gBAClC,IAAI;AACF,oBAAA,MAAM,YAAY,GAAG,CAAC,MAAM,GAAG,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,IAAI,CAAA;AAC7D,oBAAA,OAAO,YAAY,CAAA;AACpB,iBAAA;AAAC,gBAAA,OAAO,CAAC,EAAE;;AAEX,iBAAA;AACF,aAAA;AACD,YAAA,MAAM,KAAK,CAAC,CAAwB,sBAAA,CAAA,CAAC,CAAA;SACtC,CAAA,CAAA;AAAA,KAAA;AAED;;;AAGG;IACG,QAAQ,GAAA;;AACZ,YAAA,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,WAAW,EAAE;gBAClC,IAAI;oBACF,OAAO,CAAC,MAAM,GAAG,CAAC,QAAQ,EAAE,EAAE,IAAI,CAAA;AACnC,iBAAA;AAAC,gBAAA,OAAO,CAAC,EAAE;;AAEX,iBAAA;AACF,aAAA;AACD,YAAA,MAAM,IAAI,KAAK,CAAC,CAAA,sBAAA,CAAwB,CAAC,CAAA;SAC1C,CAAA,CAAA;AAAA,KAAA;AACF;;AC9DD,MAAM,uBAAuB,GAAG,IAAI,CAAA;AACpC,MAAM,wBAAwB,GAAG,IAAI,CAAA;AAErC,MAAM,cAAc,GAAG,IAAI,OAAO,EAAE,CAAA;AAEpC;;AAEG;MACU,YAAY,CAAA;AAIvB;;;;;AAKG;IACH,WAAY,CAAA,OAAO,GAAG,cAAc,EAAA;AAClC,QAAA,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;AACtB,QAAA,IAAI,CAAC,WAAW,GAAG,IAAI,WAAW,CAAe,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,uBAAuB,CAAC,CAAA;QACxG,IAAI,CAAC,YAAY,GAAG,IAAI,WAAW,CAAe,MAAM,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,wBAAwB,CAAC,CAAA;KAC9G;IAEY,QAAQ,GAAA;;AACnB,YAAA,OAAO,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAA;SACnC,CAAA,CAAA;AAAA,KAAA;AAEY,IAAA,SAAS,CAAC,OAAe,EAAA;;YACpC,OAAO,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAA;SAC3C,CAAA,CAAA;AAAA,KAAA;AACF;;AClCwB,iBAAiB,CAAC,WAAW,EAAC;AAC/B,iBAAiB,CAAC,SAAS,EAAC;AAC3B,iBAAiB,CAAC,WAAW,EAAC;AAChD,MAAM,eAAe,GAAG,iBAAiB,CAAC,WAAW,CAAC,CAAA;AAMtD,MAAM,iBAAiB,GAAG,CAAC,KAAY,KAAc,aAAa,CAAC,KAAK,CAAC,KAAK,aAAa,CAAC,eAAe,CAAC;;ACJnH,MAAM,0BAA0B,GAAG,CAAC,CAAA;AAEpC,MAAM,YAAY,GAAG,IAAI,YAAY,EAAE,CAAA;AAEvC;;AAEG;MACU,YAAY,CAAA;AAGvB;;;;;AAKG;IACH,WAAY,CAAA,YAAY,GAAG,YAAY,EAAA;AACrC,QAAA,IAAI,CAAC,YAAY,GAAG,YAAY,CAAA;KACjC;AAEa,IAAA,OAAO,CAAC,KAAa,EAAA;;YACjC,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAA;AAChD,YAAA,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,KAAK,KAAK,KAAK,CAAC,CAAA;YACvD,IAAI,CAAC,IAAI,EAAE;AACT,gBAAA,MAAM,IAAI,KAAK,CAAC,8BAA8B,KAAK,CAAA,CAAE,CAAC,CAAA;AACvD,aAAA;AACD,YAAA,OAAO,IAAI,CAAA;SACZ,CAAA,CAAA;AAAA,KAAA;AAEY,IAAA,iBAAiB,CAAC,MAAkB,EAAA;;AAC/C,YAAA,MAAM,SAAS,GAAgB,IAAI,GAAG,EAAU,CAAA;AAChD,YAAA,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,KAAK,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAA;AACvD,YAAA,MAAM,eAAe,GAAW,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YAC/D,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,eAAe,CAAC,CAAA;YACvE,MAAM,MAAM,GAAa,EAAE,CAAA;YAE3B,MAAM,eAAe,GAAqB,EAAE,CAAA;YAC5C,MAAM,oBAAoB,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAO,KAAK,KAAI,SAAA,CAAA,IAAA,EAAA,KAAA,CAAA,EAAA,KAAA,CAAA,EAAA,aAAA;gBAClE,MAAM,KAAK,GAAG,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;AAEzC,gBAAA,IAAI,KAAK,EAAE;oBACT,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;oBACjD,MAAM,aAAa,GAAG,IAAI,YAAY,CAAC,UAAU,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,cAAc,CAAC,EAAE,KAAK,CAAC,CAAA;AACvG,oBAAA,MAAM,UAAU,GAAG,MAAM,CAAC,KAAK,KAAA,IAAA,IAAL,KAAK,KAAA,KAAA,CAAA,GAAA,KAAA,CAAA,GAAL,KAAK,CAAE,UAAU,CAAC,CAAA;oBAC5C,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAA;oBACjD,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAA;oBACjD,MAAM,eAAe,GAAG,CAAC,UAAU,GAAG,UAAU,IAAI,UAAU,CAAA;AAC9D,oBAAA,MAAM,qBAAqB,GAAG,IAAI,YAAY,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE,KAAK,CAAC,CAAA;AAClF,oBAAA,MAAM,WAAW,GAAG,qBAAqB,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;oBAC5F,MAAM,SAAS,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,KAAK,GAAG,GAAG,KAAK,CAAC,CAAA;oBAEnF,eAAe,CAAC,IAAI,CAAC;AACnB,wBAAA,YAAY,EAAE,aAAa;AAC3B,wBAAA,eAAe,EAAE,qBAAqB;wBACtC,aAAa,EAAE,CAAC,CAAC;wBACjB,gBAAgB,EAAE,WAAW,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;AAC7D,wBAAA,UAAU,EAAE,SAAS;wBACrB,SAAS,EAAE,SAAS,GAAG,GAAG;wBAC1B,KAAK;wBACL,MAAM;AACP,qBAAA,CAAC,CAAA;AACH,iBAAA;aACF,CAAA,CAAC,CAAA;AACF,YAAA,MAAM,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAA;AACvC,YAAA,OAAO,eAAe,CAAA;SACvB,CAAA,CAAA;AAAA,KAAA;AAEY,IAAA,kBAAkB,CAAC,KAAY,EAAA;;AAC1C,YAAA,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,EAAE;AAC7B,gBAAA,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAA;gBACrD,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAA;gBAC3C,IAAI,QAAQ,GAAG,CAAC;AAAE,oBAAA,OAAO,QAAQ,CAAA;;AAC5B,oBAAA,OAAO,0BAA0B,CAAA;AACvC,aAAA;AACD,YAAA,OAAO,0BAA0B,CAAA;SAClC,CAAA,CAAA;AAAA,KAAA;AACF;;;;"}

package/lib/index.js

@@ -0,0 +1,215 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var xchainUtil = require('@xchainjs/xchain-util');
+var xchainClient = require('@xchainjs/xchain-client');
+var xchainMidgard = require('@xchainjs/xchain-midgard');
+var axios = require('axios');
+var axiosRetry = require('axios-retry');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var axios__default = /*#__PURE__*/_interopDefaultLegacy(axios);
+var axiosRetry__default = /*#__PURE__*/_interopDefaultLegacy(axiosRetry);
+
+/******************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+
+function __awaiter(thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+}
+
+const defaultMidgardConfig = {
+    mainnet: {
+        apiRetries: 3,
+        midgardBaseUrls: ['https://midgard.ninerealms.com'],
+    },
+    stagenet: {
+        apiRetries: 3,
+        midgardBaseUrls: ['https://stagenet-midgard.ninerealms.com'],
+    },
+    testnet: {
+        apiRetries: 3,
+        midgardBaseUrls: ['https://testnet.midgard.thorchain.info'],
+    },
+};
+class Midgard {
+    constructor(network = xchainClient.Network.Mainnet, config) {
+        this.network = network;
+        this.config = config !== null && config !== void 0 ? config : defaultMidgardConfig[this.network];
+        axiosRetry__default["default"](axios__default["default"], { retries: this.config.apiRetries, retryDelay: axiosRetry__default["default"].exponentialDelay });
+        this.midgardApis = this.config.midgardBaseUrls.map((url) => new xchainMidgard.MidgardApi(new xchainMidgard.Configuration({ basePath: url })));
+    }
+    /**
+     * 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`);
+        });
+    }
+    /**
+     *
+     * @returns an array of Pools
+     */
+    getPools() {
+        return __awaiter(this, void 0, void 0, function* () {
+            for (const api of this.midgardApis) {
+                try {
+                    return (yield api.getPools()).data;
+                }
+                catch (e) {
+                    //console.error(e)
+                }
+            }
+            throw new Error(`Midgard not responding`);
+        });
+    }
+}
+
+const MILLISECOND_CACHE_POOLS = 5000;
+const MILLISECOND_CACHE_SAVERS = 5000;
+const defaultMidgard = new Midgard();
+/**
+ * This class manages retrieving information from Midgard API and cached it
+ */
+class MidgardCache {
+    /**
+     * Constructor to create a ThorchainCache
+     *
+     * @param midgard - an instance of the midgard API (could be pointing to stagenet,testnet,mainnet)
+     * @returns MidgardCache
+     */
+    constructor(midgard = defaultMidgard) {
+        this.midgard = midgard;
+        this.cachedPools = new xchainUtil.CachedValue(() => this.midgard.getPools(), MILLISECOND_CACHE_POOLS);
+        this.cachedSavers = new xchainUtil.CachedValue(() => this.midgard.getSavers(''), MILLISECOND_CACHE_SAVERS);
+    }
+    getPools() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.cachedPools.getValue();
+        });
+    }
+    getSavers(address) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.cachedSavers.getValue(address);
+        });
+    }
+}
+
+xchainUtil.assetFromStringEx('AVAX.AVAX');
+xchainUtil.assetFromStringEx('BTC.BTC');
+xchainUtil.assetFromStringEx('GAIA.ATOM');
+const AssetRuneNative = xchainUtil.assetFromStringEx('THOR.RUNE');
+const isAssetRuneNative = (asset) => xchainUtil.assetToString(asset) === xchainUtil.assetToString(AssetRuneNative);
+
+const DEFAULT_THORCHAIN_DECIMALS = 8;
+const defaultCache = new MidgardCache();
+/**
+ * THORChain Class for getting  data from Midgard API (THORChain L2 Api).
+ */
+class MidgardQuery {
+    /**
+     * Contructor to create a ThorchainAMM
+     *
+     * @param midgardCache - an instance of the midgardCache (could be pointing to stagenet,testnet,mainnet)
+     * @returns ThorchainAMM
+     */
+    constructor(midgardCache = defaultCache) {
+        this.midgardCache = midgardCache;
+    }
+    getPool(asset) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const pools = yield this.midgardCache.getPools();
+            const pool = pools.find((pool) => pool.asset === asset);
+            if (!pool) {
+                throw new Error(`Can't find pool for asset: ${asset}`);
+            }
+            return pool;
+        });
+    }
+    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.midgardCache.getSavers(addressesString);
+            const errors = [];
+            const saversPositions = [];
+            const allPositionsPromises = saversDetail.pools.map((saver) => __awaiter(this, void 0, void 0, function* () {
+                const asset = xchainUtil.assetFromString(saver.pool);
+                if (asset) {
+                    const poolDetail = yield this.getPool(saver.pool);
+                    const depositAmount = new xchainUtil.CryptoAmount(xchainUtil.baseAmount(saver.assetAdded).minus(saver.assetWithdrawn), asset);
+                    const ownerUnits = Number(saver === null || saver === void 0 ? void 0 : saver.saverUnits);
+                    const saverUnits = Number(poolDetail.saversUnits);
+                    const assetDepth = Number(poolDetail.saversDepth);
+                    const redeemableValue = (ownerUnits / saverUnits) * assetDepth;
+                    const redeemableAssetAmount = new xchainUtil.CryptoAmount(xchainUtil.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,
+                    });
+                }
+            }));
+            yield Promise.all(allPositionsPromises);
+            return saversPositions;
+        });
+    }
+    getDecimalForAsset(asset) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!isAssetRuneNative(asset)) {
+                const pool = yield this.getPool(xchainUtil.assetToString(asset));
+                const decimals = Number(pool.nativeDecimal);
+                if (decimals > 0)
+                    return decimals;
+                else
+                    return DEFAULT_THORCHAIN_DECIMALS;
+            }
+            return DEFAULT_THORCHAIN_DECIMALS;
+        });
+    }
+}
+
+exports.Midgard = Midgard;
+exports.MidgardCache = MidgardCache;
+exports.MidgardQuery = MidgardQuery;
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../src/utils/midgard.ts","../src/midgard-cache.ts","../src/utils/const.ts","../src/midgard-query.ts"],"sourcesContent":["import { Network } from '@xchainjs/xchain-client'\nimport { Configuration, MidgardApi, PoolDetail, SaverDetails } from '@xchainjs/xchain-midgard'\nimport axios from 'axios'\nimport axiosRetry from 'axios-retry'\n\nimport { MidgardConfig } from '../types'\n\nconst defaultMidgardConfig: Record<Network, MidgardConfig> = {\n  mainnet: {\n    apiRetries: 3,\n    midgardBaseUrls: ['https://midgard.ninerealms.com'],\n  },\n  stagenet: {\n    apiRetries: 3,\n    midgardBaseUrls: ['https://stagenet-midgard.ninerealms.com'],\n  },\n  testnet: {\n    apiRetries: 3,\n    midgardBaseUrls: ['https://testnet.midgard.thorchain.info'],\n  },\n}\n\nexport class Midgard {\n  private config: MidgardConfig\n  readonly network: Network\n  private midgardApis: MidgardApi[]\n\n  constructor(network: Network = Network.Mainnet, config?: MidgardConfig) {\n    this.network = network\n    this.config = config ?? defaultMidgardConfig[this.network]\n    axiosRetry(axios, { retries: this.config.apiRetries, retryDelay: axiosRetry.exponentialDelay })\n    this.midgardApis = this.config.midgardBaseUrls.map(\n      (url: string) => new MidgardApi(new Configuration({ basePath: url })),\n    )\n  }\n\n  /**\n   * Function to return member details based on valid liquidity position\n   * @param address - query can also be multiple addresses should be separated by comma\n   * @returns - object type of Member Detail\n   */\n  public async getSavers(address: string): Promise<SaverDetails> {\n    for (const api of this.midgardApis) {\n      try {\n        const saverDetails = (await api.getSaverDetail(address)).data\n        return saverDetails\n      } catch (e) {\n        //console.error(e)\n      }\n    }\n    throw Error(`Midgard not responding`)\n  }\n\n  /**\n   *\n   * @returns an array of Pools\n   */\n  async getPools(): Promise<PoolDetail[]> {\n    for (const api of this.midgardApis) {\n      try {\n        return (await api.getPools()).data\n      } catch (e) {\n        //console.error(e)\n      }\n    }\n    throw new Error(`Midgard not responding`)\n  }\n}\n","import { PoolDetail, SaverDetails } from '@xchainjs/xchain-midgard'\nimport { CachedValue } from '@xchainjs/xchain-util'\n\nimport { Midgard } from './utils/midgard'\n\nconst MILLISECOND_CACHE_POOLS = 5000\nconst MILLISECOND_CACHE_SAVERS = 5000\n\nconst defaultMidgard = new Midgard()\n\n/**\n * This class manages retrieving information from Midgard API and cached it\n */\nexport class MidgardCache {\n  private readonly midgard: Midgard\n  private readonly cachedPools: CachedValue<PoolDetail[]>\n  private readonly cachedSavers: CachedValue<SaverDetails>\n  /**\n   * Constructor to create a ThorchainCache\n   *\n   * @param midgard - an instance of the midgard API (could be pointing to stagenet,testnet,mainnet)\n   * @returns MidgardCache\n   */\n  constructor(midgard = defaultMidgard) {\n    this.midgard = midgard\n    this.cachedPools = new CachedValue<PoolDetail[]>(() => this.midgard.getPools(), MILLISECOND_CACHE_POOLS)\n    this.cachedSavers = new CachedValue<SaverDetails>(() => this.midgard.getSavers(''), MILLISECOND_CACHE_SAVERS)\n  }\n\n  public async getPools(): Promise<PoolDetail[]> {\n    return this.cachedPools.getValue()\n  }\n\n  public async getSavers(address: string): Promise<SaverDetails> {\n    return this.cachedSavers.getValue(address)\n  }\n}\n","import { Asset, assetFromStringEx, assetToString } from '@xchainjs/xchain-util'\n\nexport const AssetAVAX = assetFromStringEx('AVAX.AVAX')\nexport const AssetBTC = assetFromStringEx('BTC.BTC')\nexport const AssetATOM = assetFromStringEx('GAIA.ATOM')\nexport const AssetRuneNative = assetFromStringEx('THOR.RUNE')\n\nexport const BTCChain = 'BTC'\nexport const GAIAChain = 'GAIA'\nexport const AVAXChain = 'AVAX'\n\nexport const isAssetRuneNative = (asset: Asset): boolean => assetToString(asset) === assetToString(AssetRuneNative)\n","import { PoolDetail } from '@xchainjs/xchain-midgard'\nimport { Asset, CryptoAmount, assetFromString, assetToString, baseAmount } from '@xchainjs/xchain-util'\n\nimport { MidgardCache } from './midgard-cache'\nimport { SaversPosition, getSaver } from './types'\nimport { isAssetRuneNative } from './utils/const'\n\nconst DEFAULT_THORCHAIN_DECIMALS = 8\n\nconst defaultCache = new MidgardCache()\n\n/**\n * THORChain Class for getting  data from Midgard API (THORChain L2 Api).\n */\nexport class MidgardQuery {\n  readonly midgardCache: MidgardCache\n\n  /**\n   * Contructor to create a ThorchainAMM\n   *\n   * @param midgardCache - an instance of the midgardCache (could be pointing to stagenet,testnet,mainnet)\n   * @returns ThorchainAMM\n   */\n  constructor(midgardCache = defaultCache) {\n    this.midgardCache = midgardCache\n  }\n\n  private async getPool(asset: string): Promise<PoolDetail> {\n    const pools = await this.midgardCache.getPools()\n    const pool = pools.find((pool) => pool.asset === asset)\n    if (!pool) {\n      throw new Error(`Can't find pool for asset: ${asset}`)\n    }\n    return pool\n  }\n\n  public async getSaverPositions(params: getSaver[]): Promise<SaversPosition[]> {\n    const addresses: Set<string> = new Set<string>()\n    params.forEach((param) => addresses.add(param.address))\n    const addressesString: string = Array.from(addresses).join(',')\n    const saversDetail = await this.midgardCache.getSavers(addressesString)\n    const errors: string[] = []\n\n    const saversPositions: SaversPosition[] = []\n    const allPositionsPromises = saversDetail.pools.map(async (saver) => {\n      const asset = assetFromString(saver.pool)\n\n      if (asset) {\n        const poolDetail = await this.getPool(saver.pool)\n        const depositAmount = new CryptoAmount(baseAmount(saver.assetAdded).minus(saver.assetWithdrawn), asset)\n        const ownerUnits = Number(saver?.saverUnits)\n        const saverUnits = Number(poolDetail.saversUnits)\n        const assetDepth = Number(poolDetail.saversDepth)\n        const redeemableValue = (ownerUnits / saverUnits) * assetDepth\n        const redeemableAssetAmount = new CryptoAmount(baseAmount(redeemableValue), asset)\n        const saverGrowth = redeemableAssetAmount.minus(depositAmount).div(depositAmount).times(100)\n        const saversAge = (Date.now() / 1000 - Number(saver.dateLastAdded)) / (365 * 86400)\n\n        saversPositions.push({\n          depositValue: depositAmount,\n          redeemableValue: redeemableAssetAmount,\n          lastAddHeight: -1,\n          percentageGrowth: saverGrowth.assetAmount.amount().toNumber(),\n          ageInYears: saversAge,\n          ageInDays: saversAge * 365,\n          asset,\n          errors,\n        })\n      }\n    })\n    await Promise.all(allPositionsPromises)\n    return saversPositions\n  }\n\n  public async getDecimalForAsset(asset: Asset): Promise<number> {\n    if (!isAssetRuneNative(asset)) {\n      const pool = await this.getPool(assetToString(asset))\n      const decimals = Number(pool.nativeDecimal)\n      if (decimals > 0) return decimals\n      else return DEFAULT_THORCHAIN_DECIMALS\n    }\n    return DEFAULT_THORCHAIN_DECIMALS\n  }\n}\n"],"names":["Network","axiosRetry","axios","MidgardApi","Configuration","CachedValue","assetFromStringEx","assetToString","assetFromString","CryptoAmount","baseAmount"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAOA,MAAM,oBAAoB,GAAmC;AAC3D,IAAA,OAAO,EAAE;AACP,QAAA,UAAU,EAAE,CAAC;QACb,eAAe,EAAE,CAAC,gCAAgC,CAAC;AACpD,KAAA;AACD,IAAA,QAAQ,EAAE;AACR,QAAA,UAAU,EAAE,CAAC;QACb,eAAe,EAAE,CAAC,yCAAyC,CAAC;AAC7D,KAAA;AACD,IAAA,OAAO,EAAE;AACP,QAAA,UAAU,EAAE,CAAC;QACb,eAAe,EAAE,CAAC,wCAAwC,CAAC;AAC5D,KAAA;CACF,CAAA;MAEY,OAAO,CAAA;AAKlB,IAAA,WAAA,CAAY,OAAmB,GAAAA,oBAAO,CAAC,OAAO,EAAE,MAAsB,EAAA;AACpE,QAAA,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;AACtB,QAAA,IAAI,CAAC,MAAM,GAAG,MAAM,aAAN,MAAM,KAAA,KAAA,CAAA,GAAN,MAAM,GAAI,oBAAoB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;AAC1D,QAAAC,8BAAU,CAACC,yBAAK,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,UAAU,EAAED,8BAAU,CAAC,gBAAgB,EAAE,CAAC,CAAA;AAC/F,QAAA,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,GAAG,CAChD,CAAC,GAAW,KAAK,IAAIE,wBAAU,CAAC,IAAIC,2BAAa,CAAC,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC,CAAC,CACtE,CAAA;KACF;AAED;;;;AAIG;AACU,IAAA,SAAS,CAAC,OAAe,EAAA;;AACpC,YAAA,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,WAAW,EAAE;gBAClC,IAAI;AACF,oBAAA,MAAM,YAAY,GAAG,CAAC,MAAM,GAAG,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,IAAI,CAAA;AAC7D,oBAAA,OAAO,YAAY,CAAA;AACpB,iBAAA;AAAC,gBAAA,OAAO,CAAC,EAAE;;AAEX,iBAAA;AACF,aAAA;AACD,YAAA,MAAM,KAAK,CAAC,CAAwB,sBAAA,CAAA,CAAC,CAAA;SACtC,CAAA,CAAA;AAAA,KAAA;AAED;;;AAGG;IACG,QAAQ,GAAA;;AACZ,YAAA,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,WAAW,EAAE;gBAClC,IAAI;oBACF,OAAO,CAAC,MAAM,GAAG,CAAC,QAAQ,EAAE,EAAE,IAAI,CAAA;AACnC,iBAAA;AAAC,gBAAA,OAAO,CAAC,EAAE;;AAEX,iBAAA;AACF,aAAA;AACD,YAAA,MAAM,IAAI,KAAK,CAAC,CAAA,sBAAA,CAAwB,CAAC,CAAA;SAC1C,CAAA,CAAA;AAAA,KAAA;AACF;;AC9DD,MAAM,uBAAuB,GAAG,IAAI,CAAA;AACpC,MAAM,wBAAwB,GAAG,IAAI,CAAA;AAErC,MAAM,cAAc,GAAG,IAAI,OAAO,EAAE,CAAA;AAEpC;;AAEG;MACU,YAAY,CAAA;AAIvB;;;;;AAKG;IACH,WAAY,CAAA,OAAO,GAAG,cAAc,EAAA;AAClC,QAAA,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;AACtB,QAAA,IAAI,CAAC,WAAW,GAAG,IAAIC,sBAAW,CAAe,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,uBAAuB,CAAC,CAAA;QACxG,IAAI,CAAC,YAAY,GAAG,IAAIA,sBAAW,CAAe,MAAM,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,wBAAwB,CAAC,CAAA;KAC9G;IAEY,QAAQ,GAAA;;AACnB,YAAA,OAAO,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAA;SACnC,CAAA,CAAA;AAAA,KAAA;AAEY,IAAA,SAAS,CAAC,OAAe,EAAA;;YACpC,OAAO,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAA;SAC3C,CAAA,CAAA;AAAA,KAAA;AACF;;AClCwBC,4BAAiB,CAAC,WAAW,EAAC;AAC/BA,4BAAiB,CAAC,SAAS,EAAC;AAC3BA,4BAAiB,CAAC,WAAW,EAAC;AAChD,MAAM,eAAe,GAAGA,4BAAiB,CAAC,WAAW,CAAC,CAAA;AAMtD,MAAM,iBAAiB,GAAG,CAAC,KAAY,KAAcC,wBAAa,CAAC,KAAK,CAAC,KAAKA,wBAAa,CAAC,eAAe,CAAC;;ACJnH,MAAM,0BAA0B,GAAG,CAAC,CAAA;AAEpC,MAAM,YAAY,GAAG,IAAI,YAAY,EAAE,CAAA;AAEvC;;AAEG;MACU,YAAY,CAAA;AAGvB;;;;;AAKG;IACH,WAAY,CAAA,YAAY,GAAG,YAAY,EAAA;AACrC,QAAA,IAAI,CAAC,YAAY,GAAG,YAAY,CAAA;KACjC;AAEa,IAAA,OAAO,CAAC,KAAa,EAAA;;YACjC,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAA;AAChD,YAAA,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,KAAK,KAAK,KAAK,CAAC,CAAA;YACvD,IAAI,CAAC,IAAI,EAAE;AACT,gBAAA,MAAM,IAAI,KAAK,CAAC,8BAA8B,KAAK,CAAA,CAAE,CAAC,CAAA;AACvD,aAAA;AACD,YAAA,OAAO,IAAI,CAAA;SACZ,CAAA,CAAA;AAAA,KAAA;AAEY,IAAA,iBAAiB,CAAC,MAAkB,EAAA;;AAC/C,YAAA,MAAM,SAAS,GAAgB,IAAI,GAAG,EAAU,CAAA;AAChD,YAAA,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,KAAK,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAA;AACvD,YAAA,MAAM,eAAe,GAAW,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YAC/D,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,eAAe,CAAC,CAAA;YACvE,MAAM,MAAM,GAAa,EAAE,CAAA;YAE3B,MAAM,eAAe,GAAqB,EAAE,CAAA;YAC5C,MAAM,oBAAoB,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAO,KAAK,KAAI,SAAA,CAAA,IAAA,EAAA,KAAA,CAAA,EAAA,KAAA,CAAA,EAAA,aAAA;gBAClE,MAAM,KAAK,GAAGC,0BAAe,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;AAEzC,gBAAA,IAAI,KAAK,EAAE;oBACT,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;oBACjD,MAAM,aAAa,GAAG,IAAIC,uBAAY,CAACC,qBAAU,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,cAAc,CAAC,EAAE,KAAK,CAAC,CAAA;AACvG,oBAAA,MAAM,UAAU,GAAG,MAAM,CAAC,KAAK,KAAA,IAAA,IAAL,KAAK,KAAA,KAAA,CAAA,GAAA,KAAA,CAAA,GAAL,KAAK,CAAE,UAAU,CAAC,CAAA;oBAC5C,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAA;oBACjD,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAA;oBACjD,MAAM,eAAe,GAAG,CAAC,UAAU,GAAG,UAAU,IAAI,UAAU,CAAA;AAC9D,oBAAA,MAAM,qBAAqB,GAAG,IAAID,uBAAY,CAACC,qBAAU,CAAC,eAAe,CAAC,EAAE,KAAK,CAAC,CAAA;AAClF,oBAAA,MAAM,WAAW,GAAG,qBAAqB,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;oBAC5F,MAAM,SAAS,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,KAAK,GAAG,GAAG,KAAK,CAAC,CAAA;oBAEnF,eAAe,CAAC,IAAI,CAAC;AACnB,wBAAA,YAAY,EAAE,aAAa;AAC3B,wBAAA,eAAe,EAAE,qBAAqB;wBACtC,aAAa,EAAE,CAAC,CAAC;wBACjB,gBAAgB,EAAE,WAAW,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;AAC7D,wBAAA,UAAU,EAAE,SAAS;wBACrB,SAAS,EAAE,SAAS,GAAG,GAAG;wBAC1B,KAAK;wBACL,MAAM;AACP,qBAAA,CAAC,CAAA;AACH,iBAAA;aACF,CAAA,CAAC,CAAA;AACF,YAAA,MAAM,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAA;AACvC,YAAA,OAAO,eAAe,CAAA;SACvB,CAAA,CAAA;AAAA,KAAA;AAEY,IAAA,kBAAkB,CAAC,KAAY,EAAA;;AAC1C,YAAA,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,EAAE;AAC7B,gBAAA,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAACH,wBAAa,CAAC,KAAK,CAAC,CAAC,CAAA;gBACrD,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAA;gBAC3C,IAAI,QAAQ,GAAG,CAAC;AAAE,oBAAA,OAAO,QAAQ,CAAA;;AAC5B,oBAAA,OAAO,0BAA0B,CAAA;AACvC,aAAA;AACD,YAAA,OAAO,0BAA0B,CAAA;SAClC,CAAA,CAAA;AAAA,KAAA;AACF;;;;;;"}

package/lib/midgard-cache.d.ts

@@ -0,0 +1,19 @@
+import { PoolDetail, SaverDetails } from '@xchainjs/xchain-midgard';
+import { Midgard } from './utils/midgard';
+/**
+ * This class manages retrieving information from Midgard API and cached it
+ */
+export declare class MidgardCache {
+    private readonly midgard;
+    private readonly cachedPools;
+    private readonly cachedSavers;
+    /**
+     * Constructor to create a ThorchainCache
+     *
+     * @param midgard - an instance of the midgard API (could be pointing to stagenet,testnet,mainnet)
+     * @returns MidgardCache
+     */
+    constructor(midgard?: Midgard);
+    getPools(): Promise<PoolDetail[]>;
+    getSavers(address: string): Promise<SaverDetails>;
+}

package/lib/midgard-query.d.ts

@@ -0,0 +1,19 @@
+import { Asset } from '@xchainjs/xchain-util';
+import { MidgardCache } from './midgard-cache';
+import { SaversPosition, getSaver } from './types';
+/**
+ * THORChain Class for getting  data from Midgard API (THORChain L2 Api).
+ */
+export declare class MidgardQuery {
+    readonly midgardCache: MidgardCache;
+    /**
+     * Contructor to create a ThorchainAMM
+     *
+     * @param midgardCache - an instance of the midgardCache (could be pointing to stagenet,testnet,mainnet)
+     * @returns ThorchainAMM
+     */
+    constructor(midgardCache?: MidgardCache);
+    private getPool;
+    getSaverPositions(params: getSaver[]): Promise<SaversPosition[]>;
+    getDecimalForAsset(asset: Asset): Promise<number>;
+}

package/lib/types.d.ts

@@ -0,0 +1,20 @@
+import { Address, Asset, CryptoAmount } from '@xchainjs/xchain-util';
+export type getSaver = {
+    asset: Asset;
+    address: Address;
+    height?: number;
+};
+export type SaversPosition = {
+    depositValue: CryptoAmount;
+    redeemableValue: CryptoAmount;
+    lastAddHeight: number;
+    percentageGrowth: number;
+    ageInYears: number;
+    ageInDays: number;
+    asset: Asset;
+    errors: string[];
+};
+export type MidgardConfig = {
+    apiRetries: number;
+    midgardBaseUrls: string[];
+};

package/lib/utils/const.d.ts

@@ -0,0 +1,9 @@
+import { Asset } from '@xchainjs/xchain-util';
+export declare const AssetAVAX: Asset;
+export declare const AssetBTC: Asset;
+export declare const AssetATOM: Asset;
+export declare const AssetRuneNative: Asset;
+export declare const BTCChain = "BTC";
+export declare const GAIAChain = "GAIA";
+export declare const AVAXChain = "AVAX";
+export declare const isAssetRuneNative: (asset: Asset) => boolean;

package/lib/utils/index.d.ts

@@ -0,0 +1 @@
+export * from './midgard';

package/lib/utils/midgard.d.ts

@@ -0,0 +1,20 @@
+import { Network } from '@xchainjs/xchain-client';
+import { PoolDetail, SaverDetails } from '@xchainjs/xchain-midgard';
+import { MidgardConfig } from '../types';
+export declare class Midgard {
+    private config;
+    readonly network: Network;
+    private midgardApis;
+    constructor(network?: Network, config?: MidgardConfig);
+    /**
+     * 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: string): Promise<SaverDetails>;
+    /**
+     *
+     * @returns an array of Pools
+     */
+    getPools(): Promise<PoolDetail[]>;
+}

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@xchainjs/xchain-midgard-query",
+  "version": "0.1.0",
+  "license": "MIT",
+  "description": "Module that is responsible for get data from Midgard API",
+  "keywords": [
+    "XChain"
+  ],
+  "author": "THORChain",
+  "homepage": "https://github.com/xchainjs/xchainjs-lib#readme",
+  "main": "lib/index.js",
+  "module": "lib/index.esm.js",
+  "typings": "lib/index.d.ts",
+  "directories": {
+    "lib": "lib",
+    "test": "__tests__"
+  },
+  "files": [
+    "lib"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:xchainjs/xchainjs-lib.git"
+  },
+  "scripts": {
+    "clean": "rimraf lib/**",
+    "build": "yarn clean && rollup -c",
+    "test": "jest",
+    "e2e": "jest --config jest.config.e2e.js",
+    "lint": "eslint \"{src,__tests__}/**/*.ts\" --fix --max-warnings 0",
+    "prepublishOnly": "yarn build",
+    "postversion": "git push --follow-tags"
+  },
+  "devDependencies": {
+    "@xchainjs/xchain-client": "^0.14.1",
+    "@xchainjs/xchain-midgard": "^0.5.1",
+    "@xchainjs/xchain-util": "^0.13.1",
+    "axios": "^1.3.6",
+    "axios-retry": "^3.2.5",
+    "bignumber.js": "^9.0.0"
+  },
+  "peerDependencies": {
+    "@xchainjs/xchain-client": "^0.14.1",
+    "@xchainjs/xchain-midgard": "^0.5.1",
+    "@xchainjs/xchain-util": "^0.13.1",
+    "axios": "^1.3.6",
+    "axios-retry": "^3.2.5",
+    "bignumber.js": "^9.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}