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

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

@@ -6,27 +6,29 @@ import {
   RWA_FACTORY_SECURITIZE
 } from "../../sdk/index.js";
 import { classifyInnerOperations } from "./classifyInnerOperations.js";
-function parseRWAFactoryOperationCalldata(props) {
-  const { contractType, address } = props.factory;
-  if (isRWAFactory(props.factory, RWA_FACTORY_SECURITIZE)) {
-    return parseSecuritizeOperationCalldata(props);
+function parseRWAFactoryOperationCalldata(sdk, factory, calldata) {
+  const { contractType, address } = factory;
+  if (isRWAFactory(factory, RWA_FACTORY_SECURITIZE)) {
+    return parseSecuritizeOperationCalldata(sdk, factory, calldata);
   }
   throw new Error(
     `unsupported RWA factory type "${contractType}" on ${address}`
   );
 }
-function parseSecuritizeOperationCalldata(props) {
-  const { sdk, factory, calldata } = props;
+function parseSecuritizeOperationCalldata(sdk, factory, calldata) {
   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 args = {
+    type: RWA_FACTORY_SECURITIZE,
+    tokensToRegister: [
+      ...rawArgs.tokensToRegister ?? []
+    ],
+    signaturesToCache: [
+      ...rawArgs.signaturesToCache ?? []
+    ]
+  };
   const suite = functionName === "openCreditAccount" ? sdk.marketRegister.findCreditManager(rawArgs.creditManager) : resolveSuiteForMulticall(sdk, factory, innerCalls);
   const metadata = {
     factory: factory.address,
@@ -41,19 +43,17 @@ function parseSecuritizeOperationCalldata(props) {
     case "openCreditAccount":
       return {
         ...metadata,
-        operation: "SecuritizeOpenCreditAccount",
+        operation: "RWAOpenCreditAccount",
         multicall,
-        tokensToRegister,
-        signaturesToCache
+        args
       };
     case "multicall":
       return {
         ...metadata,
-        operation: "SecuritizeMulticall",
+        operation: "RWAMulticall",
         creditAccount: rawArgs.creditAccount,
         multicall,
-        tokensToRegister,
-        signaturesToCache
+        args
       };
     default:
       throw new Error(

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

@@ -6,7 +6,7 @@ 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";
+  return tx.operation === "RWAOpenCreditAccount" || tx.operation === "RWAMulticall";
 }
 export {
   isPoolOperation,

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

@@ -1,55 +1,29 @@
 import { erc20Abi } from "viem";
-import {
-  Prerequisite,
-  toPrerequisiteError
-} from "./Prerequisite.js";
+import { Prerequisite } from "./Prerequisite.js";
 class AllowancePrerequisite extends Prerequisite {
-  #id;
-  #title;
   #detail;
-  constructor(props) {
+  constructor(detail) {
     super();
-    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,
-      required: props.required
-    };
-  }
-  get id() {
-    return this.#id;
-  }
-  get kind() {
-    return "allowance";
-  }
-  get title() {
-    return this.#title;
+    this.#detail = { ...detail };
   }
-  get detail() {
-    return this.#detail;
-  }
-  calls() {
-    return [
-      {
-        address: this.#detail.token,
-        abi: erc20Abi,
-        functionName: "allowance",
-        args: [this.#detail.owner, this.#detail.spender]
-      }
-    ];
-  }
-  resolve(slice) {
-    const res = slice[0];
-    if (!res || res.status === "failure") {
-      return this.errorResult(toPrerequisiteError(res?.error));
-    }
-    const actual = res.result;
-    return this.satisfiedResult(actual >= this.#detail.required, {
-      ...this.#detail,
-      actual
+  async check(ctx) {
+    const actual = await ctx.sdk.client.readContract({
+      address: this.#detail.token,
+      abi: erc20Abi,
+      functionName: "allowance",
+      args: [this.#detail.owner, this.#detail.spender],
+      // `undefined` lets viem read at `latest`; `blockNumber` is only set for
+      // testnet forks pinned to a specific block.
+      blockNumber: ctx.blockNumber
     });
+    return {
+      kind: "allowance",
+      detail: { ...this.#detail, actual },
+      satisfied: actual >= this.#detail.required
+    };
+  }
+  errorResult(error) {
+    return { kind: "allowance", detail: this.#detail, error };
   }
 }
 export {

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

@@ -1,71 +1,36 @@
 import { erc20Abi } from "viem";
-import { iMulticall3Abi } from "../../abi/iMulticall3.js";
 import { hexEq, NATIVE_ADDRESS } from "../../sdk/index.js";
-import {
-  Prerequisite,
-  toPrerequisiteError
-} from "./Prerequisite.js";
+import { Prerequisite } from "./Prerequisite.js";
 class BalancePrerequisite extends Prerequisite {
-  #id;
-  #title;
   #detail;
-  constructor(props) {
+  constructor(detail) {
     super();
-    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;
-  }
-  get kind() {
-    return "balance";
+    this.#detail = { ...detail };
   }
-  get title() {
-    return this.#title;
+  async check(ctx) {
+    const actual = await this.#readBalance(ctx);
+    return {
+      kind: "balance",
+      detail: { ...this.#detail, actual },
+      satisfied: actual >= this.#detail.required
+    };
   }
-  get detail() {
-    return this.#detail;
+  errorResult(error) {
+    return { kind: "balance", detail: this.#detail, error };
   }
-  calls(ctx) {
+  async #readBalance(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,
-        abi: erc20Abi,
-        functionName: "balanceOf",
-        args: [this.#detail.owner]
-      }
-    ];
-  }
-  resolve(slice) {
-    const res = slice[0];
-    if (!res || res.status === "failure") {
-      return this.errorResult(toPrerequisiteError(res?.error));
+      return ctx.sdk.client.getBalance({
+        address: this.#detail.owner,
+        blockNumber: ctx.blockNumber
+      });
     }
-    const actual = res.result;
-    return this.satisfiedResult(actual >= this.#detail.required, {
-      ...this.#detail,
-      actual
+    return ctx.sdk.client.readContract({
+      address: this.#detail.token,
+      abi: erc20Abi,
+      functionName: "balanceOf",
+      args: [this.#detail.owner],
+      blockNumber: ctx.blockNumber
     });
   }
 }

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

@@ -1,7 +1,4 @@
-import {
-  BaseError,
-  ContractFunctionRevertedError
-} from "viem";
+import { BaseError, ContractFunctionRevertedError } from "viem";
 function toPrerequisiteError(cause) {
   if (cause instanceof BaseError) {
     const reverted = cause.walk(
@@ -22,42 +19,18 @@ function toPrerequisiteError(cause) {
 }
 class Prerequisite {
   /**
-   * Verifies this prerequisite on its own using an `allowFailure` multicall.
-   * Prefer `verifyPrerequisites` to batch several checks into one round-trip.
+   * Verifies this prerequisite. Never rejects: any error thrown by
+   * {@link check} (revert, RPC/network failure, compressor error) is
+   * normalized into an `error` result.
    */
   async verify(ctx) {
-    const calls = this.calls(ctx);
-    const results = await ctx.sdk.client.multicall({
-      allowFailure: true,
-      contracts: calls,
-      // `undefined` lets viem read at `latest`; `blockNumber` is only set for
-      // testnet forks pinned to a specific block.
-      blockNumber: ctx.blockNumber
-    });
-    return this.resolve(results);
-  }
-  /** Builds a successful result; `detail` carries the on-chain `actual`. */
-  satisfiedResult(satisfied, detail) {
-    return {
-      id: this.id,
-      kind: this.kind,
-      title: this.title,
-      detail,
-      satisfied
-    };
-  }
-  /** Builds a failed result from a decoded read error. */
-  errorResult(error) {
-    return {
-      id: this.id,
-      kind: this.kind,
-      title: this.title,
-      detail: this.detail,
-      error
-    };
+    try {
+      return await this.check(ctx);
+    } catch (cause) {
+      return this.errorResult(toPrerequisiteError(cause));
+    }
   }
 }
 export {
-  Prerequisite,
-  toPrerequisiteError
+  Prerequisite
 };

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

@@ -1,40 +1,45 @@
 import { Prerequisite } from "./Prerequisite.js";
 class RWAOpenRequirementsPrerequisite extends Prerequisite {
-  #id;
-  #title;
   #detail;
-  constructor(props) {
+  #providedArgs;
+  constructor(detail, providedArgs) {
     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;
+    this.#detail = { ...detail };
+    this.#providedArgs = providedArgs;
+  }
+  async check(ctx) {
+    const requirements = await ctx.sdk.accounts.getOpenAccountRequirements(
+      ctx.wallet,
+      this.#detail.creditManager,
+      { tokenOutAddress: this.#detail.token }
+    );
+    if (!requirements) {
+      return {
+        kind: "rwaOpenRequirements",
+        detail: this.#detail,
+        satisfied: true
+      };
+    }
+    const { rwaFactory } = ctx.sdk.marketRegister.findByCreditManager(
+      this.#detail.creditManager
+    );
+    if (!rwaFactory) {
+      throw new Error(
+        `no RWA factory found for credit manager ${this.#detail.creditManager}`
+      );
+    }
+    const missing = rwaFactory.getMissingRequirements(
+      requirements,
+      this.#providedArgs
+    );
+    return {
+      kind: "rwaOpenRequirements",
+      detail: { ...this.#detail, requirements, missing },
+      satisfied: !missing && requirements.securitizeTokensToRegister.length === 0
+    };
+  }
+  errorResult(error) {
+    return { kind: "rwaOpenRequirements", detail: this.#detail, error };
   }
 }
 export {

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

@@ -0,0 +1,72 @@
+import { isAddressEqual } from "viem";
+import {
+  AP_WETH_TOKEN,
+  AssetsMap,
+  NATIVE_ADDRESS,
+  NO_VERSION
+} from "../../sdk/index.js";
+import { AllowancePrerequisite } from "./AllowancePrerequisite.js";
+import { BalancePrerequisite } from "./BalancePrerequisite.js";
+import { allowanceAndBalance } from "./helpers.js";
+async function buildCollateralPrerequisites(spenderOptions, multicall, ctx) {
+  const { sdk, wallet, value = 0n } = ctx;
+  const required = new AssetsMap();
+  for (const op of multicall) {
+    if (op.operation !== "AddCollateral" || op.amount === 0n) {
+      continue;
+    }
+    required.inc(op.token, op.amount);
+  }
+  if (required.size === 0 && value === 0n) {
+    return [];
+  }
+  const prereqs = [];
+  if (value > 0n) {
+    prereqs.push(
+      new BalancePrerequisite({
+        token: NATIVE_ADDRESS,
+        owner: wallet,
+        required: value
+      })
+    );
+  }
+  if (required.size === 0) {
+    return prereqs;
+  }
+  const spender = await sdk.accounts.getApprovalAddress(spenderOptions);
+  const weth = sdk.addressProvider.getAddress(AP_WETH_TOKEN, NO_VERSION);
+  for (const [token, amount] of required.entries()) {
+    if (value > 0n && isAddressEqual(token, weth)) {
+      prereqs.push(
+        new AllowancePrerequisite({
+          token,
+          owner: wallet,
+          spender,
+          required: amount
+        })
+      );
+      if (amount > value) {
+        prereqs.push(
+          new BalancePrerequisite({
+            token,
+            owner: wallet,
+            required: amount - value
+          })
+        );
+      }
+      continue;
+    }
+    prereqs.push(
+      ...allowanceAndBalance({
+        token,
+        owner: wallet,
+        spender,
+        required: amount
+      })
+    );
+  }
+  return prereqs;
+}
+export {
+  buildCollateralPrerequisites
+};

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

@@ -0,0 +1,16 @@
+import { allowanceAndBalance } from "./helpers.js";
+function buildPartialLiquidationPrerequisites(tx, ctx) {
+  if (tx.repaidAmount === 0n) {
+    return [];
+  }
+  const suite = ctx.sdk.marketRegister.findByCreditManager(tx.creditManager);
+  return allowanceAndBalance({
+    token: suite.underlying,
+    owner: ctx.wallet,
+    spender: tx.creditManager,
+    required: tx.repaidAmount
+  });
+}
+export {
+  buildPartialLiquidationPrerequisites
+};

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

@@ -0,0 +1,90 @@
+import { isAddressEqual } from "viem";
+import { NATIVE_ADDRESS } from "../../sdk/index.js";
+import { AllowancePrerequisite } from "./AllowancePrerequisite.js";
+import { BalancePrerequisite } from "./BalancePrerequisite.js";
+import { allowanceAndBalance } from "./helpers.js";
+function buildPoolPrerequisites(tx, wallet) {
+  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.
+    // The exact underlying amount for Mint is resolved by the pool, so we can
+    // only require an allowance/balance against the known specified amount —
+    // here we approximate Mint by its shares amount (a lower bound on assets is
+    // not knowable from calldata alone).
+    case "Deposit":
+      if (tx.zapper) {
+        if (isAddressEqual(tx.tokenIn, NATIVE_ADDRESS)) {
+          return [
+            new BalancePrerequisite({
+              token: tx.tokenIn,
+              owner: wallet,
+              required: tx.assets
+            })
+          ];
+        }
+        return allowanceAndBalance({
+          token: tx.tokenIn,
+          owner: wallet,
+          spender: tx.zapper,
+          required: tx.assets
+        });
+      }
+      return allowanceAndBalance({
+        token: tx.underlying,
+        owner: wallet,
+        spender: tx.pool,
+        required: tx.assets
+      });
+    case "Mint":
+      return allowanceAndBalance({
+        token: tx.underlying,
+        owner: wallet,
+        spender: tx.pool,
+        required: tx.shares
+      });
+    // Redeem and Withdraw both burn LP shares from `owner`; they only differ in
+    // which side (shares vs assets) the caller specifies.
+    case "Redeem":
+      if (tx.zapper) {
+        return [
+          new BalancePrerequisite({
+            token: tx.tokenIn,
+            owner: wallet,
+            required: tx.shares
+          }),
+          new AllowancePrerequisite({
+            token: tx.tokenIn,
+            owner: wallet,
+            spender: tx.zapper,
+            required: tx.shares
+          })
+        ];
+      }
+      return lpSharePrerequisites(tx.pool, tx.owner, tx.shares, wallet);
+    case "Withdraw":
+      return lpSharePrerequisites(tx.pool, tx.owner, tx.assets, wallet);
+  }
+}
+function lpSharePrerequisites(pool, owner, required, wallet) {
+  const prereqs = [
+    new BalancePrerequisite({
+      token: pool,
+      owner,
+      required
+    })
+  ];
+  if (!isAddressEqual(owner, wallet)) {
+    prereqs.push(
+      new AllowancePrerequisite({
+        token: pool,
+        owner,
+        spender: wallet,
+        required
+      })
+    );
+  }
+  return prereqs;
+}
+export {
+  buildPoolPrerequisites
+};

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

@@ -0,0 +1,35 @@
+import { AddressSet } from "../../sdk/index.js";
+import { RWAOpenRequirementsPrerequisite } from "./RWAOpenRequirementsPrerequisite.js";
+function buildRWAPrerequisites(multicall, creditManager, providedArgs, ctx) {
+  const { rwaFactory } = ctx.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;
+    }
+    prereqs.push(
+      new RWAOpenRequirementsPrerequisite(
+        {
+          token,
+          creditManager,
+          factory: rwaFactory.address
+        },
+        providedArgs
+      )
+    );
+  }
+  return prereqs;
+}
+export {
+  buildRWAPrerequisites
+};

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

@@ -0,0 +1,62 @@
+import { parseOperationCalldata } from "../parse/index.js";
+import { buildCollateralPrerequisites } from "./buildCollateralPrerequisites.js";
+import { buildPartialLiquidationPrerequisites } from "./buildPartialLiquidationPrerequisites.js";
+import { buildPoolPrerequisites } from "./buildPoolPrerequisites.js";
+import { buildRWAPrerequisites } from "./buildRWAPrerequisites.js";
+async function checkPrerequisites(input, options) {
+  const { sdk, sender: wallet } = input;
+  const tx = parseOperationCalldata(input);
+  const ctx = {
+    sdk,
+    wallet,
+    blockNumber: options?.blockNumber,
+    value: input.value ?? 0n
+  };
+  const prereqs = await buildPrerequisites(tx, ctx);
+  return Promise.all(prereqs.map((p) => p.verify(ctx)));
+}
+async function buildPrerequisites(tx, ctx) {
+  const { wallet } = ctx;
+  switch (tx.operation) {
+    case "Deposit":
+    case "Mint":
+    case "Redeem":
+    case "Withdraw":
+      return buildPoolPrerequisites(tx, wallet);
+    case "MultiCall":
+    case "BotMulticall":
+    case "OpenCreditAccount":
+    case "CloseCreditAccount":
+    case "LiquidateCreditAccount":
+      return buildCollateralPrerequisites(
+        tx.operation === "OpenCreditAccount" ? { creditManager: tx.creditManager, borrower: wallet } : {
+          creditManager: tx.creditManager,
+          creditAccount: tx.creditAccount
+        },
+        tx.multicall,
+        ctx
+      );
+    case "RWAOpenCreditAccount":
+      return [
+        ...await buildCollateralPrerequisites(
+          { creditManager: tx.creditManager, borrower: wallet },
+          tx.multicall,
+          ctx
+        ),
+        ...buildRWAPrerequisites(tx.multicall, tx.creditManager, tx.args, ctx)
+      ];
+    case "RWAMulticall":
+      return buildCollateralPrerequisites(
+        { creditManager: tx.creditManager, creditAccount: tx.creditAccount },
+        tx.multicall,
+        ctx
+      );
+    case "PartiallyLiquidateCreditAccount":
+      return buildPartialLiquidationPrerequisites(tx, ctx);
+    default:
+      return [];
+  }
+}
+export {
+  checkPrerequisites
+};

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

@@ -0,0 +1,14 @@
+import {
+  AllowancePrerequisite
+} from "./AllowancePrerequisite.js";
+import { BalancePrerequisite } from "./BalancePrerequisite.js";
+function allowanceAndBalance(props) {
+  const { token, owner, spender, required } = props;
+  return [
+    new AllowancePrerequisite({ token, owner, spender, required }),
+    new BalancePrerequisite({ token, owner, required })
+  ];
+}
+export {
+  allowanceAndBalance
+};