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

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

@@ -24,52 +24,29 @@ module.exports = __toCommonJS(AllowancePrerequisite_exports);
 var import_viem = require("viem");
 var import_Prerequisite = require("./Prerequisite.js");
 class AllowancePrerequisite extends import_Prerequisite.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
+    this.#detail = { ...detail };
+  }
+  async check(ctx) {
+    const actual = await ctx.sdk.client.readContract({
+      address: this.#detail.token,
+      abi: import_viem.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
     };
   }
-  get id() {
-    return this.#id;
-  }
-  get kind() {
-    return "allowance";
-  }
-  get title() {
-    return this.#title;
-  }
-  get detail() {
-    return this.#detail;
-  }
-  calls() {
-    return [
-      {
-        address: this.#detail.token,
-        abi: import_viem.erc20Abi,
-        functionName: "allowance",
-        args: [this.#detail.owner, this.#detail.spender]
-      }
-    ];
-  }
-  resolve(slice) {
-    const res = slice[0];
-    if (!res || res.status === "failure") {
-      return this.errorResult((0, import_Prerequisite.toPrerequisiteError)(res?.error));
-    }
-    const actual = res.result;
-    return this.satisfiedResult(actual >= this.#detail.required, {
-      ...this.#detail,
-      actual
-    });
+  errorResult(error) {
+    return { kind: "allowance", detail: this.#detail, error };
   }
 }
 // Annotate the CommonJS export names for ESM import in node:

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

@@ -22,52 +22,38 @@ __export(BalancePrerequisite_exports, {
 });
 module.exports = __toCommonJS(BalancePrerequisite_exports);
 var import_viem = require("viem");
+var import_sdk = require("../../sdk/index.js");
 var import_Prerequisite = require("./Prerequisite.js");
 class BalancePrerequisite extends import_Prerequisite.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
+    this.#detail = { ...detail };
+  }
+  async check(ctx) {
+    const actual = await this.#readBalance(ctx);
+    return {
+      kind: "balance",
+      detail: { ...this.#detail, actual },
+      satisfied: actual >= this.#detail.required
     };
   }
-  get id() {
-    return this.#id;
+  errorResult(error) {
+    return { kind: "balance", detail: this.#detail, error };
   }
-  get kind() {
-    return "balance";
-  }
-  get title() {
-    return this.#title;
-  }
-  get detail() {
-    return this.#detail;
-  }
-  calls() {
-    return [
-      {
-        address: this.#detail.token,
-        abi: import_viem.erc20Abi,
-        functionName: "balanceOf",
-        args: [this.#detail.owner]
-      }
-    ];
-  }
-  resolve(slice) {
-    const res = slice[0];
-    if (!res || res.status === "failure") {
-      return this.errorResult((0, import_Prerequisite.toPrerequisiteError)(res?.error));
+  async #readBalance(ctx) {
+    if ((0, import_sdk.hexEq)(this.#detail.token, import_sdk.NATIVE_ADDRESS)) {
+      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: import_viem.erc20Abi,
+      functionName: "balanceOf",
+      args: [this.#detail.owner],
+      blockNumber: ctx.blockNumber
     });
   }
 }

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

@@ -18,8 +18,7 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var Prerequisite_exports = {};
 __export(Prerequisite_exports, {
-  Prerequisite: () => Prerequisite,
-  toPrerequisiteError: () => toPrerequisiteError
+  Prerequisite: () => Prerequisite
 });
 module.exports = __toCommonJS(Prerequisite_exports);
 var import_viem = require("viem");
@@ -43,43 +42,19 @@ 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));
+    }
   }
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  Prerequisite,
-  toPrerequisiteError
+  Prerequisite
 });

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

@@ -23,41 +23,46 @@ __export(RWAOpenRequirementsPrerequisite_exports, {
 module.exports = __toCommonJS(RWAOpenRequirementsPrerequisite_exports);
 var import_Prerequisite = require("./Prerequisite.js");
 class RWAOpenRequirementsPrerequisite extends import_Prerequisite.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;
+    this.#detail = { ...detail };
+    this.#providedArgs = providedArgs;
   }
-  get id() {
-    return this.#id;
+  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
+    };
   }
-  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;
+  errorResult(error) {
+    return { kind: "rwaOpenRequirements", detail: this.#detail, error };
   }
 }
 // Annotate the CommonJS export names for ESM import in node:

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

@@ -0,0 +1,91 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var buildCollateralPrerequisites_exports = {};
+__export(buildCollateralPrerequisites_exports, {
+  buildCollateralPrerequisites: () => buildCollateralPrerequisites
+});
+module.exports = __toCommonJS(buildCollateralPrerequisites_exports);
+var import_viem = require("viem");
+var import_sdk = require("../../sdk/index.js");
+var import_AllowancePrerequisite = require("./AllowancePrerequisite.js");
+var import_BalancePrerequisite = require("./BalancePrerequisite.js");
+var import_helpers = require("./helpers.js");
+async function buildCollateralPrerequisites(spenderOptions, multicall, ctx) {
+  const { sdk, wallet, value = 0n } = ctx;
+  const required = new import_sdk.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 import_BalancePrerequisite.BalancePrerequisite({
+        token: import_sdk.NATIVE_ADDRESS,
+        owner: wallet,
+        required: value
+      })
+    );
+  }
+  if (required.size === 0) {
+    return prereqs;
+  }
+  const spender = await sdk.accounts.getApprovalAddress(spenderOptions);
+  const weth = sdk.addressProvider.getAddress(import_sdk.AP_WETH_TOKEN, import_sdk.NO_VERSION);
+  for (const [token, amount] of required.entries()) {
+    if (value > 0n && (0, import_viem.isAddressEqual)(token, weth)) {
+      prereqs.push(
+        new import_AllowancePrerequisite.AllowancePrerequisite({
+          token,
+          owner: wallet,
+          spender,
+          required: amount
+        })
+      );
+      if (amount > value) {
+        prereqs.push(
+          new import_BalancePrerequisite.BalancePrerequisite({
+            token,
+            owner: wallet,
+            required: amount - value
+          })
+        );
+      }
+      continue;
+    }
+    prereqs.push(
+      ...(0, import_helpers.allowanceAndBalance)({
+        token,
+        owner: wallet,
+        spender,
+        required: amount
+      })
+    );
+  }
+  return prereqs;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  buildCollateralPrerequisites
+});

package/dist/cjs/preview/prerequisites/{prepareAction.js → buildPartialLiquidationPrerequisites.js}

@@ -16,33 +16,25 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var prepareAction_exports = {};
-__export(prepareAction_exports, {
-  isActionablePrerequisite: () => isActionablePrerequisite,
-  preparePrerequisiteAction: () => preparePrerequisiteAction
+var buildPartialLiquidationPrerequisites_exports = {};
+__export(buildPartialLiquidationPrerequisites_exports, {
+  buildPartialLiquidationPrerequisites: () => buildPartialLiquidationPrerequisites
 });
-module.exports = __toCommonJS(prepareAction_exports);
-var import_viem = require("viem");
-function preparePrerequisiteAction(result) {
-  if (result.kind === "allowance" && result.satisfied === false) {
-    const { token, spender, required } = result.detail;
-    return {
-      kind: "allowance",
-      to: token,
-      data: (0, import_viem.encodeFunctionData)({
-        abi: import_viem.erc20Abi,
-        functionName: "approve",
-        args: [spender, required]
-      })
-    };
+module.exports = __toCommonJS(buildPartialLiquidationPrerequisites_exports);
+var import_helpers = require("./helpers.js");
+function buildPartialLiquidationPrerequisites(tx, ctx) {
+  if (tx.repaidAmount === 0n) {
+    return [];
   }
-  return null;
-}
-function isActionablePrerequisite(result) {
-  return preparePrerequisiteAction(result) !== null;
+  const suite = ctx.sdk.marketRegister.findByCreditManager(tx.creditManager);
+  return (0, import_helpers.allowanceAndBalance)({
+    token: suite.underlying,
+    owner: ctx.wallet,
+    spender: tx.creditManager,
+    required: tx.repaidAmount
+  });
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  isActionablePrerequisite,
-  preparePrerequisiteAction
+  buildPartialLiquidationPrerequisites
 });

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

@@ -0,0 +1,114 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var buildPoolPrerequisites_exports = {};
+__export(buildPoolPrerequisites_exports, {
+  buildPoolPrerequisites: () => buildPoolPrerequisites
+});
+module.exports = __toCommonJS(buildPoolPrerequisites_exports);
+var import_viem = require("viem");
+var import_sdk = require("../../sdk/index.js");
+var import_AllowancePrerequisite = require("./AllowancePrerequisite.js");
+var import_BalancePrerequisite = require("./BalancePrerequisite.js");
+var import_helpers = require("./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 ((0, import_viem.isAddressEqual)(tx.tokenIn, import_sdk.NATIVE_ADDRESS)) {
+          return [
+            new import_BalancePrerequisite.BalancePrerequisite({
+              token: tx.tokenIn,
+              owner: wallet,
+              required: tx.assets
+            })
+          ];
+        }
+        return (0, import_helpers.allowanceAndBalance)({
+          token: tx.tokenIn,
+          owner: wallet,
+          spender: tx.zapper,
+          required: tx.assets
+        });
+      }
+      return (0, import_helpers.allowanceAndBalance)({
+        token: tx.underlying,
+        owner: wallet,
+        spender: tx.pool,
+        required: tx.assets
+      });
+    case "Mint":
+      return (0, import_helpers.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 import_BalancePrerequisite.BalancePrerequisite({
+            token: tx.tokenIn,
+            owner: wallet,
+            required: tx.shares
+          }),
+          new import_AllowancePrerequisite.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 import_BalancePrerequisite.BalancePrerequisite({
+      token: pool,
+      owner,
+      required
+    })
+  ];
+  if (!(0, import_viem.isAddressEqual)(owner, wallet)) {
+    prereqs.push(
+      new import_AllowancePrerequisite.AllowancePrerequisite({
+        token: pool,
+        owner,
+        spender: wallet,
+        required
+      })
+    );
+  }
+  return prereqs;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  buildPoolPrerequisites
+});

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

@@ -0,0 +1,59 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var buildRWAPrerequisites_exports = {};
+__export(buildRWAPrerequisites_exports, {
+  buildRWAPrerequisites: () => buildRWAPrerequisites
+});
+module.exports = __toCommonJS(buildRWAPrerequisites_exports);
+var import_sdk = require("../../sdk/index.js");
+var import_RWAOpenRequirementsPrerequisite = require("./RWAOpenRequirementsPrerequisite.js");
+function buildRWAPrerequisites(multicall, creditManager, providedArgs, ctx) {
+  const { rwaFactory } = ctx.sdk.marketRegister.findByCreditManager(creditManager);
+  if (!rwaFactory) {
+    return [];
+  }
+  const rwaTokens = new import_sdk.AddressSet(rwaFactory.getTokens());
+  const candidates = new import_sdk.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 import_RWAOpenRequirementsPrerequisite.RWAOpenRequirementsPrerequisite(
+        {
+          token,
+          creditManager,
+          factory: rwaFactory.address
+        },
+        providedArgs
+      )
+    );
+  }
+  return prereqs;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  buildRWAPrerequisites
+});