@gearbox-protocol/sdk 3.0.0-next.30 → 3.0.0-next.300

package/lib/core/creditAccount.d.ts

@@ -1,60 +1,111 @@
-import { LpTokensAPY } from "../apy";
-import { CaTokenBalance, CreditAccountDataPayload, ScheduledWithdrawal } from "../payload/creditAccount";
+import { Address } from "viem";
+import { TokensWithApyRecord } from "../apy";
+import { CaTokenBalance, CreditAccountDataPayload } from "../payload/creditAccount";
 import { QuotaInfo } from "../payload/creditManager";
 import { TokenData } from "../tokens/tokenData";
 import { Asset, AssetWithAmountInTarget } from "./assets";
+export declare const MIN_INT96 = -39614081257132168796771975168n;
+export declare const MAX_UINT256 = 115792089237316195423570985008687907853269984665640564039457584007913129639935n;
 export interface CalcOverallAPYProps {
     caAssets: Array<Asset>;
-    lpAPY: LpTokensAPY | undefined;
-    quotas: Record<string, Asset>;
-    quotaRates: Record<string, Pick<QuotaInfo, "rate">>;
-    prices: Record<string, bigint>;
+    lpAPY: TokensWithApyRecord | undefined;
+    quotas: Record<Address, Asset>;
+    quotaRates: Record<Address, Pick<QuotaInfo, "isActive" | "rate">>;
+    feeInterest: number;
+    prices: Record<Address, bigint>;
     totalValue: bigint | undefined;
     debt: bigint | undefined;
-    baseBorrowRate: number;
-    underlyingToken: string;
+    baseRateWithFee: number;
+    underlyingToken: Address;
+    tokensList: Record<Address, TokenData>;
+}
+export interface CalcMaxLendingDebtProps {
+    assets: Array<Asset>;
+    prices: Record<Address, bigint>;
+    liquidationThresholds: Record<Address, bigint>;
+    underlyingToken: Address;
+    tokensList: Record<Address, TokenData>;
+    targetHF?: bigint;
 }
 export interface CalcHealthFactorProps {
     assets: Array<Asset>;
-    quotas: Record<string, Asset>;
-    prices: Record<string, bigint>;
-    liquidationThresholds: Record<string, bigint>;
-    underlyingToken: string;
-    borrowed: bigint;
+    quotas: Record<Address, Asset>;
+    quotasInfo: Record<Address, Pick<QuotaInfo, "isActive">>;
+    prices: Record<Address, bigint>;
+    liquidationThresholds: Record<Address, bigint>;
+    underlyingToken: Address;
+    debt: bigint;
+    tokensList: Record<Address, TokenData>;
+}
+export interface CalcDefaultQuotaProps {
+    amount: bigint;
+    lt: bigint;
+    quotaReserve: bigint;
+}
+export interface CalcRecommendedQuotaProps {
+    amount: bigint;
+    debt: bigint;
+    lt: bigint;
+    quotaReserve: bigint;
 }
 export interface CalcQuotaUpdateProps {
-    quotas: Record<string, Pick<QuotaInfo, "isActive" | "token">>;
-    initialQuotas: Record<string, Pick<CaTokenBalance, "quota">>;
-    assetsAfterUpdate: Record<string, AssetWithAmountInTarget>;
-    allowedToSpend: Record<string, {}>;
-    allowedToObtain: Record<string, {}>;
+    quotas: Record<Address, Pick<QuotaInfo, "isActive" | "token">>;
+    initialQuotas: Record<Address, Pick<CaTokenBalance, "quota">>;
+    liquidationThresholds: Record<Address, bigint>;
+    assetsAfterUpdate: Record<Address, AssetWithAmountInTarget>;
+    maxDebt: bigint;
+    calcModification?: {
+        type: "recommendedQuota";
+        debt: bigint;
+    };
+    allowedToSpend: Record<Address, {}>;
+    allowedToObtain: Record<Address, {}>;
+    quotaReserve: bigint;
 }
 interface CalcQuotaUpdateReturnType {
-    desiredQuota: Record<string, Asset>;
+    desiredQuota: Record<Address, Asset>;
     quotaIncrease: Array<Asset>;
     quotaDecrease: Array<Asset>;
 }
 export interface CalcQuotaBorrowRateProps {
-    quotas: Record<string, Asset>;
-    quotaRates: Record<string, Pick<QuotaInfo, "rate">>;
-    borrowAmount: bigint;
+    quotas: Record<Address, Asset>;
+    quotaRates: Record<Address, Pick<QuotaInfo, "isActive" | "rate">>;
+}
+export interface CalcRelativeBaseBorrowRateProps {
+    debt: bigint;
+    baseRateWithFee: number;
+    assetAmountInUnderlying: bigint;
+}
+export interface CalcAvgQuotaBorrowRateProps {
+    quotas: Record<Address, Asset>;
+    quotaRates: Record<Address, Pick<QuotaInfo, "isActive" | "rate">>;
+}
+interface LiquidationPriceProps {
+    liquidationThresholds: Record<Address, bigint>;
+    debt: bigint;
+    underlyingToken: Address;
+    targetToken: Address;
+    assets: Record<Address, Asset>;
+    tokensList: Record<Address, TokenData>;
+}
+export interface TimeToLiquidationProps {
+    totalBorrowRate_debt: bigint;
+    healthFactor: number;
 }
 export declare class CreditAccountData {
     readonly isSuccessful: boolean;
-    readonly addr: string;
-    readonly borrower: string;
-    readonly creditManager: string;
-    readonly creditFacade: string;
-    readonly underlyingToken: string;
-    readonly since: number;
+    readonly priceFeedsNeeded: Address[];
+    readonly addr: Address;
+    readonly borrower: Address;
+    readonly creditManager: Address;
+    readonly creditFacade: Address;
+    readonly underlyingToken: Address;
     readonly expirationDate: number;
     readonly version: number;
-    readonly cmDescription: string;
     readonly enabledTokenMask: bigint;
     readonly healthFactor: number;
     isDeleting: boolean;
-    readonly baseBorrowRate: number;
-    readonly borrowRate: number;
+    readonly baseBorrowRateWithoutFee: number;
     readonly borrowedAmount: bigint;
     readonly accruedInterest: bigint;
     readonly accruedFees: bigint;
@@ -63,32 +114,39 @@ export declare class CreditAccountData {
     readonly totalValue: bigint;
     readonly totalValueUSD: bigint;
     readonly twvUSD: bigint;
-    readonly cumulativeIndexNow: bigint;
-    readonly cumulativeIndexLastUpdate: bigint;
-    readonly cumulativeQuotaInterest: bigint;
-    readonly activeBots: string[];
-    readonly maxApprovedBots: bigint;
-    readonly balances: Record<string, bigint>;
-    readonly collateralTokens: Array<string>;
-    readonly allBalances: Record<string, CaTokenBalance>;
-    readonly forbiddenTokens: Record<string, true>;
-    readonly quotedTokens: Record<string, true>;
-    readonly schedultedWithdrawals: Array<ScheduledWithdrawal>;
+    readonly activeBots: Record<Address, true>;
+    readonly balances: Record<Address, bigint>;
+    readonly collateralTokens: Array<Address>;
+    readonly allBalances: Record<Address, CaTokenBalance>;
+    readonly forbiddenTokens: Record<Address, true>;
+    readonly quotedTokens: Record<Address, true>;
     constructor(payload: CreditAccountDataPayload);
     setDeleteInProgress(d: boolean): void;
-    static sortBalances(balances: Record<string, bigint>, prices: Record<string, bigint>, tokens: Record<string, TokenData>): Array<[string, bigint]>;
-    static tokensAbcComparator(t1?: TokenData, t2?: TokenData): 1 | -1;
+    static sortBalances(balances: Record<Address, bigint>, prices: Record<Address, bigint>, tokens: Record<Address, TokenData>): Array<[Address, bigint]>;
+    static sortAssets(balances: Array<Asset>, prices: Record<Address, bigint>, tokens: Record<Address, TokenData>): Asset[];
+    static tokensAbcComparator(t1?: TokenData, t2?: TokenData): 1 | -1 | 0;
     static amountAbcComparator(t1: bigint, t2: bigint): 1 | -1;
-    isForbidden(token: string): boolean;
-    isQuoted(token: string): boolean;
-    isTokenEnabled(index: number): boolean;
-    static isTokenEnabled(index: number, enabledTokenMask: bigint): boolean;
-    static calcMaxDebtIncrease(healthFactor: number, borrowAmountPlusInterest: bigint, underlyingLT: number, minHf?: number): bigint;
-    static calcOverallAPY({ caAssets, lpAPY, prices, quotas, quotaRates, totalValue, debt, baseBorrowRate, underlyingToken, }: CalcOverallAPYProps): bigint | undefined;
+    isForbidden(token: Address): boolean;
+    isQuoted(token: Address): boolean;
+    isTokenEnabled(token: Address): boolean;
+    static calcMaxDebtIncrease(healthFactor: number, debt: bigint, underlyingLT: number, minHf?: number): bigint;
+    static calcMaxLendingDebt({ assets, liquidationThresholds, underlyingToken, prices, tokensList, targetHF, }: CalcMaxLendingDebtProps): bigint;
+    static calcOverallAPY({ caAssets, lpAPY, prices, quotas, quotaRates, feeInterest, totalValue, debt, baseRateWithFee, underlyingToken, tokensList, }: CalcOverallAPYProps): bigint | undefined;
     hash(): string;
-    static hash(creditManager: string, borrower: string): string;
-    static calcHealthFactor({ assets, quotas, liquidationThresholds, underlyingToken, borrowed, prices, }: CalcHealthFactorProps): number;
-    static calcQuotaUpdate({ quotas, initialQuotas, assetsAfterUpdate, allowedToSpend, allowedToObtain, }: CalcQuotaUpdateProps): CalcQuotaUpdateReturnType;
-    static calcQuotaBorrowRate({ quotas, quotaRates, borrowAmount, }: CalcQuotaBorrowRateProps): number;
+    static hash(creditManager: Address, borrower: Address): string;
+    static calcHealthFactor({ assets, quotas, quotasInfo, liquidationThresholds, underlyingToken, debt, prices, tokensList, }: CalcHealthFactorProps): number;
+    static roundUpQuota(quotaChange: bigint): bigint;
+    static calcRecommendedQuota({ amount, debt, lt, quotaReserve, }: CalcRecommendedQuotaProps): bigint;
+    static calcDefaultQuota({ amount, lt, quotaReserve }: CalcDefaultQuotaProps): bigint;
+    static calcQuotaUpdate(props: CalcQuotaUpdateProps): CalcQuotaUpdateReturnType;
+    private static getSingleQuotaChange;
+    static calcQuotaBorrowRate({ quotas, quotaRates }: CalcQuotaBorrowRateProps): bigint;
+    static calcRelativeBaseBorrowRate({ debt, baseRateWithFee, assetAmountInUnderlying, }: CalcRelativeBaseBorrowRateProps): bigint;
+    static liquidationPrice({ liquidationThresholds, debt, underlyingToken, targetToken, assets, tokensList, }: LiquidationPriceProps): bigint;
+    /**
+     * Calculates the time remaining until liquidation for a credit account.
+     * @returns The time remaining until liquidation in milliseconds.
+     */
+    static getTimeToLiquidation({ healthFactor, totalBorrowRate_debt, }: TimeToLiquidationProps): bigint | null;
 }
 export {};