@gearbox-protocol/sdk 16.3.0-next.4 → 17.0.0-next.1

package/dist/types/onchain/market/rwa/types.d.ts

@@ -1,5 +1,5 @@
 import { iRWACompressorAbi } from "../../../abi/rwa/iRWACompressor.js";
-import { RWAFactoryType, RWAMissingOpenAccountRequirements, RWAOpenAccountRequirements, RWAOperationArgs, RWAProtocol, RWA_FACTORY_SECURITIZE } from "../../../model/rwa.js";
+import { KycProtocol, RWAFactoryType, RWAMissingOpenAccountRequirements, RWAOpenAccountRequirements, RWAOperationArgs, RWA_FACTORY_SECURITIZE } from "../../../model/rwa.js";
 import "../../../model/index.js";
 import { IBaseContract, Unarray } from "../../base/types.js";
 import { SecuritizeInvestorData, SecuritizeRWAFactoryStateHuman } from "./securitize/types.js";
@@ -19,15 +19,10 @@ import { AbiParametersToPrimitiveTypes, ExtractAbiFunction } from "abitype";
  **/
 interface RWAFactoryTypeMap {
   [RWA_FACTORY_SECURITIZE]: {
-    protocol: "securitize";
     investorData: SecuritizeInvestorData;
     stateHuman: SecuritizeRWAFactoryStateHuman;
   };
 }
-/**
- * {@link RWAProtocol} of the factory type `T`.
- **/
-type RWAFactoryProtocol<T extends RWAFactoryType> = RWAFactoryTypeMap[T]["protocol"];
 /**
  * Investor data decoded from the RWA compressor, defaults to union of all factory types
  * Can be discriminated by type
@@ -156,7 +151,26 @@ interface IRWAFactory<T extends RWAFactoryType = RWAFactoryType> extends IBaseCo
    * @param args - factory-specific args (e.g. tokens to register, signatures to cache).
    *   Undefined value means that no RWA actions are required
    **/
-  multicall(creditAccount: Address, calls: MultiCall[], args?: RWAOperationArgs<RWAFactoryProtocol<T>>): RawTx;
+  multicall(creditAccount: Address, calls: MultiCall[], args?: RWAOperationArgs<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<RWAOpenAccountRequirements<T> | undefined>;
+  /**
+   * Computes the subset of `requirements` still unfulfilled, given the
+   * factory-specific params already carried by the transaction calldata.
+   *
+   * @param requirements - requirements fetched via {@link getOpenAccountRequirements}
+   * @param providedArgs - params decoded from the transaction calldata, if
+   *   any; e.g. signatures already included there need not be signed again
+   * @returns the missing requirements, or `undefined` when everything is
+   *   satisfied
+   **/
+  getMissingRequirements(requirements: RWAOpenAccountRequirements<T>, providedArgs?: RWAOperationArgs<T>): RWAMissingOpenAccountRequirements<T> | undefined;
   /**
    * Creates a raw transaction to open a credit account.
    * Similar to {@link CreditFacadeV310Contract.openCreditAccount}.
@@ -166,41 +180,25 @@ interface IRWAFactory<T extends RWAFactoryType = RWAFactoryType> extends IBaseCo
    * @param args - factory-specific args (e.g. tokens to register, signatures to cache).
    * Undefined value means that no RWA actions are required (e.g. when we open second credit account)
    **/
-  openCreditAccount(creditManager: Address, calls: MultiCall[], args?: RWAOperationArgs<RWAFactoryProtocol<T>>): RawTx;
-  /**
-   * Degen NFT this factory deploys as the KYC gate. Midas has no factory;
-   * its NFT is loaded separately via {@link createDegenNFT}.
-   **/
-  readonly degenNFT: IDegenNFT<RWAFactoryProtocol<T>>;
+  openCreditAccount(creditManager: Address, calls: MultiCall[], args?: RWAOperationArgs<T>): RawTx;
 }
 /**
- * Degen NFT that gates credit-account opening behind an RWA KYC provider.
- **/
-interface IDegenNFT<P extends RWAProtocol = RWAProtocol> extends IBaseContract {
-  readonly protocol: P;
-  readonly registrationLink: string;
-  /**
-   * Tokens this gate is about: Securitize DS tokens, or the Midas mToken.
-   */
-  getTokens(): Promise<Address[]>;
-  /**
-   * What `wallet` still has to do before this gate lets it open on the
-   * strategy token in `props`.
-   */
-  getOpenAccountRequirements(wallet: Address, props: GetOpenAccountRequirementsProps): Promise<RWAOpenAccountRequirements<P>>;
-  /**
-   * Protocol-side KYC is done: registered at Securitize for every requested
-   * DS token, or greenlisted by Midas.
-   *
-   * User might still be required to do additional actions on Gearbox side,
-   * e.g. sign EIP-712 messages for Securitize
-   */
-  isRegistered(requirements: RWAOpenAccountRequirements<P>): boolean;
+ * Result of {@link IDegenNFT.checkKyc}.
+ */
+interface KycCheckResult {
+  eligible: boolean;
+  /** Token the wallet must be registered for. */
+  token: Address;
+}
+/**
+ * Degen NFT that gates credit-account opening behind a KYC provider.
+ */
+interface IDegenNFT extends IBaseContract {
+  readonly protocol: KycProtocol;
   /**
-   * Leftover Gearbox-tx work given `providedArgs` already on the calldata.
-   * Always `undefined` for Midas (no tx args).
+   * Same predicate the NFT's `burn` reverts on.
    */
-  getMissingRequirements(requirements: RWAOpenAccountRequirements<P>, providedArgs?: RWAOperationArgs<P>): RWAMissingOpenAccountRequirements<P> | undefined;
+  checkKyc(wallet: Address, targetCollateral: Address): Promise<KycCheckResult>;
 }
 /**
  * Narrows any contract to an {@link IRWAFactory}.
@@ -213,4 +211,4 @@ interface IDegenNFT<P extends RWAProtocol = RWAProtocol> extends IBaseContract {
  **/
 declare function isRWAFactory<T extends RWAFactoryType = RWAFactoryType>(contract: IBaseContract, type?: T): contract is IRWAFactory<T>;
 //#endregion
-export { GetInvestorOptions, GetOpenAccountRequirementsProps, IDegenNFT, IRWAFactory, RWACompressorCall, RWACompressorInvestorData, RWACompressorResponse, RWAFactoryData, RWAFactoryProtocol, RWAFactoryStateHuman, RWAInvestorData, RWAState, RWAStateHuman, RWAUnderlyingData, isRWAFactory };
+export { GetInvestorOptions, GetOpenAccountRequirementsProps, IDegenNFT, IRWAFactory, KycCheckResult, RWACompressorCall, RWACompressorInvestorData, RWACompressorResponse, RWAFactoryData, RWAFactoryStateHuman, RWAInvestorData, RWAState, RWAStateHuman, RWAUnderlyingData, isRWAFactory };

package/dist/types/onchain/opportunities/MultichainOpportunitiesService.d.ts

@@ -33,11 +33,7 @@ declare class MultichainOpportunitiesService<const Plugins extends PluginsMap =
    *
    * See {@link MultichainOpportunitiesService.getPool}.
    **/
-  getStrategy(key: StrategyOpportunityKey): Promise<DataResponse<StrategyOpportunityDetail>>;
-  /**
-   * {@inheritDoc OpportunitiesService.isEligibleForStrategy}
-   **/
-  isEligibleForStrategy(key: StrategyOpportunityKey, wallet: Address): Promise<boolean>;
+  getStrategy(key: StrategyOpportunityKey, wallet?: Address): Promise<DataResponse<StrategyOpportunityDetail>>;
 }
 //#endregion
 export { MultichainOpportunitiesService };

package/dist/types/onchain/opportunities/OpportunitiesService.d.ts

@@ -34,20 +34,13 @@ declare class OpportunitiesService extends SDKConstruct {
    * A single strategy opportunity plus the rate curve of the pool it borrows
    * from and the price feeds its liquidation price depends on.
    *
-   * `kyc` is the strategy's KYC gate, independent of any wallet.
+   * @param wallet - When given, `kyc` says whether this wallet must register
+   * with the strategy's KYC provider first; `null` otherwise.
    *
    * @throws If the credit manager is unknown, or does not currently offer a
    * strategy.
    **/
-  getStrategy(key: StrategyOpportunityKey): Promise<StrategyOpportunityDetail>;
-  /**
-   * Whether `wallet` may open this strategy today: `true` when it is not
-   * KYC-gated or the wallet already passed the gate.
-   *
-   * @throws If the credit manager is unknown, or does not currently offer a
-   * strategy.
-   **/
-  isEligibleForStrategy(key: StrategyOpportunityKey, wallet: Address): Promise<boolean>;
+  getStrategy(key: StrategyOpportunityKey, wallet?: Address): Promise<StrategyOpportunityDetail>;
 }
 //#endregion
 export { OpportunitiesService };

package/dist/types/onchain/opportunities/types.d.ts

@@ -22,12 +22,7 @@ interface IMultichainOpportunitiesService {
   /**
    * Detailed view of one strategy opportunity.
    **/
-  getStrategy(key: StrategyOpportunityKey): Promise<DataResponse<StrategyOpportunityDetail>>;
-  /**
-   * Whether `wallet` may open this strategy today. Throws when that chain
-   * cannot answer.
-   **/
-  isEligibleForStrategy(key: StrategyOpportunityKey, wallet: Address): Promise<boolean>;
+  getStrategy(key: StrategyOpportunityKey, wallet?: Address): Promise<DataResponse<StrategyOpportunityDetail>>;
 }
 //#endregion
 export { IMultichainOpportunitiesService };

package/dist/types/onchain/validation/bundles/checkRWAOpenRequirements.d.ts

@@ -10,10 +10,10 @@ interface CheckRWAOpenRequirementsInput {
   wallet: Address;
   creditManager: Address;
   token: Address;
-  providedArgs?: RWAOperationArgs;
+  providedArgs: RWAOperationArgs;
 }
 /**
- * The degen NFT is satisfied that `wallet` may open on `token` with the
+ * The RWA factory is satisfied that `wallet` may open on `token` with the
  * registration args already on the transaction.
  */
 declare function checkRWAOpenRequirements(input: CheckRWAOpenRequirementsInput): Promise<(RWAOpenRequirementsError | UnexpectedFailureError)[]>;

package/dist/types/onchain/validation/bundles/checkRWAOpening.d.ts

@@ -1,17 +1,17 @@
 import { RWAOpenRequirementsError } from "../../../model/errors/operation-errors.js";
 import { UnexpectedFailureError } from "../../../model/errors/prepare-errors.js";
-import { OpenStrategyPositionPreview } from "../../../model/previews.js";
+import { OpenRWAStrategyPositionPreview } from "../../../model/previews.js";
 import "../../../model/index.js";
 import { OnchainSDK } from "../../OnchainSDK.js";
 import { Address } from "viem";
 //#region src/onchain/validation/bundles/checkRWAOpening.d.ts
 interface CheckRWAOpeningInput {
   sdk: OnchainSDK;
-  preview: OpenStrategyPositionPreview;
+  preview: OpenRWAStrategyPositionPreview;
   sender: Address;
 }
 /**
- * Per KYC-gated token among `collateralAdded ∪ quotas`, whether the
+ * Per factory-gated token among `collateralAdded ∪ quotas`, whether the
  * borrower still has to register or sign before this opening can land.
  */
 declare function checkRWAOpening(input: CheckRWAOpeningInput): Promise<(RWAOpenRequirementsError | UnexpectedFailureError)[]>;

package/dist/types/onchain/validation/checkSimulation.d.ts

@@ -3,14 +3,13 @@ import { DebtOutOfRangeError, InsufficientCollateralError, QuotaCountExceededErr
 import "../../model/index.js";
 import { OnchainSDK } from "../OnchainSDK.js";
 import { OperationState } from "../accounts/intents/types.js";
-import { OpenStrategyState } from "../accounts/intents/open-strategy.js";
 import { HealthFactorThresholds } from "./bundles/checkHealthFactors.js";
 import { MarketStateError } from "./bundles/checkMarket.js";
 //#region src/onchain/validation/checkSimulation.d.ts
 /** A simulated credit operation, as the intents engine reports one. */
 interface CreditSimulationInput {
   chainId: ChainId;
-  state: OperationState | OpenStrategyState;
+  state: OperationState;
 }
 type CheckSimulationInput = CreditSimulationInput;
 /** {@inheritDoc checkSimulation} */
@@ -35,10 +34,8 @@ type SimulationValidationError = MarketStateError | DebtOutOfRangeError | QuotaC
  * touched. The engine performed all three during the walk, so a simulation that
  * came back `ok` has already passed them.
  *
- * A credit account only, opened or adjusted: a pool operation has no account
- * to weigh, and the three things its own state decides are read by `prepare`
- * before it answers. An opening names its quotas `averageQuota` — the branch
- * the planner already weighed it as.
+ * A credit account only: a pool operation has no account to weigh, and the
+ * three things its own state decides are read by `prepare` before it answers.
  */
 declare function checkSimulation(sdk: OnchainSDK, input: CheckSimulationInput, options?: HealthFactorThresholds): SimulationValidationError[];
 //#endregion

package/dist/types/onchain/validation/checks/checkDebtLimits.d.ts

@@ -1,8 +1,6 @@
 import { Token } from "../../../model/primitives.js";
 import { DebtOutOfRangeError } from "../../../model/errors/operation-errors.js";
 import "../../../model/index.js";
-import { MaxBorrowAmount } from "../../market/credit/types.js";
-import "../../market/index.js";
 //#region src/onchain/validation/checks/checkDebtLimits.d.ts
 interface DebtLimitsArgs {
   debt: bigint;
@@ -16,8 +14,6 @@ interface DebtLimitsArgs {
    * rather than assumed.
    */
   allowZero: boolean;
-  /** From the caller's suite; a caller that raises to throw advises nobody. */
-  maxBorrowAmount?: MaxBorrowAmount;
 }
 /** A debt the facade would revert on. */
 declare function checkDebtLimits(args: DebtLimitsArgs): DebtOutOfRangeError[];

package/dist/types/sdk/opportunities/OpportunitiesNamespace.d.ts

@@ -47,11 +47,7 @@ declare class OpportunitiesNamespace extends AbstractNamespace<MultichainSDK["op
   /**
    * {@inheritDoc IOpportunitiesBase.getStrategy}
    **/
-  getStrategy(key: StrategyOpportunityKey): Promise<DataResponse<StrategyOpportunityDetail>>;
-  /**
-   * {@inheritDoc IOpportunitiesOnchainOnly.isEligibleForStrategy}
-   **/
-  isEligibleForStrategy(key: StrategyOpportunityKey, wallet: Address): Promise<boolean>;
+  getStrategy(key: StrategyOpportunityKey, wallet?: Address): Promise<DataResponse<StrategyOpportunityDetail>>;
   /**
    * {@inheritDoc IOpportunitiesBase.filter}
    **/

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

@@ -30,11 +30,10 @@ interface IOpportunitiesBase {
    **/
   getPool(key: PoolOpportunityKey): Promise<DataResponse<PoolOpportunityDetail>>;
   /**
-   * Detailed view of one strategy opportunity. `kyc` is the strategy's KYC
-   * gate, independent of any wallet. Use {@link IOpportunitiesOnchainOnly.isEligibleForStrategy}
-   * for a wallet verdict.
+   * Detailed view of one strategy opportunity. With `wallet`, `kyc` tells whether
+   * that wallet must register with the strategy's KYC provider before opening.
    **/
-  getStrategy(key: StrategyOpportunityKey): Promise<DataResponse<StrategyOpportunityDetail>>;
+  getStrategy(key: StrategyOpportunityKey, wallet?: Address): Promise<DataResponse<StrategyOpportunityDetail>>;
   /**
    * Narrows an already-read list, rows and metadata alike. `undefined` passes
    * through, so a read still in flight stays that way, and a list already read
@@ -89,11 +88,6 @@ interface IOpportunitiesOnchainOnly {
    * same reason as {@link prepare}: it encodes against live chain state.
    **/
   readonly execute: IOpportunitiesExecute;
-  /**
-   * Whether `wallet` may open this strategy today: `true` when it is not
-   * KYC-gated or the wallet already passed the gate. Chain-only.
-   **/
-  isEligibleForStrategy(key: StrategyOpportunityKey, wallet: Address): Promise<boolean>;
 }
 /**
  * The chain on its own, for a consumer that shows each source as it arrives.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/sdk",
-  "version": "16.3.0-next.4",
+  "version": "17.0.0-next.1",
   "description": "Gearbox SDK",
   "license": "MIT",
   "repository": {