@gearbox-protocol/sdk 15.1.0-next.4 → 15.1.0-next.6

package/dist/cjs/sdk/market/math.js

@@ -16,7 +16,8 @@ const FULL = Number(require_sdk_constants_math.PERCENTAGE_FACTOR);
 *
 * @example
 * ```ts
-* rayToBps(50_000_000_000_000_000_000_000_000n) // 500, i.e. 5%
+* // ray: 5% (0.05 × 10²⁷)
+* rayToBps(50_000_000_000_000_000_000_000_000n) // 500 bps = 5%
 * ```
 **/
 function rayToBps(ray) {
@@ -27,6 +28,7 @@ function rayToBps(ray) {
 *
 * @example
 * ```ts
+* // usd: $1500.50 in 8-decimal fixed point
 * usdToNumber(150_050_000_000n) // 1500.5
 * ```
 **/
@@ -39,56 +41,66 @@ function usdToNumber(usd) {
 *
 * @example
 * ```ts
-* utilizationBps(750n, 1000n) // 7500, i.e. 75%
+* // borrowed: 750, total: 1000
+* calcUtilization(750n, 1000n) // 750 / 1000 = 7500 bps = 75%
 * ```
 **/
-function utilizationBps(borrowed, total) {
+function calcUtilization(borrowed, total) {
 	if (total <= 0n || borrowed <= 0n) return 0;
 	const utilization = Number(borrowed * require_sdk_constants_math.PERCENTAGE_FACTOR / total);
 	return Math.min(utilization, FULL);
 }
 /**
-* Annual cost of debt for a credit manager, in basis points: the pool's base
-* rate plus the protocol's cut of the accrued interest.
+* Annual cost of debt for a credit manager, in basis points:
+* `baseInterestRate × (1 + feeInterest)` — the pool's base rate plus the
+* protocol's cut of the accrued interest.
 *
 * @param baseInterestRate - Pool base rate in ray.
 * @param feeInterest - Credit manager interest fee in basis points.
 *
 * @example
 * ```ts
-* // 5% base rate, 50% interest fee
-* borrowApyBps(50_000_000_000_000_000_000_000_000n, 5000) // 750, i.e. 7.5%
+* // baseInterestRate: 5% in ray, feeInterest: 5000 bps = 50%
+* calcBorrowApy(50_000_000_000_000_000_000_000_000n, 5000) // 5% × 1.5 = 750 bps = 7.5%
 * ```
 **/
-function borrowApyBps(baseInterestRate, feeInterest) {
+function calcBorrowApy(baseInterestRate, feeInterest) {
 	return rayToBps(baseInterestRate * (require_sdk_constants_math.PERCENTAGE_FACTOR + BigInt(feeInterest)) / require_sdk_constants_math.PERCENTAGE_FACTOR);
 }
 /**
-* Highest leverage a liquidation threshold allows: `1 / (1 - lt)`.
-*
-* A threshold of 100% or more would allow unbounded leverage; such tokens are
-* not strategies and are filtered out before this is called, so the guard here
-* only exists to keep the function total.
+* 5% safety margin subtracted from 100% in {@link calcMaxLeverage}, so a
+* maxed position opens with HF slightly above 1.
+**/
+const MAX_LEVERAGE_BUFFER_BPS = 500;
+/**
+* Highest total-value leverage a liquidation threshold allows:
+* `(100% − buffer) / (100% − liquidationThreshold)`. At HF = 1, debt is
+* `liquidationThreshold × totalValue`, leaving `1 − liquidationThreshold` of
+* equity per unit of exposure; the {@link MAX_LEVERAGE_BUFFER_BPS} buffer
+* keeps the maxed position slightly away from that boundary.
 *
 * @example
 * ```ts
-* maxLeverage(9000) // 10
-* maxLeverage(8000) // 5
+* // liquidationThreshold: 9000 bps = 90%
+* calcMaxLeverage(9000) // (1 − 0.05) / (1 − 0.9) = 9.5x total exposure
 * ```
 **/
-function maxLeverage(liquidationThreshold) {
-	const equity = FULL - liquidationThreshold;
-	return equity > 0 ? FULL / equity : Number.POSITIVE_INFINITY;
+function calcMaxLeverage(liquidationThreshold) {
+	if (liquidationThreshold >= FULL) return 0;
+	const leverage = (FULL - 500) / (FULL - liquidationThreshold);
+	return Math.max(leverage, 1);
 }
 /**
 * Converts a credit account's health factor from the 18-decimal fixed point the
 * contracts store to basis points.
 *
-* An account with no debt return MAX_UINT256 from contract, here we return 0
+* Accounts with no debt store `MAX_UINT256` on-chain; for those this
+* returns `0`.
 *
 * @example
 * ```ts
-* healthFactorBps(1_250_000_000_000_000_000n) // 12500, i.e. 1.25
+* // healthFactor: 1.25 in 18-decimal fixed point
+* healthFactorBps(1_250_000_000_000_000_000n) // 12500 bps = 1.25
 * ```
 **/
 function healthFactorBps(healthFactor) {
@@ -96,39 +108,39 @@ function healthFactorBps(healthFactor) {
 	return Number(healthFactor * require_sdk_constants_math.PERCENTAGE_FACTOR / require_sdk_constants_math.WAD);
 }
 /**
-* Leverage of an open position: `totalDebt / equity`, where equity is what is
-* left of the position's value once its debt is repaid.
-*
-* Returns `0` for a position that carries no debt and for one that is
-* underwater, where there is no equity to lever.
+* Total-value leverage of an open position:
+* `totalValue / (totalValue − totalDebt)`. `1` when unleveraged, `0` when
+* underwater.
 *
-* @param totalDebt - Debt principal plus accrued interest and fees.
-* @param totalValue - Total value of the position, in the same token.
+* @param totalValue - Total value of the position.
+* @param totalDebt - Debt principal plus accrued interest and fees, same token.
 *
 * @example
 * ```ts
-* positionLeverage(800n, 1000n) // 4, i.e. 4x debt per unit of equity
+* // totalValue: 100k, totalDebt: 80k → equity: 100k − 80k = 20k
+* calcPositionLeverage(100_000n, 80_000n) // 100k / 20k = 5x
 * ```
 **/
-function positionLeverage(totalDebt, totalValue) {
+function calcPositionLeverage(totalValue, totalDebt) {
 	const equity = totalValue - totalDebt;
-	if (equity <= 0n || totalDebt <= 0n) return 0;
-	return Number(totalDebt) / Number(equity);
+	if (totalValue <= 0n || equity <= 0n) return 0;
+	if (totalDebt <= 0n) return 1;
+	return Number(totalValue) / Number(equity);
 }
 /**
-* Annual quota cost scaled to the debt a maximally leveraged position carries,
-* in basis points. Every unit of own capital carries `maxLeverage - 1` units of
-* debt, and the quota is paid on the whole quoted position.
+* Annual quota cost on equity, in basis points:
+* `quotaRate × (1 + feeInterest) × leverage`. Quota accrues on the whole
+* quoted position, and the DAO takes `feeInterest` of it as with base interest.
 *
 * @example
 * ```ts
-* // 2.5% quota rate at 5x leverage
-* additionalBorrowApyBps(250, 5) // 1000, i.e. 10%
+* // quotaRate: 200 bps = 2%, feeInterest: 2500 bps = 25%, leverage: 9.5x
+* calcAdditionalBorrowApy(200, 2500, 9.5) // 2% × 1.25 × 9.5 = 2375 bps = 23.75%
 * ```
 **/
-function additionalBorrowApyBps(quotaRate, leverage) {
-	if (!Number.isFinite(leverage)) return 0;
-	return Math.round(quotaRate * Math.max(leverage - 1, 0));
+function calcAdditionalBorrowApy(quotaRate, feeInterest, leverage) {
+	if (!Number.isFinite(leverage) || leverage <= 0) return 0;
+	return Math.round(quotaRate * (1 + feeInterest / FULL) * leverage);
 }
 /**
 * {@link PERCENTAGE_FACTOR} less a 0.1% safety buffer.
@@ -186,15 +198,16 @@ function optimalHFForPartialLiquidation(borrowRate) {
 	return require_sdk_constants_math.PERCENTAGE_FACTOR + (borrowRate < 100n ? borrowRate : 100n);
 }
 //#endregion
+exports.MAX_LEVERAGE_BUFFER_BPS = MAX_LEVERAGE_BUFFER_BPS;
 exports.PARTIAL_LIQUIDATION_BUFFER_BPS = PARTIAL_LIQUIDATION_BUFFER_BPS;
-exports.additionalBorrowApyBps = additionalBorrowApyBps;
-exports.borrowApyBps = borrowApyBps;
+exports.calcAdditionalBorrowApy = calcAdditionalBorrowApy;
+exports.calcBorrowApy = calcBorrowApy;
+exports.calcMaxLeverage = calcMaxLeverage;
+exports.calcPositionLeverage = calcPositionLeverage;
+exports.calcUtilization = calcUtilization;
 exports.healthFactorBps = healthFactorBps;
-exports.maxLeverage = maxLeverage;
 exports.minSeizedAmount = minSeizedAmount;
 exports.optimalHFForPartialLiquidation = optimalHFForPartialLiquidation;
 exports.optimalRepaidAmount = optimalRepaidAmount;
-exports.positionLeverage = positionLeverage;
 exports.rayToBps = rayToBps;
 exports.usdToNumber = usdToNumber;
-exports.utilizationBps = utilizationBps;

package/dist/cjs/sdk/market/pool/PoolV310Contract.js

@@ -51,7 +51,7 @@ var PoolV310Contract = class extends require_sdk_base_BaseContract.BaseContract
 	* {@inheritDoc IPoolContract.utilization}
 	*/
 	get utilization() {
-		return require_sdk_market_math.utilizationBps(this.borrowed, this.expectedLiquidity);
+		return require_sdk_market_math.calcUtilization(this.borrowed, this.expectedLiquidity);
 	}
 	/**
 	* {@inheritDoc IPoolContract.unwrappedUnderlying}

package/dist/cjs/sdk/opportunities/index.js

@@ -1,18 +1,5 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const require_sdk_market_math = require("../market/math.js");
 const require_sdk_opportunities_MultichainOpportunitiesService = require("./MultichainOpportunitiesService.js");
 const require_sdk_opportunities_OpportunitiesService = require("./OpportunitiesService.js");
 exports.MultichainOpportunitiesService = require_sdk_opportunities_MultichainOpportunitiesService.MultichainOpportunitiesService;
 exports.OpportunitiesService = require_sdk_opportunities_OpportunitiesService.OpportunitiesService;
-exports.PARTIAL_LIQUIDATION_BUFFER_BPS = require_sdk_market_math.PARTIAL_LIQUIDATION_BUFFER_BPS;
-exports.additionalBorrowApyBps = require_sdk_market_math.additionalBorrowApyBps;
-exports.borrowApyBps = require_sdk_market_math.borrowApyBps;
-exports.healthFactorBps = require_sdk_market_math.healthFactorBps;
-exports.maxLeverage = require_sdk_market_math.maxLeverage;
-exports.minSeizedAmount = require_sdk_market_math.minSeizedAmount;
-exports.optimalHFForPartialLiquidation = require_sdk_market_math.optimalHFForPartialLiquidation;
-exports.optimalRepaidAmount = require_sdk_market_math.optimalRepaidAmount;
-exports.positionLeverage = require_sdk_market_math.positionLeverage;
-exports.rayToBps = require_sdk_market_math.rayToBps;
-exports.usdToNumber = require_sdk_market_math.usdToNumber;
-exports.utilizationBps = require_sdk_market_math.utilizationBps;

package/dist/esm/dev/compareOpportunities.js

@@ -0,0 +1,216 @@
+import { opportunityId } from "../model/opportunities.js";
+import "../model/index.js";
+//#region src/dev/compareOpportunities.ts
+/**
+* Matches two opportunity listings by {@link opportunityId} and reports every
+* field the two sources disagree on.
+*
+* Nothing is filtered out: a diff that is expected — a field only the backend
+* can fill, a formula the two sides define differently, a USD value smoothed on
+* one side — is reported like any other, tagged by {@link DiffKind} so that a
+* reader can bucket it afterwards.
+**/
+function compareOpportunities(input) {
+	const onchainRows = indexById(input.onchain.data);
+	const offchainRows = indexById(input.offchain.data);
+	const onlyOnchain = [];
+	const onlyOffchain = [];
+	const matched = [];
+	for (const [id, row] of onchainRows) {
+		const counterpart = offchainRows.get(id);
+		if (!counterpart) {
+			onlyOnchain.push(toRef(row));
+			continue;
+		}
+		const diffs = diffOpportunity(row, counterpart);
+		matched.push({
+			id,
+			kind: row.kind,
+			chainId: row.chainId,
+			onchainName: row.name,
+			offchainName: counterpart.name,
+			identical: diffs.length === 0,
+			diffs
+		});
+	}
+	for (const [id, row] of offchainRows) if (!onchainRows.has(id)) onlyOffchain.push(toRef(row));
+	byId(onlyOnchain);
+	byId(onlyOffchain);
+	matched.sort((a, b) => a.id.localeCompare(b.id));
+	return {
+		generatedAt: input.generatedAt ?? (/* @__PURE__ */ new Date()).toISOString(),
+		backendUrl: input.backendUrl,
+		networks: [...input.networks],
+		onchainChains: input.onchain.meta.chains,
+		offchainChains: input.offchain.meta.chains,
+		summary: summarize(input.onchain.data, input.offchain.data, onlyOnchain, onlyOffchain, matched),
+		onlyOnchain,
+		onlyOffchain,
+		matched
+	};
+}
+function indexById(rows) {
+	return new Map(rows.map((row) => [opportunityId(row), row]));
+}
+function byId(refs) {
+	refs.sort((a, b) => a.id.localeCompare(b.id));
+}
+function toRef(row) {
+	const base = {
+		id: opportunityId(row),
+		kind: row.kind,
+		chainId: row.chainId,
+		name: row.name
+	};
+	return row.kind === "pool" ? {
+		...base,
+		pool: row.pool
+	} : {
+		...base,
+		creditManager: row.creditManager,
+		targetCollateral: row.targetCollateral.address
+	};
+}
+/**
+* Every field two versions of one opportunity disagree on.
+**/
+function diffOpportunity(onchain, offchain) {
+	const diffs = [];
+	diffValue("", onchain, offchain, diffs);
+	return diffs;
+}
+function diffValue(path, onchain, offchain, out) {
+	if (isAbsent(onchain) && isAbsent(offchain)) return;
+	if (isAbsent(onchain) || isAbsent(offchain)) {
+		out.push({
+			path,
+			onchain,
+			offchain,
+			kind: "presence"
+		});
+		return;
+	}
+	if (Array.isArray(onchain) && Array.isArray(offchain)) {
+		diffArray(path, onchain, offchain, out);
+		return;
+	}
+	if (isRecord(onchain) && isRecord(offchain)) {
+		for (const key of union(Object.keys(onchain), Object.keys(offchain))) diffValue(join(path, key), onchain[key], offchain[key], out);
+		return;
+	}
+	if (!sameScalar(onchain, offchain)) out.push({
+		path,
+		onchain,
+		offchain,
+		kind: scalarKind(path, onchain)
+	});
+}
+/**
+* Arrays whose elements identify themselves — collateral tokens, points
+* programs — are matched by that identity, so a token present on one side only
+* is reported as such rather than shifting every later element into a diff.
+**/
+function diffArray(path, onchain, offchain, out) {
+	const onchainKeyed = keyElements(onchain);
+	const offchainKeyed = keyElements(offchain);
+	if (!onchainKeyed || !offchainKeyed) {
+		if (onchain.length !== offchain.length) {
+			out.push({
+				path,
+				onchain,
+				offchain,
+				kind: "other"
+			});
+			return;
+		}
+		onchain.forEach((element, index) => {
+			diffValue(`${path}[${index}]`, element, offchain[index], out);
+		});
+		return;
+	}
+	for (const key of union([...onchainKeyed.keys()], [...offchainKeyed.keys()])) diffValue(`${path}[${key}]`, onchainKeyed.get(key), offchainKeyed.get(key), out);
+}
+/**
+* The array indexed by each element's own identity, or `undefined` when its
+* elements have none and order is all there is to go by.
+**/
+function keyElements(values) {
+	const keyed = /* @__PURE__ */ new Map();
+	for (const value of values) {
+		if (!isRecord(value)) return;
+		const identity = value.address ?? value.id ?? value.token;
+		if (typeof identity !== "string") return;
+		keyed.set(identity.toLowerCase(), value);
+	}
+	return keyed.size === values.length ? keyed : void 0;
+}
+const ADDRESS = /^0x[0-9a-f]{40}$/i;
+/**
+* Only addresses are compared case-insensitively: the backend lowercases them
+* while the chain hands out checksummed ones, which is not a disagreement. A
+* symbol or a name spelled differently is.
+**/
+function sameScalar(onchain, offchain) {
+	if (typeof onchain === "string" && typeof offchain === "string" && ADDRESS.test(onchain) && ADDRESS.test(offchain)) return onchain.toLowerCase() === offchain.toLowerCase();
+	return onchain === offchain;
+}
+function scalarKind(path, onchain) {
+	if (path.endsWith("valueUsd")) return "usd";
+	return typeof onchain === "number" || typeof onchain === "bigint" ? "numeric" : "other";
+}
+function summarize(onchain, offchain, onlyOnchain, onlyOffchain, matched) {
+	const byChain = union(onchain.map((row) => String(row.chainId)), offchain.map((row) => String(row.chainId))).map((chainId) => ({
+		chainId: Number(chainId),
+		...count(onchain.filter((row) => String(row.chainId) === chainId), offchain.filter((row) => String(row.chainId) === chainId), onlyOnchain.filter((ref) => String(ref.chainId) === chainId), onlyOffchain.filter((ref) => String(ref.chainId) === chainId), matched.filter((match) => String(match.chainId) === chainId))
+	})).sort((a, b) => a.chainId - b.chainId);
+	return {
+		...count(onchain, offchain, onlyOnchain, onlyOffchain, matched),
+		byChain,
+		diffsByPath: countPaths(matched)
+	};
+}
+function count(onchain, offchain, onlyOnchain, onlyOffchain, matched) {
+	const identical = matched.filter((match) => match.identical).length;
+	return {
+		onchainRows: onchain.length,
+		offchainRows: offchain.length,
+		matched: matched.length,
+		identical,
+		differing: matched.length - identical,
+		onlyOnchain: onlyOnchain.length,
+		onlyOffchain: onlyOffchain.length
+	};
+}
+/**
+* How often each field differed, with array keys collapsed so that the same
+* field of a hundred collateral tokens counts as one path.
+**/
+function countPaths(matched) {
+	const counts = /* @__PURE__ */ new Map();
+	for (const match of matched) for (const diff of match.diffs) {
+		const path = diff.path.replace(/\[[^\]]*\]/g, "[]");
+		const entry = counts.get(path) ?? {
+			path,
+			kinds: [],
+			count: 0
+		};
+		entry.count += 1;
+		if (!entry.kinds.includes(diff.kind)) entry.kinds.push(diff.kind);
+		counts.set(path, entry);
+	}
+	return [...counts.values()].sort((a, b) => b.count - a.count || a.path.localeCompare(b.path));
+}
+function isAbsent(value) {
+	return value === void 0 || value === null;
+}
+function isRecord(value) {
+	return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function union(left, right) {
+	return [.../* @__PURE__ */ new Set([...left, ...right])];
+}
+function join(path, key) {
+	return path ? `${path}.${key}` : key;
+}
+//#endregion
+export { compareOpportunities, diffOpportunity };

package/dist/esm/sdk/accounts/credit-account-compressor/CreditAccountCompressor.js

@@ -9,7 +9,7 @@ import { hexEq } from "../../utils/hex.js";
 import "../../utils/index.js";
 import { SDKConstruct } from "../../base/SDKConstruct.js";
 import "../../base/index.js";
-import { borrowApyBps, healthFactorBps, positionLeverage, usdToNumber } from "../../market/math.js";
+import { calcBorrowApy, calcPositionLeverage, healthFactorBps, usdToNumber } from "../../market/math.js";
 import { dominantCollateral } from "../../market/credit/dominantCollateral.js";
 import { simulateWithPriceUpdates } from "../../utils/viem/simulateWithPriceUpdates.js";
 import "../../utils/viem/index.js";
@@ -208,8 +208,8 @@ var CreditAccountCompressor = class extends SDKConstruct {
 			creditAccount: ca.creditAccount,
 			name: collateral ? suite.strategyName(collateral) : token.symbol,
 			targetCollateral: collateral ? this.sdk.tokensMeta.mustGetToken(collateral) : null,
-			leverage: positionLeverage(totalDebtValue, ca.totalValue),
-			borrowApy: borrowApyBps(pool.baseInterestRate, suite.creditManager.feeInterest),
+			leverage: calcPositionLeverage(ca.totalValue, totalDebtValue),
+			borrowApy: calcBorrowApy(pool.baseInterestRate, suite.creditManager.feeInterest),
 			totalDebt: {
 				token,
 				value: totalDebtValue,

package/dist/esm/sdk/index.js

@@ -49,9 +49,10 @@ import { createAdapter } from "./market/adapters/createAdapter.js";
 import { CreditConfiguratorV310Contract } from "./market/credit/CreditConfiguratorV310Contract.js";
 import { CreditFacadeV310BaseContract, creditFacadeV310Abi as abi } from "./market/credit/CreditFacadeV310BaseContract.js";
 import { CreditFacadeV310Contract } from "./market/credit/CreditFacadeV310Contract.js";
-import { PARTIAL_LIQUIDATION_BUFFER_BPS, additionalBorrowApyBps, borrowApyBps, healthFactorBps, maxLeverage, minSeizedAmount, optimalHFForPartialLiquidation, optimalRepaidAmount, positionLeverage, rayToBps, usdToNumber, utilizationBps } from "./market/math.js";
+import { MAX_LEVERAGE_BUFFER_BPS, PARTIAL_LIQUIDATION_BUFFER_BPS, calcAdditionalBorrowApy, calcBorrowApy, calcMaxLeverage, calcPositionLeverage, calcUtilization, healthFactorBps, minSeizedAmount, optimalHFForPartialLiquidation, optimalRepaidAmount, rayToBps, usdToNumber } from "./market/math.js";
 import { CreditManagerV310Contract } from "./market/credit/CreditManagerV310Contract.js";
 import { dominantCollateral, mustGetDominantCollateral } from "./market/credit/dominantCollateral.js";
+import { NON_STRATEGY_PHANTOM_TOKEN_TYPES, isStrategyCollateral } from "./market/credit/isStrategyCollateral.js";
 import { CreditSuite } from "./market/credit/CreditSuite.js";
 import { expectedBalanceDeltas } from "./market/credit/expectedBalanceDeltas.js";
 import { simulateMulticall } from "./utils/viem/simulateMulticall.js";
@@ -148,4 +149,4 @@ import { OnchainSDK, STATE_VERSION } from "./OnchainSDK.js";
 import { MultichainSDK } from "./MultichainSDK.js";
 import { attachOptionsSchema, onchainSDKOptionsSchema } from "./options.js";
 import "./types/index.js";
-export { ADDRESS_0X0, ADDRESS_PROVIDER_V310, AP_ACCOUNT_FACTORY, AP_ACL, AP_BOT_LIST, AP_BYTECODE_REPOSITORY, AP_CONTRACTS_REGISTER, AP_CONTROLLER_TIMELOCK, AP_CREDIT_ACCOUNT_COMPRESSOR, AP_CREDIT_SUITE_COMPRESSOR, AP_DATA_COMPRESSOR, AP_DELEVERAGE_BOT_HV, AP_DELEVERAGE_BOT_LV, AP_DELEVERAGE_BOT_PEGGED, AP_GAUGE_COMPRESSOR, AP_GEAR_STAKING, AP_GEAR_TOKEN, AP_INFLATION_ATTACK_BLOCKER, AP_INSOLVENCY_CHECKER, AP_MARKET_COMPRESSOR, AP_MARKET_CONFIGURATOR, AP_PARTIAL_LIQUIDATION_BOT, AP_PERIPHERY_COMPRESSOR, AP_PRICE_FEED_COMPRESSOR, AP_PRICE_FEED_STORE, AP_PRICE_ORACLE, AP_REDEMPTION_LOGGER, AP_REWARDS_COMPRESSOR, AP_ROUTER, AP_RWA_COMPRESSOR, AP_TOKEN_COMPRESSOR, AP_TREASURY, AP_WETH_GATEWAY, AP_WETH_TOKEN, AP_ZAPPER_REGISTER, AP_ZERO_PRICE_FEED, AbstractLPPriceFeedContract, AbstractPriceFeedContract, AbstractWithdrawalCompressorContract, AccountBotsService, AddressMap, AddressProviderV310Contract, AddressSet, AssetsMap, BLOCKS_PER_WEEK_BY_NETWORK, BalancerStablePriceFeedContract, BalancerWeightedPriceFeedContract, BaseContract, BasePlugin, BigIntMath, BotPermissions, BoundedPriceFeedContract, ChainContractsRegister, ChainNotConfiguredError, CompositePriceFeedContract, Construct, ContractParseError, CreditAccountCompressor, CreditAccountCompressorV310Contract, CreditAccountOperationsService, CreditAccountsServiceV310, CreditConfiguratorV310Contract, CreditFacadeV310BaseContract, CreditFacadeV310Contract, CreditManagerV310Contract, CreditSuite, CurveCryptoPriceFeedContract, CurveStablePriceFeedContract, CurveUSDPriceFeedContract, DELAYED_INTENT_TYPES, DELAYED_INTENT_VERSION, DUST_THRESHOLD, Erc4626PriceFeedContract, ExternalPriceFeedContract, GaugeContract, IERC20ZapperContract, IETHZapperContract, InvalidDelayedIntentError, LEVERAGE_DECIMALS, LIQUIDATION_APPROVAL_BUFFER, LIQUIDATION_COMPRESSOR_V313_ADDRESS, LinearInterestRateModelContract, LiquidationsService, MAX_INT, MAX_UINT16, MAX_UINT256, MIN_INT96, MULTICALL_ADDRESS, MarketRegister, MarketSuite, MellowLRTPriceFeedContract, MidasLiquidatorContract, MissingSerializedParamsError, MultichainConstruct, MultichainLiquidationsService, MultichainOpportunitiesService, MultichainPositionsService, MultichainSDK, NATIVE_ADDRESS, NOT_DEPLOYED, NO_VERSION, NetworkType, OnchainSDK, OpportunitiesService, PARTIAL_LIQUIDATION_BUFFER_BPS, PERCENTAGE_DECIMALS, PERCENTAGE_FACTOR, PERCENTAGE_FACTOR_1KK, PERIPHERY_CONTRACTS, PHANTOM_TOKEN_CONTRACT_TYPES, PHANTOM_TOKEN_MIDAS_REDEMPTION, PHANTOM_TOKEN_SECURITIZE_REDEMPTION, PRICE_DECIMALS, PRICE_DECIMALS_POW, PartialPriceFeedInitError, PendleTWAPPTPriceFeed, PeripheryCompressorV310Contract, PlaceholderAdapterContract, PlaceholderContract, PluginStateVersionError, PoolService, PoolSuite, PoolV310Contract, PositionsService, PriceFeedRef, PriceFeedRegister, PriceOracleV310Contract, PythPriceFeed, RAMP_DURATION_BY_NETWORK, RAY, RAY_DECIMALS_POW, RWARegistry, RWA_FACTORY_SECURITIZE, RWA_FACTORY_TYPES, RWA_LIQUIDATOR_MIDAS, RWA_LIQUIDATOR_SECURITIZE, RWA_ON_DEMAND_LP_MONOPOLIZED, RWA_UNDERLYING_DEFAULT, RWA_UNDERLYING_ON_DEMAND, RedemptionLoggerV310Contract, RedstonePriceFeedContract, RouterV310Contract, SDKConstruct, SECONDS_PER_YEAR, SECURITIZE_REGISTER_VAULT_TYPES, SLIPPAGE_DECIMALS, STATE_VERSION, SUPPORTED_NETWORKS, SdkAlreadyAttachedError, SdkChainMismatchError, SdkMissingChainStateError, SdkNotAttachedError, SdkStateVersionMismatchError, SdkSyncFailedError, SecuritizeLiquidatorContract, SecuritizeRWAFactory, SimulateWithPriceUpdatesError, SimulationError, TokensMeta, TypedObjectUtils, UnsupportedZapperFunctionError, VERSION_RANGE_310, VotingContractStatus, WAD, WAD_DECIMALS_POW, WithdrawalCompressorV310Contract, WithdrawalCompressorV311Contract, WithdrawalCompressorV313Contract, WstETHPriceFeedContract, YearnPriceFeedContract, ZapperContract, ZeroPriceFeedContract, ZodAddress, ZodBigInt, ZodHex, additionalBorrowApyBps, assetsMap, attachOptionsSchema, borrowApyBps, botPermissionsToString, bytes32ToString, chains, childLogger, createAdapter, createAddressProvider, createPriceOracle, createRawTx, createRedemptionLogger, createRouter, createWithdrawalCompressor, createZapper, abi as creditFacadeV310Abi, decodeDelayedIntent, detectNetwork, dominantCollateral, encodeDelayedIntent, estimateRawTxGas, etherscanApiUrl, etherscanUrl, executeDelegatedMulticalls, executeMulticallBatches, expectedBalanceDeltas, fetchRedstonePayloads, filterDust, filterDustUSD, findCuratorMarketConfigurator, fmtBinaryMask, formatBN, formatBNvalue, formatDuration, formatLeverage, formatNumberToString_, formatPercentage, formatTimestamp, functionArgsToMap, functionArgsToRecord, generateCastTraceCall, getAssetType, getCastTraceArgs, getChain, getCuratorName, getFunctionSignature, getNetworkType, getRawPriceUpdates, getSimulateWithPriceUpdatesError, getWithdrawalCompressorAddress, halfRAY, healthFactorBps, hexEq, hydrateAddressProvider, iCreditAccountAbi, isDust, isLPPriceFeed, isPublicNetwork, isRWAFactory, isRWAToken, isSunsetPool, isSunsetStrategy, isSupportedNetwork, isUpdatablePriceFeed, isV310, isVersionRange, json_parse, json_stringify, maxLeverage, minSeizedAmount, mustGetDominantCollateral, numberWithCommas, onchainSDKOptionsSchema, optimalHFForPartialLiquidation, optimalRepaidAmount, percentFmt, positionLeverage, primaryInstantOutput, rayToBps, rayToNumber, retry, sendRawTx, shortAddress, shortHash, simulateCall, simulateMulticall, simulateWithPriceUpdates, toAddress, toBN, toBigInt, toChainIds, toClaimableWithdrawal, toPendingWithdrawal, toRequestableWithdrawal, toSignificant, toWithdrawalStatus, usdToNumber, utilizationBps, watchBlocksAsync };
+export { ADDRESS_0X0, ADDRESS_PROVIDER_V310, AP_ACCOUNT_FACTORY, AP_ACL, AP_BOT_LIST, AP_BYTECODE_REPOSITORY, AP_CONTRACTS_REGISTER, AP_CONTROLLER_TIMELOCK, AP_CREDIT_ACCOUNT_COMPRESSOR, AP_CREDIT_SUITE_COMPRESSOR, AP_DATA_COMPRESSOR, AP_DELEVERAGE_BOT_HV, AP_DELEVERAGE_BOT_LV, AP_DELEVERAGE_BOT_PEGGED, AP_GAUGE_COMPRESSOR, AP_GEAR_STAKING, AP_GEAR_TOKEN, AP_INFLATION_ATTACK_BLOCKER, AP_INSOLVENCY_CHECKER, AP_MARKET_COMPRESSOR, AP_MARKET_CONFIGURATOR, AP_PARTIAL_LIQUIDATION_BOT, AP_PERIPHERY_COMPRESSOR, AP_PRICE_FEED_COMPRESSOR, AP_PRICE_FEED_STORE, AP_PRICE_ORACLE, AP_REDEMPTION_LOGGER, AP_REWARDS_COMPRESSOR, AP_ROUTER, AP_RWA_COMPRESSOR, AP_TOKEN_COMPRESSOR, AP_TREASURY, AP_WETH_GATEWAY, AP_WETH_TOKEN, AP_ZAPPER_REGISTER, AP_ZERO_PRICE_FEED, AbstractLPPriceFeedContract, AbstractPriceFeedContract, AbstractWithdrawalCompressorContract, AccountBotsService, AddressMap, AddressProviderV310Contract, AddressSet, AssetsMap, BLOCKS_PER_WEEK_BY_NETWORK, BalancerStablePriceFeedContract, BalancerWeightedPriceFeedContract, BaseContract, BasePlugin, BigIntMath, BotPermissions, BoundedPriceFeedContract, ChainContractsRegister, ChainNotConfiguredError, CompositePriceFeedContract, Construct, ContractParseError, CreditAccountCompressor, CreditAccountCompressorV310Contract, CreditAccountOperationsService, CreditAccountsServiceV310, CreditConfiguratorV310Contract, CreditFacadeV310BaseContract, CreditFacadeV310Contract, CreditManagerV310Contract, CreditSuite, CurveCryptoPriceFeedContract, CurveStablePriceFeedContract, CurveUSDPriceFeedContract, DELAYED_INTENT_TYPES, DELAYED_INTENT_VERSION, DUST_THRESHOLD, Erc4626PriceFeedContract, ExternalPriceFeedContract, GaugeContract, IERC20ZapperContract, IETHZapperContract, InvalidDelayedIntentError, LEVERAGE_DECIMALS, LIQUIDATION_APPROVAL_BUFFER, LIQUIDATION_COMPRESSOR_V313_ADDRESS, LinearInterestRateModelContract, LiquidationsService, MAX_INT, MAX_LEVERAGE_BUFFER_BPS, MAX_UINT16, MAX_UINT256, MIN_INT96, MULTICALL_ADDRESS, MarketRegister, MarketSuite, MellowLRTPriceFeedContract, MidasLiquidatorContract, MissingSerializedParamsError, MultichainConstruct, MultichainLiquidationsService, MultichainOpportunitiesService, MultichainPositionsService, MultichainSDK, NATIVE_ADDRESS, NON_STRATEGY_PHANTOM_TOKEN_TYPES, NOT_DEPLOYED, NO_VERSION, NetworkType, OnchainSDK, OpportunitiesService, PARTIAL_LIQUIDATION_BUFFER_BPS, PERCENTAGE_DECIMALS, PERCENTAGE_FACTOR, PERCENTAGE_FACTOR_1KK, PERIPHERY_CONTRACTS, PHANTOM_TOKEN_CONTRACT_TYPES, PHANTOM_TOKEN_MIDAS_REDEMPTION, PHANTOM_TOKEN_SECURITIZE_REDEMPTION, PRICE_DECIMALS, PRICE_DECIMALS_POW, PartialPriceFeedInitError, PendleTWAPPTPriceFeed, PeripheryCompressorV310Contract, PlaceholderAdapterContract, PlaceholderContract, PluginStateVersionError, PoolService, PoolSuite, PoolV310Contract, PositionsService, PriceFeedRef, PriceFeedRegister, PriceOracleV310Contract, PythPriceFeed, RAMP_DURATION_BY_NETWORK, RAY, RAY_DECIMALS_POW, RWARegistry, RWA_FACTORY_SECURITIZE, RWA_FACTORY_TYPES, RWA_LIQUIDATOR_MIDAS, RWA_LIQUIDATOR_SECURITIZE, RWA_ON_DEMAND_LP_MONOPOLIZED, RWA_UNDERLYING_DEFAULT, RWA_UNDERLYING_ON_DEMAND, RedemptionLoggerV310Contract, RedstonePriceFeedContract, RouterV310Contract, SDKConstruct, SECONDS_PER_YEAR, SECURITIZE_REGISTER_VAULT_TYPES, SLIPPAGE_DECIMALS, STATE_VERSION, SUPPORTED_NETWORKS, SdkAlreadyAttachedError, SdkChainMismatchError, SdkMissingChainStateError, SdkNotAttachedError, SdkStateVersionMismatchError, SdkSyncFailedError, SecuritizeLiquidatorContract, SecuritizeRWAFactory, SimulateWithPriceUpdatesError, SimulationError, TokensMeta, TypedObjectUtils, UnsupportedZapperFunctionError, VERSION_RANGE_310, VotingContractStatus, WAD, WAD_DECIMALS_POW, WithdrawalCompressorV310Contract, WithdrawalCompressorV311Contract, WithdrawalCompressorV313Contract, WstETHPriceFeedContract, YearnPriceFeedContract, ZapperContract, ZeroPriceFeedContract, ZodAddress, ZodBigInt, ZodHex, assetsMap, attachOptionsSchema, botPermissionsToString, bytes32ToString, calcAdditionalBorrowApy, calcBorrowApy, calcMaxLeverage, calcPositionLeverage, calcUtilization, chains, childLogger, createAdapter, createAddressProvider, createPriceOracle, createRawTx, createRedemptionLogger, createRouter, createWithdrawalCompressor, createZapper, abi as creditFacadeV310Abi, decodeDelayedIntent, detectNetwork, dominantCollateral, encodeDelayedIntent, estimateRawTxGas, etherscanApiUrl, etherscanUrl, executeDelegatedMulticalls, executeMulticallBatches, expectedBalanceDeltas, fetchRedstonePayloads, filterDust, filterDustUSD, findCuratorMarketConfigurator, fmtBinaryMask, formatBN, formatBNvalue, formatDuration, formatLeverage, formatNumberToString_, formatPercentage, formatTimestamp, functionArgsToMap, functionArgsToRecord, generateCastTraceCall, getAssetType, getCastTraceArgs, getChain, getCuratorName, getFunctionSignature, getNetworkType, getRawPriceUpdates, getSimulateWithPriceUpdatesError, getWithdrawalCompressorAddress, halfRAY, healthFactorBps, hexEq, hydrateAddressProvider, iCreditAccountAbi, isDust, isLPPriceFeed, isPublicNetwork, isRWAFactory, isRWAToken, isStrategyCollateral, isSunsetPool, isSunsetStrategy, isSupportedNetwork, isUpdatablePriceFeed, isV310, isVersionRange, json_parse, json_stringify, minSeizedAmount, mustGetDominantCollateral, numberWithCommas, onchainSDKOptionsSchema, optimalHFForPartialLiquidation, optimalRepaidAmount, percentFmt, primaryInstantOutput, rayToBps, rayToNumber, retry, sendRawTx, shortAddress, shortHash, simulateCall, simulateMulticall, simulateWithPriceUpdates, toAddress, toBN, toBigInt, toChainIds, toClaimableWithdrawal, toPendingWithdrawal, toRequestableWithdrawal, toSignificant, toWithdrawalStatus, usdToNumber, watchBlocksAsync };

package/dist/esm/sdk/market/credit/CreditManagerV310Contract.js

@@ -8,8 +8,7 @@ import { BaseContract } from "../../base/BaseContract.js";
 import "../../base/index.js";
 import { createAdapter } from "../adapters/createAdapter.js";
 import "../adapters/index.js";
-import { maxLeverage } from "../math.js";
-import { isAddressEqual } from "viem";
+import { calcMaxLeverage } from "../math.js";
 //#region src/sdk/market/credit/CreditManagerV310Contract.ts
 const abi = iCreditManagerV310Abi;
 var CreditManagerV310Contract = class extends BaseContract {
@@ -64,20 +63,10 @@ var CreditManagerV310Contract = class extends BaseContract {
 		return this.liquidationThresholds.keys();
 	}
 	/**
-	* {@inheritDoc ICreditManagerContract.leverageableCollaterals}
-	*/
-	get leverageableCollaterals() {
-		return this.collateralTokens.filter((token) => {
-			if (isAddressEqual(token, this.underlying)) return false;
-			const lt = this.liquidationThresholds.get(token);
-			return !!lt && lt > 0 && lt < Number(10000n);
-		});
-	}
-	/**
 	* {@inheritDoc ICreditManagerContract.maxLeverage}
 	*/
 	maxLeverage(collateral) {
-		return maxLeverage(this.liquidationThresholds.mustGet(collateral));
+		return calcMaxLeverage(this.liquidationThresholds.mustGet(collateral));
 	}
 	/**
 	* {@inheritDoc ICreditManagerContract.liquidationPremium}

package/dist/esm/sdk/market/credit/CreditSuite.js

@@ -6,12 +6,12 @@ import "../../constants/index.js";
 import "../../utils/index.js";
 import { SDKConstruct } from "../../base/SDKConstruct.js";
 import "../../base/index.js";
-import { additionalBorrowApyBps, borrowApyBps, minSeizedAmount, optimalHFForPartialLiquidation, optimalRepaidAmount } from "../math.js";
+import { calcAdditionalBorrowApy, calcBorrowApy, minSeizedAmount, optimalHFForPartialLiquidation, optimalRepaidAmount } from "../math.js";
 import createCreditConfigurator from "./createCreditConfigurator.js";
 import createCreditFacade from "./createCreditFacade.js";
 import createCreditManager from "./createCreditManager.js";
 import { mustGetDominantCollateral } from "./dominantCollateral.js";
-import { isAddressEqual } from "viem";
+import { isStrategyCollateral } from "./isStrategyCollateral.js";
 //#region src/sdk/market/credit/CreditSuite.ts
 /**
 * SDK aggregate for one credit-manager branch inside a market.
@@ -171,22 +171,8 @@ var CreditSuite = class extends SDKConstruct {
 		return this.creditFacade.isPaused || this.market.pool.isPaused;
 	}
 	/**
-	* Collateral tokens a leveraged position can be built around in this suite:
-	* the ones the credit manager can lever up, narrowed to the tokens that can
-	* still be entered. A token qualifies when it
-	*
-	* - has a liquidation threshold above `0` and below `100%`, and is not the
-	*   suite's underlying, see
-	*   {@link ICreditManagerContract.leverageableCollaterals};
-	* - is not the token the market's underlying wraps, which for an RWA market
-	*   is the same exposure as the underlying itself;
-	* - is not a phantom token, which only ever appears as the intermediate step
-	*   of a withdrawal and cannot be acquired;
-	* - is not an expired token, e.g. a matured Pendle PT;
-	* - has a non-zero main price in the market's oracle — a zero or failed
-	*   answer (e.g. a zero price feed) means the position cannot be valued;
-	* - the market still accepts quota for, see
-	*   {@link PoolQuotaKeeperContract.hasActiveQuota}.
+	* Collateral tokens a leveraged position can be built around in this suite,
+	* see {@link isStrategyCollateral} for the per-token criteria.
 	*
 	* A suite where no debt can be drawn at all ({@link maxBorrowAmount} is `0`,
 	* e.g. its debt limit is exhausted or zeroed out) offers no strategies,
@@ -196,14 +182,19 @@ var CreditSuite = class extends SDKConstruct {
 		if (this.maxBorrowAmount === 0n) return [];
 		const { pqk, unwrappedUnderlying } = this.market.pool;
 		const { mainPrices } = this.market.priceOracle;
-		const { tokensMeta } = this;
-		return this.creditManager.leverageableCollaterals.filter((token) => {
-			if (isAddressEqual(token, unwrappedUnderlying)) return false;
+		const { tokensMeta, creditManager } = this;
+		return creditManager.collateralTokens.filter((token) => {
 			const meta = tokensMeta.mustGet(token);
-			if (tokensMeta.isPhantomToken(meta) || meta.isExpired) return false;
-			const mainPrice = mainPrices.get(token);
-			if (!mainPrice?.success || mainPrice.price === 0n) return false;
-			return pqk.hasActiveQuota(token);
+			return isStrategyCollateral({
+				token,
+				underlying: creditManager.underlying,
+				unwrappedUnderlying,
+				liquidationThreshold: creditManager.liquidationThresholds.mustGet(token),
+				contractType: meta.contractType,
+				isExpired: meta.isExpired,
+				mainPrice: mainPrices.get(token)?.price,
+				hasActiveQuota: pqk.hasActiveQuota(token)
+			});
 		});
 	}
 	/**
@@ -248,7 +239,7 @@ var CreditSuite = class extends SDKConstruct {
 			curator: market.curator,
 			underlyingToken: market.underlyingToken,
 			totalBorrow: oracle.toAmount(pool.underlying, borrowed),
-			collateralTokens: market.collateralTokens,
+			collateralTokens: this.strategyCollaterals.map((t) => this.tokensMeta.mustGetToken(t)),
 			paused: this.isPaused,
 			rwa: market.rwa,
 			sunset: market.sunset || isSunsetStrategy(cm.address, collateral, this.sdk.networkType),
@@ -256,8 +247,8 @@ var CreditSuite = class extends SDKConstruct {
 			liquidationPremium: cm.liquidationPremium,
 			liquidationFee: cm.feeLiquidation,
 			expirationDate: this.expirationDate,
-			borrowApy: borrowApyBps(pool.baseInterestRate, cm.feeInterest),
-			additionalBorrowApy: additionalBorrowApyBps(market.pool.pqk.quotaRate(collateral), maxLeverage),
+			borrowApy: calcBorrowApy(pool.baseInterestRate, cm.feeInterest),
+			additionalBorrowApy: calcAdditionalBorrowApy(market.pool.pqk.quotaRate(collateral), cm.feeInterest, maxLeverage),
 			maxBorrowAmount: oracle.toAmount(pool.underlying, this.maxBorrowAmount),
 			maxLeverage
 		};

package/dist/esm/sdk/market/credit/index.js

@@ -3,7 +3,8 @@ import { CreditFacadeV310BaseContract, creditFacadeV310Abi as abi } from "./Cred
 import { CreditFacadeV310Contract } from "./CreditFacadeV310Contract.js";
 import { CreditManagerV310Contract } from "./CreditManagerV310Contract.js";
 import { dominantCollateral, mustGetDominantCollateral } from "./dominantCollateral.js";
+import { NON_STRATEGY_PHANTOM_TOKEN_TYPES, isStrategyCollateral } from "./isStrategyCollateral.js";
 import { CreditSuite } from "./CreditSuite.js";
 import { expectedBalanceDeltas } from "./expectedBalanceDeltas.js";
 import "./types.js";
-export { CreditConfiguratorV310Contract, CreditFacadeV310BaseContract, CreditFacadeV310Contract, CreditManagerV310Contract, CreditSuite, abi as creditFacadeV310Abi, dominantCollateral, expectedBalanceDeltas, mustGetDominantCollateral };
+export { CreditConfiguratorV310Contract, CreditFacadeV310BaseContract, CreditFacadeV310Contract, CreditManagerV310Contract, CreditSuite, NON_STRATEGY_PHANTOM_TOKEN_TYPES, abi as creditFacadeV310Abi, dominantCollateral, expectedBalanceDeltas, isStrategyCollateral, mustGetDominantCollateral };