@gearbox-protocol/sdk 14.8.7 → 14.10.0-next.1

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

@@ -0,0 +1,327 @@
+export declare const iWithdrawalCompressorV311Abi: readonly [{
+    readonly inputs: readonly [{
+        readonly internalType: "address";
+        readonly name: "_owner";
+        readonly type: "address";
+    }, {
+        readonly internalType: "address";
+        readonly name: "addressProvider_";
+        readonly type: "address";
+    }];
+    readonly stateMutability: "nonpayable";
+    readonly type: "constructor";
+}, {
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly indexed: true;
+        readonly internalType: "address";
+        readonly name: "previousOwner";
+        readonly type: "address";
+    }, {
+        readonly indexed: true;
+        readonly internalType: "address";
+        readonly name: "newOwner";
+        readonly type: "address";
+    }];
+    readonly name: "OwnershipTransferred";
+    readonly type: "event";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "addressProvider";
+    readonly outputs: readonly [{
+        readonly internalType: "address";
+        readonly name: "";
+        readonly type: "address";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "bytes32";
+        readonly name: "";
+        readonly type: "bytes32";
+    }];
+    readonly name: "compressorTypeToCompressor";
+    readonly outputs: readonly [{
+        readonly internalType: "address";
+        readonly name: "";
+        readonly type: "address";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "contractType";
+    readonly outputs: readonly [{
+        readonly internalType: "bytes32";
+        readonly name: "";
+        readonly type: "bytes32";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "address";
+        readonly name: "creditAccount";
+        readonly type: "address";
+    }];
+    readonly name: "getCurrentWithdrawals";
+    readonly outputs: readonly [{
+        readonly components: readonly [{
+            readonly internalType: "address";
+            readonly name: "token";
+            readonly type: "address";
+        }, {
+            readonly internalType: "address";
+            readonly name: "withdrawalPhantomToken";
+            readonly type: "address";
+        }, {
+            readonly internalType: "uint256";
+            readonly name: "withdrawalTokenSpent";
+            readonly type: "uint256";
+        }, {
+            readonly components: readonly [{
+                readonly internalType: "address";
+                readonly name: "token";
+                readonly type: "address";
+            }, {
+                readonly internalType: "bool";
+                readonly name: "isDelayed";
+                readonly type: "bool";
+            }, {
+                readonly internalType: "uint256";
+                readonly name: "amount";
+                readonly type: "uint256";
+            }];
+            readonly internalType: "struct WithdrawalOutput[]";
+            readonly name: "outputs";
+            readonly type: "tuple[]";
+        }, {
+            readonly components: readonly [{
+                readonly internalType: "address";
+                readonly name: "target";
+                readonly type: "address";
+            }, {
+                readonly internalType: "bytes";
+                readonly name: "callData";
+                readonly type: "bytes";
+            }];
+            readonly internalType: "struct MultiCall[]";
+            readonly name: "claimCalls";
+            readonly type: "tuple[]";
+        }];
+        readonly internalType: "struct ClaimableWithdrawal[]";
+        readonly name: "";
+        readonly type: "tuple[]";
+    }, {
+        readonly components: readonly [{
+            readonly internalType: "address";
+            readonly name: "token";
+            readonly type: "address";
+        }, {
+            readonly internalType: "address";
+            readonly name: "withdrawalPhantomToken";
+            readonly type: "address";
+        }, {
+            readonly components: readonly [{
+                readonly internalType: "address";
+                readonly name: "token";
+                readonly type: "address";
+            }, {
+                readonly internalType: "bool";
+                readonly name: "isDelayed";
+                readonly type: "bool";
+            }, {
+                readonly internalType: "uint256";
+                readonly name: "amount";
+                readonly type: "uint256";
+            }];
+            readonly internalType: "struct WithdrawalOutput[]";
+            readonly name: "expectedOutputs";
+            readonly type: "tuple[]";
+        }, {
+            readonly internalType: "uint256";
+            readonly name: "claimableAt";
+            readonly type: "uint256";
+        }];
+        readonly internalType: "struct PendingWithdrawal[]";
+        readonly name: "";
+        readonly type: "tuple[]";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "address";
+        readonly name: "creditManager";
+        readonly type: "address";
+    }];
+    readonly name: "getWithdrawableAssets";
+    readonly outputs: readonly [{
+        readonly components: readonly [{
+            readonly internalType: "address";
+            readonly name: "token";
+            readonly type: "address";
+        }, {
+            readonly internalType: "address";
+            readonly name: "withdrawalPhantomToken";
+            readonly type: "address";
+        }, {
+            readonly internalType: "address";
+            readonly name: "underlying";
+            readonly type: "address";
+        }, {
+            readonly internalType: "uint256";
+            readonly name: "withdrawalLength";
+            readonly type: "uint256";
+        }, {
+            readonly internalType: "uint256";
+            readonly name: "maxWithdrawals";
+            readonly type: "uint256";
+        }];
+        readonly internalType: "struct WithdrawableAsset[]";
+        readonly name: "";
+        readonly type: "tuple[]";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "address";
+        readonly name: "creditAccount";
+        readonly type: "address";
+    }, {
+        readonly internalType: "address";
+        readonly name: "token";
+        readonly type: "address";
+    }, {
+        readonly internalType: "uint256";
+        readonly name: "amount";
+        readonly type: "uint256";
+    }];
+    readonly name: "getWithdrawalRequestResult";
+    readonly outputs: readonly [{
+        readonly components: readonly [{
+            readonly internalType: "address";
+            readonly name: "token";
+            readonly type: "address";
+        }, {
+            readonly internalType: "uint256";
+            readonly name: "amountIn";
+            readonly type: "uint256";
+        }, {
+            readonly components: readonly [{
+                readonly internalType: "address";
+                readonly name: "token";
+                readonly type: "address";
+            }, {
+                readonly internalType: "bool";
+                readonly name: "isDelayed";
+                readonly type: "bool";
+            }, {
+                readonly internalType: "uint256";
+                readonly name: "amount";
+                readonly type: "uint256";
+            }];
+            readonly internalType: "struct WithdrawalOutput[]";
+            readonly name: "outputs";
+            readonly type: "tuple[]";
+        }, {
+            readonly components: readonly [{
+                readonly internalType: "address";
+                readonly name: "target";
+                readonly type: "address";
+            }, {
+                readonly internalType: "bytes";
+                readonly name: "callData";
+                readonly type: "bytes";
+            }];
+            readonly internalType: "struct MultiCall[]";
+            readonly name: "requestCalls";
+            readonly type: "tuple[]";
+        }, {
+            readonly internalType: "uint256";
+            readonly name: "claimableAt";
+            readonly type: "uint256";
+        }];
+        readonly internalType: "struct RequestableWithdrawal";
+        readonly name: "withdrawal";
+        readonly type: "tuple";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "owner";
+    readonly outputs: readonly [{
+        readonly internalType: "address";
+        readonly name: "";
+        readonly type: "address";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "renounceOwnership";
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "address";
+        readonly name: "subcompressor";
+        readonly type: "address";
+    }];
+    readonly name: "setSubcompressor";
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "bytes32";
+        readonly name: "withdrawableType";
+        readonly type: "bytes32";
+    }, {
+        readonly internalType: "bytes32";
+        readonly name: "compressorType";
+        readonly type: "bytes32";
+    }];
+    readonly name: "setWithdrawableTypeToCompressorType";
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "address";
+        readonly name: "newOwner";
+        readonly type: "address";
+    }];
+    readonly name: "transferOwnership";
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "version";
+    readonly outputs: readonly [{
+        readonly internalType: "uint256";
+        readonly name: "";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "bytes32";
+        readonly name: "";
+        readonly type: "bytes32";
+    }];
+    readonly name: "withdrawableTypeToCompressorType";
+    readonly outputs: readonly [{
+        readonly internalType: "bytes32";
+        readonly name: "";
+        readonly type: "bytes32";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}];

package/dist/types/{plugins/apy/apy-cache.d.ts → common-utils/axios-cache/AxiosCache.d.ts}

@@ -1,28 +1,27 @@
-import type { Output } from "../../rewards/apy/index.js";
 import type { ILogger } from "../../sdk/index.js";
 /**
- * Process-wide cache for the APY state-cache JSON.
+ * Process-wide cache for axios JSON responses.
  *
- * Multiple ApyPlugin instances (one per SDK / network) share the same
+ * Multiple plugin instances (one per SDK / network) share the same
  * cached HTTP response so that only **one** request is made per TTL window
  * regardless of how many SDK instances exist.
  *
  * Concurrent callers that arrive while a fetch is already in flight
  * are de-duplicated — they all await the same promise.
  */
-export declare class ApyOutputCache {
+export declare class AxiosCache<T> {
     #private;
     private constructor();
     /**
      * Returns a shared cache instance for the given URL.
      * The same instance is reused across all callers with identical URL.
      */
-    static get(url: string, ttlMs: number, logger?: ILogger): ApyOutputCache;
+    static get<T>(url: string, ttlMs: number, logger?: ILogger, getLogMeta?: (data: T) => string): AxiosCache<T>;
     /**
-     * Returns cached Output if fresh, otherwise fetches from the network.
+     * Returns cached data if fresh, otherwise fetches from the network.
      * Concurrent calls are de-duplicated.
      */
-    fetch(): Promise<Output<string, string> | undefined>;
+    fetch(): Promise<T>;
     /** Evicts all cached entries. Mainly useful for tests. */
     static clearAll(): void;
 }

package/dist/types/common-utils/axios-cache/index.d.ts

@@ -0,0 +1 @@
+export * from "./AxiosCache.js";

package/dist/types/common-utils/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./axios-cache/index.js";
 export * from "./charts/index.js";
 export * from "./static/index.js";
 export * from "./utils/index.js";

package/dist/types/plugins/apy/index.d.ts

@@ -1,5 +1,4 @@
 export * from "./ApyPlugin.js";
-export * from "./apy-cache.js";
 export * from "./apy-parser.js";
 export * from "./constants.js";
 export * from "./pool-apy-types.js";

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

@@ -1,11 +1,19 @@
 import type { Address, GetContractReturnType, PublicClient } from "viem";
 import type { iWithdrawalCompressorV310Abi } from "../../abi/IWithdrawalCompressorV310.js";
+import type { iWithdrawalCompressorV311Abi } from "../../abi/IWithdrawalCompressorV311.js";
 import type { BaseContractStateHuman } from "../../sdk/index.js";
 type WithdrawalCompressorV310InstanceType = GetContractReturnType<typeof iWithdrawalCompressorV310Abi, PublicClient>;
-export type WithdrawableAsset = Awaited<ReturnType<WithdrawalCompressorV310InstanceType["read"]["getWithdrawableAssets"]>>[number] & {
+type WithdrawalCompressorV311InstanceType = GetContractReturnType<typeof iWithdrawalCompressorV311Abi, PublicClient>;
+type WithdrawableAssetV310 = Awaited<ReturnType<WithdrawalCompressorV310InstanceType["read"]["getWithdrawableAssets"]>>[number] & {
     creditManager: Address;
     disabled: boolean;
 };
-export interface WithdrawableAssetStateHuman extends WithdrawableAsset, BaseContractStateHuman {
+type WithdrawableAssetV311 = Awaited<ReturnType<WithdrawalCompressorV311InstanceType["read"]["getWithdrawableAssets"]>>[number] & {
+    creditManager: Address;
+    disabled: boolean;
+};
+type CommonType = WithdrawableAssetV310 & Partial<Omit<WithdrawableAssetV311, keyof WithdrawableAssetV310>>;
+export type WithdrawableAsset = CommonType;
+export interface WithdrawableAssetStateHuman extends CommonType, BaseContractStateHuman {
 }
 export {};

package/dist/types/plugins/remote-configs/CustomConfigSource.d.ts

@@ -0,0 +1,13 @@
+import type { PoolConfigPayload } from "../../common-utils/static/pool-config.js";
+import type { StrategyConfigPayload } from "../../common-utils/static/strategy.js";
+import type { ConfigSource } from "./types.js";
+export interface CustomConfigSourceOptions {
+    getPools: () => Promise<PoolConfigPayload[]>;
+    getStrategies: () => Promise<StrategyConfigPayload[]>;
+}
+export declare class CustomConfigSource implements ConfigSource {
+    #private;
+    constructor(options: CustomConfigSourceOptions);
+    getPools(): Promise<PoolConfigPayload[]>;
+    getStrategies(): Promise<StrategyConfigPayload[]>;
+}

package/dist/types/plugins/remote-configs/RemoteConfigSource.d.ts

@@ -0,0 +1,31 @@
+import type { PoolConfigPayload } from "../../common-utils/static/pool-config.js";
+import type { StrategyConfigPayload } from "../../common-utils/static/strategy.js";
+import type { ILogger } from "../../sdk/index.js";
+import type { ConfigSource } from "./types.js";
+export interface RemoteConfigSourceOptions {
+    /**
+     * URL for pools config JSON.
+     * @default "https://static.gearbox.finance/client-v3/configs/pools/pools.json"
+     */
+    poolsUrl?: string;
+    /**
+     * URL for strategies config JSON.
+     * @default "https://static.gearbox.finance/client-v3/configs/strategies/strategies.json"
+     */
+    strategiesUrl?: string;
+    /**
+     * Cache TTL in milliseconds.
+     * @default 60_000
+     */
+    cacheTtlMs?: number;
+    /**
+     * Optional logger for cache diagnostics.
+     */
+    logger?: ILogger;
+}
+export declare class RemoteConfigSource implements ConfigSource {
+    #private;
+    constructor(options?: RemoteConfigSourceOptions);
+    getPools(): Promise<Array<PoolConfigPayload>>;
+    getStrategies(): Promise<Array<StrategyConfigPayload>>;
+}

package/dist/types/plugins/remote-configs/RemoteConfigsPlugin.d.ts

@@ -0,0 +1,24 @@
+import type { PoolConfigPayload } from "../../common-utils/static/pool-config.js";
+import type { NotValidatedStrategy } from "../../common-utils/utils/strategies/types/strategy.js";
+import { BasePlugin, type IOnchainSDKPlugin } from "../../sdk/index.js";
+import type { RemoteConfigsPluginOptions, RemoteConfigsPluginState } from "./types.js";
+export declare class RemoteConfigsPlugin extends BasePlugin<RemoteConfigsPluginState> implements IOnchainSDKPlugin<RemoteConfigsPluginState> {
+    #private;
+    constructor(loadOnAttach?: boolean, options?: RemoteConfigsPluginOptions);
+    get loaded(): boolean;
+    load(force?: boolean): Promise<RemoteConfigsPluginState>;
+    syncState(): Promise<void>;
+    get state(): RemoteConfigsPluginState;
+    hydrate(state: RemoteConfigsPluginState): void;
+    stateHuman(_?: boolean): RemoteConfigsPluginState;
+    /**
+     * Pool configs for the current SDK network.
+     * @throws if plugin is not loaded
+     */
+    get pools(): PoolConfigPayload[];
+    /**
+     * Strategy configs for the current SDK network.
+     * @throws if plugin is not loaded
+     */
+    get strategies(): NotValidatedStrategy[];
+}

package/dist/types/plugins/remote-configs/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./CustomConfigSource.js";
+export * from "./RemoteConfigSource.js";
+export * from "./RemoteConfigsPlugin.js";
+export * from "./types.js";

package/dist/types/plugins/remote-configs/types.d.ts

@@ -0,0 +1,24 @@
+import type { PoolConfigPayload } from "../../common-utils/static/pool-config.js";
+import type { StrategyConfigPayload } from "../../common-utils/static/strategy.js";
+import type { NotValidatedStrategy } from "../../common-utils/utils/strategies/types/strategy.js";
+export interface RemoteConfigsPluginState {
+    pools: PoolConfigPayload[];
+    strategies: NotValidatedStrategy[];
+}
+/**
+ * Abstraction for a config provider.
+ * Multiple sources can be composed; the plugin tries them in order
+ * until one succeeds.
+ */
+export interface ConfigSource {
+    getPools(): Promise<PoolConfigPayload[]>;
+    getStrategies(): Promise<StrategyConfigPayload[]>;
+}
+export interface RemoteConfigsPluginOptions {
+    /**
+     * Ordered list of config sources.
+     * Defaults to `[new RemoteConfigSource()]` if omitted.
+     */
+    sources?: ConfigSource[];
+}
+export type { NotValidatedStrategy, PoolConfigPayload, StrategyConfigPayload };

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

@@ -22,7 +22,10 @@ export interface CreditAccountServiceOptions {
  * @param chainId - Numeric chain ID.
  * @returns Withdrawal compressor address, or `undefined`.
  **/
-export declare function getWithdrawalCompressorAddress(chainId: number): `0x${string}`;
+export declare function getWithdrawalCompressorAddress(chainId: number): {
+    address: Address;
+    version: 311 | 310;
+};
 /**
  * Service for querying and operating on Gearbox credit accounts.
  *

package/package.json

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