@morpho-org/evm-simulation 4.1.2 → 4.1.3

package/README.md

@@ -2,19 +2,13 @@
 
 ## Overview
 
-EVM transaction simulation engine for Morpho — bundle execution preview
-and transfer parsing.
+EVM transaction simulation engine for Morpho — bundle execution preview,
+transfer parsing, and net per-account balance changes.
 
 ## Installation
 
-Add to the consuming app's `package.json`:
-
-```jsonc
-{
-  "dependencies": {
-    "@morpho-org/evm-simulation": "workspace:*"
-  }
-}
+```bash
+pnpm add @morpho-org/evm-simulation
 ```
 
 ## Usage
@@ -40,11 +34,14 @@ const config: SimulationConfig = {
 };
 
 try {
-  const { transfers, simulationTxs } = await simulate(config, {
-    chainId: 1,
-    transactions: [{ from: user, to: vault, data: encodedDeposit }],
-    authorizations: [{ type: "signature", token: usdc, spender: vault }],
-  });
+  const { simulationTxs, calls, transfers, assetChanges } = await simulate(
+    config,
+    {
+      chainId: 1,
+      transactions: [{ from: user, to: vault, data: encodedDeposit }],
+      authorizations: [{ type: "signature", token: usdc, spender: vault }],
+    },
+  );
 } catch (err) {
   if (err instanceof SimulationRevertedError) {
     // show err.reason to the user
@@ -61,7 +58,8 @@ All symbols below are re-exported from the package root.
 
 - `simulate(config, params)` — run a bundle through the simulation pipeline.
 - Config types: `SimulationConfig`, `TenderlyRpcConfig`, `ChainSimulationConfig`, `SimulationLogger`.
-- Data types: `SimulationTransaction`, `SimulationAuthorization`, `Transfer`, `SimulateParams`, `SimulationResult`.
+- Input types: `SimulateParams`, `SimulationTransaction`, `SimulationAuthorization`.
+- Result types: `SimulationResult`, `SimulationCall`, `Transfer`, `AccountAssetChanges`, `AssetChange`, `RawLog`.
 - Errors: `SimulationPackageError` (abstract base — `instanceof` it to catch any package error), `SimulationRevertedError`, `BlacklistViolationError`, `ExternalServiceError`, `SimulationValidationError`, `UnsupportedChainError`.
 
 ### Deeper docs

package/lib/cjs/errors.d.ts

@@ -10,9 +10,9 @@ export declare abstract class SimulationPackageError extends Error {
 /** Transaction would revert on-chain. Not bypassable. */
 export declare class SimulationRevertedError extends SimulationPackageError {
     readonly reason: string | undefined;
-    readonly details?: unknown | undefined;
+    readonly details?: unknown;
     readonly code = "SIMULATION_REVERTED";
-    constructor(reason: string | undefined, details?: unknown | undefined);
+    constructor(reason: string | undefined, details?: unknown);
 }
 interface RetainedAsset {
     address: string | undefined;

package/lib/cjs/simulate/simulate.d.ts

@@ -10,7 +10,8 @@ import type { SimulateParams, SimulationConfig, SimulationResult } from "../type
  * - `transfers` → user-facing preview / server-side verification.
  * - `simulationTxs` + `transfers` → server-side verification before broadcast.
  * - `calls[i]` → per-tx raw backend output (`logs`, `status`, `returnData`, `gasUsed`).
- *   Aligned 1:1 with `simulationTxs[i]`.
+ *   Aligned 1:1 with `simulationTxs[i]`. `gasUsed` is not a safe gas limit; consumers
+ *   deriving one must add their own headroom.
  * - `assetChanges` → net per-asset balance changes grouped by account (sender and
  *   counterparties) over the whole bundle, normalized to the same shape across backends.
  * - `transfers[k].txIdx` → index into `simulationTxs` of the tx that emitted the

package/lib/cjs/simulate/simulate.js

@@ -15,7 +15,8 @@ const index_js_2 = require("./pipeline/index.js");
  * - `transfers` → user-facing preview / server-side verification.
  * - `simulationTxs` + `transfers` → server-side verification before broadcast.
  * - `calls[i]` → per-tx raw backend output (`logs`, `status`, `returnData`, `gasUsed`).
- *   Aligned 1:1 with `simulationTxs[i]`.
+ *   Aligned 1:1 with `simulationTxs[i]`. `gasUsed` is not a safe gas limit; consumers
+ *   deriving one must add their own headroom.
  * - `assetChanges` → net per-asset balance changes grouped by account (sender and
  *   counterparties) over the whole bundle, normalized to the same shape across backends.
  * - `transfers[k].txIdx` → index into `simulationTxs` of the tx that emitted the

package/lib/cjs/types.d.ts

@@ -201,6 +201,11 @@ export interface SimulationCall {
     readonly status: boolean;
     /** Return data from the top-level call. */
     readonly returnData: Hex;
-    /** Gas used by this call (root frame). */
+    /**
+     * Gas consumed by this call's root frame, not a safe gas limit. This is
+     * post-refund consumption and does not account for EIP-150's 63/64 rule in
+     * nested calls, so consumers deriving a limit must add their own headroom,
+     * larger than headroom derived from `eth_estimateGas`.
+     */
     readonly gasUsed: bigint;
 }

package/lib/esm/errors.d.ts

@@ -10,9 +10,9 @@ export declare abstract class SimulationPackageError extends Error {
 /** Transaction would revert on-chain. Not bypassable. */
 export declare class SimulationRevertedError extends SimulationPackageError {
     readonly reason: string | undefined;
-    readonly details?: unknown | undefined;
+    readonly details?: unknown;
     readonly code = "SIMULATION_REVERTED";
-    constructor(reason: string | undefined, details?: unknown | undefined);
+    constructor(reason: string | undefined, details?: unknown);
 }
 interface RetainedAsset {
     address: string | undefined;

package/lib/esm/simulate/simulate.d.ts

@@ -10,7 +10,8 @@ import type { SimulateParams, SimulationConfig, SimulationResult } from "../type
  * - `transfers` → user-facing preview / server-side verification.
  * - `simulationTxs` + `transfers` → server-side verification before broadcast.
  * - `calls[i]` → per-tx raw backend output (`logs`, `status`, `returnData`, `gasUsed`).
- *   Aligned 1:1 with `simulationTxs[i]`.
+ *   Aligned 1:1 with `simulationTxs[i]`. `gasUsed` is not a safe gas limit; consumers
+ *   deriving one must add their own headroom.
  * - `assetChanges` → net per-asset balance changes grouped by account (sender and
  *   counterparties) over the whole bundle, normalized to the same shape across backends.
  * - `transfers[k].txIdx` → index into `simulationTxs` of the tx that emitted the

package/lib/esm/simulate/simulate.js

@@ -12,7 +12,8 @@ import { assertNoBundlerRetention, buildSimulationTxs, executeSimulation, valida
  * - `transfers` → user-facing preview / server-side verification.
  * - `simulationTxs` + `transfers` → server-side verification before broadcast.
  * - `calls[i]` → per-tx raw backend output (`logs`, `status`, `returnData`, `gasUsed`).
- *   Aligned 1:1 with `simulationTxs[i]`.
+ *   Aligned 1:1 with `simulationTxs[i]`. `gasUsed` is not a safe gas limit; consumers
+ *   deriving one must add their own headroom.
  * - `assetChanges` → net per-asset balance changes grouped by account (sender and
  *   counterparties) over the whole bundle, normalized to the same shape across backends.
  * - `transfers[k].txIdx` → index into `simulationTxs` of the tx that emitted the

package/lib/esm/types.d.ts

@@ -201,6 +201,11 @@ export interface SimulationCall {
     readonly status: boolean;
     /** Return data from the top-level call. */
     readonly returnData: Hex;
-    /** Gas used by this call (root frame). */
+    /**
+     * Gas consumed by this call's root frame, not a safe gas limit. This is
+     * post-refund consumption and does not account for EIP-150's 63/64 rule in
+     * nested calls, so consumers deriving a limit must add their own headroom,
+     * larger than headroom derived from `eth_estimateGas`.
+     */
     readonly gasUsed: bigint;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@morpho-org/evm-simulation",
   "description": "EVM simulation engine for Morpho transactions.",
-  "version": "4.1.2",
+  "version": "4.1.3",
   "author": "Morpho Association <contact@morpho.org>",
   "contributors": [
     "Rubilmax <rmilon@gmail.com>"
@@ -25,17 +25,17 @@
   ],
   "dependencies": {
     "zod": "^4.4.3",
-    "@morpho-org/blue-sdk": "^6.3.1",
-    "@morpho-org/morpho-ts": "^2.8.0"
+    "@morpho-org/blue-sdk": "^6.5.0",
+    "@morpho-org/morpho-ts": "^2.9.0"
   },
   "peerDependencies": {
     "viem": "^2.0.0"
   },
   "devDependencies": {
-    "typescript": "^6.0.3",
-    "viem": "^2.54.2",
-    "vitest": "^4.1.9",
-    "@morpho-org/test": "^2.8.2"
+    "typescript": "^7.0.2",
+    "viem": "^2.55.10",
+    "vitest": "^4.1.10",
+    "@morpho-org/test": "^2.8.4"
   },
   "scripts": {
     "prepublish": "$npm_execpath build",