impermax-sdk 1.2.112 → 2.0.0

package/lib/offchain/offchainEndpointManager.js

@@ -1,126 +1,126 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (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());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const apollo_client_1 = __importDefault(require("apollo-client"));
-const apollo_link_http_1 = require("apollo-link-http");
-const apollo_cache_inmemory_1 = require("apollo-cache-inmemory");
-const queries_1 = require("./queries");
-class OffchainEndpointManager {
-    constructor() {
-        // Get the param:
-        // 1. ?endpoint=thegraph for thegraph
-        // 2. ?endpoint=ibexer for ponder
-        // 3. none for both and picks the best of the 2
-        this.endpoint = null;
-        // https://stackoverflow.com/questions/32598971/whats-the-purpose-of-if-typeof-window-undefined
-        this.endpoint = typeof window !== 'undefined' ? this.getPreferredEndpoint(window.location.search) : null;
-    }
-    // ---------------- Getter ---------------- //
-    /**
-     * Main fetcher function to query from multiple endpoints. The query MUST have _meta included.
-     *
-     * @param endpoints - Array of endpoints
-     * @param network - The network of the request (needed for the block due to ponder's `_meta` result)
-     * @param queryBuilder - The query requested from IQueryBuilder interface (ie. `lendingPoolQuery`, `tvlQuery`, etc.)
-     */
-    fetch(endpoints, network, queryBuilder) {
-        return __awaiter(this, void 0, void 0, function* () {
-            // This is a test as we roll this out, to filter pass URL search param with thegraph or ibexer
-            const filteredEndpoints = this.filterEndpoints(endpoints);
-            if (filteredEndpoints.length === 0) {
-                console.warn("No endpoints available after filtering");
-                return null;
-            }
-            const endpointQueries = filteredEndpoints.map(endpoint => ({
-                endpoint,
-                query: queryBuilder(queries_1.QueryBuilderFactory.getQuery(endpoint)),
-            }));
-            const endpointResults = yield Promise.allSettled(endpointQueries.map(eq => this.fetchFromEndpoint(eq)));
-            // If one endpoint breaks then it shouldnt break, filter it out and report
-            const responses = endpointResults
-                .filter((result, index) => {
-                if (result.status === "rejected") {
-                    console.log(`${endpointQueries[index].endpoint} is down?`);
-                }
-                return result.status === 'fulfilled';
-            })
-                .map(result => result.value);
-            const latestResponse = this.bestEndpointBlock(responses, network);
-            if (!latestResponse) {
-                console.error("Cant find endpoint block");
-                return null;
-            }
-            // Transform the data if needed in case of ponder or different api responses
-            return queries_1.QueryBuilderFactory.transformData(latestResponse.result);
-        });
-    }
-    // ---------------- Private ---------------- //
-    /**
-     * Fetch a query from an endpoint (ponder, thegraph, etc.)
-     */
-    fetchFromEndpoint({ endpoint, query }) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const client = new apollo_client_1.default({
-                link: new apollo_link_http_1.HttpLink({ uri: endpoint }),
-                cache: new apollo_cache_inmemory_1.InMemoryCache()
-            });
-            const result = yield client.query({
-                query,
-                fetchPolicy: 'cache-first'
-            });
-            return { endpoint, result };
-        });
-    }
-    /**
-     * Given an array of responses from endpoint query, get the response wiht the latest block number
-     */
-    bestEndpointBlock(responses, network) {
-        if (!responses.length)
-            return null;
-        let bestEndpoint = responses[0];
-        let maxBlockNumber = 0;
-        for (const response of responses) {
-            const queryBuilder = queries_1.QueryBuilderFactory.getQuery(response.endpoint);
-            const blockNumber = queryBuilder.getBlockNumber(response.result, network);
-            if (blockNumber > maxBlockNumber && response.result.data) {
-                maxBlockNumber = blockNumber;
-                bestEndpoint = response;
-            }
-        }
-        return Object.assign(Object.assign({}, bestEndpoint), { maxBlockNumber });
-    }
-    // ---------------- Monitoring ---------------- //
-    filterEndpoints(endpoints) {
-        // No endpoint passed, ignore
-        if (!this.endpoint)
-            return endpoints;
-        const preferredEndpoint = this.endpoint === "thegraph" ? "thegraph" : "railway";
-        return endpoints.filter(endpoint => endpoint.includes(preferredEndpoint));
-    }
-    getPreferredEndpoint(searchParams) {
-        const urlParams = new URLSearchParams(searchParams);
-        const endpoint = urlParams.get("endpoint");
-        if (!endpoint)
-            return null;
-        switch (endpoint.toLowerCase()) {
-            case "thegraph":
-                return "thegraph";
-            case "ibexer":
-                return "ibexer";
-            default:
-                return null;
-        }
-    }
-}
-exports.default = OffchainEndpointManager;
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const apollo_client_1 = __importDefault(require("apollo-client"));
+const apollo_link_http_1 = require("apollo-link-http");
+const apollo_cache_inmemory_1 = require("apollo-cache-inmemory");
+const queries_1 = require("./queries");
+class OffchainEndpointManager {
+    constructor() {
+        // Get the param:
+        // 1. ?endpoint=thegraph for thegraph
+        // 2. ?endpoint=ibexer for ponder
+        // 3. none for both and picks the best of the 2
+        this.endpoint = null;
+        // https://stackoverflow.com/questions/32598971/whats-the-purpose-of-if-typeof-window-undefined
+        this.endpoint = typeof window !== 'undefined' ? this.getPreferredEndpoint(window.location.search) : null;
+    }
+    // ---------------- Getter ---------------- //
+    /**
+     * Main fetcher function to query from multiple endpoints. The query MUST have _meta included.
+     *
+     * @param endpoints - Array of endpoints
+     * @param network - The network of the request (needed for the block due to ponder's `_meta` result)
+     * @param queryBuilder - The query requested from IQueryBuilder interface (ie. `lendingPoolQuery`, `tvlQuery`, etc.)
+     */
+    fetch(endpoints, network, queryBuilder) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // This is a test as we roll this out, to filter pass URL search param with thegraph or ibexer
+            const filteredEndpoints = this.filterEndpoints(endpoints);
+            if (filteredEndpoints.length === 0) {
+                console.warn("No endpoints available after filtering");
+                return null;
+            }
+            const endpointQueries = filteredEndpoints.map(endpoint => ({
+                endpoint,
+                query: queryBuilder(queries_1.QueryBuilderFactory.getQuery(endpoint)),
+            }));
+            const endpointResults = yield Promise.allSettled(endpointQueries.map(eq => this.fetchFromEndpoint(eq)));
+            // If one endpoint breaks then it shouldnt break, filter it out and report
+            const responses = endpointResults
+                .filter((result, index) => {
+                if (result.status === "rejected") {
+                    console.log(`${endpointQueries[index].endpoint} is down?`);
+                }
+                return result.status === 'fulfilled';
+            })
+                .map(result => result.value);
+            const latestResponse = this.bestEndpointBlock(responses, network);
+            if (!latestResponse) {
+                console.error("Cant find endpoint block");
+                return null;
+            }
+            // Transform the data if needed in case of ponder or different api responses
+            return queries_1.QueryBuilderFactory.transformData(latestResponse.result);
+        });
+    }
+    // ---------------- Private ---------------- //
+    /**
+     * Fetch a query from an endpoint (ponder, thegraph, etc.)
+     */
+    fetchFromEndpoint({ endpoint, query }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const client = new apollo_client_1.default({
+                link: new apollo_link_http_1.HttpLink({ uri: endpoint }),
+                cache: new apollo_cache_inmemory_1.InMemoryCache()
+            });
+            const result = yield client.query({
+                query,
+                fetchPolicy: 'cache-first'
+            });
+            return { endpoint, result };
+        });
+    }
+    /**
+     * Given an array of responses from endpoint query, get the response wiht the latest block number
+     */
+    bestEndpointBlock(responses, network) {
+        if (!responses.length)
+            return null;
+        let bestEndpoint = responses[0];
+        let maxBlockNumber = 0;
+        for (const response of responses) {
+            const queryBuilder = queries_1.QueryBuilderFactory.getQuery(response.endpoint);
+            const blockNumber = queryBuilder.getBlockNumber(response.result, network);
+            if (blockNumber > maxBlockNumber && response.result.data) {
+                maxBlockNumber = blockNumber;
+                bestEndpoint = response;
+            }
+        }
+        return Object.assign(Object.assign({}, bestEndpoint), { maxBlockNumber });
+    }
+    // ---------------- Monitoring ---------------- //
+    filterEndpoints(endpoints) {
+        // No endpoint passed, ignore
+        if (!this.endpoint)
+            return endpoints;
+        const preferredEndpoint = this.endpoint === "thegraph" ? "thegraph" : "railway";
+        return endpoints.filter(endpoint => endpoint.includes(preferredEndpoint));
+    }
+    getPreferredEndpoint(searchParams) {
+        const urlParams = new URLSearchParams(searchParams);
+        const endpoint = urlParams.get("endpoint");
+        if (!endpoint)
+            return null;
+        switch (endpoint.toLowerCase()) {
+            case "thegraph":
+                return "thegraph";
+            case "ibexer":
+                return "ibexer";
+            default:
+                return null;
+        }
+    }
+}
+exports.default = OffchainEndpointManager;

package/lib/offchain/offchainInitializer.d.ts

@@ -1,52 +1,52 @@
-import { ApolloQueryResult } from "apollo-client";
-import { DocumentNode } from "graphql";
-import { Address, AddressIndex, Factory, FactoryIndex, LendingPoolIndex, WhitelistState } from '../config/types';
-import { Amms } from '../config/amms';
-import { LendingPoolData, LendingVaultData, LendingVaultPosition, RawUserData, TvlData, UserData, WhitelistData, XimxData } from './offchainTypes';
-import Offchain from './offchain';
-export declare function apolloFetcher(subgraphUrl: string, query: DocumentNode): Promise<ApolloQueryResult<any>>;
-export declare function fetchBlockByTimestamp(this: Offchain, timestamp: number): Promise<number | null>;
-export declare function fetchLendingPools(this: Offchain): Promise<FactoryIndex<LendingPoolData[]>>;
-export declare function fetchLendingPoolsPast(this: Offchain, seconds: number): Promise<FactoryIndex<any[]> | null>;
-export declare function fetchImpermaxChefRewardRates(this: Offchain): Promise<AddressIndex<Array<{
-    rewardToken: Address;
-    rewardRate: number;
-}>> | null>;
-export declare function fetchPastVolume(this: Offchain, amm: Amms, lendingPools: LendingPoolData[], seconds: number): Promise<AddressIndex<number>>;
-export declare function fetchCurrentVolumeAndReserves(this: Offchain, amm: Amms, lendingPools: LendingPoolData[]): Promise<{
-    currentVolume: AddressIndex<number>;
-    currentReserve: AddressIndex<number>;
-}>;
-export declare function fetchUniswapAPR(this: Offchain, lendingPoolsByAmm: {
-    [key in Amms]?: LendingPoolData[];
-}, seconds?: number): Promise<AddressIndex<number>>;
-export declare function initializeLendingPoolsData(this: Offchain): Promise<LendingPoolIndex<LendingPoolData>>;
-export declare function getLendingPoolsData(this: Offchain): Promise<LendingPoolIndex<LendingPoolData>>;
-export declare function getLendingPoolData(this: Offchain, factory: Factory, uniswapV2PairAddress: Address): Promise<LendingPoolData>;
-export declare function initializeTvlData(this: Offchain): Promise<TvlData>;
-export declare function getTvlData(this: Offchain): Promise<TvlData>;
-export declare function fetchUserData(this: Offchain, account: Address): Promise<FactoryIndex<RawUserData>>;
-export declare function initializeUserData(this: Offchain, account: Address): Promise<FactoryIndex<UserData> | null>;
-export declare function getUserData(this: Offchain, account: Address): Promise<FactoryIndex<UserData> | null>;
-export declare function initializeXimxData(this: Offchain): Promise<XimxData>;
-export declare function getXimxData(this: Offchain): Promise<XimxData>;
-/**
- * Lending Vault
- **/
-export declare function fetchLendingVaults(this: Offchain): Promise<LendingVaultData[]>;
-export declare function initializeLendingVaultsData(this: Offchain): Promise<AddressIndex<LendingVaultData>>;
-export declare function getLendingVaultsData(this: Offchain): Promise<AddressIndex<LendingVaultData>>;
-export declare function getLendingVaultData(this: Offchain, lendingVaultAddress: Address): Promise<LendingVaultData>;
-/**
- * Whitelist
- */
-export declare function fetchWhitelist(this: Offchain): Promise<WhitelistData[]>;
-export declare function initializeWhitelistData(this: Offchain): Promise<LendingPoolIndex<WhitelistState>>;
-export declare function getWhitelistData(this: Offchain): Promise<LendingPoolIndex<WhitelistState>>;
-export declare function getWhitelistState(this: Offchain, factory: Factory, pair: Address): Promise<WhitelistState>;
-/**
- * User Data
- */
-export declare function fetchLendingVaultsUserData(this: Offchain, account: Address): Promise<LendingVaultPosition[] | null>;
-export declare function initializeLendingVaultsUserData(this: Offchain, account: Address): Promise<AddressIndex<LendingVaultPosition> | null>;
-export declare function getLendingVaultsUserData(this: Offchain, account: Address): Promise<AddressIndex<LendingVaultPosition> | null>;
+import { ApolloQueryResult } from "apollo-client";
+import { DocumentNode } from "graphql";
+import { Address, AddressIndex, Factory, FactoryIndex, LendingPoolIndex, WhitelistState } from '../config/types';
+import { Amms } from '../config/amms';
+import { LendingPoolData, LendingVaultData, VaultPosition, RawUserData, TvlData, UserData, WhitelistData, XimxData } from './offchainTypes';
+import Offchain from './offchain';
+export declare function apolloFetcher(subgraphUrl: string, query: DocumentNode): Promise<ApolloQueryResult<any>>;
+export declare function fetchBlockByTimestamp(this: Offchain, timestamp: number): Promise<number | null>;
+export declare function fetchLendingPools(this: Offchain): Promise<FactoryIndex<LendingPoolData[]>>;
+export declare function fetchLendingPoolsPast(this: Offchain, seconds: number): Promise<FactoryIndex<any[]> | null>;
+export declare function fetchImpermaxChefRewardRates(this: Offchain): Promise<AddressIndex<Array<{
+    rewardToken: Address;
+    rewardRate: number;
+}>> | null>;
+export declare function fetchPastVolume(this: Offchain, amm: Amms, lendingPools: LendingPoolData[], seconds: number): Promise<AddressIndex<number>>;
+export declare function fetchCurrentVolumeAndReserves(this: Offchain, amm: Amms, lendingPools: LendingPoolData[]): Promise<{
+    currentVolume: AddressIndex<number>;
+    currentReserve: AddressIndex<number>;
+}>;
+export declare function fetchUniswapAPR(this: Offchain, lendingPoolsByAmm: {
+    [key in Amms]?: LendingPoolData[];
+}, seconds?: number): Promise<AddressIndex<number>>;
+export declare function initializeLendingPoolsData(this: Offchain): Promise<LendingPoolIndex<LendingPoolData>>;
+export declare function getLendingPoolsData(this: Offchain): Promise<LendingPoolIndex<LendingPoolData>>;
+export declare function getLendingPoolData(this: Offchain, factory: Factory, uniswapV2PairAddress: Address): Promise<LendingPoolData>;
+export declare function initializeTvlData(this: Offchain): Promise<TvlData>;
+export declare function getTvlData(this: Offchain): Promise<TvlData>;
+export declare function fetchUserData(this: Offchain, account: Address): Promise<FactoryIndex<RawUserData>>;
+export declare function initializeUserData(this: Offchain, account: Address): Promise<FactoryIndex<UserData> | null>;
+export declare function getUserData(this: Offchain, account: Address): Promise<FactoryIndex<UserData> | null>;
+export declare function initializeXimxData(this: Offchain): Promise<XimxData>;
+export declare function getXimxData(this: Offchain): Promise<XimxData>;
+/**
+ * Lending Vault
+ **/
+export declare function fetchLendingVaults(this: Offchain): Promise<LendingVaultData[]>;
+export declare function initializeLendingVaultsData(this: Offchain): Promise<AddressIndex<LendingVaultData>>;
+export declare function getLendingVaultsData(this: Offchain): Promise<AddressIndex<LendingVaultData>>;
+export declare function getLendingVaultData(this: Offchain, lendingVaultAddress: Address): Promise<LendingVaultData>;
+/**
+ * Whitelist
+ */
+export declare function fetchWhitelist(this: Offchain): Promise<WhitelistData[]>;
+export declare function initializeWhitelistData(this: Offchain): Promise<LendingPoolIndex<WhitelistState>>;
+export declare function getWhitelistData(this: Offchain): Promise<LendingPoolIndex<WhitelistState>>;
+export declare function getWhitelistState(this: Offchain, factory: Factory, pair: Address): Promise<WhitelistState>;
+/**
+ * User Data
+ */
+export declare function fetchLendingVaultsUserData(this: Offchain, account: Address): Promise<VaultPosition[] | null>;
+export declare function initializeLendingVaultsUserData(this: Offchain, account: Address): Promise<AddressIndex<VaultPosition> | null>;
+export declare function getLendingVaultsUserData(this: Offchain, account: Address): Promise<AddressIndex<VaultPosition> | null>;