@gearbox-protocol/sdk 13.2.0-next.1 → 13.2.0

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

@@ -1,56 +1,40 @@
-import { type Address, type Chain, type PublicClient, type Transport } from "viem";
+import type { Address, Chain, PublicClient, Transport } from "viem";
+import type { PhantomTokenContractType } from "../constants/index.js";
 import type { Asset } from "../router/index.js";
-import type { ILogger } from "../types/logger.js";
 import { AddressMap } from "../utils/index.js";
-import { type DSTokenMeta, type KYCTokenMeta, type PhantomTokenMeta, type TokenMetaData } from "./token-types.js";
+import type { TokenMetaData } from "./types.js";
 export interface FormatBNOptions {
     precision?: number;
     symbol?: boolean;
 }
-export declare class TokensMeta extends AddressMap<TokenMetaData> {
+export interface TokenMetaDataExtended extends TokenMetaData {
+    /**
+     * Undefined if token is not a phantom token
+     */
+    phantomTokenType?: PhantomTokenContractType;
+}
+export declare class TokensMeta extends AddressMap<TokenMetaDataExtended> {
     #private;
-    constructor(client: PublicClient<Transport, Chain>, logger?: ILogger);
+    constructor(client: PublicClient<Transport, Chain>);
     reset(): void;
-    upsert(address: string, value: TokenMetaData | undefined): void;
     symbol(token: Address): string;
     decimals(token: Address): number;
     /**
-     * Returns true if the token is a phantom token, throws if the token data is not loaded
-     * @param t
-     * @returns
-     */
-    isPhantomToken(t: TokenMetaData): t is PhantomTokenMeta;
-    /**
-     * Returns true if the token is a KYC underlying token, throws if the token data is not loaded
-     * @param t
-     * @returns
+     * Returns the phantom token type for a given token, or undefined for normal tokens
+     * Throws if the phantom token data is not loaded
      */
-    isKYCUnderlying(t: TokenMetaData): t is KYCTokenMeta;
-    /**
-     * Returns true if the token is a DSToken, throws if the token data is not loaded
-     * @param t
-     * @returns
-     */
-    isDSToken(t: TokenMetaData): t is DSTokenMeta;
+    phantomTokenType(token: Address): PhantomTokenContractType | undefined;
     /**
      * Returns a map of all phantom tokens
-     * Throws if token data is not loaded
-     */
-    get phantomTokens(): AddressMap<PhantomTokenMeta>;
-    /**
-     * Returns a map of all KYC underlying tokens
-     * Throws if token data is not loaded
+     * Throws if the phantom token data is not loaded
      */
-    get kycUnderlyings(): AddressMap<KYCTokenMeta>;
-    get dsTokens(): AddressMap<DSTokenMeta>;
+    get phantomTokens(): AddressMap<TokenMetaDataExtended>;
     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 token information about phantom tokens, KYC underlying tokens and DSTokens
-     *
-     * @param tokens - tokens to load data for, defaults to all tokens
+     * Loads phantom token data for all known tokens from chain
      */
-    loadTokenData(...tokens: Address[]): Promise<void>;
+    loadPhantomTokens(): Promise<void>;
 }

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

@@ -5,5 +5,4 @@ export * from "./errors.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/types.d.ts

@@ -35,6 +35,7 @@ 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/chain/chains.d.ts

@@ -1,6 +1,6 @@
 import type { Address, Chain } from "viem";
 import { z } from "zod/v4";
-export type Curator = "Chaos Labs" | "K3" | "cp0x" | "Re7" | "Invariant Group" | "Tulipa" | "M11 Credit" | "kpk" | "Hyperithm" | "UltraYield" | "TelosC" | "Gami Labs" | "Securitize";
+export type Curator = "Chaos Labs" | "K3" | "cp0x" | "Re7" | "Invariant Group" | "Tulipa" | "M11 Credit" | "kpk" | "Hyperithm" | "UltraYield" | "TelosC" | "Gami Labs";
 export interface GearboxChain extends Chain {
     network: NetworkType;
     defaultMarketConfigurators: Record<Address, Curator>;

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

@@ -4,4 +4,5 @@ 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/constants/phantom-tokens.d.ts

@@ -0,0 +1,2 @@
+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 type PhantomTokenContractType = (typeof PHANTOM_TOKEN_CONTRACT_TYPES)[number];

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

@@ -1,5 +1,6 @@
 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";
@@ -8,8 +9,7 @@ import { MarketConfiguratorContract } from "./MarketConfiguratorContract.js";
 import { MarketSuite } from "./MarketSuite.js";
 import type { IPriceOracleContract } from "./oracle/index.js";
 import type { PoolSuite } from "./pool/index.js";
-import { ZapperRegister } from "./ZapperRegister.js";
-export declare class MarketRegister extends ZapperRegister {
+export declare class MarketRegister extends SDKConstruct {
     #private;
     constructor(sdk: GearboxSDK, ignoreMarkets?: Address[]);
     hydrate(state: MarketData[]): void;

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

@@ -8,7 +8,6 @@ import { type ILossPolicyContract } from "./loss-policy/index.js";
 import { MarketConfiguratorContract } from "./MarketConfiguratorContract.js";
 import type { IPriceOracleContract } from "./oracle/index.js";
 import { PoolSuite } from "./pool/index.js";
-import type { SecuritizeKYCFactory } from "./pool/SecuritizeKYCFactory.js";
 export declare class MarketSuite extends SDKConstruct {
     readonly acl: Address;
     readonly treasury: Address;
@@ -22,8 +21,6 @@ export declare class MarketSuite extends SDKConstruct {
      */
     readonly state: MarketData;
     constructor(sdk: GearboxSDK, marketData: MarketData);
-    get underlying(): Address;
-    getKYCFactory(): Promise<SecuritizeKYCFactory | undefined>;
     get dirty(): boolean;
     get watchAddresses(): Set<Address>;
     stateHuman(raw?: boolean): MarketStateHuman;

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

@@ -844,8 +844,8 @@ declare const abi: readonly [{
     readonly anonymous: false;
 }];
 type abi = typeof abi;
-export { abi as creditFacadeV310Abi };
 export type { abi as CreditFacadeV310Abi };
+export { abi as creditFacadeV310Abi };
 /**
  * SDK-less facade contract, only needs address
  */

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

@@ -5,4 +5,3 @@ 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/pool/PoolSuite.d.ts

@@ -6,7 +6,6 @@ import type { PoolSuiteStateHuman } from "../../types/index.js";
 import type { MarketConfiguratorContract } from "../MarketConfiguratorContract.js";
 import { GaugeContract } from "./GaugeContract.js";
 import { LinearInterestRateModelContract } from "./LinearInterestRateModelContract.js";
-import type { SecuritizeKYCFactory } from "./SecuritizeKYCFactory.js";
 import { TumblerContract } from "./TumblerContract.js";
 import type { IInterestRateModelContract, IRateKeeperContract, PoolContract, PoolQuotaKeeperContract } from "./types.js";
 export declare class PoolSuite extends SDKConstruct {
@@ -21,7 +20,6 @@ export declare class PoolSuite extends SDKConstruct {
     get linearModel(): LinearInterestRateModelContract;
     get marketConfigurator(): MarketConfiguratorContract;
     get underlying(): Address;
-    getKYCFactory(): Promise<SecuritizeKYCFactory | undefined>;
     get dirty(): boolean;
     get watchAddresses(): Set<Address>;
     stateHuman(raw?: boolean): PoolSuiteStateHuman;

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

@@ -1,10 +1,8 @@
 import type { ContractEventName, DecodeFunctionDataReturnType, Log } from "viem";
-import type { CreditManagerDebtParams, PoolState } from "../../base/index.js";
+import type { ConstructOptions, CreditManagerDebtParams, PoolState } from "../../base/index.js";
 import { BaseContract } from "../../base/index.js";
-import type { GearboxSDK } from "../../GearboxSDK.js";
 import type { PoolStateHuman } from "../../types/index.js";
 import { AddressMap } from "../../utils/index.js";
-import { SecuritizeKYCFactory } from "./SecuritizeKYCFactory.js";
 declare const abi: readonly [{
     readonly type: "function";
     readonly inputs: readonly [];
@@ -1132,10 +1130,8 @@ type abi = typeof abi;
 export interface PoolV310Contract extends Omit<PoolState, "baseParams" | "creditManagerDebtParams" | "name">, BaseContract<abi> {
 }
 export declare class PoolV310Contract extends BaseContract<abi> {
-    #private;
     readonly creditManagerDebtParams: AddressMap<CreditManagerDebtParams>;
-    constructor(sdk: GearboxSDK, data: PoolState);
-    getKYCFactory(): Promise<SecuritizeKYCFactory | undefined>;
+    constructor(options: ConstructOptions, data: PoolState);
     stateHuman(raw?: boolean): PoolStateHuman;
     processLog(log: Log<bigint, number, false, undefined, undefined, abi, ContractEventName<abi>>): void;
     protected stringifyFunctionParams(params: DecodeFunctionDataReturnType<abi>): string[];

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

@@ -1,6 +1,4 @@
 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/pools/AbstractPoolService.d.ts

@@ -0,0 +1,9 @@
+import { SDKConstruct } from "../base/index.js";
+import type { GearboxSDK } from "../GearboxSDK.js";
+import type { AddLiquidityCall, AddLiquidityProps, RemoveLiquidityCall, RemoveLiquidityProps } from "./types.js";
+export declare abstract class AbstractPoolService extends SDKConstruct {
+    #private;
+    constructor(sdk: GearboxSDK, version: number);
+    addLiquidity({ collateral, pool, account, zapper, permit, nativeTokenAddress, referralCode, migrate, }: AddLiquidityProps): AddLiquidityCall;
+    removeLiquidity({ pool, amount, account, zapper, permit, }: RemoveLiquidityProps): RemoveLiquidityCall;
+}

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

@@ -0,0 +1,4 @@
+import { AbstractPoolService } from "./AbstractPoolService.js";
+import type { IPoolsService } from "./types.js";
+export declare class PoolServiceV310 extends AbstractPoolService implements IPoolsService {
+}

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

@@ -0,0 +1,3 @@
+import type { GearboxSDK } from "../GearboxSDK.js";
+import type { AbstractPoolService } from "./AbstractPoolService.js";
+export declare function createPoolService(sdk: GearboxSDK, version: number): AbstractPoolService;

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

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

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

@@ -1,7 +1,14 @@
-import type { Abi } from "abitype";
-import type { Address, ContractFunctionArgs, ContractFunctionName } from "viem";
-import type { ZapperData } from "../market/index.js";
+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 { Asset } from "../router/index.js";
+interface IZapper {
+    zapper: Address;
+    tokenIn: Address;
+    tokenOut: Address;
+}
 interface PermitResult {
     r: Address;
     s: Address;
@@ -13,105 +20,77 @@ 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;
-    wallet: Address;
-    meta: DepositMetadata;
-    permit?: PermitResult;
-    referralCode?: bigint;
+    account: Address;
+    migrate: boolean;
+    zapper: IZapper | undefined;
+    permit: PermitResult | undefined;
+    nativeTokenAddress: Address;
+    referralCode: bigint | undefined;
 }
+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];
+    }
+];
 export interface RemoveLiquidityProps {
     pool: Address;
     amount: bigint;
-    wallet: Address;
+    account: Address;
     permit: PermitResult | undefined;
-    meta: WithdrawalMetadata;
-}
-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 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";
+    zapper: IZapper;
 }
+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];
+    }
+];
 export interface IPoolsService {
     /**
-     * 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)
+     * Add liquidity to a pool
      * @param props - {@link AddLiquidityProps}
      * @returns - {@link AddLiquidityCall}
      */
-    addLiquidity(props: AddLiquidityProps): PoolServiceCall | undefined;
+    addLiquidity(props: AddLiquidityProps): AddLiquidityCall;
     /**
      * Remove liquidity from a pool
      * @param props - {@link RemoveLiquidityProps}
      * @returns - {@link RemoveLiquidityCall}
      */
-    removeLiquidity(props: RemoveLiquidityProps): PoolServiceCall;
+    removeLiquidity(props: RemoveLiquidityProps): RemoveLiquidityCall;
 }
 export {};

package/dist/types/sdk/utils/AddressMap.d.ts

@@ -3,7 +3,7 @@ export declare class AddressMap<T> {
     #private;
     constructor(entries?: Array<[string, T]>, name?: string);
     /**
-     * Adds or overwrites value, undefined removes value
+     * Adds or updates value, undefined removes value
      * @param address
      * @param value
      */

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

@@ -1,11 +1,7 @@
 import type { Account, Chain, Client, SendTransactionRequest, SendTransactionReturnType, Transport } from "viem";
-import { type EstimateGasParameters, type SendTransactionParameters } from "viem/actions";
+import { 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.2.0-next.1",
+  "version": "13.2.0",
   "description": "Gearbox SDK",
   "license": "MIT",
   "main": "./dist/cjs/sdk/index.js",
@@ -63,7 +63,9 @@
     "prepare": "husky",
     "check": "biome check --write",
     "check:ci": "biome check --diagnostic-level=error",
-    "typecheck:ci": "tsc --noEmit"
+    "typecheck:ci": "tsc --noEmit",
+    "docs": "NODE_OPTIONS='--max-old-space-size=8192' pnpm --filter @gearbox-protocol/sdk-docs build",
+    "docs:dev": "pnpm --filter @gearbox-protocol/sdk-docs start"
   },
   "dependencies": {
     "@gearbox-protocol/integrations-v3": "1.54.2",
@@ -112,5 +114,5 @@
       "biome check --no-errors-on-unmatched --write"
     ]
   },
-  "packageManager": "yarn@4.9.2"
+  "packageManager": "pnpm@10.33.0"
 }