@gearbox-protocol/sdk 16.1.2 → 16.3.0-next.1

package/dist/types/model/errors/operation-errors.d.ts

@@ -0,0 +1,216 @@
+import { Bps, Token, TokenAmount } from "../primitives.js";
+import { IGearboxError } from "./base.js";
+import { RWAMissingOpenAccountRequirements, RWAOpenAccountRequirements } from "../rwa.js";
+import { Address } from "viem";
+//#region src/model/errors/operation-errors.d.ts
+/**
+ * Which limit stopped a borrow.
+ *
+ * - `poolAvailableLiquidity` — the pool's available liquidity
+ * - `managerDebtAvailable` — this credit manager's remaining debt allowance
+ * - `maxDebt` — the facade's per-account `debtLimits.maxDebt`
+ * - `debtPerBlockLimit` — facade takes no new debt this block; in practice
+ *   `maxDebtPerBlockMultiplier == 0` after a with-loss liquidation
+ * - `poolDebtLimit` — pool-wide debt cap; used on account-opening only
+ **/
+type BorrowLimitCause = "poolAvailableLiquidity" | "managerDebtAvailable" | "maxDebt" | "debtPerBlockLimit" | "poolDebtLimit";
+/**
+ * The credit manager is paused and takes no multicall at all.
+ **/
+interface CreditManagerPausedError extends IGearboxError {
+  code: "creditManagerPaused";
+  creditManager: Address;
+}
+/** {@inheritDoc CreditManagerPausedError} */
+declare function creditManagerPaused(creditManager: Address): CreditManagerPausedError;
+/**
+ * The pool is paused: it neither takes deposits nor serves withdrawals.
+ **/
+interface PoolPausedError extends IGearboxError {
+  code: "poolPaused";
+  pool: Address;
+}
+/** {@inheritDoc PoolPausedError} */
+declare function poolPaused(pool: Address): PoolPausedError;
+/**
+ * The facade is past its expiration date and takes no more multicalls.
+ **/
+interface MarketExpiredError extends IGearboxError {
+  code: "marketExpired";
+  creditManager: Address;
+  /** Unix seconds, as the facade reports it. */
+  expirationDate: number;
+}
+/** {@inheritDoc MarketExpiredError} */
+declare function marketExpired(creditManager: Address, expirationDate: number): MarketExpiredError;
+/**
+ * The pool is winding down: it still serves withdrawals, but takes no more deposits.
+ **/
+interface PoolSunsetError extends IGearboxError {
+  code: "poolSunset";
+  pool: Address;
+}
+/** {@inheritDoc PoolSunsetError} */
+declare function poolSunset(pool: Address): PoolSunsetError;
+/**
+ * The pool cannot lend what the operation asks for.
+ **/
+interface InsufficientPoolLiquidityError extends IGearboxError {
+  code: "insufficientPoolLiquidity";
+  /** Both in the market's underlying. */
+  requested: TokenAmount;
+  available: TokenAmount;
+  /**
+   * Which limit ran out. See {@link BorrowLimitCause}.
+   **/
+  limit: BorrowLimitCause;
+  /**
+   * Largest debt a new position can still take, omitted when even `minDebt`
+   * does not fit.
+   **/
+  maxBorrowAmount?: TokenAmount;
+}
+/** {@inheritDoc InsufficientPoolLiquidityError} */
+declare function insufficientPoolLiquidity(args: Omit<InsufficientPoolLiquidityError, "code" | "message">): InsufficientPoolLiquidityError;
+/**
+ * The debt the operation implies falls outside the facade's `debtLimits`
+ * (`minDebt`/`maxDebt`).
+ **/
+interface DebtOutOfRangeError extends IGearboxError {
+  code: "debtOutOfRange";
+  /** All three in the market's underlying. */
+  requested: TokenAmount;
+  minDebt: TokenAmount;
+  maxDebt: TokenAmount;
+}
+/** {@inheritDoc DebtOutOfRangeError} */
+declare function debtOutOfRange(args: Omit<DebtOutOfRangeError, "code" | "message">): DebtOutOfRangeError;
+/**
+ * The leverage asked for cannot be expressed as a plan at all.
+ **/
+interface LeverageOutOfRangeError extends IGearboxError {
+  code: "leverageOutOfRange";
+  /**
+   * Scaled by `LEVERAGE_DECIMALS` (`100n` = 1x), as the intent states it — not
+   * the read model's `Leverage`. Both are absent where the floor is not fixed:
+   * the deposit planner's is a function of the deposit.
+   **/
+  requested?: bigint;
+  min?: bigint;
+}
+/** {@inheritDoc LeverageOutOfRangeError} */
+declare function leverageOutOfRange(args?: Omit<LeverageOutOfRangeError, "code" | "message">): LeverageOutOfRangeError;
+/**
+ * The account would end the operation owing more than its collateral is worth
+ * under liquidation thresholds, which the facade refuses to allow.
+ **/
+interface InsufficientCollateralError extends IGearboxError {
+  code: "insufficientCollateral";
+  /**
+   * The factor that was compared, which for a call that hands funds over is
+   * the safe-price one; `safePrices` says which, since a projection always
+   * reports main prices.
+   **/
+  healthFactor: Bps;
+  /**
+   * The threshold it was weighed against — the facade's own `1.0` for a check
+   * that asks whether the transaction lands, a form's higher threshold for one
+   * that asks whether it is wise.
+   **/
+  healthFactorThreshold: Bps;
+  safePrices: boolean;
+}
+/** {@inheritDoc InsufficientCollateralError} */
+declare function insufficientCollateral(args: Omit<InsufficientCollateralError, "code" | "message">): InsufficientCollateralError;
+/**
+ * The operation would increase the balance of a token the market forbids.
+ **/
+interface ForbiddenTokenError extends IGearboxError {
+  code: "forbiddenToken";
+  token: Token;
+}
+/** {@inheritDoc ForbiddenTokenError} */
+declare function forbiddenToken(token: Token): ForbiddenTokenError;
+/**
+ * The market takes no more quota for a token the operation wants to hold.
+ **/
+interface QuotaLimitReachedError extends IGearboxError {
+  code: "quotaLimitReached";
+  /** The token whose quota is asked for. */
+  token: Token;
+  /**
+   * In the **underlying**, which is what a quota is measured in. Absent for a
+   * token the market opened no quota for at all — nothing was weighed against
+   * a limit, the token simply counts as no collateral.
+   **/
+  requested: TokenAmount | undefined;
+  available: TokenAmount;
+}
+/** {@inheritDoc QuotaLimitReachedError} */
+declare function quotaLimitReached(args: Omit<QuotaLimitReachedError, "code" | "message">): QuotaLimitReachedError;
+/**
+ * The account would end up with more quoted tokens than the facade enables at
+ * once. A count, not an amount — unlike {@link QuotaLimitReachedError}.
+ **/
+interface QuotaCountExceededError extends IGearboxError {
+  code: "quotaCountExceeded";
+  count: number;
+  max: number;
+}
+/** {@inheritDoc QuotaCountExceededError} */
+declare function quotaCountExceeded(count: number, max: number): QuotaCountExceededError;
+/**
+ * A balance is too small to fund the operation's step.
+ *
+ * One error for both sides of the question, since both state the same fact —
+ * holder H lacks amount X of token T — and differ only in whose balance is
+ * short.
+ **/
+interface InsufficientBalanceError extends IGearboxError {
+  code: "insufficientBalance";
+  /**
+   * Both absent where the operation was refused before any pair of amounts
+   * existed, which is most of the sites that raise this. The `message` carries
+   * the explanation in that case.
+   **/
+  required?: TokenAmount;
+  held?: TokenAmount;
+  /** Who is short of funds. Absent when planning never resolved one. */
+  holderKind?: "wallet" | "creditAccount";
+  /** The address short of funds, when known. */
+  holder?: Address;
+}
+/** {@inheritDoc InsufficientBalanceError} */
+declare function insufficientBalance(args?: Omit<InsufficientBalanceError, "code" | "message">): InsufficientBalanceError;
+/**
+ * `owner` has not approved `spender` for what the operation pulls.
+ **/
+interface InsufficientAllowanceError extends IGearboxError {
+  code: "insufficientAllowance";
+  owner: Address;
+  spender: Address;
+  /** The token rides inside, as on {@link InsufficientBalanceError}. */
+  required: TokenAmount;
+  /** What is approved today. */
+  allowed: TokenAmount;
+}
+/** {@inheritDoc InsufficientAllowanceError} */
+declare function insufficientAllowance(args: Omit<InsufficientAllowanceError, "code" | "message">): InsufficientAllowanceError;
+/**
+ * The RWA factory still wants something from the borrower before this token
+ * can be opened on.
+ **/
+interface RWAOpenRequirementsError extends IGearboxError {
+  code: "rwaOpenRequirementsNotMet";
+  token: Token;
+  creditManager: Address;
+  factory: Address;
+  /** Always present on the error. */
+  requirements: RWAOpenAccountRequirements;
+  /** Absent when only issuer-side registration is pending. */
+  missing?: RWAMissingOpenAccountRequirements;
+}
+/** {@inheritDoc RWAOpenRequirementsError} */
+declare function rwaOpenRequirementsNotMet(args: Omit<RWAOpenRequirementsError, "code" | "message">): RWAOpenRequirementsError;
+//#endregion
+export { BorrowLimitCause, CreditManagerPausedError, DebtOutOfRangeError, ForbiddenTokenError, InsufficientAllowanceError, InsufficientBalanceError, InsufficientCollateralError, InsufficientPoolLiquidityError, LeverageOutOfRangeError, MarketExpiredError, PoolPausedError, PoolSunsetError, QuotaCountExceededError, QuotaLimitReachedError, RWAOpenRequirementsError, creditManagerPaused, debtOutOfRange, forbiddenToken, insufficientAllowance, insufficientBalance, insufficientCollateral, insufficientPoolLiquidity, leverageOutOfRange, marketExpired, poolPaused, poolSunset, quotaCountExceeded, quotaLimitReached, rwaOpenRequirementsNotMet };

package/dist/types/{onchain/market/oracle/errors.d.ts → model/errors/oracle-errors.d.ts}

@@ -1,10 +1,8 @@
-import { IGearboxError } from "../../../model/errors.js";
+import { IGearboxError } from "./base.js";
 import { Address } from "viem";
-//#region src/onchain/market/oracle/errors.d.ts
+//#region src/model/errors/oracle-errors.d.ts
 /**
- * The oracle has no price for `token`. Preview callers attach this with
- * `warning ??=` so a malformed-transaction warning already recorded keeps
- * precedence.
+ * The oracle has no price for token
  **/
 interface UnpriceableTokenError extends IGearboxError {
   code: "unpriceableToken";

package/dist/types/model/errors/prepare-errors.d.ts

@@ -0,0 +1,131 @@
+import { Token, TokenAmount } from "../primitives.js";
+import { IGearboxError } from "./base.js";
+import { Address } from "viem";
+//#region src/model/errors/prepare-errors.d.ts
+/**
+ * Input token is not accepted by the flow (e.g. deposit of a non-underlying).
+ **/
+interface UnsupportedCollateralTokenError extends IGearboxError {
+  code: "unsupportedCollateralToken";
+  token: Token;
+}
+/** {@inheritDoc UnsupportedCollateralTokenError} */
+declare function unsupportedCollateralToken(token: Token): UnsupportedCollateralTokenError;
+/**
+ * No route for the trade the plan needs: no pool pair between the tokens,
+ * several and none was picked, or the pathfinder found no path.
+ **/
+interface UnsupportedTokenPairError extends IGearboxError {
+  code: "unsupportedTokenPair";
+  /**
+   * `to` is absent where the market named no output for `from`; both are absent
+   * when the pathfinder reverted rather than answered.
+   **/
+  from?: Token;
+  to?: Token;
+}
+/** {@inheritDoc UnsupportedTokenPairError} */
+declare function unsupportedTokenPair(args?: Omit<UnsupportedTokenPairError, "code" | "message">): UnsupportedTokenPairError;
+/**
+ * The intent cannot settle with a delay: the source has no redemption config,
+ * the chain has no compressor, or the tail cannot serve the token asked for.
+ **/
+interface NoDelayedRouteError extends IGearboxError {
+  code: "noDelayedRoute";
+  /** Absent where the error is the intent's, not the token's. */
+  token?: Token;
+}
+/** {@inheritDoc NoDelayedRouteError} */
+declare function noDelayedRoute(token?: Token): NoDelayedRouteError;
+/** Several redemption venues for the source, and nothing says which. */
+interface MultipleDelayedWithdrawalsError extends IGearboxError {
+  code: "multipleDelayedWithdrawals";
+  token: Token;
+  venues: number;
+}
+/** {@inheritDoc MultipleDelayedWithdrawalsError} */
+declare function multipleDelayedWithdrawals(token: Token, venues: number): MultipleDelayedWithdrawalsError;
+/** A redemption of the same asset is already in flight. */
+interface WithdrawalInProgressError extends IGearboxError {
+  code: "withdrawalInProgress";
+  /** The phantom token standing for the redemption already in flight. */
+  inFlight: TokenAmount;
+}
+/** {@inheritDoc WithdrawalInProgressError} */
+declare function withdrawalInProgress(inFlight: TokenAmount): WithdrawalInProgressError;
+/**
+ * The claim names no operation to resume: requested without an intent, or read
+ * through a compressor too old to report one.
+ **/
+interface NoRecordedIntentError extends IGearboxError {
+  code: "noRecordedIntent";
+}
+/** {@inheritDoc NoRecordedIntentError} */
+declare function noRecordedIntent(): NoRecordedIntentError;
+/**
+ * Opening asked for no target token and the market names none of its own, so
+ * there is nothing to put the position into.
+ *
+ * A market fact, not a bad argument: pass a `targetToken` to open against a
+ * manager that has no default one.
+ **/
+interface NoStrategyTargetCollateralError extends IGearboxError {
+  code: "noStrategyTargetCollateral";
+  creditManager: Address;
+}
+/** {@inheritDoc NoStrategyTargetCollateralError} */
+declare function noStrategyTargetCollateral(creditManager: Address): NoStrategyTargetCollateralError;
+/**
+ * No account at that address in the markets this SDK is connected to — closed
+ * since it was listed, or read on the wrong chain.
+ **/
+interface CreditAccountNotFoundError extends IGearboxError {
+  code: "creditAccountNotFound";
+  creditAccount: Address;
+}
+/** {@inheritDoc CreditAccountNotFoundError} */
+declare function creditAccountNotFound(creditAccount: Address): CreditAccountNotFoundError;
+/**
+ * The account named to open a position on carries debt or quotas.
+ *
+ * Growing a position that already exists is `depositStrategy`.
+ **/
+interface CreditAccountNotEmptyError extends IGearboxError {
+  code: "creditAccountNotEmpty";
+  creditAccount: Address;
+}
+/** {@inheritDoc CreditAccountNotEmptyError} */
+declare function creditAccountNotEmpty(creditAccount: Address): CreditAccountNotEmptyError;
+/**
+ * An empty opening was asked for with something to open it with: collateral to
+ * spend, an account to reuse, or a leverage to reach.
+ **/
+interface EmptyOpenTakesNothingError extends IGearboxError {
+  code: "emptyOpenTakesNothing";
+}
+/** {@inheritDoc EmptyOpenTakesNothingError} */
+declare function emptyOpenTakesNothing(): EmptyOpenTakesNothingError;
+/**
+ * The SDK could not answer at all: a read that failed, a chain it is not
+ * connected to, a market or token address it knows nothing about, a contract
+ * that reverted where nothing should, a bug of ours.
+ *
+ * The one code that is not a verdict on the request — everything above says
+ * "this cannot be done", this one says "we do not know". It exists so that a
+ * prepare method or a check always answers: what used to escape as an
+ * exception arrives here instead, whole, under `cause`.
+ **/
+interface UnexpectedFailureError extends IGearboxError {
+  code: "unexpectedFailure";
+  /** What actually went wrong, for a log and a bug report. */
+  cause: Error;
+}
+/**
+ * {@inheritDoc UnexpectedFailureError}
+ *
+ * Takes what was thrown, whatever that is: a `throw` is not obliged to raise an
+ * `Error`, and `cause` promises one.
+ **/
+declare function unexpectedFailure(thrown: unknown, action?: string): UnexpectedFailureError;
+//#endregion
+export { CreditAccountNotEmptyError, CreditAccountNotFoundError, EmptyOpenTakesNothingError, MultipleDelayedWithdrawalsError, NoDelayedRouteError, NoRecordedIntentError, NoStrategyTargetCollateralError, UnexpectedFailureError, UnsupportedCollateralTokenError, UnsupportedTokenPairError, WithdrawalInProgressError, creditAccountNotEmpty, creditAccountNotFound, emptyOpenTakesNothing, multipleDelayedWithdrawals, noDelayedRoute, noRecordedIntent, noStrategyTargetCollateral, unexpectedFailure, unsupportedCollateralToken, unsupportedTokenPair, withdrawalInProgress };

package/dist/types/model/errors/preview-errors.d.ts

@@ -0,0 +1,72 @@
+import { IGearboxError } from "./base.js";
+import { Address, Hex } from "viem";
+//#region src/model/errors/preview-errors.d.ts
+/**
+ * Target of a transaction is not a known Gearbox contract
+ * (pool/facade/etc.)
+ */
+interface UnsupportedTargetError extends IGearboxError {
+  code: "unsupportedTarget";
+  /** Target address no known Gearbox contract answers for. */
+  target: Address;
+}
+/**
+ * Pool call uses a function other than ERC4626 `deposit`/`redeem`.
+ */
+interface UnsupportedPoolFunctionError extends IGearboxError {
+  code: "unsupportedPoolFunction";
+  /** Pool the call targets. */
+  pool: Address;
+  /** Decoded function name the SDK cannot preview. */
+  functionName: string;
+}
+/**
+ * Zapper call uses a function other than a known `deposit`/`redeem` variant.
+ */
+interface UnsupportedZapperFunctionError extends IGearboxError {
+  code: "unsupportedZapperFunction";
+  /** Zapper contract the call targets. */
+  zapper: Address;
+  /** Decoded function name the SDK cannot preview. */
+  functionName: string;
+}
+/**
+ * Refusal answered by `previewOperation` for parsed operations it cannot
+ * preview yet.
+ */
+interface UnsupportedOperationError extends IGearboxError {
+  code: "unsupportedOperation";
+  /** The parsed operation kind (the `operation` discriminant). */
+  operation: string;
+}
+/**
+ * Delayed-withdrawal request or redemption log carries
+ * non-empty `extraData` that cannot be decoded as a `DelayedIntent`.
+ */
+interface InvalidDelayedIntentError extends IGearboxError {
+  code: "invalidDelayedIntent";
+  /** Raw `extraData` that failed to decode. */
+  extraData: Hex;
+  /** The decoding failure this refusal stands in front of. */
+  cause?: Error;
+}
+/**
+ * Pool operation preview read (ERC4626 preview/`balanceOf`) fails.
+ */
+interface PoolOperationPreviewError extends IGearboxError {
+  code: "poolOperationPreviewError";
+  /** Pool the operation targeted. */
+  pool: Address;
+}
+/**
+ * The transaction could not be replayed: it is malformed.
+ * Facade multicalls theoretically allow many more combinations of calls,
+ * but sdk generates and parses only certain combinations.
+ */
+interface MalformedTransactionError extends IGearboxError {
+  code: "malformedTransaction";
+}
+/** {@inheritDoc MalformedTransactionError} */
+declare function malformedTransaction(detail: string, cause?: Error): MalformedTransactionError;
+//#endregion
+export { InvalidDelayedIntentError, MalformedTransactionError, PoolOperationPreviewError, UnsupportedOperationError, UnsupportedPoolFunctionError, UnsupportedTargetError, UnsupportedZapperFunctionError, malformedTransaction };

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

@@ -1,12 +1,19 @@
 import { Amount, Asset, AssetType, Bps, ChainId, Leverage, Timestamp, Token, TokenAmount, TxCall, UnderlyingToken } 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, PROTOCOL_CHART_METRICS, PoolOpportunityChartMetric, PoolPositionChartMetric, PositionChartMetric, ProtocolChartMetric, STRATEGY_OPPORTUNITY_CHART_METRICS, STRATEGY_POSITION_CHART_METRICS, StrategyOpportunityChartMetric, StrategyPositionChartMetric } from "./charts.js";
 import { ChainScopedFilter, FILTER_ALL, FilterAll, Filterable, isFilterSet } from "./filters.js";
-import { IGearboxError } from "./errors.js";
 import { Curator, CuratorName } from "./curators.js";
 import { DelayedAddCollateralIntent, DelayedCloseAccountIntent, DelayedDecreaseLeverageIntent, DelayedDepositAndIncreaseLeverageIntent, DelayedDepositIntent, DelayedIncreaseLeverageIntent, DelayedIntent, DelayedWithdrawCollateralIntent } from "./delayed-intents.js";
+import { IGearboxError } from "./errors/base.js";
+import { CreditAccountFrozenError, LiquidatorNotEligibleError, NotEmergencyLiquidatorError, creditAccountFrozen, liquidatorNotEligible, notEmergencyLiquidator } from "./errors/liquidation-errors.js";
+import { RWAFactoryType, RWAMissingOpenAccountRequirements, RWAOpenAccountRequirements, RWAOperationArgs, RWA_FACTORY_SECURITIZE, RWA_FACTORY_TYPES, SECURITIZE_REGISTER_VAULT_TYPES, SecuritizeMissingOpenAccountRequirements, SecuritizeOpenAccountRequirements, SecuritizeOperationArgs, SecuritizeRegisterMessage, SecuritizeRegisterVaultMessage, SecuritizeSignature } from "./rwa.js";
+import { BorrowLimitCause, CreditManagerPausedError, DebtOutOfRangeError, ForbiddenTokenError, InsufficientAllowanceError, InsufficientBalanceError, InsufficientCollateralError, InsufficientPoolLiquidityError, LeverageOutOfRangeError, MarketExpiredError, PoolPausedError, PoolSunsetError, QuotaCountExceededError, QuotaLimitReachedError, RWAOpenRequirementsError, creditManagerPaused, debtOutOfRange, forbiddenToken, insufficientAllowance, insufficientBalance, insufficientCollateral, insufficientPoolLiquidity, leverageOutOfRange, marketExpired, poolPaused, poolSunset, quotaCountExceeded, quotaLimitReached, rwaOpenRequirementsNotMet } from "./errors/operation-errors.js";
+import { UnpriceableTokenError, unpriceableTokenError } from "./errors/oracle-errors.js";
+import { CreditAccountNotEmptyError, CreditAccountNotFoundError, EmptyOpenTakesNothingError, MultipleDelayedWithdrawalsError, NoDelayedRouteError, NoRecordedIntentError, NoStrategyTargetCollateralError, UnexpectedFailureError, UnsupportedCollateralTokenError, UnsupportedTokenPairError, WithdrawalInProgressError, creditAccountNotEmpty, creditAccountNotFound, emptyOpenTakesNothing, multipleDelayedWithdrawals, noDelayedRoute, noRecordedIntent, noStrategyTargetCollateral, unexpectedFailure, unsupportedCollateralToken, unsupportedTokenPair, withdrawalInProgress } from "./errors/prepare-errors.js";
+import { InvalidDelayedIntentError, MalformedTransactionError, PoolOperationPreviewError, UnsupportedOperationError, UnsupportedPoolFunctionError, UnsupportedTargetError, UnsupportedZapperFunctionError, malformedTransaction } from "./errors/preview-errors.js";
+import "./errors/index.js";
 import { ApyBreakdown, Opportunity, OpportunityBase, OpportunityDetail, OpportunityFilter, OpportunityId, OpportunityKey, OpportunityKind, OpportunityTotals, 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, STRATEGY_POSITION_COLLATERAL_ERROR, StrategyPosition, StrategyPositionKey, StrategyPositionRef, TokenQuotaRate, TokenRewardsPnL, liquidationPositionId, matchesPositionFilter, poolPositionId, positionId, strategyPositionId } from "./positions.js";
-import { AccountHoldings, AccountMetrics, AccountProjection, AccountStateChange, AdapterCallOutsideBracketError, AdjustStrategyPositionPreview, CreditOperationMarket, DelayedStrategyPositionOperationPreview, Estimated, EstimatedProjection, ExitStrategyPositionPreview, InstantStrategyPositionOperationPreview, InvalidTransactionValueError, MalformedBracketError, MalformedBracketKind, MalformedPreviewError, NonAdapterCallInBracketError, OpenStrategyPositionPreview, OperationPreview, OperationPreviewError, PoolOperationType, PoolPositionOperationPreview, PreviewOperationInput, PreviewOperationOptions, RepayStrategyPositionPreview, RoutedField, UnpreviewableAdapterCallError, UnsupportedOutOfBracketCallError, asEstimated } from "./previews.js";
+import { AccountHoldings, AccountMetrics, AccountProjection, AccountStateChange, AdjustStrategyPositionPreview, CreditOperationMarket, DelayedStrategyPositionOperationPreview, Estimated, EstimatedProjection, ExitStrategyPositionPreview, InstantStrategyPositionOperationPreview, OpenNonRWAStrategyPositionPreview, OpenRWAStrategyPositionPreview, OpenStrategyPositionPreview, OperationPreview, PoolOperationType, PoolPositionOperationPreview, PreviewOperationInput, PreviewOperationOptions, RepayStrategyPositionPreview, RoutedField, asEstimated } from "./previews.js";
 import { DelayedReceivedAsset, InstantReceivedAsset, LiquidatableAccount, LiquidatableAccountFilter, LiquidationApproval, LiquidationDetails, LiquidationPosition, ReceivedAsset, matchesLiquidatableAccountFilter } from "./liquidations.js";
 import { AnalyticsChartQuery, AnalyticsLiquidationPosition, AnalyticsPoolPosition, AnalyticsPosition, AnalyticsPositionListOptions, AnalyticsPositionOwner, AnalyticsPositionPage, AnalyticsPositionSortField, AnalyticsSortDirection, AnalyticsStrategyPosition } from "./analytics.js";
 import { ANALYTICS_POSITIONS_DEFAULT_LIMIT, ANALYTICS_POSITIONS_MAX_LIMIT, analyticsChartQueryOptionsSchema, analyticsChartQueryParamsSchema, analyticsChartQuerySchema, analyticsPositionListOptionsSchema, analyticsPositionListQueryParamsSchema, analyticsPositionListQuerySchema, analyticsPositionPageSchema, analyticsPositionSchema, analyticsPositionSortFieldSchema, analyticsSortDirectionSchema } from "./analytics.schema.js";
@@ -22,7 +29,7 @@ import { borrowRateBreakdownSchema, pnlBreakdownSchema, pointsProgramPnLSchema,
 import { amountSchema, assetTypeSchema, bpsSchema, chainIdSchema, leverageSchema, timestampSchema, tokenAmountSchema, tokenSchema, txCallSchema, underlyingTokenSchema } 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";
-import { SDKError, SDKResult, SDKReturn, SafeValue, isSDKError, safeValue, sdkErr, sdkOk } from "./result.js";
+import { SDKError, SDKResult, SDKReturn, SafeValue, safeValue, sdkErr, sdkOk } from "./result.js";
 import { PositionClaimableWithdrawal, PositionPendingWithdrawal, PositionWithdrawals, WithdrawalOutputAmount } from "./withdrawals.js";
 import { positionClaimableWithdrawalSchema, positionPendingWithdrawalSchema, positionWithdrawalsSchema, withdrawalOutputAmountSchema } from "./withdrawals.schema.js";
-export { ANALYTICS_POSITIONS_DEFAULT_LIMIT, ANALYTICS_POSITIONS_MAX_LIMIT, AccountHoldings, AccountMetrics, AccountProjection, AccountStateChange, AdapterCallOutsideBracketError, AdjustStrategyPositionPreview, Amount, AnalyticsChartQuery, AnalyticsLiquidationPosition, AnalyticsPoolPosition, AnalyticsPosition, AnalyticsPositionListOptions, AnalyticsPositionOwner, AnalyticsPositionPage, AnalyticsPositionSortField, AnalyticsSortDirection, AnalyticsStrategyPosition, 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, CompareTag, CompareTolerance, CreditOperationMarket, Curator, CuratorName, DataResponse, DataSource, DelayedAddCollateralIntent, DelayedCloseAccountIntent, DelayedDecreaseLeverageIntent, DelayedDepositAndIncreaseLeverageIntent, DelayedDepositIntent, DelayedIncreaseLeverageIntent, DelayedIntent, DelayedReceivedAsset, DelayedStrategyPositionOperationPreview, DelayedWithdrawCollateralIntent, Estimated, EstimatedProjection, ExitStrategyPositionPreview, FILTER_ALL, FilterAll, Filterable, GridSampling, IGearboxError, InstantReceivedAsset, InstantStrategyPositionOperationPreview, InvalidTransactionValueError, Leverage, LiquidatableAccount, LiquidatableAccountFilter, LiquidationApproval, LiquidationDetails, LiquidationPosition, MalformedBracketError, MalformedBracketKind, MalformedPreviewError, NonAdapterCallInBracketError, Notice, NoticeKind, NoticeSubject, OpenStrategyPositionPreview, OperationPreview, OperationPreviewError, Opportunity, OpportunityBase, OpportunityChartMetric, OpportunityDetail, OpportunityFilter, OpportunityId, OpportunityKey, OpportunityKind, OpportunityTotals, POOL_OPPORTUNITY_CHART_METRICS, POOL_POSITION_CHART_METRICS, PROTOCOL_CHART_METRICS, PnlBreakdown, PointRewards, PointsProgram, PointsProgramPnL, PointsRewardsPnL, PoolOperationType, PoolOpportunity, PoolOpportunityChartMetric, PoolOpportunityDetail, PoolOpportunityKey, PoolOpportunityRef, PoolPosition, PoolPositionChartMetric, PoolPositionKey, PoolPositionOperationPreview, PoolPositionRef, Position, PositionChartMetric, PositionClaimableWithdrawal, PositionCollateral, PositionFilter, PositionId, PositionKey, PositionKind, PositionPendingWithdrawal, PositionTransaction, PositionTransactionKind, PositionWithdrawals, PositionsTotals, PreviewOperationInput, PreviewOperationOptions, PriceFeedData, PriceFeedSummary, ProtocolChartMetric, QuotaAsset, RateCurve, RateCurvePoint, ReceivedAsset, RepayStrategyPositionPreview, ResponseMetadata, Rewards, RewardsPnL, RoutedField, SDKError, SDKResult, SDKReturn, STRATEGY_OPPORTUNITY_CHART_METRICS, STRATEGY_POSITION_CHART_METRICS, STRATEGY_POSITION_COLLATERAL_ERROR, SafeValue, StrategyOpportunity, StrategyOpportunityChartMetric, StrategyOpportunityDetail, StrategyOpportunityKey, StrategyOpportunityRef, StrategyPosition, StrategyPositionChartMetric, StrategyPositionKey, StrategyPositionRef, Timestamp, Token, TokenAmount, TokenQuotaRate, TokenRewards, TokenRewardsPnL, ToleranceCompareTag, TxCall, UnderlyingToken, UnpreviewableAdapterCallError, UnsupportedOutOfBracketCallError, WithdrawalOutputAmount, amountSchema, analyticsChartQueryOptionsSchema, analyticsChartQueryParamsSchema, analyticsChartQuerySchema, analyticsPositionListOptionsSchema, analyticsPositionListQueryParamsSchema, analyticsPositionListQuerySchema, analyticsPositionPageSchema, analyticsPositionSchema, analyticsPositionSortFieldSchema, analyticsSortDirectionSchema, apyBreakdownSchema, asEstimated, assetTypeSchema, backendPreferred, 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, isSDKError, leverageSchema, liquidatableAccountFilterSchema, liquidatableAccountSchema, liquidationApprovalSchema, liquidationDetailsSchema, liquidationPositionId, liquidationPositionSchema, matchesLiquidatableAccountFilter, matchesOpportunityFilter, matchesPositionFilter, noticeKindSchema, noticeSchema, offchainOnly, onchainOnly, opportunityBaseSchema, opportunityDetailSchema, opportunityFilterQueryParamsSchema, opportunityFilterQuerySchema, opportunityFilterSchema, opportunityId, opportunityKeySchema, opportunityKindSchema, opportunitySchema, opportunityTotalsSchema, pnlBreakdownSchema, pointRewardsSchema, pointsProgramPnLSchema, pointsProgramSchema, pointsRewardsPnLSchema, poolOpportunityChartMetricSchema, poolOpportunityDetailSchema, poolOpportunityId, poolOpportunityKeySchema, poolOpportunitySchema, poolPositionChartMetricSchema, poolPositionId, poolPositionKeySchema, poolPositionSchema, positionClaimableWithdrawalSchema, positionCollateralSchema, positionFilterQueryParamsSchema, positionFilterQuerySchema, positionFilterSchema, positionId, positionKeySchema, positionKindSchema, positionPendingWithdrawalSchema, positionSchema, positionTransactionKindSchema, positionTransactionSchema, positionWithdrawalsSchema, positionsTotalsSchema, priceFeedDataSchema, priceFeedSummarySchema, protocolChartMetricSchema, quotaAssetSchema, rateCurvePointSchema, rateCurveSchema, receivedAssetSchema, responseMetadataSchema, responseSchema, rewardsPnLSchema, rewardsSchema, safeValue, sdkErr, sdkOk, strategyOpportunityChartMetricSchema, strategyOpportunityDetailSchema, strategyOpportunityId, strategyOpportunityKeySchema, strategyOpportunitySchema, strategyPositionChartMetricSchema, strategyPositionId, strategyPositionKeySchema, strategyPositionSchema, timestampSchema, tokenAmountSchema, tokenQuotaRateSchema, tokenRewardsPnLSchema, tokenRewardsSchema, tokenSchema, tolerance, txCallSchema, underlyingTokenSchema, withdrawalOutputAmountSchema };
+export { ANALYTICS_POSITIONS_DEFAULT_LIMIT, ANALYTICS_POSITIONS_MAX_LIMIT, AccountHoldings, AccountMetrics, AccountProjection, AccountStateChange, AdjustStrategyPositionPreview, Amount, AnalyticsChartQuery, AnalyticsLiquidationPosition, AnalyticsPoolPosition, AnalyticsPosition, AnalyticsPositionListOptions, AnalyticsPositionOwner, AnalyticsPositionPage, AnalyticsPositionSortField, AnalyticsSortDirection, AnalyticsStrategyPosition, ApyBreakdown, Asset, AssetType, BorrowLimitCause, 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, CompareTag, CompareTolerance, CreditAccountFrozenError, CreditAccountNotEmptyError, CreditAccountNotFoundError, CreditManagerPausedError, CreditOperationMarket, Curator, CuratorName, DataResponse, DataSource, DebtOutOfRangeError, DelayedAddCollateralIntent, DelayedCloseAccountIntent, DelayedDecreaseLeverageIntent, DelayedDepositAndIncreaseLeverageIntent, DelayedDepositIntent, DelayedIncreaseLeverageIntent, DelayedIntent, DelayedReceivedAsset, DelayedStrategyPositionOperationPreview, DelayedWithdrawCollateralIntent, EmptyOpenTakesNothingError, Estimated, EstimatedProjection, ExitStrategyPositionPreview, FILTER_ALL, FilterAll, Filterable, ForbiddenTokenError, GridSampling, IGearboxError, InstantReceivedAsset, InstantStrategyPositionOperationPreview, InsufficientAllowanceError, InsufficientBalanceError, InsufficientCollateralError, InsufficientPoolLiquidityError, InvalidDelayedIntentError, Leverage, LeverageOutOfRangeError, LiquidatableAccount, LiquidatableAccountFilter, LiquidationApproval, LiquidationDetails, LiquidationPosition, LiquidatorNotEligibleError, MalformedTransactionError, MarketExpiredError, MultipleDelayedWithdrawalsError, NoDelayedRouteError, NoRecordedIntentError, NoStrategyTargetCollateralError, NotEmergencyLiquidatorError, Notice, NoticeKind, NoticeSubject, OpenNonRWAStrategyPositionPreview, OpenRWAStrategyPositionPreview, OpenStrategyPositionPreview, OperationPreview, Opportunity, OpportunityBase, OpportunityChartMetric, OpportunityDetail, OpportunityFilter, OpportunityId, OpportunityKey, OpportunityKind, OpportunityTotals, POOL_OPPORTUNITY_CHART_METRICS, POOL_POSITION_CHART_METRICS, PROTOCOL_CHART_METRICS, PnlBreakdown, PointRewards, PointsProgram, PointsProgramPnL, PointsRewardsPnL, PoolOperationPreviewError, PoolOperationType, PoolOpportunity, PoolOpportunityChartMetric, PoolOpportunityDetail, PoolOpportunityKey, PoolOpportunityRef, PoolPausedError, PoolPosition, PoolPositionChartMetric, PoolPositionKey, PoolPositionOperationPreview, PoolPositionRef, PoolSunsetError, Position, PositionChartMetric, PositionClaimableWithdrawal, PositionCollateral, PositionFilter, PositionId, PositionKey, PositionKind, PositionPendingWithdrawal, PositionTransaction, PositionTransactionKind, PositionWithdrawals, PositionsTotals, PreviewOperationInput, PreviewOperationOptions, PriceFeedData, PriceFeedSummary, ProtocolChartMetric, QuotaAsset, QuotaCountExceededError, QuotaLimitReachedError, RWAFactoryType, RWAMissingOpenAccountRequirements, RWAOpenAccountRequirements, RWAOpenRequirementsError, RWAOperationArgs, RWA_FACTORY_SECURITIZE, RWA_FACTORY_TYPES, RateCurve, RateCurvePoint, ReceivedAsset, RepayStrategyPositionPreview, ResponseMetadata, Rewards, RewardsPnL, RoutedField, SDKError, SDKResult, SDKReturn, SECURITIZE_REGISTER_VAULT_TYPES, STRATEGY_OPPORTUNITY_CHART_METRICS, STRATEGY_POSITION_CHART_METRICS, STRATEGY_POSITION_COLLATERAL_ERROR, SafeValue, SecuritizeMissingOpenAccountRequirements, SecuritizeOpenAccountRequirements, SecuritizeOperationArgs, SecuritizeRegisterMessage, SecuritizeRegisterVaultMessage, SecuritizeSignature, StrategyOpportunity, StrategyOpportunityChartMetric, StrategyOpportunityDetail, StrategyOpportunityKey, StrategyOpportunityRef, StrategyPosition, StrategyPositionChartMetric, StrategyPositionKey, StrategyPositionRef, Timestamp, Token, TokenAmount, TokenQuotaRate, TokenRewards, TokenRewardsPnL, ToleranceCompareTag, TxCall, UnderlyingToken, UnexpectedFailureError, UnpriceableTokenError, UnsupportedCollateralTokenError, UnsupportedOperationError, UnsupportedPoolFunctionError, UnsupportedTargetError, UnsupportedTokenPairError, UnsupportedZapperFunctionError, WithdrawalInProgressError, WithdrawalOutputAmount, amountSchema, analyticsChartQueryOptionsSchema, analyticsChartQueryParamsSchema, analyticsChartQuerySchema, analyticsPositionListOptionsSchema, analyticsPositionListQueryParamsSchema, analyticsPositionListQuerySchema, analyticsPositionPageSchema, analyticsPositionSchema, analyticsPositionSortFieldSchema, analyticsSortDirectionSchema, apyBreakdownSchema, asEstimated, assetTypeSchema, backendPreferred, booleanParamSchema, borrowRateBreakdownSchema, bpsSchema, chainFailedSchema, chainIdSchema, chainMetadataSchema, chainSucceededSchema, chartBundleSchemaFor, chartDenominationSchema, chartMetricSchema, chartQueryCodec, chartQueryParamsSchema, chartQuerySchema, chartRangeSchema, chartSeriesSchema, chartValueSchema, chartWindowSchema, compareTagOf, creditAccountFrozen, creditAccountNotEmpty, creditAccountNotFound, creditManagerPaused, curatorNameSchema, curatorSchema, dataSourceSchema, debtOutOfRange, delayedReceivedAssetSchema, emptyOpenTakesNothing, encodeFlag, filterAllSchema, filterable, forbiddenToken, instantReceivedAssetSchema, insufficientAllowance, insufficientBalance, insufficientCollateral, insufficientPoolLiquidity, isFilterSet, leverageOutOfRange, leverageSchema, liquidatableAccountFilterSchema, liquidatableAccountSchema, liquidationApprovalSchema, liquidationDetailsSchema, liquidationPositionId, liquidationPositionSchema, liquidatorNotEligible, malformedTransaction, marketExpired, matchesLiquidatableAccountFilter, matchesOpportunityFilter, matchesPositionFilter, multipleDelayedWithdrawals, noDelayedRoute, noRecordedIntent, noStrategyTargetCollateral, notEmergencyLiquidator, noticeKindSchema, noticeSchema, offchainOnly, onchainOnly, opportunityBaseSchema, opportunityDetailSchema, opportunityFilterQueryParamsSchema, opportunityFilterQuerySchema, opportunityFilterSchema, opportunityId, opportunityKeySchema, opportunityKindSchema, opportunitySchema, opportunityTotalsSchema, pnlBreakdownSchema, pointRewardsSchema, pointsProgramPnLSchema, pointsProgramSchema, pointsRewardsPnLSchema, poolOpportunityChartMetricSchema, poolOpportunityDetailSchema, poolOpportunityId, poolOpportunityKeySchema, poolOpportunitySchema, poolPaused, poolPositionChartMetricSchema, poolPositionId, poolPositionKeySchema, poolPositionSchema, poolSunset, positionClaimableWithdrawalSchema, positionCollateralSchema, positionFilterQueryParamsSchema, positionFilterQuerySchema, positionFilterSchema, positionId, positionKeySchema, positionKindSchema, positionPendingWithdrawalSchema, positionSchema, positionTransactionKindSchema, positionTransactionSchema, positionWithdrawalsSchema, positionsTotalsSchema, priceFeedDataSchema, priceFeedSummarySchema, protocolChartMetricSchema, quotaAssetSchema, quotaCountExceeded, quotaLimitReached, rateCurvePointSchema, rateCurveSchema, receivedAssetSchema, responseMetadataSchema, responseSchema, rewardsPnLSchema, rewardsSchema, rwaOpenRequirementsNotMet, safeValue, sdkErr, sdkOk, strategyOpportunityChartMetricSchema, strategyOpportunityDetailSchema, strategyOpportunityId, strategyOpportunityKeySchema, strategyOpportunitySchema, strategyPositionChartMetricSchema, strategyPositionId, strategyPositionKeySchema, strategyPositionSchema, timestampSchema, tokenAmountSchema, tokenQuotaRateSchema, tokenRewardsPnLSchema, tokenRewardsSchema, tokenSchema, tolerance, txCallSchema, underlyingTokenSchema, unexpectedFailure, unpriceableTokenError, unsupportedCollateralToken, unsupportedTokenPair, withdrawalInProgress, withdrawalOutputAmountSchema };

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

@@ -38,7 +38,7 @@ interface PointsProgram {
   multiplier: number | null;
 }
 /**
- * Rewards paid out in a token, e.g. a liquidity mining program.
+ * Rewards in a token, e.g. a liquidity mining program.
  **/
 interface TokenRewards {
   kind: "token";
@@ -338,7 +338,8 @@ interface StrategyOpportunity extends OpportunityBase {
   /**
    * Largest debt a single new position can take on right now: the tightest of
    * the credit manager's remaining debt limit, the pool's free liquidity and
-   * the facade's per-account maximum.
+   * the facade's per-account `maxDebt`. Zero while borrowing is frozen
+   * (`maxDebtPerBlockMultiplier == 0`).
    **/
   maxBorrowAmount: Amount;
   /**

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

@@ -14,7 +14,7 @@ import { Address, Hex } from "viem";
  **/
 type PositionKind = "pool" | "strategy" | "liquidation";
 /**
- * Earnings paid out in a token, as an amount rather than a rate.
+ * Earnings in a token, as an amount rather than a rate.
  **/
 interface TokenRewardsPnL extends TokenAmount {
   kind: "token";
@@ -412,7 +412,7 @@ interface PositionFilter extends ChainScopedFilter {
  * A condition that does not apply to a position's kind keeps the row rather
  * than dropping it: `isZeroDebt` says nothing about a pool position, and
  * `underlyingType` says nothing about a liquidation position, which is
- * denominated in whatever its withdrawal pays out.
+ * denominated in whatever its withdrawal settles in.
  *
  * @param position - Row to test.
  * @param filter - Conditions to test against. An absent filter matches