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

package/lib/core/{pool/data.d.ts → pool.d.ts}

@@ -1,11 +1,14 @@
-import { providers, Signer } from "ethers";
-import { CreditManagerDebtParams, QuotaInfo } from "../../payload/creditManager";
-import { ChartsPoolDataPayload, LinearModel, PoolDataPayload, PoolZapper, UserPoolPayload } from "../../payload/pool";
-import { IPoolService, IPoolV3 } from "../../types";
+import { Provider, Signer } from "ethers";
+import { CreditManagerDebtParamsSDK, QuotaInfo } from "../payload/creditManager";
+import { ChartsPoolDataPayload, LinearModel, PoolDataExtraPayload, PoolDataPayload, PoolZapper, UserPoolPayload } from "../payload/pool";
+import { IPoolService, IPoolV3 } from "../types";
+export type PoolType = "universal" | "trade" | "farm";
 export declare class PoolData {
     readonly address: string;
+    readonly type: PoolType;
     readonly underlyingToken: string;
     readonly dieselToken: string;
+    readonly stakedDieselToken: Array<string>;
     readonly isPaused: boolean;
     readonly version: number;
     readonly poolQuotaKeeper: string;
@@ -15,37 +18,42 @@ export declare class PoolData {
     readonly expectedLiquidity: bigint;
     readonly expectedLiquidityLimit: bigint;
     readonly availableLiquidity: bigint;
-    readonly linearCumulativeIndex: bigint;
+    readonly baseInterestIndex: bigint;
+    readonly utilization: number;
     readonly totalBorrowed: bigint;
     readonly totalDebtLimit: bigint;
-    readonly creditManagerDebtParams: Record<string, CreditManagerDebtParams>;
+    readonly creditManagerDebtParams: Record<string, CreditManagerDebtParamsSDK>;
     readonly quotas: Record<string, QuotaInfo>;
-    readonly zappers: Record<string, PoolZapper>;
+    readonly zappers: Record<string, Record<string, PoolZapper>>;
     readonly totalAssets: bigint;
     readonly totalSupply: bigint;
+    readonly supplyAPY7D: number | undefined;
     readonly depositAPY: number;
     readonly borrowAPY: number;
     readonly interestModel: LinearModel;
     readonly dieselRate: number;
     readonly dieselRateRay: bigint;
     readonly withdrawFee: number;
-    readonly cumulativeIndex_RAY: bigint;
-    constructor(payload: PoolDataPayload);
+    readonly lastBaseInterestUpdate: bigint;
+    constructor(payload: PoolDataPayload, extra: PoolDataExtraPayload);
     getPoolContractV1(signer: Signer): IPoolService;
     getPoolContractV3(signer: Signer): IPoolV3;
-    calculateBorrowRate({ provider, expectedLiquidity, availableLiquidity, }: CalculateBorrowRateProps): Promise<import("ethers").BigNumber>;
+    calculateBorrowRate({ provider, expectedLiquidity, availableLiquidity, }: CalculateBorrowRateProps): Promise<bigint>;
+    static getPoolType(name: string): PoolType;
+    static calculateUtilization(expected: bigint, available: bigint): number;
 }
 interface CalculateBorrowRateProps {
-    provider: providers.Provider;
+    provider: Provider;
     expectedLiquidity: bigint;
     availableLiquidity: bigint;
 }
 export declare class ChartsPoolData {
-    readonly id: string;
     readonly address: string;
     readonly underlyingToken: string;
     readonly dieselToken: string;
-    readonly isWETH: boolean;
+    readonly type: PoolType;
+    readonly version: number;
+    readonly name: string;
     readonly addLiqCount: number;
     readonly addedLiquidity: number;
     readonly removeLiqCount: number;
@@ -60,6 +68,10 @@ export declare class ChartsPoolData {
     readonly borrowAPY: number;
     readonly borrowAPYRay: bigint;
     readonly lmAPY: number;
+    readonly lmRewardAll: Array<{
+        apy: number;
+        token: string;
+    }>;
     readonly availableLiquidity: bigint;
     readonly availableLiquidityChange: number;
     readonly availableLiquidityInUSD: number;
@@ -101,6 +113,10 @@ export declare class UserPoolData {
     readonly depositAPY: number;
     readonly depositAPYRay: bigint;
     readonly lmAPY: number;
+    readonly lmRewardAll: Array<{
+        apy: number;
+        token: string;
+    }>;
     readonly providedLiquidity: bigint;
     readonly providedLiquidityInUSD: number;
     readonly dieselBalance: bigint;

package/lib/core/{pool/data.js → pool.js}

@@ -2,12 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UserPoolData = exports.ChartsPoolData = exports.PoolData = void 0;
 const sdk_gov_1 = require("@gearbox-protocol/sdk-gov");
-const types_1 = require("../../types");
-const formatter_1 = require("../../utils/formatter");
+const types_1 = require("../types");
+const formatter_1 = require("../utils/formatter");
 class PoolData {
     address;
+    type;
     underlyingToken;
     dieselToken;
+    stakedDieselToken;
     isPaused;
     version;
     poolQuotaKeeper;
@@ -18,7 +20,8 @@ class PoolData {
     expectedLiquidity;
     expectedLiquidityLimit;
     availableLiquidity;
-    linearCumulativeIndex;
+    baseInterestIndex;
+    utilization;
     totalBorrowed;
     totalDebtLimit;
     creditManagerDebtParams;
@@ -26,71 +29,75 @@ class PoolData {
     zappers;
     totalAssets;
     totalSupply;
+    supplyAPY7D;
     depositAPY;
     borrowAPY;
     interestModel;
     dieselRate;
     dieselRateRay;
     withdrawFee;
-    cumulativeIndex_RAY;
-    constructor(payload) {
+    lastBaseInterestUpdate;
+    constructor(payload, extra) {
         this.address = payload.addr.toLowerCase();
+        this.type = PoolData.getPoolType(payload.name || "");
         this.underlyingToken = payload.underlying.toLowerCase();
         this.dieselToken = payload.dieselToken.toLowerCase();
+        this.stakedDieselToken = (extra.stakedDieselToken || []).map(t => t.toLowerCase());
         this.isPaused = payload.isPaused;
-        this.version = payload.version.toNumber();
+        this.version = Number(payload.version);
         this.poolQuotaKeeper = payload.poolQuotaKeeper.toLowerCase();
         this.gauge = payload.gauge.toLowerCase();
         this.name = payload.name;
         this.symbol = payload.symbol;
-        this.expectedLiquidity = (0, sdk_gov_1.toBigInt)(payload.expectedLiquidity);
-        this.availableLiquidity = (0, sdk_gov_1.toBigInt)(payload.availableLiquidity);
+        const expected = payload.expectedLiquidity;
+        const available = payload.availableLiquidity;
+        this.expectedLiquidity = expected;
+        this.availableLiquidity = available;
         this.expectedLiquidityLimit =
             this.expectedLiquidity + this.availableLiquidity;
-        this.linearCumulativeIndex = (0, sdk_gov_1.toBigInt)(payload.linearCumulativeIndex);
-        this.totalBorrowed = (0, sdk_gov_1.toBigInt)(payload.totalBorrowed);
-        this.totalDebtLimit = (0, sdk_gov_1.toBigInt)(payload.totalDebtLimit);
-        this.creditManagerDebtParams = Object.fromEntries(payload.creditManagerDebtParams.map(p => {
+        this.baseInterestIndex = payload.baseInterestIndex;
+        this.utilization = PoolData.calculateUtilization(expected, available);
+        this.totalBorrowed = payload.totalBorrowed;
+        this.totalDebtLimit = payload.totalDebtLimit;
+        this.creditManagerDebtParams = payload.creditManagerDebtParams.reduce((acc, p) => {
             const creditManager = p.creditManager.toLowerCase();
-            return [
+            acc[creditManager] = {
                 creditManager,
-                {
-                    creditManager,
-                    borrowed: (0, sdk_gov_1.toBigInt)(p.borrowed),
-                    limit: (0, sdk_gov_1.toBigInt)(p.limit),
-                    availableToBorrow: (0, sdk_gov_1.toBigInt)(p.availableToBorrow),
-                },
-            ];
-        }));
-        this.quotas = Object.fromEntries(payload.quotas.map(q => {
+                borrowed: p.borrowed,
+                limit: p.limit,
+                availableToBorrow: p.availableToBorrow,
+            };
+            return acc;
+        }, {});
+        this.quotas = payload.quotas.reduce((acc, q) => {
             const token = q.token.toLowerCase();
-            return [
+            acc[token] = {
                 token,
-                {
-                    token,
-                    rate: q.rate,
-                    quotaIncreaseFee: q.quotaIncreaseFee,
-                    totalQuoted: (0, sdk_gov_1.toBigInt)(q.totalQuoted),
-                    limit: (0, sdk_gov_1.toBigInt)(q.limit),
-                    isActive: q.isActive,
-                },
-            ];
-        }));
-        this.zappers = Object.fromEntries(payload.zappers.map(z => {
+                rate: q.rate * sdk_gov_1.PERCENTAGE_DECIMALS,
+                quotaIncreaseFee: q.quotaIncreaseFee,
+                totalQuoted: q.totalQuoted,
+                limit: q.limit,
+                isActive: q.isActive,
+            };
+            return acc;
+        }, {});
+        this.zappers = payload.zappers.reduce((acc, z) => {
             const tokenIn = z.tokenIn.toLowerCase();
-            return [
-                tokenIn,
-                {
-                    tokenIn,
-                    tokenOut: z.tokenOut.toLowerCase(),
-                    zapper: z.zapper.toLowerCase(),
+            const tokenOut = z.tokenOut.toLowerCase();
+            const old = acc[tokenIn] || {};
+            return {
+                ...acc,
+                [tokenIn]: {
+                    ...old,
+                    [tokenOut]: { tokenIn, tokenOut, zapper: z.zapper.toLowerCase() },
                 },
-            ];
-        }));
-        this.totalAssets = (0, sdk_gov_1.toBigInt)(payload.totalAssets);
-        this.totalSupply = (0, sdk_gov_1.toBigInt)(payload.totalSupply);
-        this.depositAPY = (0, formatter_1.rayToNumber)((0, sdk_gov_1.toBigInt)(payload.supplyRate) * sdk_gov_1.PERCENTAGE_DECIMALS);
-        this.borrowAPY = (0, formatter_1.rayToNumber)((0, sdk_gov_1.toBigInt)(payload.baseInterestRate) * sdk_gov_1.PERCENTAGE_DECIMALS);
+            };
+        }, {});
+        this.totalAssets = payload.totalAssets;
+        this.totalSupply = payload.totalSupply;
+        this.depositAPY = (0, formatter_1.rayToNumber)(payload.supplyRate * sdk_gov_1.PERCENTAGE_DECIMALS);
+        this.borrowAPY = (0, formatter_1.rayToNumber)(payload.baseInterestRate * sdk_gov_1.PERCENTAGE_DECIMALS);
+        this.supplyAPY7D = extra.supplyAPY7D;
         this.interestModel = {
             interestModel: payload.lirm.interestModel.toLowerCase(),
             U_1: payload.lirm.U_1,
@@ -99,14 +106,14 @@ class PoolData {
             R_slope1: payload.lirm.R_slope1,
             R_slope2: payload.lirm.R_slope2,
             R_slope3: payload.lirm.R_slope3,
-            version: payload?.lirm?.version?.toNumber(),
+            version: Number(payload?.lirm?.version),
             isBorrowingMoreU2Forbidden: payload?.lirm?.isBorrowingMoreU2Forbidden,
         };
         this.dieselRate = (0, formatter_1.rayToNumber)(payload.dieselRate_RAY);
-        this.dieselRateRay = (0, sdk_gov_1.toBigInt)(payload.dieselRate_RAY);
-        this.cumulativeIndex_RAY = (0, sdk_gov_1.toBigInt)(payload.cumulativeIndex_RAY);
+        this.dieselRateRay = payload.dieselRate_RAY;
+        this.lastBaseInterestUpdate = payload.lastBaseInterestUpdate;
         this.withdrawFee =
-            Number((0, sdk_gov_1.toBigInt)(payload.withdrawFee)) / Number(sdk_gov_1.PERCENTAGE_DECIMALS);
+            Number(payload.withdrawFee) / Number(sdk_gov_1.PERCENTAGE_DECIMALS);
     }
     getPoolContractV1(signer) {
         return types_1.IPoolService__factory.connect(this.address, signer);
@@ -118,14 +125,30 @@ class PoolData {
         const model = types_1.IInterestRateModel__factory.connect(this.interestModel.interestModel, provider);
         return model.calcBorrowRate(expectedLiquidity, availableLiquidity);
     }
+    static getPoolType(name) {
+        const [identity = ""] = name.split(" ") || [];
+        const lc = identity.toLowerCase();
+        if (lc === "farm")
+            return "farm";
+        if (lc === "trade")
+            return "trade";
+        return "universal";
+    }
+    static calculateUtilization(expected, available) {
+        return expected > 0
+            ? Number(((expected - available) * sdk_gov_1.PERCENTAGE_FACTOR) / expected) /
+                Number(sdk_gov_1.PERCENTAGE_DECIMALS)
+            : 0;
+    }
 }
 exports.PoolData = PoolData;
 class ChartsPoolData {
-    id;
     address;
     underlyingToken;
     dieselToken;
-    isWETH;
+    type;
+    version;
+    name;
     addLiqCount;
     addedLiquidity;
     removeLiqCount;
@@ -140,6 +163,7 @@ class ChartsPoolData {
     borrowAPY;
     borrowAPYRay;
     lmAPY;
+    lmRewardAll;
     availableLiquidity;
     availableLiquidityChange;
     availableLiquidityInUSD;
@@ -172,19 +196,14 @@ class ChartsPoolData {
     uniqueLPs;
     uniqueLPsChange;
     constructor(payload) {
-        this.id = (payload.addr || "").toLowerCase();
         this.address = (payload.addr || "").toLowerCase();
         this.underlyingToken = (payload.underlyingToken || "").toLowerCase();
         this.dieselToken = (payload.dieselToken || "").toLowerCase();
-        this.isWETH = payload.isWETH || false;
+        this.type = PoolData.getPoolType(payload.name || "");
+        this.version = payload.version || 1;
+        this.name = payload.name || "";
         this.earned7D = payload.earned7D || 0;
         this.earned7DInUSD = payload.earned7DInUSD || 0;
-        const expected = (0, sdk_gov_1.toBigInt)(payload.expectedLiquidity || 0);
-        this.utilization =
-            expected > 0
-                ? Number(((0, sdk_gov_1.toBigInt)(payload.totalBorrowed || 0) * sdk_gov_1.PERCENTAGE_FACTOR) /
-                    expected) / Number(sdk_gov_1.PERCENTAGE_DECIMALS)
-                : 0;
         this.dieselRate = (0, formatter_1.rayToNumber)(payload.dieselRate_RAY || 0);
         this.dieselRateRay = (0, sdk_gov_1.toBigInt)(payload.dieselRate_RAY || 0);
         this.depositAPY =
@@ -194,11 +213,18 @@ class ChartsPoolData {
             (0, formatter_1.rayToNumber)(payload.borrowAPY_RAY || 0) * Number(sdk_gov_1.PERCENTAGE_DECIMALS);
         this.borrowAPYRay = (0, sdk_gov_1.toBigInt)(payload.borrowAPY_RAY || 0);
         this.lmAPY = (payload.lmAPY || 0) / Number(sdk_gov_1.PERCENTAGE_DECIMALS);
-        this.availableLiquidity = (0, sdk_gov_1.toBigInt)(payload.availableLiquidity || 0);
+        this.lmRewardAll = (payload.lmRewardAll || []).map(r => ({
+            apy: (r.apy || 0) / Number(sdk_gov_1.PERCENTAGE_DECIMALS),
+            token: (r.token || "").toLowerCase(),
+        }));
+        const expected = (0, sdk_gov_1.toBigInt)(payload.expectedLiquidity || 0);
+        const available = (0, sdk_gov_1.toBigInt)(payload.availableLiquidity || 0);
+        this.availableLiquidity = available;
         this.oldAvailableLiquidity = (0, sdk_gov_1.toBigInt)(payload.availableLiquidityOld || 0);
         this.availableLiquidityChange =
             (payload.availableLiquidity10kBasis || 0) * Number(sdk_gov_1.PERCENTAGE_DECIMALS);
         this.availableLiquidityInUSD = payload.availableLiquidityInUSD || 0;
+        this.utilization = PoolData.calculateUtilization(expected, available);
         this.caLockedValue = payload.caLockedValue || 0;
         this.oldCALockedValue = payload.caLockedValueOld || 0;
         this.caLockedValueChange =
@@ -250,6 +276,7 @@ class UserPoolData {
     depositAPY;
     depositAPYRay;
     lmAPY;
+    lmRewardAll;
     providedLiquidity;
     providedLiquidityInUSD;
     dieselBalance;
@@ -271,6 +298,10 @@ class UserPoolData {
             (0, formatter_1.rayToNumber)(payload.depositAPY_RAY || 0) * Number(sdk_gov_1.PERCENTAGE_DECIMALS);
         this.depositAPYRay = (0, sdk_gov_1.toBigInt)(payload.depositAPY_RAY || 0);
         this.lmAPY = (payload.lmAPY || 0) / Number(sdk_gov_1.PERCENTAGE_DECIMALS || 0);
+        this.lmRewardAll = (payload.lmRewardAll || []).map(r => ({
+            apy: (r.apy || 0) / Number(sdk_gov_1.PERCENTAGE_DECIMALS),
+            token: (r.token || "").toLowerCase(),
+        }));
         this.providedLiquidity = (0, sdk_gov_1.toBigInt)(payload.liqValue || 0);
         this.providedLiquidityInUSD = payload.liqValueInUSD;
         this.dieselBalance = (0, sdk_gov_1.toBigInt)(payload.dieselBalanceBI || 0);

package/lib/core/rewardClaimer.d.ts

@@ -1,11 +1,13 @@
-import { NetworkType, SupportedContract, SupportedToken } from "@gearbox-protocol/sdk-gov";
-import { providers } from "ethers";
+import { NetworkType, PartialRecord, Protocols, SupportedContract, SupportedToken } from "@gearbox-protocol/sdk-gov";
+import { Provider } from "ethers";
 import { MultiCall } from "../pathfinder/core";
 import { CreditAccountData } from "./creditAccount";
 import { CreditManagerData } from "./creditManager";
 export interface Rewards {
     contract: SupportedContract;
-    rewards: Partial<Record<SupportedToken, bigint>>;
+    totalSupply: bigint;
+    protocol: Protocols.Aura | Protocols.Convex;
+    rewards: PartialRecord<SupportedToken, bigint>;
     calls: Array<MultiCall>;
 }
 export interface AdapterWithType {
@@ -14,5 +16,5 @@ export interface AdapterWithType {
     contract: SupportedContract;
 }
 export declare class RewardClaimer {
-    static findRewards(ca: CreditAccountData, cm: CreditManagerData, network: NetworkType, provider: providers.Provider): Promise<Array<Rewards>>;
+    static findRewards(ca: CreditAccountData, cm: CreditManagerData, network: NetworkType, provider: Provider): Promise<Array<Rewards>>;
 }

package/lib/core/rewardConvex.d.ts

@@ -1,24 +1,40 @@
-import { MCall, NetworkType, SupportedContract, SupportedToken } from "@gearbox-protocol/sdk-gov";
-import { BigNumber, providers } from "ethers";
+import { MCall, NetworkType, Protocols, SupportedToken } from "@gearbox-protocol/sdk-gov";
+import { Interface, Provider } from "ethers";
 import { IBaseRewardPoolInterface } from "../types/IBaseRewardPool";
+import { IConvexTokenInterface } from "../types/IConvexToken";
 import { CreditAccountData } from "./creditAccount";
 import { CreditManagerData } from "./creditManager";
 import { AdapterWithType, Rewards } from "./rewardClaimer";
+type DistributionList = Array<Array<RewardDistribution>>;
+type CallsList = Array<Array<MCall<IConvexTokenInterface> | MCall<IBaseRewardPoolInterface> | MCall<Interface>>>;
 export interface RewardDistribution {
+    contract: Rewards["contract"];
+    protocol: Rewards["protocol"];
+    token: SupportedToken;
     adapter: string;
     contractAddress: string;
-    contract: SupportedContract;
-    token: SupportedToken;
 }
-interface MCallPreparation {
-    calls: Array<MCall<IBaseRewardPoolInterface>>;
-    distribution: Array<RewardDistribution>;
+interface ParseProps {
+    convexResponse: Array<bigint>;
+    convexDistribution: DistributionList;
+    convexTotalSupply: bigint;
+    auraResponse: Array<bigint>;
+    auraDistribution: DistributionList;
+    auraTotalSupply: bigint;
 }
 export declare class RewardConvex {
     static poolInterface: IBaseRewardPoolInterface;
-    static findRewards(ca: CreditAccountData, cm: CreditManagerData, network: NetworkType, provider: providers.Provider): Promise<Array<Rewards>>;
-    static findAdapters(cm: CreditManagerData): Array<AdapterWithType>;
-    static prepareMultiCalls(creditAccount: string, cm: CreditManagerData, network: NetworkType): MCallPreparation;
-    static parseResults(rewards: Array<BigNumber>, distribution: Array<RewardDistribution>): Array<Rewards>;
+    static findRewards(ca: CreditAccountData, cm: CreditManagerData, network: NetworkType, provider: Provider): Promise<Array<Rewards>>;
+    static findAdapters(cm: CreditManagerData): AdapterWithType[];
+    static prepareMultiCalls(creditAccount: string, cm: CreditManagerData, network: NetworkType): {
+        convexDistribution: DistributionList;
+        auraDistribution: DistributionList;
+        convexCalls: CallsList;
+        auraCalls: CallsList;
+    } | undefined;
+    static parseResults({ convexDistribution, convexResponse, convexTotalSupply, auraDistribution, auraResponse, auraTotalSupply, }: ParseProps): Array<Rewards>;
+    static getRewardObject(baseReward: bigint, baseDistribution: RewardDistribution, boostedRewardToken: SupportedToken, extraDistribution: Array<RewardDistribution>, rewardsResp: Array<bigint>, totalSupply: bigint, callData: string, multiplier: bigint): Rewards | undefined;
+    static getBaseRewardToken(protocol: Protocols): SupportedToken | undefined;
+    static getBBoostedRewardToken(protocol: Protocols): SupportedToken | undefined;
 }
 export {};