@gearbox-protocol/sdk 14.12.0-next.17 → 14.12.0-next.19

package/dist/types/sdk/accounts/withdrawal-compressor/intent.d.ts

@@ -0,0 +1,106 @@
+import type { Hex } from "viem";
+import { z } from "zod/v4";
+/**
+ * App: 1.1 Deposit and 4.1 Adjust leverage — raise leverage at fixed TVL.
+ * Borrow `underlying` -> swap `underlying` into `targetToken` -> [withdraw to wallet].
+ **/
+export declare const delayedIncreaseLeverageIntentSchema: z.ZodObject<{
+    type: z.ZodLiteral<"INCREASE_LEVERAGE">;
+    to: z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>;
+}, z.core.$strip>;
+export type DelayedIncreaseLeverageIntent = z.infer<typeof delayedIncreaseLeverageIntentSchema>;
+/**
+ * App: 1.2 Deposit — `amount > 0`, leverage = current (grow net value at same L).
+ **/
+export declare const delayedDepositIntentSchema: z.ZodObject<{
+    type: z.ZodLiteral<"DEPOSIT">;
+}, z.core.$strip>;
+export type DelayedDepositIntent = z.infer<typeof delayedDepositIntentSchema>;
+/**
+ * App: 1.3 Deposit and Adjust leverage — `amount > 0`, leverage > current.
+ **/
+export declare const delayedDepositAndIncreaseLeverageIntentSchema: z.ZodObject<{
+    type: z.ZodLiteral<"DEPOSIT_AND_INCREASE_LEVERAGE">;
+}, z.core.$strip>;
+export type DelayedDepositAndIncreaseLeverageIntent = z.infer<typeof delayedDepositAndIncreaseLeverageIntentSchema>;
+/**
+ * App: 2.1 Withdraw — withdraw selected token at fixed leverage.
+ **/
+export declare const delayedWithdrawCollateralIntentSchema: z.ZodObject<{
+    type: z.ZodLiteral<"WITHDRAW_COLLATERAL">;
+    to: z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>;
+    withdrawToken: z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>;
+    withdrawAmount: z.ZodBigInt;
+}, z.core.$strip>;
+export type DelayedWithdrawCollateralIntent = z.infer<typeof delayedWithdrawCollateralIntentSchema>;
+/**
+ * App: 2.2 Withdraw — close account (receive leftover to wallet).
+ **/
+export declare const delayedCloseAccountIntentSchema: z.ZodObject<{
+    type: z.ZodLiteral<"CLOSE_ACCOUNT">;
+    to: z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>;
+}, z.core.$strip>;
+export type DelayedCloseAccountIntent = z.infer<typeof delayedCloseAccountIntentSchema>;
+/**
+ * App: 3.1 Add collateral — fixed debt.
+ **/
+export declare const delayedAddCollateralIntentSchema: z.ZodObject<{
+    type: z.ZodLiteral<"ADD_COLLATERAL">;
+}, z.core.$strip>;
+export type DelayedAddCollateralIntent = z.infer<typeof delayedAddCollateralIntentSchema>;
+/**
+ * App: 4.2 Adjust leverage — lower leverage at fixed TVL.
+ **/
+export declare const delayedDecreaseLeverageIntentSchema: z.ZodObject<{
+    type: z.ZodLiteral<"DECREASE_LEVERAGE">;
+}, z.core.$strip>;
+export type DelayedDecreaseLeverageIntent = z.infer<typeof delayedDecreaseLeverageIntentSchema>;
+/**
+ * Lean intent that is abi-encoded into `extraData` of a delayed withdrawal
+ * request and decoded back when reading claimable withdrawals.
+ **/
+export declare const delayedIntentSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    type: z.ZodLiteral<"INCREASE_LEVERAGE">;
+    to: z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>;
+}, 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.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>;
+    withdrawToken: z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>;
+    withdrawAmount: z.ZodBigInt;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"CLOSE_ACCOUNT">;
+    to: z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, 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">;
+export type DelayedIntent = z.infer<typeof delayedIntentSchema>;
+/**
+ * Current version of the delayed intent encoding schema.
+ * Bump when the layout of any intent type changes.
+ **/
+export declare const DELAYED_INTENT_VERSION = 1;
+/**
+ * Stable uint8 discriminants for intent types.
+ * Starts at 1 so that all-zero data cannot decode as a valid intent.
+ * Never reuse or renumber existing values.
+ **/
+export declare const DELAYED_INTENT_TYPES: Record<DelayedIntent["type"], number>;
+/**
+ * ABI-encodes a delayed intent as
+ * `(uint8 version, uint8 intentType, ...intent-specific fields)`.
+ * @throws if the intent does not match {@link delayedIntentSchema}
+ **/
+export declare function encodeDelayedIntent(intent: DelayedIntent): Hex;
+/**
+ * Decodes a delayed intent from abi-encoded `extraData` and validates it
+ * against {@link delayedIntentSchema}.
+ * @throws if data is empty, has an unsupported version, an unknown intent
+ * type, or does not match the schema
+ **/
+export declare function decodeDelayedIntent(data: Hex): DelayedIntent;

package/dist/types/sdk/accounts/withdrawal-compressor/types.d.ts

@@ -0,0 +1,122 @@
+import type { Address } from "viem";
+import type { IBaseContract } from "../../base/index.js";
+import type { MultiCall } from "../../types/index.js";
+import type { DelayedIntent } from "./intent.js";
+/**
+ * Delayed intent decoded from `extraData`, enriched with data known at read time.
+ **/
+export type DelayedIntentExtended = DelayedIntent & {
+    /**
+     * Credit manager of the credit account the withdrawal belongs to
+     **/
+    creditManager: Address;
+};
+/**
+ * A single output of a (delayed) withdrawal.
+ **/
+export interface WithdrawalOutput {
+    token: Address;
+    isDelayed: boolean;
+    amount: bigint;
+}
+/**
+ * An asset that can be withdrawn from a credit manager via delayed withdrawal.
+ **/
+export interface WithdrawableAsset {
+    /**
+     * Credit manager the asset is withdrawable from
+     **/
+    creditManager: Address;
+    /**
+     * Source token (e.g. rstETH)
+     **/
+    token: Address;
+    /**
+     * Withdrawal phantom token (e.g. wdwstETH)
+     **/
+    withdrawalPhantomToken: Address;
+    /**
+     * Target token (e.g. wstETH)
+     **/
+    underlying: Address;
+    withdrawalLength: bigint;
+    /**
+     * Not available on v310 compressors
+     **/
+    maxWithdrawals?: bigint;
+}
+/**
+ * A single delayed withdrawal that is ready to be claimed.
+ **/
+export interface ClaimableWithdrawal {
+    token: Address;
+    withdrawalPhantomToken: Address;
+    withdrawalTokenSpent: bigint;
+    outputs: WithdrawalOutput[];
+    claimCalls: MultiCall[];
+    /**
+     * Delayed intent decoded from the withdrawal's `extraData`, enriched with
+     * the credit manager of the credit account. `undefined` on compressor
+     * versions below 313, and on v313+ when the withdrawal was requested
+     * without an intent (empty `extraData`).
+     **/
+    intent?: DelayedIntentExtended;
+}
+/**
+ * A single pending delayed withdrawal that is not yet claimable.
+ **/
+export interface PendingWithdrawal {
+    token: Address;
+    withdrawalPhantomToken: Address;
+    expectedOutputs: WithdrawalOutput[];
+    claimableAt: bigint;
+}
+/**
+ * Result of previewing a delayed withdrawal request.
+ **/
+export interface RequestableWithdrawal {
+    token: Address;
+    amountIn: bigint;
+    outputs: WithdrawalOutput[];
+    requestCalls: MultiCall[];
+    claimableAt: bigint;
+}
+/**
+ * Delayed withdrawals of a credit account, split into immediately claimable
+ * and still-pending entries.
+ **/
+export interface CurrentWithdrawals {
+    claimable: ClaimableWithdrawal[];
+    /**
+     * Sorted by claimableAt in ascending order
+     **/
+    pending: PendingWithdrawal[];
+}
+/**
+ * Version-agnostic interface of the WithdrawalCompressor contract.
+ **/
+export interface IWithdrawalCompressorContract extends IBaseContract {
+    /**
+     * Returns assets that can be withdrawn from the given credit manager via delayed withdrawal.
+     **/
+    getWithdrawableAssets(creditManager: Address): Promise<WithdrawableAsset[]>;
+    /**
+     * Same as {@link getWithdrawableAssets}, but for multiple credit managers in a single multicall.
+     * Defaults to all credit managers known to the SDK's market register.
+     * Failed per-manager calls are logged and skipped.
+     **/
+    getWithdrawableAssetsBatch(creditManagers?: Address[]): Promise<WithdrawableAsset[]>;
+    /**
+     * Returns claimable and pending delayed withdrawals of the given credit account.
+     **/
+    getCurrentWithdrawals(creditAccount: Address): Promise<CurrentWithdrawals>;
+    /**
+     * Previews a delayed withdrawal request.
+     *
+     * When `intent` is provided, it is abi-encoded and passed as `extraData` to
+     * the contract on v313+ compressors. On older versions, passing an intent
+     * throws if `sdk.strictContractTypes` is `true`, otherwise a warning is
+     * logged and the intent is ignored.
+     **/
+    getWithdrawalRequestResult(creditAccount: Address, token: Address, amount: bigint, intent?: DelayedIntent): Promise<RequestableWithdrawal>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/sdk",
-  "version": "14.12.0-next.17",
+  "version": "14.12.0-next.19",
   "description": "Gearbox SDK",
   "license": "MIT",
   "repository": {