@gearbox-protocol/sdk 14.12.0-next.2 → 14.12.0-next.4

package/dist/types/preview/parse/types.d.ts

@@ -2,9 +2,11 @@ import type { AdaptersPlugin } from "../../plugins/adapters/index.js";
 import type { OnchainSDK, PluginsMap } from "../../sdk/index.js";
 import type { OuterFacadeOperation } from "./types-facades.js";
 import type { PoolOperation } from "./types-pools.js";
+import type { RWAOperation } from "./types-rwa.js";
 export * from "./types-adapters.js";
 export * from "./types-facades.js";
 export * from "./types-pools.js";
+export * from "./types-rwa.js";
 /**
  * True when the plugin map `P` contains the {@link AdaptersPlugin} under any
  * key. Matched nominally (the plugin's private fields make it non-structural),
@@ -29,16 +31,19 @@ export type RequireAdaptersPlugin<P extends PluginsMap> = HasAdaptersPlugin<P> e
  */
 export type SdkWithAdapters<P extends PluginsMap = PluginsMap> = OnchainSDK<P> & RequireAdaptersPlugin<P>;
 /**
- * Result of decoding a single raw operation calldata: either a pool
- * deposit/redeem or one of the credit-facade operations.
- *
- * Calldata-only parse produces base (descriptor) adapter operations, so the
- * facade operations are used with the default `Ext = {}`.
+ * Result of decoding a single raw operation calldata: a pool deposit/redeem,
+ * one of the credit-facade operations, or an RWA-factory operation.
  */
-export type Operation = PoolOperation | OuterFacadeOperation;
+export type Operation = PoolOperation | OuterFacadeOperation | RWAOperation;
 /**
  * Narrows an {@link Operation} to a {@link PoolOperation} (deposit, mint,
  * withdraw or redeem). Used by the UI to decide whether a custom view exists for
  * the parsed result; everything else falls back to the raw JSON view.
  */
 export declare function isPoolOperation(tx: Operation): tx is PoolOperation;
+/**
+ * Narrows an {@link Operation} to an {@link RWAOperation} (an RWA-factory
+ * open-account or multicall). Used to route parsed operations to the
+ * RWA-specific simulation path.
+ */
+export declare function isRWAOperation(tx: Operation): tx is RWAOperation;

package/dist/types/preview/prerequisites/AllowancePrerequisite.d.ts

@@ -11,9 +11,7 @@ export interface AllowancePrerequisiteProps {
 }
 /** Checks that `owner` granted `spender` an ERC-20 allowance >= `required`. */
 export declare class AllowancePrerequisite extends Prerequisite<"allowance"> {
-    private readonly _id;
-    private readonly _title;
-    private readonly _detail;
+    #private;
     constructor(props: AllowancePrerequisiteProps);
     get id(): string;
     get kind(): "allowance";

package/dist/types/preview/prerequisites/BalancePrerequisite.d.ts

@@ -10,9 +10,7 @@ export interface BalancePrerequisiteProps {
 }
 /** Checks that `owner` holds an ERC-20 balance >= `required`. */
 export declare class BalancePrerequisite extends Prerequisite<"balance"> {
-    private readonly _id;
-    private readonly _title;
-    private readonly _detail;
+    #private;
     constructor(props: BalancePrerequisiteProps);
     get id(): string;
     get kind(): "balance";

package/dist/types/preview/prerequisites/RWAOpenRequirementsPrerequisite.d.ts

@@ -0,0 +1,36 @@
+import type { Address, ContractFunctionParameters } from "viem";
+import type { RWAOpenAccountRequirements } from "../../sdk/index.js";
+import { Prerequisite } from "./Prerequisite.js";
+import type { PrerequisiteDetail, PrerequisiteResult } from "./types.js";
+export interface RWAOpenRequirementsPrerequisiteProps {
+    /** Requirements already resolved via `sdk.accounts.getOpenAccountRequirements`. */
+    requirements: RWAOpenAccountRequirements;
+    /** RWA token (e.g. Securitize DSToken) the requirements were computed for. */
+    token: Address;
+    /** RWA factory that produced the requirements. */
+    factory: Address;
+    title?: string;
+    id?: string;
+}
+/**
+ * Checks that the borrower has fulfilled the RWA factory's open-account
+ * requirements (issuer-side token registration, EIP-712 signatures).
+ *
+ * Unlike `allowance`/`balance`, the requirements cannot be derived from plain
+ * ERC-20 multicall reads: they come from an async compressor read performed by
+ * `sdk.accounts.getOpenAccountRequirements`. The prerequisite is therefore
+ * *pre-resolved*: it is constructed with the requirements already computed,
+ * contributes no calls to the verification multicall, and `resolve` only
+ * interprets the stored payload.
+ */
+export declare class RWAOpenRequirementsPrerequisite extends Prerequisite<"rwaOpenRequirements"> {
+    #private;
+    constructor(props: RWAOpenRequirementsPrerequisiteProps);
+    get id(): string;
+    get kind(): "rwaOpenRequirements";
+    get title(): string;
+    get detail(): PrerequisiteDetail<"rwaOpenRequirements">;
+    /** Pre-resolved: no on-chain reads to contribute. */
+    calls(): ContractFunctionParameters[];
+    resolve(): PrerequisiteResult<"rwaOpenRequirements">;
+}

package/dist/types/preview/prerequisites/buildPrerequisites.d.ts

@@ -13,4 +13,4 @@ import type { PrerequisiteContext } from "./types.js";
  * bot permissions) is intentionally out of scope, since the user cannot
  * resolve it. New {@link AnyPrerequisite} subclasses must follow the same rule.
  */
-export declare function buildPrerequisites(tx: Operation, ctx: PrerequisiteContext): AnyPrerequisite[];
+export declare function buildPrerequisites(tx: Operation, ctx: PrerequisiteContext): Promise<AnyPrerequisite[]>;

package/dist/types/preview/prerequisites/index.d.ts

@@ -3,5 +3,6 @@ export * from "./BalancePrerequisite.js";
 export * from "./buildPrerequisites.js";
 export * from "./Prerequisite.js";
 export * from "./prepareAction.js";
+export * from "./RWAOpenRequirementsPrerequisite.js";
 export * from "./runPrerequisites.js";
 export * from "./types.js";

package/dist/types/preview/prerequisites/types.d.ts

@@ -1,18 +1,14 @@
 import type { Address } from "viem";
-import type { OnchainSDK } from "../../sdk/index.js";
+import type { OnchainSDK, RWAOpenAccountRequirements } from "../../sdk/index.js";
 /**
  * Extension point that ties each prerequisite kind to its detail payload.
  *
- * Adding a new prerequisite kind only requires a new entry here: the generic
- * machinery below and the UI renderer registry both key off this map, so TS
- * forces every consumer to handle the new kind.
- *
  * IMPORTANT: only add prerequisites that are *actionable by the transaction
  * sender* (the LP provider or borrower). A valid prerequisite is one the user
  * can resolve themselves before retrying, e.g. approve a token (`allowance`)
- * or acquire/free up funds (`balance`). Do NOT add protocol- or admin-level
- * state the user cannot change, such as pool pause status or available pool
- * liquidity; those are not actionable and must not be listed as prerequisites.
+ * or perform offchain KYC verification.
+ *
+ * Do NOT add protocol- or admin-level state the user cannot change.
  */
 export interface PrerequisiteDetailMap {
     /** ERC-20 allowance from `owner` to `spender` must cover `required`. */
@@ -32,6 +28,12 @@ export interface PrerequisiteDetailMap {
         /** On-chain balance read; only present when the read succeeded. */
         actual?: bigint;
     };
+    /**
+     * RWA (e.g. Securitize) open-account requirements: off-chain token
+     * registration and/or EIP-712 signatures the borrower must provide before
+     * opening a credit account in an RWA market.
+     */
+    rwaOpenRequirements: RWAOpenAccountRequirements;
 }
 export type PrerequisiteKind = keyof PrerequisiteDetailMap;
 export type PrerequisiteDetail<K extends PrerequisiteKind = PrerequisiteKind> = PrerequisiteDetailMap[K];

package/dist/types/preview/simulate/index.d.ts

@@ -5,4 +5,6 @@ export { simulateFacadeOperation } from "./simulateFacadeOperation.js";
 export type { SimulateOperationInput } from "./simulateOperation.js";
 export { simulateOperation } from "./simulateOperation.js";
 export { simulatePoolOperation } from "./simulatePoolOperation.js";
+export type { SimulateRWAOperationInput } from "./simulateRWAOperation.js";
+export { simulateRWAOperation } from "./simulateRWAOperation.js";
 export type { AddressBalanceChanges, OperationSimulationOptions, PoolOperationSimulation, PoolOperationSimulationInput, PoolOperationSimulationResult, TokenBalanceChange, } from "./types.js";

package/dist/types/preview/simulate/simulateRWAOperation.d.ts

@@ -0,0 +1,25 @@
+import type { Address, Hex } from "viem";
+import type { OnchainSDK } from "../../sdk/index.js";
+import type { RWAOperation } from "../parse/index.js";
+import type { OperationSimulationOptions, PoolOperationSimulation } from "./types.js";
+export interface SimulateRWAOperationInput {
+    /** Only `client`/`networkType` are used, so any OnchainSDK works. */
+    sdk: OnchainSDK;
+    /** Parsed RWA-factory operation to simulate. */
+    operation: RWAOperation;
+    /** Target contract the calldata is sent to (the RWA factory). */
+    to: Address;
+    /** Raw RWA-factory calldata to simulate. */
+    calldata: Hex;
+    /** Wallet whose balance changes and transfers we track. */
+    wallet: Address;
+}
+/**
+ * Simulates an RWA-factory operation.
+ *
+ * Not yet implemented: like credit-facade simulation, it requires
+ * multicall-aware balance/transfer accounting that the pool simulation does
+ * not cover. The signature mirrors {@link simulatePoolOperation} so the
+ * {@link simulateOperation} wrapper can delegate uniformly once implemented.
+ */
+export declare function simulateRWAOperation(_input: SimulateRWAOperationInput, _options?: OperationSimulationOptions): Promise<PoolOperationSimulation>;

package/dist/types/sdk/market/rwa/securitize/SecuritizeRWAFactory.d.ts

@@ -1,4 +1,4 @@
-import { type Address } from "viem";
+import { type Address, type DecodeFunctionDataReturnType } from "viem";
 import type { GetOpenAccountRequirementsProps } from "../../../accounts/types.js";
 import { BaseContract } from "../../../base/index.js";
 import type { OnchainSDK } from "../../../OnchainSDK.js";
@@ -463,10 +463,15 @@ export declare class SecuritizeRWAFactory extends BaseContract<abi> implements I
     readonly dsTokens: DStokenData[];
     readonly contractType = "RWA_FACTORY::SECURITIZE";
     constructor(sdk: OnchainSDK, data: RWAFactoryData);
+    protected parseFunctionParamsV2(params: DecodeFunctionDataReturnType<abi>, strict?: boolean): Record<string, unknown>;
     /**
      * {@inheritDoc IRWAFactory.decodeInvestorData}
      */
     decodeInvestorData(data: RWACompressorInvestorData): SecuritizeInvestorData;
+    /**
+     * {@inheritDoc IRWAFactory.getTokens}
+     */
+    getTokens(): Address[];
     /**
      * {@inheritDoc IRWAFactory.getInvestor}
      */

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

@@ -102,6 +102,12 @@ export interface IRWAFactory<T extends RWAFactoryType = RWAFactoryType> extends
      * @param data - raw RWACompressor InvestorData
      **/
     decodeInvestorData(data: RWACompressorInvestorData): RWAInvestorData<T>;
+    /**
+     * Returns the RWA token addresses this factory can register/gate
+     * (e.g. Securitize DSTokens). Named for parity with the Solidity
+     * `IRWAFactory` contract.
+     **/
+    getTokens(): Address[];
     /**
      * Returns the investor address for a credit account.
      * @param creditAccount - credit account address
@@ -161,11 +167,13 @@ export interface IRWAFactory<T extends RWAFactoryType = RWAFactoryType> extends
     openCreditAccount(creditManager: Address, calls: MultiCall[], options?: RWAOperationParams<T>): RawTx;
 }
 /**
- * Narrows an {@link IRWAFactory} to a specific factory type.
+ * Narrows any contract to an {@link IRWAFactory}.
  *
- * @param factory - factory instance to check
- * @param type - expected factory type literal
- * @returns `true` if `factory.factoryType === type`
+ * @param contract - contract instance to check
+ * @param type - optional expected factory type literal. When provided, narrows
+ *   to the concrete `IRWAFactory<T>`; when omitted, narrows to the
+ *   generalized {@link IRWAFactory}
+ * @returns `true` if the contract is an RWA factory (of the given type, if provided)
  **/
-export declare function isRWAFactory<T extends RWAFactoryType>(factory: IRWAFactory, type: T): factory is IRWAFactory<T>;
+export declare function isRWAFactory<T extends RWAFactoryType = RWAFactoryType>(contract: IBaseContract, type?: T): contract is IRWAFactory<T>;
 export {};

package/package.json

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