@gearbox-protocol/sdk 14.11.0-next.3 → 14.11.0-next.4

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

@@ -19,6 +19,7 @@ __reExport(prerequisites_exports, require("./AllowancePrerequisite.js"), module.
 __reExport(prerequisites_exports, require("./BalancePrerequisite.js"), module.exports);
 __reExport(prerequisites_exports, require("./buildPrerequisites.js"), module.exports);
 __reExport(prerequisites_exports, require("./Prerequisite.js"), module.exports);
+__reExport(prerequisites_exports, require("./prepareAction.js"), module.exports);
 __reExport(prerequisites_exports, require("./runPrerequisites.js"), module.exports);
 __reExport(prerequisites_exports, require("./types.js"), module.exports);
 // Annotate the CommonJS export names for ESM import in node:
@@ -27,6 +28,7 @@ __reExport(prerequisites_exports, require("./types.js"), module.exports);
   ...require("./BalancePrerequisite.js"),
   ...require("./buildPrerequisites.js"),
   ...require("./Prerequisite.js"),
+  ...require("./prepareAction.js"),
   ...require("./runPrerequisites.js"),
   ...require("./types.js")
 });

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

@@ -0,0 +1,48 @@
+"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 prepareAction_exports = {};
+__export(prepareAction_exports, {
+  isActionablePrerequisite: () => isActionablePrerequisite,
+  preparePrerequisiteAction: () => preparePrerequisiteAction
+});
+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]
+      })
+    };
+  }
+  return null;
+}
+function isActionablePrerequisite(result) {
+  return preparePrerequisiteAction(result) !== null;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  isActionablePrerequisite,
+  preparePrerequisiteAction
+});

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

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

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

@@ -0,0 +1,23 @@
+import { encodeFunctionData, erc20Abi } from "viem";
+function preparePrerequisiteAction(result) {
+  if (result.kind === "allowance" && result.satisfied === false) {
+    const { token, spender, required } = result.detail;
+    return {
+      kind: "allowance",
+      to: token,
+      data: encodeFunctionData({
+        abi: erc20Abi,
+        functionName: "approve",
+        args: [spender, required]
+      })
+    };
+  }
+  return null;
+}
+function isActionablePrerequisite(result) {
+  return preparePrerequisiteAction(result) !== null;
+}
+export {
+  isActionablePrerequisite,
+  preparePrerequisiteAction
+};

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

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

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

@@ -0,0 +1,52 @@
+import { type Address, type Hex } from "viem";
+import type { AnyPrerequisiteResult } from "./types.js";
+/**
+ * A single transaction that satisfies a sender-actionable prerequisite.
+ *
+ * The shape is intentionally minimal (`to`/`data`/optional `value`) so it maps
+ * directly onto wallet send primitives (e.g. viem `sendTransaction`, wagmi
+ * `useSendTransaction`/`useWriteContract`). It is deliberately *not* the heavier
+ * {@link import("../../sdk/types/transactions.js").RawTx} used for Safe batches.
+ *
+ * The `kind` mirrors the prerequisite kind it remediates, so consumers can label
+ * the action (e.g. "Approve") without re-deriving it.
+ */
+export interface PrerequisiteAction {
+    /** Prerequisite kind this action remediates. */
+    kind: "allowance";
+    /** Contract the transaction is sent to (the ERC-20 token for allowances). */
+    to: Address;
+    /** Encoded calldata (e.g. `approve(spender, required)`). */
+    data: Hex;
+    /** Native value to send; omitted (treated as 0) for ERC-20 approvals. */
+    value?: bigint;
+}
+/**
+ * Builds the transaction that resolves an unsatisfied, sender-actionable
+ * prerequisite, or returns `null` when the prerequisite cannot be fixed with a
+ * single wallet transaction.
+ *
+ * Currently only `allowance` is actionable: it returns an ERC-20
+ * `approve(spender, required)` for the exact required amount. `balance`
+ * shortfalls (the user must acquire/free up funds) and errored reads are not
+ * actionable and return `null`. New actionable kinds (permits, native unwrap,
+ * approve-reset-to-zero for non-standard tokens, ...) should be encoded here so
+ * consumers do not have to special-case them.
+ *
+ * Operates on the serializable {@link AnyPrerequisiteResult} produced by
+ * `verifyPrerequisites` (not on {@link import("./Prerequisite.js").Prerequisite}
+ * instances), so it works against cached/persisted results.
+ *
+ * @param result - A verified prerequisite result.
+ * @returns The remediation transaction, or `null` if not auto-actionable.
+ */
+export declare function preparePrerequisiteAction(result: AnyPrerequisiteResult): PrerequisiteAction | null;
+/**
+ * Whether a prerequisite result represents something the sender can fix with a
+ * single wallet transaction (i.e. {@link preparePrerequisiteAction} returns a
+ * transaction for it).
+ *
+ * Useful for UIs that distinguish "approve to continue" (actionable) from hard
+ * blocks like an insufficient balance (not actionable).
+ */
+export declare function isActionablePrerequisite(result: AnyPrerequisiteResult): boolean;

package/package.json

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