Add options for state changes output and json output in cast run command #9013

cassc · 2024-10-03T08:31:59Z

Motivation

The current human-readable output from cast run is great for manual interpretation but requires additional parsing to be used programmatically. Additionally, there is a need to inspect storage changes for each call, but currently, these changes are not recorded.

Solution

This PR introduces a -j option for cast run to output traces in JSON format, making it easier to consume programmatically. It also adds a --with-state-changes option that outputs storage changes.

Example usage:

cast run 0xefc789b63631b255aeb6f97d948c9eac14bae4b7f021122fe24c7c6e4f34667f \
  -r https://eth.llamarpc.com -q --decode-internal --with-state-changes -j | \
  jq -R 'select(try fromjson? | . != null) | fromjson'

…output-storage-change-and-json-output-for-cast-run

zerosnacks

Thanks for your PR, generally in favor of adding this

crates/verify/src/utils.rs

crates/evm/traces/src/lib.rs

crates/cast/bin/cmd/run.rs

…output-storage-change-and-json-output-for-cast-run

cassc · 2024-10-16T04:03:53Z

Hi everyone, please let me know if there's anything else I can do to help move this PR forward.

This PR writes the storage change in the trace. Example output when using cast run from [the PR](foundry-rs/foundry#9013): ``` ❯ cargo run --bin cast run 0xefc789b63631b255aeb6f97d948c9eac14bae4b7f021122fe24c7c6e4f34667f -r https://eth.llamarpc.com -q --decode-internal --with-state-changes Compiling: TransparentUpgradeableProxy 0x6bE457e04092B28865E0cBa84E3b2CFa0f871E67 Compiling: TransparentUpgradeableProxy 0x7a7f0b3c23C23a31cFcb0c44709be70d4D545c6e Compiling: TransparentUpgradeableProxy 0xD523794C879D9eC028960a231F866758e405bE34 Compiling: Pool 0xDEbbf61098642C7c06fAd1E116C1a00e50405D0d Traces: [247473] TransparentUpgradeableProxy::stake{value: 1949677189193480698}(1) ├─ [2232] TransparentUpgradeableProxy::_beforeFallback() │ ├─ [2150] ERC1967Upgrade::_getAdmin() │ │ └─ ← 0xD491302a6621128f4b5a6A49ce6657230732b0cb │ └─ ← ├─ [2196] ERC1967Proxy::_implementation() │ └─ ← 0xDEbbf61098642C7c06fAd1E116C1a00e50405D0d ├─ [240157] Pool::stake{value: 1949677189193480698}(1) [delegatecall] │ ├─ [213932] Pool::_stake(0x93386C72aa57082820Ad6Aa29998B820971a8d61, 1949677189193480698 [1.949e18]) │ │ ├─ [228681] TransparentUpgradeableProxy::deposit(0x93386C72aa57082820Ad6Aa29998B820971a8d61, 1949677189193480698 [1.949e18]) │ │ │ ├─ [2232] TransparentUpgradeableProxy::_beforeFallback() │ │ │ │ ├─ [2150] ERC1967Upgrade::_getAdmin() │ │ │ │ │ └─ ← 0xD491302a6621128f4b5a6A49ce6657230732b0cb │ │ │ │ └─ ← │ │ │ ├─ [2196] ERC1967Proxy::_implementation() │ │ │ │ └─ ← 0x1a5b89b2ef0028A059EAD7D9E648B533f87c8558 │ │ │ ├─ [221356] 0x1a5b89b2ef0028A059EAD7D9E648B533f87c8558::deposit(0x93386C72aa57082820Ad6Aa29998B820971a8d61, 1949677189193480698 [1.949e18]) [delegatecall] │ │ │ │ ├─ emit Update(: 1305166715630598691 [1.305e18], : 17341785000000000 [1.734e16], : 1926865000000000 [1.926e15]) │ │ │ │ ├─ [22215] TransparentUpgradeableProxy::reStake(17341785000000000 [1.734e16], 0) │ │ │ │ │ ├─ [2232] TransparentUpgradeableProxy::_beforeFallback() │ │ │ │ │ │ ├─ [2150] ERC1967Upgrade::_getAdmin() │ │ │ │ │ │ │ └─ ← 0xD491302a6621128f4b5a6A49ce6657230732b0cb │ │ │ │ │ │ └─ ← │ │ │ │ │ ├─ [2196] ERC1967Proxy::_implementation() │ │ │ │ │ │ └─ ← 0xbE3366a14D0c87094DEB6DFbA667299b4EaC489d │ │ │ │ │ ├─ [14896] 0xbE3366a14D0c87094DEB6DFbA667299b4EaC489d::reStake(17341785000000000 [1.734e16], 0) [delegatecall] │ │ │ │ │ │ ├─ [3266] TransparentUpgradeableProxy::restake{value: 17341785000000000}(0) │ │ │ │ │ │ │ ├─ [232] TransparentUpgradeableProxy::_beforeFallback() │ │ │ │ │ │ │ │ ├─ [150] ERC1967Upgrade::_getAdmin() │ │ │ │ │ │ │ │ │ └─ ← 0xD491302a6621128f4b5a6A49ce6657230732b0cb │ │ │ │ │ │ │ │ └─ ← │ │ │ │ │ │ │ ├─ [196] ERC1967Proxy::_implementation() │ │ │ │ │ │ │ │ └─ ← 0xDEbbf61098642C7c06fAd1E116C1a00e50405D0d │ │ │ │ │ │ │ ├─ [2450] Pool::restake{value: 17341785000000000}(0) [delegatecall] │ │ │ │ │ │ │ │ └─ ← [Stop] │ │ │ │ │ │ │ └─ ← [Return] │ │ │ │ │ │ └─ ← [Stop] │ │ │ │ │ └─ ← [Return] │ │ │ │ ├─ emit topic 0: 0xb0ec6c271a891e04f03d43bf454839acfbf574e269cb5599c1f70b9257cf9cd7 │ │ │ │ │ data: 0x000000000000000000000000000000000000000000000000003d9c42f6b23a00 │ │ │ │ ├─ emit topic 0: 0xc8724ec5e59eea00f3f35419c3139ead03ff07766e7e9cf00a62381692aac8c7 │ │ │ │ │ topic 1: 0x00000000000000000000000093386c72aa57082820ad6aa29998b820971a8d61 │ │ │ │ │ data: 0x0000000000000000000000000000000000000000000000001b0ea512e08f39fa │ │ │ │ ├─ storage write 0x7a7f0b3c23C23a31cFcb0c44709be70d4D545c6e [0x501d093c0316d001addb7dc8913312112ff29225e2343de5aed242436c83ecaf]: │ │ │ │ │ 0x0000000000000000000000000000000000000000000000000000000000000000 → 0x0000000000000000000000000000000000000000000000001b0ea512e08f39fa ... │ │ │ │ │ 0x0000000000000000000000000000000000000000000000000000000000000003 → 0x0000000000000000000000000000000000000000000000000000000000000004 │ │ │ │ ├─ storage write 0x7a7f0b3c23C23a31cFcb0c44709be70d4D545c6e [0xb4c87350b3618bf3b0453372aae234908cc3b6cf61d458f195edd9160dac1f7f]: │ │ │ │ │ 0x000000000000000000000000000000000000000000000000ce8cbfb644313c26 → 0x000000000000000000000000000000000000000000000000e9d9010c1b72b020 │ │ │ │ └─ ← [Return] 0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000 │ │ │ └─ ← [Return] 0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000 │ │ └─ ← │ ├─ emit StakeAdded(staker: 0x93386C72aa57082820Ad6Aa29998B820971a8d61, value: 1949677189193480698 [1.949e18], source: 1) │ └─ ← [Stop] └─ ← [Return] Transaction successfully executed. Gas used: 248777 ``` --------- Co-authored-by: DaniPopes <[email protected]>

cassc · 2024-10-18T03:51:40Z

For the CI error:

error: this function has too many arguments (9/7)
   --> crates/cli/src/utils/cmd.rs:357:1
    |
357 | / pub async fn handle_traces(
358 | |     mut result: TraceResult,
359 | |     config: &Config,
360 | |     chain: Option<Chain>,
...   |
366 | |     with_state_changes: bool,
367 | | ) -> Result<()> {
    | |_______________^

I believe we have a few options to address this:

Move the options debug, decode_internal, verbose, json, and with_state_changes into the Config struct.
Suppress the warning by adding #[allow(clippy::too_many_arguments)] to this function.
Extract the above 5 options into a new struct.

Please let me know your thoughts or suggestions.

grandizzy · 2024-10-18T06:24:08Z

Suppress the warning by adding #[allow(clippy::too_many_arguments)] to this function.

this should be fine IMO

grandizzy · 2024-10-18T06:25:11Z

Cargo.toml

@@ -174,7 +174,8 @@ solang-parser = "=0.3.3"
 ## revm
 revm = { version = "14.0.3", default-features = false }
 revm-primitives = { version = "10.0.0", default-features = false }
-revm-inspectors = { version = "0.8.0", features = ["serde"] }
+# Update this after the PR https://github.com/paradigmxyz/revm-inspectors/pull/213 is merged


this one was merged

it hasn't been included in the lastest release of revm-inspectors, should we wait for the next release first?

cassc added 3 commits October 3, 2024 16:20

Add options for state changes output and json output in cast run command

9bf8320

Merge remote-tracking branch 'foundry-rs/master' into add-options-to-…

dceddb0

…output-storage-change-and-json-output-for-cast-run

fix test

5546575

cassc marked this pull request as ready for review October 3, 2024 08:58

cassc requested review from DaniPopes, klkvr, mattsse, grandizzy, yash-atreya and zerosnacks as code owners October 3, 2024 08:58

add back serde_json in Cargo.lock

28ef6a9

zerosnacks requested changes Oct 3, 2024

View reviewed changes

crates/verify/src/utils.rs Outdated Show resolved Hide resolved

zerosnacks reviewed Oct 3, 2024

View reviewed changes

crates/evm/traces/src/lib.rs Outdated Show resolved Hide resolved

zerosnacks reviewed Oct 3, 2024

View reviewed changes

crates/cast/bin/cmd/run.rs Show resolved Hide resolved

cassc added 2 commits October 4, 2024 10:30

format using nightly

99a6914

rename parameter

c6ca2b6

cassc mentioned this pull request Oct 4, 2024

Write storage change in trace paradigmxyz/revm-inspectors#213

Merged

cassc added 2 commits October 7, 2024 14:26

update revm-inspectors

68f5887

Merge remote-tracking branch 'foundry-rs/master' into add-options-to-…

7bad232

…output-storage-change-and-json-output-for-cast-run

cassc requested a review from zerosnacks October 8, 2024 02:34

grandizzy reviewed Oct 18, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add options for state changes output and json output in cast run command #9013

Add options for state changes output and json output in cast run command #9013

cassc commented Oct 3, 2024

zerosnacks left a comment

cassc commented Oct 16, 2024

cassc commented Oct 18, 2024

grandizzy commented Oct 18, 2024

grandizzy Oct 18, 2024

cassc Oct 18, 2024

Add options for state changes output and json output in cast run command #9013

Are you sure you want to change the base?

Add options for state changes output and json output in cast run command #9013

Conversation

cassc commented Oct 3, 2024

Motivation

Solution

Example usage:

zerosnacks left a comment

Choose a reason for hiding this comment

cassc commented Oct 16, 2024

cassc commented Oct 18, 2024

grandizzy commented Oct 18, 2024

grandizzy Oct 18, 2024

Choose a reason for hiding this comment

cassc Oct 18, 2024

Choose a reason for hiding this comment