@gearbox-protocol/sdk 15.1.0-next.8 → 16.0.0-next.1

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

@@ -22,7 +22,7 @@ type ChartRange = (typeof CHART_RANGES)[number];
 /**
  * Every metric a pool opportunity can chart.
  **/
-declare const POOL_OPPORTUNITY_CHART_METRICS: readonly ["depositApy", "borrowApy", "dieselRate", "supplied", "borrowed", "availableLiquidity"];
+declare const POOL_OPPORTUNITY_CHART_METRICS: readonly ["depositApy", "depositApyAvg7d", "dieselRate", "supplied", "borrowed"];
 /**
  * Metric a pool opportunity can chart. Derived from the runtime list that also
  * builds the backend's route enum, so the two cannot drift.
@@ -34,7 +34,7 @@ type PoolOpportunityChartMetric = (typeof POOL_OPPORTUNITY_CHART_METRICS)[number
  * `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 ["netApy", "borrowApy", "collateralApy", "tvl", "collateralPrice", "collateralUsdPrice", "underlyingUsdPrice"];
+declare const STRATEGY_OPPORTUNITY_CHART_METRICS: readonly ["borrowApy", "borrowApyAvg7d", "quotaRate", "liquidationThreshold", "collateralApy", "tvl", "collateralPrice", "collateralUsdPrice", "underlyingUsdPrice"];
 /**
  * Metric a strategy opportunity can chart, derived from
  * {@link STRATEGY_OPPORTUNITY_CHART_METRICS}.
@@ -44,13 +44,12 @@ type StrategyOpportunityChartMetric = (typeof STRATEGY_OPPORTUNITY_CHART_METRICS
  * Every metric a pool position can chart.
  *
  * Nothing to do with {@link POOL_OPPORTUNITY_CHART_METRICS}: an opportunity charts what the
- * pool did, a position charts what one wallet's deposit did in it. `mwr` and
- * `twr` are cumulative returns since the position opened — money-weighted, so
- * sensitive to when deposits and withdrawals landed, and time-weighted, which
- * strips that timing out. Both are anchored at inception, so a narrow `range`
- * only zooms the visible slice and its first point is rarely zero.
+ * pool did, a position charts what one wallet's deposit did in it. `mwr` is the
+ * money-weighted return since the position opened, so it is sensitive to when
+ * deposits and withdrawals landed. It is anchored at inception, so a narrow
+ * `range` only zooms the visible slice and its first point is rarely zero.
  **/
-declare const POOL_POSITION_CHART_METRICS: readonly ["value", "apy", "pnl", "mwr", "twr", "underlyingPrice"];
+declare const POOL_POSITION_CHART_METRICS: readonly ["apy", "pnl", "mwr"];
 /**
  * Metric a pool position can chart, derived from
  * {@link POOL_POSITION_CHART_METRICS}.
@@ -59,12 +58,11 @@ type PoolPositionChartMetric = (typeof POOL_POSITION_CHART_METRICS)[number];
 /**
  * Every metric a strategy position can chart.
  *
- * `twrApy` annualizes `twr` over the position's whole life; the two trailing
- * APYs annualize it over a fixed window instead, so they track the current pace
- * rather than the lifetime rate and are comparable across positions of
- * different ages.
+ * `netApy7d` is the trailing seven-day net yield, so it tracks the position's
+ * recent pace rather than its lifetime return and is comparable across
+ * positions of different ages.
  **/
-declare const STRATEGY_POSITION_CHART_METRICS: readonly ["totalValueUsd", "totalValueUnderlying", "debt", "healthFactor", "leverage", "borrowApy", "underlyingPrice", "pnl", "mwr", "twr", "twrApy", "trailingApy7d", "trailingApy30d"];
+declare const STRATEGY_POSITION_CHART_METRICS: readonly ["totalValueUnderlying", "debt", "healthFactor", "borrowApy", "borrowApyAvg7d", "pnl", "mwr", "netApy7d"];
 /**
  * Metric a strategy position can chart, derived from
  * {@link STRATEGY_POSITION_CHART_METRICS}.
@@ -161,31 +159,26 @@ type ChartUnit =
  **/
 declare const CHART_METRIC_UNITS: {
   readonly depositApy: "bps";
+  readonly depositApyAvg7d: "bps";
   readonly borrowApy: "bps";
-  readonly netApy: "bps";
+  readonly borrowApyAvg7d: "bps";
+  readonly quotaRate: "bps";
+  readonly liquidationThreshold: "bps";
   readonly collateralApy: "bps";
   readonly supplied: "token";
   readonly borrowed: "token";
-  readonly availableLiquidity: "token";
   readonly tvl: "token";
   readonly dieselRate: "ratio";
   readonly collateralPrice: "ratio";
   readonly collateralUsdPrice: "usd";
   readonly underlyingUsdPrice: "usd";
-  readonly value: "token";
   readonly apy: "bps";
   readonly pnl: "token";
   readonly mwr: "bps";
-  readonly twr: "bps";
-  readonly underlyingPrice: "usd";
-  readonly totalValueUsd: "usd";
   readonly totalValueUnderlying: "token";
   readonly debt: "token";
   readonly healthFactor: "bps";
-  readonly leverage: "scalar";
-  readonly twrApy: "bps";
-  readonly trailingApy7d: "bps";
-  readonly trailingApy30d: "bps";
+  readonly netApy7d: "bps";
 };
 /**
  * A unit together with what it is denominated in.

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

@@ -24,10 +24,9 @@ declare const chartRangeSchema: z.ZodEnum<{
  * {@link PoolOpportunityChartMetric}
  **/
 declare const poolOpportunityChartMetricSchema: z.ZodEnum<{
-  availableLiquidity: "availableLiquidity";
-  borrowApy: "borrowApy";
   borrowed: "borrowed";
   depositApy: "depositApy";
+  depositApyAvg7d: "depositApyAvg7d";
   dieselRate: "dieselRate";
   supplied: "supplied";
 }>;
@@ -36,10 +35,12 @@ declare const poolOpportunityChartMetricSchema: z.ZodEnum<{
  **/
 declare const strategyOpportunityChartMetricSchema: z.ZodEnum<{
   borrowApy: "borrowApy";
+  borrowApyAvg7d: "borrowApyAvg7d";
   collateralApy: "collateralApy";
   collateralPrice: "collateralPrice";
   collateralUsdPrice: "collateralUsdPrice";
-  netApy: "netApy";
+  liquidationThreshold: "liquidationThreshold";
+  quotaRate: "quotaRate";
   tvl: "tvl";
   underlyingUsdPrice: "underlyingUsdPrice";
 }>;
@@ -50,108 +51,86 @@ declare const poolPositionChartMetricSchema: z.ZodEnum<{
   apy: "apy";
   mwr: "mwr";
   pnl: "pnl";
-  twr: "twr";
-  underlyingPrice: "underlyingPrice";
-  value: "value";
 }>;
 /**
  * {@link StrategyPositionChartMetric}
  **/
 declare const strategyPositionChartMetricSchema: z.ZodEnum<{
   borrowApy: "borrowApy";
+  borrowApyAvg7d: "borrowApyAvg7d";
   debt: "debt";
   healthFactor: "healthFactor";
-  leverage: "leverage";
   mwr: "mwr";
+  netApy7d: "netApy7d";
   pnl: "pnl";
   totalValueUnderlying: "totalValueUnderlying";
-  totalValueUsd: "totalValueUsd";
-  trailingApy30d: "trailingApy30d";
-  trailingApy7d: "trailingApy7d";
-  twr: "twr";
-  twrApy: "twrApy";
-  underlyingPrice: "underlyingPrice";
 }>;
 /**
  * {@link ChartMetric}, every metric either kind of subject can chart.
  **/
 declare const chartMetricSchema: z.ZodUnion<readonly [z.ZodEnum<{
-  availableLiquidity: "availableLiquidity";
-  borrowApy: "borrowApy";
   borrowed: "borrowed";
   depositApy: "depositApy";
+  depositApyAvg7d: "depositApyAvg7d";
   dieselRate: "dieselRate";
   supplied: "supplied";
 }>, z.ZodEnum<{
   borrowApy: "borrowApy";
+  borrowApyAvg7d: "borrowApyAvg7d";
   collateralApy: "collateralApy";
   collateralPrice: "collateralPrice";
   collateralUsdPrice: "collateralUsdPrice";
-  netApy: "netApy";
+  liquidationThreshold: "liquidationThreshold";
+  quotaRate: "quotaRate";
   tvl: "tvl";
   underlyingUsdPrice: "underlyingUsdPrice";
 }>, z.ZodEnum<{
   apy: "apy";
   mwr: "mwr";
   pnl: "pnl";
-  twr: "twr";
-  underlyingPrice: "underlyingPrice";
-  value: "value";
 }>, z.ZodEnum<{
   borrowApy: "borrowApy";
+  borrowApyAvg7d: "borrowApyAvg7d";
   debt: "debt";
   healthFactor: "healthFactor";
-  leverage: "leverage";
   mwr: "mwr";
+  netApy7d: "netApy7d";
   pnl: "pnl";
   totalValueUnderlying: "totalValueUnderlying";
-  totalValueUsd: "totalValueUsd";
-  trailingApy30d: "trailingApy30d";
-  trailingApy7d: "trailingApy7d";
-  twr: "twr";
-  twrApy: "twrApy";
-  underlyingPrice: "underlyingPrice";
 }>]>;
 /**
  * {@link ChartQuery}
  **/
 declare const chartQuerySchema: z.ZodObject<{
   metrics: z.ZodReadonly<z.ZodArray<z.ZodUnion<readonly [z.ZodEnum<{
-    availableLiquidity: "availableLiquidity";
-    borrowApy: "borrowApy";
     borrowed: "borrowed";
     depositApy: "depositApy";
+    depositApyAvg7d: "depositApyAvg7d";
     dieselRate: "dieselRate";
     supplied: "supplied";
   }>, z.ZodEnum<{
     borrowApy: "borrowApy";
+    borrowApyAvg7d: "borrowApyAvg7d";
     collateralApy: "collateralApy";
     collateralPrice: "collateralPrice";
     collateralUsdPrice: "collateralUsdPrice";
-    netApy: "netApy";
+    liquidationThreshold: "liquidationThreshold";
+    quotaRate: "quotaRate";
     tvl: "tvl";
     underlyingUsdPrice: "underlyingUsdPrice";
   }>, z.ZodEnum<{
     apy: "apy";
     mwr: "mwr";
     pnl: "pnl";
-    twr: "twr";
-    underlyingPrice: "underlyingPrice";
-    value: "value";
   }>, z.ZodEnum<{
     borrowApy: "borrowApy";
+    borrowApyAvg7d: "borrowApyAvg7d";
     debt: "debt";
     healthFactor: "healthFactor";
-    leverage: "leverage";
     mwr: "mwr";
+    netApy7d: "netApy7d";
     pnl: "pnl";
     totalValueUnderlying: "totalValueUnderlying";
-    totalValueUsd: "totalValueUsd";
-    trailingApy30d: "trailingApy30d";
-    trailingApy7d: "trailingApy7d";
-    twr: "twr";
-    twrApy: "twrApy";
-    underlyingPrice: "underlyingPrice";
   }>]>>>;
   range: z.ZodEnum<{
     "1d": "1d";
@@ -195,41 +174,34 @@ declare const chartQueryCodec: z.ZodCodec<z.ZodObject<{
   }>;
 }, z.core.$strip>, z.ZodObject<{
   metrics: z.ZodReadonly<z.ZodArray<z.ZodUnion<readonly [z.ZodEnum<{
-    availableLiquidity: "availableLiquidity";
-    borrowApy: "borrowApy";
     borrowed: "borrowed";
     depositApy: "depositApy";
+    depositApyAvg7d: "depositApyAvg7d";
     dieselRate: "dieselRate";
     supplied: "supplied";
   }>, z.ZodEnum<{
     borrowApy: "borrowApy";
+    borrowApyAvg7d: "borrowApyAvg7d";
     collateralApy: "collateralApy";
     collateralPrice: "collateralPrice";
     collateralUsdPrice: "collateralUsdPrice";
-    netApy: "netApy";
+    liquidationThreshold: "liquidationThreshold";
+    quotaRate: "quotaRate";
     tvl: "tvl";
     underlyingUsdPrice: "underlyingUsdPrice";
   }>, z.ZodEnum<{
     apy: "apy";
     mwr: "mwr";
     pnl: "pnl";
-    twr: "twr";
-    underlyingPrice: "underlyingPrice";
-    value: "value";
   }>, z.ZodEnum<{
     borrowApy: "borrowApy";
+    borrowApyAvg7d: "borrowApyAvg7d";
     debt: "debt";
     healthFactor: "healthFactor";
-    leverage: "leverage";
     mwr: "mwr";
+    netApy7d: "netApy7d";
     pnl: "pnl";
     totalValueUnderlying: "totalValueUnderlying";
-    totalValueUsd: "totalValueUsd";
-    trailingApy30d: "trailingApy30d";
-    trailingApy7d: "trailingApy7d";
-    twr: "twr";
-    twrApy: "twrApy";
-    underlyingPrice: "underlyingPrice";
   }>]>>>;
   range: z.ZodEnum<{
     "1d": "1d";

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

@@ -0,0 +1,47 @@
+import { z } from "zod/v4";
+//#region src/model/compare.schema.d.ts
+/**
+ * How close two numeric values may be before a disagreement counts as real.
+ *
+ * The compare scripts pick a formula from this union; the schemas only name
+ * which formula a field uses.
+ *
+ * - `"amount"` — accrual lag on an {@link Amount.value} / {@link TokenAmount.value}.
+ * - `"bps"` — truncation vs rounding on a basis-point rate, ±1.
+ * - `"float"` — relative float drift within 0.1% (leverage).
+ * - `"usd"` — price-derived {@link Amount.valueUsd} / {@link TokenAmount.valueUsd}.
+ **/
+type CompareTolerance = "amount" | "bps" | "float" | "usd";
+/**
+ * A numeric field whose two sources may drift within {@link tolerance}.
+ **/
+interface ToleranceCompareTag {
+  tolerance: CompareTolerance;
+}
+/**
+ * Compare metadata a schema field may carry.
+ *
+ * - `"offchainOnly"` / `"onchainOnly"` — the other source typically leaves
+ *   the field empty, so a disagreement is expected.
+ * - {@link ToleranceCompareTag} — a numeric disagreement within the named
+ *   formula is expected snapshot noise.
+ **/
+type CompareTag = "offchainOnly" | "onchainOnly" | ToleranceCompareTag;
+/**
+ * Marks a field that only the backend fills.
+ **/
+declare function offchainOnly<S extends z.ZodType>(schema: S): S;
+/**
+ * Marks a field that only the chain fills.
+ **/
+declare function onchainOnly<S extends z.ZodType>(schema: S): S;
+/**
+ * Marks a numeric field whose two sources may drift within {@link kind}.
+ **/
+declare function tolerance<S extends z.ZodType>(schema: S, kind: CompareTolerance): S;
+/**
+ * The compare tag registered on a schema, if any.
+ **/
+declare function compareTagOf(schema: z.ZodType): CompareTag | undefined;
+//#endregion
+export { CompareTag, CompareTolerance, ToleranceCompareTag, compareTagOf, offchainOnly, onchainOnly, tolerance };

package/dist/types/model/delayed-intents.d.ts

@@ -0,0 +1,94 @@
+import { Address } from "viem";
+//#region src/model/delayed-intents.d.ts
+/**
+ * App: 1.1 Deposit and 4.1 Adjust leverage — raise leverage at fixed collateral.
+ * Borrow `underlying` -> swap `underlying` into `targetToken` (kept on CA).
+ **/
+interface DelayedIncreaseLeverageIntent {
+  type: "INCREASE_LEVERAGE";
+}
+/**
+ * App: 1.2 Deposit — `amount > 0`, leverage = current (grow net value at same L).
+ * Add collateral -> borrow `underlying` -> swap collateral and `underlying`
+ * into the target token.
+ **/
+interface DelayedDepositIntent {
+  type: "DEPOSIT";
+}
+/**
+ * App: 1.3 Deposit and Adjust leverage — `amount > 0`, leverage > current.
+ * Add collateral -> borrow `underlying` -> swap collateral and `underlying`
+ * into the target token.
+ **/
+interface DelayedDepositAndIncreaseLeverageIntent {
+  type: "DEPOSIT_AND_INCREASE_LEVERAGE";
+}
+/**
+ * App: 2.1 Withdraw — withdraw selected token at fixed leverage.
+ * Primary goal is `withdrawAmount` of `withdrawToken` (W of T). Debt cut is
+ * residual from the claim/path after reserving W. `sourceToken` (S) funds the
+ * delayed path; `debtRepaid` is 0 when debt was already repaid on start.
+ **/
+interface DelayedWithdrawCollateralIntent {
+  type: "WITHDRAW_COLLATERAL";
+  /**
+   * Wallet address that receives the withdrawn token
+   * when the flow is resumed after the claim
+   **/
+  to: Address;
+  /**
+   * Token to withdraw from the credit account to the wallet after the claim
+   **/
+  withdrawToken: Address;
+  /**
+   * Amount of `withdrawToken` to withdraw to the wallet after the claim (W)
+   **/
+  withdrawAmount: bigint;
+  /**
+   * Token that funds the delayed path / debt conversion (S)
+   **/
+  sourceToken: Address;
+  /**
+   * Desired debt decrease in underlying units remaining for resume.
+   * `0n` when debt was already repaid on the delayed-start branch.
+   **/
+  debtRepaid: bigint;
+}
+/**
+ * App: 2.2 Withdraw — close account (receive leftover to wallet).
+ **/
+interface DelayedCloseAccountIntent {
+  type: "CLOSE_ACCOUNT";
+  /**
+   * Wallet address that receives leftover tokens when the account is closed
+   * after the claim
+   **/
+  to: Address;
+}
+/**
+ * App: 3.1 Add collateral — fixed debt.
+ * Add collateral -> swap collateral into the target token.
+ **/
+interface DelayedAddCollateralIntent {
+  type: "ADD_COLLATERAL";
+}
+/**
+ * App: 4.2 Adjust leverage — lower leverage at fixed collateral.
+ * Swap source token into `underlying` -> decrease debt.
+ **/
+interface DelayedDecreaseLeverageIntent {
+  type: "DECREASE_LEVERAGE";
+}
+/**
+ * Lean intent that is abi-encoded into `extraData` of a delayed withdrawal
+ * request and decoded back when reading claimable withdrawals.
+ *
+ * It allows the app to resume a multi-step operation that was interrupted by
+ * a delayed withdrawal: the intent records which operation was in progress
+ * (and the minimal set of parameters that cannot be re-derived at claim time),
+ * so that after the withdrawal is claimed, the remaining steps can be
+ * previewed and executed.
+ **/
+type DelayedIntent = DelayedIncreaseLeverageIntent | DelayedDepositIntent | DelayedDepositAndIncreaseLeverageIntent | DelayedWithdrawCollateralIntent | DelayedCloseAccountIntent | DelayedAddCollateralIntent | DelayedDecreaseLeverageIntent;
+//#endregion
+export { DelayedAddCollateralIntent, DelayedCloseAccountIntent, DelayedDecreaseLeverageIntent, DelayedDepositAndIncreaseLeverageIntent, DelayedDepositIntent, DelayedIncreaseLeverageIntent, DelayedIntent, DelayedWithdrawCollateralIntent };

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

@@ -1,17 +1,22 @@
-import { Amount, AssetType, Bps, ChainId, Leverage, Timestamp, Token, TokenAmount, TxCall } from "./primitives.js";
-import { Curator, CuratorName } from "./curators.js";
+import { Amount, Asset, AssetType, Bps, ChainId, Leverage, Timestamp, Token, TokenAmount, TxCall } from "./primitives.js";
 import { CHART_METRIC_UNITS, CHART_RANGES, CHART_UNAVAILABLE_CODES, ChartBundle, ChartDenomination, ChartMetric, ChartQuery, ChartRange, ChartSeries, ChartSeriesOk, ChartSeriesUnavailable, ChartUnavailableCode, ChartUnit, ChartValue, ChartWindow, GridSampling, OpportunityChartMetric, POOL_OPPORTUNITY_CHART_METRICS, POOL_POSITION_CHART_METRICS, PoolOpportunityChartMetric, PoolPositionChartMetric, PositionChartMetric, STRATEGY_OPPORTUNITY_CHART_METRICS, STRATEGY_POSITION_CHART_METRICS, StrategyOpportunityChartMetric, StrategyPositionChartMetric } from "./charts.js";
 import { chartBundleSchemaFor, chartDenominationSchema, chartMetricSchema, chartQueryCodec, chartQueryParamsSchema, chartQuerySchema, chartRangeSchema, chartSeriesSchema, chartValueSchema, chartWindowSchema, poolOpportunityChartMetricSchema, poolPositionChartMetricSchema, strategyOpportunityChartMetricSchema, strategyPositionChartMetricSchema } from "./charts.schema.js";
+import { CompareTag, CompareTolerance, ToleranceCompareTag, compareTagOf, offchainOnly, onchainOnly, tolerance } from "./compare.schema.js";
+import { Curator, CuratorName } from "./curators.js";
 import { curatorNameSchema, curatorSchema } from "./curators.schema.js";
+import { DelayedAddCollateralIntent, DelayedCloseAccountIntent, DelayedDecreaseLeverageIntent, DelayedDepositAndIncreaseLeverageIntent, DelayedDepositIntent, DelayedIncreaseLeverageIntent, DelayedIntent, DelayedWithdrawCollateralIntent } from "./delayed-intents.js";
 import { ChainScopedFilter, FILTER_ALL, FilterAll, Filterable, isFilterSet } from "./filters.js";
 import { booleanParamSchema, encodeFlag, filterAllSchema, filterable } from "./filters.schema.js";
 import { DelayedReceivedAsset, InstantReceivedAsset, LiquidatableAccount, LiquidatableAccountFilter, LiquidationApproval, LiquidationDetails, LiquidationPosition, ReceivedAsset, matchesLiquidatableAccountFilter } from "./liquidations.js";
 import { delayedReceivedAssetSchema, instantReceivedAssetSchema, liquidatableAccountFilterSchema, liquidatableAccountSchema, liquidationApprovalSchema, liquidationDetailsSchema, liquidationPositionSchema, receivedAssetSchema } from "./liquidations.schema.js";
 import { ApyBreakdown, Opportunity, OpportunityBase, OpportunityDetail, OpportunityFilter, OpportunityId, OpportunityKey, OpportunityKind, PointRewards, PointsProgram, PoolOpportunity, PoolOpportunityDetail, PoolOpportunityKey, PoolOpportunityRef, PriceFeedData, PriceFeedSummary, QuotaAsset, RateCurve, RateCurvePoint, Rewards, StrategyOpportunity, StrategyOpportunityDetail, StrategyOpportunityKey, StrategyOpportunityRef, TokenRewards, matchesOpportunityFilter, opportunityId, poolOpportunityId, strategyOpportunityId } from "./opportunities.js";
+import { BorrowRateBreakdown, PnlBreakdown, PointsProgramPnL, PointsRewardsPnL, PoolPosition, PoolPositionKey, PoolPositionRef, Position, PositionCollateral, PositionFilter, PositionId, PositionKey, PositionKind, PositionTransaction, PositionTransactionKind, PositionsTotals, RewardsPnL, StrategyPosition, StrategyPositionKey, StrategyPositionRef, TokenQuotaRate, TokenRewardsPnL, liquidationPositionId, matchesPositionFilter, poolPositionId, positionId, strategyPositionId } from "./positions.js";
+import { Notice, NoticeKind, NoticeSubject } from "./notices.js";
+import { noticeKindSchema, noticeSchema } from "./notices.schema.js";
 import { apyBreakdownSchema, opportunityBaseSchema, opportunityDetailSchema, opportunityFilterQueryParamsSchema, opportunityFilterQuerySchema, opportunityFilterSchema, opportunityKeySchema, opportunityKindSchema, opportunitySchema, pointRewardsSchema, pointsProgramSchema, poolOpportunityDetailSchema, poolOpportunityKeySchema, poolOpportunitySchema, priceFeedDataSchema, priceFeedSummarySchema, quotaAssetSchema, rateCurvePointSchema, rateCurveSchema, rewardsSchema, strategyOpportunityDetailSchema, strategyOpportunityKeySchema, strategyOpportunitySchema, tokenRewardsSchema } from "./opportunities.schema.js";
-import { BorrowRateBreakdown, PnlBreakdown, PointsProgramPnL, PointsRewardsPnL, PoolPosition, PoolPositionKey, PoolPositionRef, Position, PositionCollateral, PositionFilter, PositionId, PositionKey, PositionKind, PositionMetrics, RewardsPnL, StrategyPosition, StrategyPositionKey, StrategyPositionRef, TokenRewardsPnL, liquidationPositionId, matchesPositionFilter, poolPositionId, positionId, strategyPositionId } from "./positions.js";
-import { borrowRateBreakdownSchema, pnlBreakdownSchema, pointsProgramPnLSchema, pointsRewardsPnLSchema, poolPositionKeySchema, poolPositionSchema, positionCollateralSchema, positionFilterQueryParamsSchema, positionFilterQuerySchema, positionFilterSchema, positionKeySchema, positionKindSchema, positionSchema, rewardsPnLSchema, strategyPositionKeySchema, strategyPositionSchema, tokenRewardsPnLSchema } from "./positions.schema.js";
+import { borrowRateBreakdownSchema, pnlBreakdownSchema, pointsProgramPnLSchema, pointsRewardsPnLSchema, poolPositionKeySchema, poolPositionSchema, positionCollateralSchema, positionFilterQueryParamsSchema, positionFilterQuerySchema, positionFilterSchema, positionKeySchema, positionKindSchema, positionSchema, positionTransactionKindSchema, positionTransactionSchema, positionsTotalsSchema, rewardsPnLSchema, strategyPositionKeySchema, strategyPositionSchema, tokenQuotaRateSchema, tokenRewardsPnLSchema } from "./positions.schema.js";
+import { AdjustCreditAccountPreview, CloseCreditAccountPreview, DelayedCreditAccountOperationPreview, ERROR_ADAPTER_CALL_OUTSIDE_BRACKET, ERROR_INVALID_TRANSACTION_VALUE, ERROR_MALFORMED_BRACKET, ERROR_NON_ADAPTER_CALL_IN_BRACKET, ERROR_UNPREVIEWABLE_ADAPTER_CALL, ERROR_UNPREVIEWABLE_RWA_WRAP_UNWRAP, ERROR_UNPRICEABLE_TOKEN, InstantOperationPreview, OpenCreditAccountPreview, OperationPreview, OperationPreviewError, PoolOperationPreview, PoolOperationType, PreviewOperationInput, PreviewOperationOptions, RepayCreditAccountPreview } from "./previews.js";
 import { amountSchema, assetTypeSchema, bpsSchema, chainIdSchema, leverageSchema, timestampSchema, tokenAmountSchema, tokenSchema, txCallSchema } from "./primitives.schema.js";
 import { ChainFailed, ChainMetadata, ChainScoped, ChainSucceeded, DataResponse, DataSource, ResponseMetadata } from "./response.js";
 import { chainFailedSchema, chainMetadataSchema, chainSucceededSchema, dataSourceSchema, responseMetadataSchema, responseSchema } from "./response.schema.js";
-export { Amount, ApyBreakdown, AssetType, BorrowRateBreakdown, Bps, CHART_METRIC_UNITS, CHART_RANGES, CHART_UNAVAILABLE_CODES, ChainFailed, ChainId, ChainMetadata, ChainScoped, ChainScopedFilter, ChainSucceeded, ChartBundle, ChartDenomination, ChartMetric, ChartQuery, ChartRange, ChartSeries, ChartSeriesOk, ChartSeriesUnavailable, ChartUnavailableCode, ChartUnit, ChartValue, ChartWindow, Curator, CuratorName, DataResponse, DataSource, DelayedReceivedAsset, FILTER_ALL, FilterAll, Filterable, GridSampling, InstantReceivedAsset, Leverage, LiquidatableAccount, LiquidatableAccountFilter, LiquidationApproval, LiquidationDetails, LiquidationPosition, Opportunity, OpportunityBase, OpportunityChartMetric, OpportunityDetail, OpportunityFilter, OpportunityId, OpportunityKey, OpportunityKind, POOL_OPPORTUNITY_CHART_METRICS, POOL_POSITION_CHART_METRICS, PnlBreakdown, PointRewards, PointsProgram, PointsProgramPnL, PointsRewardsPnL, PoolOpportunity, PoolOpportunityChartMetric, PoolOpportunityDetail, PoolOpportunityKey, PoolOpportunityRef, PoolPosition, PoolPositionChartMetric, PoolPositionKey, PoolPositionRef, Position, PositionChartMetric, PositionCollateral, PositionFilter, PositionId, PositionKey, PositionKind, PositionMetrics, PriceFeedData, PriceFeedSummary, QuotaAsset, RateCurve, RateCurvePoint, ReceivedAsset, ResponseMetadata, Rewards, RewardsPnL, STRATEGY_OPPORTUNITY_CHART_METRICS, STRATEGY_POSITION_CHART_METRICS, StrategyOpportunity, StrategyOpportunityChartMetric, StrategyOpportunityDetail, StrategyOpportunityKey, StrategyOpportunityRef, StrategyPosition, StrategyPositionChartMetric, StrategyPositionKey, StrategyPositionRef, Timestamp, Token, TokenAmount, TokenRewards, TokenRewardsPnL, TxCall, amountSchema, apyBreakdownSchema, assetTypeSchema, booleanParamSchema, borrowRateBreakdownSchema, bpsSchema, chainFailedSchema, chainIdSchema, chainMetadataSchema, chainSucceededSchema, chartBundleSchemaFor, chartDenominationSchema, chartMetricSchema, chartQueryCodec, chartQueryParamsSchema, chartQuerySchema, chartRangeSchema, chartSeriesSchema, chartValueSchema, chartWindowSchema, curatorNameSchema, curatorSchema, dataSourceSchema, delayedReceivedAssetSchema, encodeFlag, filterAllSchema, filterable, instantReceivedAssetSchema, isFilterSet, leverageSchema, liquidatableAccountFilterSchema, liquidatableAccountSchema, liquidationApprovalSchema, liquidationDetailsSchema, liquidationPositionId, liquidationPositionSchema, matchesLiquidatableAccountFilter, matchesOpportunityFilter, matchesPositionFilter, opportunityBaseSchema, opportunityDetailSchema, opportunityFilterQueryParamsSchema, opportunityFilterQuerySchema, opportunityFilterSchema, opportunityId, opportunityKeySchema, opportunityKindSchema, opportunitySchema, pnlBreakdownSchema, pointRewardsSchema, pointsProgramPnLSchema, pointsProgramSchema, pointsRewardsPnLSchema, poolOpportunityChartMetricSchema, poolOpportunityDetailSchema, poolOpportunityId, poolOpportunityKeySchema, poolOpportunitySchema, poolPositionChartMetricSchema, poolPositionId, poolPositionKeySchema, poolPositionSchema, positionCollateralSchema, positionFilterQueryParamsSchema, positionFilterQuerySchema, positionFilterSchema, positionId, positionKeySchema, positionKindSchema, positionSchema, priceFeedDataSchema, priceFeedSummarySchema, quotaAssetSchema, rateCurvePointSchema, rateCurveSchema, receivedAssetSchema, responseMetadataSchema, responseSchema, rewardsPnLSchema, rewardsSchema, strategyOpportunityChartMetricSchema, strategyOpportunityDetailSchema, strategyOpportunityId, strategyOpportunityKeySchema, strategyOpportunitySchema, strategyPositionChartMetricSchema, strategyPositionId, strategyPositionKeySchema, strategyPositionSchema, timestampSchema, tokenAmountSchema, tokenRewardsPnLSchema, tokenRewardsSchema, tokenSchema, txCallSchema };
+export { AdjustCreditAccountPreview, Amount, ApyBreakdown, Asset, AssetType, BorrowRateBreakdown, Bps, CHART_METRIC_UNITS, CHART_RANGES, CHART_UNAVAILABLE_CODES, ChainFailed, ChainId, ChainMetadata, ChainScoped, ChainScopedFilter, ChainSucceeded, ChartBundle, ChartDenomination, ChartMetric, ChartQuery, ChartRange, ChartSeries, ChartSeriesOk, ChartSeriesUnavailable, ChartUnavailableCode, ChartUnit, ChartValue, ChartWindow, CloseCreditAccountPreview, CompareTag, CompareTolerance, Curator, CuratorName, DataResponse, DataSource, DelayedAddCollateralIntent, DelayedCloseAccountIntent, DelayedCreditAccountOperationPreview, DelayedDecreaseLeverageIntent, DelayedDepositAndIncreaseLeverageIntent, DelayedDepositIntent, DelayedIncreaseLeverageIntent, DelayedIntent, DelayedReceivedAsset, DelayedWithdrawCollateralIntent, ERROR_ADAPTER_CALL_OUTSIDE_BRACKET, ERROR_INVALID_TRANSACTION_VALUE, ERROR_MALFORMED_BRACKET, ERROR_NON_ADAPTER_CALL_IN_BRACKET, ERROR_UNPREVIEWABLE_ADAPTER_CALL, ERROR_UNPREVIEWABLE_RWA_WRAP_UNWRAP, ERROR_UNPRICEABLE_TOKEN, FILTER_ALL, FilterAll, Filterable, GridSampling, InstantOperationPreview, InstantReceivedAsset, Leverage, LiquidatableAccount, LiquidatableAccountFilter, LiquidationApproval, LiquidationDetails, LiquidationPosition, Notice, NoticeKind, NoticeSubject, OpenCreditAccountPreview, OperationPreview, OperationPreviewError, Opportunity, OpportunityBase, OpportunityChartMetric, OpportunityDetail, OpportunityFilter, OpportunityId, OpportunityKey, OpportunityKind, POOL_OPPORTUNITY_CHART_METRICS, POOL_POSITION_CHART_METRICS, PnlBreakdown, PointRewards, PointsProgram, PointsProgramPnL, PointsRewardsPnL, PoolOperationPreview, PoolOperationType, PoolOpportunity, PoolOpportunityChartMetric, PoolOpportunityDetail, PoolOpportunityKey, PoolOpportunityRef, PoolPosition, PoolPositionChartMetric, PoolPositionKey, PoolPositionRef, Position, PositionChartMetric, PositionCollateral, PositionFilter, PositionId, PositionKey, PositionKind, PositionTransaction, PositionTransactionKind, PositionsTotals, PreviewOperationInput, PreviewOperationOptions, PriceFeedData, PriceFeedSummary, QuotaAsset, RateCurve, RateCurvePoint, ReceivedAsset, RepayCreditAccountPreview, ResponseMetadata, Rewards, RewardsPnL, STRATEGY_OPPORTUNITY_CHART_METRICS, STRATEGY_POSITION_CHART_METRICS, StrategyOpportunity, StrategyOpportunityChartMetric, StrategyOpportunityDetail, StrategyOpportunityKey, StrategyOpportunityRef, StrategyPosition, StrategyPositionChartMetric, StrategyPositionKey, StrategyPositionRef, Timestamp, Token, TokenAmount, TokenQuotaRate, TokenRewards, TokenRewardsPnL, ToleranceCompareTag, TxCall, amountSchema, apyBreakdownSchema, assetTypeSchema, booleanParamSchema, borrowRateBreakdownSchema, bpsSchema, chainFailedSchema, chainIdSchema, chainMetadataSchema, chainSucceededSchema, chartBundleSchemaFor, chartDenominationSchema, chartMetricSchema, chartQueryCodec, chartQueryParamsSchema, chartQuerySchema, chartRangeSchema, chartSeriesSchema, chartValueSchema, chartWindowSchema, compareTagOf, curatorNameSchema, curatorSchema, dataSourceSchema, delayedReceivedAssetSchema, encodeFlag, filterAllSchema, filterable, instantReceivedAssetSchema, isFilterSet, leverageSchema, liquidatableAccountFilterSchema, liquidatableAccountSchema, liquidationApprovalSchema, liquidationDetailsSchema, liquidationPositionId, liquidationPositionSchema, matchesLiquidatableAccountFilter, matchesOpportunityFilter, matchesPositionFilter, noticeKindSchema, noticeSchema, offchainOnly, onchainOnly, opportunityBaseSchema, opportunityDetailSchema, opportunityFilterQueryParamsSchema, opportunityFilterQuerySchema, opportunityFilterSchema, opportunityId, opportunityKeySchema, opportunityKindSchema, opportunitySchema, pnlBreakdownSchema, pointRewardsSchema, pointsProgramPnLSchema, pointsProgramSchema, pointsRewardsPnLSchema, poolOpportunityChartMetricSchema, poolOpportunityDetailSchema, poolOpportunityId, poolOpportunityKeySchema, poolOpportunitySchema, poolPositionChartMetricSchema, poolPositionId, poolPositionKeySchema, poolPositionSchema, positionCollateralSchema, positionFilterQueryParamsSchema, positionFilterQuerySchema, positionFilterSchema, positionId, positionKeySchema, positionKindSchema, positionSchema, positionTransactionKindSchema, positionTransactionSchema, positionsTotalsSchema, priceFeedDataSchema, priceFeedSummarySchema, quotaAssetSchema, rateCurvePointSchema, rateCurveSchema, receivedAssetSchema, responseMetadataSchema, responseSchema, rewardsPnLSchema, rewardsSchema, strategyOpportunityChartMetricSchema, strategyOpportunityDetailSchema, strategyOpportunityId, strategyOpportunityKeySchema, strategyOpportunitySchema, strategyPositionChartMetricSchema, strategyPositionId, strategyPositionKeySchema, strategyPositionSchema, timestampSchema, tokenAmountSchema, tokenQuotaRateSchema, tokenRewardsPnLSchema, tokenRewardsSchema, tokenSchema, tolerance, txCallSchema };

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

@@ -0,0 +1,29 @@
+import { Token } from "./primitives.js";
+import { PoolOpportunity } from "./opportunities.js";
+import { StrategyPosition } from "./positions.js";
+//#region src/model/notices.d.ts
+/**
+ * What a notice is about, and therefore how a consumer shows it.
+ **/
+type NoticeKind = "expired" | "externalRewards" | "extraApy" | "warning" | "disclaimer";
+/**
+ * A banner the backend asks a consumer to show for a pool opportunity or a
+ * strategy position: an expired account, rewards paid outside the protocol,
+ * a caveat on the yield. The message is final text; the consumer adds
+ * nothing.
+ **/
+interface Notice {
+  kind: NoticeKind;
+  message: string;
+  /**
+   * Token the notice is about, when it is about one (rewards, extra APY).
+   **/
+  token?: Token;
+}
+/**
+ * What a notice is attached to: a pool opportunity or a strategy position —
+ * the two entities a consumer shows banners for.
+ **/
+type NoticeSubject = PoolOpportunity | StrategyPosition;
+//#endregion
+export { Notice, NoticeKind, NoticeSubject };

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

@@ -0,0 +1,23 @@
+import { z } from "zod/v4";
+//#region src/model/notices.schema.d.ts
+/**
+ * {@link NoticeKind}
+ **/
+declare const noticeKindSchema: z.ZodUnion<readonly [z.ZodLiteral<"expired">, z.ZodLiteral<"externalRewards">, z.ZodLiteral<"extraApy">, z.ZodLiteral<"warning">, z.ZodLiteral<"disclaimer">]>;
+/**
+ * {@link Notice}
+ **/
+declare const noticeSchema: z.ZodObject<{
+  kind: z.ZodUnion<readonly [z.ZodLiteral<"expired">, z.ZodLiteral<"externalRewards">, z.ZodLiteral<"extraApy">, z.ZodLiteral<"warning">, z.ZodLiteral<"disclaimer">]>;
+  message: z.ZodString;
+  token: z.ZodOptional<z.ZodObject<{
+    chainId: z.ZodNumber;
+    address: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
+    symbol: z.ZodString;
+    name: z.ZodString;
+    decimals: z.ZodNumber;
+    assetType: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"Stable">, z.ZodLiteral<"ETH">, z.ZodLiteral<"BTC">]>>;
+  }, z.core.$strip>>;
+}, z.core.$strip>;
+//#endregion
+export { noticeKindSchema, noticeSchema };