feat(forge, cast): add `cast --with_local_artifacts`/`forge selectors cache` to trace with local artifacts #7359

byteshijinn · 2024-03-10T14:52:00Z

Motivation

Closes #8949
Closes #8581
Supply a fast way to add all project contracts functions and events to signatures makes them decode correctly.

Solution

This PR introduces such a possibility using a cli argument --generate-local-signatures for cast run.

mattsse

supportive, though we can solve this a bit differently

lmk if anything's unclear

crates/cast/bin/cmd/run.rs

byteshijinn · 2024-03-17T14:47:54Z

I updated my code. please check again @mattsse

mattsse

sorry this one slipped through,
some nits.

generally supportive, wdyt @DaniPopes @klkvr

crates/cli/src/utils/cmd.rs

crates/cast/bin/cmd/run.rs

crates/cli/src/utils/cmd.rs

mattsse · 2024-07-09T14:48:52Z

how to proceed here @klkvr ?

klkvr · 2024-07-09T15:27:51Z

crates/cli/src/utils/cmd.rs

+                | NamedChain::ArbitrumTestnet
+                | NamedChain::ArbitrumGoerli
+                | NamedChain::ArbitrumSepolia
+                | NamedChain::Moonbeam


please remove all the formatting changes

sorry for my mistakes, I will fix it

klkvr · 2024-07-09T15:33:15Z

crates/cli/src/utils/cmd.rs

+        let cache_contents = std::fs::read_to_string(path.clone()).unwrap();
+        match serde_json::from_str::<CachedSignatures>(&cache_contents) {
+            Ok(existed_signatures) => cached_signatures = existed_signatures,
+            Err(e) => {
+                println!("parse cached local signatures file error: {}", e);
+            }
+        }
+        dbg!(&cached_signatures);


this is now duplicated with SignatureIdentifier::new, can we move this logic to CachedSignatures::load(path)

klkvr · 2024-07-09T15:44:29Z

So this can be broken into 2 separate usecases

Have a way to flush selectors from local project contracts into global signature cache (forge build --cache_local_signatures). Current impl lgtm, however, wondering if it makes more sense to be forge selectors cache instead?
Use local ABIs when decoding call trace from cast run. For this usecase I'd prefer a different implementation which would obtain Project, compile it, construct known_contracts and include them in both CallTraceDecoder and TraceIdentifiers similarly to how it's done in forge test:

foundry/crates/forge/bin/cmd/test/mod.rs

Line 402 in b1b8151

let mut identifier = TraceIdentifiers::new().with_local(&known_contracts);

The motivation is that if we have an entire Project, then we can not only use artifacts for identification of selectors, but also to resolve return values of functions, and identify contracts by their bytecodes. ref tracing: Improve decoding of functions output #6531 which had similar motivation

…racts functions and events

merge project signatures with exists cached local signatures instead of just override them

byteshijinn · 2024-07-12T14:30:58Z

So this can be broken into 2 separate usecases

Have a way to flush selectors from local project contracts into global signature cache (forge build --cache_local_signatures). Current impl lgtm, however, wondering if it makes more sense to be forge selectors cache instead?

Use local ABIs when decoding call trace from cast run. For this usecase I'd prefer a different implementation which would obtain Project, compile it, construct known_contracts and include them in both CallTraceDecoder and TraceIdentifiers similarly to how it's done in forge test:

foundry/crates/forge/bin/cmd/test/mod.rs

Line 402 in b1b8151

let mut identifier = TraceIdentifiers::new().with_local(&known_contracts);

The motivation is that if we have an entire Project, then we can not only use artifacts for identification of selectors, but also to resolve return values of functions, and identify contracts by their bytecodes. ref tracing: Improve decoding of functions output #6531 which had similar motivation

For case 1, I believe having helper options in forge build and cast run would make this feature more noticeable. I think adding a command to clear the cache would be useful because SignatureIdentifier merges matched signatures into the cache. My previous tests showed that if a local signature is matched, even if the parameters do not match, it still displays the matched function name.

For case 2, I have considered the solution you mentioned. However, the changes involved are quite extensive and a bit difficult for me, which is why I chose the current method. It allows me to get it working quickly.

…end traces

grandizzy · 2024-11-21T10:50:49Z

thanks @byteshijinn ! I made following changes and updated the PR:

merged with latest master
flush selectors from local project contracts into global signature cache through forge selectors cache instead forge build
use local ABIs when decoding call trace from cast run and cast send (--with_local_artifacts or --la)
cast test

tested locally as:

start anvil
deploy contract
send tx (custom errors, events)
run cast run tx - no traces shown. run cast run tx --la showing decoded traces (contracts identified)
run forge selectors cache, then run cast run tx --la showing decoded traces (contracts not identified though)

@klkvr mind to review? thank you!

klkvr

nice, a couple nits

crates/cli/src/utils/cmd.rs

- compile without quiet, fix test - merge local sources with etherscan

klkvr

last nit

crates/evm/traces/src/debug/sources.rs

Co-authored-by: Arsenii Kulikov <klkvrr@gmail.com>

changes accomodated

… cache` to trace with local artifacts (foundry-rs#7359) * add RunArgs generate_local_signatures to enable trace with local contracts functions and events * make generate_local_signatures as a helper function * rename generate_local_signatures to cache_local_signatures merge project signatures with exists cached local signatures instead of just override them * extract duplicate method for CachedSignatures * fix cache load path * fix for lint * fix fot lint * remove unnecessary `let` binding * fix for format check * fix for clippy check * fix for clippy check * Move cache in forge selectors, use local artifacts for cast run and send traces * Add test * Review changes: - compile without quiet, fix test - merge local sources with etherscan * Update crates/evm/traces/src/debug/sources.rs Co-authored-by: Arsenii Kulikov <klkvrr@gmail.com> --------- Co-authored-by: grandizzy <grandizzy.the.egg@gmail.com> Co-authored-by: grandizzy <38490174+grandizzy@users.noreply.github.com> Co-authored-by: Arsenii Kulikov <klkvrr@gmail.com>

byteshijinn requested review from DaniPopes and mattsse as code owners March 10, 2024 14:52

mattsse requested changes Mar 12, 2024

View reviewed changes

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

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

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

byteshijinn force-pushed the master branch 2 times, most recently from 2a08d1c to 4f0ee53 Compare March 17, 2024 14:18

byteshijinn requested a review from mattsse March 23, 2024 03:35

byteshijinn changed the title ~~add RunArgs generate_local_signatures to enable trace with local contracts functions and events~~ feat(forge, cast): add RunArgs generate_local_signatures to enable trace with local contracts functions and events Apr 20, 2024

byteshijinn requested a review from Evalir as a code owner June 30, 2024 12:00

byteshijinn force-pushed the master branch from 17a6f74 to 759a009 Compare June 30, 2024 13:19

mattsse previously requested changes Jul 1, 2024

View reviewed changes

crates/cli/src/utils/cmd.rs Outdated Show resolved Hide resolved

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

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

klkvr reviewed Jul 1, 2024

View reviewed changes

crates/cli/src/utils/cmd.rs Outdated Show resolved Hide resolved

byteshijinn force-pushed the master branch from 759a009 to 273a62e Compare July 6, 2024 08:57

mattsse requested a review from klkvr July 9, 2024 14:43

klkvr reviewed Jul 9, 2024

View reviewed changes

byteshijinn force-pushed the master branch 2 times, most recently from 825579e to c575b2d Compare July 10, 2024 16:59

add RunArgs generate_local_signatures to enable trace with local cont…

19f0b13

…racts functions and events

byteshijinn force-pushed the master branch from 584af8d to c575b2d Compare July 12, 2024 14:10

byteshijinn added 3 commits July 12, 2024 22:12

make generate_local_signatures as a helper function

093ea83

rename generate_local_signatures to cache_local_signatures

82e7c67

merge project signatures with exists cached local signatures instead of just override them

extract duplicate method for CachedSignatures

fa0d4de

byteshijinn force-pushed the master branch from c575b2d to fa0d4de Compare July 12, 2024 14:13

byteshijinn added 3 commits July 12, 2024 23:37

Merge branch 'master' into master

e00d358

Merge branch 'master' into master

81f7c5f

Merge branch 'master' into master

d34f2a3

byteshijinn added 4 commits September 7, 2024 23:42

fix for format check

e0f35f9

fix for clippy check

ebc10c8

fix for clippy check

7325872

merge master

54b7e83

byteshijinn requested review from grandizzy, yash-atreya and zerosnacks as code owners September 29, 2024 14:28

byteshijinn and others added 3 commits October 1, 2024 13:45

merge master

cf40ea6

Merge branch 'master' into local-changes

6502c22

Move cache in forge selectors, use local artifacts for cast run and s…

df9f753

…end traces

grandizzy changed the title ~~feat(forge, cast): add RunArgs generate_local_signatures to enable trace with local contracts functions and events~~ feat(forge, cast): add cast --with_local_artifacts/forge selectors cache to trace with local artifacts Nov 21, 2024

grandizzy added 2 commits November 22, 2024 09:39

Add test

38aef61

Merge branch 'master' into local-changes

0420857

grandizzy requested a review from mattsse November 22, 2024 07:58

klkvr requested changes Nov 22, 2024

View reviewed changes

crates/cli/src/utils/cmd.rs Outdated Show resolved Hide resolved

crates/cli/src/utils/cmd.rs Outdated Show resolved Hide resolved

grandizzy added 2 commits November 22, 2024 14:27

Review changes:

6cec5eb

- compile without quiet, fix test - merge local sources with etherscan

Merge branch 'master' into local-changes

a444842

grandizzy requested a review from klkvr November 22, 2024 12:44

klkvr requested changes Nov 22, 2024

View reviewed changes

crates/evm/traces/src/debug/sources.rs Outdated Show resolved Hide resolved

grandizzy and others added 2 commits November 22, 2024 17:35

Update crates/evm/traces/src/debug/sources.rs

a40f5f9

Co-authored-by: Arsenii Kulikov <klkvrr@gmail.com>

Merge branch 'master' into local_signature

2acc33a

grandizzy requested a review from klkvr November 22, 2024 15:52

klkvr approved these changes Nov 22, 2024

View reviewed changes

klkvr enabled auto-merge (squash) November 22, 2024 15:54

klkvr merged commit 398ef4a into foundry-rs:master Nov 22, 2024
21 checks passed

grandizzy added the T-feature Type: feature label Dec 18, 2024

byteshijinn deleted the local_signature branch January 11, 2025 06:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(forge, cast): add `cast --with_local_artifacts`/`forge selectors cache` to trace with local artifacts #7359

feat(forge, cast): add `cast --with_local_artifacts`/`forge selectors cache` to trace with local artifacts #7359

byteshijinn commented Mar 10, 2024 •

edited by grandizzy

Loading

mattsse left a comment

byteshijinn commented Mar 17, 2024

mattsse left a comment

mattsse commented Jul 9, 2024

klkvr Jul 9, 2024 •

edited

Loading

byteshijinn Jul 10, 2024

klkvr Jul 9, 2024

klkvr commented Jul 9, 2024 •

edited

Loading

byteshijinn commented Jul 12, 2024

grandizzy commented Nov 21, 2024 •

edited

Loading

klkvr left a comment

klkvr left a comment

feat(forge, cast): add cast --with_local_artifacts/forge selectors cache to trace with local artifacts #7359

feat(forge, cast): add cast --with_local_artifacts/forge selectors cache to trace with local artifacts #7359

Conversation

byteshijinn commented Mar 10, 2024 • edited by grandizzy Loading

Motivation

Solution

mattsse left a comment

Choose a reason for hiding this comment

byteshijinn commented Mar 17, 2024

mattsse left a comment

Choose a reason for hiding this comment

mattsse commented Jul 9, 2024

klkvr Jul 9, 2024 • edited Loading

Choose a reason for hiding this comment

byteshijinn Jul 10, 2024

Choose a reason for hiding this comment

klkvr Jul 9, 2024

Choose a reason for hiding this comment

klkvr commented Jul 9, 2024 • edited Loading

byteshijinn commented Jul 12, 2024

grandizzy commented Nov 21, 2024 • edited Loading

klkvr left a comment

Choose a reason for hiding this comment

klkvr left a comment

Choose a reason for hiding this comment

feat(forge, cast): add `cast --with_local_artifacts`/`forge selectors cache` to trace with local artifacts #7359

feat(forge, cast): add `cast --with_local_artifacts`/`forge selectors cache` to trace with local artifacts #7359

byteshijinn commented Mar 10, 2024 •

edited by grandizzy

Loading

klkvr Jul 9, 2024 •

edited

Loading

klkvr commented Jul 9, 2024 •

edited

Loading

grandizzy commented Nov 21, 2024 •

edited

Loading