@gearbox-protocol/sdk 12.8.0 → 13.0.0-next.10

package/dist/esm/sdk/pools/PoolService.js

@@ -0,0 +1,250 @@
+import { ierc20Abi } from "../../abi/iERC20.js";
+import { ierc20ZapperDepositsAbi } from "../../abi/iERC20ZapperDeposits.js";
+import { iethZapperDepositsAbi } from "../../abi/iETHZapperDeposits.js";
+import { iZapperAbi } from "../../abi/iZapper.js";
+import { iPoolV300Abi } from "../../abi/v300.js";
+import {
+  KYC_UNDERLYING_DEFAULT,
+  KYC_UNDERLYING_ON_DEMAND,
+  SDKConstruct
+} from "../base/index.js";
+import { AddressMap, AddressSet, hexEq } from "../index.js";
+const NATIVE_ADDRESS = "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE";
+const POOL_TOKENS_TO_MIGRATE = new AddressMap([
+  // v2 diesels
+  ["0x6CFaF95457d7688022FC53e7AbE052ef8DFBbdBA", "dDAI"],
+  ["0xc411dB5f5Eb3f7d552F9B8454B2D74097ccdE6E3", "dUSDC"],
+  ["0xe753260F1955e8678DCeA8887759e07aa57E8c54", "dWBTC"],
+  ["0xF21fc650C1B34eb0FDE786D52d23dA99Db3D6278", "dWETH"],
+  ["0x2158034dB06f06dcB9A786D2F1F8c38781bA779d", "dwstETH"],
+  ["0x8A1112AFef7F4FC7c066a77AABBc01b3Fff31D47", "dFRAX"]
+]);
+class PoolService extends SDKConstruct {
+  getDepositTokensIn(pool) {
+    const underlying = this.#describeUnderlying(pool);
+    if (this.sdk.tokensMeta.isKYCUnderlying(underlying)) {
+      switch (underlying.contractType) {
+        case KYC_UNDERLYING_DEFAULT:
+          return this.#depositTokensIn(pool, false);
+        case KYC_UNDERLYING_ON_DEMAND:
+          return [underlying.asset];
+      }
+    }
+    return this.#depositTokensIn(pool, true);
+  }
+  getDepositTokensOut(pool, tokenIn) {
+    const underlying = this.#describeUnderlying(pool);
+    if (this.sdk.tokensMeta.isKYCUnderlying(underlying)) {
+      switch (underlying.contractType) {
+        case KYC_UNDERLYING_DEFAULT:
+          return this.#depositTokensOut(pool, tokenIn, false);
+        case KYC_UNDERLYING_ON_DEMAND:
+          return [];
+      }
+    }
+    return this.#depositTokensOut(pool, tokenIn, true);
+  }
+  getDepositMetadata(pool, tokenIn, tokenOut) {
+    const underlying = this.#describeUnderlying(pool);
+    if (this.sdk.tokensMeta.isKYCUnderlying(underlying)) {
+      switch (underlying.contractType) {
+        case KYC_UNDERLYING_DEFAULT: {
+          return this.#depositMetadata(
+            "kyc-default",
+            pool,
+            tokenIn,
+            tokenOut,
+            false
+          );
+        }
+        case KYC_UNDERLYING_ON_DEMAND:
+          return {
+            zapper: void 0,
+            approveTarget: underlying.liquidityProvider,
+            permissible: false,
+            type: "kyc-on-demand"
+          };
+      }
+    }
+    return this.#depositMetadata("classic", pool, tokenIn, tokenOut, true);
+  }
+  addLiquidity(props) {
+    const { collateral, meta, permit, referralCode, pool, wallet } = props;
+    const underlying = this.#describeUnderlying(pool);
+    if (this.sdk.tokensMeta.isKYCUnderlying(underlying)) {
+      if (underlying.contractType === KYC_UNDERLYING_ON_DEMAND) {
+        return void 0;
+      }
+    }
+    const { zapper } = meta;
+    if (zapper?.tokenIn.addr?.toLowerCase() === NATIVE_ADDRESS.toLowerCase()) {
+      return {
+        target: zapper.baseParams.addr,
+        abi: iethZapperDepositsAbi,
+        functionName: "depositWithReferral",
+        args: [wallet, referralCode],
+        value: collateral.balance
+      };
+    } else if (zapper) {
+      return permit ? {
+        target: zapper.baseParams.addr,
+        abi: ierc20ZapperDepositsAbi,
+        functionName: "depositWithReferralAndPermit",
+        args: [
+          collateral.balance,
+          wallet,
+          referralCode,
+          permit.deadline,
+          permit.v,
+          permit.r,
+          permit.s
+        ]
+      } : {
+        target: zapper.baseParams.addr,
+        abi: ierc20ZapperDepositsAbi,
+        functionName: "depositWithReferral",
+        args: [collateral.balance, wallet, referralCode]
+      };
+    } else {
+      return {
+        target: pool,
+        abi: iPoolV300Abi,
+        functionName: "depositWithReferral",
+        args: [collateral.balance, wallet, referralCode]
+      };
+    }
+  }
+  removeLiquidity(props) {
+    const { pool, amount, account, zapper, permit } = props;
+    const underlying = this.#describeUnderlying(pool);
+    if (this.sdk.tokensMeta.isKYCUnderlying(underlying)) {
+      if (underlying.contractType === KYC_UNDERLYING_ON_DEMAND) {
+        return {
+          abi: ierc20Abi,
+          functionName: "approve",
+          args: [underlying.liquidityProvider, 0n],
+          target: underlying.asset
+        };
+      }
+    }
+    if (zapper) {
+      return permit ? {
+        target: zapper.zapper,
+        abi: iZapperAbi,
+        functionName: "redeemWithPermit",
+        args: [
+          amount,
+          account,
+          permit.deadline,
+          permit.v,
+          permit.r,
+          permit.s
+        ]
+      } : {
+        target: zapper.zapper,
+        abi: iZapperAbi,
+        functionName: "redeem",
+        args: [amount, account]
+      };
+    }
+    return {
+      target: pool,
+      abi: iPoolV300Abi,
+      functionName: "redeem",
+      args: [amount, account, account]
+    };
+  }
+  #getDepositZappers(poolAddr) {
+    const zappers = this.sdk.marketRegister.poolZappers(poolAddr);
+    return zappers.filter((z) => z.type !== "migration");
+  }
+  #depositTokensIn(poolAddr, allowDirectDeposit) {
+    const { pool } = this.sdk.marketRegister.findByPool(poolAddr);
+    const result = new AddressSet();
+    if (allowDirectDeposit) {
+      result.add(pool.underlying);
+    }
+    const zappers = this.#getDepositZappers(poolAddr);
+    for (const z of zappers) {
+      if (hexEq(z.tokenOut.addr, poolAddr)) {
+        result.add(z.tokenIn.addr);
+      }
+    }
+    if (result.size === 0) {
+      throw new Error(
+        `No tokensIn found for pool ${this.labelAddress(poolAddr)}`
+      );
+    }
+    return result.asArray();
+  }
+  #depositTokensOut(poolAddr, tokenIn, allowDirectDeposit) {
+    const result = new AddressSet();
+    const { pool } = this.sdk.marketRegister.findByPool(poolAddr);
+    const zappers = this.#getDepositZappers(poolAddr);
+    for (const z of zappers) {
+      if (hexEq(z.tokenIn.addr, tokenIn)) {
+        if (!hexEq(z.tokenOut.addr, poolAddr)) {
+          console.log("found", "z.tokenOut.addr", z.tokenOut.addr);
+        }
+        result.add(z.tokenOut.addr);
+      }
+    }
+    if (allowDirectDeposit && hexEq(tokenIn, pool.underlying)) {
+      result.add(poolAddr);
+    }
+    if (result.size === 0) {
+      throw new Error(
+        `No tokensOut found for tokenIn ${this.labelAddress(
+          tokenIn
+        )} on pool ${this.labelAddress(poolAddr)}`
+      );
+    }
+    const r = result.asArray().filter((t) => !POOL_TOKENS_TO_MIGRATE.has(t));
+    return r;
+  }
+  #getDepositZapper(poolAddr, tokenIn, tokenOut) {
+    const zappers = this.sdk.marketRegister.getZapper(poolAddr, tokenIn, tokenOut)?.filter((z) => z.type !== "migration");
+    if (zappers && zappers.length > 1) {
+      throw new Error(
+        `Multiple zappers found for tokenIn ${this.labelAddress(
+          tokenIn
+        )} and tokenOut ${this.labelAddress(
+          tokenOut
+        )} on pool ${this.labelAddress(poolAddr)}`
+      );
+    }
+    return zappers?.[0];
+  }
+  #depositMetadata(type, poolAddr, tokenIn, tokenOut, allowDirectDeposit) {
+    if (!tokenOut) {
+      throw new Error("tokenOut is required for classic pool deposit");
+    }
+    const { pool } = this.sdk.marketRegister.findByPool(poolAddr);
+    const zapper = this.#getDepositZapper(poolAddr, tokenIn, tokenOut);
+    if (!zapper && !allowDirectDeposit) {
+      throw new Error(
+        `No zapper found for tokenIn ${this.labelAddress(
+          tokenIn
+        )} and tokenOut ${this.labelAddress(
+          tokenOut
+        )} on pool ${this.labelAddress(poolAddr)}`
+      );
+    }
+    return {
+      zapper,
+      // zapper or pool itself
+      approveTarget: zapper?.baseParams.addr ?? pool.pool.address,
+      // TODO: instead of permissible, return permitType зависимости от tokenIn
+      // "none" | "eip2612" | "dai_like";
+      permissible: !!zapper && tokenIn !== NATIVE_ADDRESS,
+      type
+    };
+  }
+  #describeUnderlying(pool) {
+    const market = this.sdk.marketRegister.findByPool(pool);
+    return this.sdk.tokensMeta.mustGet(market.underlying);
+  }
+}
+export {
+  PoolService
+};

package/dist/esm/sdk/pools/index.js

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

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

@@ -0,0 +1,11 @@
+export declare const iStateSerializerAbi: readonly [{
+    readonly type: "function";
+    readonly inputs: readonly [];
+    readonly name: "serialize";
+    readonly outputs: readonly [{
+        readonly name: "serializedData";
+        readonly internalType: "bytes";
+        readonly type: "bytes";
+    }];
+    readonly stateMutability: "view";
+}];

package/dist/types/sdk/base/TokensMeta.d.ts

@@ -1,40 +1,33 @@
-import type { Address, Chain, PublicClient, Transport } from "viem";
-import { type PhantomTokenContractType } from "../index.js";
+import { type Address, type Chain, type PublicClient, type Transport } from "viem";
 import type { Asset } from "../router/index.js";
 import { AddressMap } from "../utils/index.js";
-import type { TokenMetaData } from "./types.js";
+import type { KYCTokenMeta, PhantomTokenMeta, TokenMetaData } from "./token-types.js";
 export interface FormatBNOptions {
     precision?: number;
     symbol?: boolean;
 }
-export interface TokenMetaDataExtended extends TokenMetaData {
-    /**
-     * Undefined if token is not a phantom token
-     */
-    phantomTokenType?: PhantomTokenContractType;
-}
-export declare class TokensMeta extends AddressMap<TokenMetaDataExtended> {
+export declare class TokensMeta extends AddressMap<TokenMetaData> {
     #private;
     constructor(client: PublicClient<Transport, Chain>);
     reset(): void;
     symbol(token: Address): string;
     decimals(token: Address): number;
-    /**
-     * Returns the phantom token type for a given token, or undefined for normal tokens
-     * Throws if the phantom token data is not loaded
-     */
-    phantomTokenType(token: Address): PhantomTokenContractType | undefined;
+    isPhantomToken(t: TokenMetaData): t is PhantomTokenMeta;
+    isKYCUnderlying(t: TokenMetaData): t is KYCTokenMeta;
     /**
      * Returns a map of all phantom tokens
      * Throws if the phantom token data is not loaded
      */
-    get phantomTokens(): AddressMap<TokenMetaDataExtended>;
+    get phantomTokens(): AddressMap<PhantomTokenMeta>;
+    get kycUnderlyings(): AddressMap<KYCTokenMeta>;
     formatBN(asset: Asset, options?: FormatBNOptions): string;
     formatBN(token: Address, amount: number | bigint | string | undefined, options?: FormatBNOptions): string;
     findBySymbol(symbol: string): TokenMetaData | undefined;
     mustFindBySymbol(symbol: string): TokenMetaData;
     /**
-     * Loads phantom token data for all known tokens from chain
+     * Loads token information about phantom token and KYC underlying tokens
+     *
+     * @param tokens - tokens to load data for, defaults to all tokens
      */
-    loadPhantomTokens(): Promise<void>;
+    loadTokenData(...tokens: Address[]): Promise<void>;
 }

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

@@ -4,4 +4,5 @@ export * from "./Construct.js";
 export * from "./PlaceholderContract.js";
 export * from "./SDKConstruct.js";
 export * from "./TokensMeta.js";
+export * from "./token-types.js";
 export * from "./types.js";

package/dist/types/sdk/base/token-types.d.ts

@@ -0,0 +1,25 @@
+import type { Address } from "viem";
+import type { MarketData, Unarray } from "./types.js";
+export type SimpleTokenMeta = Unarray<MarketData["tokens"]>;
+export declare const PHANTOM_TOKEN_CONTRACT_TYPES: readonly ["PHANTOM_TOKEN::CONVEX", "PHANTOM_TOKEN::INFINIFI_UNWIND", "PHANTOM_TOKEN::INFRARED", "PHANTOM_TOKEN::MELLOW_WITHDRAWAL", "PHANTOM_TOKEN::MIDAS_REDEMPTION", "PHANTOM_TOKEN::STAKING_REWARDS", "PHANTOM_TOKEN::UPSHIFT_WITHDRAW"];
+export declare const KYC_UNDERLYING_DEFAULT = "KYC_UNDERLYING::DEFAULT";
+export declare const KYC_UNDERLYING_ON_DEMAND = "KYC_UNDERLYING::ON_DEMAND";
+export type KYCUnderlyingContractType = typeof KYC_UNDERLYING_DEFAULT | typeof KYC_UNDERLYING_ON_DEMAND;
+export type PhantomTokenContractType = (typeof PHANTOM_TOKEN_CONTRACT_TYPES)[number];
+export type PhantomTokenMeta = SimpleTokenMeta & {
+    contractType: PhantomTokenContractType;
+};
+export type KYCDefaultTokenMeta = SimpleTokenMeta & {
+    contractType: typeof KYC_UNDERLYING_DEFAULT;
+    kycFactory: Address;
+    asset: Address;
+};
+export type KYCOnDemandTokenMeta = SimpleTokenMeta & {
+    contractType: typeof KYC_UNDERLYING_ON_DEMAND;
+    kycFactory: Address;
+    asset: Address;
+    pool: Address;
+    liquidityProvider: Address;
+};
+export type KYCTokenMeta = KYCDefaultTokenMeta | KYCOnDemandTokenMeta;
+export type TokenMetaData = SimpleTokenMeta | PhantomTokenMeta | KYCTokenMeta;

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

@@ -26,7 +26,6 @@ export type CreditManagerState = CreditSuiteState["creditManager"];
 export type CreditFacadeState = CreditSuiteState["creditFacade"];
 export type CreditConfiguratorState = CreditSuiteState["creditConfigurator"];
 export type AdapterData = Unarray<CreditSuiteState["adapters"]>;
-export type TokenMetaData = Unarray<MarketData["tokens"]>;
 export type PoolState = MarketData["pool"];
 export type QuotaKeeperState = MarketData["quotaKeeper"];
 export type QuotaState = Unarray<QuotaKeeperState["quotas"]>;

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

@@ -4,5 +4,4 @@ export * from "./bot-permissions.js";
 export * from "./math.js";
 export * from "./networks.js";
 export * from "./periphery.js";
-export * from "./phantom-tokens.js";
 export * from "./versions.js";

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

@@ -1,6 +1,5 @@
 import type { Address } from "viem";
 import type { MarketData, MarketFilter } from "../base/index.js";
-import { SDKConstruct } from "../base/index.js";
 import type { GearboxSDK } from "../GearboxSDK.js";
 import type { MarketStateHuman } from "../types/index.js";
 import { AddressMap } from "../utils/index.js";
@@ -9,7 +8,8 @@ import { MarketConfiguratorContract } from "./MarketConfiguratorContract.js";
 import { MarketSuite } from "./MarketSuite.js";
 import type { IPriceOracleContract } from "./oracle/index.js";
 import type { PoolSuite } from "./pool/index.js";
-export declare class MarketRegister extends SDKConstruct {
+import { ZapperRegister } from "./ZapperRegister.js";
+export declare class MarketRegister extends ZapperRegister {
     #private;
     constructor(sdk: GearboxSDK, ignoreMarkets?: Address[]);
     hydrate(state: MarketData[]): void;

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

@@ -21,6 +21,7 @@ export declare class MarketSuite extends SDKConstruct {
      */
     readonly state: MarketData;
     constructor(sdk: GearboxSDK, marketData: MarketData);
+    get underlying(): Address;
     get dirty(): boolean;
     get watchAddresses(): Set<Address>;
     stateHuman(raw?: boolean): MarketStateHuman;

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

@@ -0,0 +1,17 @@
+import type { Address } from "viem";
+import { SDKConstruct } from "../base/index.js";
+import { AddressMap } from "../utils/index.js";
+import type { ZapperData } from "./types.js";
+export declare class ZapperRegister extends SDKConstruct {
+    #private;
+    /**
+     * Load zappers for all pools using periphery compressor, adds hardcoded zappers
+     */
+    loadZappers(force?: boolean): Promise<void>;
+    get zappers(): AddressMap<ZapperData[]>;
+    poolZappers(pool: Address): ZapperData[];
+    /**
+     * Can return multiple zappers if there are multiple zappers for the same tokenIn and tokenOut
+     */
+    getZapper(pool: Address, tokenIn: Address, tokenOut: Address): Array<ZapperData> | undefined;
+}

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

@@ -5,3 +5,4 @@ export * from "./MarketSuite.js";
 export * from "./oracle/index.js";
 export * from "./pool/index.js";
 export * from "./pricefeeds/index.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,11 @@
+import type { Address } from "viem";
+import { SDKConstruct } from "../base/index.js";
+import type { AddLiquidityProps, DepositMetadata, IPoolsService, PoolServiceCall, RemoveLiquidityProps } 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;
+    removeLiquidity(props: RemoveLiquidityProps): PoolServiceCall;
+}

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,10 +1,8 @@
-import type { Address } from "viem";
-import type { ierc20ZapperDepositsAbi } from "../../abi/iERC20ZapperDeposits.js";
-import type { iethZapperDepositsAbi } from "../../abi/iETHZapperDeposits.js";
-import type { iZapperAbi } from "../../abi/iZapper.js";
-import type { iPoolV300Abi } from "../../abi/v300.js";
-import type { PoolData_Legacy } from "../index.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";
+import type { PoolData_Legacy } from "../sdk-legacy/index.js";
 interface PermitResult {
     r: Address;
     s: Address;
@@ -16,40 +14,21 @@ interface PermitResult {
     deadline: bigint;
     nonce: bigint;
 }
+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 {
     collateral: Asset;
     pool: Address;
-    account: Address;
-    migrate: boolean;
-    zapper: PoolData_Legacy["zappers"][Address][Address] | undefined;
-    permit: PermitResult | undefined;
-    nativeTokenAddress: Address;
-    referralCode: bigint | undefined;
+    wallet: Address;
+    meta: DepositMetadata;
+    permit?: PermitResult;
+    referralCode?: bigint;
 }
-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 iPoolV300Abi;
-        functionName: "depositWithReferral";
-        args: [bigint, Address, bigint];
-    }
-];
 export interface RemoveLiquidityProps {
     pool: Address;
     amount: bigint;
@@ -57,36 +36,63 @@ export interface RemoveLiquidityProps {
     permit: PermitResult | undefined;
     zapper: PoolData_Legacy["zappers"][Address][Address];
 }
-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 iPoolV300Abi;
-        functionName: "redeem";
-        args: [bigint, Address, Address];
-    }
-];
+export interface DepositMetadata {
+    /**
+     * 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";
+}
 export interface IPoolsService {
     /**
-     * Add liquidity to a 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 - {@link AddLiquidityCall}
      */
-    addLiquidity(props: AddLiquidityProps): AddLiquidityCall;
+    addLiquidity(props: AddLiquidityProps): PoolServiceCall | undefined;
     /**
      * Remove liquidity from a pool
      * @param props - {@link RemoveLiquidityProps}
      * @returns - {@link RemoveLiquidityCall}
      */
-    removeLiquidity(props: RemoveLiquidityProps): RemoveLiquidityCall;
+    removeLiquidity(props: RemoveLiquidityProps): PoolServiceCall;
 }
 export {};

package/dist/types/sdk/sdk-legacy/payload/pool.d.ts

@@ -3,8 +3,8 @@ import type { Address } from "viem";
 import type { peripheryCompressorAbi } from "../../../abi/compressors/peripheryCompressor.js";
 import type { Unarray } from "../../base/types.js";
 import type { NetworkType } from "../../chain/chains.js";
-export type ZapperData = Unarray<AbiParametersToPrimitiveTypes<ExtractAbiFunction<typeof peripheryCompressorAbi, "getZappers">["outputs"]>>;
-export interface ZapperDataFull extends ZapperData {
+type ZapperData = Unarray<AbiParametersToPrimitiveTypes<ExtractAbiFunction<typeof peripheryCompressorAbi, "getZappers">["outputs"]>>;
+interface ZapperDataFull extends ZapperData {
     pool: Address;
 }
 export interface PoolDataPayload {
@@ -178,3 +178,4 @@ export interface UserPoolAggregatedStatsPayload {
     user: Address;
     pools: Array<UserPoolPayload>;
 }
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/sdk",
-  "version": "12.8.0",
+  "version": "13.0.0-next.10",
   "description": "Gearbox SDK",
   "license": "MIT",
   "main": "./dist/cjs/sdk/index.js",
@@ -66,10 +66,10 @@
     "zod": "^4.3.6"
   },
   "devDependencies": {
-    "@biomejs/biome": "^2.3.14",
+    "@biomejs/biome": "^2.4.2",
     "@commitlint/cli": "^20.4.1",
     "@commitlint/config-conventional": "^20.4.1",
-    "@gearbox-protocol/biome-config": "^1.0.20",
+    "@gearbox-protocol/biome-config": "^1.0.21",
     "@types/cross-spawn": "^6.0.6",
     "axios": "^1.13.5",
     "cross-spawn": "^7.0.6",