@gearbox-protocol/sdk 3.0.0-next.2 → 3.0.0-next.200

package/lib/pathfinder/v1/pathfinderv1.js

@@ -0,0 +1,154 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PathFinderV1 = void 0;
+const sdk_gov_1 = require("@gearbox-protocol/sdk-gov");
+const types_1 = require("../../types");
+const pathOptions_1 = require("../pathOptions");
+const MAX_GAS_PER_ROUTE = 200e6;
+const GAS_PER_BLOCK = 400e6;
+class PathFinderV1 {
+    pathFinder;
+    network;
+    static connectors = [
+        "USDC",
+        "WETH",
+        "USDT",
+        "FRAX",
+    ];
+    _connectors;
+    constructor(address, provider, network = "Mainnet", connectors = PathFinderV1.connectors) {
+        this.pathFinder = types_1.IRouter__factory.connect(address, provider);
+        this.network = network;
+        this._connectors = connectors
+            .map(c => sdk_gov_1.tokenDataByNetwork[this.network][c]?.toLowerCase())
+            .filter(t => !!t);
+    }
+    async findAllSwaps(creditAccount, swapOperation, tokenIn, tokenOut, amount, slippage) {
+        const connectors = this.getAvailableConnectors(creditAccount.balances);
+        const swapTask = {
+            swapOperation: BigInt(swapOperation),
+            creditAccount: creditAccount.addr,
+            tokenIn: sdk_gov_1.tokenDataByNetwork[this.network][tokenIn] || tokenIn,
+            tokenOut: sdk_gov_1.tokenDataByNetwork[this.network][tokenOut] ||
+                tokenOut,
+            connectors,
+            amount: BigInt(amount),
+            slippage: BigInt(slippage),
+            externalSlippage: false,
+        };
+        const results = await this.pathFinder.findAllSwaps.staticCall(swapTask, {
+            gasLimit: GAS_PER_BLOCK,
+        });
+        const unique = {};
+        results.forEach(r => {
+            const key = `${r.amount}${r.calls
+                .map(c => `${c.target.toLowerCase()}${c.callData}`)
+                .join("-")}`;
+            unique[key] = {
+                amount: r.amount,
+                calls: r.calls,
+            };
+        });
+        return Object.values(unique);
+    }
+    async findOneTokenPath(creditAccount, tokenIn, tokenOut, amount, slippage) {
+        const tokenInAddr = sdk_gov_1.tokenDataByNetwork[this.network][tokenIn] || tokenIn;
+        const connectors = this.getAvailableConnectors(creditAccount.balances);
+        const result = await this.pathFinder.findOneTokenPath.staticCall(tokenInAddr, amount, sdk_gov_1.tokenDataByNetwork[this.network][tokenOut] || tokenOut, creditAccount.addr, connectors, slippage, {
+            gasLimit: GAS_PER_BLOCK,
+        });
+        return {
+            amount: result.amount,
+            calls: result.calls,
+        };
+    }
+    /**
+     * @dev Finds the best path for opening credit account and converting all NORMAL tokens and LP token in the way to TARGET
+     * @param cm CreditManagerData which represents credit manager you want to use to open credit account
+     * @param expectedBalances Expected balances which would be on account accounting also debt. For example,
+     *    if you open an USDC credit account, borrow 50_000 USDC and provide 10 WETH and 10_USDC as collateral
+     *    from your own funds, expectedBalances should be: { "USDC": 60_000 * (10**6), "<address of WETH>": WAD.mul(10) }
+     *
+     * @param target Address of symbol of desired token
+     * @param slippage Slippage in PERCENTAGE_FORMAT (100% = 10_000) per operation
+     * @returns PathFinderOpenStrategyResult which
+     */
+    async findOpenStrategyPath(cm, expectedBalances, target, slippage) {
+        const targetAddr = sdk_gov_1.tokenDataByNetwork[this.network][target] || target;
+        const expectedBalancesAddr = Object.entries(expectedBalances).reduce((acc, [token, balance]) => {
+            const tokenAddr = sdk_gov_1.tokenDataByNetwork[this.network][token] || token;
+            acc[tokenAddr.toLowerCase()] = balance;
+            return acc;
+        }, {});
+        const balances = cm.collateralTokens.map(token => ({
+            token,
+            balance: expectedBalancesAddr[token] || 0,
+        }));
+        const connectors = this.getAvailableConnectors(cm.supportedTokens);
+        const result = await this.pathFinder.findOpenStrategyPath.staticCall(cm.address, balances, targetAddr, connectors, slippage, {
+            gasLimit: GAS_PER_BLOCK,
+        });
+        const balancesAfter = result[0].reduce((acc, b) => {
+            acc[b.token.toLowerCase()] = b.balance;
+            return acc;
+        }, {});
+        return {
+            balances: balancesAfter,
+            calls: result[1].calls,
+        };
+    }
+    /**
+     * @dev Finds the path to swap / withdraw all assets from CreditAccount into underlying asset
+     *   Can bu used for closing credit account and for liquidations as well.
+     * @param creditAccount CreditAccountData object used for close path computation
+     * @param slippage Slippage in PERCENTAGE_FORMAT (100% = 10_000) per operation
+     * @return The best option in PathFinderCloseResult format, which
+     *          - underlyingBalance - total balance of underlying token
+     *          - calls - list of calls which should be done to swap & unwrap everything to underlying token
+     */
+    async findBestClosePath(creditAccount, slippage, noConcurency = false, network) {
+        const loopsPerTx = Math.floor(GAS_PER_BLOCK / MAX_GAS_PER_ROUTE);
+        const pathOptions = pathOptions_1.PathOptionFactory.generatePathOptions(creditAccount.allBalances, loopsPerTx, network);
+        const connectors = this.getAvailableConnectors(creditAccount.balances);
+        let results = [];
+        if (noConcurency) {
+            for (const po of pathOptions) {
+                results.push(await this.pathFinder.findBestClosePath.staticCall(creditAccount.addr, connectors, slippage, po, loopsPerTx, false, {
+                    gasLimit: GAS_PER_BLOCK,
+                }));
+            }
+        }
+        else {
+            const requests = pathOptions.map(po => this.pathFinder.findBestClosePath.staticCall(creditAccount.addr, connectors, slippage, po, loopsPerTx, false, {
+                gasLimit: GAS_PER_BLOCK,
+            }));
+            results = await Promise.all(requests);
+        }
+        const bestResult = results.reduce((best, [pathFinderResult, gasPriceRAY]) => PathFinderV1.compare(best, {
+            calls: pathFinderResult.calls,
+            amount: pathFinderResult.amount,
+            gasUsage: pathFinderResult.gasUsage,
+        }, gasPriceRAY), {
+            amount: 0n,
+            gasUsage: 0n,
+            calls: [],
+        });
+        return {
+            underlyingBalance: bestResult.amount +
+                creditAccount.allBalances[creditAccount.underlyingToken.toLowerCase()]
+                    .balance,
+            calls: bestResult.calls,
+        };
+    }
+    static compare(r1, r2, gasPriceRAY) {
+        const comparator = ({ amount, gasUsage }, gasPrice) => amount - (gasUsage * gasPrice) / sdk_gov_1.RAY;
+        return comparator(r1, gasPriceRAY) > comparator(r2, gasPriceRAY) ? r1 : r2;
+    }
+    getAvailableConnectors(availableList) {
+        return PathFinderV1.getAvailableConnectors(availableList, this._connectors);
+    }
+    static getAvailableConnectors(availableList, connectors) {
+        return connectors.filter(t => availableList[t] !== undefined);
+    }
+}
+exports.PathFinderV1 = PathFinderV1;

package/lib/pathfinder/v1/pathfinderv1.spec.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const sdk_gov_1 = require("@gearbox-protocol/sdk-gov");
+const chai_1 = require("chai");
+const ethers_1 = require("ethers");
+const pathfinderv1_1 = require("./pathfinderv1");
+describe("PathFinderV1 test", () => {
+    it("compare works correctly", () => {
+        const r1 = {
+            amount: 2000n,
+            gasUsage: 1000n,
+            calls: [],
+        };
+        const r2 = {
+            amount: 3000n,
+            gasUsage: 2000n,
+            calls: [],
+        };
+        let result = pathfinderv1_1.PathFinderV1.compare(r1, r2, sdk_gov_1.RAY);
+        (0, chai_1.expect)(result).to.be.eql(r2);
+        result = pathfinderv1_1.PathFinderV1.compare(r1, r2, sdk_gov_1.RAY * 2n);
+        (0, chai_1.expect)(result).to.be.eql(r1);
+    });
+    it("has all expected connectors", () => {
+        const pf = new pathfinderv1_1.PathFinderV1("", new ethers_1.JsonRpcProvider(), "Mainnet");
+        const allowedTokens = {
+            [sdk_gov_1.tokenDataByNetwork.Mainnet.USDC.toLowerCase()]: true,
+            [sdk_gov_1.tokenDataByNetwork.Mainnet.WETH.toLowerCase()]: true,
+            [sdk_gov_1.tokenDataByNetwork.Mainnet.USDT.toLowerCase()]: true,
+            [sdk_gov_1.tokenDataByNetwork.Mainnet.FRAX.toLowerCase()]: true,
+        };
+        (0, chai_1.expect)(pf.getAvailableConnectors(allowedTokens)).to.be.deep.equal([
+            sdk_gov_1.tokenDataByNetwork.Mainnet.USDC.toLowerCase(),
+            sdk_gov_1.tokenDataByNetwork.Mainnet.WETH.toLowerCase(),
+            sdk_gov_1.tokenDataByNetwork.Mainnet.USDT.toLowerCase(),
+            sdk_gov_1.tokenDataByNetwork.Mainnet.FRAX.toLowerCase(),
+        ]);
+    });
+});

package/lib/payload/bot.d.ts

@@ -0,0 +1,13 @@
+import type { BigNumberish } from "ethers";
+export type BotBaseType = "liquidationProtection";
+export type LiquidationBotType = "deleverageBotPegged" | "deleverageBotLV" | "deleverageBotHV";
+export type BotDetailedType = LiquidationBotType;
+export interface BotDataPayload {
+    baseType: BotBaseType;
+    detailedType: BotDetailedType;
+    address: string;
+    minHealthFactor: BigNumberish;
+    maxHealthFactor: BigNumberish;
+    premiumScaleFactor: BigNumberish;
+    feeScaleFactor: BigNumberish;
+}

package/lib/payload/creditAccount.d.ts

@@ -1,4 +1,5 @@
 import { ExcludeArrayProps } from "@gearbox-protocol/sdk-gov";
-import { CreditAccountDataStruct, CreditAccountDataStructOutput } from "../types/@gearbox-protocol/core-v2/contracts/interfaces/IDataCompressor.sol/IDataCompressor";
-export type TokenBalancePayload = CreditAccountDataStruct["balances"];
-export type CreditAccountDataPayload = ExcludeArrayProps<CreditAccountDataStructOutput>;
+import { CreditAccountDataStructOutput, TokenBalanceStructOutput } from "../types/IDataCompressorV3";
+import { PartialKeys } from "../utils/types";
+export type CaTokenBalance = ExcludeArrayProps<TokenBalanceStructOutput>;
+export type CreditAccountDataPayload = PartialKeys<ExcludeArrayProps<CreditAccountDataStructOutput>, "accruedInterest" | "accruedFees" | "healthFactor" | "totalValue">;

package/lib/payload/creditManager.d.ts

@@ -1,20 +1,23 @@
 import { ExcludeArrayProps } from "@gearbox-protocol/sdk-gov";
 import { BigNumberish } from "ethers";
-import { ICreditFacade } from "../types";
-import { CreditManagerDataStructOutput } from "../types/@gearbox-protocol/core-v2/contracts/interfaces/IDataCompressor.sol/IDataCompressor";
+import { ICreditFacadeV2 } from "../types";
+import { CreditManagerDataStructOutput, CreditManagerDebtParamsStructOutput, QuotaInfoStructOutput } from "../types/IDataCompressorV3";
+export type CreditManagerDebtParamsSDK = ExcludeArrayProps<CreditManagerDebtParamsStructOutput>;
+export type QuotaInfo = ExcludeArrayProps<QuotaInfoStructOutput>;
 export interface AdapterPayload {
     allowedContract: string;
     adapter: string;
 }
-export type TotalDebt = ExcludeArrayProps<Awaited<ReturnType<ICreditFacade["totalDebt"]>>>;
-export type CreditManagerDataPayload = ExcludeArrayProps<CreditManagerDataStructOutput> & {
-    totalDebt?: TotalDebt;
-};
+export type TotalDebt = ExcludeArrayProps<Awaited<ReturnType<ICreditFacadeV2["totalDebt"]>>>;
+export type CreditManagerDataPayload = ExcludeArrayProps<CreditManagerDataStructOutput>;
 export interface ChartsCreditManagerPayload {
     addr: string;
     underlyingToken: string;
+    configurator: string;
+    creditFacade: string;
     isWeth: boolean;
     poolAddress: string;
+    name: string;
     maxAmount: BigNumberish;
     minAmount: BigNumberish;
     maxLeverageFactor: number;
@@ -52,4 +55,5 @@ export interface ChartsCreditManagerPayload {
     totalClosedAccountsChange: number;
     totalRepaidAccounts: number;
     liquidityThresholds: Record<string, number>;
+    totalDebtLimit: BigNumberish;
 }

package/lib/payload/creditSession.d.ts

@@ -3,8 +3,11 @@ export interface CreditSessionBalancePayload {
     BI: string;
     F: number;
     ind: number;
-    isAllowed: boolean;
+    isForbidden: boolean;
     isEnabled: boolean;
+    quota?: BigNumberish;
+    quotaIndexLU?: BigNumberish;
+    isQuoted?: boolean;
 }
 interface CreditSessionReward {
     bi: BigNumberish;
@@ -12,6 +15,9 @@ interface CreditSessionReward {
     pool: string;
     symbol: string;
 }
+export interface SecondaryStatus {
+    secStatus: Array<[block: number, status: number]>;
+}
 export interface CreditSessionPayload {
     id: string;
     status: number;
@@ -52,6 +58,11 @@ export interface CreditSessionPayload {
     currentTimestamp: number;
     cvxUnclaimedRewards: Record<string, CreditSessionReward>;
     balances: Record<string, CreditSessionBalancePayload>;
+    baseBorrowAPY7DAverage: number;
+    baseBorrowAPY_RAY: string;
+    baseToken: string;
+    pool: string;
+    teritaryStatus: null | SecondaryStatus;
 }
 export interface CreditSessionFilteredPayload {
     balances: Record<string, CreditSessionBalancePayload>;
@@ -72,6 +83,9 @@ export interface CreditSessionFilteredPayload {
     pnl: number;
     pnlUSD: number;
     tfIndex: number;
+    closedAtTimestamp: number;
+    sinceTimestamp: number;
+    teritaryStatus: null | SecondaryStatus;
 }
 export interface CreditSessionsAggregatedStatsPayload {
     healthFactor: BigNumberish;

package/lib/payload/gauge.d.ts

@@ -0,0 +1,11 @@
+import { AwaitedRes, ExcludeArrayProps } from "@gearbox-protocol/sdk-gov";
+import { IGearStakingV3 } from "../types";
+import { GaugeInfoStructOutput, GaugeQuotaParamsStructOutput } from "../types/IDataCompressorV3";
+export type GaugeQuotaParams = ExcludeArrayProps<GaugeQuotaParamsStructOutput>;
+export type GaugeDataPayload = ExcludeArrayProps<GaugeInfoStructOutput>;
+export interface GaugeStakingDataPayload {
+    availableBalance: AwaitedRes<IGearStakingV3["availableBalance"]>;
+    totalBalance: AwaitedRes<IGearStakingV3["balanceOf"]>;
+    epoch: AwaitedRes<IGearStakingV3["getCurrentEpoch"]>;
+    withdrawableAmounts: AwaitedRes<IGearStakingV3["getWithdrawableAmounts"]>;
+}

package/lib/payload/graphPayload.d.ts

@@ -1,9 +1,10 @@
-export interface GraphData {
+interface GraphPointPayload {
     time: number;
     value: number;
 }
 export interface GraphPayload {
     id: string;
     title: string;
-    data: Array<GraphData>;
+    data: Array<GraphPointPayload>;
 }
+export {};

package/lib/payload/pool.d.ts

@@ -1,16 +1,33 @@
 import { ExcludeArrayProps } from "@gearbox-protocol/sdk-gov";
 import { BigNumberish } from "ethers";
-import { PoolDataStruct } from "../types/@gearbox-protocol/core-v2/contracts/interfaces/IDataCompressor.sol/IDataCompressor";
-export type PoolDataPayload = ExcludeArrayProps<PoolDataStruct>;
+import { ZapperInfoStructOutput } from "../types/IDataCompressorV2_1";
+import { LinearModelStructOutput, PoolDataStructOutput } from "../types/IDataCompressorV3";
+export type PoolDataPayload = Omit<ExcludeArrayProps<PoolDataStructOutput>, "zappers"> & {
+    zappers: Array<PoolZapper>;
+};
+export interface PoolDataExtraPayload {
+    stakedDieselToken: Array<string>;
+    supplyAPY7D: number | undefined;
+}
+export type LinearModel = Omit<ExcludeArrayProps<LinearModelStructOutput>, "version"> & {
+    version: number;
+};
+export type PoolZapper = ExcludeArrayProps<ZapperInfoStructOutput>;
 export interface ChartsPoolDataPayload {
     addr: string;
     dieselToken: string;
     underlyingToken: string;
     isWETH: boolean;
+    version: number;
+    name: string;
     borrowAPY_RAY: BigNumberish;
     depositAPY_RAY: BigNumberish;
     dieselRate_RAY: BigNumberish;
     lmAPY: number;
+    lmRewardAll: Array<{
+        apy: number;
+        token: string;
+    }>;
     earned7D: number;
     earned7DInUSD: number;
     availableLiquidity: BigNumberish;
@@ -85,6 +102,10 @@ export interface UserPoolPayload {
     removedLiq: number;
     depositAPY_RAY: BigNumberish;
     lmAPY: number;
+    lmRewardAll: Array<{
+        apy: number;
+        token: string;
+    }>;
 }
 export interface UserPoolAggregatedStatsPayload {
     totalLMRewards: number;

package/lib/payload/token.d.ts

@@ -1,5 +1,7 @@
+import { SupportedToken } from "@gearbox-protocol/sdk-gov";
 export interface TokenDataPayload {
+    title?: string;
     addr: string;
-    symbol: string;
+    symbol: SupportedToken;
     decimals: number;
 }

package/lib/redstone/api.d.ts

@@ -0,0 +1,44 @@
+import { NetworkType, SupportedToken, TickerInfo } from "@gearbox-protocol/sdk-gov";
+import { SignedDataPackage } from "@redstone-finance/protocol";
+import { Provider } from "ethers";
+export declare const DEFAULT_DATA_SERVICE_ID = "redstone-primary-prod";
+export declare const REDSTONE_SIGNERS_THRESHOLD: number;
+interface RedstonePriceFeedInfo {
+    tokenAddress: string;
+    tickedTokenAddress: string;
+    symbol: SupportedToken;
+    feedAddress: string;
+    dataFeedId: string;
+    tickedDataFeedId: string;
+    dataServiceId: string;
+    reserve: boolean;
+    ticker?: TickerInfo;
+}
+export type RedstonePriceFeeds = Array<RedstonePriceFeedInfo>;
+export interface GetRedstoneFeedsProps {
+    provider: Provider;
+    currentTokenData: Record<SupportedToken, string>;
+    priceOracleAddress: string;
+    network: NetworkType;
+}
+export declare class RedstoneApi {
+    static getPricesBulk(feedsToUpdate: Array<RedstonePriceFeedInfo>): Promise<string[]>;
+    static getRedstonePayloadForManualUsage: (dataServiceId: string, dataFeeds: string, uniqueSignersCount: number) => Promise<string>;
+    static getDataPackagesBulk(feedsToUpdate: Array<RedstonePriceFeedInfo>): Promise<{
+        [k: string]: SignedDataPackage[];
+    }>;
+    private static getDataPackages;
+    private static splitResponse;
+    static getRedstonePriceFeedsSDK: ({ priceOracleAddress, currentTokenData, provider, network, }: GetRedstoneFeedsProps) => Promise<{
+        main: RedstonePriceFeeds;
+        reserve: RedstonePriceFeeds;
+    }>;
+    private static getRedstonePF_SDK;
+    static getRedstonePriceFeeds: ({ priceOracleAddress, currentTokenData, provider, network, }: GetRedstoneFeedsProps) => Promise<{
+        main: RedstonePriceFeeds;
+        reserve: RedstonePriceFeeds;
+    }>;
+    private static getPriceFeedsOfInterest_Onchain;
+    private static getRedstonePF_Onchain;
+}
+export {};