@gearbox-protocol/sdk 16.0.0-next.21 → 16.0.0-next.22

package/dist/esm/common-utils/utils/strategies/strategy-info/calculate-total-apy.js

@@ -1,62 +0,0 @@
-import { PERCENTAGE_FACTOR } from "../../../../onchain/constants/math.js";
-import "../../constants.js";
-import { calcOverallAPY } from "../../creditAccount/calc-overall-apy.js";
-import { isApyWithPointsException } from "../tokens/is-apy-with-points-exception.js";
-//#region src/common-utils/utils/strategies/strategy-info/calculate-total-apy.ts
-function calculateTotalAPY({ caAssets, lpAPY, pointsInfo, isValueTo, debt, totalValue, effectiveBorrowRate, showAPY, prices, quotaRates, quotas, feeInterest, underlyingToken, tokensList }) {
-	const pointsWithAPY = (lpAPY?.[pointsInfo?.address || ""] || 0) > 0;
-	if (pointsInfo?.address && !pointsWithAPY && !isApyWithPointsException(pointsInfo?.address)) return isValueTo ? {
-		overallAPY: null,
-		overallAPYBigInt: null,
-		overallAPYStatus: "pointsNoAPY"
-	} : {
-		overallAPY: void 0,
-		overallAPYBigInt: void 0,
-		overallAPYStatus: "pointsNoAPY"
-	};
-	if (pointsWithAPY && (debt === 0n || totalValue === 0n || caAssets.length === 0 || effectiveBorrowRate === 0)) return {
-		overallAPY: void 0,
-		overallAPYBigInt: void 0,
-		overallAPYStatus: "noAPY"
-	};
-	if (!showAPY) return {
-		overallAPY: null,
-		overallAPYBigInt: null,
-		overallAPYStatus: "notEnoughFarmAssets"
-	};
-	const r = calcOverallAPY({
-		caAssets,
-		lpAPY,
-		prices,
-		quotaRates,
-		quotas,
-		feeInterest,
-		totalValue,
-		debt,
-		baseRateWithFee: effectiveBorrowRate,
-		underlyingToken,
-		tokensList
-	});
-	if (r === void 0) return {
-		overallAPY: void 0,
-		overallAPYBigInt: void 0,
-		overallAPYStatus: "noAPY"
-	};
-	const apy = Number(r) / Number(PERCENTAGE_FACTOR);
-	if (pointsWithAPY && !isApyWithPointsException(pointsInfo?.address) && apy <= 0) return isValueTo ? {
-		overallAPY: null,
-		overallAPYBigInt: null,
-		overallAPYStatus: "negativeForPoints"
-	} : {
-		overallAPY: void 0,
-		overallAPYBigInt: void 0,
-		overallAPYStatus: "negativeForPoints"
-	};
-	return {
-		overallAPYStatus: "calculated",
-		overallAPY: apy,
-		overallAPYBigInt: r
-	};
-}
-//#endregion
-export { calculateTotalAPY };

package/dist/esm/common-utils/utils/strategies/strategy-info/calculate-total-apy.spec.js

@@ -1,184 +0,0 @@
-import { PERCENTAGE_FACTOR } from "../../../../onchain/constants/math.js";
-import { calcOverallAPY } from "../../creditAccount/calc-overall-apy.js";
-import { calculateTotalAPY } from "./calculate-total-apy.js";
-import { mockPrices, mockToken1, mockTokenData, mockUnderlyingToken } from "../../../test-utils/index.js";
-import { afterEach, describe, expect, it, vi } from "vitest";
-//#region src/common-utils/utils/strategies/strategy-info/calculate-total-apy.spec.ts
-vi.mock("../../utils/creditAccount/calc-overall-apy.js", async () => {
-	const actual = await vi.importActual("../../utils/creditAccount/calc-overall-apy.js");
-	return {
-		...actual,
-		calcOverallAPY: vi.fn(actual.calcOverallAPY)
-	};
-});
-const buildLpAPYList = (entries) => entries.reduce((acc, { token, apy }) => {
-	acc[token] = apy;
-	return acc;
-}, {});
-describe("calculateTotalAPY", () => {
-	const baseArgs = {
-		caAssets: [{
-			token: mockToken1,
-			balance: 1n
-		}],
-		lpAPY: buildLpAPYList([{
-			token: mockToken1,
-			apy: 1
-		}]),
-		pointsInfo: { address: mockToken1 },
-		isValueTo: false,
-		debt: 1n,
-		totalValue: 1n,
-		effectiveBorrowRate: 1,
-		showAPY: true,
-		prices: mockPrices,
-		quotaRates: {},
-		quotas: {},
-		feeInterest: 0,
-		underlyingToken: mockUnderlyingToken,
-		tokensList: mockTokenData
-	};
-	afterEach(() => {
-		vi.clearAllMocks();
-		vi.restoreAllMocks();
-	});
-	it("returns pointsNoAPY undefined for valueFrom when points have no APY", () => {
-		const result = calculateTotalAPY({
-			...baseArgs,
-			lpAPY: buildLpAPYList([])
-		});
-		expect(result).toEqual({
-			overallAPY: void 0,
-			overallAPYBigInt: void 0,
-			overallAPYStatus: "pointsNoAPY"
-		});
-	});
-	it("returns pointsNoAPY null for valueTo when points have no APY", () => {
-		const result = calculateTotalAPY({
-			...baseArgs,
-			lpAPY: buildLpAPYList([]),
-			isValueTo: true
-		});
-		expect(result).toEqual({
-			overallAPY: null,
-			overallAPYBigInt: null,
-			overallAPYStatus: "pointsNoAPY"
-		});
-	});
-	it("returns noAPY when pointsWithAPY but missing required values", () => {
-		const result = calculateTotalAPY({
-			...baseArgs,
-			debt: 0n
-		});
-		expect(result).toEqual({
-			overallAPY: void 0,
-			overallAPYBigInt: void 0,
-			overallAPYStatus: "noAPY"
-		});
-	});
-	it("returns notEnoughFarmAssets when showAPY is false", () => {
-		const result = calculateTotalAPY({
-			...baseArgs,
-			showAPY: false
-		});
-		expect(result).toEqual({
-			overallAPY: null,
-			overallAPYBigInt: null,
-			overallAPYStatus: "notEnoughFarmAssets"
-		});
-	});
-	it("returns noAPY when calcOverallAPY returns undefined", () => {
-		vi.mocked(calcOverallAPY).mockReturnValue(void 0);
-		const result = calculateTotalAPY(baseArgs);
-		expect(calcOverallAPY).toHaveBeenCalledWith({
-			caAssets: baseArgs.caAssets,
-			lpAPY: baseArgs.lpAPY,
-			prices: baseArgs.prices,
-			quotaRates: baseArgs.quotaRates,
-			quotas: baseArgs.quotas,
-			feeInterest: baseArgs.feeInterest,
-			totalValue: baseArgs.totalValue,
-			debt: baseArgs.debt,
-			baseRateWithFee: baseArgs.effectiveBorrowRate,
-			underlyingToken: baseArgs.underlyingToken,
-			tokensList: baseArgs.tokensList
-		});
-		expect(result).toEqual({
-			overallAPY: void 0,
-			overallAPYBigInt: void 0,
-			overallAPYStatus: "noAPY"
-		});
-	});
-	it("returns negativeForPoints undefined when APY <= 0 and valueFrom", () => {
-		vi.mocked(calcOverallAPY).mockReturnValue(0n);
-		const result = calculateTotalAPY(baseArgs);
-		expect(calcOverallAPY).toHaveBeenCalledWith({
-			caAssets: baseArgs.caAssets,
-			lpAPY: baseArgs.lpAPY,
-			prices: baseArgs.prices,
-			quotaRates: baseArgs.quotaRates,
-			quotas: baseArgs.quotas,
-			feeInterest: baseArgs.feeInterest,
-			totalValue: baseArgs.totalValue,
-			debt: baseArgs.debt,
-			baseRateWithFee: baseArgs.effectiveBorrowRate,
-			underlyingToken: baseArgs.underlyingToken,
-			tokensList: baseArgs.tokensList
-		});
-		expect(result).toEqual({
-			overallAPY: void 0,
-			overallAPYBigInt: void 0,
-			overallAPYStatus: "negativeForPoints"
-		});
-	});
-	it("returns negativeForPoints null when APY <= 0 and valueTo", () => {
-		vi.mocked(calcOverallAPY).mockReturnValue(0n);
-		const result = calculateTotalAPY({
-			...baseArgs,
-			isValueTo: true
-		});
-		expect(calcOverallAPY).toHaveBeenCalledWith({
-			caAssets: baseArgs.caAssets,
-			lpAPY: baseArgs.lpAPY,
-			prices: baseArgs.prices,
-			quotaRates: baseArgs.quotaRates,
-			quotas: baseArgs.quotas,
-			feeInterest: baseArgs.feeInterest,
-			totalValue: baseArgs.totalValue,
-			debt: baseArgs.debt,
-			baseRateWithFee: baseArgs.effectiveBorrowRate,
-			underlyingToken: baseArgs.underlyingToken,
-			tokensList: baseArgs.tokensList
-		});
-		expect(result).toEqual({
-			overallAPY: null,
-			overallAPYBigInt: null,
-			overallAPYStatus: "negativeForPoints"
-		});
-	});
-	it("returns calculated when APY is positive", () => {
-		const apyBigInt = 2n * PERCENTAGE_FACTOR;
-		vi.mocked(calcOverallAPY).mockReturnValue(apyBigInt);
-		const result = calculateTotalAPY(baseArgs);
-		expect(calcOverallAPY).toHaveBeenCalledWith({
-			caAssets: baseArgs.caAssets,
-			lpAPY: baseArgs.lpAPY,
-			prices: baseArgs.prices,
-			quotaRates: baseArgs.quotaRates,
-			quotas: baseArgs.quotas,
-			feeInterest: baseArgs.feeInterest,
-			totalValue: baseArgs.totalValue,
-			debt: baseArgs.debt,
-			baseRateWithFee: baseArgs.effectiveBorrowRate,
-			underlyingToken: baseArgs.underlyingToken,
-			tokensList: baseArgs.tokensList
-		});
-		expect(result).toEqual({
-			overallAPYStatus: "calculated",
-			overallAPY: 2,
-			overallAPYBigInt: apyBigInt
-		});
-	});
-});
-//#endregion
-export {};

package/dist/esm/common-utils/utils/strategies/strategy-info/calculate-total-points.js

@@ -1,37 +0,0 @@
-import { BigIntMath } from "../../../../onchain/utils/bigint-math.js";
-import { LEVERAGE_DECIMALS, PERCENTAGE_FACTOR, PRICE_DECIMALS } from "../../../../onchain/constants/math.js";
-import { PriceUtils } from "../../price-math.js";
-import { getPointsRates } from "../points/get-points-rates.js";
-//#region src/common-utils/utils/strategies/strategy-info/calculate-total-points.ts
-const THRESHOLD_POINTS = 1e3;
-function calculateTotalPoints({ pointsAsset, cmAddress, info, totalValue, assetValue, prices, tokensList, underlyingToken }) {
-	if (!pointsAsset || !info) return null;
-	if (totalValue === void 0 || totalValue <= 0n) return null;
-	if (assetValue === void 0 || assetValue <= 0n) return null;
-	const { token: tokenAddress, balance: amount } = pointsAsset;
-	const price = prices[tokenAddress] || 0n;
-	const tokenDecimals = tokensList[tokenAddress]?.decimals || 18;
-	const money = PriceUtils.calcTotalPrice(price, amount, tokenDecimals);
-	const underlyingPrice = prices[underlyingToken] ?? PRICE_DECIMALS;
-	const { decimals: underlyingDecimals = 18 } = tokensList[underlyingToken] || {};
-	const assetAmountInUnderlying = PriceUtils.convertByPrice(money, {
-		price: underlyingPrice || PRICE_DECIMALS,
-		decimals: underlyingDecimals
-	});
-	if (assetAmountInUnderlying * PERCENTAGE_FACTOR / totalValue < THRESHOLD_POINTS) return null;
-	const leverage = assetAmountInUnderlying * LEVERAGE_DECIMALS / assetValue;
-	const rates = getPointsRates(info.rewards, leverage);
-	const debt = totalValue - assetValue;
-	const leverageDebt = BigIntMath.min(assetAmountInUnderlying, debt > 0 ? debt : 0n) * LEVERAGE_DECIMALS / assetValue;
-	const debtRewardsAvailable = (info.debtRewards || []).filter((r) => r.cm === cmAddress || r.cm === "any");
-	return {
-		info,
-		rates,
-		debtRates: {
-			rewards: debtRewardsAvailable,
-			rates: getPointsRates(debtRewardsAvailable, leverageDebt)
-		}
-	};
-}
-//#endregion
-export { calculateTotalPoints };

package/dist/esm/common-utils/utils/strategies/strategy-info/calculate-total-points.spec.js

@@ -1,124 +0,0 @@
-import { LEVERAGE_DECIMALS, PRICE_DECIMALS } from "../../../../onchain/constants/math.js";
-import { calculateTotalPoints } from "./calculate-total-points.js";
-import { mockCMAddress, mockPrices, mockToken1, mockTokenData, mockUnderlyingToken } from "../../../test-utils/index.js";
-import { describe, expect, it } from "vitest";
-//#region src/common-utils/utils/strategies/strategy-info/calculate-total-points.spec.ts
-describe("calculateTotalPoints", () => {
-	const pointsInfo = {
-		symbol: "PTS",
-		address: mockToken1,
-		rewards: [{
-			name: "points",
-			units: "pts",
-			multiplier: LEVERAGE_DECIMALS,
-			type: "base"
-		}],
-		debtRewards: [{
-			name: "debt",
-			units: "pts",
-			multiplier: LEVERAGE_DECIMALS,
-			type: "debt",
-			cm: mockCMAddress
-		}]
-	};
-	const baseArgs = {
-		pointsAsset: {
-			token: mockToken1,
-			balance: 1n
-		},
-		cmAddress: mockCMAddress,
-		info: pointsInfo,
-		totalValue: 10n * PRICE_DECIMALS,
-		assetValue: 1n,
-		prices: mockPrices,
-		tokensList: mockTokenData,
-		underlyingToken: mockUnderlyingToken
-	};
-	it("returns null when no pointsAsset or info", () => {
-		expect(calculateTotalPoints({
-			...baseArgs,
-			pointsAsset: void 0
-		})).toBeNull();
-		expect(calculateTotalPoints({
-			...baseArgs,
-			info: void 0
-		})).toBeNull();
-	});
-	it("returns null when no totalValue", () => {
-		expect(calculateTotalPoints({
-			...baseArgs,
-			totalValue: void 0
-		})).toBeNull();
-		expect(calculateTotalPoints({
-			...baseArgs,
-			totalValue: 0n
-		})).toBeNull();
-	});
-	it("returns null when no assetValue", () => {
-		expect(calculateTotalPoints({
-			...baseArgs,
-			assetValue: void 0
-		})).toBeNull();
-		expect(calculateTotalPoints({
-			...baseArgs,
-			assetValue: 0n
-		})).toBeNull();
-	});
-	it("returns null when below threshold", () => {
-		const result = calculateTotalPoints({
-			...baseArgs,
-			totalValue: 10n * PRICE_DECIMALS
-		});
-		expect(result).toBeNull();
-	});
-	it("returns points data when above threshold with matching debt rewards", () => {
-		const assetAmount = PRICE_DECIMALS;
-		const totalValue = 4n * PRICE_DECIMALS;
-		const result = calculateTotalPoints({
-			pointsAsset: {
-				token: mockToken1,
-				balance: assetAmount
-			},
-			cmAddress: mockCMAddress,
-			info: pointsInfo,
-			totalValue,
-			assetValue: PRICE_DECIMALS,
-			prices: {
-				...mockPrices,
-				[mockToken1]: 2n * PRICE_DECIMALS
-			},
-			tokensList: mockTokenData,
-			underlyingToken: mockUnderlyingToken
-		});
-		expect(result?.info).toBe(pointsInfo);
-		expect(result?.rates).toEqual([2n * LEVERAGE_DECIMALS]);
-		expect(result?.debtRates.rewards).toHaveLength(1);
-		expect(result?.debtRates.rates).toEqual([2n * LEVERAGE_DECIMALS]);
-	});
-	it("returns points data when above threshold with matching debt rewards when debt is lower than asset amount", () => {
-		const assetAmount = PRICE_DECIMALS;
-		const totalValue = 4n * PRICE_DECIMALS;
-		const result = calculateTotalPoints({
-			pointsAsset: {
-				token: mockToken1,
-				balance: assetAmount
-			},
-			cmAddress: mockCMAddress,
-			info: pointsInfo,
-			totalValue,
-			assetValue: PRICE_DECIMALS,
-			prices: {
-				...mockPrices,
-				[mockToken1]: 4n * PRICE_DECIMALS
-			},
-			tokensList: mockTokenData,
-			underlyingToken: mockUnderlyingToken
-		});
-		expect(result?.info).toBe(pointsInfo);
-		expect(result?.rates).toEqual([4n * LEVERAGE_DECIMALS]);
-		expect(result?.debtRates.rewards).toHaveLength(1);
-		expect(result?.debtRates.rates).toEqual([3n * LEVERAGE_DECIMALS]);
-	});
-});
-//#endregion
-export {};

package/dist/esm/common-utils/utils/strategies/strategy-info/cm-availability-condition.js

@@ -1,42 +0,0 @@
-import { checkBoolean } from "../availability/check-boolean.js";
-import { checkDegenNFT } from "../availability/check-degen-nft.js";
-import "../availability/index.js";
-import { checkOpenAccountCeilings } from "./credit-manager-issues.js";
-//#region src/common-utils/utils/strategies/strategy-info/cm-availability-condition.ts
-function cmAvailabilityCondition(targetToken, cmA, cmB, pools) {
-	const aHasMinError = checkOpenAccountCeilings({
-		pool: pools?.[cmA.pool],
-		debt: cmA.minDebt,
-		creditManager: cmA,
-		targetToken
-	});
-	const bHasMinError = checkOpenAccountCeilings({
-		pool: pools?.[cmB.pool],
-		debt: cmB.minDebt,
-		creditManager: cmB,
-		targetToken
-	});
-	const minSort = checkBoolean(!aHasMinError, !bHasMinError);
-	if (minSort !== 0) return minSort;
-	const { freeOfNFT: aFreeOfNFT } = checkDegenNFT(cmA);
-	const { freeOfNFT: bFreeOfNFT } = checkDegenNFT(cmB);
-	const nftSort = checkBoolean(aFreeOfNFT, bFreeOfNFT);
-	if (nftSort !== 0) return nftSort;
-	const aHasMaxError = checkOpenAccountCeilings({
-		pool: pools?.[cmA.pool],
-		debt: cmA.maxDebt,
-		creditManager: cmA,
-		targetToken
-	});
-	const bHasMaxError = checkOpenAccountCeilings({
-		pool: pools?.[cmB.pool],
-		debt: cmB.maxDebt,
-		creditManager: cmB,
-		targetToken
-	});
-	const maxSort = checkBoolean(!aHasMaxError, !bHasMaxError);
-	if (maxSort !== 0) return maxSort;
-	return 0;
-}
-//#endregion
-export { cmAvailabilityCondition };

package/dist/esm/common-utils/utils/strategies/strategy-info/credit-manager-issues.js

@@ -1,133 +0,0 @@
-import { BigIntMath } from "../../../../onchain/utils/bigint-math.js";
-import { checkBorrowLimit, checkCollateralised, checkCreditManagerPaused, checkDebtInBand, checkForbiddenToken, checkFunding, checkQuotaCount, checkQuotaLimit } from "../../../../onchain/validation/checks.js";
-import "../../../../onchain/index.js";
-//#region src/common-utils/utils/strategies/strategy-info/credit-manager-issues.ts
-/**
-* The ladders below are the order the strategy lists report in, which is theirs
-* to decide — the engine weighs the same ceilings differently and says so.
-*/
-/**
-* The lists hold no token registry, so only the address is real here — these
-* issues are read as a reason, not rendered as an amount.
-*/
-function tokenOf(chainId, address) {
-	return {
-		chainId,
-		address,
-		symbol: address,
-		name: "",
-		decimals: 0
-	};
-}
-/**
-* The debt ceilings an account opening runs into, in the order a form reports
-* them. The minimum debt is what is weighed — asking for less does not make it
-* fit.
-*/
-function checkOpenAccountCeilings(args) {
-	const { creditManager, pool, debt, targetToken } = args;
-	const underlying = tokenOf(creditManager.chainId, creditManager.underlyingToken);
-	const effectiveDebt = BigIntMath.max(creditManager.minDebt, debt);
-	const debtLimitLeft = BigIntMath.max(creditManager.totalDebtLimit - creditManager.totalDebt, 0n);
-	const { totalDebtLimit = 0n, totalBorrowed = 0n } = pool || {};
-	const poolDebtLimitLeft = totalDebtLimit - totalBorrowed;
-	const canOpenMinDebt = creditManager.minDebt <= debtLimitLeft && creditManager.minDebt <= poolDebtLimitLeft && creditManager.minDebt <= creditManager.availableToBorrow;
-	const minPositionSize = BigIntMath.min(BigIntMath.min(debtLimitLeft, poolDebtLimitLeft), creditManager.availableToBorrow);
-	const ceilings = [
-		...creditManager.totalDebtLimit >= 0n ? [{
-			available: debtLimitLeft,
-			binding: "managerDebtAvailable"
-		}] : [],
-		...totalDebtLimit > 0n ? [{
-			available: poolDebtLimitLeft,
-			binding: "poolDebtLimit"
-		}] : [],
-		{
-			available: creditManager.availableToBorrow,
-			binding: "poolAvailableLiquidity"
-		}
-	];
-	for (const { available, binding } of ceilings) {
-		const issue = checkBorrowLimit({
-			requested: effectiveDebt,
-			available,
-			binding,
-			underlying,
-			solutionAmount: canOpenMinDebt ? minPositionSize : void 0
-		});
-		if (issue) return issue;
-	}
-	if (targetToken !== null) return quotaIssue(creditManager, targetToken, effectiveDebt, underlying);
-	return null;
-}
-/** The room the keeper has left for a token, read off a slice. */
-function quotaIssue(creditManager, token, requested, underlying) {
-	const quota = creditManager.quotas[token];
-	if (!quota) return null;
-	const realLimit = quota.isActive ? quota.limit : 0n;
-	return checkQuotaLimit({
-		token: tokenOf(creditManager.chainId, token),
-		requested,
-		available: realLimit - quota.totalQuoted,
-		underlying
-	});
-}
-/** Everything the lists weigh before calling a manager usable, in their order. */
-function checkCreditManagerUsable(args) {
-	const { creditManager, pool, debt, targetToken } = args;
-	const { chainId } = creditManager;
-	const underlying = tokenOf(chainId, creditManager.underlyingToken);
-	return checkCreditManagerPaused({
-		isPaused: creditManager.isPaused,
-		creditManager: creditManager.address
-	}) || checkOpenAccountCeilings({
-		creditManager,
-		pool,
-		debt,
-		targetToken
-	}) || (args.tokenToObtain === null ? null : checkForbiddenToken({
-		token: tokenOf(chainId, args.tokenToObtain),
-		isForbidden: creditManager.isForbidden(args.tokenToObtain)
-	})) || fundingIssue(chainId, args.collateral, args.balances) || checkDebtInBand({
-		debt,
-		minDebt: creditManager.minDebt,
-		maxDebt: creditManager.maxDebt,
-		underlying,
-		allowZero: false
-	}) || checkQuotaCount({
-		count: Object.values(args.desiredQuota).filter((a) => a.balance > 0n).length,
-		max: creditManager.maxEnabledTokensLength
-	}) || quotaUpdateIssue(creditManager, args.quotaUpdate, underlying) || checkCollateralised({
-		healthFactor: args.healthFactor,
-		required: 10101,
-		safePrices: false
-	});
-}
-/**
-* The first asset the wallet cannot fund.
-*
-* The lookup lowercases because the balance map is keyed that way while a
-* market names its tokens as it spells them.
-*/
-function fundingIssue(chainId, collateral, balances) {
-	for (const { token, balance } of collateral) {
-		const held = balances[token.toLowerCase()] || 0n;
-		const issue = checkFunding({
-			token: tokenOf(chainId, token),
-			required: balance,
-			held
-		});
-		if (issue) return issue;
-	}
-	return null;
-}
-function quotaUpdateIssue(creditManager, quotaUpdate, underlying) {
-	for (const { token, balance: updateBy } of quotaUpdate) {
-		if (updateBy <= 0n) continue;
-		const issue = quotaIssue(creditManager, token, updateBy, underlying);
-		if (issue) return issue;
-	}
-	return null;
-}
-//#endregion
-export { checkCreditManagerUsable, checkOpenAccountCeilings };