@gearbox-protocol/sdk 16.0.0-next.9 → 16.1.0

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

@@ -0,0 +1,63 @@
+import { IGearboxError } from "./errors.js";
+//#region src/model/result.d.ts
+/**
+ * The success half of every refusable answer: the data the method was asked
+ * for, behind the `ok` discriminant a caller must narrow first.
+ **/
+interface SDKResult<T> {
+  ok: true;
+  data: T;
+}
+/**
+ * The failure half: one of the errors that method's own signature names —
+ * see {@link IGearboxError} for what every error carries.
+ **/
+interface SDKError<E extends IGearboxError = IGearboxError> {
+  ok: false;
+  error: E;
+}
+/**
+ * What a method that can be refused answers with. `ok` is the discriminant,
+ * and narrowing it settles which of the two fields is there — a caller
+ * cannot read `data` without having ruled the failure out first.
+ *
+ * ```ts
+ * const res = await sdk.opportunities.prepare.depositStrategy(position, params);
+ * if (isSDKError(res)) {
+ *   return showRefusal(res.error);   // res.error: exactly this method's union
+ * }
+ * res.data;                          // res.data: StrategyResult
+ * ```
+ *
+ * @typeParam T - What the method answers when it can.
+ * @typeParam E - The errors that method can refuse with. Naming them
+ * per method is the point: the union is the list of everything a caller has
+ * to handle, checked by the compiler.
+ **/
+type SDKReturn<T, E extends IGearboxError> = SDKResult<T> | SDKError<E>;
+/**
+ * Best-effort result: `value` is always present (zero / empty when nothing
+ * worked), `error` is set when it was degraded.
+ *
+ * Opposite of {@link SDKReturn}, which is exclusive (ok XOR error: a refusal).
+ * Later safe-priced figures reuse this type.
+ **/
+interface SafeValue<T, E extends IGearboxError = IGearboxError> {
+  value: T;
+  error?: E;
+}
+/**
+ * Builds a {@link SafeValue}. Omits `error` when the value was not degraded.
+ **/
+declare function safeValue<T, E extends IGearboxError = IGearboxError>(value: T, error?: E): SafeValue<T, E>;
+/** The success half, built. */
+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 };

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

@@ -0,0 +1,106 @@
+import { Timestamp, Token, TokenAmount, TxCall } from "./primitives.js";
+import { DelayedIntent } from "./delayed-intents.js";
+import { Address } from "viem";
+//#region src/model/withdrawals.d.ts
+/**
+ * One token amount a delayed withdrawal produces, and when.
+ **/
+interface WithdrawalOutputAmount extends TokenAmount {
+  /**
+   * `false` when the amount lands on the credit account as the withdrawal is
+   * requested or claimed. `true` when it does not: the token is then the
+   * withdrawal phantom standing for a part that has not matured, and another
+   * claim is needed for it.
+   *
+   * A withdrawal that produces both at once is a legacy Mellow multivault: it
+   * serves whatever its subvaults hold liquid and queues the remainder.
+   **/
+  isDelayed: boolean;
+}
+/**
+ * A delayed withdrawal of a strategy position that has matured and can be claimed.
+ **/
+interface PositionClaimableWithdrawal {
+  /**
+   * Source token the withdrawal was requested from.
+   **/
+  sourceToken: Token;
+  /**
+   * Withdrawal phantom token that represents this position, and the amount
+   * that will be burned when the withdrawal is claimed.
+   **/
+  withdrawalPhantomToken: TokenAmount;
+  /**
+   * What the claim credits the account with. Everything a venue that answers
+   * whole produces lands at once; one that pays in instalments credits part of
+   * it as a fresh withdrawal position, see
+   * {@link WithdrawalOutputAmount.isDelayed}.
+   **/
+  outputs: WithdrawalOutputAmount[];
+  /**
+   * Adapter call that executes the claim. Subcompressors always report exactly
+   * one call; it is wrapped into a facade multicall by `assembleClaimDelayedCalls`.
+   **/
+  claimCall: TxCall;
+  /**
+   * Redeemer contract the withdrawal is claimed from. `undefined` on
+   * compressor versions below 313, which do not report it.
+   **/
+  redeemer?: Address;
+  /**
+   * Delayed intent decoded from the withdrawal's `extraData`. `undefined` on
+   * compressor versions below 313, and on v313+ when the withdrawal was
+   * requested without an intent (empty `extraData`).
+   **/
+  intent?: DelayedIntent;
+}
+/**
+ * A delayed withdrawal of a strategy position that is not yet claimable.
+ **/
+interface PositionPendingWithdrawal {
+  /**
+   * Source token the withdrawal was requested from.
+   **/
+  sourceToken: Token;
+  /**
+   * Withdrawal phantom token that represents this position.
+   **/
+  withdrawalPhantomToken: Token;
+  /**
+   * Estimated tokens the position will receive once the withdrawal
+   * matures and is claimed, see {@link WithdrawalOutputAmount.isDelayed} for
+   * the ones a single claim will not bring.
+   **/
+  expectedOutputs: WithdrawalOutputAmount[];
+  /**
+   * Unix timestamp (in seconds) when the withdrawal becomes claimable.
+   **/
+  claimableAt: Timestamp;
+  /**
+   * Redeemer contract the withdrawal will be claimed from. `undefined` on
+   * compressor versions below 313, which do not report it.
+   **/
+  redeemer?: Address;
+  /**
+   * Delayed intent decoded from the withdrawal's `extraData`. `undefined` on
+   * compressor versions below 313, and on v313+ when the withdrawal was
+   * requested without an intent (empty `extraData`).
+   **/
+  intent?: DelayedIntent;
+}
+/**
+ * Delayed withdrawals of a strategy position, split into immediately claimable
+ * and still-pending entries.
+ **/
+interface PositionWithdrawals {
+  /**
+   * Withdrawals that have matured and can be claimed now.
+   **/
+  claimable: PositionClaimableWithdrawal[];
+  /**
+   * Withdrawals that are still maturing.
+   **/
+  pending: PositionPendingWithdrawal[];
+}
+//#endregion
+export { PositionClaimableWithdrawal, PositionPendingWithdrawal, PositionWithdrawals, WithdrawalOutputAmount };

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

@@ -0,0 +1,263 @@
+import { z } from "zod/v4";
+//#region src/model/withdrawals.schema.d.ts
+/**
+ * {@link WithdrawalOutputAmount}
+ **/
+declare const withdrawalOutputAmountSchema: z.ZodObject<{
+  value: z.ZodCodec<z.ZodUnion<[z.ZodString, z.ZodBigInt]>, z.ZodBigInt>;
+  valueUsd: z.ZodNullable<z.ZodNumber>;
+  token: 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>;
+  isDelayed: z.ZodBoolean;
+}, z.core.$strip>;
+/**
+ * {@link PositionClaimableWithdrawal}
+ **/
+declare const positionClaimableWithdrawalSchema: z.ZodObject<{
+  sourceToken: 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>;
+  withdrawalPhantomToken: z.ZodObject<{
+    value: z.ZodCodec<z.ZodUnion<[z.ZodString, z.ZodBigInt]>, z.ZodBigInt>;
+    valueUsd: z.ZodNullable<z.ZodNumber>;
+    token: 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>;
+  outputs: z.ZodArray<z.ZodObject<{
+    value: z.ZodCodec<z.ZodUnion<[z.ZodString, z.ZodBigInt]>, z.ZodBigInt>;
+    valueUsd: z.ZodNullable<z.ZodNumber>;
+    token: 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>;
+    isDelayed: z.ZodBoolean;
+  }, z.core.$strip>>;
+  claimCall: z.ZodObject<{
+    to: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
+    callData: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
+    value: z.ZodOptional<z.ZodCodec<z.ZodUnion<[z.ZodString, z.ZodBigInt]>, z.ZodBigInt>>;
+  }, z.core.$strip>;
+  redeemer: z.ZodOptional<z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>>;
+  intent: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
+    type: z.ZodLiteral<"INCREASE_LEVERAGE">;
+  }, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"DEPOSIT">;
+  }, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"DEPOSIT_AND_INCREASE_LEVERAGE">;
+  }, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"WITHDRAW_COLLATERAL">;
+    to: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
+    withdrawToken: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
+    withdrawAmount: z.ZodCodec<z.ZodUnion<[z.ZodString, z.ZodBigInt]>, z.ZodBigInt>;
+    sourceToken: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
+    debtRepaid: z.ZodCodec<z.ZodUnion<[z.ZodString, z.ZodBigInt]>, z.ZodBigInt>;
+  }, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"CLOSE_ACCOUNT">;
+    to: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
+  }, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"ADD_COLLATERAL">;
+  }, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"DECREASE_LEVERAGE">;
+  }, z.core.$strip>], "type">>;
+}, z.core.$strip>;
+/**
+ * {@link PositionPendingWithdrawal}
+ **/
+declare const positionPendingWithdrawalSchema: z.ZodObject<{
+  sourceToken: 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>;
+  withdrawalPhantomToken: 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>;
+  expectedOutputs: z.ZodArray<z.ZodObject<{
+    value: z.ZodCodec<z.ZodUnion<[z.ZodString, z.ZodBigInt]>, z.ZodBigInt>;
+    valueUsd: z.ZodNullable<z.ZodNumber>;
+    token: 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>;
+    isDelayed: z.ZodBoolean;
+  }, z.core.$strip>>;
+  claimableAt: z.ZodNumber;
+  redeemer: z.ZodOptional<z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>>;
+  intent: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
+    type: z.ZodLiteral<"INCREASE_LEVERAGE">;
+  }, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"DEPOSIT">;
+  }, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"DEPOSIT_AND_INCREASE_LEVERAGE">;
+  }, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"WITHDRAW_COLLATERAL">;
+    to: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
+    withdrawToken: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
+    withdrawAmount: z.ZodCodec<z.ZodUnion<[z.ZodString, z.ZodBigInt]>, z.ZodBigInt>;
+    sourceToken: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
+    debtRepaid: z.ZodCodec<z.ZodUnion<[z.ZodString, z.ZodBigInt]>, z.ZodBigInt>;
+  }, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"CLOSE_ACCOUNT">;
+    to: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
+  }, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"ADD_COLLATERAL">;
+  }, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"DECREASE_LEVERAGE">;
+  }, z.core.$strip>], "type">>;
+}, z.core.$strip>;
+/**
+ * {@link PositionWithdrawals}
+ **/
+declare const positionWithdrawalsSchema: z.ZodObject<{
+  claimable: z.ZodArray<z.ZodObject<{
+    sourceToken: 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>;
+    withdrawalPhantomToken: z.ZodObject<{
+      value: z.ZodCodec<z.ZodUnion<[z.ZodString, z.ZodBigInt]>, z.ZodBigInt>;
+      valueUsd: z.ZodNullable<z.ZodNumber>;
+      token: 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>;
+    outputs: z.ZodArray<z.ZodObject<{
+      value: z.ZodCodec<z.ZodUnion<[z.ZodString, z.ZodBigInt]>, z.ZodBigInt>;
+      valueUsd: z.ZodNullable<z.ZodNumber>;
+      token: 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>;
+      isDelayed: z.ZodBoolean;
+    }, z.core.$strip>>;
+    claimCall: z.ZodObject<{
+      to: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
+      callData: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
+      value: z.ZodOptional<z.ZodCodec<z.ZodUnion<[z.ZodString, z.ZodBigInt]>, z.ZodBigInt>>;
+    }, z.core.$strip>;
+    redeemer: z.ZodOptional<z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>>;
+    intent: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
+      type: z.ZodLiteral<"INCREASE_LEVERAGE">;
+    }, z.core.$strip>, z.ZodObject<{
+      type: z.ZodLiteral<"DEPOSIT">;
+    }, z.core.$strip>, z.ZodObject<{
+      type: z.ZodLiteral<"DEPOSIT_AND_INCREASE_LEVERAGE">;
+    }, z.core.$strip>, z.ZodObject<{
+      type: z.ZodLiteral<"WITHDRAW_COLLATERAL">;
+      to: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
+      withdrawToken: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
+      withdrawAmount: z.ZodCodec<z.ZodUnion<[z.ZodString, z.ZodBigInt]>, z.ZodBigInt>;
+      sourceToken: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
+      debtRepaid: z.ZodCodec<z.ZodUnion<[z.ZodString, z.ZodBigInt]>, z.ZodBigInt>;
+    }, z.core.$strip>, z.ZodObject<{
+      type: z.ZodLiteral<"CLOSE_ACCOUNT">;
+      to: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
+    }, z.core.$strip>, z.ZodObject<{
+      type: z.ZodLiteral<"ADD_COLLATERAL">;
+    }, z.core.$strip>, z.ZodObject<{
+      type: z.ZodLiteral<"DECREASE_LEVERAGE">;
+    }, z.core.$strip>], "type">>;
+  }, z.core.$strip>>;
+  pending: z.ZodArray<z.ZodObject<{
+    sourceToken: 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>;
+    withdrawalPhantomToken: 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>;
+    expectedOutputs: z.ZodArray<z.ZodObject<{
+      value: z.ZodCodec<z.ZodUnion<[z.ZodString, z.ZodBigInt]>, z.ZodBigInt>;
+      valueUsd: z.ZodNullable<z.ZodNumber>;
+      token: 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>;
+      isDelayed: z.ZodBoolean;
+    }, z.core.$strip>>;
+    claimableAt: z.ZodNumber;
+    redeemer: z.ZodOptional<z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>>;
+    intent: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
+      type: z.ZodLiteral<"INCREASE_LEVERAGE">;
+    }, z.core.$strip>, z.ZodObject<{
+      type: z.ZodLiteral<"DEPOSIT">;
+    }, z.core.$strip>, z.ZodObject<{
+      type: z.ZodLiteral<"DEPOSIT_AND_INCREASE_LEVERAGE">;
+    }, z.core.$strip>, z.ZodObject<{
+      type: z.ZodLiteral<"WITHDRAW_COLLATERAL">;
+      to: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
+      withdrawToken: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
+      withdrawAmount: z.ZodCodec<z.ZodUnion<[z.ZodString, z.ZodBigInt]>, z.ZodBigInt>;
+      sourceToken: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
+      debtRepaid: z.ZodCodec<z.ZodUnion<[z.ZodString, z.ZodBigInt]>, z.ZodBigInt>;
+    }, z.core.$strip>, z.ZodObject<{
+      type: z.ZodLiteral<"CLOSE_ACCOUNT">;
+      to: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
+    }, z.core.$strip>, z.ZodObject<{
+      type: z.ZodLiteral<"ADD_COLLATERAL">;
+    }, z.core.$strip>, z.ZodObject<{
+      type: z.ZodLiteral<"DECREASE_LEVERAGE">;
+    }, z.core.$strip>], "type">>;
+  }, z.core.$strip>>;
+}, z.core.$strip>;
+//#endregion
+export { positionClaimableWithdrawalSchema, positionPendingWithdrawalSchema, positionWithdrawalsSchema, withdrawalOutputAmountSchema };

package/dist/types/offchain/GearboxAPI.d.ts

@@ -1,5 +1,7 @@
 import { ChainId } from "../model/primitives.js";
 import { GearboxAPIOptions } from "./types.js";
+import { OffchainAnalytics } from "./analytics/OffchainAnalytics.js";
+import "./analytics/index.js";
 import { OffchainNotices } from "./notices/OffchainNotices.js";
 import "./notices/index.js";
 import { OffchainOpportunities } from "./opportunities/OffchainOpportunities.js";
@@ -29,6 +31,8 @@ declare class GearboxAPI {
    * Chains every read of this client is scoped to.
    **/
   readonly chainIds: readonly ChainId[];
+  /** Protocol-wide, backend-only analytics. */
+  readonly analytics: OffchainAnalytics;
   /**
    * Namespace for pool and strategy opportunities.
    **/

package/dist/types/offchain/analytics/OffchainAnalytics.d.ts

@@ -0,0 +1,23 @@
+import { ChartBundle, ChartRange, ProtocolChartMetric } from "../../model/charts.js";
+import { ChainScopedFilter } from "../../model/filters.js";
+import { DataResponse } from "../../model/response.js";
+import { GearboxAPIOptions } from "../types.js";
+import { AbstractOffchainNamespace } from "../AbstractOffchainNamespace.js";
+import { IOffchainAnalytics } from "./types.js";
+import { OffchainAnalyticsPositions } from "./OffchainAnalyticsPositions.js";
+//#region src/offchain/analytics/OffchainAnalytics.d.ts
+/**
+ * Backend-only protocol analytics, grouped by subject.
+ *
+ * It owns the protocol-wide charts itself rather than through a sub-namespace:
+ * their subject is Gearbox as a whole, so there is nothing narrower for them to
+ * hang off.
+ **/
+declare class OffchainAnalytics extends AbstractOffchainNamespace implements IOffchainAnalytics {
+  readonly positions: OffchainAnalyticsPositions;
+  constructor(options: GearboxAPIOptions);
+  /** {@inheritDoc IOffchainAnalytics.getCharts} */
+  getCharts<const Metrics extends readonly ProtocolChartMetric[]>(metrics: Metrics, range: ChartRange, filter?: ChainScopedFilter): Promise<DataResponse<ChartBundle<Metrics>>>;
+}
+//#endregion
+export { OffchainAnalytics };

package/dist/types/offchain/analytics/OffchainAnalyticsPositions.d.ts

@@ -0,0 +1,14 @@
+import { AnalyticsPositionListOptions, AnalyticsPositionPage } from "../../model/analytics.js";
+import { DataResponse } from "../../model/response.js";
+import { GearboxAPIOptions } from "../types.js";
+import { AbstractOffchainNamespace } from "../AbstractOffchainNamespace.js";
+import { IOffchainAnalyticsPositions } from "./types.js";
+//#region src/offchain/analytics/OffchainAnalyticsPositions.d.ts
+/** Backend client for protocol-wide position analytics. */
+declare class OffchainAnalyticsPositions extends AbstractOffchainNamespace implements IOffchainAnalyticsPositions {
+  constructor(options: GearboxAPIOptions);
+  /** {@inheritDoc IOffchainAnalyticsPositions.list} */
+  list(options?: AnalyticsPositionListOptions): Promise<DataResponse<AnalyticsPositionPage>>;
+}
+//#endregion
+export { OffchainAnalyticsPositions };

package/dist/types/offchain/analytics/index.d.ts

@@ -0,0 +1,4 @@
+import { IOffchainAnalytics, IOffchainAnalyticsPositions } from "./types.js";
+import { OffchainAnalyticsPositions } from "./OffchainAnalyticsPositions.js";
+import { OffchainAnalytics } from "./OffchainAnalytics.js";
+export { IOffchainAnalytics, IOffchainAnalyticsPositions, OffchainAnalytics, OffchainAnalyticsPositions };

package/dist/types/offchain/analytics/types.d.ts

@@ -0,0 +1,28 @@
+import { ChartBundle, ChartRange, ProtocolChartMetric } from "../../model/charts.js";
+import { ChainScopedFilter } from "../../model/filters.js";
+import { AnalyticsPositionListOptions, AnalyticsPositionPage } from "../../model/analytics.js";
+import { DataResponse } from "../../model/response.js";
+//#region src/offchain/analytics/types.d.ts
+/** Protocol-wide position reads served by the backend. */
+interface IOffchainAnalyticsPositions {
+  /**
+   * Every current position in the protocol, with its owning borrower, after
+   * applying the requested filter, ordering and pagination.
+   **/
+  list(options?: AnalyticsPositionListOptions): Promise<DataResponse<AnalyticsPositionPage>>;
+}
+/** Backend-only protocol analytics, grouped by subject. */
+interface IOffchainAnalytics {
+  readonly positions: IOffchainAnalyticsPositions;
+  /**
+   * Charts of the protocol as a whole: one series per metric named, onto the
+   * one grid that lets them be compared at an index.
+   *
+   * The series sums the chains the read covers, which are the client's own
+   * narrowed by `filter` — so a client built for one chain charts that chain,
+   * not the protocol.
+   **/
+  getCharts<const Metrics extends readonly ProtocolChartMetric[]>(metrics: Metrics, range: ChartRange, filter?: ChainScopedFilter): Promise<DataResponse<ChartBundle<Metrics>>>;
+}
+//#endregion
+export { IOffchainAnalytics, IOffchainAnalyticsPositions };

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

@@ -1,9 +1,15 @@
 import { GearboxAPIOptions } from "./types.js";
 import { AbstractOffchainNamespace, OffchainGetRequest, OffchainQuery } from "./AbstractOffchainNamespace.js";
+import { IOffchainAnalytics, IOffchainAnalyticsPositions } from "./analytics/types.js";
+import { OffchainAnalyticsPositions } from "./analytics/OffchainAnalyticsPositions.js";
+import { OffchainAnalytics } from "./analytics/OffchainAnalytics.js";
+import "./analytics/index.js";
 import { OffchainNotices } from "./notices/OffchainNotices.js";
 import "./notices/index.js";
+import { IOffchainOpportunities, OpportunityChartMetricFor } from "./opportunities/types.js";
 import { OffchainOpportunities } from "./opportunities/OffchainOpportunities.js";
 import "./opportunities/index.js";
+import { IOffchainPositions, PositionChartMetricFor } from "./positions/types.js";
 import { OffchainPositions } from "./positions/OffchainPositions.js";
 import "./positions/index.js";
 import { GearboxAPI } from "./GearboxAPI.js";
@@ -18,4 +24,4 @@ import { backendMessage } from "./errors/backendMessage.js";
 import { ErrorCause, errorCause } from "./errors/errorCause.js";
 import { readResponseBody } from "./errors/readResponseBody.js";
 import "./errors/index.js";
-export { AbstractOffchainNamespace, ErrorCause, GearboxAPI, GearboxAPIOptions, OffchainGetRequest, OffchainInvalidJsonError, OffchainNotConfiguredError, OffchainNotImplementedError, OffchainNotices, OffchainOpportunities, OffchainPositions, OffchainQuery, OffchainRequestFailedError, OffchainStatusError, OffchainTransportError, OffchainTransportErrorParams, OffchainValidationError, backendMessage, errorCause, readResponseBody };
+export { AbstractOffchainNamespace, ErrorCause, GearboxAPI, GearboxAPIOptions, IOffchainAnalytics, IOffchainAnalyticsPositions, IOffchainOpportunities, IOffchainPositions, OffchainAnalytics, OffchainAnalyticsPositions, OffchainGetRequest, OffchainInvalidJsonError, OffchainNotConfiguredError, OffchainNotImplementedError, OffchainNotices, OffchainOpportunities, OffchainPositions, OffchainQuery, OffchainRequestFailedError, OffchainStatusError, OffchainTransportError, OffchainTransportErrorParams, OffchainValidationError, OpportunityChartMetricFor, PositionChartMetricFor, backendMessage, errorCause, readResponseBody };

package/dist/types/offchain/opportunities/OffchainOpportunities.d.ts

@@ -1,34 +1,34 @@
-import { ChartBundle, ChartRange, PoolOpportunityChartMetric, StrategyOpportunityChartMetric } from "../../model/charts.js";
-import { Opportunity, OpportunityFilter, OpportunityKey, PoolOpportunityDetail, PoolOpportunityKey, StrategyOpportunityDetail, StrategyOpportunityKey } from "../../model/opportunities.js";
+import { ChartBundle, ChartRange } from "../../model/charts.js";
+import { Opportunity, OpportunityFilter, OpportunityKey, OpportunityTotals, PoolOpportunityDetail, PoolOpportunityKey, StrategyOpportunityDetail, StrategyOpportunityKey } from "../../model/opportunities.js";
 import { DataResponse } from "../../model/response.js";
 import { GearboxAPIOptions } from "../types.js";
 import { AbstractOffchainNamespace } from "../AbstractOffchainNamespace.js";
+import { IOffchainOpportunities, OpportunityChartMetricFor } from "./types.js";
 //#region src/offchain/opportunities/OffchainOpportunities.d.ts
-type OpportunityChartMetricFor<K extends OpportunityKey> = {
-  pool: PoolOpportunityChartMetric;
-  strategy: StrategyOpportunityChartMetric;
-}[K["kind"]];
 /**
  * Backend counterpart of the `opportunities` namespace.
  **/
-declare class OffchainOpportunities extends AbstractOffchainNamespace {
+declare class OffchainOpportunities extends AbstractOffchainNamespace implements IOffchainOpportunities {
   #private;
   constructor(options: GearboxAPIOptions);
   /**
-   * Opportunities of the chains this client covers, optionally narrowed further
-   * by {@link OpportunityFilter}.
+   * {@inheritDoc IOffchainOpportunities.list}
    **/
   list(filter?: OpportunityFilter): Promise<DataResponse<Opportunity[]>>;
   /**
-   * Detailed view of one pool opportunity.
+   * {@inheritDoc IOffchainOpportunities.getPool}
    **/
   getPool(key: PoolOpportunityKey): Promise<DataResponse<PoolOpportunityDetail>>;
   /**
-   * Detailed view of one strategy opportunity.
+   * {@inheritDoc IOffchainOpportunities.getStrategy}
    **/
   getStrategy(key: StrategyOpportunityKey): Promise<DataResponse<StrategyOpportunityDetail>>;
   /**
-   * Charts of one opportunity: one series per metric, on a shared grid.
+   * {@inheritDoc IOffchainOpportunities.getTotals}
+   **/
+  getTotals(): Promise<DataResponse<OpportunityTotals>>;
+  /**
+   * {@inheritDoc IOffchainOpportunities.getCharts}
    **/
   getCharts<K extends OpportunityKey, const Metrics extends readonly OpportunityChartMetricFor<K>[]>(key: K, metrics: Metrics, range: ChartRange): Promise<DataResponse<ChartBundle<Metrics>>>;
 }

package/dist/types/offchain/opportunities/index.d.ts

@@ -1,2 +1,3 @@
+import { IOffchainOpportunities, OpportunityChartMetricFor } from "./types.js";
 import { OffchainOpportunities } from "./OffchainOpportunities.js";
-export { OffchainOpportunities };
+export { IOffchainOpportunities, OffchainOpportunities, OpportunityChartMetricFor };

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

@@ -0,0 +1,36 @@
+import { ChartBundle, ChartRange, PoolOpportunityChartMetric, StrategyOpportunityChartMetric } from "../../model/charts.js";
+import { Opportunity, OpportunityFilter, OpportunityKey, OpportunityTotals, PoolOpportunityDetail, PoolOpportunityKey, StrategyOpportunityDetail, StrategyOpportunityKey } from "../../model/opportunities.js";
+import { DataResponse } from "../../model/response.js";
+//#region src/offchain/opportunities/types.d.ts
+type OpportunityChartMetricFor<K extends OpportunityKey> = {
+  pool: PoolOpportunityChartMetric;
+  strategy: StrategyOpportunityChartMetric;
+}[K["kind"]];
+/**
+ * Backend counterpart of the `opportunities` namespace.
+ **/
+interface IOffchainOpportunities {
+  /**
+   * Opportunities of the chains this client covers, optionally narrowed further
+   * by {@link OpportunityFilter}.
+   **/
+  list(filter?: OpportunityFilter): Promise<DataResponse<Opportunity[]>>;
+  /**
+   * Detailed view of one pool opportunity.
+   **/
+  getPool(key: PoolOpportunityKey): Promise<DataResponse<PoolOpportunityDetail>>;
+  /**
+   * Detailed view of one strategy opportunity.
+   **/
+  getStrategy(key: StrategyOpportunityKey): Promise<DataResponse<StrategyOpportunityDetail>>;
+  /**
+   * Protocol-wide totals across every opportunity the backend serves.
+   **/
+  getTotals(): Promise<DataResponse<OpportunityTotals>>;
+  /**
+   * Charts of one opportunity: one series per metric, on a shared grid.
+   **/
+  getCharts<K extends OpportunityKey, const Metrics extends readonly OpportunityChartMetricFor<K>[]>(key: K, metrics: Metrics, range: ChartRange): Promise<DataResponse<ChartBundle<Metrics>>>;
+}
+//#endregion
+export { IOffchainOpportunities, OpportunityChartMetricFor };