feat(cheatcodes): add getRecordedLogsJson cheatcode #13093
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adds a new cheatcode `getRecordedLogsJson` that returns recorded logs
as a JSON string, similar to the existing `getStateDiffJson` pattern.
This allows users to easily post-process recorded logs externally without
needing to manually transform the Log[] array to JSON.
JSON format:
```json
[{"topics": ["0x..."], "data": "0x...", "emitter": "0x..."}]
```
Closes #12854
grandizzy
requested review from
0xrusowsky,
DaniPopes,
mattsse,
onbjerg and
zerosnacks
as code owners
zerosnacks
approved these changes
Jan 15, 2026
Contributor
|
Hey, I'm a bit confused - how can i use this on latest nightly? Do i need to wait for a release of forge-std, as it seems to not to be available yet. |
Contributor
|
Added a pr here foundry-rs/forge-std#809 as i think it's missing (on docs it is mentioned, but seems to not exist) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Adds a new cheatcode
getRecordedLogsJsonthat returns recorded logs as a JSON string, similar to the existinggetStateDiffJsonpattern.This allows users to easily post-process recorded logs externally without needing to manually transform the
Log[]array to JSON.Motivation
Closes #12854
Users heavily rely on log analysis for simulation and auditing purposes. Currently they have to use
recordLogs-> custom transform to JSON ->writeJson, which is cumbersome. This cheatcode provides a native way to get recorded logs as JSON for external processing.JSON Format
[ { "topics": ["0x...", "0x..."], "data": "0x...", "emitter": "0x..." } ]All binary fields are hex-encoded with
0xprefix.Changes
getRecordedLogsJson()function declaration invm.rsLogJsonstruct for JSON serializationgetStateDiffJsonTesting
testRecordedLogsJson: Verifies emitter address, topics (event signature + indexed args), and hex-encoded datatestRecordedLogsJsonEmpty: Verifies empty logs returns[]