@morpho-org/evm-simulation 5.0.1 → 6.0.0

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

@@ -4,11 +4,11 @@ import type { SimulationConfig } from "../types.js";
 /**
  * Simulate a bundle of EVM transactions.
  *
- * Parses and normalizes the request → resolves the chain identity → resolves
- * a single pinned block → resolves quoted-asset metadata → plans state reads
- * and the execution → executes once through `eth_simulateV1` under the full
- * timeout budget (simulation with in-block state reads → response parsing →
- * reorg check) → derives ERC20/WETH9 transfers and net asset changes from the
+ * Parses and normalizes the request → resolves a single pinned block (skipped
+ * when `params.block` is supplied) → resolves quoted-asset metadata → plans
+ * state reads and the execution → executes once through `eth_simulateV1` under
+ * the full timeout budget (simulation with in-block state reads → response
+ * parsing) → derives ERC20/WETH9 transfers and net asset changes from the
  * user calls only → decodes quoted balances/positions → runs slippage checks
  * → asserts no funds are retained by standalone `bundles` periphery contracts
  * → returns the result. The caller reads whichever fields they need:
@@ -37,10 +37,13 @@ import type { SimulationConfig } from "../types.js";
  * separating gas from economic effects. Monad nodes reject `false`, so Monad
  * simulations send `true`; its simulated block charges no gas either way.
  *
- * @param config - Required per-chain `eth_simulateV1` URL, optional logger, and
- *   the overall timeout budget.
+ * @param config - Required per-chain `eth_simulateV1` URL, optional per-chain
+ *   `blockOverrides.gasLimit` and `parentHashCheck`, optional logger, and the
+ *   overall timeout budget.
  * @param params - Per-call simulation input.
- * @param params.chainId - Chain id the bundle targets; must match the endpoint.
+ * @param params.chainId - Chain id the bundle targets. Sent on every call inside
+ *   `eth_simulateV1`, so nodes that check it reject a wrong-chain endpoint;
+ *   there is no separate `eth_chainId` lookup.
  * @param params.transactions - The bundle's transactions, in execution order.
  *   All must share the same `from`.
  * @param params.mode - `"final"` (default) or `"preview"`.
@@ -50,9 +53,16 @@ import type { SimulationConfig } from "../types.js";
  *   than `"pending"`.
  *   Defaults to `latest` (`finalized` on Monad, whose `latest` block is not
  *   final), resolved exactly once.
+ * @param params.block - Optional caller-supplied state block (`number`,
+ *   `hash`, `timestamp`). Skips the block lookup, so a simulation without
+ *   asset metadata reads makes a single `eth_simulateV1` request. Cannot be
+ *   combined with `blockNumber`.
  * @throws {SimulationValidationError} for invalid input (mixed senders, bad
  *   addresses, empty transactions, malformed authorizations, final-mode
- *   authorizations, malformed limits, unknown fields, a `"pending"` block tag, or share quotes for
+ *   authorizations, malformed limits, unknown fields, a `"pending"` block tag,
+ *   a malformed `block` or one combined with `blockNumber`, a
+ *   `blockOverrides.gasLimit` that is not a positive bigint, a `parentHashCheck`
+ *   that is not a boolean, or share quotes for
  *   `blueSupplyCollateral` / `blueWithdrawCollateral`).
  * @throws {ConsumerLimitViolationError} when a declared `limits` bound is
  *   violated by the observed effects.
@@ -66,20 +76,21 @@ import type { SimulationConfig } from "../types.js";
  * @throws {InvalidSimulationResponseError} when the node response cannot be
  *   trusted (bad shape, call-count mismatch, block that is neither the pinned
  *   state block nor its immediate successor, a successor with a mismatched
- *   `parentHash`, a block timestamp earlier than the pinned block's, a
- *   malformed per-call result, a quoted balance/position read whose non-empty
- *   return data cannot be decoded, a state-block hash that changed or a pinned
- *   block that vanished mid-flight, or an
- *   endpoint whose `eth_chainId` differs from `params.chainId`; chain identity
- *   is checked before any block lookup).
+ *   `parentHash` (unless `parentHashCheck` is off; off by default on Stable,
+ *   chain 988), a block timestamp earlier than the pinned block's, a
+ *   malformed per-call result, or a quoted balance/position read whose
+ *   non-empty return data cannot be decoded).
+ * @throws {InvalidChainIdError} when the node rejects the request `chainId`
+ *   because the endpoint serves another chain (a subclass of
+ *   `InvalidSimulationResponseError` sharing its `name`/`code`;
+ *   `instanceof InvalidChainIdError` tells them apart). Never bypassable.
  * @throws {BlacklistViolationError} when the simulation leaves value retained
  *   beyond the dust threshold by a `bundles` periphery contract
- *   (VaultExitBundlesV1, VaultBundlesV1, BlueBundlesV1, MidnightBundlesV1).
+ *   (VaultExitBundlesV1, VaultBundlesV1, BlueBundlesV1, MidnightBundlesV2).
  *   Never bypassable.
  * @throws {ExternalServiceError} when the RPC is unavailable within the
- *   timeout budget or returns a malformed JSON-RPC envelope. Chain-id
- *   mismatches and a state block without number/hash are reported as
- *   `InvalidSimulationResponseError`.
+ *   timeout budget or returns a malformed JSON-RPC envelope. A looked-up state
+ *   block without number/hash is reported as `InvalidSimulationResponseError`.
  * @returns A frozen {@link VerifiedSimulationResult} carrying the normalized
  *   `simulationTxs`, per-tx `calls` (aligned 1:1), parsed `transfers` (each
  *   stamped with `txIdx`), per-account net `assetChanges`, and per-operation

package/lib/esm/simulate/simulate.js

@@ -3,11 +3,11 @@ import { runSimulation } from "./run-simulation.js";
 /**
  * Simulate a bundle of EVM transactions.
  *
- * Parses and normalizes the request → resolves the chain identity → resolves
- * a single pinned block → resolves quoted-asset metadata → plans state reads
- * and the execution → executes once through `eth_simulateV1` under the full
- * timeout budget (simulation with in-block state reads → response parsing →
- * reorg check) → derives ERC20/WETH9 transfers and net asset changes from the
+ * Parses and normalizes the request → resolves a single pinned block (skipped
+ * when `params.block` is supplied) → resolves quoted-asset metadata → plans
+ * state reads and the execution → executes once through `eth_simulateV1` under
+ * the full timeout budget (simulation with in-block state reads → response
+ * parsing) → derives ERC20/WETH9 transfers and net asset changes from the
  * user calls only → decodes quoted balances/positions → runs slippage checks
  * → asserts no funds are retained by standalone `bundles` periphery contracts
  * → returns the result. The caller reads whichever fields they need:
@@ -36,10 +36,13 @@ import { runSimulation } from "./run-simulation.js";
  * separating gas from economic effects. Monad nodes reject `false`, so Monad
  * simulations send `true`; its simulated block charges no gas either way.
  *
- * @param config - Required per-chain `eth_simulateV1` URL, optional logger, and
- *   the overall timeout budget.
+ * @param config - Required per-chain `eth_simulateV1` URL, optional per-chain
+ *   `blockOverrides.gasLimit` and `parentHashCheck`, optional logger, and the
+ *   overall timeout budget.
  * @param params - Per-call simulation input.
- * @param params.chainId - Chain id the bundle targets; must match the endpoint.
+ * @param params.chainId - Chain id the bundle targets. Sent on every call inside
+ *   `eth_simulateV1`, so nodes that check it reject a wrong-chain endpoint;
+ *   there is no separate `eth_chainId` lookup.
  * @param params.transactions - The bundle's transactions, in execution order.
  *   All must share the same `from`.
  * @param params.mode - `"final"` (default) or `"preview"`.
@@ -49,9 +52,16 @@ import { runSimulation } from "./run-simulation.js";
  *   than `"pending"`.
  *   Defaults to `latest` (`finalized` on Monad, whose `latest` block is not
  *   final), resolved exactly once.
+ * @param params.block - Optional caller-supplied state block (`number`,
+ *   `hash`, `timestamp`). Skips the block lookup, so a simulation without
+ *   asset metadata reads makes a single `eth_simulateV1` request. Cannot be
+ *   combined with `blockNumber`.
  * @throws {SimulationValidationError} for invalid input (mixed senders, bad
  *   addresses, empty transactions, malformed authorizations, final-mode
- *   authorizations, malformed limits, unknown fields, a `"pending"` block tag, or share quotes for
+ *   authorizations, malformed limits, unknown fields, a `"pending"` block tag,
+ *   a malformed `block` or one combined with `blockNumber`, a
+ *   `blockOverrides.gasLimit` that is not a positive bigint, a `parentHashCheck`
+ *   that is not a boolean, or share quotes for
  *   `blueSupplyCollateral` / `blueWithdrawCollateral`).
  * @throws {ConsumerLimitViolationError} when a declared `limits` bound is
  *   violated by the observed effects.
@@ -65,20 +75,21 @@ import { runSimulation } from "./run-simulation.js";
  * @throws {InvalidSimulationResponseError} when the node response cannot be
  *   trusted (bad shape, call-count mismatch, block that is neither the pinned
  *   state block nor its immediate successor, a successor with a mismatched
- *   `parentHash`, a block timestamp earlier than the pinned block's, a
- *   malformed per-call result, a quoted balance/position read whose non-empty
- *   return data cannot be decoded, a state-block hash that changed or a pinned
- *   block that vanished mid-flight, or an
- *   endpoint whose `eth_chainId` differs from `params.chainId`; chain identity
- *   is checked before any block lookup).
+ *   `parentHash` (unless `parentHashCheck` is off; off by default on Stable,
+ *   chain 988), a block timestamp earlier than the pinned block's, a
+ *   malformed per-call result, or a quoted balance/position read whose
+ *   non-empty return data cannot be decoded).
+ * @throws {InvalidChainIdError} when the node rejects the request `chainId`
+ *   because the endpoint serves another chain (a subclass of
+ *   `InvalidSimulationResponseError` sharing its `name`/`code`;
+ *   `instanceof InvalidChainIdError` tells them apart). Never bypassable.
  * @throws {BlacklistViolationError} when the simulation leaves value retained
  *   beyond the dust threshold by a `bundles` periphery contract
- *   (VaultExitBundlesV1, VaultBundlesV1, BlueBundlesV1, MidnightBundlesV1).
+ *   (VaultExitBundlesV1, VaultBundlesV1, BlueBundlesV1, MidnightBundlesV2).
  *   Never bypassable.
  * @throws {ExternalServiceError} when the RPC is unavailable within the
- *   timeout budget or returns a malformed JSON-RPC envelope. Chain-id
- *   mismatches and a state block without number/hash are reported as
- *   `InvalidSimulationResponseError`.
+ *   timeout budget or returns a malformed JSON-RPC envelope. A looked-up state
+ *   block without number/hash is reported as `InvalidSimulationResponseError`.
  * @returns A frozen {@link VerifiedSimulationResult} carrying the normalized
  *   `simulationTxs`, per-tx `calls` (aligned 1:1), parsed `transfers` (each
  *   stamped with `txIdx`), per-account net `assetChanges`, and per-operation

package/lib/esm/types.d.ts

@@ -3,6 +3,21 @@ import type { Address, Hex } from "viem";
 export interface ChainSimulationConfig {
     /** JSON-RPC URL supporting `eth_simulateV1`. Required for every configured chain. */
     readonly simulateV1Url: string;
+    /**
+     * Block overrides forwarded to `eth_simulateV1` as the simulated block's
+     * `blockOverrides`. Omitted fields leave the node's defaults untouched.
+     */
+    readonly blockOverrides?: {
+        /** Gas limit of the simulated block. Omitted: no gas limit override is sent. */
+        readonly gasLimit?: bigint;
+    };
+    /**
+     * Whether a simulated successor block's `parentHash` must equal the pinned
+     * state block hash. Block number and timestamp checks always run.
+     * Omitted: on everywhere except Stable (988), whose nodes report a
+     * `parentHash` that never matches the pinned block.
+     */
+    readonly parentHashCheck?: boolean;
 }
 /**
  * Top-level configuration for `simulate`.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@morpho-org/evm-simulation",
   "description": "EVM simulation engine for Morpho transactions.",
-  "version": "5.0.1",
+  "version": "6.0.0",
   "author": "Morpho Association <contact@morpho.org>",
   "repository": {
     "type": "git",
@@ -21,9 +21,9 @@
     "lib"
   ],
   "dependencies": {
-    "@morpho-org/blue-sdk": "^7.2.0",
-    "@morpho-org/morpho-sdk": "^6.6.0",
-    "@morpho-org/morpho-ts": "^3.2.1"
+    "@morpho-org/blue-sdk": "^8.0.0",
+    "@morpho-org/morpho-sdk": "^7.0.0",
+    "@morpho-org/morpho-ts": "^4.0.0"
   },
   "peerDependencies": {
     "viem": "^2.0.0"