@gearbox-protocol/sdk 10.2.9 → 10.3.0

package/dist/types/abi/IWithdrawalCompressorV310.d.ts

@@ -0,0 +1,208 @@
+export declare const iWithdrawalCompressorV310Abi: readonly [{
+    readonly type: "function";
+    readonly inputs: readonly [];
+    readonly name: "contractType";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly internalType: "bytes32";
+        readonly type: "bytes32";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly inputs: readonly [{
+        readonly name: "creditAccount";
+        readonly internalType: "address";
+        readonly type: "address";
+    }];
+    readonly name: "getCurrentWithdrawals";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly internalType: "struct ClaimableWithdrawal[]";
+        readonly type: "tuple[]";
+        readonly components: readonly [{
+            readonly name: "token";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "withdrawalPhantomToken";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "withdrawalTokenSpent";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }, {
+            readonly name: "outputs";
+            readonly internalType: "struct WithdrawalOutput[]";
+            readonly type: "tuple[]";
+            readonly components: readonly [{
+                readonly name: "token";
+                readonly internalType: "address";
+                readonly type: "address";
+            }, {
+                readonly name: "isDelayed";
+                readonly internalType: "bool";
+                readonly type: "bool";
+            }, {
+                readonly name: "amount";
+                readonly internalType: "uint256";
+                readonly type: "uint256";
+            }];
+        }, {
+            readonly name: "claimCalls";
+            readonly internalType: "struct MultiCall[]";
+            readonly type: "tuple[]";
+            readonly components: readonly [{
+                readonly name: "target";
+                readonly internalType: "address";
+                readonly type: "address";
+            }, {
+                readonly name: "callData";
+                readonly internalType: "bytes";
+                readonly type: "bytes";
+            }];
+        }];
+    }, {
+        readonly name: "";
+        readonly internalType: "struct PendingWithdrawal[]";
+        readonly type: "tuple[]";
+        readonly components: readonly [{
+            readonly name: "token";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "withdrawalPhantomToken";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "expectedOutputs";
+            readonly internalType: "struct WithdrawalOutput[]";
+            readonly type: "tuple[]";
+            readonly components: readonly [{
+                readonly name: "token";
+                readonly internalType: "address";
+                readonly type: "address";
+            }, {
+                readonly name: "isDelayed";
+                readonly internalType: "bool";
+                readonly type: "bool";
+            }, {
+                readonly name: "amount";
+                readonly internalType: "uint256";
+                readonly type: "uint256";
+            }];
+        }, {
+            readonly name: "claimableAt";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly inputs: readonly [{
+        readonly name: "creditManager";
+        readonly internalType: "address";
+        readonly type: "address";
+    }];
+    readonly name: "getWithdrawableAssets";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly internalType: "struct WithdrawableAsset[]";
+        readonly type: "tuple[]";
+        readonly components: readonly [{
+            readonly name: "token";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "withdrawalPhantomToken";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "underlying";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "withdrawalLength";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly inputs: readonly [{
+        readonly name: "creditAccount";
+        readonly internalType: "address";
+        readonly type: "address";
+    }, {
+        readonly name: "token";
+        readonly internalType: "address";
+        readonly type: "address";
+    }, {
+        readonly name: "amount";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }];
+    readonly name: "getWithdrawalRequestResult";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly internalType: "struct RequestableWithdrawal";
+        readonly type: "tuple";
+        readonly components: readonly [{
+            readonly name: "token";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "amountIn";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }, {
+            readonly name: "outputs";
+            readonly internalType: "struct WithdrawalOutput[]";
+            readonly type: "tuple[]";
+            readonly components: readonly [{
+                readonly name: "token";
+                readonly internalType: "address";
+                readonly type: "address";
+            }, {
+                readonly name: "isDelayed";
+                readonly internalType: "bool";
+                readonly type: "bool";
+            }, {
+                readonly name: "amount";
+                readonly internalType: "uint256";
+                readonly type: "uint256";
+            }];
+        }, {
+            readonly name: "requestCalls";
+            readonly internalType: "struct MultiCall[]";
+            readonly type: "tuple[]";
+            readonly components: readonly [{
+                readonly name: "target";
+                readonly internalType: "address";
+                readonly type: "address";
+            }, {
+                readonly name: "callData";
+                readonly internalType: "bytes";
+                readonly type: "bytes";
+            }];
+        }, {
+            readonly name: "claimableAt";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly inputs: readonly [];
+    readonly name: "version";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "view";
+}];

package/dist/types/plugins/delayed-withdrawal/DelayedWithdrawalPlugin.d.ts

@@ -0,0 +1,20 @@
+import type { Address } from "viem";
+import type { IGearboxSDKPlugin } from "../../sdk/index.js";
+import { AddressMap, BasePlugin } from "../../sdk/index.js";
+import type { WithdrawableAsset, WithdrawableAssetStateHuman } from "./types.js";
+export interface DelayedWithdrawalPluginState {
+    withdrawableAssets: Record<Address, Array<WithdrawableAsset>>;
+}
+export declare class DelayedWithdrawalPlugin extends BasePlugin<DelayedWithdrawalPluginState> implements IGearboxSDKPlugin<DelayedWithdrawalPluginState> {
+    #private;
+    load(force?: boolean): Promise<DelayedWithdrawalPluginState>;
+    get loaded(): boolean;
+    /**
+     * Returns a map of cmAddress -> array of delayed assets
+     * @throws if plugin is not attached
+     */
+    get withdrawableAssets(): AddressMap<Array<WithdrawableAsset>>;
+    stateHuman(_?: boolean): WithdrawableAssetStateHuman[];
+    get state(): DelayedWithdrawalPluginState;
+    hydrate(state: DelayedWithdrawalPluginState): void;
+}

package/dist/types/plugins/delayed-withdrawal/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./DelayedWithdrawalPlugin.js";
+export * from "./types.js";

package/dist/types/plugins/delayed-withdrawal/types.d.ts

@@ -0,0 +1,10 @@
+import type { Address, GetContractReturnType, PublicClient } from "viem";
+import type { iWithdrawalCompressorV310Abi } from "../../abi/IWithdrawalCompressorV310.js";
+import type { BaseContractStateHuman } from "../../sdk/index.js";
+type WithdrawalCompressorV310InstanceType = GetContractReturnType<typeof iWithdrawalCompressorV310Abi, PublicClient>;
+export type WithdrawableAsset = Awaited<ReturnType<WithdrawalCompressorV310InstanceType["read"]["getWithdrawableAssets"]>>[number] & {
+    creditManager: Address;
+};
+export interface WithdrawableAssetStateHuman extends WithdrawableAsset, BaseContractStateHuman {
+}
+export {};

package/dist/types/sdk/accountMigration/AbstractMigrateCreditAccountsService.d.ts

@@ -35,5 +35,5 @@ export declare abstract class AbstractMigrateCreditAccountsService extends SDKCo
     };
     static getTokensAfterMigration<T extends Asset>(balances: Array<T> | Record<Address, T>, chainId: number): Array<T>;
     static checkSourceCreditManager(sourceCreditManager: Address, migrationBot: Address, sdk: GearboxSDK): boolean;
-    static isSourceMigratableToTargetCM(targetTokensToMigrate: Array<Asset>, source: CreditAccountData_Legacy, target: CreditManagerData_Legacy, delayedPhantoms: Record<Address, object>, sdk: GearboxSDK): boolean;
+    static isSourceMigratableToTargetCM(targetTokensToMigrate: Array<Asset>, source: CreditAccountData_Legacy, target: CreditManagerData_Legacy, delayedPhantoms: Record<Address, boolean>, sdk: GearboxSDK): boolean;
 }

package/dist/types/sdk/accounts/AbstractCreditAccountsService.d.ts

@@ -5,10 +5,11 @@ import type { GearboxSDK } from "../GearboxSDK.js";
 import type { OnDemandPriceUpdates, PriceUpdateV300, PriceUpdateV310, UpdatePriceFeedsResult } from "../market/index.js";
 import { type Asset, type RouterCASlice } from "../router/index.js";
 import type { MultiCall } from "../types/index.js";
-import type { AddCollateralProps, ChangeDeptProps, ClaimDelayedProps, CloseCreditAccountProps, CloseCreditAccountResult, CreditAccountOperationResult, EnableTokensProps, ExecuteSwapProps, FullyLiquidateProps, GetConnectedBotsResult, GetConnectedMigrationBotsResult, GetCreditAccountsOptions, OpenCAProps, PermitResult, PrepareUpdateQuotasProps, PriceUpdatesOptions, Rewards, StartDelayedWithdrawalProps, UpdateQuotasProps } from "./types.js";
+import type { AddCollateralProps, ChangeDeptProps, ClaimDelayedProps, CloseCreditAccountProps, CloseCreditAccountResult, CreditAccountOperationResult, EnableTokensProps, ExecuteSwapProps, FullyLiquidateProps, GetConnectedBotsResult, GetConnectedMigrationBotsResult, GetCreditAccountsOptions, GetPendingWithdrawalsProps, GetPendingWithdrawalsResult, OpenCAProps, PermitResult, PrepareUpdateQuotasProps, PreviewDelayedWithdrawalProps, PreviewDelayedWithdrawalResult, PriceUpdatesOptions, Rewards, StartDelayedWithdrawalProps, UpdateQuotasProps } from "./types.js";
 export interface CreditAccountServiceOptions {
     batchSize?: number;
 }
+export declare function getWithdrawalCompressorAddress(chainId: number): "0xfB79b6713fe214B8748ED7b0db1f93E4f1aC9d29" | undefined;
 export declare abstract class AbstractCreditAccountService extends SDKConstruct {
     #private;
     constructor(sdk: GearboxSDK, options?: CreditAccountServiceOptions);
@@ -115,20 +116,32 @@ export declare abstract class AbstractCreditAccountService extends SDKConstruct
      * @returns All necessary data to execute the transaction (call, credit facade)
      */
     executeSwap({ creditAccount, calls: swapCalls, minQuota, averageQuota, }: ExecuteSwapProps): Promise<CreditAccountOperationResult>;
+    /**
+     * Preview delayed withdrawal for given token
+     * @param props - {@link PreviewDelayedWithdrawalProps}
+     * @returns
+     */
+    previewDelayedWithdrawal({ creditAccount, amount, token, }: PreviewDelayedWithdrawalProps): Promise<PreviewDelayedWithdrawalResult>;
+    /**
+     * Get claimable and pending withdrawals of an account
+     * @param props - {@link GetPendingWithdrawalsProps}
+     * @returns
+     */
+    getPendingWithdrawals({ creditAccount, }: GetPendingWithdrawalsProps): Promise<GetPendingWithdrawalsResult>;
     /**
      * Start delayed withdrawal for given token
        - Withdrawal is executed in the following order: price update -> execute withdraw calls -> update quotas
      * @param props - {@link StartDelayedWithdrawalProps}
      * @returns
     */
-    startDelayedWithdrawal_Mellow({ creditAccount, minQuota, averageQuota, instantWithdrawals, delayedWithdrawals, sourceAmount, sourceToken, }: StartDelayedWithdrawalProps): Promise<CreditAccountOperationResult>;
+    startDelayedWithdrawal({ creditAccount, minQuota, averageQuota, preview, }: StartDelayedWithdrawalProps): Promise<CreditAccountOperationResult>;
     /**
      * Claim tokens with delayed withdrawal
        - Claim is executed in the following order: price update -> execute claim calls -> update quotas
      * @param props - {@link ClaimDelayedProps}
      * @returns
     */
-    claimDelayed_Mellow({ creditAccount, minQuota, averageQuota, sourceToken, phantom, target, }: ClaimDelayedProps): Promise<CreditAccountOperationResult>;
+    claimDelayed({ creditAccount, minQuota, averageQuota, claimableNow, }: ClaimDelayedProps): Promise<CreditAccountOperationResult>;
     /**
      * Executes enable/disable tokens specified by given tokens lists and token prices
      * @param {RouterCASlice} creditAccount - minimal credit account data {@link RouterCASlice} on which operation is performed

package/dist/types/sdk/accounts/types.d.ts

@@ -1,5 +1,6 @@
-import type { Address, ContractFunctionArgs } from "viem";
+import type { Address, ContractFunctionArgs, GetContractReturnType, PublicClient } from "viem";
 import type { creditAccountCompressorAbi } from "../../abi/compressors/creditAccountCompressor.js";
+import type { iWithdrawalCompressorV310Abi } from "../../abi/IWithdrawalCompressorV310.js";
 import type { LiquidationBotType as LiquidationBotTypeSDK } from "../../plugins/bots/types.js";
 import type { MigrationBotType } from "../accountMigration/types.js";
 import type { ConnectedBotData, CreditAccountData } from "../base/index.js";
@@ -168,41 +169,50 @@ export interface ExecuteSwapProps extends PrepareUpdateQuotasProps {
      */
     creditAccount: RouterCASlice;
 }
-export interface StartDelayedWithdrawalProps extends PrepareUpdateQuotasProps {
+export interface PreviewDelayedWithdrawalProps {
     /**
      * Amount of source token (ex. cp0xlrt)
      */
-    sourceAmount: bigint;
+    amount: bigint;
     /**
      * Address of source token (ex. cp0xlrt)
      */
-    sourceToken: Address;
-    /**
-     * Array of token which can be instantly withdrawn
-     */
-    instantWithdrawals: Array<Asset>;
+    token: Address;
     /**
-     * Array of token which will be withdrawn with a delay
+     * Minimal credit account data on which operation is performed
      */
-    delayedWithdrawals: Array<Asset>;
+    creditAccount: Address;
+}
+export interface GetPendingWithdrawalsProps {
     /**
      * Minimal credit account data on which operation is performed
      */
-    creditAccount: RouterCASlice;
+    creditAccount: Address;
 }
-export interface ClaimDelayedProps extends PrepareUpdateQuotasProps {
+type WithdrawalCompressorV310InstanceType = GetContractReturnType<typeof iWithdrawalCompressorV310Abi, PublicClient>;
+export type PreviewDelayedWithdrawalResult = Awaited<ReturnType<WithdrawalCompressorV310InstanceType["read"]["getWithdrawalRequestResult"]>>;
+type PendingWithdrawalResult = Awaited<ReturnType<WithdrawalCompressorV310InstanceType["read"]["getCurrentWithdrawals"]>>;
+export type PendingWithdrawal = PendingWithdrawalResult[1][number];
+export type ClaimableWithdrawal = PendingWithdrawalResult[0][number];
+export interface GetPendingWithdrawalsResult {
+    claimableNow: Array<ClaimableWithdrawal>;
+    pending: Array<PendingWithdrawal>;
+}
+export interface StartDelayedWithdrawalProps extends PrepareUpdateQuotasProps {
     /**
-     * Address of source token (ex. sp0xlrt)
+     * Withdrawal preview
      */
-    sourceToken: Address;
+    preview: PreviewDelayedWithdrawalResult;
     /**
-     * Amount of phantom token
+     * Minimal credit account data on which operation is performed
      */
-    phantom: Asset;
+    creditAccount: RouterCASlice;
+}
+export interface ClaimDelayedProps extends PrepareUpdateQuotasProps {
     /**
-     * Amount of target token
+     * assets claimable now from getPendingWithdrawals
      */
-    target: Asset;
+    claimableNow: GetPendingWithdrawalsResult["claimableNow"][number];
     /**
      * Minimal credit account data on which operation is performed
      */
@@ -486,14 +496,26 @@ export interface ICreditAccountsService extends SDKConstruct {
      * @param props - {@link StartDelayedWithdrawalProps}
      * @returns All necessary data to execute the transaction (call, credit facade)
      */
-    startDelayedWithdrawal_Mellow(props: StartDelayedWithdrawalProps): Promise<CreditAccountOperationResult>;
+    startDelayedWithdrawal(props: StartDelayedWithdrawalProps): Promise<CreditAccountOperationResult>;
+    /**
+     * Preview delayed withdrawal for given token
+     * @param props - {@link PreviewDelayedWithdrawalProps}
+     * @returns
+     */
+    previewDelayedWithdrawal(props: PreviewDelayedWithdrawalProps): Promise<PreviewDelayedWithdrawalResult>;
+    /**
+     * Get claimable and pending withdrawals of an account
+     * @param props - {@link GetPendingWithdrawalsProps}
+     * @returns
+     */
+    getPendingWithdrawals(props: GetPendingWithdrawalsProps): Promise<GetPendingWithdrawalsResult>;
     /**
      * Claim tokens with delayed withdrawal
        - Claim is executed in the following order: price update -> execute claim calls -> update quotas
      * @param props - {@link ClaimDelayedProps}
      * @returns
     */
-    claimDelayed_Mellow(props: ClaimDelayedProps): Promise<CreditAccountOperationResult>;
+    claimDelayed(props: ClaimDelayedProps): Promise<CreditAccountOperationResult>;
     /**
      * Executes enable/disable tokens specified by given tokens lists and token prices
      * @param props - {@link EnableTokensProps}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/sdk",
-  "version": "10.2.9",
+  "version": "10.3.0",
   "description": "Gearbox SDK",
   "license": "MIT",
   "main": "./dist/cjs/sdk/index.js",