@gearbox-protocol/sdk 14.0.0 → 14.1.0

package/dist/types/abi/kyc/iSecuritizeKYCFactory.d.ts

@@ -0,0 +1,376 @@
+export declare const iSecuritizeKYCFactoryAbi: readonly [{
+    readonly type: "function";
+    readonly name: "contractType";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bytes32";
+        readonly internalType: "bytes32";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getCreditAccounts";
+    readonly inputs: readonly [{
+        readonly name: "investor";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address[]";
+        readonly internalType: "address[]";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getDegenNFT";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getInvestor";
+    readonly inputs: readonly [{
+        readonly name: "creditAccount";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getTokens";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address[]";
+        readonly internalType: "address[]";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getWallet";
+    readonly inputs: readonly [{
+        readonly name: "creditAccount";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "isCreditAccount";
+    readonly inputs: readonly [{
+        readonly name: "creditAccount";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+        readonly internalType: "bool";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "isFrozen";
+    readonly inputs: readonly [{
+        readonly name: "creditAccount";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+        readonly internalType: "bool";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "multicall";
+    readonly inputs: readonly [{
+        readonly name: "creditAccount";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "calls";
+        readonly type: "tuple[]";
+        readonly internalType: "struct MultiCall[]";
+        readonly components: readonly [{
+            readonly name: "target";
+            readonly type: "address";
+            readonly internalType: "address";
+        }, {
+            readonly name: "callData";
+            readonly type: "bytes";
+            readonly internalType: "bytes";
+        }];
+    }, {
+        readonly name: "tokensToRegister";
+        readonly type: "address[]";
+        readonly internalType: "address[]";
+    }, {
+        readonly name: "signaturesToCache";
+        readonly type: "tuple[]";
+        readonly internalType: "struct ISecuritizeDegenNFT.RegisterMessage[]";
+        readonly components: readonly [{
+            readonly name: "token";
+            readonly type: "address";
+            readonly internalType: "address";
+        }, {
+            readonly name: "signature";
+            readonly type: "tuple";
+            readonly internalType: "struct ISecuritizeDegenNFT.Signature";
+            readonly components: readonly [{
+                readonly name: "deadline";
+                readonly type: "uint256";
+                readonly internalType: "uint256";
+            }, {
+                readonly name: "signature";
+                readonly type: "bytes";
+                readonly internalType: "bytes";
+            }];
+        }];
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "openCreditAccount";
+    readonly inputs: readonly [{
+        readonly name: "creditManager";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "calls";
+        readonly type: "tuple[]";
+        readonly internalType: "struct MultiCall[]";
+        readonly components: readonly [{
+            readonly name: "target";
+            readonly type: "address";
+            readonly internalType: "address";
+        }, {
+            readonly name: "callData";
+            readonly type: "bytes";
+            readonly internalType: "bytes";
+        }];
+    }, {
+        readonly name: "tokensToRegister";
+        readonly type: "address[]";
+        readonly internalType: "address[]";
+    }, {
+        readonly name: "signaturesToCache";
+        readonly type: "tuple[]";
+        readonly internalType: "struct ISecuritizeDegenNFT.RegisterMessage[]";
+        readonly components: readonly [{
+            readonly name: "token";
+            readonly type: "address";
+            readonly internalType: "address";
+        }, {
+            readonly name: "signature";
+            readonly type: "tuple";
+            readonly internalType: "struct ISecuritizeDegenNFT.Signature";
+            readonly components: readonly [{
+                readonly name: "deadline";
+                readonly type: "uint256";
+                readonly internalType: "uint256";
+            }, {
+                readonly name: "signature";
+                readonly type: "bytes";
+                readonly internalType: "bytes";
+            }];
+        }];
+    }];
+    readonly outputs: readonly [{
+        readonly name: "creditAccount";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "wallet";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "precomputeWalletAddress";
+    readonly inputs: readonly [{
+        readonly name: "creditManager";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "investor";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "serialize";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "serializedData";
+        readonly type: "bytes";
+        readonly internalType: "bytes";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "setFrozenStatus";
+    readonly inputs: readonly [{
+        readonly name: "creditAccount";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "frozen";
+        readonly type: "bool";
+        readonly internalType: "bool";
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "setInvestor";
+    readonly inputs: readonly [{
+        readonly name: "creditAccount";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "investor";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "version";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "event";
+    readonly name: "CreateWallet";
+    readonly inputs: readonly [{
+        readonly name: "creditAccount";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }, {
+        readonly name: "wallet";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }, {
+        readonly name: "investor";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }];
+    readonly anonymous: false;
+}, {
+    readonly type: "event";
+    readonly name: "SetFrozenStatus";
+    readonly inputs: readonly [{
+        readonly name: "creditAccount";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }, {
+        readonly name: "frozen";
+        readonly type: "bool";
+        readonly indexed: false;
+        readonly internalType: "bool";
+    }];
+    readonly anonymous: false;
+}, {
+    readonly type: "event";
+    readonly name: "SetInvestor";
+    readonly inputs: readonly [{
+        readonly name: "creditAccount";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }, {
+        readonly name: "oldInvestor";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }, {
+        readonly name: "newInvestor";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }];
+    readonly anonymous: false;
+}, {
+    readonly type: "error";
+    readonly name: "CallerIsNotInvestorException";
+    readonly inputs: readonly [{
+        readonly name: "caller";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "creditAccount";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "FrozenCreditAccountException";
+    readonly inputs: readonly [{
+        readonly name: "creditAccount";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "InvalidCreditManagerException";
+    readonly inputs: readonly [{
+        readonly name: "creditManager";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "InvalidUnderlyingTokenException";
+    readonly inputs: readonly [{
+        readonly name: "underlying";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "UnknownCreditAccountException";
+    readonly inputs: readonly [{
+        readonly name: "creditAccount";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "ZeroAddressException";
+    readonly inputs: readonly [];
+}];

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

@@ -6,6 +6,7 @@ import { ChainContractsRegister } from "./base/index.js";
 import type { GearboxChain, NetworkType } from "./chain/chains.js";
 import type { VersionRange } from "./constants/index.js";
 import type { IAddressProviderContract } from "./core/index.js";
+import { KYCRegistry } from "./market/index.js";
 import { MarketRegister } from "./market/MarketRegister.js";
 import { PriceFeedRegister } from "./market/pricefeeds/index.js";
 import type { PythOptions, RedstoneOptions } from "./market/pricefeeds/updates/index.js";
@@ -90,6 +91,10 @@ export interface AttachOptions {
      * Addresses of market configurator contracts to load.
      **/
     marketConfigurators?: Address[];
+    /**
+     * Addresses of KYC factory contracts to load.
+     **/
+    kycFactories?: Address[];
     /**
      * Pin SDK to a specific block number during attach.
      **/
@@ -246,9 +251,22 @@ export declare class OnchainSDK<const Plugins extends PluginsMap = {}> extends C
      */
     get marketRegister(): MarketRegister;
     /**
+     * KYC register for KYC-wrapped underlying tokens and factories.
+     *
+     * @throws If the SDK has not been attached or hydrated yet.
+     **/
+    get kyc(): KYCRegistry;
+    /**
+     * @internal
      * Resolves the appropriate router contract for a given credit manager,
      * credit facade, or explicit version range.
-     */
+     *
+     * @param params - Identifies the context: a credit manager address/state,
+     *   a credit facade address/state, or a {@link VersionRange}.
+     * @returns The matching router contract instance.
+     * @throws If the credit facade version is unsupported or no router is
+     *   registered for the resolved version range.
+     **/
     routerFor(params: {
         creditManager: Address | BaseState | IBaseContract;
     } | {

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

@@ -1,12 +1,13 @@
 import type { Address } from "viem";
 import type { CreditAccountData } from "../base/index.js";
 import { SDKConstruct } from "../base/index.js";
-import type { CreditSuite } from "../market/index.js";
+import type { CreditSuite, KYCOperationParams } from "../market/index.js";
 import { type PriceUpdate, type UpdatePriceFeedsResult } from "../market/index.js";
+import { type KYCOpenAccountRequirements } from "../market/kyc/index.js";
 import type { OnchainSDK } from "../OnchainSDK.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, CloseOptions, CreditAccountOperationResult, CreditAccountTokensSlice, ExecuteSwapProps, FullyLiquidateProps, FullyLiquidateResult, GetConnectedBotsResult, GetConnectedMigrationBotsResult, GetCreditAccountsOptions, GetPendingWithdrawalsProps, GetPendingWithdrawalsResult, OpenCAProps, PermitResult, PrepareUpdateQuotasProps, PreviewDelayedWithdrawalProps, PreviewDelayedWithdrawalResult, Rewards, StartDelayedWithdrawalProps, UpdateQuotasProps } from "./types.js";
+import type { AccountToCheck, AddCollateralProps, ChangeDeptProps, ClaimDelayedProps, CloseCreditAccountProps, CloseCreditAccountResult, CloseOptions, CreditAccountOperationResult, CreditAccountTokensSlice, ExecuteSwapProps, FullyLiquidateProps, FullyLiquidateResult, GetApprovalAddressProps, GetConnectedBotsResult, GetConnectedMigrationBotsResult, GetCreditAccountsOptions, GetOpenAccountRequirementsProps, GetPendingWithdrawalsProps, GetPendingWithdrawalsResult, OpenCAProps, PermitResult, PrepareUpdateQuotasProps, PreviewDelayedWithdrawalProps, PreviewDelayedWithdrawalResult, Rewards, StartDelayedWithdrawalProps, UpdateQuotasProps } from "./types.js";
 /**
  * Options for configuring the credit account service.
  **/
@@ -32,11 +33,15 @@ export declare abstract class AbstractCreditAccountService extends SDKConstruct
     /**
      * {@inheritDoc ICreditAccountsService.getCreditAccountData}
      **/
-    getCreditAccountData(account: Address, blockNumber?: bigint): Promise<CreditAccountData | undefined>;
+    getCreditAccountData(account: Address, blockNumber?: bigint): Promise<CreditAccountData<true> | undefined>;
     /**
      * {@inheritDoc ICreditAccountsService.getCreditAccounts}
      **/
     getCreditAccounts(options?: GetCreditAccountsOptions, blockNumber?: bigint): Promise<Array<CreditAccountData>>;
+    /**
+     * {@inheritDoc ICreditAccountsService.getBorrowerCreditAccounts}
+     **/
+    getBorrowerCreditAccounts(borrower: Address, options?: GetCreditAccountsOptions, blockNumber?: bigint): Promise<Array<CreditAccountData<true>>>;
     /**
      * {@inheritDoc ICreditAccountsService.getRewards}
      **/
@@ -89,6 +94,14 @@ export declare abstract class AbstractCreditAccountService extends SDKConstruct
      * {@inheritDoc ICreditAccountsService.claimDelayed}
      **/
     claimDelayed({ creditAccount, minQuota, averageQuota, claimableNow, }: ClaimDelayedProps): Promise<CreditAccountOperationResult>;
+    /**
+     * {@inheritDoc ICreditAccountsService.getApprovalAddress}
+     **/
+    getApprovalAddress(options: GetApprovalAddressProps): Promise<Address>;
+    /**
+     * {@inheritDoc ICreditAccountsService.getOpenAccountRequirements}
+     */
+    getOpenAccountRequirements(borrower: Address, creditManager: Address, props: GetOpenAccountRequirementsProps): Promise<KYCOpenAccountRequirements | undefined>;
     /**
      * {@inheritDoc ICreditAccountsService.openCA}
      **/
@@ -102,6 +115,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[]>;
@@ -150,24 +200,27 @@ export declare abstract class AbstractCreditAccountService extends SDKConstruct
      * @param to
      * @param calls
      * @param referralCode
+     * @param kycOptions
      * @returns
      */
-    protected openCreditAccountTx(suite: CreditSuite, to: Address, calls: MultiCall[], referralCode?: bigint): Promise<RawTx>;
+    protected openCreditAccountTx(suite: CreditSuite, to: Address, calls: MultiCall[], referralCode?: bigint, kycOptions?: KYCOperationParams): Promise<RawTx>;
     /**
      * Wrapper that selects between credit facade and KYC factory
      * @param suite
      * @param creditAccount
      * @param calls
+     * @param kycOptions
      * @returns
      */
-    protected multicallTx(suite: CreditSuite, creditAccount: Address, calls: MultiCall[]): Promise<RawTx>;
+    protected multicallTx(suite: CreditSuite, creditAccount: Address, calls: MultiCall[], kycOptions?: KYCOperationParams): Promise<RawTx>;
     /**
      * Wrapper that selects between credit facade and KYC factory
      * @param suite
      * @param creditAccount
      * @param calls
      * @param operation
+     * @param kycOptions
      * @returns
      */
-    protected closeCreditAccountTx(suite: CreditSuite, creditAccount: Address, calls: MultiCall[], operation: CloseOptions): Promise<RawTx>;
+    protected closeCreditAccountTx(suite: CreditSuite, creditAccount: Address, calls: MultiCall[], operation: CloseOptions, kycOptions?: KYCOperationParams): Promise<RawTx>;
 }

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}
      */