impermax-sdk 1.2.102 → 1.2.103

package/lib/offchain/queries/apis/ponder/index.js

@@ -0,0 +1,278 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PonderQueryBuilder = void 0;
+const graphql_tag_1 = __importDefault(require("graphql-tag"));
+const factories_1 = require("../../../../config/factories");
+const impermax_factories_1 = require("../../../../config/contracts/impermax-factories");
+class PonderQueryBuilder {
+    /*-----------------------------*
+     *   1. API Health
+     *-----------------------------*/
+    // Add queries here for metadata, health, etc.
+    blockQuery() {
+        return (0, graphql_tag_1.default) `{
+        _meta {
+          status
+        }
+      }`;
+    }
+    getBlockNumber(response, network) {
+        return response.data._meta.status[network].block.number || 0;
+    }
+    /*-----------------------------*
+     *   2. Lending pools
+     *-----------------------------*/
+    lendingPoolsQuery(factory, addressesFilter, network) {
+        const tokenStr = `{
+      id
+      symbol
+      name
+      decimals
+      derivedUSD
+    }`;
+        const distributorStr = `{ 
+      id 
+    }`;
+        const farmingPoolStr = `{
+      epochAmount
+      epochBegin
+      segmentLength
+      vestingBegin
+      sharePercentage
+      distributor ${distributorStr}
+    }`;
+        const borrowableStr = `{
+      id
+      underlying ${tokenStr}
+      totalBalance
+      totalBorrows
+      borrowRate
+      reserveFactor
+      kinkBorrowRate
+      kinkUtilizationRate
+      adjustSpeed
+      borrowIndex
+      accrualTimestamp 
+      exchangeRate 
+      borrowTracker
+      farmingPool ${farmingPoolStr}
+    }`;
+        const collateralStr = `{
+      id
+      totalBalance
+      safetyMargin
+      liquidationIncentive
+      ${factories_1.LIQUIDATION_FEE_FACTORIES.includes(factory) ? "liquidationFee" : ""}
+      exchangeRate 
+    }`;
+        const pairStr = `{
+      factory
+      reserve0
+      reserve1
+      totalSupply
+      reserveUSD
+      token0Price
+      token1Price
+      derivedUSD
+      uniswapV2PairAddress
+      uniswapV2Factory
+      isStakedLPToken
+      exchangeRate
+      stakingRewards 
+      masterChef
+      pid
+      stakedTotalSupply
+      rewards {
+        items { 
+          id
+          rewardRate
+          rewardsToken ${tokenStr}
+          periodFinish
+        }
+      }
+    }`;
+        const id_in_string = addressesFilter.length > 0 ? `id_in: ["${addressesFilter.join('","').toLowerCase()}"]}` : "";
+        return (0, graphql_tag_1.default) `{
+      lendingPools(
+        limit: 1000
+        orderBy: "totalBorrowsUSD"
+        where: { factoryId: "${impermax_factories_1.IMPERMAX_FACTORY[network][factory]}", ${id_in_string}}
+      ) {
+        items {
+          id
+          borrowable0 ${borrowableStr}
+          borrowable1 ${borrowableStr}
+          collateral ${collateralStr}
+          pair ${pairStr}
+        }
+      }
+      _meta {
+        status
+      }
+    }`;
+    }
+    userQuery(account, network, factory) {
+        return (0, graphql_tag_1.default) `{
+      user(id: "${account.toLowerCase()}") {
+        collateralPositions(limit:1000, where: { factoryId: "${impermax_factories_1.IMPERMAX_FACTORY[network][factory]}"}) {
+          items { 
+            balance
+            collateral {
+              lendingPool {
+                id
+              }
+            }
+          }
+        }
+        supplyPositions(limit:1000, where: { factoryId: "${impermax_factories_1.IMPERMAX_FACTORY[network][factory]}"}) {
+          items { 
+            balance
+            borrowable {
+              underlying {
+                id
+              }
+              lendingPool {
+                id
+              }
+            }
+          }
+        }
+        borrowPositions(limit:1000, where: { factoryId: "${impermax_factories_1.IMPERMAX_FACTORY[network][factory]}"}) {
+          items { 
+            borrowBalance
+            borrowIndex
+            borrowable {
+              underlying {
+                id
+              }
+              lendingPool {
+                id
+              }
+            }
+          }
+        }
+      }
+      _meta {
+        status
+      }
+    }`;
+    }
+    tvlQuery() {
+        return (0, graphql_tag_1.default) `
+      {
+        impermaxFactorys(limit: 1) {
+          items {
+            id
+            totalBalanceUSD
+            totalSupplyUSD
+            totalBorrowsUSD
+          }
+        }
+      }
+    `;
+    }
+    /*-----------------------------*
+     *   Lending vaults
+     *-----------------------------*/
+    lendingVaultsUserQuery(account) {
+        return (0, graphql_tag_1.default) `{
+      user(id: "${account.toLowerCase()}") {
+        positions(first:1000) {
+          tokenBalance
+          lastExchangeRate
+          cumulativeEarnings
+          lendingVault {
+              id
+          }
+        }
+      }
+    }`;
+    }
+    lendingVaultsQuery(addressesFilter) {
+        const id_in_string = addressesFilter.length > 0 ? `where: {id_in: ["${addressesFilter.join('","').toLowerCase()}"]}` : "";
+        return (0, graphql_tag_1.default) `{
+      lendingVaults(first: 1000 ${id_in_string}) {
+          id
+          underlying {
+              id
+              symbol
+              name
+              decimals
+          }
+          totalBalance
+          totalSupply
+          supplyRate
+          reserveFactor
+          exchangeRate
+          availableLiquidity
+          lastUpdate
+      }
+      _meta {
+          block {
+              number
+          }
+          hasIndexingErrors
+      }
+    }`;
+    }
+    /*-----------------------------*
+     *   Config Manager
+     *-----------------------------*/
+    // TODO: Add config manager ponder
+    proposalsMetaQuery(rangeBegin, rangeLength, descending) {
+        return (0, graphql_tag_1.default) `{
+      proposals(
+        orderBy: idInt, 
+        orderDirection: ${descending ? "desc" : "asc"},
+        first: ${rangeLength},
+        skip: ${rangeBegin}
+      ) {
+        id
+        state
+      }
+    }`;
+    }
+    proposalQuery(id) {
+        return (0, graphql_tag_1.default) `{
+      proposal(id:${id}) {
+        id
+        state
+        pairConfig {
+          factory
+          pair
+          safetyMarginSqrt
+          liquidationIncentive
+          liquidationFee
+          reserveFactor0
+          reserveFactor1
+          kinkUtilizationRate0
+          kinkUtilizationRate1
+          adjustSpeed0
+          adjustSpeed1
+          borrowTracker0
+          borrowTracker1
+          whiteListState
+        }
+      }
+    }`;
+    }
+    /*-----------------------------*
+     *   IBEX
+     *-----------------------------*/
+    // TODO: Add IBEX ponder idk what this is
+    ximxQuery() {
+        return (0, graphql_tag_1.default) `{
+        ximxes(first: 1) {
+          totalSupply
+          totalBalance
+          exchangeRate
+          dailyAPR
+        }
+      }
+    `;
+    }
+}
+exports.PonderQueryBuilder = PonderQueryBuilder;

package/lib/offchain/queries/apis/thegraph/index.d.ts

@@ -0,0 +1,19 @@
+import { Address, Factory, Networks } from "../../../../config/types";
+import { IQueryBuilder } from "../../interfaces/query-builder";
+export declare class TheGraphQueryBuilder implements IQueryBuilder {
+    blockQuery(timestamp: number): import("graphql").DocumentNode;
+    getBlockNumber(response: any, network: Networks): number;
+    lendingPoolsQuery(factory: Factory, addressesFilter: Address[]): import("graphql").DocumentNode;
+    userQuery(account: Address, network: Networks, factory: Factory): import("graphql").DocumentNode;
+    tvlQuery(): import("graphql").DocumentNode;
+    lendingVaultsQuery(addressesFilter: Address[]): import("graphql").DocumentNode;
+    lendingVaultsUserQuery(account: Address): import("graphql").DocumentNode;
+    proposalsMetaQuery(rangeBegin: any, rangeLength: any, descending: any): import("graphql").DocumentNode;
+    proposalQuery(id: number): import("graphql").DocumentNode;
+    ximxQuery(): import("graphql").DocumentNode;
+    lendingPoolsPastQuery(blockNumber: number, addressesFilter: Address[]): import("graphql").DocumentNode;
+    impermaxChefQuery(): import("graphql").DocumentNode;
+    pastVolumeQuery(blockNumber: number, addressesFilter: Address[]): import("graphql").DocumentNode;
+    currentVolumeAndReservesQuery(addressesFilter: Address[]): import("graphql").DocumentNode;
+    whitelistQuery(): import("graphql").DocumentNode;
+}

package/lib/offchain/queries/apis/thegraph/index.js

@@ -0,0 +1,349 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TheGraphQueryBuilder = void 0;
+const graphql_tag_1 = __importDefault(require("graphql-tag"));
+const factories_1 = require("../../../../config/factories");
+class TheGraphQueryBuilder {
+    /*-----------------------------*
+     *   1. API Health
+     *-----------------------------*/
+    // Add queries here for metadata, health, etc.
+    blockQuery(timestamp) {
+        return (0, graphql_tag_1.default) `{
+      blocks (first: 1, orderBy: timestamp, orderDirection: desc, where: { timestamp_gt: ${timestamp}, timestamp_lt: ${timestamp + 600} }) {
+        number
+      } 
+      _meta {
+        block {
+          number
+        }
+      }
+    }`;
+    }
+    getBlockNumber(response, network) {
+        var _a, _b, _c;
+        // Keep compatible to interface, shh
+        network;
+        return ((_c = (_b = (_a = response === null || response === void 0 ? void 0 : response.data) === null || _a === void 0 ? void 0 : _a._meta) === null || _b === void 0 ? void 0 : _b.block) === null || _c === void 0 ? void 0 : _c.number) || 0;
+    }
+    /*-----------------------------*
+     *   2. Lending pools
+     *-----------------------------*/
+    lendingPoolsQuery(factory, addressesFilter) {
+        const tokenStr = `{
+      id
+      symbol
+      name
+      decimals
+      derivedUSD
+    }`;
+        const distributorStr = `{
+      id
+    }`;
+        const farmingPoolStr = `{
+      epochAmount
+      epochBegin
+      segmentLength
+      vestingBegin
+      sharePercentage
+      distributor ${distributorStr}
+    }`;
+        const borrowableStr = `{
+      id
+      underlying ${tokenStr}
+      totalBalance
+      totalBorrows
+      borrowRate
+      reserveFactor
+      kinkBorrowRate
+      kinkUtilizationRate
+      adjustSpeed
+      borrowIndex
+      accrualTimestamp 
+      exchangeRate 
+      totalBalanceUSD
+      totalSupplyUSD
+      totalBorrowsUSD
+      borrowTracker
+      farmingPool ${farmingPoolStr}
+    }`;
+        const collateralStr = `{
+      id
+      totalBalance
+      totalBalanceUSD
+      safetyMargin
+      liquidationIncentive
+      ${factories_1.LIQUIDATION_FEE_FACTORIES.includes(factory) ? "liquidationFee" : ""}
+      exchangeRate 
+    }`;
+        const pairStr = `{
+      factory
+      reserve0
+      reserve1
+      totalSupply
+      reserveUSD
+      token0Price
+      token1Price
+      derivedUSD
+      uniswapV2PairAddress
+      uniswapV2Factory
+      isStakedLPToken
+      exchangeRate
+      stakingRewards 
+      masterChef
+      pid
+      stakedTotalSupply
+      rewards {
+        id
+        rewardRate
+        rewardsToken ${tokenStr}
+        periodFinish
+      }
+    }`;
+        const id_in_string = addressesFilter.length > 0 ? `where: {id_in: ["${addressesFilter.join('","').toLowerCase()}"]}` : "";
+        return (0, graphql_tag_1.default) `{
+      lendingPools(first: 1000, orderBy: totalBorrowsUSD, orderDirection: desc ${id_in_string}) {
+        id
+        borrowable0 ${borrowableStr}
+        borrowable1 ${borrowableStr}
+        collateral ${collateralStr}
+        pair ${pairStr}
+      }
+      _meta {
+        block {
+          number
+        }
+        hasIndexingErrors
+      }
+    }`;
+    }
+    userQuery(account, network, factory) {
+        // Shh
+        network;
+        factory;
+        return (0, graphql_tag_1.default) `{
+      user(id: "${account.toLowerCase()}") {
+        collateralPositions(first:1000) {
+          balance
+          collateral {
+            lendingPool {
+              id
+            }
+          }
+        }
+        supplyPositions(first:1000) {
+          balance
+          borrowable {
+            underlying {
+              id
+            }
+            lendingPool {
+              id
+            }
+          }
+        }
+        borrowPositions(first:1000) {
+          borrowBalance
+          borrowIndex
+          borrowable {
+            underlying {
+              id
+            }
+            lendingPool {
+              id
+            }
+          }
+        }
+      }
+      _meta {
+        block {
+          number
+        }
+        hasIndexingErrors
+      }
+    }`;
+    }
+    tvlQuery() {
+        return (0, graphql_tag_1.default) `{
+      impermaxFactories(first: 1) {
+        totalBalanceUSD
+        totalSupplyUSD
+        totalBorrowsUSD
+      }
+    }`;
+    }
+    /*-----------------------------*
+     *   Lending vaults
+     *-----------------------------*/
+    lendingVaultsQuery(addressesFilter) {
+        const id_in_string = addressesFilter.length > 0 ? `where: {id_in: ["${addressesFilter.join('","').toLowerCase()}"]}` : "";
+        return (0, graphql_tag_1.default) `{
+      lendingVaults(first: 1000 ${id_in_string}) {
+        id
+        underlying {
+            id
+            symbol
+            name
+            decimals
+        }
+        totalBalance
+        totalSupply
+        supplyRate
+        reserveFactor
+        exchangeRate
+        availableLiquidity
+        lastUpdate
+      }
+      _meta {
+        block {
+            number
+        }
+        hasIndexingErrors
+      }
+    }`;
+    }
+    lendingVaultsUserQuery(account) {
+        return (0, graphql_tag_1.default) `{
+      user(id: "${account.toLowerCase()}") {
+          positions(first:1000) {
+              tokenBalance
+              lastExchangeRate
+              cumulativeEarnings
+              lendingVault {
+                  id
+              }
+          }
+      }
+    }`;
+    }
+    /*-----------------------------*
+     *   Config Manager
+     *-----------------------------*/
+    proposalsMetaQuery(rangeBegin, rangeLength, descending) {
+        return (0, graphql_tag_1.default) `{
+      proposals(
+        orderBy: idInt, 
+        orderDirection: ${descending ? "desc" : "asc"},
+        first: ${rangeLength},
+        skip: ${rangeBegin}
+      ) {
+        id
+        state
+      }
+    }`;
+    }
+    proposalQuery(id) {
+        return (0, graphql_tag_1.default) `{
+      proposal(id:${id}) {
+        id
+        state
+        pairConfig {
+          factory
+          pair
+          safetyMarginSqrt
+          liquidationIncentive
+          liquidationFee
+          reserveFactor0
+          reserveFactor1
+          kinkUtilizationRate0
+          kinkUtilizationRate1
+          adjustSpeed0
+          adjustSpeed1
+          borrowTracker0
+          borrowTracker1
+          whiteListState
+        }
+      }
+    }`;
+    }
+    /*-----------------------------*
+     *   IBEX
+     *-----------------------------*/
+    ximxQuery() {
+        return (0, graphql_tag_1.default) `{
+        ximxes(first: 1) {
+          totalSupply
+          totalBalance
+          exchangeRate
+          dailyAPR
+        }
+      }
+    `;
+    }
+    /*-----------------------------*
+     *   Optionals
+     *-----------------------------*/
+    lendingPoolsPastQuery(blockNumber, addressesFilter) {
+        const borrowablePastStr = `{
+      borrowIndex
+      accrualTimestamp
+      exchangeRate
+    }`;
+        const id_in_string = addressesFilter.length > 0 ? `where: {id_in: ["${addressesFilter.join('","').toLowerCase()}"]}` : "";
+        return (0, graphql_tag_1.default) `{
+      lendingPools(first: 1000, orderBy: totalBorrowsUSD, orderDirection: desc, block: {number: ${blockNumber}} ${id_in_string}) {
+        id
+        borrowable0 ${borrowablePastStr}
+        borrowable1 ${borrowablePastStr}
+      }
+    }`;
+    }
+    impermaxChefQuery() {
+        return (0, graphql_tag_1.default) `{
+      impermaxChefs(first: 1) {
+        id
+        rewardToken
+        rewardPerSec
+        totalAllocPoint
+      }
+      pools(first: 1000) {
+        id
+        allocPoint
+        rewarder {
+          id
+        }
+      }
+      impermaxRewarders(first: 1000) {
+        rewardToken
+        rewardPerSec
+        totalAllocPoint
+        pools(first: 1000) {
+          borrowable
+          allocPoint
+        }
+      }
+    }`;
+    }
+    pastVolumeQuery(blockNumber, addressesFilter) {
+        const id_in_string = addressesFilter.length > 0 ? `where: {id_in: ["${addressesFilter.join('","').toLowerCase()}"]}` : "";
+        return (0, graphql_tag_1.default) `{
+      pairs (block: {number: ${blockNumber}} ${id_in_string}) {
+        id
+        volumeUSD
+      }
+    }`;
+    }
+    currentVolumeAndReservesQuery(addressesFilter) {
+        const id_in_string = addressesFilter.length > 0 ? `where: {id_in: ["${addressesFilter.join('","').toLowerCase()}"]}` : "";
+        return (0, graphql_tag_1.default) `{
+      pairs (${id_in_string}) {
+        id
+        reserveUSD
+        volumeUSD
+      }
+    }`;
+    }
+    whitelistQuery() {
+        return (0, graphql_tag_1.default) `{
+      whitelistStates(first: 1000) {
+        factory
+        pair
+        state
+      }
+    }`;
+    }
+}
+exports.TheGraphQueryBuilder = TheGraphQueryBuilder;

package/lib/offchain/queries/index.d.ts

@@ -0,0 +1,16 @@
+import { IQueryBuilder } from "./interfaces/query-builder";
+import { ApolloQueryResult } from "apollo-client";
+/**
+ * Pure utility class to create query builders and transform data
+ */
+export declare class QueryBuilderFactory {
+    /**
+     * Gets an API's query builder given an endpoint
+     */
+    static getQuery(endpoint: string): IQueryBuilder;
+    /**
+     * Helper to transform nested query results from various apis during apollo fetch.
+     * Mainly used for Ponder as the graphql schema is different to thegraph due to pagination.
+     */
+    static transformData(input: ApolloQueryResult<any>): ApolloQueryResult<any>;
+}

package/lib/offchain/queries/index.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QueryBuilderFactory = void 0;
+const ponder_1 = require("./apis/ponder");
+const thegraph_1 = require("./apis/thegraph");
+/**
+ * Pure utility class to create query builders and transform data
+ */
+class QueryBuilderFactory {
+    /**
+     * Gets an API's query builder given an endpoint
+     */
+    static getQuery(endpoint) {
+        if (endpoint.includes("thegraph"))
+            return new thegraph_1.TheGraphQueryBuilder();
+        // if (endpoint.includes("goldsky")) return new GoldskyBuilder(), etc.;
+        // Default to ponder (ie. includes('railway')) but helps local test
+        return new ponder_1.PonderQueryBuilder();
+    }
+    /**
+     * Helper to transform nested query results from various apis during apollo fetch.
+     * Mainly used for Ponder as the graphql schema is different to thegraph due to pagination.
+     */
+    static transformData(input) {
+        const transformValue = (value) => {
+            if (!value)
+                return value;
+            if (Array.isArray(value))
+                return value.map(transformValue);
+            if (typeof value === "object") {
+                const transformed = {};
+                for (const [key, val] of Object.entries(value)) {
+                    if (key === "items" && Array.isArray(val))
+                        return val.map(transformValue);
+                    transformed[key] = transformValue(val);
+                }
+                return transformed;
+            }
+            return value;
+        };
+        return Object.assign(Object.assign({}, input), { data: transformValue(input.data) });
+    }
+}
+exports.QueryBuilderFactory = QueryBuilderFactory;