@gearbox-protocol/sdk 13.5.0 → 13.6.0-kyc.2

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

@@ -1,8 +1,8 @@
-import { type Address, type Chain, type PublicClient, type Transport } from "viem";
+import type { Address, Chain, PublicClient, 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 { PhantomTokenMeta, TokenMetaData } from "./token-types.js";
+import type { KYCTokenMeta, PhantomTokenMeta, TokenMetaData } from "./token-types.js";
 /**
  * Options for {@link TokensMeta.formatBN}.
  **/
@@ -50,11 +50,22 @@ export declare class TokensMeta extends AddressMap<TokenMetaData> {
      * @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 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
+     */
+    get kycUnderlyings(): AddressMap<KYCTokenMeta>;
     /**
      * Formats a raw token amount into a human-readable decimal string,
      * dividing by `10^decimals` for the token.
@@ -85,7 +96,7 @@ export declare class TokensMeta extends AddressMap<TokenMetaData> {
     mustFindBySymbol(symbol: string): TokenMetaData;
     /**
      * Loads token information about phantom tokens
-     * Other special tokens may be loaded here in the future
+     * In future other custom tokens types that do not have compressors might be handled here
      *
      * @param tokens - tokens to load data for, defaults to all tokens
      */

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

@@ -1,13 +1,53 @@
+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 declare const KYC_ON_DEMAND_LP_MONOPOLIZED = "ON_DEMAND_LP::MONOPOLIZED";
+export type KYCOnDemandLpContractType = typeof KYC_ON_DEMAND_LP_MONOPOLIZED;
 export type PhantomTokenContractType = (typeof PHANTOM_TOKEN_CONTRACT_TYPES)[number];
-export type SimpleTokenMeta = TokenData & {
-    isDSToken?: boolean;
+export interface SimpleTokenMeta extends TokenData {
     contractType?: string;
-};
+}
 export type PhantomTokenMeta = SimpleTokenMeta & {
     contractType: PhantomTokenContractType;
 };
-export type TokenMetaData = SimpleTokenMeta | PhantomTokenMeta;
+export interface KYCDefaultTokenMeta extends SimpleTokenMeta {
+    contractType: typeof KYC_UNDERLYING_DEFAULT;
+    kycFactory: Address;
+    asset: Address;
+}
+export interface LPMonopolizedPoolMeta {
+    pool: Address;
+    wrappedUnderlying: Address;
+    unwrappedUnderlying: Address;
+    depositAllowance: bigint;
+    claimableAmount: bigint;
+}
+export interface KYCOnDemandLPMonopolizedMeta {
+    addr: Address;
+    version: bigint;
+    contractType: typeof KYC_ON_DEMAND_LP_MONOPOLIZED;
+    marketConfigurator: Address;
+    /**
+     * Only this user can deposit into the pool and withdraw
+     * Other users should not see it at all
+     */
+    depositor: Address;
+    pools: LPMonopolizedPoolMeta[];
+}
+export type KYCOnDemandLPMeta = KYCOnDemandLPMonopolizedMeta;
+export interface KYCOnDemandTokenMeta extends SimpleTokenMeta {
+    contractType: typeof KYC_UNDERLYING_ON_DEMAND;
+    kycFactory: Address;
+    asset: Address;
+    pool: Address;
+    marketConfigurator: Address;
+    allowedDepositors: Address[];
+    liquidityProvider: KYCOnDemandLPMeta;
+}
+export type KYCTokenMeta = KYCDefaultTokenMeta | KYCOnDemandTokenMeta;
+export type TokenMetaData = SimpleTokenMeta | PhantomTokenMeta | KYCTokenMeta;
 export {};

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

@@ -1,6 +1,5 @@
 import type { AbiParametersToPrimitiveTypes, ExtractAbiFunction } from "abitype";
 import type { Address, Hex } from "viem";
-import type { creditAccountCompressorAbi } from "../../abi/compressors/creditAccountCompressor.js";
 import type { gaugeCompressorAbi } from "../../abi/compressors/gaugeCompressor.js";
 import type { marketCompressorAbi } from "../../abi/compressors/marketCompressor.js";
 import type { peripheryCompressorAbi } from "../../abi/compressors/peripheryCompressor.js";
@@ -62,10 +61,125 @@ export interface BaseState {
  * Filter criteria for querying markets.
  **/
 export type MarketFilter = AbiParametersToPrimitiveTypes<ExtractAbiFunction<typeof marketCompressorAbi, "getMarkets">["inputs"]>[0];
+/**
+ * Info on credit account's assets
+ **/
+export interface TokenInfo {
+    /**
+     * Token address.
+     **/
+    token: Address;
+    /**
+     * Token mask in the credit manager.
+     **/
+    mask: bigint;
+    /**
+     * Account's balance of token.
+     **/
+    balance: bigint;
+    /**
+     * Account's quota of token.
+     **/
+    quota: bigint;
+    /**
+     * Whether balance call was successful.
+     **/
+    success: boolean;
+}
+/**
+ * On-chain state of a credit account.
+ *
+ * @remarks
+ * Fields from `totalDebtUSD` through `healthFactor` are not filled when
+ * `success` is `false`.
+ *
+ **/
+export interface CreditAccountDataPayload {
+    /**
+     * Credit account address.
+     **/
+    creditAccount: Address;
+    /**
+     * Credit manager account is opened in.
+     **/
+    creditManager: Address;
+    /**
+     * Facade connected to account's credit manager.
+     **/
+    creditFacade: Address;
+    /**
+     * Credit manager's underlying token.
+     **/
+    underlying: Address;
+    /**
+     * Credit account's owner (contract address for KYC accounts, EOA for
+     * normal accounts).
+     **/
+    owner: Address;
+    /**
+     * Expiration timestamp, in case facade is expirable.
+     **/
+    expirationDate: number;
+    /**
+     * Bitmask of tokens enabled on credit account as collateral.
+     **/
+    enabledTokensMask: bigint;
+    /**
+     * Credit account's debt principal in underlying.
+     **/
+    debt: bigint;
+    /**
+     * Base and quota interest accrued on the credit account.
+     **/
+    accruedInterest: bigint;
+    /**
+     * Fees accrued on the credit account.
+     **/
+    accruedFees: bigint;
+    /**
+     * Account's total debt in USD.
+     **/
+    totalDebtUSD: bigint;
+    /**
+     * Account's total value in USD.
+     **/
+    totalValueUSD: bigint;
+    /**
+     * Account's threshold-weighted value in USD.
+     **/
+    twvUSD: bigint;
+    /**
+     * Account's total value in underlying.
+     **/
+    totalValue: bigint;
+    /**
+     * Account's health factor, i.e. ratio of `twvUSD` to `totalDebtUSD`,
+     * with 18 decimals precision.
+     **/
+    healthFactor: bigint;
+    /**
+     * Whether collateral calculation was successful.
+     **/
+    success: boolean;
+    /**
+     * Info on credit account's enabled tokens and tokens with non-zero balance.
+     **/
+    tokens: readonly TokenInfo[];
+}
 /**
  * Full on-chain snapshot of a single credit account.
+ *
+ * @typeParam WithInvestor - When `true`, the result includes an `investor`
+ *   field (`Address | undefined`).  Defaults to `false` (no investor field).
  **/
-export type CreditAccountData = Unarray<AbiParametersToPrimitiveTypes<ExtractAbiFunction<typeof creditAccountCompressorAbi, "getCreditAccountData">["outputs"]>>;
+export type CreditAccountData<WithInvestor extends boolean = false> = WithInvestor extends true ? CreditAccountDataPayload & {
+    /**
+     * Investor EOA address (the real person behind the account).
+     * - KYC accounts: resolved from KYC factory, always defined.
+     * - Normal accounts: `undefined` (owner IS the investor).
+     **/
+    investor: Address | undefined;
+} : CreditAccountDataPayload;
 /**
  * Reward distribution details for a single reward token.
  **/

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.
  *
@@ -20,6 +20,10 @@ export interface GearboxChain extends Chain {
      * Market configurator addresses operated by known curators on this chain.
      **/
     defaultMarketConfigurators: Record<Address, Curator>;
+    /**
+     * Known KYC factory addresses on this chain
+     */
+    kycFactories?: Address[];
     /**
      * Market configurators used in test/staging environments.
      **/

package/dist/types/sdk/constants/address-provider.d.ts

@@ -31,6 +31,7 @@ export declare const AP_WETH_GATEWAY = "WETH_GATEWAY";
 export declare const AP_WETH_TOKEN = "WETH_TOKEN";
 export declare const AP_ZAPPER_REGISTER = "ZAPPER_REGISTER";
 export declare const AP_ZERO_PRICE_FEED = "ZERO_PRICE_FEED";
+export declare const AP_KYC_COMPRESSOR = "GLOBAL::KYC_COMPRESSOR";
 /**
  * Default address provider address for v3.1.0
  * Is determenistic and does not depend on the network type

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

@@ -3,6 +3,7 @@ import type { MarketData, MarketFilter } from "../base/index.js";
 import type { GearboxSDK } from "../GearboxSDK.js";
 import type { MarketStateHuman } from "../types/index.js";
 import { AddressMap } from "../utils/index.js";
+import { type DelegatedMulticall } from "../utils/viem/index.js";
 import type { CreditSuite } from "./credit/index.js";
 import { MarketConfiguratorContract } from "./MarketConfiguratorContract.js";
 import { MarketSuite } from "./MarketSuite.js";
@@ -30,13 +31,13 @@ export declare class MarketRegister extends ZapperRegister {
      **/
     hydrate(state: MarketData[]): void;
     /**
-     * Fetches all markets from the on-chain for the given market configurators.
+     * @internal
+     * Returns delegated multicalls for loading all markets from the on-chain
+     * market compressor. Used by the SDK to compose batched RPC calls.
      *
-     * @param marketConfigurators - Addresses of market configurator contracts to query.
-     * @param ignoreUpdateablePrices - When `true`, skips generating off-chain
-     *   price updates before loading
+     * @param configurators - Addresses of market configurator contracts to query.
      **/
-    loadMarkets(marketConfigurators: Address[], ignoreUpdateablePrices?: boolean): Promise<void>;
+    getLoadMulticalls(configurators: Address[]): DelegatedMulticall[];
     /**
      * The active filter used to scope market compressor queries.
      * @throws If the register has not been hydrated or attached yet.
@@ -52,10 +53,6 @@ export declare class MarketRegister extends ZapperRegister {
      * @param ignoreUpdateablePrices - When `true`, skips off-chain price updates.
      **/
     syncState(ignoreUpdateablePrices?: boolean): Promise<void>;
-    /**
-     * Loads new prices and price feeds for given oracles from PriceFeedCompressor, defaults to all oracles
-     */
-    updatePrices(oracles?: Address[]): Promise<void>;
     get watchAddresses(): Set<Address>;
     /**
      * Serializable snapshot of all loaded markets, suitable for hydration.

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

@@ -4,6 +4,7 @@ import { SDKConstruct } from "../base/index.js";
 import type { GearboxSDK } from "../GearboxSDK.js";
 import type { MarketStateHuman } from "../types/index.js";
 import { CreditSuite } from "./credit/index.js";
+import type { IKYCFactory, OpenAccountRequirements } from "./kyc/types.js";
 import { type ILossPolicyContract } from "./loss-policy/index.js";
 import { MarketConfiguratorContract } from "./MarketConfiguratorContract.js";
 import type { IPriceOracleContract } from "./oracle/index.js";
@@ -22,6 +23,7 @@ export declare class MarketSuite extends SDKConstruct {
     readonly state: MarketData;
     constructor(sdk: GearboxSDK, marketData: MarketData);
     get underlying(): Address;
+    get kycFactory(): IKYCFactory<unknown, OpenAccountRequirements> | undefined;
     get dirty(): boolean;
     get watchAddresses(): Set<Address>;
     stateHuman(raw?: boolean): MarketStateHuman;

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

@@ -0,0 +1,31 @@
+import type { Address } from "abitype";
+import { SDKConstruct } from "../../base/index.js";
+import type { DelegatedMulticall } from "../../utils/viem/index.js";
+import { SecuritizeKYCFactory } from "./securitize/index.js";
+import type { InvestorData, KYCCompressorResponse, KYCState, KYCStateHuman } from "./types.js";
+export declare class KYCRegister extends SDKConstruct {
+    #private;
+    /**
+     * @internal
+     *
+     * Returns delegated multicalls for loading all KYC underlying tokens from the on-chain KYC compressor.
+     * Used by the SDK to compose batched RPC calls.
+     *
+     * @param configurators - Market configurators to query.
+     * @param kycFactories - KYC factory contracts to query.
+     * @returns
+     */
+    getLoadMulticalls(configurators: Address[], kycFactories?: Address[]): DelegatedMulticall[];
+    /**
+     * Returns the investor data for a given investor and optional list of factories.
+     * If no factories are provided, all factories will be used.
+     * @param investor
+     * @param factories_
+     * @returns
+     */
+    getInvestorData(investor: Address, factories_?: Address[]): Promise<InvestorData[]>;
+    get factories(): SecuritizeKYCFactory[];
+    get state(): KYCState | undefined;
+    stateHuman(raw?: boolean): KYCStateHuman;
+    setState(resp?: KYCCompressorResponse): void;
+}

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

@@ -0,0 +1,2 @@
+export * from "./KYCRegister.js";
+export * from "./types.js";