@gearbox-protocol/sdk 13.4.0-beta.3 → 13.5.0-kyc.1

package/dist/types/sdk/market/pool/SecuritizeKYCFactory.d.ts

@@ -0,0 +1,345 @@
+import type { Address } from "viem";
+import type { ConstructOptions } from "../../base/index.js";
+import { BaseContract } from "../../base/index.js";
+import type { MultiCall, RawTx } from "../../types/index.js";
+declare const abi: readonly [{
+    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: "getCreditAccounts";
+    readonly inputs: readonly [{
+        readonly name: "investor";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address[]";
+        readonly internalType: "address[]";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getDegenNFT";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getInvestor";
+    readonly inputs: readonly [{
+        readonly name: "creditAccount";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getWallet";
+    readonly inputs: readonly [{
+        readonly name: "creditAccount";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "isCreditAccount";
+    readonly inputs: readonly [{
+        readonly name: "creditAccount";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+        readonly internalType: "bool";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "isFrozen";
+    readonly inputs: readonly [{
+        readonly name: "creditAccount";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+        readonly internalType: "bool";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "multicall";
+    readonly inputs: readonly [{
+        readonly name: "creditAccount";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "calls";
+        readonly type: "tuple[]";
+        readonly internalType: "struct MultiCall[]";
+        readonly components: readonly [{
+            readonly name: "target";
+            readonly type: "address";
+            readonly internalType: "address";
+        }, {
+            readonly name: "callData";
+            readonly type: "bytes";
+            readonly internalType: "bytes";
+        }];
+    }, {
+        readonly name: "tokensToRegister";
+        readonly type: "address[]";
+        readonly internalType: "address[]";
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "openCreditAccount";
+    readonly inputs: readonly [{
+        readonly name: "creditManager";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "calls";
+        readonly type: "tuple[]";
+        readonly internalType: "struct MultiCall[]";
+        readonly components: readonly [{
+            readonly name: "target";
+            readonly type: "address";
+            readonly internalType: "address";
+        }, {
+            readonly name: "callData";
+            readonly type: "bytes";
+            readonly internalType: "bytes";
+        }];
+    }, {
+        readonly name: "tokensToRegister";
+        readonly type: "address[]";
+        readonly internalType: "address[]";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "creditAccount";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "wallet";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "precomputeWalletAddress";
+    readonly inputs: readonly [{
+        readonly name: "creditManager";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "investor";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    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: "setFrozenStatus";
+    readonly inputs: readonly [{
+        readonly name: "creditAccount";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "frozen";
+        readonly type: "bool";
+        readonly internalType: "bool";
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "setInvestor";
+    readonly inputs: readonly [{
+        readonly name: "creditAccount";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "investor";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "version";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "event";
+    readonly name: "CreateWallet";
+    readonly inputs: readonly [{
+        readonly name: "creditAccount";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }, {
+        readonly name: "wallet";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }, {
+        readonly name: "investor";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }];
+    readonly anonymous: false;
+}, {
+    readonly type: "event";
+    readonly name: "SetFrozenStatus";
+    readonly inputs: readonly [{
+        readonly name: "creditAccount";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }, {
+        readonly name: "frozen";
+        readonly type: "bool";
+        readonly indexed: false;
+        readonly internalType: "bool";
+    }];
+    readonly anonymous: false;
+}, {
+    readonly type: "event";
+    readonly name: "SetInvestor";
+    readonly inputs: readonly [{
+        readonly name: "creditAccount";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }, {
+        readonly name: "oldInvestor";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }, {
+        readonly name: "newInvestor";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }];
+    readonly anonymous: false;
+}, {
+    readonly type: "error";
+    readonly name: "CallerIsNotInvestorException";
+    readonly inputs: readonly [{
+        readonly name: "caller";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "creditAccount";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "FrozenCreditAccountException";
+    readonly inputs: readonly [{
+        readonly name: "creditAccount";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "InvalidCreditManagerException";
+    readonly inputs: readonly [{
+        readonly name: "creditManager";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "InvalidUnderlyingTokenException";
+    readonly inputs: readonly [{
+        readonly name: "underlying";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "UnknownCreditAccountException";
+    readonly inputs: readonly [{
+        readonly name: "creditAccount";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "ZeroAddressException";
+    readonly inputs: readonly [];
+}];
+type abi = typeof abi;
+export declare class SecuritizeKYCFactory extends BaseContract<abi> {
+    #private;
+    private investorCache;
+    constructor(options: ConstructOptions, address: Address);
+    precomputeWalletAddress(creditManager: Address, investor: Address): Promise<Address>;
+    getWallet(creditAccount: Address): Promise<Address>;
+    /**
+     * Returns the investor address for a credit account.
+     * @param creditAccount - Credit account address
+     * @param fromCache - If true, use and update an in-memory cache (creditAccount -> investor). On cache miss, loads from contract and stores the result for future calls.
+     */
+    getInvestor(creditAccount: Address, fromCache?: boolean): Promise<Address>;
+    getDSTokens(): Promise<Address[]>;
+    multicall(creditAccount: Address, calls: MultiCall[], tokensToRegister: Address[]): RawTx;
+    openCreditAccount(creditManager: Address, calls: MultiCall[], tokensToRegister: Address[]): RawTx;
+    getDegenNFT(): Promise<Address>;
+}
+export {};

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

@@ -1,4 +1,6 @@
 export * from "./GaugeContract.js";
 export * from "./LinearInterestRateModelContract.js";
 export * from "./PoolSuite.js";
+export * from "./PoolV310Contract.js";
+export * from "./SecuritizeKYCFactory.js";
 export * from "./types.js";

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

@@ -0,0 +1,10 @@
+import type { AbiParametersToPrimitiveTypes, ExtractAbiFunction } from "abitype";
+import type { Address } from "viem";
+import type { peripheryCompressorAbi } from "../../abi/compressors/peripheryCompressor.js";
+import type { Unarray } from "../base/index.js";
+type CompressorZapperData = Unarray<AbiParametersToPrimitiveTypes<ExtractAbiFunction<typeof peripheryCompressorAbi, "getZappers">["outputs"]>>;
+export interface ZapperData extends CompressorZapperData {
+    pool: Address;
+    type: "migration" | "kyc" | "base";
+}
+export {};

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

@@ -0,0 +1,14 @@
+import type { Address } from "viem";
+import { SDKConstruct } from "../base/index.js";
+import type { AddLiquidityProps, DepositMetadata, IPoolsService, PoolServiceCall, RemoveLiquidityProps, WithdrawalMetadata } from "./types.js";
+export declare class PoolService extends SDKConstruct implements IPoolsService {
+    #private;
+    getDepositTokensIn(pool: Address): Address[];
+    getDepositTokensOut(pool: Address, tokenIn: Address): Address[];
+    getDepositMetadata(pool: Address, tokenIn: Address, tokenOut?: Address): DepositMetadata;
+    addLiquidity(props: AddLiquidityProps): PoolServiceCall | undefined;
+    getWithdrawalTokensIn(pool: Address): Address[];
+    getWithdrawalTokensOut(pool: Address, tokenIn: Address): Address[];
+    removeLiquidity(props: RemoveLiquidityProps): PoolServiceCall;
+    getWithdrawalMetadata(pool: Address, tokenIn: Address, tokenOut?: Address): WithdrawalMetadata;
+}

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

@@ -1,3 +1,2 @@
-export * from "./AbstractPoolService.js";
-export * from "./createPoolService.js";
+export * from "./PoolService.js";
 export * from "./types.js";

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

@@ -1,14 +1,7 @@
-import type { Address } from "viem";
-import type { iPoolV310Abi } from "../../abi/310/generated.js";
-import type { ierc20ZapperDepositsAbi } from "../../abi/iERC20ZapperDeposits.js";
-import type { iethZapperDepositsAbi } from "../../abi/iETHZapperDeposits.js";
-import type { iZapperAbi } from "../../abi/iZapper.js";
+import type { Abi } from "abitype";
+import type { Address, ContractFunctionArgs, ContractFunctionName } from "viem";
+import type { ZapperData } from "../market/index.js";
 import type { Asset } from "../router/index.js";
-interface IZapper {
-    zapper: Address;
-    tokenIn: Address;
-    tokenOut: Address;
-}
 interface PermitResult {
     r: Address;
     s: Address;
@@ -20,14 +13,13 @@ interface PermitResult {
     deadline: bigint;
     nonce: bigint;
 }
-/**
- * Parameters for depositing liquidity into a Gearbox lending pool.
- *
- * When a `zapper` is provided, the deposit is routed through a zapper
- * contract that handles token conversions (e.g. native ETH wrapping or
- * ERC-20 permit-based approvals). Without a zapper, the deposit goes
- * directly to the pool contract.
- **/
+export type PoolServiceCall<abi extends Abi | readonly unknown[] = Abi, functionName extends ContractFunctionName<abi, "nonpayable" | "payable"> = ContractFunctionName<abi, "nonpayable" | "payable">, args extends ContractFunctionArgs<abi, "nonpayable" | "payable", functionName> = ContractFunctionArgs<abi, "nonpayable" | "payable", functionName>> = {
+    abi: abi;
+    functionName: functionName;
+    args: args;
+    target: Address;
+    value?: bigint;
+};
 export interface AddLiquidityProps {
     /**
      * Token and amount to deposit.
@@ -37,61 +29,11 @@ export interface AddLiquidityProps {
      * Address of the Gearbox lending pool.
      **/
     pool: Address;
-    /**
-     * Recipient of the pool shares (diesel tokens).
-     **/
-    account: Address;
-    /**
-     * Whether this deposit is part of a pool migration.
-     * When `true`, a zapper is required.
-     **/
-    migrate: boolean;
-    /**
-     * Optional zapper to route the deposit through.
-     **/
-    zapper: IZapper | undefined;
-    /**
-     * Optional ERC-2612 permit for gasless token approval.
-     **/
-    permit: PermitResult | undefined;
-    /**
-     * Address of the chain's native-token wrapper (e.g. WETH).
-     **/
-    nativeTokenAddress: Address;
-    /**
-     * Optional referral code for tracking the deposit source.
-     **/
-    referralCode: bigint | undefined;
+    wallet: Address;
+    meta: DepositMetadata;
+    permit?: PermitResult;
+    referralCode?: bigint;
 }
-/**
- * Tuple describing a single contract call to execute an add-liquidity
- * operation. The exact variant depends on whether a zapper and/or
- * permit is used.
- **/
-export type AddLiquidityCall = [
-    {
-        target: Address;
-        abi: typeof iethZapperDepositsAbi;
-        functionName: "depositWithReferral";
-        args: [Address, bigint];
-        value: bigint;
-    } | {
-        target: Address;
-        abi: typeof ierc20ZapperDepositsAbi;
-        functionName: "depositWithReferralAndPermit";
-        args: [bigint, Address, bigint, bigint, number, Address, Address];
-    } | {
-        target: Address;
-        abi: typeof ierc20ZapperDepositsAbi;
-        functionName: "depositWithReferral";
-        args: [bigint, Address, bigint];
-    } | {
-        target: Address;
-        abi: typeof iPoolV310Abi;
-        functionName: "depositWithReferral";
-        args: [bigint, Address, bigint];
-    }
-];
 /**
  * Parameters for withdrawing liquidity from a Gearbox lending pool.
  *
@@ -107,59 +49,91 @@ export interface RemoveLiquidityProps {
      * Amount of pool shares (diesel tokens) to redeem.
      **/
     amount: bigint;
+    wallet: Address;
+    permit: PermitResult | undefined;
+    meta: WithdrawalMetadata;
+}
+export interface DepositMetadata {
     /**
-     * Recipient of the redeemed underlying tokens.
-     **/
-    account: Address;
+     * Zapper that will perform the deposit, undefined in case of direct pool underlying deposit
+     */
+    zapper?: ZapperData;
     /**
-     * Optional ERC-2612 permit for gasless token approval.
-     **/
-    permit: PermitResult | undefined;
+     * 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.
+     *
+     */
+    approveTarget: Address;
     /**
-     * Zapper to route the redemption through.
-     **/
-    zapper: IZapper;
+     * If true, user can avoid approval step and deposit with permit
+     */
+    permissible: boolean;
+    /**
+     * Type of deposit
+     */
+    type: "kyc-on-demand" | "kyc-default" | "classic";
+}
+export interface WithdrawalMetadata {
+    /**
+     * Zapper that will perform the deposit, undefined in case of direct pool underlying deposit
+     */
+    zapper?: ZapperData;
+    /**
+     * 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.
+     *
+     */
+    approveTarget?: Address;
+    /**
+     * If true, user can avoid approval step and deposit with permit
+     */
+    permissible: boolean;
+    /**
+     * Type of deposit
+     */
+    type: "kyc-on-demand" | "kyc-default" | "classic";
 }
-/**
- * Tuple describing a single contract call to execute a remove-liquidity
- * operation. The exact variant depends on whether a permit is used and
- * whether the withdrawal goes through a zapper or directly to the pool.
- **/
-export type RemoveLiquidityCall = [
-    {
-        target: Address;
-        abi: typeof iZapperAbi;
-        functionName: "redeemWithPermit";
-        args: [bigint, Address, bigint, number, Address, Address];
-    } | {
-        target: Address;
-        abi: typeof iZapperAbi;
-        functionName: "redeem";
-        args: [bigint, Address];
-    } | {
-        target: Address;
-        abi: typeof iPoolV310Abi;
-        functionName: "redeem";
-        args: [bigint, Address, Address];
-    }
-];
 /**
  * Service interface for pool liquidity operations.
  **/
 export interface IPoolsService {
     /**
-     * Construct a call to add liquidity to a Gearbox lending pool.
+     * Returns list of tokens that can be deposited to a pool
+     * @param pool
+     */
+    getDepositTokensIn(pool: Address): Address[];
+    /**
+     * Returns list of tokens that user can receive after depositing to a pool,
+     * depends on the pool type and the token being deposited (one of returned by {@link getDepositTokensIn}).
+     *
+     * Can return empty array if no tokens can be received (e.g. for KYC underlying on demand)
+     *
+     * @param pool
+     * @param tokenIn
+     */
+    getDepositTokensOut(pool: Address, tokenIn: Address): Address[];
+    /**
+     * After user chooses tokenIn from {@link getDepositTokensIn} and tokenOut from {@link getDepositTokensOut},
+     * this method returns metadata that will be used to perform the deposit.
      *
+     * @param pool
+     * @param tokenIn
+     * @param tokenOut can be undefined if deposit is not resulting in a token out (e.g. for KYC underlying on demand)
+     */
+    getDepositMetadata(pool: Address, tokenIn: Address, tokenOut?: Address): DepositMetadata;
+    /**
+     * Returns contract call parameters for adding liquidity to a pool
+     * Or undefined if no deposit action is required (e.g. for KYC underlying on demand)
      * @param props - {@link AddLiquidityProps}
-     * @returns A single-element tuple with the encoded contract call.
-     **/
-    addLiquidity(props: AddLiquidityProps): AddLiquidityCall;
+     * @returns - {@link AddLiquidityCall}
+     */
+    addLiquidity(props: AddLiquidityProps): PoolServiceCall | undefined;
     /**
      * Construct a call to remove liquidity from a Gearbox lending pool.
      *
      * @param props - {@link RemoveLiquidityProps}
-     * @returns A single-element tuple with the encoded contract call.
-     **/
-    removeLiquidity(props: RemoveLiquidityProps): RemoveLiquidityCall;
+     * @returns - {@link RemoveLiquidityCall}
+     */
+    removeLiquidity(props: RemoveLiquidityProps): PoolServiceCall;
 }
 export {};

package/dist/types/sdk/utils/viem/sendRawTx.d.ts

@@ -1,7 +1,11 @@
 import type { Account, Chain, Client, SendTransactionRequest, SendTransactionReturnType, Transport } from "viem";
-import { type SendTransactionParameters } from "viem/actions";
+import { type EstimateGasParameters, type SendTransactionParameters } from "viem/actions";
 import type { RawTx } from "../../types/index.js";
 export type SendRawTxParameters<chain extends Chain, account extends Account | undefined, request extends SendTransactionRequest<chain, chainOverride>, chainOverride extends Chain | undefined = undefined> = Omit<SendTransactionParameters<chain, account, chainOverride, request>, "data" | "to" | "value"> & {
     tx: Pick<RawTx, "to" | "callData" | "value">;
 };
 export declare function sendRawTx<chain extends Chain, account extends Account | undefined, const request extends SendTransactionRequest<chain, chainOverride>, chainOverride extends Chain | undefined>(client: Client<Transport, chain, account>, params: SendRawTxParameters<chain, account, request, chainOverride>): Promise<SendTransactionReturnType>;
+export type EstimateRawTxGasParameters<chain extends Chain> = Omit<EstimateGasParameters<chain>, "data" | "to" | "value"> & {
+    tx: Pick<RawTx, "to" | "callData" | "value">;
+};
+export declare function estimateRawTxGas<chain extends Chain, account extends Account | undefined>(client: Client<Transport, chain, account>, params: EstimateRawTxGasParameters<chain>): Promise<bigint>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/sdk",
-  "version": "13.4.0-beta.3",
+  "version": "13.5.0-kyc.1",
   "description": "Gearbox SDK",
   "license": "MIT",
   "main": "./dist/cjs/sdk/index.js",