@gearbox-protocol/sdk 14.11.0-next.6 → 14.11.0-next.7

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

@@ -37,9 +37,26 @@ function parsePoolOperationCalldata(props) {
         receiver: rawArgs.receiver,
         assets: rawArgs.assets,
         underlying,
-        referralCode: functionName === "depositWithReferral" ? rawArgs.referralCode : void 0,
-        // Calldata-only parse: transfers are recovered later by simulation.
-        transfers: []
+        referralCode: functionName === "depositWithReferral" ? rawArgs.referralCode : void 0
+      };
+    case "mint":
+    case "mintWithReferral":
+      return {
+        operation: "Mint",
+        pool: pool.address,
+        receiver: rawArgs.receiver,
+        shares: rawArgs.shares,
+        underlying,
+        referralCode: functionName === "mintWithReferral" ? rawArgs.referralCode : void 0
+      };
+    case "withdraw":
+      return {
+        operation: "Withdraw",
+        pool: pool.address,
+        receiver: rawArgs.receiver,
+        owner: rawArgs.owner,
+        assets: rawArgs.assets,
+        underlying
       };
     case "redeem":
       return {
@@ -48,9 +65,7 @@ function parsePoolOperationCalldata(props) {
         receiver: rawArgs.receiver,
         owner: rawArgs.owner,
         shares: rawArgs.shares,
-        underlying,
-        // Calldata-only parse: transfers are recovered later by simulation.
-        transfers: []
+        underlying
       };
     default:
       throw new import_errors.UnsupportedPoolFunctionError(pool.address, parsed.functionName);

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

@@ -26,7 +26,7 @@ __reExport(types_exports, require("./types-adapters.js"), module.exports);
 __reExport(types_exports, require("./types-facades.js"), module.exports);
 __reExport(types_exports, require("./types-pools.js"), module.exports);
 function isPoolOperation(tx) {
-  return tx.operation === "Deposit" || tx.operation === "Redeem";
+  return tx.operation === "Deposit" || tx.operation === "Mint" || tx.operation === "Withdraw" || tx.operation === "Redeem";
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

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

@@ -27,6 +27,12 @@ var import_BalancePrerequisite = require("./BalancePrerequisite.js");
 function buildPrerequisites(tx, ctx) {
   const { wallet } = ctx;
   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":
       return [
         new import_AllowancePrerequisite.AllowancePrerequisite({
@@ -43,6 +49,24 @@ function buildPrerequisites(tx, ctx) {
           title: "Sufficient token balance"
         })
       ];
+    case "Mint":
+      return [
+        new import_AllowancePrerequisite.AllowancePrerequisite({
+          token: tx.underlying,
+          owner: wallet,
+          spender: tx.pool,
+          required: tx.shares,
+          title: "Token approved to pool"
+        }),
+        new import_BalancePrerequisite.BalancePrerequisite({
+          token: tx.underlying,
+          owner: wallet,
+          required: tx.shares,
+          title: "Sufficient token balance"
+        })
+      ];
+    // Redeem and Withdraw both burn LP shares from `owner`; they only differ in
+    // which side (shares vs assets) the caller specifies.
     case "Redeem": {
       const prereqs = [
         new import_BalancePrerequisite.BalancePrerequisite({
@@ -65,6 +89,28 @@ function buildPrerequisites(tx, ctx) {
       }
       return prereqs;
     }
+    case "Withdraw": {
+      const prereqs = [
+        new import_BalancePrerequisite.BalancePrerequisite({
+          token: tx.pool,
+          owner: tx.owner,
+          required: tx.assets,
+          title: "Sufficient LP token balance"
+        })
+      ];
+      if (!(0, import_viem.isAddressEqual)(tx.owner, wallet)) {
+        prereqs.push(
+          new import_AllowancePrerequisite.AllowancePrerequisite({
+            token: tx.pool,
+            owner: tx.owner,
+            spender: wallet,
+            required: tx.assets,
+            title: "LP token approved to caller"
+          })
+        );
+      }
+      return prereqs;
+    }
     case "MultiCall":
     case "BotMulticall":
     case "OpenCreditAccount":

package/dist/cjs/preview/simulate/constants.js

@@ -0,0 +1,28 @@
+"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 constants_exports = {};
+__export(constants_exports, {
+  ETH_SIMULATE_V1_NETWORKS: () => ETH_SIMULATE_V1_NETWORKS
+});
+module.exports = __toCommonJS(constants_exports);
+const ETH_SIMULATE_V1_NETWORKS = /* @__PURE__ */ new Set(["Mainnet", "Plasma", "Somnia"]);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ETH_SIMULATE_V1_NETWORKS
+});

package/dist/cjs/preview/simulate/{decodeSimulationError.js → errors.js}

@@ -16,13 +16,44 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var decodeSimulationError_exports = {};
-__export(decodeSimulationError_exports, {
+var errors_exports = {};
+__export(errors_exports, {
+  PreviewSimulationError: () => PreviewSimulationError,
+  asPreviewSimulationError: () => asPreviewSimulationError,
+  combinePreviewSimulationErrors: () => combinePreviewSimulationErrors,
   decodeSimulationError: () => decodeSimulationError
 });
-module.exports = __toCommonJS(decodeSimulationError_exports);
+module.exports = __toCommonJS(errors_exports);
 var import_viem = require("viem");
 var import_errors = require("../../abi/errors.js");
+class PreviewSimulationError extends import_viem.BaseError {
+  name = "PreviewSimulationError";
+  /** Per-flow decoded failures behind this error. */
+  failures;
+  constructor(failures) {
+    const shortMessage = failures.length <= 1 ? failures[0]?.detail.reason ?? "simulation failed" : "all simulation flows failed";
+    const cause = failures.find((f) => f.detail.cause instanceof Error)?.detail.cause;
+    super(shortMessage, {
+      metaMessages: failures.map((f) => `[${f.source}] ${f.detail.reason}`),
+      cause
+    });
+    this.failures = failures;
+  }
+}
+function asPreviewSimulationError(reason, source) {
+  if (reason instanceof PreviewSimulationError) {
+    return reason;
+  }
+  const error = reason instanceof Error ? reason : new Error(String(reason));
+  return new PreviewSimulationError([
+    { source, detail: decodeSimulationError({ error }) }
+  ]);
+}
+function combinePreviewSimulationErrors(...errors) {
+  return new PreviewSimulationError(
+    errors.filter((e) => e).flatMap((e) => e?.failures ?? [])
+  );
+}
 function decodeSimulationError(revert) {
   const { error, data } = revert;
   if (data && data !== "0x") {
@@ -60,5 +91,8 @@ function formatDecodedError(errorName, args) {
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  PreviewSimulationError,
+  asPreviewSimulationError,
+  combinePreviewSimulationErrors,
   decodeSimulationError
 });

package/dist/cjs/preview/simulate/holders.js

@@ -0,0 +1,45 @@
+"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 holders_exports = {};
+__export(holders_exports, {
+  watchedHolders: () => watchedHolders
+});
+module.exports = __toCommonJS(holders_exports);
+var import_sdk = require("../../sdk/index.js");
+function sourceHolder(operation, wallet) {
+  switch (operation.operation) {
+    case "Deposit":
+    case "Mint":
+      return wallet;
+    case "Withdraw":
+    case "Redeem":
+      return operation.owner;
+  }
+}
+function watchedHolders(operation, wallet) {
+  const holders = new import_sdk.AddressSet([
+    sourceHolder(operation, wallet),
+    operation.receiver
+  ]);
+  return holders.asArray();
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  watchedHolders
+});

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

@@ -3,6 +3,10 @@ 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))
@@ -11,22 +15,26 @@ var __copyProps = (to, from, except, desc) => {
   }
   return to;
 };
-var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var simulate_exports = {};
+__export(simulate_exports, {
+  ETH_SIMULATE_V1_NETWORKS: () => import_constants.ETH_SIMULATE_V1_NETWORKS,
+  PreviewSimulationError: () => import_errors.PreviewSimulationError,
+  simulateFacadeOperation: () => import_simulateFacadeOperation.simulateFacadeOperation,
+  simulateOperation: () => import_simulateOperation.simulateOperation,
+  simulatePoolOperation: () => import_simulatePoolOperation.simulatePoolOperation
+});
 module.exports = __toCommonJS(simulate_exports);
-__reExport(simulate_exports, require("./decodeSimulationError.js"), module.exports);
-__reExport(simulate_exports, require("./extractERC20Transfers.js"), module.exports);
-__reExport(simulate_exports, require("./simulateFacadeOperation.js"), module.exports);
-__reExport(simulate_exports, require("./simulateOperation.js"), module.exports);
-__reExport(simulate_exports, require("./simulatePoolOperation.js"), module.exports);
-__reExport(simulate_exports, require("./types.js"), module.exports);
+var import_constants = require("./constants.js");
+var import_errors = require("./errors.js");
+var import_simulateFacadeOperation = require("./simulateFacadeOperation.js");
+var import_simulateOperation = require("./simulateOperation.js");
+var import_simulatePoolOperation = require("./simulatePoolOperation.js");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  ...require("./decodeSimulationError.js"),
-  ...require("./extractERC20Transfers.js"),
-  ...require("./simulateFacadeOperation.js"),
-  ...require("./simulateOperation.js"),
-  ...require("./simulatePoolOperation.js"),
-  ...require("./types.js")
+  ETH_SIMULATE_V1_NETWORKS,
+  PreviewSimulationError,
+  simulateFacadeOperation,
+  simulateOperation,
+  simulatePoolOperation
 });

package/dist/cjs/preview/simulate/simulateFacadeOperation.js

@@ -21,7 +21,7 @@ __export(simulateFacadeOperation_exports, {
   simulateFacadeOperation: () => simulateFacadeOperation
 });
 module.exports = __toCommonJS(simulateFacadeOperation_exports);
-async function simulateFacadeOperation(_input) {
+async function simulateFacadeOperation(_input, _options) {
   throw new Error("not yet implemented");
 }
 // Annotate the CommonJS export names for ESM import in node:

package/dist/cjs/preview/simulate/simulateOperation.js

@@ -24,12 +24,12 @@ module.exports = __toCommonJS(simulateOperation_exports);
 var import_parse = require("../parse/index.js");
 var import_simulateFacadeOperation = require("./simulateFacadeOperation.js");
 var import_simulatePoolOperation = require("./simulatePoolOperation.js");
-async function simulateOperation(input) {
+async function simulateOperation(input, options) {
   const { operation } = input;
   if ((0, import_parse.isPoolOperation)(operation)) {
-    return (0, import_simulatePoolOperation.simulatePoolOperation)({ ...input, operation });
+    return (0, import_simulatePoolOperation.simulatePoolOperation)({ ...input, operation }, options);
   }
-  return (0, import_simulateFacadeOperation.simulateFacadeOperation)({ ...input, operation });
+  return (0, import_simulateFacadeOperation.simulateFacadeOperation)({ ...input, operation }, options);
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/dist/cjs/preview/simulate/simulatePoolOpMulticall.js

@@ -0,0 +1,155 @@
+"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 simulatePoolOpMulticall_exports = {};
+__export(simulatePoolOpMulticall_exports, {
+  computePoolOpBalanceChanges: () => computePoolOpBalanceChanges,
+  simulatePoolOpMulticall: () => simulatePoolOpMulticall
+});
+module.exports = __toCommonJS(simulatePoolOpMulticall_exports);
+var import_generated = require("../../abi/310/generated.js");
+var import_iERC20 = require("../../abi/iERC20.js");
+var import_sdk = require("../../sdk/index.js");
+var import_errors = require("./errors.js");
+var import_holders = require("./holders.js");
+function previewRead(operation) {
+  switch (operation.operation) {
+    case "Deposit":
+      return { functionName: "previewDeposit", amount: operation.assets };
+    case "Mint":
+      return { functionName: "previewMint", amount: operation.shares };
+    case "Withdraw":
+      return { functionName: "previewWithdraw", amount: operation.assets };
+    case "Redeem":
+      return { functionName: "previewRedeem", amount: operation.shares };
+  }
+}
+async function simulatePoolOpMulticall(input, options = {}) {
+  const { sdk, operation, wallet } = input;
+  const { blockNumber } = options;
+  const { underlying, pool } = operation;
+  const holders = (0, import_holders.watchedHolders)(operation, wallet);
+  const tokens = [underlying, pool];
+  const balanceCalls = holders.flatMap(
+    (holder) => tokens.map((token) => ({ holder, token }))
+  );
+  const balanceContracts = balanceCalls.map(
+    ({ holder, token }) => ({
+      address: token,
+      abi: import_iERC20.ierc20Abi,
+      functionName: "balanceOf",
+      args: [holder]
+    })
+  );
+  const { functionName, amount } = previewRead(operation);
+  const previewContract = {
+    address: pool,
+    abi: import_generated.iPoolV310Abi,
+    functionName,
+    args: [amount]
+  };
+  let results;
+  try {
+    results = await sdk.client.multicall({
+      allowFailure: false,
+      // `undefined` lets viem read at `latest`; `blockNumber` is only set for
+      // testnet forks pinned to a specific block.
+      blockNumber,
+      contracts: [...balanceContracts, previewContract]
+    });
+  } catch (cause) {
+    throw new import_errors.PreviewSimulationError([
+      {
+        source: "multicall",
+        detail: (0, import_errors.decodeSimulationError)({
+          error: cause instanceof Error ? cause : new Error(String(cause))
+        })
+      }
+    ]);
+  }
+  const previewAmount = results[balanceContracts.length];
+  const balances = new import_sdk.AddressMap();
+  for (const [i, { holder, token }] of balanceCalls.entries()) {
+    const tokenBalances = balances.get(holder) ?? new import_sdk.AddressMap();
+    tokenBalances.upsert(token, results[i]);
+    balances.upsert(holder, tokenBalances);
+  }
+  const before = (token, holder) => balances.get(holder)?.get(token) ?? 0n;
+  return {
+    balanceChanges: computePoolOpBalanceChanges(
+      operation,
+      wallet,
+      previewAmount,
+      before
+    ),
+    transfers: void 0
+  };
+}
+function balanceLegs(operation, wallet, previewAmount) {
+  const { underlying, pool, receiver } = operation;
+  switch (operation.operation) {
+    case "Deposit":
+      return [
+        { address: wallet, token: underlying, delta: -operation.assets },
+        { address: receiver, token: pool, delta: previewAmount }
+      ];
+    case "Mint":
+      return [
+        { address: wallet, token: underlying, delta: -previewAmount },
+        { address: receiver, token: pool, delta: operation.shares }
+      ];
+    case "Withdraw":
+      return [
+        { address: operation.owner, token: pool, delta: -previewAmount },
+        { address: receiver, token: underlying, delta: operation.assets }
+      ];
+    case "Redeem":
+      return [
+        { address: operation.owner, token: pool, delta: -operation.shares },
+        { address: receiver, token: underlying, delta: previewAmount }
+      ];
+  }
+}
+function computePoolOpBalanceChanges(operation, wallet, previewAmount, before) {
+  const byAddress = new import_sdk.AddressMap();
+  for (const { address, token, delta } of balanceLegs(
+    operation,
+    wallet,
+    previewAmount
+  )) {
+    const beforeBalance = before(token, address);
+    const change = {
+      token,
+      before: beforeBalance,
+      after: beforeBalance + delta,
+      delta
+    };
+    const existing = byAddress.get(address);
+    if (existing) {
+      existing.changes.push(change);
+    } else {
+      byAddress.upsert(address, { address, changes: [change] });
+    }
+  }
+  return byAddress.values();
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  computePoolOpBalanceChanges,
+  simulatePoolOpMulticall
+});

package/dist/cjs/preview/simulate/simulatePoolOpV1.js

@@ -0,0 +1,106 @@
+"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 simulatePoolOpV1_exports = {};
+__export(simulatePoolOpV1_exports, {
+  simulatePoolOpV1: () => simulatePoolOpV1
+});
+module.exports = __toCommonJS(simulatePoolOpV1_exports);
+var import_actions = require("viem/actions");
+var import_iERC20 = require("../../abi/iERC20.js");
+var import_errors = require("./errors.js");
+var import_extractERC20Transfers = require("./extractERC20Transfers.js");
+var import_holders = require("./holders.js");
+async function simulatePoolOpV1(input, options = {}) {
+  const { sdk, operation, to, calldata, wallet } = input;
+  const { blockNumber } = options;
+  const { underlying, pool } = operation;
+  const holders = (0, import_holders.watchedHolders)(operation, wallet);
+  const tokens = [underlying, pool];
+  const balanceOf = (token, holder) => ({
+    to: token,
+    abi: import_iERC20.ierc20Abi,
+    functionName: "balanceOf",
+    args: [holder]
+  });
+  const balanceCalls = holders.flatMap(
+    (holder) => tokens.map((token) => balanceOf(token, holder))
+  );
+  let results;
+  try {
+    ({ results } = await (0, import_actions.simulateCalls)(sdk.client, {
+      account: wallet,
+      // `undefined` lets viem simulate at `latest`; `blockNumber` is only set
+      // for testnet forks pinned to a specific block.
+      blockNumber,
+      calls: [...balanceCalls, { to, data: calldata }, ...balanceCalls]
+    }));
+  } catch (cause) {
+    throw new import_errors.PreviewSimulationError([
+      {
+        source: "eth_simulateV1",
+        detail: (0, import_errors.decodeSimulationError)({
+          error: cause instanceof Error ? cause : new Error(String(cause))
+        })
+      }
+    ]);
+  }
+  const sim = results;
+  const txIndex = balanceCalls.length;
+  const afterOffset = txIndex + 1;
+  const txResult = sim[txIndex];
+  if (!txResult || txResult.status === "failure") {
+    throw new import_errors.PreviewSimulationError([
+      {
+        source: "eth_simulateV1",
+        detail: (0, import_errors.decodeSimulationError)({
+          error: txResult?.error,
+          data: txResult?.data
+        })
+      }
+    ]);
+  }
+  const balanceChanges = [];
+  for (const [holderIndex, address] of holders.entries()) {
+    const changes = [];
+    for (const [tokenIndex, token] of tokens.entries()) {
+      const slot = holderIndex * tokens.length + tokenIndex;
+      const before = readBalance(sim[slot]);
+      const after = readBalance(sim[afterOffset + slot]);
+      const delta = after - before;
+      const magnitude = delta >= 0n ? delta : -delta;
+      if (magnitude > 1n) {
+        changes.push({ token, before, after, delta });
+      }
+    }
+    if (changes.length > 0) {
+      balanceChanges.push({ address, changes });
+    }
+  }
+  return {
+    transfers: (0, import_extractERC20Transfers.extractERC20Transfers)(txResult.logs ?? [], holders),
+    balanceChanges
+  };
+}
+function readBalance(result) {
+  return result?.status === "success" ? result.result : 0n;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  simulatePoolOpV1
+});