@gearbox-protocol/sdk 14.0.0 → 14.1.0

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

@@ -0,0 +1,171 @@
+import type { AbiParametersToPrimitiveTypes, ExtractAbiFunction } from "abitype";
+import type { Address, ContractFunctionParameters } from "viem";
+import type { iKYCCompressorAbi } from "../../../abi/kyc/iKYCCompressor.js";
+import type { GetOpenAccountRequirementsProps } from "../../accounts/types.js";
+import type { IBaseContract, Unarray } from "../../base/index.js";
+import type { MultiCall, RawTx } from "../../types/index.js";
+import type { SecuritizeInvestorData, SecuritizeKYCFactoryStateHuman, SecuritizeOpenAccountRequirements, SecuritizeOperationParams } from "./securitize/index.js";
+import { KYC_FACTORY_SECURITIZE } from "./securitize/index.js";
+/**
+ * Discriminated union of all known KYC factory contract type strings.
+ **/
+export declare const KYC_FACTORY_TYPES: readonly ["KYC_FACTORY::SECURITIZE"];
+/**
+ * String literal union of known KYC factory types.
+ **/
+export type KYCFactoryType = (typeof KYC_FACTORY_TYPES)[number];
+/**
+ * @internal
+ *
+ * Type-level registry mapping each {@link KYCFactoryType} to its associated
+ * data types. Adding a new KYC factory requires a single new entry here;
+ * all derived types update automatically.
+ **/
+interface KYCFactoryTypeMap {
+    [KYC_FACTORY_SECURITIZE]: {
+        investorData: SecuritizeInvestorData;
+        openAccountRequirements: SecuritizeOpenAccountRequirements;
+        stateHuman: SecuritizeKYCFactoryStateHuman;
+        operationParams: SecuritizeOperationParams;
+    };
+}
+/**
+ * Investor data decoded from the KYC compressor, defaults to union of all factory types
+ * Can be discriminated by type
+ **/
+export type KYCInvestorData<T extends KYCFactoryType = KYCFactoryType> = KYCFactoryTypeMap[T]["investorData"];
+/**
+ * Open-account requirements for a KYC factory, defaults to union of all factory types
+ * Can be discriminated by type
+ **/
+export type KYCOpenAccountRequirements<T extends KYCFactoryType = KYCFactoryType> = KYCFactoryTypeMap[T]["openAccountRequirements"];
+/**
+ * Open credit account/Multicall extra params type for a KYC factory, defaults to union of all factory types
+ * Can be discriminated by type
+ **/
+export type KYCOperationParams<T extends KYCFactoryType = KYCFactoryType> = KYCFactoryTypeMap[T]["operationParams"];
+/**
+ * Raw return type of `KYCCompressor.getKYCMarketsData`.
+ **/
+export type KYCCompressorResponse = AbiParametersToPrimitiveTypes<ExtractAbiFunction<typeof iKYCCompressorAbi, "getKYCMarketsData">["outputs"]>;
+/**
+ * On-chain state of a KYC underlying token.
+ **/
+export type KYCUnderlyingData = Unarray<KYCCompressorResponse[0]>;
+/**
+ * On-chain state of a KYC factory.
+ **/
+export type KYCFactoryData = Unarray<KYCCompressorResponse[1]>;
+/**
+ * Typed contract call parameters for `KYCCompressor.getKYCMarketsData`.
+ **/
+export type KYCCompressorCall = ContractFunctionParameters<typeof iKYCCompressorAbi, "view", "getKYCMarketsData">;
+/**
+ * Single element of the `KYCCompressor.getKYCInvestorData` return array.
+ * Contains per-factory credit accounts and factory-specific extra details.
+ **/
+export type KYCCompressorInvestorData = Unarray<AbiParametersToPrimitiveTypes<ExtractAbiFunction<typeof iKYCCompressorAbi, "getKYCInvestorData">["outputs"]>[0]>;
+/**
+ * Full KYC compressor response, used as the persisted/hydrated state.
+ **/
+export type KYCState = KYCCompressorResponse;
+/**
+ * Human-readable KYC factory state, union of all factory types.
+ **/
+export type KYCFactoryStateHuman = KYCFactoryTypeMap[KYCFactoryType]["stateHuman"];
+/**
+ * Human-readable snapshot of the full KYC registry state.
+ **/
+export interface KYCStateHuman {
+    /** State of each loaded KYC factory. */
+    factories: KYCFactoryStateHuman[];
+}
+/**
+ * Shared interface for all KYC factory contracts.
+ *
+ * Parameterised by a single factory type literal `T` which indexes into
+ * {@link KYCFactoryTypeMap} to derive all associated data types.
+ *
+ * @typeParam T - factory type
+ **/
+export interface IKYCFactory<T extends KYCFactoryType = KYCFactoryType> extends IBaseContract {
+    /**
+     * Narrowed factory type discriminant
+     **/
+    readonly contractType: T;
+    /**
+     * @internal
+     *
+     * Decodes factory-specific extra details from the compressor's investor data.
+     * Each factory knows how to decode its own extra details.
+     *
+     * @param data - raw KYCCompressor InvestorData
+     **/
+    decodeInvestorData(data: KYCCompressorInvestorData): KYCInvestorData<T>;
+    /**
+     * Returns the investor address for a credit account.
+     * @param creditAccount - credit account address
+     * @param fromCache - if true, use and update an in-memory cache
+     *   (creditAccount → investor). On cache miss, loads from contract and
+     *   stores the result for future calls.
+     **/
+    getInvestor(creditAccount: Address, fromCache?: boolean): Promise<Address>;
+    /**
+     *  Returns address to which approval should be given on collateral token
+     *
+     * @param options - either `{ creditManager, creditAccount }` for an
+     *   existing account or `{ creditManager, borrower }` for a new one
+     **/
+    getApprovalAddress(options: {
+        creditManager: Address;
+        borrower: Address;
+    } | {
+        creditManager: Address;
+        creditAccount: Address;
+    }): Promise<Address>;
+    /**
+     * Returns the wallet address for a credit account.
+     * Wallet is a smart contract that owns the credit account, and
+     * it is different from the investor address (actual user).
+     * @param creditAccount - credit account address
+     **/
+    getWallet(creditAccount: Address): Promise<Address>;
+    /**
+     * Creates a raw transaction to perform operations on a credit account.
+     * Similar to {@link CreditFacadeV310Contract.multicall}.
+     *
+     * @param creditAccount - credit account address
+     * @param calls - calls to perform
+     * @param options - factory-specific parameters (e.g. tokens to
+     *   register, signatures to cache). Undefined value means that no KYC actions are required
+     **/
+    multicall(creditAccount: Address, calls: MultiCall[], options?: KYCOperationParams<T>): RawTx;
+    /**
+     * Checks if the user can open a credit account with this factory.
+     * @param investor - investor address
+     * @param props - {@link GetOpenAccountRequirementsProps}
+     * @returns open account requirements for the investor, or `undefined` if the
+     *   user can open a credit account without any further actions
+     **/
+    getOpenAccountRequirements(investor: Address, props: GetOpenAccountRequirementsProps): Promise<KYCOpenAccountRequirements<T> | undefined>;
+    /**
+     * Creates a raw transaction to open a credit account.
+     * Similar to {@link CreditFacadeV310Contract.openCreditAccount}.
+     *
+     * @param creditManager - credit manager address
+     * @param calls - initial calls to perform
+     * @param options - factory-specific parameters (e.g. tokens to
+     *   register, signatures to cache).
+     * Undefined value means that no KYC actions are required (e.g. when we open second credit account)
+     **/
+    openCreditAccount(creditManager: Address, calls: MultiCall[], options?: KYCOperationParams<T>): RawTx;
+}
+/**
+ * Narrows an {@link IKYCFactory} to a specific factory type.
+ *
+ * @param factory - factory instance to check
+ * @param type - expected factory type literal
+ * @returns `true` if `factory.factoryType === type`
+ **/
+export declare function isKYCFactory<T extends KYCFactoryType>(factory: IKYCFactory, type: T): factory is IKYCFactory<T>;
+export {};

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

@@ -5,10 +5,11 @@ import { BaseContract } from "../../base/index.js";
 import type { OnchainSDK } from "../../OnchainSDK.js";
 import type { PriceOracleStateHuman } from "../../types/index.js";
 import { AddressMap } from "../../utils/index.js";
+import type { DelegatedMulticall } from "../../utils/viem/index.js";
 import type { IPriceFeedContract, UpdatePriceFeedsResult } from "../pricefeeds/index.js";
 import { PriceFeedRef } from "../pricefeeds/index.js";
 import PriceFeedAnswerMap from "./PriceFeedAnswerMap.js";
-import type { DelegatedOracleMulticall, IPriceOracleContract, OnDemandPriceUpdates, PriceFeedsForTokensOptions } from "./types.js";
+import type { IPriceOracleContract, OnDemandPriceUpdates, PriceFeedsForTokensOptions } from "./types.js";
 /**
  * Base implementation of the Gearbox price oracle.
  *
@@ -74,7 +75,7 @@ export declare abstract class PriceOracleBaseContract<abi extends Abi | readonly
     /**
      * {@inheritDoc IPriceOracleContract.syncStateMulticall}
      **/
-    syncStateMulticall(): DelegatedOracleMulticall;
+    syncStateMulticall(): DelegatedMulticall;
     /**
      * {@inheritDoc IPriceOracleContract.watchAddresses}
      **/

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

@@ -1,8 +1,8 @@
-import type { Address, ContractFunctionParameters, ContractFunctionReturnType } from "viem";
-import type { priceFeedCompressorAbi } from "../../../abi/compressors/priceFeedCompressor.js";
+import type { Address } from "viem";
 import type { IBaseContract } from "../../base/index.js";
 import type { MultiCall, PriceOracleStateHuman } from "../../types/index.js";
 import type { AddressMap } from "../../utils/index.js";
+import type { DelegatedMulticall } from "../../utils/viem/index.js";
 import type { IPriceFeedContract, PriceFeedRef, PriceUpdate, UpdatePriceFeedsResult } from "../pricefeeds/index.js";
 import type PriceFeedAnswerMap from "./PriceFeedAnswerMap.js";
 /**
@@ -71,7 +71,7 @@ export interface IPriceOracleContract extends IBaseContract {
     /**
      * @internal
      **/
-    syncStateMulticall: () => DelegatedOracleMulticall;
+    syncStateMulticall: () => DelegatedMulticall;
     /**
      * Checks whether the given price feed address appears anywhere in this
      * oracle's feed tree (including as a dependency of a composite feed,
@@ -124,10 +124,3 @@ export interface IPriceOracleContract extends IBaseContract {
      **/
     stateHuman: (raw?: boolean) => PriceOracleStateHuman;
 }
-/**
- * @internal
- **/
-export interface DelegatedOracleMulticall {
-    call: ContractFunctionParameters<typeof priceFeedCompressorAbi, "view", "getPriceOracleState">;
-    onResult: (resp: ContractFunctionReturnType<typeof priceFeedCompressorAbi, "view", "getPriceOracleState">) => void;
-}

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

@@ -3,6 +3,7 @@ import type { MarketData } from "../../base/index.js";
 import { SDKConstruct } from "../../base/index.js";
 import type { OnchainSDK } from "../../OnchainSDK.js";
 import type { PoolSuiteStateHuman } from "../../types/index.js";
+import type { IKYCFactory } from "../kyc/types.js";
 import type { MarketConfiguratorContract } from "../MarketConfiguratorContract.js";
 import { GaugeContract } from "./GaugeContract.js";
 import { LinearInterestRateModelContract } from "./LinearInterestRateModelContract.js";
@@ -20,6 +21,7 @@ export declare class PoolSuite extends SDKConstruct {
     get linearModel(): LinearInterestRateModelContract;
     get marketConfigurator(): MarketConfiguratorContract;
     get underlying(): Address;
+    get kycFactory(): IKYCFactory | 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 { OnchainSDK } from "../../OnchainSDK.js";
 import type { PoolStateHuman } from "../../types/index.js";
 import { AddressMap } from "../../utils/index.js";
+import type { IKYCFactory } from "../kyc/types.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: OnchainSDK, data: PoolState);
+    get kycFactory(): IKYCFactory | undefined;
     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,4 +1,5 @@
 export * from "./GaugeContract.js";
 export * from "./LinearInterestRateModelContract.js";
 export * from "./PoolSuite.js";
+export * from "./PoolV310Contract.js";
 export * from "./types.js";

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

@@ -152,7 +152,7 @@ export declare class PriceFeedRegister extends SDKConstruct implements IHooks<Pr
      * Loads PARTIAL information about all updatable price feeds from MarketCompressor
      * Discovered price feeds are not saved anywhere in PriceFeedRegister, and can later be used to load price feed updates
      */
-    getPartialUpdatablePriceFeeds(configurators: Address[], pools?: Address[]): Promise<IPriceFeedContract[]>;
+    getPartialUpdatablePriceFeeds(configurators: Address[]): Promise<IPriceFeedContract[]>;
     /**
      * Instantiates the appropriate price feed contract wrapper based on
      * the `contractType` discriminator in the node's base params.

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

@@ -5,6 +5,6 @@ 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" | "base";
+    type: "migration" | "kyc" | "base";
 }
 export {};

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

@@ -16,6 +16,7 @@ export declare const OnchainSDKOptionsSchema: z.ZodObject<{
 export declare const AttachOptionsSchema: z.ZodObject<{
     addressProvider: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>>;
     marketConfigurators: z.ZodOptional<z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>>>;
+    kycFactories: z.ZodOptional<z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>>>;
     blockNumber: z.ZodOptional<z.ZodUnion<readonly [z.ZodBigInt, z.ZodNumber]>>;
     ignoreUpdateablePrices: z.ZodOptional<z.ZodBoolean>;
     ignoreMarkets: z.ZodOptional<z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>>>;

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

@@ -4,35 +4,35 @@ import type { AddLiquidityProps, DepositMetadata, IPoolsService, PoolServiceCall
 export declare class PoolService extends SDKConstruct implements IPoolsService {
     #private;
     /**
-     * @inheritdoc IPoolsService.getDepositTokensIn
+     * {@inheritDoc IPoolsService.getDepositTokensIn}
      */
     getDepositTokensIn(pool: Address): Address[];
     /**
-     * @inheritdoc IPoolsService.getDepositTokensOut
+     * {@inheritDoc IPoolsService.getDepositTokensOut}
      */
     getDepositTokensOut(pool: Address, tokenIn: Address): Address[];
     /**
-     * @inheritdoc IPoolsService.getDepositMetadata
+     * {@inheritDoc IPoolsService.getDepositMetadata}
      */
     getDepositMetadata(pool: Address, tokenIn: Address, tokenOut?: Address): DepositMetadata;
     /**
-     * @inheritdoc IPoolsService.addLiquidity
+     * {@inheritDoc IPoolsService.addLiquidity}
      */
     addLiquidity(props: AddLiquidityProps): PoolServiceCall | undefined;
     /**
-     * @inheritdoc IPoolsService.getWithdrawalTokensIn
+     * {@inheritDoc IPoolsService.getWithdrawalTokensIn}
      */
     getWithdrawalTokensIn(pool: Address): Address[];
     /**
-     * @inheritdoc IPoolsService.getWithdrawalTokensOut
+     * {@inheritDoc IPoolsService.getWithdrawalTokensOut}
      */
     getWithdrawalTokensOut(pool: Address, tokenIn: Address): Address[];
     /**
-     * @inheritdoc IPoolsService.removeLiquidity
+     * {@inheritDoc IPoolsService.removeLiquidity}
      */
     removeLiquidity(props: RemoveLiquidityProps): PoolServiceCall;
     /**
-     * @inheritdoc IPoolsService.getWithdrawalMetadata
+     * {@inheritDoc IPoolsService.getWithdrawalMetadata}
      */
     getWithdrawalMetadata(pool: Address, tokenIn: Address, tokenOut?: Address): WithdrawalMetadata;
 }

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

@@ -52,7 +52,7 @@ export interface RemoveLiquidityProps {
     permit: PermitResult | undefined;
     meta: WithdrawalMetadata;
 }
-export type MarketType = "classic";
+export type MarketType = "kyc-on-demand" | "kyc-default" | "classic";
 export interface DepositMetadata {
     /**
      * Zapper that will perform the deposit, undefined in case of direct pool underlying deposit

package/dist/types/sdk/types/state-human.d.ts

@@ -1,6 +1,7 @@
 import type { Address } from "viem";
 import type { TokenMetaData } from "../base/index.js";
 import type { PriceFeedContractType } from "../market/index.js";
+import type { KYCStateHuman } from "../market/kyc/index.js";
 export interface BaseContractStateHuman {
     address: string;
     version: number;
@@ -200,6 +201,7 @@ export interface GearboxStateHuman {
     markets: MarketStateHuman[];
     plugins: Record<string, unknown>;
     tokens: TokenMetaData[];
+    kyc: KYCStateHuman;
 }
 /**
  * Human-readable state for all chains managed by {@link MultichainSDK}.

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

@@ -1,6 +1,7 @@
 import type { MarketData } from "../base/index.js";
 import type { NetworkType } from "../chain/chains.js";
 import type { AddressProviderState } from "../core/index.js";
+import type { KYCState } from "../market/kyc/index.js";
 import type { PluginStatesMap, PluginsMap } from "../plugins/index.js";
 /**
  * Complete serialisable snapshot of the SDK state for a single chain.
@@ -40,6 +41,10 @@ export interface GearboxState<Plugins extends PluginsMap = {}> {
      * All loaded market data.
      **/
     markets: MarketData[];
+    /**
+     * KYC compressor state snapshot, if KYC factories were loaded.
+     **/
+    kyc?: KYCState;
     /**
      * Per-plugin serialised state.
      **/

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

@@ -0,0 +1,28 @@
+import type { Chain, Client, ContractFunctionParameters, Transport } from "viem";
+import type { IPriceUpdateTx } from "../../types/index.js";
+/**
+ * A contract call paired with a callback that receives its decoded result.
+ * Used to compose batched on-chain reads that are executed together inside a
+ * single {@link simulateWithPriceUpdates} call.
+ **/
+export interface DelegatedMulticall {
+    /** Contract call parameters (ABI, address, function name, args). */
+    call: ContractFunctionParameters;
+    /** Callback invoked with the decoded return value after simulation. */
+    onResult: (resp: unknown) => void;
+}
+/**
+ * Executes multiple contract read calls in a single
+ * {@link simulateWithPriceUpdates} batch and dispatches each result to its
+ * corresponding {@link DelegatedMulticall.onResult} callback.
+ *
+ * @param client - Viem public client.
+ * @param multicalls - Calls to execute with their result handlers.
+ * @param opts - Price-update transactions, target block number, and optional
+ *   gas limit forwarded to the simulation.
+ **/
+export declare function executeDelegatedMulticalls(client: Client<Transport, Chain>, multicalls: DelegatedMulticall[], opts: {
+    priceUpdates: IPriceUpdateTx[];
+    blockNumber: bigint;
+    gas?: bigint;
+}): Promise<void>;

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

@@ -1,4 +1,5 @@
 export * from "./cast.js";
+export * from "./executeDelegatedMulticalls.js";
 export * from "./sendRawTx.js";
 export * from "./simulateMulticall.js";
 export * from "./simulateWithPriceUpdates.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/sdk",
-  "version": "14.0.0",
+  "version": "14.1.0",
   "description": "Gearbox SDK",
   "license": "MIT",
   "main": "./dist/cjs/sdk/index.js",

package/dist/esm/sdk/accounts/utils.js

@@ -1,14 +0,0 @@
-function stringifyGetCreditAccountsArgs(args) {
-  const s = JSON.stringify(args, replacer);
-  return JSON.parse(s);
-}
-function replacer(_key, value) {
-  if (typeof value === "bigint") {
-    return value.toString();
-  } else {
-    return value;
-  }
-}
-export {
-  stringifyGetCreditAccountsArgs
-};

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

@@ -1,2 +0,0 @@
-import type { GetCreditAccountsArgs } from "./types.js";
-export declare function stringifyGetCreditAccountsArgs(args: GetCreditAccountsArgs): Record<any, any>;