@gearbox-protocol/sdk 14.12.0-next.1 → 14.12.0-next.2

package/dist/types/sdk/market/zapper/IERC20ZapperContract.d.ts

@@ -1,8 +1,8 @@
 import type { Address, Hex } from "viem";
-import { BaseContract } from "../../base/index.js";
 import type { OnchainSDK } from "../../OnchainSDK.js";
 import type { RawTx } from "../../types/index.js";
 import type { ZapperData } from "../types.js";
+import { ZapperContract } from "./ZapperContract.js";
 declare const abi: readonly [{
     readonly type: "function";
     readonly inputs: readonly [{
@@ -197,132 +197,195 @@ declare const abi: readonly [{
     readonly stateMutability: "nonpayable";
 }, {
     readonly type: "function";
+    readonly name: "contractType";
     readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bytes32";
+        readonly internalType: "bytes32";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
     readonly name: "pool";
+    readonly inputs: readonly [];
     readonly outputs: readonly [{
         readonly name: "";
-        readonly internalType: "address";
         readonly type: "address";
+        readonly internalType: "address";
     }];
     readonly stateMutability: "view";
 }, {
     readonly type: "function";
+    readonly name: "previewDeposit";
     readonly inputs: readonly [{
         readonly name: "tokenInAmount";
-        readonly internalType: "uint256";
         readonly type: "uint256";
+        readonly internalType: "uint256";
     }];
-    readonly name: "previewDeposit";
     readonly outputs: readonly [{
         readonly name: "tokenOutAmount";
-        readonly internalType: "uint256";
         readonly type: "uint256";
+        readonly internalType: "uint256";
     }];
     readonly stateMutability: "view";
 }, {
     readonly type: "function";
+    readonly name: "previewRedeem";
     readonly inputs: readonly [{
         readonly name: "tokenOutAmount";
-        readonly internalType: "uint256";
         readonly type: "uint256";
+        readonly internalType: "uint256";
     }];
-    readonly name: "previewRedeem";
     readonly outputs: readonly [{
         readonly name: "tokenInAmount";
-        readonly internalType: "uint256";
         readonly type: "uint256";
+        readonly internalType: "uint256";
     }];
     readonly stateMutability: "view";
 }, {
     readonly type: "function";
+    readonly name: "redeem";
     readonly inputs: readonly [{
         readonly name: "tokenOutAmount";
-        readonly internalType: "uint256";
         readonly type: "uint256";
+        readonly internalType: "uint256";
     }, {
         readonly name: "receiver";
-        readonly internalType: "address";
         readonly type: "address";
+        readonly internalType: "address";
     }];
-    readonly name: "redeem";
     readonly outputs: readonly [{
         readonly name: "tokenInAmount";
-        readonly internalType: "uint256";
         readonly type: "uint256";
+        readonly internalType: "uint256";
     }];
     readonly stateMutability: "nonpayable";
 }, {
     readonly type: "function";
+    readonly name: "redeemWithPermit";
     readonly inputs: readonly [{
         readonly name: "tokenOutAmount";
-        readonly internalType: "uint256";
         readonly type: "uint256";
+        readonly internalType: "uint256";
     }, {
         readonly name: "receiver";
-        readonly internalType: "address";
         readonly type: "address";
+        readonly internalType: "address";
     }, {
         readonly name: "deadline";
-        readonly internalType: "uint256";
         readonly type: "uint256";
+        readonly internalType: "uint256";
     }, {
         readonly name: "v";
-        readonly internalType: "uint8";
         readonly type: "uint8";
+        readonly internalType: "uint8";
     }, {
         readonly name: "r";
-        readonly internalType: "bytes32";
         readonly type: "bytes32";
+        readonly internalType: "bytes32";
     }, {
         readonly name: "s";
-        readonly internalType: "bytes32";
         readonly type: "bytes32";
+        readonly internalType: "bytes32";
     }];
-    readonly name: "redeemWithPermit";
     readonly outputs: readonly [{
         readonly name: "tokenInAmount";
+        readonly type: "uint256";
         readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "redeemWithPermitAllowed";
+    readonly inputs: readonly [{
+        readonly name: "tokenOutAmount";
         readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "receiver";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "nonce";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "expiry";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "v";
+        readonly type: "uint8";
+        readonly internalType: "uint8";
+    }, {
+        readonly name: "r";
+        readonly type: "bytes32";
+        readonly internalType: "bytes32";
+    }, {
+        readonly name: "s";
+        readonly type: "bytes32";
+        readonly internalType: "bytes32";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "tokenInAmount";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
     }];
     readonly stateMutability: "nonpayable";
 }, {
     readonly type: "function";
+    readonly name: "serialize";
     readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "serializedData";
+        readonly type: "bytes";
+        readonly internalType: "bytes";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
     readonly name: "tokenIn";
+    readonly inputs: readonly [];
     readonly outputs: readonly [{
         readonly name: "";
-        readonly internalType: "address";
         readonly type: "address";
+        readonly internalType: "address";
     }];
     readonly stateMutability: "view";
 }, {
     readonly type: "function";
-    readonly inputs: readonly [];
     readonly name: "tokenOut";
+    readonly inputs: readonly [];
     readonly outputs: readonly [{
         readonly name: "";
-        readonly internalType: "address";
         readonly type: "address";
+        readonly internalType: "address";
     }];
     readonly stateMutability: "view";
 }, {
     readonly type: "function";
-    readonly inputs: readonly [];
     readonly name: "underlying";
+    readonly inputs: readonly [];
     readonly outputs: readonly [{
         readonly name: "";
-        readonly internalType: "address";
         readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "version";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
     }];
     readonly stateMutability: "view";
 }];
 type abi = typeof abi;
-export declare class IERC20ZapperContract extends BaseContract<abi> implements ZapperData {
-    readonly pool: ZapperData["pool"];
-    readonly type: ZapperData["type"];
-    readonly baseParams: ZapperData["baseParams"];
-    readonly tokenIn: ZapperData["tokenIn"];
-    readonly tokenOut: ZapperData["tokenOut"];
+export declare class IERC20ZapperContract extends ZapperContract<abi> {
     constructor(sdk: OnchainSDK, data: ZapperData);
     /**
      * Deposits ERC20 tokens into the pool via this zapper.
@@ -337,14 +400,5 @@ export declare class IERC20ZapperContract extends BaseContract<abi> implements Z
      * EIP-2612 permit signature, skipping a separate approve transaction.
      */
     depositWithReferralAndPermit(tokenInAmount: bigint, receiver: Address, referralCode: bigint, deadline: bigint, v: number, r: Hex, s: Hex): RawTx;
-    /**
-     * Redeems pool shares (diesel tokens) for the underlying asset via this zapper.
-     */
-    redeem(tokenInAmount: bigint, receiver: Address): RawTx;
-    /**
-     * Redeems pool shares via this zapper with an EIP-2612 permit signature,
-     * skipping a separate approve transaction.
-     */
-    redeemWithPermit(tokenInAmount: bigint, receiver: Address, deadline: bigint, v: number, r: Hex, s: Hex): RawTx;
 }
 export {};

package/dist/types/sdk/market/zapper/IETHZapperContract.d.ts

@@ -1,8 +1,8 @@
 import type { Address } from "viem";
-import { BaseContract } from "../../base/index.js";
 import type { OnchainSDK } from "../../OnchainSDK.js";
 import type { RawTx } from "../../types/index.js";
 import type { ZapperData } from "../types.js";
+import { ZapperContract } from "./ZapperContract.js";
 declare const abi: readonly [{
     readonly type: "function";
     readonly inputs: readonly [{
@@ -37,132 +37,195 @@ declare const abi: readonly [{
     readonly stateMutability: "payable";
 }, {
     readonly type: "function";
+    readonly name: "contractType";
     readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bytes32";
+        readonly internalType: "bytes32";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
     readonly name: "pool";
+    readonly inputs: readonly [];
     readonly outputs: readonly [{
         readonly name: "";
-        readonly internalType: "address";
         readonly type: "address";
+        readonly internalType: "address";
     }];
     readonly stateMutability: "view";
 }, {
     readonly type: "function";
+    readonly name: "previewDeposit";
     readonly inputs: readonly [{
         readonly name: "tokenInAmount";
-        readonly internalType: "uint256";
         readonly type: "uint256";
+        readonly internalType: "uint256";
     }];
-    readonly name: "previewDeposit";
     readonly outputs: readonly [{
         readonly name: "tokenOutAmount";
-        readonly internalType: "uint256";
         readonly type: "uint256";
+        readonly internalType: "uint256";
     }];
     readonly stateMutability: "view";
 }, {
     readonly type: "function";
+    readonly name: "previewRedeem";
     readonly inputs: readonly [{
         readonly name: "tokenOutAmount";
-        readonly internalType: "uint256";
         readonly type: "uint256";
+        readonly internalType: "uint256";
     }];
-    readonly name: "previewRedeem";
     readonly outputs: readonly [{
         readonly name: "tokenInAmount";
-        readonly internalType: "uint256";
         readonly type: "uint256";
+        readonly internalType: "uint256";
     }];
     readonly stateMutability: "view";
 }, {
     readonly type: "function";
+    readonly name: "redeem";
     readonly inputs: readonly [{
         readonly name: "tokenOutAmount";
-        readonly internalType: "uint256";
         readonly type: "uint256";
+        readonly internalType: "uint256";
     }, {
         readonly name: "receiver";
-        readonly internalType: "address";
         readonly type: "address";
+        readonly internalType: "address";
     }];
-    readonly name: "redeem";
     readonly outputs: readonly [{
         readonly name: "tokenInAmount";
-        readonly internalType: "uint256";
         readonly type: "uint256";
+        readonly internalType: "uint256";
     }];
     readonly stateMutability: "nonpayable";
 }, {
     readonly type: "function";
+    readonly name: "redeemWithPermit";
     readonly inputs: readonly [{
         readonly name: "tokenOutAmount";
-        readonly internalType: "uint256";
         readonly type: "uint256";
+        readonly internalType: "uint256";
     }, {
         readonly name: "receiver";
-        readonly internalType: "address";
         readonly type: "address";
+        readonly internalType: "address";
     }, {
         readonly name: "deadline";
-        readonly internalType: "uint256";
         readonly type: "uint256";
+        readonly internalType: "uint256";
     }, {
         readonly name: "v";
-        readonly internalType: "uint8";
         readonly type: "uint8";
+        readonly internalType: "uint8";
     }, {
         readonly name: "r";
-        readonly internalType: "bytes32";
         readonly type: "bytes32";
+        readonly internalType: "bytes32";
     }, {
         readonly name: "s";
-        readonly internalType: "bytes32";
         readonly type: "bytes32";
+        readonly internalType: "bytes32";
     }];
-    readonly name: "redeemWithPermit";
     readonly outputs: readonly [{
         readonly name: "tokenInAmount";
+        readonly type: "uint256";
         readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "redeemWithPermitAllowed";
+    readonly inputs: readonly [{
+        readonly name: "tokenOutAmount";
         readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "receiver";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "nonce";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "expiry";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "v";
+        readonly type: "uint8";
+        readonly internalType: "uint8";
+    }, {
+        readonly name: "r";
+        readonly type: "bytes32";
+        readonly internalType: "bytes32";
+    }, {
+        readonly name: "s";
+        readonly type: "bytes32";
+        readonly internalType: "bytes32";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "tokenInAmount";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
     }];
     readonly stateMutability: "nonpayable";
 }, {
     readonly type: "function";
+    readonly name: "serialize";
     readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "serializedData";
+        readonly type: "bytes";
+        readonly internalType: "bytes";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
     readonly name: "tokenIn";
+    readonly inputs: readonly [];
     readonly outputs: readonly [{
         readonly name: "";
-        readonly internalType: "address";
         readonly type: "address";
+        readonly internalType: "address";
     }];
     readonly stateMutability: "view";
 }, {
     readonly type: "function";
-    readonly inputs: readonly [];
     readonly name: "tokenOut";
+    readonly inputs: readonly [];
     readonly outputs: readonly [{
         readonly name: "";
-        readonly internalType: "address";
         readonly type: "address";
+        readonly internalType: "address";
     }];
     readonly stateMutability: "view";
 }, {
     readonly type: "function";
-    readonly inputs: readonly [];
     readonly name: "underlying";
+    readonly inputs: readonly [];
     readonly outputs: readonly [{
         readonly name: "";
-        readonly internalType: "address";
         readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "version";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
     }];
     readonly stateMutability: "view";
 }];
 type abi = typeof abi;
-export declare class IETHZapperContract extends BaseContract<abi> implements ZapperData {
-    readonly pool: ZapperData["pool"];
-    readonly type: ZapperData["type"];
-    readonly baseParams: ZapperData["baseParams"];
-    readonly tokenIn: ZapperData["tokenIn"];
-    readonly tokenOut: ZapperData["tokenOut"];
+export declare class IETHZapperContract extends ZapperContract<abi> {
     constructor(sdk: OnchainSDK, data: ZapperData);
     /**
      * Deposits native ETH into the pool via this zapper.
@@ -173,14 +236,5 @@ export declare class IETHZapperContract extends BaseContract<abi> implements Zap
      * The caller must attach the deposit amount as msg.value.
      */
     depositWithReferral(receiver: Address, referralCode: bigint): RawTx;
-    /**
-     * Redeems pool shares (diesel tokens) for the underlying asset via this zapper.
-     */
-    redeem(tokenInAmount: bigint, receiver: Address): RawTx;
-    /**
-     * Redeems pool shares via this zapper with an EIP-2612 permit signature,
-     * skipping a separate approve transaction.
-     */
-    redeemWithPermit(tokenInAmount: bigint, receiver: Address, deadline: bigint, v: number, r: Address, s: Address): RawTx;
 }
 export {};

package/dist/types/sdk/market/zapper/ZapperContract.d.ts

@@ -0,0 +1,35 @@
+import type { Abi, Address, Hex } from "viem";
+import { BaseContract } from "../../base/index.js";
+import type { OnchainSDK } from "../../OnchainSDK.js";
+import type { RawTx } from "../../types/index.js";
+import type { ZapperData } from "../types.js";
+import type { IZapperContract, ParsedZapperOperation } from "./types.js";
+/**
+ * Base contract for every Gearbox zapper. Specialized zappers (e.g.
+ * {@link IERC20ZapperContract}, {@link IETHZapperContract}) extend this and add
+ * their type-specific deposit helpers; unknown zapper types are represented by
+ * this class directly, decoding against the common {@link iZapperAbi}.
+ */
+export declare class ZapperContract<A extends Abi = Abi> extends BaseContract<A> implements IZapperContract {
+    readonly sdk: OnchainSDK;
+    readonly pool: ZapperData["pool"];
+    readonly type: ZapperData["type"];
+    readonly baseParams: ZapperData["baseParams"];
+    readonly tokenIn: ZapperData["tokenIn"];
+    readonly tokenOut: ZapperData["tokenOut"];
+    constructor(sdk: OnchainSDK, data: ZapperData, abi?: A, namePrefix?: string);
+    /**
+     * Decodes zapper calldata into {@link ParsedZapperOperation}.
+     * Throws {@link UnsupportedZapperFunctionError} for unknown selectors.
+     */
+    parseOperation(calldata: Hex, value?: bigint): ParsedZapperOperation;
+    /**
+     * Redeems pool shares (diesel tokens) for the underlying asset via this zapper.
+     */
+    redeem(tokenInAmount: bigint, receiver: Address): RawTx;
+    /**
+     * Redeems pool shares via this zapper with an EIP-2612 permit signature,
+     * skipping a separate approve transaction.
+     */
+    redeemWithPermit(tokenInAmount: bigint, receiver: Address, deadline: bigint, v: number, r: Hex, s: Hex): RawTx;
+}

package/dist/types/sdk/market/zapper/createZapper.d.ts

@@ -1,6 +1,4 @@
 import type { OnchainSDK } from "../../OnchainSDK.js";
 import type { ZapperData } from "../types.js";
-import { IERC20ZapperContract } from "./IERC20ZapperContract.js";
-import { IETHZapperContract } from "./IETHZapperContract.js";
-import { Zapper } from "./Zapper.js";
-export declare function createZapper(sdk: OnchainSDK, data: ZapperData): Zapper | IETHZapperContract | IERC20ZapperContract;
+import type { IZapperContract } from "./types.js";
+export declare function createZapper(sdk: OnchainSDK, data: ZapperData): IZapperContract;

package/dist/types/sdk/market/zapper/errors.d.ts

@@ -0,0 +1,10 @@
+import type { Address } from "viem";
+/**
+ * Thrown when a zapper call uses a function other than a known
+ * `deposit`/`redeem` variant.
+ */
+export declare class UnsupportedZapperFunctionError extends Error {
+    readonly zapper: Address;
+    readonly functionName: string;
+    constructor(zapper: Address, functionName: string);
+}

package/dist/types/sdk/market/zapper/index.d.ts

@@ -1,4 +1,6 @@
 export * from "./createZapper.js";
+export * from "./errors.js";
 export * from "./IERC20ZapperContract.js";
 export * from "./IETHZapperContract.js";
-export * from "./Zapper.js";
+export * from "./types.js";
+export * from "./ZapperContract.js";

package/dist/types/sdk/market/zapper/types.d.ts

@@ -0,0 +1,64 @@
+import type { Address, Hex } from "viem";
+import type { IBaseContract } from "../../base/index.js";
+import type { RawTx } from "../../types/index.js";
+import type { ZapperData } from "../types.js";
+/**
+ * Deposit decoded from a zapper call
+ */
+export interface ParsedZapperDeposit {
+    operation: "Deposit";
+    /** Destination pool the zapper deposits into. */
+    pool: Address;
+    /** Zapper contract the call is sent to. */
+    zapper: Address;
+    receiver: Address;
+    /** Amount of `token` supplied to the zapper. */
+    assets: bigint;
+    /** Token actually deposited into the zapper (the zapper's `tokenIn`). */
+    token: Address;
+    /** Underlying token of the destination pool. */
+    underlying: Address;
+    /** Referral code, present only for `depositWithReferral(...)` calls. */
+    referralCode?: bigint;
+}
+/**
+ * Redeem decoded from a zapper call. The zapper burns pool shares and returns
+ * `token` to the receiver.
+ */
+export interface ParsedZapperRedeem {
+    operation: "Redeem";
+    /** Source pool the zapper redeems from. */
+    pool: Address;
+    /** Zapper contract the call is sent to. */
+    zapper: Address;
+    receiver: Address;
+    /** Pool shares (diesel) burned. */
+    shares: bigint;
+    /** Token returned to the receiver (the zapper's `tokenIn`). */
+    token: Address;
+    /** Underlying token of the source pool. */
+    underlying: Address;
+}
+export type ParsedZapperOperation = ParsedZapperDeposit | ParsedZapperRedeem;
+/**
+ * Public interface for any Gearbox zapper contract wrapper.
+ *
+ * Based on contracts/interfaces/zappers/IZapper.sol in intergrations-v3 repo
+ */
+export interface IZapperContract extends IBaseContract, ZapperData {
+    /**
+     * Decodes zapper calldata into a {@link ParsedZapperOperation}.
+     * @param calldata - Raw ABI-encoded calldata sent to the zapper.
+     * @param value - Transaction `msg.value`, used for native-token deposits.
+     */
+    parseOperation(calldata: Hex, value?: bigint): ParsedZapperOperation;
+    /**
+     * Redeems pool shares (diesel tokens) for the underlying asset via this zapper.
+     */
+    redeem(tokenInAmount: bigint, receiver: Address): RawTx;
+    /**
+     * Redeems pool shares via this zapper with an EIP-2612 permit signature,
+     * skipping a separate approve transaction.
+     */
+    redeemWithPermit(tokenInAmount: bigint, receiver: Address, deadline: bigint, v: number, r: Hex, s: Hex): RawTx;
+}

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

@@ -4,7 +4,7 @@ import type { ILogger } from "./types/index.js";
 /**
  * Zod schema for validating {@link OnchainSDKOptions} at runtime.
  **/
-export declare const OnchainSDKOptionsSchema: z.ZodObject<{
+export declare const onchainSDKOptionsSchema: z.ZodObject<{
     strictContractTypes: z.ZodOptional<z.ZodBoolean>;
     plugins: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
     logger: z.ZodAny;
@@ -13,7 +13,7 @@ export declare const OnchainSDKOptionsSchema: z.ZodObject<{
 /**
  * Zod schema for validating {@link AttachOptions} at runtime.
  **/
-export declare const AttachOptionsSchema: z.ZodObject<{
+export declare const attachOptionsSchema: z.ZodObject<{
     addressProvider: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>>;
     marketConfigurators: z.ZodOptional<z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>>>;
     rwaFactories: z.ZodOptional<z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>>>;
@@ -33,15 +33,20 @@ export declare const AttachOptionsSchema: z.ZodObject<{
         cacheTTL: z.ZodOptional<z.ZodNumber>;
         failOnMissingFeeds: z.ZodOptional<z.ZodBoolean>;
     }, z.core.$strip>>;
+    loadZappers: z.ZodOptional<z.ZodBoolean>;
 }, z.core.$strip>;
 /**
  * SDK constructor options type.
  *
  * @typeParam Plugins - Map of plugin names to plugin instances.
  **/
-export type SDKOptions<Plugins extends PluginsMap> = Omit<z.infer<typeof OnchainSDKOptionsSchema>, "logger" | "plugins"> & {
-    /** Plugins that extend SDK functionality. */
+export type SDKOptions<Plugins extends PluginsMap> = Omit<z.infer<typeof onchainSDKOptionsSchema>, "logger" | "plugins"> & {
+    /**
+     * Plugins that extend SDK functionality.
+     **/
     plugins?: Plugins;
-    /** Custom logger implementation. */
+    /**
+     * Custom logger implementation.
+     **/
     logger?: ILogger;
 };