@gearbox-protocol/sdk 14.10.3 → 14.10.5-next.1

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

@@ -0,0 +1,350 @@
+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";
+declare const abi: readonly [{
+    readonly type: "function";
+    readonly inputs: readonly [{
+        readonly name: "tokenInAmount";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }, {
+        readonly name: "receiver";
+        readonly internalType: "address";
+        readonly type: "address";
+    }];
+    readonly name: "deposit";
+    readonly outputs: readonly [{
+        readonly name: "tokenOutAmount";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly inputs: readonly [{
+        readonly name: "tokenInAmount";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }, {
+        readonly name: "receiver";
+        readonly internalType: "address";
+        readonly type: "address";
+    }, {
+        readonly name: "deadline";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }, {
+        readonly name: "v";
+        readonly internalType: "uint8";
+        readonly type: "uint8";
+    }, {
+        readonly name: "r";
+        readonly internalType: "bytes32";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "s";
+        readonly internalType: "bytes32";
+        readonly type: "bytes32";
+    }];
+    readonly name: "depositWithPermit";
+    readonly outputs: readonly [{
+        readonly name: "tokenOutAmount";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly inputs: readonly [{
+        readonly name: "tokenInAmount";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }, {
+        readonly name: "receiver";
+        readonly internalType: "address";
+        readonly type: "address";
+    }, {
+        readonly name: "nonce";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }, {
+        readonly name: "expiry";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }, {
+        readonly name: "v";
+        readonly internalType: "uint8";
+        readonly type: "uint8";
+    }, {
+        readonly name: "r";
+        readonly internalType: "bytes32";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "s";
+        readonly internalType: "bytes32";
+        readonly type: "bytes32";
+    }];
+    readonly name: "depositWithPermitAllowed";
+    readonly outputs: readonly [{
+        readonly name: "tokenOutAmount";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly inputs: readonly [{
+        readonly name: "tokenInAmount";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }, {
+        readonly name: "receiver";
+        readonly internalType: "address";
+        readonly type: "address";
+    }, {
+        readonly name: "referralCode";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }];
+    readonly name: "depositWithReferral";
+    readonly outputs: readonly [{
+        readonly name: "tokenOutAmount";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly inputs: readonly [{
+        readonly name: "tokenInAmount";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }, {
+        readonly name: "receiver";
+        readonly internalType: "address";
+        readonly type: "address";
+    }, {
+        readonly name: "referralCode";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }, {
+        readonly name: "deadline";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }, {
+        readonly name: "v";
+        readonly internalType: "uint8";
+        readonly type: "uint8";
+    }, {
+        readonly name: "r";
+        readonly internalType: "bytes32";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "s";
+        readonly internalType: "bytes32";
+        readonly type: "bytes32";
+    }];
+    readonly name: "depositWithReferralAndPermit";
+    readonly outputs: readonly [{
+        readonly name: "tokenOutAmount";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly inputs: readonly [{
+        readonly name: "tokenInAmount";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }, {
+        readonly name: "receiver";
+        readonly internalType: "address";
+        readonly type: "address";
+    }, {
+        readonly name: "referralCode";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }, {
+        readonly name: "nonce";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }, {
+        readonly name: "expiry";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }, {
+        readonly name: "v";
+        readonly internalType: "uint8";
+        readonly type: "uint8";
+    }, {
+        readonly name: "r";
+        readonly internalType: "bytes32";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "s";
+        readonly internalType: "bytes32";
+        readonly type: "bytes32";
+    }];
+    readonly name: "depositWithReferralAndPermitAllowed";
+    readonly outputs: readonly [{
+        readonly name: "tokenOutAmount";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly inputs: readonly [];
+    readonly name: "pool";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly internalType: "address";
+        readonly type: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly inputs: readonly [{
+        readonly name: "tokenInAmount";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }];
+    readonly name: "previewDeposit";
+    readonly outputs: readonly [{
+        readonly name: "tokenOutAmount";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly inputs: readonly [{
+        readonly name: "tokenOutAmount";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }];
+    readonly name: "previewRedeem";
+    readonly outputs: readonly [{
+        readonly name: "tokenInAmount";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly inputs: readonly [{
+        readonly name: "tokenOutAmount";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }, {
+        readonly name: "receiver";
+        readonly internalType: "address";
+        readonly type: "address";
+    }];
+    readonly name: "redeem";
+    readonly outputs: readonly [{
+        readonly name: "tokenInAmount";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly inputs: readonly [{
+        readonly name: "tokenOutAmount";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }, {
+        readonly name: "receiver";
+        readonly internalType: "address";
+        readonly type: "address";
+    }, {
+        readonly name: "deadline";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }, {
+        readonly name: "v";
+        readonly internalType: "uint8";
+        readonly type: "uint8";
+    }, {
+        readonly name: "r";
+        readonly internalType: "bytes32";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "s";
+        readonly internalType: "bytes32";
+        readonly type: "bytes32";
+    }];
+    readonly name: "redeemWithPermit";
+    readonly outputs: readonly [{
+        readonly name: "tokenInAmount";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly inputs: readonly [];
+    readonly name: "tokenIn";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly internalType: "address";
+        readonly type: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly inputs: readonly [];
+    readonly name: "tokenOut";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly internalType: "address";
+        readonly type: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly inputs: readonly [];
+    readonly name: "underlying";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly internalType: "address";
+        readonly type: "address";
+    }];
+    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"];
+    constructor(sdk: OnchainSDK, data: ZapperData);
+    /**
+     * Deposits ERC20 tokens into the pool via this zapper.
+     */
+    deposit(tokenInAmount: bigint, receiver: Address): RawTx;
+    /**
+     * Deposits ERC20 tokens into the pool via this zapper using a referral code.
+     */
+    depositWithReferral(tokenInAmount: bigint, receiver: Address, referralCode: bigint): RawTx;
+    /**
+     * Deposits ERC20 tokens via this zapper with a referral code and an
+     * 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

@@ -0,0 +1,186 @@
+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";
+declare const abi: readonly [{
+    readonly type: "function";
+    readonly inputs: readonly [{
+        readonly name: "receiver";
+        readonly internalType: "address";
+        readonly type: "address";
+    }];
+    readonly name: "deposit";
+    readonly outputs: readonly [{
+        readonly name: "tokenOutAmount";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "payable";
+}, {
+    readonly type: "function";
+    readonly inputs: readonly [{
+        readonly name: "receiver";
+        readonly internalType: "address";
+        readonly type: "address";
+    }, {
+        readonly name: "referralCode";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }];
+    readonly name: "depositWithReferral";
+    readonly outputs: readonly [{
+        readonly name: "tokenOutAmount";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "payable";
+}, {
+    readonly type: "function";
+    readonly inputs: readonly [];
+    readonly name: "pool";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly internalType: "address";
+        readonly type: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly inputs: readonly [{
+        readonly name: "tokenInAmount";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }];
+    readonly name: "previewDeposit";
+    readonly outputs: readonly [{
+        readonly name: "tokenOutAmount";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly inputs: readonly [{
+        readonly name: "tokenOutAmount";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }];
+    readonly name: "previewRedeem";
+    readonly outputs: readonly [{
+        readonly name: "tokenInAmount";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly inputs: readonly [{
+        readonly name: "tokenOutAmount";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }, {
+        readonly name: "receiver";
+        readonly internalType: "address";
+        readonly type: "address";
+    }];
+    readonly name: "redeem";
+    readonly outputs: readonly [{
+        readonly name: "tokenInAmount";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly inputs: readonly [{
+        readonly name: "tokenOutAmount";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }, {
+        readonly name: "receiver";
+        readonly internalType: "address";
+        readonly type: "address";
+    }, {
+        readonly name: "deadline";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }, {
+        readonly name: "v";
+        readonly internalType: "uint8";
+        readonly type: "uint8";
+    }, {
+        readonly name: "r";
+        readonly internalType: "bytes32";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "s";
+        readonly internalType: "bytes32";
+        readonly type: "bytes32";
+    }];
+    readonly name: "redeemWithPermit";
+    readonly outputs: readonly [{
+        readonly name: "tokenInAmount";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly inputs: readonly [];
+    readonly name: "tokenIn";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly internalType: "address";
+        readonly type: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly inputs: readonly [];
+    readonly name: "tokenOut";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly internalType: "address";
+        readonly type: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly inputs: readonly [];
+    readonly name: "underlying";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly internalType: "address";
+        readonly type: "address";
+    }];
+    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"];
+    constructor(sdk: OnchainSDK, data: ZapperData);
+    /**
+     * Deposits native ETH into the pool via this zapper.
+     */
+    deposit(receiver: Address): RawTx;
+    /**
+     * Deposits native ETH into the pool via this zapper using a referral code.
+     * 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/Zapper.d.ts

@@ -0,0 +1,13 @@
+import type { Address } from "viem";
+import type { BaseParams } from "../../base/types.js";
+import type { ZapperData } from "../types.js";
+export declare class Zapper implements ZapperData {
+    readonly pool: Address;
+    readonly type: "migration" | "rwa" | "base";
+    readonly baseParams: ZapperData["baseParams"];
+    readonly tokenIn: ZapperData["tokenIn"];
+    readonly tokenOut: ZapperData["tokenOut"];
+    readonly contractType: string;
+    constructor(data: ZapperData);
+    static contractType(baseParams: BaseParams): string;
+}

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

@@ -0,0 +1,6 @@
+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;

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

@@ -0,0 +1,4 @@
+export * from "./createZapper.js";
+export * from "./IERC20ZapperContract.js";
+export * from "./IETHZapperContract.js";
+export * from "./Zapper.js";

package/dist/types/sdk/pools/PoolService.d.ts

@@ -1,6 +1,6 @@
 import type { Address } from "viem";
 import { SDKConstruct } from "../base/index.js";
-import type { AddLiquidityProps, DepositMetadata, IPoolsService, PoolServiceCall, RemoveLiquidityProps, WithdrawalMetadata } from "./types.js";
+import type { AddLiquidityProps, DepositMetadata, IPoolsService, PoolServiceCallResult, RemoveLiquidityProps, WithdrawalMetadata } from "./types.js";
 export declare class PoolService extends SDKConstruct implements IPoolsService {
     #private;
     /**
@@ -18,7 +18,7 @@ export declare class PoolService extends SDKConstruct implements IPoolsService {
     /**
      * {@inheritDoc IPoolsService.addLiquidity}
      */
-    addLiquidity(props: AddLiquidityProps): PoolServiceCall | undefined;
+    addLiquidity(props: AddLiquidityProps): PoolServiceCallResult | undefined;
     /**
      * {@inheritDoc IPoolsService.getWithdrawalTokensIn}
      */
@@ -30,7 +30,7 @@ export declare class PoolService extends SDKConstruct implements IPoolsService {
     /**
      * {@inheritDoc IPoolsService.removeLiquidity}
      */
-    removeLiquidity(props: RemoveLiquidityProps): PoolServiceCall;
+    removeLiquidity(props: RemoveLiquidityProps): PoolServiceCallResult;
     /**
      * {@inheritDoc IPoolsService.getWithdrawalMetadata}
      */

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

@@ -1,6 +1,7 @@
 import type { Abi, Address, ContractFunctionArgs, ContractFunctionName } from "viem";
-import type { ZapperData } from "../market/index.js";
+import type { Zapper } from "../market/index.js";
 import type { Asset } from "../router/index.js";
+import type { MultiCall, RawTx } from "../types/transactions.js";
 interface PermitResult {
     r: Address;
     s: Address;
@@ -19,6 +20,10 @@ export type PoolServiceCall<abi extends Abi | readonly unknown[] = Abi, function
     target: Address;
     value?: bigint;
 };
+export interface PoolServiceCallResult {
+    tx: RawTx;
+    calls: Array<MultiCall>;
+}
 export interface AddLiquidityProps {
     /**
      * Token and amount to deposit.
@@ -57,7 +62,7 @@ export interface DepositMetadata {
     /**
      * Zapper that will perform the deposit, undefined in case of direct pool underlying deposit
      */
-    zapper?: ZapperData;
+    zapper?: Zapper;
     /**
      * Before deposit user will nedd to call approve method on token that he wants to deposit,
      * this is the spender address that will be used to call approve method.
@@ -77,7 +82,7 @@ export interface WithdrawalMetadata {
     /**
      * Zapper that will perform the withdrawal, undefined in case of direct pool underlying withdrawal
      */
-    zapper?: ZapperData;
+    zapper?: Zapper;
     /**
      * Before withdrawal user will need to call approve method on token that he wants to withdraw (diesel token),
      * this is the spender address that will be used to call approve method.
@@ -146,13 +151,13 @@ export interface IPoolsService {
      * @param props - {@link AddLiquidityProps}
      * @returns - {@link AddLiquidityCall}
      */
-    addLiquidity(props: AddLiquidityProps): PoolServiceCall | undefined;
+    addLiquidity(props: AddLiquidityProps): PoolServiceCallResult | undefined;
     /**
      * Construct a call to remove liquidity from a Gearbox lending pool.
      *
      * @param props - {@link RemoveLiquidityProps}
      * @returns - {@link RemoveLiquidityCall}
      */
-    removeLiquidity(props: RemoveLiquidityProps): PoolServiceCall;
+    removeLiquidity(props: RemoveLiquidityProps): PoolServiceCallResult;
 }
 export {};

package/package.json

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