Skip to content

docs(evm-simulation): sync README API surface with exports #868

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Foulks-Plb wants to merge 3 commits into
base: main
Choose a base branch
from
+14 −16
Open

docs(evm-simulation): sync README API surface with exports #868

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9ecd38a
docs(evm-simulation): sync README API surface with exports
Foulks-Plb Jul 10, 2026
5663e53
docs(evm-simulation): use published install command, not workspace range
Foulks-Plb Jul 10, 2026
d0ed114
docs(evm-simulation): drop inline comments from usage example
Foulks-Plb Jul 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 14 additions & 16 deletions packages/evm-simulation/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down