[feat] `cast call --trace` (& code reuse in `cast run`) by nhtyy · Pull Request #5477 · foundry-rs/foundry

nhtyy · 2023-07-26T07:08:39Z

Forks remote rpc, executes a call and prints a trace

edit: this PR also touches on cast run just to dedup some code we copy

Motivation

I come up needing something like this quite often, using a forge test on the fly rn with calldata

nhtyy · 2023-07-26T18:47:51Z

hi, so this PR is fully implemented as a extension to cast call, although, im actually not sure if should instead become its own command like cast trace.

i only say this because now, cast call has options like --debug or --verbose that can only be used in trace mode, but they still appear at the top level --help call...

Making --trace a subcommand would alter the current semantics of how create calls are handled so im thinking this maybe should have its own command.

lots of this code is shared with cast run also, if someone can give some guidance on where to store this code so we can dedup all of that

mattsse

great feature,

I think having it as flag in cast call is the best approach

I wonder if we can unify a lot of stuff with cast run

but perhaps not really possible since cast run behaves slightly differently

wdyt @Evalir

only glanced over the changes, looks promising

I'd like to move the TracingExecutor and the standalone functions to a separate file though

Evalir

looking good! some comments & agree with mattsse over moving the tracingexecutor & related funcs

Evalir · 2023-07-27T14:15:07Z

cli/src/cmd/cast/call.rs

+struct TracingExecutor {
+    executor: Executor,
+}
+
+impl TracingExecutor {
+    pub async fn new(
+        config: &foundry_config::Config,
+        version: Option<EvmVersion>,
+        rpc_opts: RpcOpts,
+        debug: bool,
+    ) -> eyre::Result<(Self, EvmOpts)> {
+        // todo:n find out what this is
+        let figment =
+            Config::figment_with_root(find_project_root_path(None).unwrap()).merge(rpc_opts);
+
+        let mut evm_opts = figment.extract::<EvmOpts>()?;
+
+        evm_opts.fork_url = Some(config.get_rpc_url_or_localhost_http()?.into_owned());
+        evm_opts.fork_block_number = config.fork_block_number;
+
+        // Set up the execution environment
+        let env = evm_opts.evm_env().await;
+
+        let db = Backend::spawn(evm_opts.get_fork(&config, env.clone())).await;
+
+        // configures a bare version of the evm executor: no cheatcode inspector is enabled,
+        // tracing will be enabled only for the targeted transaction
+        let builder = ExecutorBuilder::default()
+            .with_config(env)
+            .with_spec(evm_spec(&version.unwrap_or(config.evm_version)));
+
+        let mut executor = builder.build(db);
+
+        executor.set_tracing(true).set_debugger(debug);
+
+        Ok((Self { executor }, evm_opts))
+    }
+}
+
+impl std::ops::Deref for TracingExecutor {
+    type Target = Executor;
+
+    fn deref(&self) -> &Self::Target {
+        &self.executor
+    }
+}
+
+impl DerefMut for TracingExecutor {
+    fn deref_mut(&mut self) -> &mut Self::Target {
+        &mut self.executor
+    }
+}


i like this. wdyt about moving it to the evm crate? that way we have executors all in one place—we can do the config stuff before building the executor and therefore not depend on the config

Evalir · 2023-07-27T14:18:29Z

cli/src/cmd/cast/call.rs

+                        Ok(DeployResult { gas_used, traces, debug: run_debug, .. }) => {
+                            TraceResult {
+                                success: true,
+                                traces: vec![(TraceKind::Execution, traces.unwrap_or_default())],


hmm, as traces are enabled by default, is there any situation where we do not want to error if we can't unwrap the traces? thinking it might be better to just bail here if not

Evalir · 2023-07-27T14:18:56Z

cli/src/cmd/cast/call.rs

                }

-                builder.set_data(data);
+                // fill it last because we dont need anything from the built one


can we make this comment a tad clearer? can't easily figure out what you mean without context 😄

Evalir · 2023-07-27T14:19:09Z

cli/src/cmd/cast/call.rs

            }
            _ => {
-                builder.value(tx.value);
+                // fill it first becasue builder parses args / addr


Suggested change

// fill it first becasue builder parses args / addr

// fill it first because builder parses args / addr

nhtyy · 2023-07-28T01:26:28Z

hi @Evalir i addressed your requests in the more recent commits, as well as moved the TracingExecutor to evm::trace, and moved handle_trace, print_trace, run_debugger to cli::cmd::utils. Just want to confirm those are good spots..

As well all items mentioned can by re used in cast run! Should i do that here or should i make another pr?

Evalir

lgtm bar few doc comments! can't push to your branch as it's protected (master)

i think we can do the other stuff in a followup pr if you're up for it 🙏

cli/src/cmd/cast/call.rs

cli/src/cmd/utils.rs

evm/src/trace/mod.rs

nhtyy · 2023-07-31T23:47:58Z

@Evalir

just finished this, currently its a pr on my repo, wasnt sure where to point it

nhtyy#1

Evalir · 2023-08-01T17:40:09Z

@nhtyy nice! should we fix the failing tests on this pr and open that one here?

nhtyy · 2023-08-01T23:16:31Z

@Evalir hmm sorry im not sure how to open both of them at the same time on this repo

nhtyy · 2023-08-01T23:19:29Z

maybe we should just merge them all here? diff shouldnt be to bad, sent you an invite to my repo as well

Evalir · 2023-08-02T00:07:36Z

sure! let's merge them all here then, and update the pr description accordingly

nhtyy · 2023-08-07T20:22:03Z

re-requesting review since there was some merge conflicts blocking

Evalir

lgtm! thank you! just needs fmt, but can't push to your branch since this is on master. let's fix ci then we can send it

cli/src/cmd/cast/call.rs

meetmangukiya · 2023-08-10T11:19:32Z

was missing this feature a lot! great stuff 🚀

evm/src/trace/mod.rs

N and others added 6 commits July 26, 2023 00:30

initial start

ae45e30

traces working

636ff05

Update opts.rs

19c9c39

clean up

c1cfb82

Merge branch 'master' of https://github.com/nhtyy/foundry

3589fc6

comments/debugger

3a37650

nhtyy marked this pull request as ready for review July 26, 2023 18:44

N added 2 commits July 26, 2023 17:26

comment

8e1fb61

change build -> fill

e797891

mattsse requested changes Jul 27, 2023

View reviewed changes

Evalir requested changes Jul 27, 2023

View reviewed changes

N added 8 commits July 27, 2023 15:38

start of move to evm crate

eb63029

rename

1aaa59f

put fork setup on tracing executor

ff90e6b

comment

dee0d34

return err on no traces

2136cce

moving trace handlers to cast::cmd::utils

5de5f05

rm formatting

ca5ec5d

fmt

e31c432

Evalir requested review from Evalir and mattsse July 28, 2023 02:57

N added 2 commits July 28, 2023 00:30

use a ref

6dbf0cd

fix unneeded borrow

005a5ca

Evalir requested changes Jul 31, 2023

View reviewed changes

N added 4 commits July 31, 2023 18:35

Merge branch 'master' of https://github.com/foundry-rs/foundry

ba5e0f2

unused import

4ce14bd

panic instead of bail

72c5bab

initial

5c26bdd

N added 5 commits August 1, 2023 14:33

TraceResult::from

c544211

clippy --fix

6ab8770

merge upstream

f49609d

use from/try_from

f3e84fa

clippy --fix

770d052

N added 3 commits August 1, 2023 19:25

clean up, no extra url in panic

bd24641

Merge branch 'master' of https://github.com/nhtyy/foundry into n/run

5600a5e

formatting

2c9b5a6

N added 2 commits August 2, 2023 13:08

Merge branch 'master' of https://github.com/foundry-rs/foundry

866475d

fix imports

8445445

nhtyy changed the title ~~[feat] cast call --trace~~ [feat] cast call --trace (& code reuse in cast run) Aug 2, 2023

N added 2 commits August 2, 2023 13:18

fix clap rxequirements

78130fd

pull upstream

93ad848

nhtyy requested a review from Evalir August 7, 2023 20:22

Evalir approved these changes Aug 9, 2023

View reviewed changes

cli/src/cmd/cast/call.rs Show resolved Hide resolved

Evalir and others added 3 commits August 10, 2023 11:16

Update cli/src/cmd/cast/call.rs

2d6bd74

cargo fmt

cdbca4d

Merge branch 'master' of https://github.com/nhtyy/foundry

9c8590c

Evalir reviewed Aug 10, 2023

View reviewed changes

evm/src/trace/mod.rs Outdated Show resolved Hide resolved

move tracing executor to its own file

b78187a

Evalir merged commit ad1d090 into foundry-rs:master Aug 10, 2023

Evalir mentioned this pull request Aug 14, 2023

feat: add trace docs foundry-rs/book#985

Merged

yash-atreya mentioned this pull request Feb 22, 2024

feat: support traces and debugging in cast call #3038

Closed

	// fill it first becasue builder parses args / addr
	// fill it first because builder parses args / addr

Conversation

nhtyy commented Jul 26, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivation

Uh oh!

nhtyy commented Jul 26, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mattsse left a comment

Choose a reason for hiding this comment

Uh oh!

Evalir left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Evalir Jul 27, 2023

Choose a reason for hiding this comment

Uh oh!

Evalir Jul 27, 2023

Choose a reason for hiding this comment

Uh oh!

Evalir Jul 27, 2023

Choose a reason for hiding this comment

Uh oh!

Evalir Jul 27, 2023

Choose a reason for hiding this comment

Uh oh!

nhtyy commented Jul 28, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Evalir left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nhtyy commented Jul 31, 2023

Uh oh!

Evalir commented Aug 1, 2023

Uh oh!

nhtyy commented Aug 1, 2023

Uh oh!

nhtyy commented Aug 1, 2023

Uh oh!

Evalir commented Aug 2, 2023

Uh oh!

nhtyy commented Aug 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Evalir left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

meetmangukiya commented Aug 10, 2023

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

nhtyy commented Jul 26, 2023 •

edited

Loading

nhtyy commented Jul 26, 2023 •

edited

Loading

Evalir left a comment •

edited

Loading

nhtyy commented Jul 28, 2023 •

edited

Loading

nhtyy commented Aug 7, 2023 •

edited

Loading