@gearbox-protocol/sdk 14.12.0-next.3 → 14.12.0-next.5

package/dist/esm/preview/parse/parseFacadeOperationCalldata.js

@@ -1,6 +1,5 @@
 import { isAddressEqual, zeroAddress } from "viem";
 import { classifyInnerOperations } from "./classifyInnerOperations.js";
-import { extractExpectedBalanceChanges } from "./extractExpectedBalanceChanges.js";
 function parseFacadeOperationCalldata(props) {
   const { sdk, facade, calldata } = props;
   const parsed = sdk.parseFunctionDataV2(facade.address, calldata);
@@ -21,23 +20,20 @@ function parseFacadeOperationCalldata(props) {
     sdk,
     underlying: suite.underlying
   });
-  const expectedBalanceChanges = extractExpectedBalanceChanges(innerCalls);
   switch (functionName) {
     case "multicall":
       return {
         ...metadata,
         operation: "MultiCall",
         creditAccount: rawArgs.creditAccount,
-        multicall,
-        expectedBalanceChanges
+        multicall
       };
     case "botMulticall":
       return {
         ...metadata,
         operation: "BotMulticall",
         creditAccount: rawArgs.creditAccount,
-        multicall,
-        expectedBalanceChanges
+        multicall
       };
     case "openCreditAccount":
       return {
@@ -46,16 +42,14 @@ function parseFacadeOperationCalldata(props) {
         creditAccount: zeroAddress,
         onBehalfOf: rawArgs.onBehalfOf,
         referralCode: rawArgs.referralCode,
-        multicall,
-        expectedBalanceChanges
+        multicall
       };
     case "closeCreditAccount":
       return {
         ...metadata,
         operation: "CloseCreditAccount",
         creditAccount: rawArgs.creditAccount,
-        multicall,
-        expectedBalanceChanges
+        multicall
       };
     case "liquidateCreditAccount":
       return {
@@ -67,8 +61,7 @@ function parseFacadeOperationCalldata(props) {
         // liquidation, so they are not recoverable from raw calldata.
         token: zeroAddress,
         remainingFunds: 0n,
-        multicall,
-        expectedBalanceChanges
+        multicall
       };
     case "partiallyLiquidateCreditAccount":
       return {

package/dist/esm/preview/parse/parseOperationCalldata.js

@@ -1,7 +1,7 @@
 import {
   CreditFacadeV310Contract,
+  isRWAFactory,
   PoolV310Contract,
-  SecuritizeRWAFactory,
   ZapperContract
 } from "../../sdk/index.js";
 import { UnsupportedTargetError } from "./errors.js";
@@ -23,7 +23,8 @@ function parseOperationCalldata(input) {
         receiver: parsed.receiver,
         assets: parsed.assets,
         underlying: parsed.underlying,
-        tokenIn: parsed.token,
+        tokenIn: contract.tokenIn.addr,
+        tokenOut: contract.tokenOut.addr,
         zapper: parsed.zapper,
         referralCode: parsed.referralCode
       };
@@ -33,12 +34,13 @@ function parseOperationCalldata(input) {
       operation: "Redeem",
       pool: parsed.pool,
       receiver: parsed.receiver,
-      // The zapper burns the caller's pool shares, so the share owner is the
+      // The zapper burns the caller's share tokens, so the share owner is the
       // transaction sender.
       owner: sender,
       shares: parsed.shares,
       underlying: parsed.underlying,
-      tokenOut: parsed.token,
+      tokenIn: contract.tokenOut.addr,
+      tokenOut: contract.tokenIn.addr,
       zapper: parsed.zapper
     };
     return op;
@@ -50,7 +52,7 @@ function parseOperationCalldata(input) {
       calldata
     });
   }
-  if (contract instanceof SecuritizeRWAFactory) {
+  if (contract && isRWAFactory(contract)) {
     return parseRWAFactoryOperationCalldata({
       sdk,
       factory: contract,

package/dist/esm/preview/parse/parsePoolOperationCalldata.js

@@ -15,6 +15,7 @@ function parsePoolOperationCalldata(props) {
         assets: rawArgs.assets,
         underlying,
         tokenIn: underlying,
+        tokenOut: pool.address,
         zapper: void 0,
         referralCode: functionName === "depositWithReferral" ? rawArgs.referralCode : void 0
       };
@@ -27,6 +28,7 @@ function parsePoolOperationCalldata(props) {
         shares: rawArgs.shares,
         underlying,
         tokenIn: underlying,
+        tokenOut: pool.address,
         zapper: void 0,
         referralCode: functionName === "mintWithReferral" ? rawArgs.referralCode : void 0
       };
@@ -38,6 +40,7 @@ function parsePoolOperationCalldata(props) {
         owner: rawArgs.owner,
         assets: rawArgs.assets,
         underlying,
+        tokenIn: pool.address,
         tokenOut: underlying,
         zapper: void 0
       };
@@ -49,6 +52,7 @@ function parsePoolOperationCalldata(props) {
         owner: rawArgs.owner,
         shares: rawArgs.shares,
         underlying,
+        tokenIn: pool.address,
         tokenOut: underlying,
         zapper: void 0
       };

package/dist/esm/preview/parse/parseRWAFactoryOperationCalldata.js

@@ -1,19 +1,35 @@
-import { zeroAddress } from "viem";
 import { AbstractAdapterContract } from "../../plugins/adapters/index.js";
 import {
   CreditFacadeV310Contract,
-  hexEq
+  hexEq,
+  isRWAFactory,
+  RWA_FACTORY_SECURITIZE
 } from "../../sdk/index.js";
 import { classifyInnerOperations } from "./classifyInnerOperations.js";
-import { extractExpectedBalanceChanges } from "./extractExpectedBalanceChanges.js";
 function parseRWAFactoryOperationCalldata(props) {
+  const { contractType, address } = props.factory;
+  if (isRWAFactory(props.factory, RWA_FACTORY_SECURITIZE)) {
+    return parseSecuritizeOperationCalldata(props);
+  }
+  throw new Error(
+    `unsupported RWA factory type "${contractType}" on ${address}`
+  );
+}
+function parseSecuritizeOperationCalldata(props) {
   const { sdk, factory, calldata } = props;
   const parsed = sdk.parseFunctionDataV2(factory.address, calldata);
   const functionName = parsed.functionName.split("(")[0];
   const { rawArgs } = parsed;
   const innerCalls = rawArgs.calls ?? [];
+  const tokensToRegister = [
+    ...rawArgs.tokensToRegister ?? []
+  ];
+  const signaturesToCache = [
+    ...rawArgs.signaturesToCache ?? []
+  ];
   const suite = functionName === "openCreditAccount" ? sdk.marketRegister.findCreditManager(rawArgs.creditManager) : resolveSuiteForMulticall(sdk, factory, innerCalls);
   const metadata = {
+    factory: factory.address,
     creditManager: suite.creditManager.address,
     creditFacade: suite.creditFacade.address
   };
@@ -21,25 +37,23 @@ function parseRWAFactoryOperationCalldata(props) {
     sdk,
     underlying: suite.underlying
   });
-  const expectedBalanceChanges = extractExpectedBalanceChanges(innerCalls);
   switch (functionName) {
     case "openCreditAccount":
       return {
         ...metadata,
-        operation: "OpenCreditAccount",
-        creditAccount: zeroAddress,
-        onBehalfOf: zeroAddress,
-        referralCode: 0n,
+        operation: "SecuritizeOpenCreditAccount",
         multicall,
-        expectedBalanceChanges
+        tokensToRegister,
+        signaturesToCache
       };
     case "multicall":
       return {
         ...metadata,
-        operation: "MultiCall",
+        operation: "SecuritizeMulticall",
         creditAccount: rawArgs.creditAccount,
         multicall,
-        expectedBalanceChanges
+        tokensToRegister,
+        signaturesToCache
       };
     default:
       throw new Error(

package/dist/esm/preview/parse/types.js

@@ -1,9 +1,14 @@
 export * from "./types-adapters.js";
 export * from "./types-facades.js";
 export * from "./types-pools.js";
+export * from "./types-rwa.js";
 function isPoolOperation(tx) {
   return tx.operation === "Deposit" || tx.operation === "Mint" || tx.operation === "Withdraw" || tx.operation === "Redeem";
 }
+function isRWAOperation(tx) {
+  return tx.operation === "SecuritizeOpenCreditAccount" || tx.operation === "SecuritizeMulticall";
+}
 export {
-  isPoolOperation
+  isPoolOperation,
+  isRWAOperation
 };

package/dist/esm/preview/prerequisites/AllowancePrerequisite.js

@@ -4,14 +4,14 @@ import {
   toPrerequisiteError
 } from "./Prerequisite.js";
 class AllowancePrerequisite extends Prerequisite {
-  _id;
-  _title;
-  _detail;
+  #id;
+  #title;
+  #detail;
   constructor(props) {
     super();
-    this._id = props.id ?? `allowance:${props.token}:${props.owner}:${props.spender}`;
-    this._title = props.title ?? "Token approval";
-    this._detail = {
+    this.#id = props.id ?? `allowance:${props.token}:${props.owner}:${props.spender}`;
+    this.#title = props.title ?? "Token approval";
+    this.#detail = {
       token: props.token,
       owner: props.owner,
       spender: props.spender,
@@ -19,24 +19,24 @@ class AllowancePrerequisite extends Prerequisite {
     };
   }
   get id() {
-    return this._id;
+    return this.#id;
   }
   get kind() {
     return "allowance";
   }
   get title() {
-    return this._title;
+    return this.#title;
   }
   get detail() {
-    return this._detail;
+    return this.#detail;
   }
   calls() {
     return [
       {
-        address: this._detail.token,
+        address: this.#detail.token,
         abi: erc20Abi,
         functionName: "allowance",
-        args: [this._detail.owner, this._detail.spender]
+        args: [this.#detail.owner, this.#detail.spender]
       }
     ];
   }
@@ -46,8 +46,8 @@ class AllowancePrerequisite extends Prerequisite {
       return this.errorResult(toPrerequisiteError(res?.error));
     }
     const actual = res.result;
-    return this.satisfiedResult(actual >= this._detail.required, {
-      ...this._detail,
+    return this.satisfiedResult(actual >= this.#detail.required, {
+      ...this.#detail,
       actual
     });
   }

package/dist/esm/preview/prerequisites/BalancePrerequisite.js

@@ -1,41 +1,59 @@
 import { erc20Abi } from "viem";
+import { iMulticall3Abi } from "../../abi/iMulticall3.js";
+import { hexEq, NATIVE_ADDRESS } from "../../sdk/index.js";
 import {
   Prerequisite,
   toPrerequisiteError
 } from "./Prerequisite.js";
 class BalancePrerequisite extends Prerequisite {
-  _id;
-  _title;
-  _detail;
+  #id;
+  #title;
+  #detail;
   constructor(props) {
     super();
-    this._id = props.id ?? `balance:${props.token}:${props.owner}`;
-    this._title = props.title ?? "Sufficient balance";
-    this._detail = {
+    this.#id = props.id ?? `balance:${props.token}:${props.owner}`;
+    this.#title = props.title ?? "Sufficient balance";
+    this.#detail = {
       token: props.token,
       owner: props.owner,
       required: props.required
     };
   }
   get id() {
-    return this._id;
+    return this.#id;
   }
   get kind() {
     return "balance";
   }
   get title() {
-    return this._title;
+    return this.#title;
   }
   get detail() {
-    return this._detail;
+    return this.#detail;
   }
-  calls() {
+  calls(ctx) {
+    if (hexEq(this.#detail.token, NATIVE_ADDRESS)) {
+      const multicall3 = ctx.sdk.client.chain.contracts?.multicall3?.address;
+      if (!multicall3) {
+        throw new Error(
+          "multicall3 is not configured for this chain, cannot read native balance"
+        );
+      }
+      return [
+        {
+          address: multicall3,
+          abi: iMulticall3Abi,
+          functionName: "getEthBalance",
+          args: [this.#detail.owner]
+        }
+      ];
+    }
     return [
       {
-        address: this._detail.token,
+        address: this.#detail.token,
         abi: erc20Abi,
         functionName: "balanceOf",
-        args: [this._detail.owner]
+        args: [this.#detail.owner]
       }
     ];
   }
@@ -45,8 +63,8 @@ class BalancePrerequisite extends Prerequisite {
       return this.errorResult(toPrerequisiteError(res?.error));
     }
     const actual = res.result;
-    return this.satisfiedResult(actual >= this._detail.required, {
-      ...this._detail,
+    return this.satisfiedResult(actual >= this.#detail.required, {
+      ...this.#detail,
       actual
     });
   }

package/dist/esm/preview/prerequisites/RWAOpenRequirementsPrerequisite.js

@@ -0,0 +1,42 @@
+import { Prerequisite } from "./Prerequisite.js";
+class RWAOpenRequirementsPrerequisite extends Prerequisite {
+  #id;
+  #title;
+  #detail;
+  constructor(props) {
+    super();
+    this.#id = props.id ?? `rwaOpenRequirements:${props.factory}:${props.token}`;
+    this.#title = props.title ?? "RWA account requirements fulfilled";
+    this.#detail = props.requirements;
+  }
+  get id() {
+    return this.#id;
+  }
+  get kind() {
+    return "rwaOpenRequirements";
+  }
+  get title() {
+    return this.#title;
+  }
+  get detail() {
+    return this.#detail;
+  }
+  /** Pre-resolved: no on-chain reads to contribute. */
+  calls() {
+    return [];
+  }
+  resolve() {
+    return this.satisfiedResult(this.#satisfied(), this.#detail);
+  }
+  /**
+   * Satisfied when the borrower has nothing left to do: no tokens pending
+   * issuer-side registration and no messages left to sign.
+   */
+  #satisfied() {
+    const { securitizeTokensToRegister, requiredSignatures } = this.#detail;
+    return securitizeTokensToRegister.length === 0 && requiredSignatures.length === 0;
+  }
+}
+export {
+  RWAOpenRequirementsPrerequisite
+};

package/dist/esm/preview/prerequisites/buildPrerequisites.js

@@ -1,8 +1,18 @@
 import { isAddressEqual } from "viem";
+import {
+  AddressSet,
+  NATIVE_ADDRESS
+} from "../../sdk/index.js";
+import {
+  parseOperationCalldata
+} from "../parse/parseOperationCalldata.js";
 import { AllowancePrerequisite } from "./AllowancePrerequisite.js";
 import { BalancePrerequisite } from "./BalancePrerequisite.js";
-async function buildPrerequisites(tx, ctx) {
-  const { wallet } = ctx;
+import { RWAOpenRequirementsPrerequisite } from "./RWAOpenRequirementsPrerequisite.js";
+async function buildPrerequisites(input) {
+  const { sdk, sender: wallet, blockNumber } = input;
+  const tx = parseOperationCalldata(input);
+  const ctx = { sdk, wallet, blockNumber };
   switch (tx.operation) {
     // Deposit and Mint both pull the underlying from the caller into the pool;
     // they only differ in which side (assets vs shares) the caller specifies.
@@ -12,21 +22,27 @@ async function buildPrerequisites(tx, ctx) {
     // not knowable from calldata alone).
     case "Deposit":
       if (tx.zapper) {
-        return [
-          new AllowancePrerequisite({
-            token: tx.tokenIn,
-            owner: wallet,
-            spender: tx.zapper,
-            required: tx.assets,
-            title: "Token approved to zapper"
-          }),
+        const prereqs = [];
+        if (!isAddressEqual(tx.tokenIn, NATIVE_ADDRESS)) {
+          prereqs.push(
+            new AllowancePrerequisite({
+              token: tx.tokenIn,
+              owner: wallet,
+              spender: tx.zapper,
+              required: tx.assets,
+              title: "Token approved to zapper"
+            })
+          );
+        }
+        prereqs.push(
           new BalancePrerequisite({
             token: tx.tokenIn,
             owner: wallet,
             required: tx.assets,
             title: "Sufficient token balance"
           })
-        ];
+        );
+        return prereqs;
       }
       return [
         new AllowancePrerequisite({
@@ -65,17 +81,17 @@ async function buildPrerequisites(tx, ctx) {
       if (tx.zapper) {
         return [
           new BalancePrerequisite({
-            token: tx.pool,
+            token: tx.tokenIn,
             owner: wallet,
             required: tx.shares,
-            title: "Sufficient LP token balance"
+            title: "Sufficient share token balance"
           }),
           new AllowancePrerequisite({
-            token: tx.pool,
+            token: tx.tokenIn,
             owner: wallet,
             spender: tx.zapper,
             required: tx.shares,
-            title: "LP token approved to zapper"
+            title: "Share token approved to zapper"
           })
         ];
       }
@@ -128,10 +144,34 @@ async function buildPrerequisites(tx, ctx) {
     case "CloseCreditAccount":
     case "LiquidateCreditAccount":
       return collateralPrerequisites(
-        tx.operation,
+        tx.operation === "OpenCreditAccount" ? { creditManager: tx.creditManager, borrower: wallet } : {
+          creditManager: tx.creditManager,
+          creditAccount: tx.creditAccount
+        },
+        tx.multicall,
+        ctx
+      );
+    // RWA-factory operations: same collateral checks as facade operations,
+    // plus (for opening) the factory's open-account requirements. The parsed
+    // operation carries template (empty) `tokensToRegister`/`signaturesToCache`;
+    // the prerequisite detail provides the real values.
+    case "SecuritizeOpenCreditAccount":
+      return [
+        ...await collateralPrerequisites(
+          { creditManager: tx.creditManager, borrower: wallet },
+          tx.multicall,
+          ctx
+        ),
+        ...await rwaOpenRequirementsPrerequisites(
+          tx.multicall,
+          tx.creditManager,
+          ctx
+        )
+      ];
+    case "SecuritizeMulticall":
+      return collateralPrerequisites(
+        { creditManager: tx.creditManager, creditAccount: tx.creditAccount },
         tx.multicall,
-        tx.creditManager,
-        tx.creditAccount,
         ctx
       );
     case "PartiallyLiquidateCreditAccount": {
@@ -159,26 +199,24 @@ async function buildPrerequisites(tx, ctx) {
       return [];
   }
 }
-async function collateralPrerequisites(op, multicall, creditManager, creditAccount, ctx) {
+async function collateralPrerequisites(spenderOptions, multicall, ctx) {
   const { sdk, wallet } = ctx;
   const required = /* @__PURE__ */ new Map();
-  for (const op2 of multicall) {
-    if (op2.operation !== "AddCollateral" || op2.amount === 0n) {
+  for (const op of multicall) {
+    if (op.operation !== "AddCollateral" || op.amount === 0n) {
       continue;
     }
-    const key = op2.token.toLowerCase();
+    const key = op.token.toLowerCase();
     const existing = required.get(key);
     required.set(key, {
-      token: op2.token,
-      amount: (existing?.amount ?? 0n) + op2.amount
+      token: op.token,
+      amount: (existing?.amount ?? 0n) + op.amount
     });
   }
   if (required.size === 0) {
     return [];
   }
-  const spender = await sdk.accounts.getApprovalAddress(
-    op === "OpenCreditAccount" ? { creditManager, borrower: wallet } : { creditManager, creditAccount }
-  );
+  const spender = await sdk.accounts.getApprovalAddress(spenderOptions);
   const prereqs = [];
   for (const { token, amount } of required.values()) {
     prereqs.push(
@@ -199,6 +237,41 @@ async function collateralPrerequisites(op, multicall, creditManager, creditAccou
   }
   return prereqs;
 }
+async function rwaOpenRequirementsPrerequisites(multicall, creditManager, ctx) {
+  const { sdk, wallet } = ctx;
+  const { rwaFactory } = sdk.marketRegister.findByCreditManager(creditManager);
+  if (!rwaFactory) {
+    return [];
+  }
+  const rwaTokens = new AddressSet(rwaFactory.getTokens());
+  const candidates = new AddressSet();
+  for (const op of multicall) {
+    if (op.operation === "AddCollateral" || op.operation === "UpdateQuota") {
+      candidates.add(op.token);
+    }
+  }
+  const prereqs = [];
+  for (const token of candidates) {
+    if (!rwaTokens.has(token)) {
+      continue;
+    }
+    const requirements = await sdk.accounts.getOpenAccountRequirements(
+      wallet,
+      creditManager,
+      { tokenOutAddress: token }
+    );
+    if (requirements) {
+      prereqs.push(
+        new RWAOpenRequirementsPrerequisite({
+          requirements,
+          token,
+          factory: rwaFactory.address
+        })
+      );
+    }
+  }
+  return prereqs;
+}
 function underlyingOf(sdk, creditManager) {
   const suite = sdk.marketRegister.creditManagers.find(
     (cm) => isAddressEqual(cm.creditManager.address, creditManager)

package/dist/esm/preview/prerequisites/index.js

@@ -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/esm/preview/preview/errors.js

@@ -0,0 +1,12 @@
+class UnsupportedOperationError extends Error {
+  /** The parsed operation kind (the `operation` discriminant). */
+  operation;
+  constructor(operation) {
+    super(`operation "${operation}" is not supported by previewOperation`);
+    this.name = "UnsupportedOperationError";
+    this.operation = operation;
+  }
+}
+export {
+  UnsupportedOperationError
+};

package/dist/esm/preview/{parse → preview}/extractExpectedBalanceChanges.js

@@ -14,7 +14,7 @@ function extractExpectedBalanceChanges(innerCalls) {
   if (!balanceDeltas) {
     return void 0;
   }
-  return balanceDeltas.map(({ token, amount }) => ({ token, delta: amount }));
+  return balanceDeltas.map(({ token, amount }) => ({ token, balance: amount }));
 }
 function functionName(call) {
   return call.functionName.split("(")[0];

package/dist/esm/preview/preview/index.js

@@ -0,0 +1,3 @@
+export * from "./errors.js";
+export * from "./previewOperation.js";
+export * from "./types.js";