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

package/dist/types/sdk/accounts/AbstractCreditAccountsService.d.ts

@@ -2,10 +2,11 @@ import type { Address } from "viem";
 import type { CreditAccountData } from "../base/index.js";
 import { SDKConstruct } from "../base/index.js";
 import type { GearboxSDK } from "../GearboxSDK.js";
+import type { CreditSuite, MarketSuite } from "../market/index.js";
 import { type PriceUpdate, type UpdatePriceFeedsResult } from "../market/index.js";
 import { type Asset, type RouterCASlice } from "../router/index.js";
-import type { MultiCall, RawTx } from "../types/index.js";
-import type { AccountToCheck, AddCollateralProps, ChangeDeptProps, ClaimDelayedProps, CloseCreditAccountProps, CloseCreditAccountResult, CreditAccountOperationResult, CreditAccountTokensSlice, ExecuteSwapProps, FullyLiquidateProps, FullyLiquidateResult, GetConnectedBotsResult, GetConnectedMigrationBotsResult, GetCreditAccountsOptions, GetPendingWithdrawalsProps, GetPendingWithdrawalsResult, OpenCAProps, PermitResult, PrepareUpdateQuotasProps, PreviewDelayedWithdrawalProps, PreviewDelayedWithdrawalResult, Rewards, StartDelayedWithdrawalProps, UpdateQuotasProps } from "./types.js";
+import type { IPriceUpdateTx, MultiCall, RawTx } from "../types/index.js";
+import type { AccountToCheck, AddCollateralProps, ChangeDeptProps, ClaimDelayedProps, CloseCreditAccountProps, CloseCreditAccountResult, CloseOptions, CreditAccountDataWithInvestor, CreditAccountOperationResult, CreditAccountTokensSlice, ExecuteSwapProps, FullyLiquidateProps, FullyLiquidateResult, GetApprovalAddressProps, GetConnectedBotsResult, GetConnectedMigrationBotsResult, GetCreditAccountsOptions, GetPendingWithdrawalsProps, GetPendingWithdrawalsResult, OpenCAProps, PermitResult, PrepareUpdateQuotasProps, PreviewDelayedWithdrawalProps, PreviewDelayedWithdrawalResult, Rewards, StartDelayedWithdrawalProps, UpdateQuotasProps } from "./types.js";
 /**
  * Options for configuring the credit account service.
  **/
@@ -32,10 +33,42 @@ export declare abstract class AbstractCreditAccountService extends SDKConstruct
      * {@inheritDoc ICreditAccountsService.getCreditAccountData}
      **/
     getCreditAccountData(account: Address, blockNumber?: bigint): Promise<CreditAccountData | undefined>;
+    /**
+     * Returns credit account data for a single account with the investor address resolved.
+     * Loads CA via getCreditAccountData; for KYC underlyings fetches the investor from the KYC factory's getInvestor(creditAccount), otherwise uses the account owner.
+     * @param account - Credit account address
+     * @param blockNumber - Optional block number for the read
+     * @returns CreditAccountDataWithInvestor (CA data + investor address), or undefined if the account is not found
+     */
+    getCreditAccountDataWithInvestor(account: Address, blockNumber?: bigint): Promise<CreditAccountDataWithInvestor | undefined>;
     /**
      * {@inheritDoc ICreditAccountsService.getCreditAccounts}
      **/
     getCreditAccounts(options?: GetCreditAccountsOptions, blockNumber?: bigint): Promise<Array<CreditAccountData>>;
+    /**
+     * Returns all credit accounts matching the filter, with investor set on each item.
+     * Delegates to getCreditAccounts; when options.owner is set, also loads KYC credit accounts for that owner and merges them into the list. Result is sorted by health factor ascending.
+     * @param options - Filter options (owner, creditManager, health factor, etc.)
+     * @param blockNumber - Optional block number for the read
+     * @returns Array of credit accounts (with investor field), sorted by health factor ascending
+     */
+    getCreditAccountsWithInvestor(options?: GetCreditAccountsOptions, blockNumber?: bigint): Promise<Array<CreditAccountDataWithInvestor>>;
+    protected getKYCCreditAccountsOfOwner(owner: Address, priceUpdateTxs: IPriceUpdateTx<{
+        priceFeed: `0x${string}`;
+        timestamp: number;
+    }>[], blockNumber?: bigint): Promise<Array<CreditAccountDataWithInvestor>>;
+    /**
+     * Loads credit account data for the given addresses using simulateWithPriceUpdates.
+     * Applies the provided price update txs before reading, so returned data is consistent with up-to-date prices.
+     * @param accounts - Credit account addresses to load
+     * @param priceUpdateTxs - Price feed update txs to simulate before the read (e.g. from generatePriceFeedsUpdateTxs)
+     * @param blockNumber - Optional block number for the read
+     * @returns Array of CreditAccountData in the same order as accounts (throws if any getCreditAccountData call reverts)
+     */
+    loadSpecifiedAccounts(accounts: Address[], priceUpdateTxs: IPriceUpdateTx<{
+        priceFeed: `0x${string}`;
+        timestamp: number;
+    }>[], blockNumber?: bigint): Promise<Array<CreditAccountData>>;
     /**
      * {@inheritDoc ICreditAccountsService.getRewards}
      **/
@@ -69,7 +102,7 @@ export declare abstract class AbstractCreditAccountService extends SDKConstruct
     /**
      * {@inheritDoc ICreditAccountsService.changeDebt}
      **/
-    changeDebt({ creditAccount, amount, addCollateral, }: ChangeDeptProps): Promise<CreditAccountOperationResult>;
+    changeDebt({ creditAccount, amount, collateral, }: ChangeDeptProps): Promise<CreditAccountOperationResult>;
     /**
      * {@inheritDoc ICreditAccountsService.executeSwap}
      **/
@@ -90,10 +123,17 @@ export declare abstract class AbstractCreditAccountService extends SDKConstruct
      * {@inheritDoc ICreditAccountsService.claimDelayed}
      **/
     claimDelayed({ creditAccount, minQuota, averageQuota, claimableNow, }: ClaimDelayedProps): Promise<CreditAccountOperationResult>;
+    /**
+     * Returns address to which approval should be given on collateral token
+     * It's credit manager for classical markets and special wallet for KYC markets
+     * @param options - {@link GetApprovalAddressProps}
+     * @returns
+     **/
+    getApprovalAddress(options: GetApprovalAddressProps): Promise<Address>;
     /**
      * {@inheritDoc ICreditAccountsService.openCA}
      **/
-    openCA({ ethAmount, creditManager, collateral, permits, debt, withdrawDebt, referralCode, to, calls: openPathCalls, minQuota, averageQuota, }: OpenCAProps): Promise<CreditAccountOperationResult>;
+    openCA(props: OpenCAProps): Promise<CreditAccountOperationResult>;
     /**
      * {@inheritDoc ICreditAccountsService.getBorrowRate}
      **/
@@ -103,6 +143,43 @@ export declare abstract class AbstractCreditAccountService extends SDKConstruct
      **/
     getOptimalHFForPartialLiquidation(ca: CreditAccountData): bigint;
     /**
+     * Returns multicall entries to redeem (unwrap) KYC ERC-4626 vault shares into underlying for the given credit manager.
+     * Used when withdrawing debt from a KYC market: redeems adapter vault shares so the underlying can be withdrawn.
+     * Only applies when the credit manager's underlying is KYC-gated and has an ERC-4626 adapter configured.
+     * @param amount - Number of vault shares (adapter tokens) to redeem
+     * @param creditManager - Credit manager address
+     * @returns Array of MultiCall to pass to credit facade multicall, or undefined if underlying is not KYC or no adapter is configured
+     */
+    getKYCUnwrapCalls(amount: bigint, creditManager: Address): Promise<Array<MultiCall> | undefined>;
+    /**
+     * Returns multicall entries to deposit (wrap) underlying into KYC ERC-4626 vault shares for the given credit manager.
+     * Used when adding debt on a KYC market: deposits underlying into the adapter vault so shares are minted on the account.
+     * Only applies when the credit manager's underlying is KYC-gated and has an ERC-4626 adapter configured.
+     * @param amount - Amount of underlying assets to deposit into the vault (in underlying decimals)
+     * @param creditManager - Credit manager address
+     * @returns Array of MultiCall to pass to credit facade multicall, or undefined if underlying is not KYC or no adapter is configured
+     */
+    getKYCWrapCalls(amount: bigint, creditManager: Address): Promise<Array<MultiCall> | undefined>;
+    /**
+     * Returns multicall entries to call redeemDiff on the KYC ERC-4626 adapter for the given credit manager.
+     * Redeems the leftover vault shares (e.g. after repaying debt) so the account does not hold excess KYC vault tokens.
+     * Only applies when the credit manager's underlying is KYC-gated and has an ERC-4626 adapter configured.
+     * @param amount - Leftover vault share amount to redeem (in adapter/vault decimals)
+     * @param creditManager - Credit manager address
+     * @returns Array of MultiCall to pass to credit facade multicall, or undefined if underlying is not KYC or no adapter is configured
+     */
+    getRedeemDiffCalls(amount: bigint, creditManager: Address): Promise<Array<MultiCall> | undefined>;
+    /**
+     * Returns multicall entries to call depositDiff on the KYC ERC-4626 adapter for the given credit manager.
+     * Deposits the leftover underlying (e.g. after decreasing debt) into the vault so the account does not hold excess underlying.
+     * Only applies when the credit manager's underlying is KYC-gated and has an ERC-4626 adapter configured.
+     * @param amount - Leftover underlying amount to deposit into the vault (in underlying decimals)
+     * @param creditManager - Credit manager address
+     * @returns Array of MultiCall to pass to credit facade multicall, or undefined if underlying is not KYC or no adapter is configured
+     */
+    getDepositDiffCalls(amount: bigint, creditManager: Address): Promise<Array<MultiCall> | undefined>;
+    /**
+     * Returns raw txs that are needed to update all price feeds so that all credit accounts (possibly from different markets) compute
      * {@inheritDoc ICreditAccountsService.getOnDemandPriceUpdates}
      **/
     getOnDemandPriceUpdates(account: CreditAccountTokensSlice, ignoreReservePrices?: boolean): Promise<PriceUpdate[]>;
@@ -157,4 +234,38 @@ export declare abstract class AbstractCreditAccountService extends SDKConstruct
     private get marketConfigurators();
     private get rewardCompressor();
     private get peripheryCompressor();
+    /**
+     * Wrapper that selects between credit facade and KYC factory
+     * @param suite
+     * @param to
+     * @param calls
+     * @param referralCode
+     * @returns
+     */
+    protected openCreditAccountTx(suite: CreditSuite, to: Address, calls: MultiCall[], referralCode?: bigint): Promise<RawTx>;
+    /**
+     * Wrapper that selects between credit facade and KYC factory
+     * @param suite
+     * @param creditAccount
+     * @param calls
+     * @returns
+     */
+    protected multicallTx(suite: CreditSuite, creditAccount: Address, calls: MultiCall[]): Promise<RawTx>;
+    /**
+     * Wrapper that selects between credit facade and KYC factory
+     * @param suite
+     * @param creditAccount
+     * @param calls
+     * @param operation
+     * @returns
+     */
+    protected closeCreditAccountTx(suite: CreditSuite, creditAccount: Address, calls: MultiCall[], operation: CloseOptions): Promise<RawTx>;
+    /**
+     * Returns all KYC credit account addresses for an investor across the given market suites.
+     * Resolves KYC factory per suite, then multicalls each factory's getCreditAccounts(investor).
+     * @param investor - Owner address to query
+     * @param suites - Market suites (KYC factories are resolved for each; undefined entries are skipped)
+     * @returns Flat array of credit account addresses from all KYC markets
+     */
+    protected getKYCCaOfInvestor(investor: Address, suites: Array<MarketSuite | undefined>): Promise<`0x${string}`[]>;
 }

package/dist/types/sdk/accounts/CreditAccountsServiceV310.d.ts

@@ -21,7 +21,7 @@ export declare class CreditAccountServiceV310 extends AbstractCreditAccountServi
     /**
      * {@inheritDoc ICreditAccountsService.repayCreditAccount}
      */
-    repayCreditAccount({ operation, collateralAssets, assetsToWithdraw, creditAccount: ca, permits, to, tokensToClaim, }: RepayCreditAccountProps): Promise<CreditAccountOperationResult>;
+    repayCreditAccount({ operation, collateralAssets, assetsToWithdraw, creditAccount: ca, permits, to, tokensToClaim, calls: wrapCalls, }: RepayCreditAccountProps): Promise<CreditAccountOperationResult>;
     /**
      * {@inheritDoc ICreditAccountsService.repayAndLiquidateCreditAccount}
      */

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

@@ -5,7 +5,7 @@ import type { ConnectedBotData, Construct, CreditAccountData } from "../base/ind
 import type { GearboxSDK } from "../GearboxSDK.js";
 import type { CreditSuite, PriceUpdate } from "../market/index.js";
 import type { Asset, RouterCASlice, RouterCloseResult } from "../router/index.js";
-import type { MultiCall, RawTx } from "../types/index.js";
+import type { IPriceUpdateTx, MultiCall, RawTx } from "../types/index.js";
 /**
  * @internal
  * Arguments tuple for the credit account compressor's `getCreditAccounts` view method.
@@ -182,6 +182,10 @@ export interface CloseCreditAccountProps {
     closePath?: RouterCloseResult;
 }
 export interface RepayCreditAccountProps extends RepayAndLiquidateCreditAccountProps {
+    /**
+     * Swap calls for repay
+     */
+    calls?: Array<MultiCall>;
     /**
      * close or zeroDebt
      */
@@ -389,8 +393,9 @@ export interface OpenCAProps extends PrepareUpdateQuotasProps {
     /**
      * Flag to withdraw debt to wallet after opening credit account;
      * used for borrowing functionality
+     * If true, will withdraw underlying token, otherwise will withdraw specified token
      */
-    withdrawDebt?: boolean;
+    withdrawToken?: boolean | Address;
     /**
      * Permits of collateral tokens (in any permittable token is present) {@link PermitResult}
      */
@@ -400,10 +405,19 @@ export interface OpenCAProps extends PrepareUpdateQuotasProps {
      * Used for trading and strategy functionality
      */
     calls: Array<MultiCall>;
+    /**
+     * Slot for optional call to execute after main tx.
+     * For example: add bots
+     */
+    callsAfter?: Array<MultiCall>;
     /**
      * Address of credit manager to open credit account on
      */
     creditManager: Address;
+    /**
+     * Optional address of credit account to reopen
+     */
+    reopenCreditAccount?: Address;
     /**
      * Wallet address to transfer credit account to
      */
@@ -426,9 +440,13 @@ export interface ChangeDeptProps {
      */
     amount: bigint;
     /**
-     * If true, will add collateral to the credit account
+     * Assets to add as collateral
      */
-    addCollateral: boolean;
+    collateral?: [Asset];
+    /**
+     * Assets to wrap
+     */
+    wrapAsset?: [Asset];
 }
 export interface FullyLiquidateProps {
     /**
@@ -604,6 +622,19 @@ export interface LlamathenaProportionalWithdrawProps extends PrepareUpdateQuotas
      */
     creditAccount: RouterCASlice;
 }
+/**
+ * Options to get approval address for collateral token
+ */
+export type GetApprovalAddressProps = {
+    creditManager: Address;
+    borrower: Address;
+} | {
+    creditManager: Address;
+    creditAccount: Address;
+};
+export type CreditAccountDataWithInvestor = CreditAccountData & {
+    investor: Address;
+};
 export interface ICreditAccountsService extends Construct {
     sdk: GearboxSDK;
     /**
@@ -614,15 +645,41 @@ export interface ICreditAccountsService extends Construct {
      * @returns
      */
     getCreditAccountData(account: Address, blockNumber?: bigint): Promise<CreditAccountData | undefined>;
+    /**
+     * Returns credit account data for a single account with the investor address resolved (from KYC factory when applicable).
+     * @param account - Credit account address
+     * @param blockNumber - Optional block number for the read
+     * @returns CreditAccountDataWithInvestor, or undefined if the account is not found
+     */
+    getCreditAccountDataWithInvestor(account: Address, blockNumber?: bigint): Promise<CreditAccountDataWithInvestor | undefined>;
     /**
      * Methods to get all credit accounts with some optional filtering
      * Performs all necessary price feed updates under the hood
      *
      * @param options
      * @param blockNumber
-     * @returns returned credit accounts are sorted by health factor in ascending order
+     * @param priceUpdate - Optional pre-computed price feed update (e.g. from generatePriceFeedsUpdateTxs)
+     * @returns Credit accounts sorted by health factor ascending
      */
     getCreditAccounts(options?: GetCreditAccountsOptions, blockNumber?: bigint): Promise<Array<CreditAccountData>>;
+    /**
+     * Returns all credit accounts matching the filter with investor set on each; when options.owner is set, includes KYC CAs for that owner.
+     * @param options - Filter options (owner, creditManager, health factor, etc.)
+     * @param blockNumber - Optional block number for the read
+     * @returns Credit accounts (with investor) sorted by health factor ascending
+     */
+    getCreditAccountsWithInvestor(options?: GetCreditAccountsOptions, blockNumber?: bigint): Promise<Array<CreditAccountDataWithInvestor>>;
+    /**
+     * Loads credit account data for the given addresses using simulateWithPriceUpdates (with price updates applied before the read).
+     * @param accounts - Credit account addresses to load
+     * @param priceUpdateTxs - Price feed update txs to simulate before the read (e.g. from generatePriceFeedsUpdateTxs)
+     * @param blockNumber - Optional block number for the read
+     * @returns Array of CreditAccountData in the same order as accounts
+     */
+    loadSpecifiedAccounts(accounts: Address[], priceUpdateTxs: IPriceUpdateTx<{
+        priceFeed: `0x${string}`;
+        timestamp: number;
+    }>[], blockNumber?: bigint): Promise<Array<CreditAccountData>>;
     /**
      * Method to get all claimable rewards for credit account (ex. stkUSDS SKY rewards).
      * Associates rewards by adapter + stakedPhantomToken.
@@ -651,9 +708,9 @@ export interface ICreditAccountsService extends Construct {
     /**
      * Generates transaction to liquidate credit account
      * @param props - {@link FullyLiquidateProps}
-     * @returns
+     * @returns Transaction data and optional loss policy data
      */
-    fullyLiquidate(props: FullyLiquidateProps): Promise<CloseCreditAccountResult>;
+    fullyLiquidate(props: FullyLiquidateProps): Promise<FullyLiquidateResult>;
     /**
      * Closes credit account or closes credit account and keeps it open with zero debt.
      * - Ca is closed in the following order: price update -> close path to swap all tokens into underlying ->
@@ -716,6 +773,13 @@ export interface ICreditAccountsService extends Construct {
      * @returns
     */
     claimDelayed(props: ClaimDelayedProps): Promise<CreditAccountOperationResult>;
+    /**
+     * Returns address to which approval should be given on collateral token
+     * It's credit manager for classical markets and special wallet for KYC markets
+     * @param props - {@link GetApprovalAddressProps}
+     * @returns
+     */
+    getApprovalAddress(props: GetApprovalAddressProps): Promise<Address>;
     /**
      * Executes swap specified by given calls, update quotas of affected tokens
      * - Open credit account is executed in the following order: price update -> increase debt -> add collateral ->
@@ -771,6 +835,42 @@ export interface ICreditAccountsService extends Construct {
     botMulticall(creditAccount: RouterCASlice, calls: Array<MultiCall>, options?: {
         ignoreReservePrices?: boolean;
     }): Promise<RawTx>;
+    /**
+     * Returns multicall entries to redeem (unwrap) KYC ERC-4626 vault shares into underlying for the given credit manager.
+     * Used when withdrawing debt from a KYC market: redeems adapter vault shares so the underlying can be withdrawn.
+     * Only applies when the credit manager's underlying is KYC-gated and has an ERC-4626 adapter configured.
+     * @param amount - Number of vault shares (adapter tokens) to redeem
+     * @param creditManager - Credit manager address
+     * @returns Array of MultiCall to pass to credit facade multicall, or undefined if underlying is not KYC or no adapter is configured
+     */
+    getKYCUnwrapCalls(amount: bigint, creditManager: Address): Promise<Array<MultiCall> | undefined>;
+    /**
+     * Returns multicall entries to deposit (wrap) underlying into KYC ERC-4626 vault shares for the given credit manager.
+     * Used when adding debt on a KYC market: deposits underlying into the adapter vault so shares are minted on the account.
+     * Only applies when the credit manager's underlying is KYC-gated and has an ERC-4626 adapter configured.
+     * @param amount - Amount of underlying assets to deposit into the vault (in underlying decimals)
+     * @param creditManager - Credit manager address
+     * @returns Array of MultiCall to pass to credit facade multicall, or undefined if underlying is not KYC or no adapter is configured
+     */
+    getKYCWrapCalls(amount: bigint, creditManager: Address): Promise<Array<MultiCall> | undefined>;
+    /**
+     * Returns multicall entries to call redeemDiff on the KYC ERC-4626 adapter for the given credit manager.
+     * Redeems the leftover vault shares (e.g. after repaying debt) so the account does not hold excess KYC vault tokens.
+     * Only applies when the credit manager's underlying is KYC-gated and has an ERC-4626 adapter configured.
+     * @param amount - Leftover vault share amount to redeem (in adapter/vault decimals)
+     * @param creditManager - Credit manager address
+     * @returns Array of MultiCall to pass to credit facade multicall, or undefined if underlying is not KYC or no adapter is configured
+     */
+    getRedeemDiffCalls(amount: bigint, creditManager: Address): Promise<Array<MultiCall> | undefined>;
+    /**
+     * Returns multicall entries to call depositDiff on the KYC ERC-4626 adapter for the given credit manager.
+     * Deposits the leftover underlying (e.g. after decreasing debt) into the vault so the account does not hold excess underlying.
+     * Only applies when the credit manager's underlying is KYC-gated and has an ERC-4626 adapter configured.
+     * @param amount - Leftover underlying amount to deposit into the vault (in underlying decimals)
+     * @param creditManager - Credit manager address
+     * @returns Array of MultiCall to pass to credit facade multicall, or undefined if underlying is not KYC or no adapter is configured
+     */
+    getDepositDiffCalls(amount: bigint, creditManager: Address): Promise<Array<MultiCall> | undefined>;
     /**
      * Withdraws a single collateral from credit account to wallet to and updates quotas;
      * technically can withdraw several tokens at once

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

@@ -1,8 +1,8 @@
-import type { Address, Chain, PublicClient, Transport } from "viem";
-import type { PhantomTokenContractType } from "../constants/index.js";
+import { type Address, type Chain, type PublicClient, type Transport } from "viem";
 import type { Asset } from "../router/index.js";
+import type { ILogger } from "../types/logger.js";
 import { AddressMap } from "../utils/index.js";
-import type { TokenMetaData } from "./types.js";
+import { type DSTokenMeta, type KYCTokenMeta, type PhantomTokenMeta, type TokenMetaData } from "./token-types.js";
 /**
  * Options for {@link TokensMeta.formatBN}.
  **/
@@ -16,15 +16,6 @@ export interface FormatBNOptions {
      **/
     symbol?: boolean;
 }
-/**
- * Token metadata enriched with some attributes specific to certain classes of tokens
- **/
-export interface TokenMetaDataExtended extends TokenMetaData {
-    /**
-     * Classification of the phantom token, or `undefined` for normal tokens.
-     **/
-    phantomTokenType?: PhantomTokenContractType;
-}
 /**
  * Registry of token metadata (symbol, decimals, phantom type) keyed by address.
  *
@@ -33,13 +24,14 @@ export interface TokenMetaDataExtended extends TokenMetaData {
  *
  * Provides methods to lazy-load information about certain classes of tokens (e.g. phantom tokens)
  */
-export declare class TokensMeta extends AddressMap<TokenMetaDataExtended> {
+export declare class TokensMeta extends AddressMap<TokenMetaData> {
     #private;
-    constructor(client: PublicClient<Transport, Chain>);
+    constructor(client: PublicClient<Transport, Chain>, logger?: ILogger);
     /**
      * Clears all token metadata
      **/
     reset(): void;
+    upsert(address: string, value: TokenMetaData | undefined): void;
     /**
      * Returns the symbol string for a token.
      * @param token - Token address.
@@ -53,15 +45,34 @@ export declare class TokensMeta extends AddressMap<TokenMetaDataExtended> {
      */
     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
+     * 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
+     */
+    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
      */
-    phantomTokenType(token: Address): PhantomTokenContractType | undefined;
+    isDSToken(t: TokenMetaData): t is DSTokenMeta;
     /**
      * Returns a map of all phantom tokens
-     * Throws if the phantom token data is not loaded
+     * Throws if token data is not loaded
      */
-    get phantomTokens(): AddressMap<TokenMetaDataExtended>;
+    get phantomTokens(): AddressMap<PhantomTokenMeta>;
+    /**
+     * Returns a map of all KYC underlying tokens
+     * Throws if token data is not loaded
+     */
+    get kycUnderlyings(): AddressMap<KYCTokenMeta>;
+    get dsTokens(): AddressMap<DSTokenMeta>;
     /**
      * Formats a raw token amount into a human-readable decimal string,
      * dividing by `10^decimals` for the token.
@@ -91,7 +102,9 @@ export declare class TokensMeta extends AddressMap<TokenMetaDataExtended> {
      */
     mustFindBySymbol(symbol: string): TokenMetaData;
     /**
-     * Loads phantom token data for all known tokens from chain
+     * Loads token information about phantom tokens, KYC underlying tokens and DSTokens
+     *
+     * @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

@@ -5,4 +5,5 @@ 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/token-types.d.ts

@@ -0,0 +1,33 @@
+import type { Address } from "viem";
+import type { MarketData, Unarray } from "./types.js";
+type TokenData = 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 SimpleTokenMeta = TokenData & {
+    isDSToken?: boolean;
+    contractType?: string;
+};
+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 DSTokenMeta = Omit<SimpleTokenMeta, "isDSToken"> & {
+    isDSToken: true;
+};
+export type KYCTokenMeta = KYCDefaultTokenMeta | KYCOnDemandTokenMeta;
+export type TokenMetaData = SimpleTokenMeta | PhantomTokenMeta | KYCTokenMeta | DSTokenMeta;
+export {};

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

@@ -102,13 +102,6 @@ export type CreditConfiguratorState = CreditSuiteState["creditConfigurator"];
  * Adapter contract data for a credit suite.
  **/
 export type AdapterData = Unarray<CreditSuiteState["adapters"]>;
-/**
- * On-chain metadata for a single token (symbol, decimals, address).
- **/
-export type TokenMetaData = Unarray<MarketData["tokens"]>;
-/**
- * On-chain state of a lending pool.
- **/
 export type PoolState = MarketData["pool"];
 /**
  * On-chain state of a quota keeper.

package/dist/types/sdk/chain/chains.d.ts

@@ -4,7 +4,7 @@ import { z } from "zod/v4";
  * Known curator names that manage Gearbox markets.
  *
  **/
-export type Curator = "Chaos Labs" | "K3" | "cp0x" | "Re7" | "Invariant Group" | "Tulipa" | "M11 Credit" | "kpk" | "Hyperithm" | "UltraYield" | "TelosC" | "Gami Labs";
+export type Curator = "Chaos Labs" | "K3" | "cp0x" | "Re7" | "Invariant Group" | "Tulipa" | "M11 Credit" | "kpk" | "Hyperithm" | "UltraYield" | "TelosC" | "Gami Labs" | "Securitize";
 /**
  * Extended viem {@link Chain} with Gearbox-specific metadata.
  *

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,6 +8,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";
 /**
  * Central registry of all Gearbox markets on the current chain.
  *
@@ -16,7 +16,7 @@ import type { PoolSuite } from "./pool/index.js";
  * managers into a single unit. The `MarketRegister` loads this data from the
  * on-chain market compressor and exposes convenience lookup methods
  **/
-export declare class MarketRegister extends SDKConstruct {
+export declare class MarketRegister extends ZapperRegister {
     #private;
     /**
      * @param sdk - Top-level SDK instance.

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

@@ -8,6 +8,7 @@ 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;
@@ -21,6 +22,8 @@ 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/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/pool/PoolSuite.d.ts

@@ -6,6 +6,7 @@ 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 {
@@ -20,6 +21,7 @@ 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,8 +1,10 @@
 import type { ContractEventName, DecodeFunctionDataReturnType, Log } from "viem";
-import type { ConstructOptions, CreditManagerDebtParams, PoolState } from "../../base/index.js";
+import type { 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 [];
@@ -1130,8 +1132,10 @@ 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(options: ConstructOptions, data: PoolState);
+    constructor(sdk: GearboxSDK, data: PoolState);
+    getKYCFactory(): Promise<SecuritizeKYCFactory | undefined>;
     stateHuman(raw?: boolean): PoolStateHuman;
     processLog(log: Log<bigint, number, false, undefined, undefined, abi, ContractEventName<abi>>): void;
     protected stringifyFunctionParams(params: DecodeFunctionDataReturnType<abi>): string[];