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

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

@@ -1,8 +1,9 @@
 import { Bps, ChainId, Leverage, Timestamp, Token, TokenAmount, UnderlyingToken } from "./primitives.js";
-import { IGearboxError } from "./errors.js";
-import { UnpriceableTokenError } from "../onchain/market/oracle/errors.js";
 import { Curator } from "./curators.js";
 import { DelayedIntent } from "./delayed-intents.js";
+import { RWAOperationArgs } from "./rwa.js";
+import { UnpriceableTokenError } from "./errors/oracle-errors.js";
+import "./errors/index.js";
 import { BorrowRateBreakdown } from "./positions.js";
 import { Address, Hex } from "viem";
 //#region src/model/previews.d.ts
@@ -12,7 +13,6 @@ import { Address, Hex } from "viem";
 type PoolOperationType = "Deposit" | "Mint" | "Withdraw" | "Redeem";
 /**
  * Raw-calldata operation to preview: the chain and the transaction fields.
- * The on-chain SDK is resolved from {@link chainId} by the caller.
  **/
 interface PreviewOperationInput {
   /**
@@ -46,86 +46,6 @@ interface PreviewOperationOptions {
    **/
   blockNumber?: bigint;
 }
-/**
- * Which `storeExpectedBalances`/`compareBalances` invariant was broken.
- **/
-type MalformedBracketKind = "nested" | "unmatchedStore" | "unmatchedCompare";
-/**
- * Broken `storeExpectedBalances`/`compareBalances` bracket structure:
- * nested brackets, `compareBalances` without a preceding
- * `storeExpectedBalances`, or `storeExpectedBalances` without a matching
- * `compareBalances`. We expect transactions generated by the frontend
- * using the router/withdrawal compressor.
- **/
-interface MalformedBracketError extends IGearboxError {
-  code: "malformedBracket";
-  /** Which bracket invariant was broken. */
-  kind: MalformedBracketKind;
-}
-/**
- * Adapter call outside a `storeExpectedBalances`/`compareBalances` bracket.
- * We expect transactions generated by the frontend using the
- * router/withdrawal compressor.
- **/
-interface AdapterCallOutsideBracketError extends IGearboxError {
-  code: "adapterCallOutsideBracket";
-  /** Adapter the out-of-bracket call targeted. */
-  adapter: Address;
-}
-/**
- * Bracketed call whose target is not an adapter (or an adapter the SDK
- * does not know).
- **/
-interface NonAdapterCallInBracketError extends IGearboxError {
-  code: "nonAdapterCallInBracket";
-  /** Contract the bracketed call targeted. */
-  target: Address;
-}
-/**
- * Bracketed adapter call cannot be replayed (undecodable/unsupported
- * calldata).
- **/
-interface UnpreviewableAdapterCallError extends IGearboxError {
-  code: "unpreviewableAdapterCall";
-  /** Adapter whose calldata could not be replayed. */
-  adapter: Address;
-}
-/**
- * An out-of-bracket adapter call that is allowed there (e.g. RWA
- * wrap/unwrap) could not be decoded or replayed.
- **/
-interface UnsupportedOutOfBracketCallError extends IGearboxError {
-  code: "unsupportedOutOfBracketCall";
-  /** Adapter whose out-of-bracket call could not be replayed. */
-  adapter: Address;
-}
-/**
- * `msg.value` does not fit into the declared WETH collateral.
- * Transactions can have arbitrary value, but the ones the frontend
- * creates should have a value that fits into the declared WETH collateral.
- **/
-interface InvalidTransactionValueError extends IGearboxError {
-  code: "invalidTransactionValue";
-  /** Transaction `msg.value`. */
-  value: bigint;
-  /** WETH collateral declared by the multicall. */
-  wethCollateral: bigint;
-}
-/**
- * The transaction itself is malformed: fields derived from replayed
- * balances may be unreliable. `checkPreviewError` maps any of these to
- * `malformedTransaction`.
- **/
-type MalformedPreviewError = MalformedBracketError | AdapterCallOutsideBracketError | NonAdapterCallInBracketError | UnpreviewableAdapterCallError | UnsupportedOutOfBracketCallError | InvalidTransactionValueError;
-/**
- * Non-throwing preview caveat. When set on a preview, all fields are still
- * computed best-effort, but some of them may be unreliable.
- *
- * `MalformedPreviewError` means the transaction would not execute correctly
- * on-chain. {@link UnpriceableTokenError} means the transaction may be fine,
- * but the SDK could not fully evaluate the preview.
- **/
-type OperationPreviewError = MalformedPreviewError | UnpriceableTokenError;
 /**
  * What a pool transaction that already exists would do — the counterpart of
  * `prepare.deposit`, `prepare.withdraw` and `prepare.redeem`, read off calldata
@@ -137,6 +57,17 @@ interface PoolPositionOperationPreview {
    * Pool address
    */
   pool: Address;
+  /**
+   * Call target when the operation is zapper-routed. The wallet approves this
+   * instead of the pool. Absent on a direct pool call.
+   */
+  zapper?: Address;
+  /**
+   * Whose share balance {@link netValue} describes and whose shares burn on a
+   * withdrawal or redeem (the calldata's `owner` there, its `receiver` on a
+   * deposit or mint).
+   */
+  holder: Address;
   /**
    * Human-readable pool name
    */
@@ -153,7 +84,7 @@ interface PoolPositionOperationPreview {
    * In case of deposit, underlying for direct deposit, zapper input for zapper-routed deposit.
    * In case of withdraw, pool shares (diesel token) for direct withdraw or zapper token out.
    *
-   * On withdraw, this is the amount of shares burend that covers both the requested payout
+   * On withdraw, this is the amount of shares burned that covers both the requested withdrawal
    * and the fee.
    *
    * On redeem this is the shares from calldata, fee-free.
@@ -189,11 +120,6 @@ interface PoolPositionOperationPreview {
    * {@link tokenOut} instead.
    */
   netValue: TokenAmount;
-  /**
-   * Set when preview encountered non-fatal caveats, all fields are
-   * still computed best-effort
-   */
-  warning?: OperationPreviewError;
 }
 /**
  * The market a credit operation acts on, reported the same way by every half of
@@ -425,12 +351,9 @@ interface AccountStateChange {
   assetsChange: TokenAmount[];
 }
 /**
- * What an account-opening transaction that already exists would do — the
- * counterpart of `prepare.openNewStrategy`, read off calldata rather than
- * planned into it.
+ * Fields every account opening shares.
  **/
-interface OpenStrategyPositionPreview extends EstimatedProjection {
-  operation: "OpenCreditAccount" | "RWAOpenCreditAccount";
+interface OpenStrategyPositionProjection extends EstimatedProjection {
   /**
    * Collateral token this position is a strategy in: the first quoted token,
    * with its balance taken from `estAssets` — so, like them, the floor the
@@ -447,12 +370,36 @@ interface OpenStrategyPositionPreview extends EstimatedProjection {
    */
   collateralAdded: TokenAmount[];
   /**
-   * Set when preview encountered non-fatal caveats, all fields are
-   * still computed best-effort, but derived fields (`estAssets`,
-   * `targetCollateral`, `estNetValue`) may be unreliable in that case.
+   * The oracle could not price a token; it contributes nothing to the values.
    */
-  warning?: OperationPreviewError;
+  warning?: UnpriceableTokenError;
 }
+/**
+ * What a facade account-opening transaction that already exists would do —
+ * the counterpart of `prepare.openNewStrategy` on a non-RWA market, read off
+ * calldata rather than planned into it.
+ **/
+interface OpenNonRWAStrategyPositionPreview extends OpenStrategyPositionProjection {
+  operation: "OpenCreditAccount";
+}
+/**
+ * What an RWA-factory account-opening transaction that already exists would
+ * do — the counterpart of `prepare.openNewStrategy` on an RWA market.
+ **/
+interface OpenRWAStrategyPositionPreview extends OpenStrategyPositionProjection {
+  operation: "RWAOpenCreditAccount";
+  /**
+   * Registration args the factory received (Securitize: `tokensToRegister`,
+   * `signaturesToCache`).
+   */
+  rwaArgs: RWAOperationArgs;
+}
+/**
+ * What an account-opening transaction that already exists would do — the
+ * counterpart of `prepare.openNewStrategy`, read off calldata rather than
+ * planned into it.
+ **/
+type OpenStrategyPositionPreview = OpenNonRWAStrategyPositionPreview | OpenRWAStrategyPositionPreview;
 /**
  * What a transaction on an existing account would do — the counterpart of the
  * `prepare` flows that adjust one (`depositStrategy`, `withdrawStrategy`,
@@ -488,11 +435,9 @@ interface AdjustStrategyPositionPreview extends EstimatedProjection, AccountStat
    */
   intent?: DelayedIntent;
   /**
-   * Set when preview encountered non-fatal caveats, all fields are
-   * still computed best-effort, but derived fields (`estAssets`, `assetsChange`,
-   * `estTotalValue`) may be unreliable in that case.
+   * The oracle could not price a token; it contributes nothing to the values.
    */
-  warning?: OperationPreviewError;
+  warning?: UnpriceableTokenError;
 }
 /**
  * What an exit transaction that already exists would do — the counterpart of
@@ -530,12 +475,9 @@ interface ExitStrategyPositionPreview extends EstimatedProjection {
    */
   intent?: DelayedIntent;
   /**
-   * Set when preview encountered non-fatal caveats, all fields are
-   * still computed best-effort, but the
-   * balance-derived `receivedAmount` and the projected holdings may be
-   * unreliable in that case.
+   * The oracle could not price a token; it contributes nothing to the values.
    */
-  warning?: OperationPreviewError;
+  warning?: UnpriceableTokenError;
 }
 /**
  * What a settling repayment that already exists would do — the counterpart of
@@ -586,12 +528,9 @@ interface RepayStrategyPositionPreview extends EstimatedProjection {
    */
   intent?: DelayedIntent;
   /**
-   * Set when preview encountered non-fatal caveats, all fields are
-   * still computed best-effort, but the
-   * balance-derived `collateralWithdrawn` and the projected holdings may be
-   * unreliable in that case.
+   * The oracle could not price a token; it contributes nothing to the values.
    */
-  warning?: OperationPreviewError;
+  warning?: UnpriceableTokenError;
 }
 /**
  * Preview of the "instant" part of an operation on an existing credit
@@ -646,4 +585,4 @@ interface DelayedStrategyPositionOperationPreview extends CreditOperationMarket
  */
 type OperationPreview = PoolPositionOperationPreview | OpenStrategyPositionPreview | AdjustStrategyPositionPreview | ExitStrategyPositionPreview | RepayStrategyPositionPreview | DelayedStrategyPositionOperationPreview;
 //#endregion
-export { 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 };
+export { AccountHoldings, AccountMetrics, AccountProjection, AccountStateChange, AdjustStrategyPositionPreview, CreditOperationMarket, DelayedStrategyPositionOperationPreview, Estimated, EstimatedProjection, ExitStrategyPositionPreview, InstantStrategyPositionOperationPreview, OpenNonRWAStrategyPositionPreview, OpenRWAStrategyPositionPreview, OpenStrategyPositionPreview, OperationPreview, PoolOperationType, PoolPositionOperationPreview, PreviewOperationInput, PreviewOperationOptions, RepayStrategyPositionPreview, RoutedField, asEstimated };

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

@@ -1,4 +1,5 @@
-import { IGearboxError } from "./errors.js";
+import { IGearboxError } from "./errors/base.js";
+import "./errors/index.js";
 //#region src/model/result.d.ts
 /**
  * The success half of every refusable answer: the data the method was asked
@@ -23,7 +24,7 @@ interface SDKError<E extends IGearboxError = IGearboxError> {
  *
  * ```ts
  * const res = await sdk.opportunities.prepare.depositStrategy(position, params);
- * if (isSDKError(res)) {
+ * if (!res.ok) {
  *   return showRefusal(res.error);   // res.error: exactly this method's union
  * }
  * res.data;                          // res.data: StrategyResult
@@ -54,10 +55,5 @@ declare function safeValue<T, E extends IGearboxError = IGearboxError>(value: T,
 declare function sdkOk<T>(data: T): SDKResult<T>;
 /** The failure half, built. */
 declare function sdkErr<E extends IGearboxError>(error: E): SDKError<E>;
-/**
- * Narrows a {@link SDKReturn} to its failure half. Trivial over `ok`, but it
- * names the intent at call sites that would otherwise read `!r.ok`.
- **/
-declare function isSDKError<T, E extends IGearboxError>(answer: SDKReturn<T, E>): answer is SDKError<E>;
 //#endregion
-export { SDKError, SDKResult, SDKReturn, SafeValue, isSDKError, safeValue, sdkErr, sdkOk };
+export { SDKError, SDKResult, SDKReturn, SafeValue, safeValue, sdkErr, sdkOk };

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

@@ -0,0 +1,143 @@
+import { Address, Hex, TypedDataDefinition } from "viem";
+//#region src/model/rwa.d.ts
+/**
+ * Discriminant of the Securitize RWA factory contract type.
+ **/
+declare const RWA_FACTORY_SECURITIZE = "RWA_FACTORY::SECURITIZE";
+/**
+ * Discriminated union of all known RWA factory contract type strings.
+ **/
+declare const RWA_FACTORY_TYPES: readonly ["RWA_FACTORY::SECURITIZE"];
+/**
+ * String literal union of known RWA factory types.
+ **/
+type RWAFactoryType = (typeof RWA_FACTORY_TYPES)[number];
+/**
+ * Cached registration signature for a single DSToken, stored in the
+ * @see SecuritizeDegenNFT in https://github.com/Gearbox-protocol/periphery-v3
+ **/
+interface SecuritizeRegisterMessage {
+  /** DSToken address the signature authorises. */
+  token: Address;
+  /** EIP-712 deadline + raw signature bytes. */
+  signature: SecuritizeSignature;
+}
+/**
+ * Deadline-bound EIP-712 signature produced by the investor.
+ **/
+interface SecuritizeSignature {
+  /** Unix timestamp after which the signature is no longer valid. */
+  deadline: bigint;
+  /** Raw EIP-712 signature bytes. */
+  signature: Hex;
+}
+/**
+ * EIP-712 type schema for the `RegisterVault` message expected by Securitize's
+ * VaultRegistrar. Matches the contract's `RegisterVault` typehash field order.
+ **/
+declare const SECURITIZE_REGISTER_VAULT_TYPES: {
+  readonly RegisterVault: readonly [{
+    readonly name: "investor";
+    readonly type: "address";
+  }, {
+    readonly name: "operator";
+    readonly type: "address";
+  }, {
+    readonly name: "token";
+    readonly type: "address";
+  }, {
+    readonly name: "nonce";
+    readonly type: "uint256";
+  }, {
+    readonly name: "deadline";
+    readonly type: "uint256";
+  }];
+};
+/**
+ * EIP-712 typed-data message that must be signed by the investor to allow the
+ * RWA factory to register a credit account as a vault in Securitize's VaultRegistrar.
+ *
+ * Shaped as a viem {@link TypedDataDefinition} so it can be spread directly into
+ * `walletClient.signTypedData({ account, ...message })`. The caller only has to
+ * supply the signing `account`.
+ *
+ * - `domain` — EIP-712 domain from the VaultRegistrar contract.
+ * - `message.investor` — investor EOA that will sign the message.
+ * - `message.operator` — operator address (the DegenNFT contract).
+ * - `message.token` — DSToken address to register for.
+ * - `message.nonce` — monotonic nonce from VaultRegistrar `(investor, operator)`.
+ * - `message.deadline` — unix timestamp after which the message is no longer valid.
+ *
+ * @see VaultRegistrar in https://github.com/Gearbox-protocol/periphery-v3
+ **/
+type SecuritizeRegisterVaultMessage = TypedDataDefinition<typeof SECURITIZE_REGISTER_VAULT_TYPES, "RegisterVault">;
+/**
+ * Factory-specific args for a Securitize RWA factory `multicall` /
+ * `openCreditAccount`.
+ **/
+interface SecuritizeOperationArgs {
+  type: typeof RWA_FACTORY_SECURITIZE;
+  /** DSToken addresses to register for this operation. */
+  tokensToRegister: Address[];
+  /** Cached EIP-712 registration signatures to store on-chain. */
+  signaturesToCache: SecuritizeRegisterMessage[];
+}
+/**
+ * Subset of {@link SecuritizeOpenAccountRequirements} still unfulfilled given
+ * the params already carried by the transaction calldata. Returned by
+ * `SecuritizeRWAFactory.getMissingRequirements`; `undefined` there means the
+ * requirements are satisfied.
+ **/
+interface SecuritizeMissingOpenAccountRequirements {
+  type: typeof RWA_FACTORY_SECURITIZE;
+  /**
+   * EIP-712 messages the investor still has to sign (not covered by
+   * calldata-provided signatures). Once signed, they become the
+   * `signaturesToCache` arg of the factory's `openCreditAccount`/`multicall`
+   * calls (see {@link SecuritizeOperationArgs}).
+   */
+  requiredSignatures: SecuritizeRegisterVaultMessage[];
+}
+interface SecuritizeOpenAccountRequirements {
+  type: typeof RWA_FACTORY_SECURITIZE;
+  /**
+   * User must visit securitize website to register these tokens
+   * May be empty if user already registered all required tokens
+   */
+  securitizeTokensToRegister: Address[];
+  /**
+   * Desired tokens to register for this operation, must be always present on open credit account
+   * Come from strategy configuration
+   * Passed to openCreditAccount contract call on securitize factory
+   */
+  tokensToRegister: Address[];
+  /**
+   * User must sign these messages to gearbox and provide EIP-712 signatures
+   * as {@link SecuritizeRegisterMessage} to gearbox
+   */
+  requiredSignatures: SecuritizeRegisterVaultMessage[];
+}
+/**
+ * Open-account requirements for a RWA factory, defaults to union of all factory types.
+ * Can be discriminated by type.
+ **/
+type RWAOpenAccountRequirements<T extends RWAFactoryType = RWAFactoryType> = Extract<SecuritizeOpenAccountRequirements, {
+  type: T;
+}>;
+/**
+ * Subset of {@link RWAOpenAccountRequirements} that is still unfulfilled,
+ * defaults to union of all factory types.
+ * Can be discriminated by type.
+ **/
+type RWAMissingOpenAccountRequirements<T extends RWAFactoryType = RWAFactoryType> = Extract<SecuritizeMissingOpenAccountRequirements, {
+  type: T;
+}>;
+/**
+ * Open credit account/Multicall extra params type for a RWA factory, defaults to union of all factory types.
+ * Can be discriminated by type.
+ **/
+type RWAOperationArgs<T extends RWAFactoryType = RWAFactoryType> = Extract<SecuritizeOperationArgs, {
+  type: T;
+}>;
+//#endregion
+export { RWAFactoryType, RWAMissingOpenAccountRequirements, RWAOpenAccountRequirements, RWAOperationArgs, RWA_FACTORY_SECURITIZE, RWA_FACTORY_TYPES, SECURITIZE_REGISTER_VAULT_TYPES, SecuritizeMissingOpenAccountRequirements, SecuritizeOpenAccountRequirements, SecuritizeOperationArgs, SecuritizeRegisterMessage, SecuritizeRegisterVaultMessage, SecuritizeSignature };

package/dist/types/onchain/accounts/CreditAccountsServiceV310.d.ts

@@ -1,6 +1,8 @@
+import { RWAOpenAccountRequirements } from "../../model/rwa.js";
+import "../../model/index.js";
 import { RequestableWithdrawal } from "./withdrawal-compressor/types.js";
 import { Asset, CreditAccountData, CreditAccountTokensSlice, PermitResult } from "../base/types.js";
-import { GetOpenAccountRequirementsProps, RWAOpenAccountRequirements } from "../market/rwa/types.js";
+import { GetOpenAccountRequirementsProps } from "../market/rwa/types.js";
 import "../market/rwa/index.js";
 import { PriceUpdate } from "../market/pricefeeds/types.js";
 import { PrepareUpdateQuotasProps } from "../market/credit/types.js";

package/dist/types/onchain/accounts/index.d.ts

@@ -1,4 +1,3 @@
-import { InvalidDelayedIntentError } from "./withdrawal-compressor/errors.js";
 import { ClaimableWithdrawal, CurrentWithdrawals, DelayedIntentExtended, GetExternalAccountCurrentWithdrawalsProps, GetWithdrawalRequestResultProps, IRedemptionLoggerContract, IWithdrawalCompressorContract, PendingWithdrawal, RedemptionLog, RequestableWithdrawal, WithdrawableAsset, WithdrawalOutput, WithdrawalStatus, WithdrawalsState, toWithdrawalStatus } from "./withdrawal-compressor/types.js";
 import { CreditAccountDataCall, CreditAccountFilter, CreditAccountReadOptions, CreditAccountsCall, CreditAccountsQuery, CreditAccountsReadOptions, CreditAccountsTarget, CreditManagerFilter, GetCreditAccountsArgs, GetCreditAccountsOptions } from "./credit-account-compressor/types.js";
 import { CreditAccountCompressor } from "./credit-account-compressor/CreditAccountCompressor.js";
@@ -20,11 +19,10 @@ import { AccountBotsService } from "./bots/AccountBotsService.js";
 import { PeripheryCompressorV310Contract } from "./bots/PeripheryCompressorV310Contract.js";
 import "./bots/index.js";
 import { CreditAccountsServiceV310 } from "./CreditAccountsServiceV310.js";
-import { borrowable } from "./intents/guards.js";
 import { LeverageBand } from "./intents/leverage-band.js";
 import { CalcDefaultQuotaProps, CalcQuotaUpdateProps, CalcRecommendedQuotaProps, calcDefaultQuota, calcQuotaUpdate, calcRecommendedQuota, roundUpQuota } from "./quota-utils.js";
 import { AccountCalculatorOperation } from "./intents/operations.js";
-import { AddCollateralIntent, AdjustLeverageIntent, ClaimRemainder, CreditAccountSlice, DelayableIntent, DelayedRoute, DelayedStart, DelayedStartResult, DepositStrategyIntent, FinishIntentProps, FinishIntentResult, InstantRoute, IntentPreviewResult, IntentRoutesResult, OperationState, PathLossRate, RepayStrategyIntent, ResumableIntent, RouteRefusals, StartIntent, WithdrawAssetIntent, WithdrawCeilings, WithdrawStrategyIntent } from "./intents/types.js";
+import { AddCollateralIntent, AdjustLeverageIntent, ClaimRemainder, CreditAccountSlice, DelayableIntent, DelayedRoute, DelayedStart, DelayedStartResult, DepositStrategyIntent, FinishIntentProps, FinishIntentResult, InstantRoute, IntentPreviewResult, IntentRoutesResult, OperationState, PathLossRate, RepayStrategyIntent, ResumableIntent, RouteErrors, StartIntent, WithdrawAssetIntent, WithdrawCeilings, WithdrawStrategyIntent } from "./intents/types.js";
 import { OpenStrategyProps, OpenStrategyState } from "./intents/open-strategy.js";
 import { fetchCreditAccountSlice, toCreditAccountSlice } from "./intents/utils/credit-account-slice.js";
 import { isPhantomToken } from "./intents/utils/pick-token.js";
@@ -34,4 +32,4 @@ import { BuildLiquidationTxProps, BuildLiquidationTxPropsBase, GetLiquidatableAc
 import { LiquidationsService } from "./liquidations/LiquidationsService.js";
 import { MultichainLiquidationsService } from "./liquidations/MultichainLiquidationsService.js";
 import "./liquidations/index.js";
-export { AbstractWithdrawalCompressorContract, AccountBotsService, type AccountCalculatorOperation, AccountToCheck, type AddCollateralIntent, type AdjustLeverageIntent, AssembleCaOperationsProps, AssembleClaimDelayedCallsProps, AssembleCloseCreditAccountCallsProps, AssembleRepayCreditAccountCallsProps, AssembleStartDelayedWithdrawalCallsProps, BotStatusCall, BotsDirectResponse, BuildLiquidationTxProps, BuildLiquidationTxPropsBase, CMSlice, CalcDefaultQuotaProps, CalcQuotaUpdateProps, CalcRecommendedQuotaProps, ClaimFarmRewardsProps, type ClaimRemainder, ClaimableWithdrawal, CloseCreditAccountResult, ConnectedBotsCall, ConnectedBotsPerAccount, CreditAccountCompressor, CreditAccountCompressorV310Contract, CreditAccountDataCall, CreditAccountFilter, CreditAccountOperationResult, CreditAccountOperationsService, CreditAccountReadOptions, type CreditAccountSlice, CreditAccountsCall, CreditAccountsQuery, CreditAccountsReadOptions, CreditAccountsServiceV310, CreditAccountsTarget, CreditManagerFilter, CreditManagerOperationResult, CurrentWithdrawals, DELAYED_INTENT_TYPES, DELAYED_INTENT_VERSION, type DelayableIntent, DelayedIntentExtended, type DelayedRoute, type DelayedStart, type DelayedStartResult, type DepositStrategyIntent, EncodableCreditAccountOperation, type FinishIntentProps, type FinishIntentResult, FullyLiquidateProps, FullyLiquidateResult, GetApprovalAddressProps, GetConnectedBotsResponse, GetConnectedBotsResult, GetConnectedMigrationBotsResult, GetCreditAccountsArgs, GetCreditAccountsOptions, GetExternalAccountCurrentWithdrawalsProps, GetLiquidatableAccountsProps, GetLiquidationDetailsProps, GetLiquidationDetailsPropsBase, GetLiquidationPositionsProps, GetLiquidationPositionsPropsBase, GetWithdrawalRequestResultProps, ICreditAccountsService, IRedemptionLoggerContract, IWithdrawalCompressorContract, type InstantRoute, type IntentPreviewResult, type IntentRoutesResult, InvalidDelayedIntentError, LIQUIDATION_APPROVAL_BUFFER, LIQUIDATION_COMPRESSOR_V313_ADDRESS, type LeverageBand, LiquidationsService, LoadRWALiquidatorsProps, MulticallWithFailure, MultichainLiquidationsService, OnchainLiquidationCall, OnchainLiquidationData, OnchainLiquidationOutput, OnchainRequestableWithdrawal, OpenCAProps, OpenStrategyPreviewResult, type OpenStrategyProps, type OpenStrategyState, type OperationState, PartiallyLiquidateProps, type PathLossRate, PendingWithdrawal, PeripheryCompressorV310Contract, PreviewDelayedWithdrawalProps, RWALiquidatorInfo, RedemptionLog, RedemptionLoggerV310Contract, type RepayStrategyIntent, RequestableWithdrawal, type ResumableIntent, Rewards, type RouteRefusals, SetBotProps, SetBotResult, type StartIntent, type WithdrawAssetIntent, type WithdrawCeilings, type WithdrawStrategyIntent, WithdrawableAsset, WithdrawalCompressorLocation, WithdrawalCompressorV310Contract, WithdrawalCompressorV311Contract, WithdrawalCompressorV313Contract, WithdrawalCompressorVersion, WithdrawalOutput, WithdrawalStatus, WithdrawalsState, borrowable, calcDefaultQuota, calcQuotaUpdate, calcRecommendedQuota, createRedemptionLogger, createWithdrawalCompressor, decodeDelayedIntent, encodeDelayedIntent, fetchCreditAccountSlice, getWithdrawalCompressorAddress, iCreditAccountAbi, isPhantomToken, roundUpQuota, toClaimableWithdrawal, toCreditAccountSlice, toPendingWithdrawal, toRequestableWithdrawal, toWithdrawalStatus };
+export { AbstractWithdrawalCompressorContract, AccountBotsService, type AccountCalculatorOperation, AccountToCheck, type AddCollateralIntent, type AdjustLeverageIntent, AssembleCaOperationsProps, AssembleClaimDelayedCallsProps, AssembleCloseCreditAccountCallsProps, AssembleRepayCreditAccountCallsProps, AssembleStartDelayedWithdrawalCallsProps, BotStatusCall, BotsDirectResponse, BuildLiquidationTxProps, BuildLiquidationTxPropsBase, CMSlice, CalcDefaultQuotaProps, CalcQuotaUpdateProps, CalcRecommendedQuotaProps, ClaimFarmRewardsProps, type ClaimRemainder, ClaimableWithdrawal, CloseCreditAccountResult, ConnectedBotsCall, ConnectedBotsPerAccount, CreditAccountCompressor, CreditAccountCompressorV310Contract, CreditAccountDataCall, CreditAccountFilter, CreditAccountOperationResult, CreditAccountOperationsService, CreditAccountReadOptions, type CreditAccountSlice, CreditAccountsCall, CreditAccountsQuery, CreditAccountsReadOptions, CreditAccountsServiceV310, CreditAccountsTarget, CreditManagerFilter, CreditManagerOperationResult, CurrentWithdrawals, DELAYED_INTENT_TYPES, DELAYED_INTENT_VERSION, type DelayableIntent, DelayedIntentExtended, type DelayedRoute, type DelayedStart, type DelayedStartResult, type DepositStrategyIntent, EncodableCreditAccountOperation, type FinishIntentProps, type FinishIntentResult, FullyLiquidateProps, FullyLiquidateResult, GetApprovalAddressProps, GetConnectedBotsResponse, GetConnectedBotsResult, GetConnectedMigrationBotsResult, GetCreditAccountsArgs, GetCreditAccountsOptions, GetExternalAccountCurrentWithdrawalsProps, GetLiquidatableAccountsProps, GetLiquidationDetailsProps, GetLiquidationDetailsPropsBase, GetLiquidationPositionsProps, GetLiquidationPositionsPropsBase, GetWithdrawalRequestResultProps, ICreditAccountsService, IRedemptionLoggerContract, IWithdrawalCompressorContract, type InstantRoute, type IntentPreviewResult, type IntentRoutesResult, LIQUIDATION_APPROVAL_BUFFER, LIQUIDATION_COMPRESSOR_V313_ADDRESS, type LeverageBand, LiquidationsService, LoadRWALiquidatorsProps, MulticallWithFailure, MultichainLiquidationsService, OnchainLiquidationCall, OnchainLiquidationData, OnchainLiquidationOutput, OnchainRequestableWithdrawal, OpenCAProps, OpenStrategyPreviewResult, type OpenStrategyProps, type OpenStrategyState, type OperationState, PartiallyLiquidateProps, type PathLossRate, PendingWithdrawal, PeripheryCompressorV310Contract, PreviewDelayedWithdrawalProps, RWALiquidatorInfo, RedemptionLog, RedemptionLoggerV310Contract, type RepayStrategyIntent, RequestableWithdrawal, type ResumableIntent, Rewards, type RouteErrors, SetBotProps, SetBotResult, type StartIntent, type WithdrawAssetIntent, type WithdrawCeilings, type WithdrawStrategyIntent, WithdrawableAsset, WithdrawalCompressorLocation, WithdrawalCompressorV310Contract, WithdrawalCompressorV311Contract, WithdrawalCompressorV313Contract, WithdrawalCompressorVersion, WithdrawalOutput, WithdrawalStatus, WithdrawalsState, calcDefaultQuota, calcQuotaUpdate, calcRecommendedQuota, createRedemptionLogger, createWithdrawalCompressor, decodeDelayedIntent, encodeDelayedIntent, fetchCreditAccountSlice, getWithdrawalCompressorAddress, iCreditAccountAbi, isPhantomToken, roundUpQuota, toClaimableWithdrawal, toCreditAccountSlice, toPendingWithdrawal, toRequestableWithdrawal, toWithdrawalStatus };

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

@@ -2,7 +2,6 @@ import { Asset } from "../../base/types.js";
 import { MarketSuite } from "../../market/MarketSuite.js";
 import { CreditSuite } from "../../market/credit/CreditSuite.js";
 import { OnchainSDK } from "../../OnchainSDK.js";
-import { BorrowLimitBinding } from "../../validation/refusal.js";
 import "../../index.js";
 //#region src/onchain/accounts/intents/guards.d.ts
 /**
@@ -24,16 +23,6 @@ import "../../index.js";
  * every intent the engine previews would revert on arrival.
  */
 declare function assertMarketOperable(suite: CreditSuite): void;
-/**
- * What the pool will hand this manager in one transaction: the tightest of its
- * free liquidity, the manager's remaining debt limit and the per-block cap the
- * facade puts on a single borrow. A zero multiplier switches borrowing off
- * outright, which reads here as nothing being available.
- */
-declare function borrowable(suite: CreditSuite): {
-  limit: bigint;
-  binding: BorrowLimitBinding;
-};
 /** The pool has to be able to lend what the plan means to draw. */
 declare function assertCanBorrow(sdk: OnchainSDK, suite: CreditSuite, amount: bigint): void;
 /**
@@ -60,19 +49,20 @@ declare function assertGrowthAllowed(args: {
  * and reverts if the collateral does not cover it, so a plan that lands the
  * account below water is refused here.
  *
- * The bar is the facade's own `1.0`, because this guard answers one question:
- * would the transaction revert. It is deliberately not `MIN_HF_LIMITED`, and
- * the three bars in this codebase are three different jobs:
+ * The threshold is the facade's own `1.0`, because this guard answers one
+ * question: would the transaction revert. It is deliberately not
+ * `MIN_HF_LIMITED`, and the three thresholds in this codebase are three
+ * different jobs:
  *
  * - here, `1.0` — what the facade enforces, so what a plan must clear to land;
  * - `maxWithdrawCollateral` sizes at `MIN_HF_LIMITED + 2` — a *sizing* helper
- *   leaving headroom, which is not the same as a validity check;
+ *   leaving a margin, which is not the same as a validity check;
  * - a form refuses at or below `MIN_HF_LIMITED` (`MIN_HEALTH_FACTOR_FORM`).
  *
  * Raising this one to `MIN_HF_LIMITED` was tried and reverted: it made
  * `maxWithdraw` hand back a ceiling this guard then refused, and it blocked
  * small top-ups of an account sitting in `[1.0, 1.01)` — the very operations
- * that rescue it. A form wanting the stricter bar has `validateHF`.
+ * that rescue it. A form wanting the stricter threshold has `validateHF`.
  *
  * Note that a position already underwater cannot be nursed back one step at a
  * time — the check is on where the transaction ends, not on whether it
@@ -89,6 +79,6 @@ declare function assertCollateralised(healthFactorBps: number, safePrices: boole
  * A quota can only be raised as far as the market still has room for: past the
  * token's limit the keeper takes nothing more, whoever is asking.
  */
-declare function assertQuotaHeadroom(sdk: OnchainSDK, market: MarketSuite, increases: readonly Asset[]): void;
+declare function assertQuotaAvailable(sdk: OnchainSDK, market: MarketSuite, increases: readonly Asset[]): void;
 //#endregion
-export { assertCanBorrow, assertCollateralised, assertGrowthAllowed, assertMarketOperable, assertQuotaHeadroom, borrowable };
+export { assertCanBorrow, assertCollateralised, assertGrowthAllowed, assertMarketOperable, assertQuotaAvailable };

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

@@ -1,9 +1,10 @@
+import { SDKError } from "../../../model/result.js";
+import "../../../model/index.js";
 import { SDKConstruct } from "../../base/SDKConstruct.js";
-import { PreviewRefusal } from "../../validation/refusal.js";
-import { borrowable } from "./guards.js";
+import { IntentValidationError } from "../../validation/raise.js";
 import { LeverageBand, LeverageBandProps } from "./leverage-band.js";
 import { AccountCalculatorOperation } from "./operations.js";
-import { AddCollateralIntent, AdjustLeverageIntent, ClaimRemainder, CreditAccountSlice, DelayableIntent, DelayedRoute, DelayedStart, DelayedStartResult, DepositStrategyIntent, FinishIntentProps, FinishIntentResult, InstantRoute, IntentPreviewResult, IntentRoutesResult, OperationState, PathLossRate, RepayStrategyIntent, ResumableIntent, RouteRefusals, StartIntent, StartIntentProps, WithdrawAssetIntent, WithdrawCeilings, WithdrawStrategyIntent } from "./types.js";
+import { AddCollateralIntent, AdjustLeverageIntent, ClaimRemainder, CreditAccountSlice, DelayableIntent, DelayedRoute, DelayedStart, DelayedStartResult, DepositStrategyIntent, FinishIntentProps, FinishIntentResult, InstantRoute, IntentPreviewResult, IntentRoutesResult, OperationState, PathLossRate, RepayStrategyIntent, ResumableIntent, RouteErrors, StartIntent, StartIntentProps, WithdrawAssetIntent, WithdrawCeilings, WithdrawStrategyIntent } from "./types.js";
 import { OpenStrategyProps, OpenStrategyState } from "./open-strategy.js";
 import { fetchCreditAccountSlice, toCreditAccountSlice } from "./utils/credit-account-slice.js";
 import { isPhantomToken } from "./utils/pick-token.js";
@@ -19,7 +20,7 @@ import { Address } from "viem";
 type OpenStrategyPreviewResult = {
   ok: true;
   state: OpenStrategyState;
-} | PreviewRefusal;
+} | SDKError<IntentValidationError>;
 /** An intent plus everything previewing it needs. */
 type StartProps = StartIntentProps & {
   intent: StartIntent;
@@ -37,15 +38,15 @@ declare class CreditAccountOperationsService extends SDKConstruct {
    * Previews an operation on an existing account.
    *
    * @param props - Intent plus account slice, quota reserve and slippage
-   * @returns Operations, projected state and calldata, or `{ ok: false, reason }`
+   * @returns Operations, projected state and calldata, or `{ ok: false, error }`
    * when the intent cannot be satisfied (e.g. the account lacks the source
    * balance)
    */
   startIntent(props: StartProps): Promise<IntentPreviewResult>;
   /**
    * Both ends of what a `WITHDRAW` can take out, in underlying: the largest
-   * partial withdrawal that keeps leverage and stays inside the facade's debt
-   * band, and the net value an exit hands over. They are reported together
+   * partial withdrawal that keeps leverage and stays inside the facade's
+   * `debtLimits`, and the net value an exit hands over. They are reported together
    * because a withdraw form needs both — the range it may offer, and the one
    * amount past it that is allowed — and because the distance between them is
    * the account's own, not a constant a caller could assume.
@@ -78,8 +79,8 @@ declare class CreditAccountOperationsService extends SDKConstruct {
    *
    * A credit manager's `maxLeverage` follows from the liquidation threshold
    * alone, so it is the same for a hundred dollars and for a million. What a
-   * given deposit reaches is decided by the debt it implies and by the band
-   * the market puts that debt in — the range a leverage slider should offer.
+   * given deposit reaches is decided by the debt it implies and by the
+   * `debtLimits` the market puts that debt in — the range a leverage slider should offer.
    *
    * Unlike the other ceilings here this one reads no account: opening has none
    * yet, and adjusting measures against the net value the caller already
@@ -96,9 +97,9 @@ declare class CreditAccountOperationsService extends SDKConstruct {
    * while its health factor stays at `targetHF` — the ceiling a
    * withdraw-collateral form should offer. Thresholds, prices and quota
    * activity come from the account's market, valued the way the facade values
-   * a call that pays out; zero debt frees the whole balance.
+   * a call that withdraws collateral; zero debt frees the whole balance.
    *
-   * The default is {@link MIN_HF_LIMITED}, the bar a form holds an
+   * The default is {@link MIN_HF_LIMITED}, the threshold a form holds an
    * account to.
    *
    * @param props - Account slice, the SDK holding its market, the collateral
@@ -115,8 +116,8 @@ declare class CreditAccountOperationsService extends SDKConstruct {
    *
    * Sits apart from {@link startIntent} because it is a different trade route,
    * not a different intent: the request goes to the issuer instead of the
-   * router, and the proceeds — hence the repayment and the payout — arrive days
-   * later. Both routes of one intent are quoted together by
+   * router, and what it sells for — hence the repayment and the withdrawal —
+   * arrives days later. Both routes of one intent are quoted together by
    * {@link intentRoutes}; this is the one to call when the delayed route is the
    * only one of interest.
    *
@@ -128,7 +129,7 @@ declare class CreditAccountOperationsService extends SDKConstruct {
    *
    * @param props - Intent plus account slice, quota reserve and slippage
    * @returns The request transaction, the state it ends in and what it recorded
-   * for the tail, or `{ ok: false, reason }` — `noDelayedRoute` when this route
+   * for the tail, or `{ ok: false, error }` — `noDelayedRoute` when this route
    * does not exist for the account at all
    */
   startDelayedIntent(props: StartIntentProps & {
@@ -141,7 +142,7 @@ declare class CreditAccountOperationsService extends SDKConstruct {
    * Which routes an account has depends on the intent and the token it sells,
    * and a form has to know before it can offer a choice — so both are quoted
    * from the same request and each is reported on its own. A route the account
-   * cannot take comes back `undefined` with its refusal in `refused`; only when
+   * cannot take comes back `undefined` with its error in `errors`; only when
    * neither answers is the whole result `{ ok: false }`.
    *
    * A route that could not be quoted at all — a pathfinder with no path out of
@@ -151,7 +152,7 @@ declare class CreditAccountOperationsService extends SDKConstruct {
    *
    * @param props - A withdraw or adjust-leverage intent plus account slice,
    * quota reserve and slippage
-   * @returns Whichever routes are viable, or `{ ok: false, reason }` when none is
+   * @returns Whichever routes are viable, or `{ ok: false, error }` when none is
    */
   intentRoutes(props: StartIntentProps & {
     intent: DelayableIntent;
@@ -166,7 +167,7 @@ declare class CreditAccountOperationsService extends SDKConstruct {
    * catch up.
    *
    * A claim that brought only part of what the request queued — a legacy Mellow
-   * multivault, which pays out what it holds liquid and re-queues the rest — is
+   * multivault, which hands over what it holds liquid and re-queues the rest — is
    * served in proportion, and what it did not settle comes back as `remainder`:
    * the withdrawal still in flight and the intent to finish it with.
    *
@@ -185,10 +186,10 @@ declare class CreditAccountOperationsService extends SDKConstruct {
    *
    * @param props - Credit manager, wallet collateral, target token and leverage
    * @returns Debt, position size, projected balances and quotas for both the
-   * expected and the floor branch, or `{ ok: false, reason }` when the requested
+   * expected and the floor branch, or `{ ok: false, error }` when the requested
    * leverage or the resulting debt is not viable
    */
   openStrategyIntent(props: OpenStrategyProps): Promise<OpenStrategyPreviewResult>;
 }
 //#endregion
-export { type AccountCalculatorOperation, type AddCollateralIntent, type AdjustLeverageIntent, type ClaimRemainder, CreditAccountOperationsService, type CreditAccountSlice, type DelayableIntent, type DelayedRoute, type DelayedStart, type DelayedStartResult, type DepositStrategyIntent, type FinishIntentProps, type FinishIntentResult, type InstantRoute, type IntentPreviewResult, type IntentRoutesResult, type LeverageBand, OpenStrategyPreviewResult, type OpenStrategyProps, type OpenStrategyState, type OperationState, type PathLossRate, type RepayStrategyIntent, type ResumableIntent, type RouteRefusals, type StartIntent, type WithdrawAssetIntent, type WithdrawCeilings, type WithdrawStrategyIntent, borrowable, fetchCreditAccountSlice, isPhantomToken, toCreditAccountSlice };
+export { type AccountCalculatorOperation, type AddCollateralIntent, type AdjustLeverageIntent, type ClaimRemainder, CreditAccountOperationsService, type CreditAccountSlice, type DelayableIntent, type DelayedRoute, type DelayedStart, type DelayedStartResult, type DepositStrategyIntent, type FinishIntentProps, type FinishIntentResult, type InstantRoute, type IntentPreviewResult, type IntentRoutesResult, type LeverageBand, OpenStrategyPreviewResult, type OpenStrategyProps, type OpenStrategyState, type OperationState, type PathLossRate, type RepayStrategyIntent, type ResumableIntent, type RouteErrors, type StartIntent, type WithdrawAssetIntent, type WithdrawCeilings, type WithdrawStrategyIntent, fetchCreditAccountSlice, isPhantomToken, toCreditAccountSlice };