@gearbox-protocol/sdk 17.5.0 → 17.6.1

package/dist/cjs/model/charts.js

@@ -41,6 +41,7 @@ const POOL_OPPORTUNITY_CHART_METRICS = [
 /**
 * Every metric a strategy opportunity can chart.
 *
+* `quotaRateAvg7d` is the trailing seven-day average quota rate.
 * `collateralPrice` is the collateral/underlying series a liquidation-price
 * chart draws; the two USD series are the same prices quoted in dollars.
 **/
@@ -49,6 +50,7 @@ const STRATEGY_OPPORTUNITY_CHART_METRICS = [
 	"borrowApyAvg7d",
 	"rewardsApyAvg7d",
 	"quotaRate",
+	"quotaRateAvg7d",
 	"liquidationThreshold",
 	"collateralApy",
 	"tvl",
@@ -114,6 +116,7 @@ const CHART_METRIC_UNITS = {
 	borrowApy: "bps",
 	borrowApyAvg7d: "bps",
 	quotaRate: "bps",
+	quotaRateAvg7d: "bps",
 	liquidationThreshold: "bps",
 	collateralApy: "bps",
 	supplied: "token",

package/dist/cjs/onchain/accounts/intents/borrow.js

@@ -55,7 +55,7 @@ async function buildBorrowState(props) {
 		totalDebt: market.toUnderlyingAmount(debt),
 		netValue: market.toUnderlyingAmount(margin - debt)
 	});
-	require_onchain_accounts_intents_math.assertDebtLimits(sdk, debt, suite.creditFacade, underlying);
+	require_onchain_accounts_intents_math.assertDebtLimits(sdk, debt, suite.creditFacade, underlying, suite.maxBorrowAmount());
 	require_onchain_accounts_intents_guards.assertCanBorrow(sdk, suite, debt);
 	const account = existing ?? require_onchain_accounts_intents_utils_credit_account_slice.unopenedAccountSlice({
 		creditManager,

package/dist/cjs/onchain/accounts/intents/math.js

@@ -56,13 +56,14 @@ function assertLeverageAtLeastOne(leverage) {
 * Rejects a debt the facade would revert on: zero is always fine (no loan at
 * all), anything else has to sit inside `[minDebt, maxDebt]`.
 */
-function assertDebtLimits(sdk, debt, debtLimits, underlying) {
+function assertDebtLimits(sdk, debt, debtLimits, underlying, maxBorrowAmount) {
 	require_onchain_validation_raise.raise(require_onchain_validation_checks_checkDebtLimits.checkDebtLimits({
 		debt,
 		minDebt: debtLimits.minDebt,
 		maxDebt: debtLimits.maxDebt,
 		underlying: require_onchain_validation_helpers_token.toToken(sdk, underlying),
-		allowZero: true
+		allowZero: true,
+		maxBorrowAmount
 	}), debt > debtLimits.maxDebt ? `debt ${debt} exceeds maxDebt ${debtLimits.maxDebt}` : `debt ${debt} is below minDebt ${debtLimits.minDebt}`);
 }
 //#endregion

package/dist/cjs/onchain/accounts/intents/open-strategy.js

@@ -45,7 +45,7 @@ async function buildOpenStrategyState(props) {
 		creditFacade: suite.creditFacade.address,
 		underlying
 	});
-	require_onchain_accounts_intents_math.assertDebtLimits(sdk, debt, suite.creditFacade, underlying);
+	require_onchain_accounts_intents_math.assertDebtLimits(sdk, debt, suite.creditFacade, underlying, suite.maxBorrowAmount());
 	require_onchain_accounts_intents_guards.assertCanBorrow(sdk, suite, debt);
 	const paths = require_onchain_accounts_intents_utils_router_path.createRouterPaths({
 		sdk,

package/dist/cjs/onchain/accounts/intents/plan.js

@@ -43,7 +43,7 @@ function planDeposit(intent, view) {
 	const aU = view.price(intent.token, U, intent.amount);
 	const debtDelta = intent.targetLeverage === void 0 ? require_onchain_accounts_intents_math.proportionalDebt(view, aU) : require_onchain_accounts_intents_math.debtForLeverage(view.collateral + aU, intent.targetLeverage) - view.debt;
 	if (debtDelta < 0n) throw new require_onchain_validation_raise.IntentPreviewError(require_model_errors_operation_errors.leverageOutOfRange(), `deposit: target leverage ${intent.targetLeverage} would require repaying debt`);
-	require_onchain_accounts_intents_math.assertDebtLimits(view.sdk, view.debt + debtDelta, view.debtLimits, U);
+	require_onchain_accounts_intents_math.assertDebtLimits(view.sdk, view.debt + debtDelta, view.debtLimits, U, view.maxBorrowAmount);
 	const T = intent.positionToken ?? positionToken(view, "deposit");
 	const depositStays = require_onchain_accounts_intents_utils_common.eq(intent.token, T);
 	return [
@@ -74,11 +74,12 @@ function planRepay(intent, view) {
 	if (view.debt <= 0n) throw new require_onchain_validation_raise.IntentPreviewError(require_model_errors_operation_errors.debtOutOfRange({
 		requested: require_onchain_validation_helpers_token.toTokenAmount(view.sdk, U, view.debt),
 		minDebt: require_onchain_validation_helpers_token.toTokenAmount(view.sdk, U, view.debtLimits.minDebt),
-		maxDebt: require_onchain_validation_helpers_token.toTokenAmount(view.sdk, U, view.debtLimits.maxDebt)
+		maxDebt: require_onchain_validation_helpers_token.toTokenAmount(view.sdk, U, view.debtLimits.maxDebt),
+		maxBorrowAmount: view.maxBorrowAmount
 	}), "repay: the account owes nothing");
 	const funding = everything(intent.amount) ? view.price(U, intent.token, withMargin(view.debt)) : intent.amount;
 	const repaid = min(view.price(intent.token, U, funding), view.debt);
-	require_onchain_accounts_intents_math.assertDebtLimits(view.sdk, view.debt - repaid, view.debtLimits, view.underlying);
+	require_onchain_accounts_intents_math.assertDebtLimits(view.sdk, view.debt - repaid, view.debtLimits, view.underlying, view.maxBorrowAmount);
 	return [
 		add(intent.token, funding, intent.value),
 		...fundsInU ? [] : [convert(intent.token, U, funding)],
@@ -307,7 +308,7 @@ function withdrawShape(intent, view) {
 		};
 	}
 	const dD = require_onchain_accounts_intents_math.proportionalDebt(view, WU);
-	require_onchain_accounts_intents_math.assertDebtLimits(view.sdk, view.debt - dD, view.debtLimits, view.underlying);
+	require_onchain_accounts_intents_math.assertDebtLimits(view.sdk, view.debt - dD, view.debtLimits, view.underlying, view.maxBorrowAmount);
 	return {
 		U,
 		T,
@@ -326,7 +327,7 @@ function leverageShape(intent, view) {
 	require_onchain_accounts_intents_math.assertLeverageAtLeastOne(intent.targetLeverage);
 	if (view.collateral <= 0n) throw new require_onchain_validation_raise.IntentPreviewError(require_model_errors_operation_errors.insufficientBalance(), "adjustLeverage: account has no collateral to lever");
 	const target = require_onchain_accounts_intents_math.debtForLeverage(view.collateral, intent.targetLeverage);
-	require_onchain_accounts_intents_math.assertDebtLimits(view.sdk, target, view.debtLimits, view.underlying);
+	require_onchain_accounts_intents_math.assertDebtLimits(view.sdk, target, view.debtLimits, view.underlying, view.maxBorrowAmount);
 	return {
 		U: view.underlying,
 		delta: target - view.debt

package/dist/cjs/onchain/accounts/intents/view.js

@@ -13,7 +13,7 @@ function accountView(creditAccount, sdk) {
 	const { underlying, creditManager } = creditAccount;
 	const oracle = sdk.marketRegister.findByCreditManager(creditManager).priceOracle;
 	const price = (from, to, amount) => oracle.safeConvert(from, to, amount).value;
-	const { creditFacade } = sdk.marketRegister.findCreditManager(creditManager);
+	const creditSuite = sdk.marketRegister.findCreditManager(creditManager);
 	let totalValue = 0n;
 	for (const t of creditAccount.tokens) totalValue += price(t.token, underlying, t.balance);
 	return {
@@ -23,9 +23,10 @@ function accountView(creditAccount, sdk) {
 		debt: creditAccount.totalDebt,
 		collateral: totalValue - creditAccount.totalDebt,
 		debtLimits: {
-			minDebt: creditFacade.minDebt,
-			maxDebt: creditFacade.maxDebt
+			minDebt: creditSuite.creditFacade.minDebt,
+			maxDebt: creditSuite.creditFacade.maxDebt
 		},
+		maxBorrowAmount: creditSuite.maxBorrowAmount(),
 		balanceOf: (token) => creditAccount.tokens.find((t) => require_onchain_accounts_intents_utils_common.eq(t.token, token))?.balance ?? 0n,
 		price,
 		fattest: (exclude) => require_onchain_accounts_intents_utils_pick_token.pickFattestNonPhantomToken({

package/dist/esm/model/charts.js

@@ -40,6 +40,7 @@ const POOL_OPPORTUNITY_CHART_METRICS = [
 /**
 * Every metric a strategy opportunity can chart.
 *
+* `quotaRateAvg7d` is the trailing seven-day average quota rate.
 * `collateralPrice` is the collateral/underlying series a liquidation-price
 * chart draws; the two USD series are the same prices quoted in dollars.
 **/
@@ -48,6 +49,7 @@ const STRATEGY_OPPORTUNITY_CHART_METRICS = [
 	"borrowApyAvg7d",
 	"rewardsApyAvg7d",
 	"quotaRate",
+	"quotaRateAvg7d",
 	"liquidationThreshold",
 	"collateralApy",
 	"tvl",
@@ -113,6 +115,7 @@ const CHART_METRIC_UNITS = {
 	borrowApy: "bps",
 	borrowApyAvg7d: "bps",
 	quotaRate: "bps",
+	quotaRateAvg7d: "bps",
 	liquidationThreshold: "bps",
 	collateralApy: "bps",
 	supplied: "token",

package/dist/esm/onchain/accounts/intents/borrow.js

@@ -54,7 +54,7 @@ async function buildBorrowState(props) {
 		totalDebt: market.toUnderlyingAmount(debt),
 		netValue: market.toUnderlyingAmount(margin - debt)
 	});
-	assertDebtLimits(sdk, debt, suite.creditFacade, underlying);
+	assertDebtLimits(sdk, debt, suite.creditFacade, underlying, suite.maxBorrowAmount());
 	assertCanBorrow(sdk, suite, debt);
 	const account = existing ?? unopenedAccountSlice({
 		creditManager,

package/dist/esm/onchain/accounts/intents/math.js

@@ -55,13 +55,14 @@ function assertLeverageAtLeastOne(leverage) {
 * Rejects a debt the facade would revert on: zero is always fine (no loan at
 * all), anything else has to sit inside `[minDebt, maxDebt]`.
 */
-function assertDebtLimits(sdk, debt, debtLimits, underlying) {
+function assertDebtLimits(sdk, debt, debtLimits, underlying, maxBorrowAmount) {
 	raise(checkDebtLimits({
 		debt,
 		minDebt: debtLimits.minDebt,
 		maxDebt: debtLimits.maxDebt,
 		underlying: toToken(sdk, underlying),
-		allowZero: true
+		allowZero: true,
+		maxBorrowAmount
 	}), debt > debtLimits.maxDebt ? `debt ${debt} exceeds maxDebt ${debtLimits.maxDebt}` : `debt ${debt} is below minDebt ${debtLimits.minDebt}`);
 }
 //#endregion

package/dist/esm/onchain/accounts/intents/open-strategy.js

@@ -44,7 +44,7 @@ async function buildOpenStrategyState(props) {
 		creditFacade: suite.creditFacade.address,
 		underlying
 	});
-	assertDebtLimits(sdk, debt, suite.creditFacade, underlying);
+	assertDebtLimits(sdk, debt, suite.creditFacade, underlying, suite.maxBorrowAmount());
 	assertCanBorrow(sdk, suite, debt);
 	const paths = createRouterPaths({
 		sdk,

package/dist/esm/onchain/accounts/intents/plan.js

@@ -42,7 +42,7 @@ function planDeposit(intent, view) {
 	const aU = view.price(intent.token, U, intent.amount);
 	const debtDelta = intent.targetLeverage === void 0 ? proportionalDebt(view, aU) : debtForLeverage(view.collateral + aU, intent.targetLeverage) - view.debt;
 	if (debtDelta < 0n) throw new IntentPreviewError(leverageOutOfRange(), `deposit: target leverage ${intent.targetLeverage} would require repaying debt`);
-	assertDebtLimits(view.sdk, view.debt + debtDelta, view.debtLimits, U);
+	assertDebtLimits(view.sdk, view.debt + debtDelta, view.debtLimits, U, view.maxBorrowAmount);
 	const T = intent.positionToken ?? positionToken(view, "deposit");
 	const depositStays = eq(intent.token, T);
 	return [
@@ -73,11 +73,12 @@ function planRepay(intent, view) {
 	if (view.debt <= 0n) throw new IntentPreviewError(debtOutOfRange({
 		requested: toTokenAmount(view.sdk, U, view.debt),
 		minDebt: toTokenAmount(view.sdk, U, view.debtLimits.minDebt),
-		maxDebt: toTokenAmount(view.sdk, U, view.debtLimits.maxDebt)
+		maxDebt: toTokenAmount(view.sdk, U, view.debtLimits.maxDebt),
+		maxBorrowAmount: view.maxBorrowAmount
 	}), "repay: the account owes nothing");
 	const funding = everything(intent.amount) ? view.price(U, intent.token, withMargin(view.debt)) : intent.amount;
 	const repaid = min(view.price(intent.token, U, funding), view.debt);
-	assertDebtLimits(view.sdk, view.debt - repaid, view.debtLimits, view.underlying);
+	assertDebtLimits(view.sdk, view.debt - repaid, view.debtLimits, view.underlying, view.maxBorrowAmount);
 	return [
 		add(intent.token, funding, intent.value),
 		...fundsInU ? [] : [convert(intent.token, U, funding)],
@@ -306,7 +307,7 @@ function withdrawShape(intent, view) {
 		};
 	}
 	const dD = proportionalDebt(view, WU);
-	assertDebtLimits(view.sdk, view.debt - dD, view.debtLimits, view.underlying);
+	assertDebtLimits(view.sdk, view.debt - dD, view.debtLimits, view.underlying, view.maxBorrowAmount);
 	return {
 		U,
 		T,
@@ -325,7 +326,7 @@ function leverageShape(intent, view) {
 	assertLeverageAtLeastOne(intent.targetLeverage);
 	if (view.collateral <= 0n) throw new IntentPreviewError(insufficientBalance(), "adjustLeverage: account has no collateral to lever");
 	const target = debtForLeverage(view.collateral, intent.targetLeverage);
-	assertDebtLimits(view.sdk, target, view.debtLimits, view.underlying);
+	assertDebtLimits(view.sdk, target, view.debtLimits, view.underlying, view.maxBorrowAmount);
 	return {
 		U: view.underlying,
 		delta: target - view.debt

package/dist/esm/onchain/accounts/intents/view.js

@@ -12,7 +12,7 @@ function accountView(creditAccount, sdk) {
 	const { underlying, creditManager } = creditAccount;
 	const oracle = sdk.marketRegister.findByCreditManager(creditManager).priceOracle;
 	const price = (from, to, amount) => oracle.safeConvert(from, to, amount).value;
-	const { creditFacade } = sdk.marketRegister.findCreditManager(creditManager);
+	const creditSuite = sdk.marketRegister.findCreditManager(creditManager);
 	let totalValue = 0n;
 	for (const t of creditAccount.tokens) totalValue += price(t.token, underlying, t.balance);
 	return {
@@ -22,9 +22,10 @@ function accountView(creditAccount, sdk) {
 		debt: creditAccount.totalDebt,
 		collateral: totalValue - creditAccount.totalDebt,
 		debtLimits: {
-			minDebt: creditFacade.minDebt,
-			maxDebt: creditFacade.maxDebt
+			minDebt: creditSuite.creditFacade.minDebt,
+			maxDebt: creditSuite.creditFacade.maxDebt
 		},
+		maxBorrowAmount: creditSuite.maxBorrowAmount(),
 		balanceOf: (token) => creditAccount.tokens.find((t) => eq(t.token, token))?.balance ?? 0n,
 		price,
 		fattest: (exclude) => pickFattestNonPhantomToken({

package/dist/types/model/charts.d.ts

@@ -33,10 +33,11 @@ type PoolOpportunityChartMetric = (typeof POOL_OPPORTUNITY_CHART_METRICS)[number
 /**
  * Every metric a strategy opportunity can chart.
  *
+ * `quotaRateAvg7d` is the trailing seven-day average quota rate.
  * `collateralPrice` is the collateral/underlying series a liquidation-price
  * chart draws; the two USD series are the same prices quoted in dollars.
  **/
-declare const STRATEGY_OPPORTUNITY_CHART_METRICS: readonly ["borrowApy", "borrowApyAvg7d", "rewardsApyAvg7d", "quotaRate", "liquidationThreshold", "collateralApy", "tvl", "collateralPrice", "collateralUsdPrice", "underlyingUsdPrice"];
+declare const STRATEGY_OPPORTUNITY_CHART_METRICS: readonly ["borrowApy", "borrowApyAvg7d", "rewardsApyAvg7d", "quotaRate", "quotaRateAvg7d", "liquidationThreshold", "collateralApy", "tvl", "collateralPrice", "collateralUsdPrice", "underlyingUsdPrice"];
 /**
  * Metric a strategy opportunity can chart, derived from
  * {@link STRATEGY_OPPORTUNITY_CHART_METRICS}.
@@ -183,6 +184,7 @@ declare const CHART_METRIC_UNITS: {
   readonly borrowApy: "bps";
   readonly borrowApyAvg7d: "bps";
   readonly quotaRate: "bps";
+  readonly quotaRateAvg7d: "bps";
   readonly liquidationThreshold: "bps";
   readonly collateralApy: "bps";
   readonly supplied: "token";

package/dist/types/model/charts.schema.d.ts

@@ -43,6 +43,7 @@ declare const strategyOpportunityChartMetricSchema: z.ZodEnum<{
   collateralUsdPrice: "collateralUsdPrice";
   liquidationThreshold: "liquidationThreshold";
   quotaRate: "quotaRate";
+  quotaRateAvg7d: "quotaRateAvg7d";
   rewardsApyAvg7d: "rewardsApyAvg7d";
   tvl: "tvl";
   underlyingUsdPrice: "underlyingUsdPrice";
@@ -94,6 +95,7 @@ declare const chartMetricSchema: z.ZodUnion<readonly [z.ZodEnum<{
   collateralUsdPrice: "collateralUsdPrice";
   liquidationThreshold: "liquidationThreshold";
   quotaRate: "quotaRate";
+  quotaRateAvg7d: "quotaRateAvg7d";
   rewardsApyAvg7d: "rewardsApyAvg7d";
   tvl: "tvl";
   underlyingUsdPrice: "underlyingUsdPrice";
@@ -134,6 +136,7 @@ declare const chartQuerySchema: z.ZodObject<{
     collateralUsdPrice: "collateralUsdPrice";
     liquidationThreshold: "liquidationThreshold";
     quotaRate: "quotaRate";
+    quotaRateAvg7d: "quotaRateAvg7d";
     rewardsApyAvg7d: "rewardsApyAvg7d";
     tvl: "tvl";
     underlyingUsdPrice: "underlyingUsdPrice";
@@ -211,6 +214,7 @@ declare const chartQueryCodec: z.ZodCodec<z.ZodObject<{
     collateralUsdPrice: "collateralUsdPrice";
     liquidationThreshold: "liquidationThreshold";
     quotaRate: "quotaRate";
+    quotaRateAvg7d: "quotaRateAvg7d";
     rewardsApyAvg7d: "rewardsApyAvg7d";
     tvl: "tvl";
     underlyingUsdPrice: "underlyingUsdPrice";

package/dist/types/onchain/accounts/intents/math.d.ts

@@ -1,3 +1,5 @@
+import { MaxBorrowAmount } from "../../market/credit/types.js";
+import "../../market/index.js";
 import { OnchainSDK } from "../../OnchainSDK.js";
 import { Address } from "viem";
 //#region src/onchain/accounts/intents/math.d.ts
@@ -44,6 +46,6 @@ declare function assertLeverageAtLeastOne(leverage: bigint): void;
  * Rejects a debt the facade would revert on: zero is always fine (no loan at
  * all), anything else has to sit inside `[minDebt, maxDebt]`.
  */
-declare function assertDebtLimits(sdk: OnchainSDK, debt: bigint, debtLimits: DebtLimits, underlying: Address): void;
+declare function assertDebtLimits(sdk: OnchainSDK, debt: bigint, debtLimits: DebtLimits, underlying: Address, maxBorrowAmount: MaxBorrowAmount): void;
 //#endregion
 export { DebtLimits, Position, assertDebtLimits, assertLeverageAtLeastOne, debtForLeverage, maxProportionalWithdrawal, proportionalDebt };

package/dist/types/onchain/accounts/intents/plan.d.ts

@@ -1,6 +1,8 @@
 import { DelayedIntent } from "../../../model/delayed-intents.js";
 import "../../../model/index.js";
 import { ClaimableWithdrawal } from "../withdrawal-compressor/types.js";
+import { MaxBorrowAmount } from "../../market/credit/types.js";
+import "../../market/index.js";
 import { OnchainSDK } from "../../OnchainSDK.js";
 import { AddCollateralIntent, AdjustLeverageIntent, DepositStrategyIntent, RepayStrategyIntent, WithdrawAssetIntent, WithdrawStrategyIntent } from "./types.js";
 import { DebtLimits } from "./math.js";
@@ -109,6 +111,7 @@ interface AccountView {
   /** TVL − debt, in underlying. */
   collateral: bigint;
   debtLimits: DebtLimits;
+  maxBorrowAmount: MaxBorrowAmount;
   balanceOf(token: Address): bigint;
   /** Oracle conversion; unpriceable tokens contribute 0n. */
   price(from: Address, to: Address, amount: bigint): bigint;

package/dist/types/onchain/validation/checks/checkDebtLimits.d.ts

@@ -17,7 +17,7 @@ interface DebtLimitsArgs {
    */
   allowZero: boolean;
   /** From the caller's suite; a caller that raises to throw advises nobody. */
-  maxBorrowAmount?: MaxBorrowAmount;
+  maxBorrowAmount: MaxBorrowAmount;
 }
 /** A debt the facade would revert on. */
 declare function checkDebtLimits(args: DebtLimitsArgs): DebtOutOfRangeError[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/sdk",
-  "version": "17.5.0",
+  "version": "17.6.1",
   "description": "Gearbox SDK",
   "license": "MIT",
   "repository": {