@gearbox-protocol/sdk 14.5.10 → 14.6.0-next.1

package/dist/types/common-utils/utils/apy/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./bonus-apy-from-points.js";
+export * from "./calculate-effective-borrow-rate.js";
+export * from "./get-complex-apy-list.js";
+export * from "./get-rate-with-fee.js";
+export * from "./get-single-quota-borrow-rate.js";
+export * from "./max-apy-formula.js";

package/dist/types/common-utils/utils/apy/max-apy-formula.d.ts

@@ -0,0 +1,6 @@
+export declare function maxAPYFormula({ apy, leverage, baseRateWithFee, quotaRateWithFee, }: {
+    apy: number;
+    leverage: bigint;
+    baseRateWithFee: number;
+    quotaRateWithFee: number;
+}): number;

package/dist/types/common-utils/utils/index.d.ts

@@ -1,4 +1,6 @@
+export * from "./apy/index.js";
 export * from "./assets-math.js";
 export * from "./bigint-math.js";
 export * from "./creditAccount/index.js";
 export * from "./price-math.js";
+export * from "./strategies/index.js";

package/dist/types/common-utils/utils/strategies/__test-utils.d.ts

@@ -0,0 +1,11 @@
+import type { Address } from "viem";
+import type { CreditManagerSlice, PoolSlice, QuotaSlice, TokenSlice } from "./strategy-info/types.js";
+export declare const mockToken1: Address;
+export declare const mockToken2: Address;
+export declare const mockUnderlyingToken: Address;
+export declare const mockTokenData: Record<Address, TokenSlice>;
+export declare function buildQuota(overrides: Partial<QuotaSlice> & {
+    token: Address;
+}): QuotaSlice;
+export declare function buildPool(overrides?: Partial<PoolSlice>): PoolSlice;
+export declare function buildCreditManager(overrides?: Partial<CreditManagerSlice>): CreditManagerSlice;

package/dist/types/common-utils/utils/strategies/availability/check-boolean.d.ts

@@ -0,0 +1 @@
+export declare function checkBoolean(a: boolean, b: boolean): number;

package/dist/types/common-utils/utils/strategies/availability/check-degen-nft.d.ts

@@ -0,0 +1,5 @@
+import type { CreditManagerSlice } from "../strategy-info/types.js";
+export declare function checkDegenNFT(creditManager: CreditManagerSlice): {
+    nftAddress: `0x${string}`;
+    freeOfNFT: boolean;
+};

package/dist/types/common-utils/utils/strategies/availability/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./check-boolean.js";
+export * from "./check-degen-nft.js";
+export * from "./validate-open-account-pool-quota-status.js";
+export * from "./validate-open-account-pool-status.js";

package/dist/types/common-utils/utils/strategies/availability/validate-open-account-pool-quota-status.d.ts

@@ -0,0 +1,6 @@
+import type { Address } from "viem";
+import type { CreditManagerSlice } from "../strategy-info/types.js";
+export declare function validateOpenAccountPoolQuotaStatus(targetToken: Address, creditManager: CreditManagerSlice, amountToBorrow: bigint): {
+    readonly message: "insufficientQuota";
+    readonly token: `0x${string}`;
+} | null;

package/dist/types/common-utils/utils/strategies/availability/validate-open-account-pool-status.d.ts

@@ -0,0 +1,24 @@
+import type { Address } from "viem";
+import type { CreditManagerSlice, PoolSlice } from "../strategy-info/types.js";
+export interface ValidateOpenAccountPoolStatusProps {
+    creditManager: CreditManagerSlice;
+    pool: PoolSlice | undefined | null;
+    debt: bigint;
+    targetToken: Address | null;
+}
+export declare function validateOpenAccountPoolStatus(props: ValidateOpenAccountPoolStatusProps): {
+    readonly message: "insufficientQuota";
+    readonly token: `0x${string}`;
+} | {
+    readonly message: "insufficientDebtLimit";
+    readonly amount: bigint;
+    readonly solutionAmount: bigint | undefined;
+} | {
+    readonly message: "insufficientPoolDebtLimit";
+    readonly amount: bigint;
+    readonly solutionAmount: bigint | undefined;
+} | {
+    readonly message: "insufficientPoolLiquidity";
+    readonly amount: bigint;
+    readonly solutionAmount: bigint | undefined;
+} | null;

package/dist/types/common-utils/utils/strategies/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./availability/index.js";
+export * from "./leverage/index.js";
+export * from "./sort-strategy-cms-by-availability/index.js";
+export * from "./strategy-info/index.js";

package/dist/types/common-utils/utils/strategies/leverage/calculate-loss-coefficient.d.ts

@@ -0,0 +1 @@
+export declare function calculateLossCoefficient(slippage: number, constantLoss?: bigint): bigint;

package/dist/types/common-utils/utils/strategies/leverage/calculate-max-leverage-factor.d.ts

@@ -0,0 +1,12 @@
+import type { Address } from "viem";
+import type { LeverageFactor } from "./get-factor-from-leverage.js";
+export declare function calculateMaxLeverageFactor({ targetToken, slippage, creditManagers, constantLoss, leverageLimit, }: {
+    targetToken: Address;
+    slippage: number;
+    creditManagers: Array<{
+        liquidationThresholds: Record<Address, bigint>;
+        address: Address;
+    }>;
+    constantLoss?: bigint;
+    leverageLimit?: number;
+}): LeverageFactor;

package/dist/types/common-utils/utils/strategies/leverage/get-factor-from-leverage.d.ts

@@ -0,0 +1,4 @@
+export type LeverageFactor = bigint & {
+    __brand: "leverageFactor";
+};
+export declare function getFactorFromLeverage(leverage: bigint): bigint;

package/dist/types/common-utils/utils/strategies/leverage/get-leverage-from-factor.d.ts

@@ -0,0 +1,2 @@
+import type { LeverageFactor } from "./get-factor-from-leverage.js";
+export declare function getLeverageFromFactor(factor: LeverageFactor): bigint;

package/dist/types/common-utils/utils/strategies/leverage/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./calculate-loss-coefficient.js";
+export * from "./calculate-max-leverage-factor.js";
+export * from "./get-factor-from-leverage.js";
+export * from "./get-leverage-from-factor.js";
+export * from "./max-leverage.js";
+export * from "./max-leverage-threshold.js";

package/dist/types/common-utils/utils/strategies/leverage/max-leverage-threshold.d.ts

@@ -0,0 +1,5 @@
+import type { Address } from "viem";
+export declare function maxLeverageThreshold(lpToken: Address, cms: Array<{
+    liquidationThresholds: Record<Address, bigint>;
+    address: Address;
+}>): readonly [bigint, Address];

package/dist/types/common-utils/utils/strategies/leverage/max-leverage.d.ts

@@ -0,0 +1,9 @@
+import type { Address } from "viem";
+/**
+ * Max leverage factor (not leverage value) for a token across CMs.
+ * Returns a factor where leverage = factor + LEVERAGE_DECIMALS.
+ */
+export declare function maxLeverage(lpToken: Address, cms: Array<{
+    liquidationThresholds: Record<Address, bigint>;
+    address: Address;
+}>, targetHF?: bigint): bigint;

package/dist/types/common-utils/utils/strategies/sort-strategy-cms-by-availability/index.d.ts

@@ -0,0 +1 @@
+export * from "./sort-strategy-cms-by-availability.js";

package/dist/types/common-utils/utils/strategies/sort-strategy-cms-by-availability/sort-strategy-cms-by-availability.d.ts

@@ -0,0 +1,13 @@
+import type { Address } from "viem";
+import { type APYListSlice, type CreditManagerSlice, type PoolSlice } from "../strategy-info/index.js";
+export interface SortStrategyCMsByAvailabilityProps {
+    targetToken: Address;
+    allCreditManagers: Array<CreditManagerSlice>;
+    apyListByNetwork: Record<number, APYListSlice | undefined> | undefined;
+    pools: Record<Address, PoolSlice> | undefined | null;
+    slippage: number;
+    quotaReserve: number;
+    leverageLimit: number | undefined;
+    isStrategy: boolean;
+}
+export declare function sortStrategyCMsByAvailability({ targetToken, allCreditManagers, apyListByNetwork, pools, slippage, quotaReserve, leverageLimit, isStrategy, }: SortStrategyCMsByAvailabilityProps): Array<CreditManagerSlice>;

package/dist/types/common-utils/utils/strategies/strategy-info/cm-availability-condition.d.ts

@@ -0,0 +1,3 @@
+import type { Address } from "viem";
+import type { CreditManagerSlice, PoolSlice } from "./types.js";
+export declare function cmAvailabilityCondition(targetToken: Address, cmA: CreditManagerSlice, cmB: CreditManagerSlice, pools: Record<Address, PoolSlice> | null | undefined): number;

package/dist/types/common-utils/utils/strategies/strategy-info/get-strategy-info.d.ts

@@ -0,0 +1,2 @@
+import type { CreditManagerSlice, GetStrategyInfoArgs, StrategyInfoResult } from "./types.js";
+export declare function getStrategyInfo<ID extends string | number, CM extends CreditManagerSlice = CreditManagerSlice>({ strategy, creditManagers, sdkStateByChain, apyListByNetwork, quotaReserve, slippage, allPricesByChain, }: GetStrategyInfoArgs<ID, CM>): StrategyInfoResult<CM> | undefined;

package/dist/types/common-utils/utils/strategies/strategy-info/get-strategy-max-apy.d.ts

@@ -0,0 +1,13 @@
+import type { Address } from "viem";
+import type { APYListSlice, CreditManagerSlice } from "./types.js";
+export declare function getStrategyMaxAPY(targetToken: Address, cm: CreditManagerSlice | undefined, apyListByNetwork: Record<number, APYListSlice | undefined> | undefined, slippage: number, quotaReserve: number, leverageLimit: number | undefined): {
+    totalMaxApy: number;
+    bonusAPY: {
+        value: number;
+    } | undefined;
+    maxAPY: number;
+    maxLeverage: bigint;
+    quotaRateMin: bigint;
+    baseBorrowRate: number;
+    totalBorrowRate: number;
+} | undefined;

package/dist/types/common-utils/utils/strategies/strategy-info/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./cm-availability-condition.js";
+export * from "./get-strategy-info.js";
+export * from "./get-strategy-max-apy.js";
+export * from "./is-strategy-cm-disabled.js";
+export * from "./types.js";

package/dist/types/common-utils/utils/strategies/strategy-info/is-strategy-cm-disabled.d.ts

@@ -0,0 +1,2 @@
+import type { CreditManagerSlice, QuotaSlice } from "./types.js";
+export declare function isStrategyCMDisabled(cm: CreditManagerSlice, quota: QuotaSlice | undefined): boolean;

package/dist/types/common-utils/utils/strategies/strategy-info/types.d.ts

@@ -0,0 +1,80 @@
+import type { Address } from "viem";
+import type { PartialRecord } from "../../../../sdk/index.js";
+export interface QuotaSlice {
+    token: Address;
+    rate: bigint;
+    quotaIncreaseFee: bigint;
+    totalQuoted: bigint;
+    limit: bigint;
+    isActive: boolean;
+}
+export interface CreditManagerSlice {
+    address: Address;
+    underlyingToken: Address;
+    pool: Address;
+    chainId: number;
+    baseBorrowRate: number;
+    feeInterest: number;
+    availableToBorrow: bigint;
+    minDebt: bigint;
+    maxDebt: bigint;
+    totalDebt: bigint;
+    totalDebtLimit: bigint;
+    isDegenMode: boolean;
+    degenNFT: Address;
+    liquidationThresholds: Record<Address, bigint>;
+    quotas: Record<Address, QuotaSlice | undefined>;
+    collateralTokens: readonly Address[];
+}
+export interface PoolSlice {
+    address: Address;
+    totalDebtLimit: bigint;
+    totalBorrowed: bigint;
+}
+export interface TokenSlice {
+    address: Address;
+    decimals: number;
+    title?: string;
+}
+export interface StrategySlice<ID extends string | number = string> {
+    id: ID;
+    chainId: number;
+    tokenOutAddress: Address;
+    maxLeverage?: number;
+}
+export interface APYListSlice {
+    apyList: Record<Address, number> | undefined;
+    extraCollateralAPYList: Record<Address, Record<Address, {
+        type: "relative" | "absolute";
+        value: number;
+    }>> | undefined;
+}
+export interface PricesByChainSlice {
+    [chainId: number]: {
+        prices?: Record<Address, Record<Address, bigint>> | undefined;
+    } | undefined;
+}
+export interface StrategyInfoResult<CM extends CreditManagerSlice = CreditManagerSlice> {
+    maxLeverage: bigint;
+    maxAPY: number | undefined;
+    bonusAPY: {
+        value: number;
+    } | undefined;
+    totalBorrowRate: number;
+    availableToBorrowMoney: bigint;
+    minCreditManager: CM;
+}
+export interface GetStrategyInfoArgs<ID extends string | number, CM extends CreditManagerSlice> {
+    strategy: StrategySlice<ID>;
+    creditManagers: Record<number, PartialRecord<ID, Record<Address, CM>>> | undefined;
+    sdkStateByChain: Record<number, {
+        pools?: Record<Address, PoolSlice> | undefined;
+        tokens?: {
+            tokenDataList?: Record<Address, TokenSlice> | undefined;
+        };
+    } | undefined> | undefined;
+    apyListByNetwork: Record<number, APYListSlice | undefined> | undefined;
+    quotaReserve: number;
+    slippage: number;
+    allPricesByChain: PricesByChainSlice;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/sdk",
-  "version": "14.5.10",
+  "version": "14.6.0-next.1",
   "description": "Gearbox SDK",
   "license": "MIT",
   "main": "./dist/cjs/sdk/index.js",