Skip to content

chore: add TransferInspector to anvil Inspector #10261

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.

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
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
38 changes: 23 additions & 15 deletions crates/anvil/src/eth/backend/mem/inspector.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ use alloy_primitives::{Address, Log};
use foundry_evm::{
call_inspectors,
decode::decode_console_logs,
inspectors::{LogCollector, TracingInspector},
inspectors::{LogCollector, TracingInspector, TransferInspector},
revm::{
interpreter::{
CallInputs, CallOutcome, CreateInputs, CreateOutcome, EOFCreateInputs, Interpreter,
Expand All @@ -25,6 +25,8 @@ pub struct Inspector {
pub tracer: Option<TracingInspector>,
/// Collects all `console.sol` logs
pub log_collector: Option<LogCollector>,
/// Collects all internal ETH transfers as ERC20 transfer events.
pub transfer: Option<TransferInspector>,
}

impl Inspector {
Expand Down Expand Up @@ -80,6 +82,12 @@ impl Inspector {
self.tracer = Some(TracingInspector::new(TracingInspectorConfig::all().with_state_diffs()));
self
}

/// Configures the `Tracer` [`revm::Inspector`] with a transfer event collector
pub fn with_transfers(mut self) -> Self {
self.transfer = Some(TransferInspector::new(false).with_logs(true));
self
}
}

/// Prints the traces for the inspector
Expand Down Expand Up @@ -132,7 +140,7 @@ impl<DB: Database> revm::Inspector<DB> for Inspector {
fn call(&mut self, ecx: &mut EvmContext<DB>, inputs: &mut CallInputs) -> Option<CallOutcome> {
call_inspectors!(
#[ret]
[&mut self.tracer, &mut self.log_collector],
[&mut self.tracer, &mut self.log_collector, &mut self.transfer],
|inspector| inspector.call(ecx, inputs).map(Some),
);
None
Expand All @@ -156,11 +164,11 @@ impl<DB: Database> revm::Inspector<DB> for Inspector {
ecx: &mut EvmContext<DB>,
inputs: &mut CreateInputs,
) -> Option<CreateOutcome> {
if let Some(tracer) = &mut self.tracer {
if let Some(out) = tracer.create(ecx, inputs) {
return Some(out);
}
}
call_inspectors!(
#[ret]
[&mut self.tracer, &mut self.transfer],
|inspector| { inspector.create(ecx, inputs).map(Some) },
);
None
}

Expand All @@ -183,11 +191,11 @@ impl<DB: Database> revm::Inspector<DB> for Inspector {
ecx: &mut EvmContext<DB>,
inputs: &mut EOFCreateInputs,
) -> Option<CreateOutcome> {
if let Some(tracer) = &mut self.tracer {
if let Some(out) = tracer.eofcreate(ecx, inputs) {
return Some(out);
}
}
call_inspectors!(
#[ret]
[&mut self.tracer, &mut self.transfer],
|inspector| { inspector.eofcreate(ecx, inputs).map(Some) },
);
None
}

Expand All @@ -207,9 +215,9 @@ impl<DB: Database> revm::Inspector<DB> for Inspector {

#[inline]
fn selfdestruct(&mut self, contract: Address, target: Address, value: U256) {
if let Some(tracer) = &mut self.tracer {
revm::Inspector::<DB>::selfdestruct(tracer, contract, target, value);
}
call_inspectors!([&mut self.tracer, &mut self.transfer], |inspector| {
revm::Inspector::<DB>::selfdestruct(inspector, contract, target, value);
},);
}
}

Expand Down
25 changes: 14 additions & 11 deletions crates/anvil/src/eth/backend/mem/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,6 @@ use revm::{
primitives::{BlobExcessGasAndPrice, HashMap, OptimismFields, ResultAndState},
DatabaseCommit,
};
use revm_inspectors::transfer::TransferInspector;
use std::{
collections::BTreeMap,
io::{Read, Write},
Expand Down Expand Up @@ -1561,28 +1560,32 @@ impl Backend {
env.block.basefee = U256::from(0);
}

// transact
let ResultAndState { result, state } = if trace_transfers {
let mut inspector = self.build_inspector();
if trace_transfers {
// prepare inspector to capture transfer inside the evm so they are
// recorded and included in logs
let mut inspector = TransferInspector::new(false).with_logs(true);
inspector = inspector.with_transfers();
}

// transact
let ResultAndState { result, state } = {
let mut evm =
self.new_evm_with_inspector_ref(cache_db.as_dyn(), env, &mut inspector);
self.new_evm_with_inspector_ref(cache_db.as_dyn(), env, &mut inspector);

trace!(target: "backend", env=?evm.context.env(), spec=?evm.spec_id(), "simulate evm env");
evm.transact()?
} else {
let mut inspector = self.build_inspector();
let mut evm =
self.new_evm_with_inspector_ref(cache_db.as_dyn(), env, &mut inspector);
trace!(target: "backend", env=?evm.context.env(),spec=?evm.spec_id(), "simulate evm env");
evm.transact()?
};
trace!(target: "backend", ?result, ?request, "simulate call");

// commit the transaction
cache_db.commit(state);
gas_used += result.gas_used();

inspector.print_logs();
if self.print_traces {
inspector.into_print_traces();
}

// TODO: this is likely incomplete
// create the transaction from a request
let from = request.from.unwrap_or_default();
Expand Down
2 changes: 1 addition & 1 deletion crates/evm/evm/src/inspectors/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ pub use foundry_evm_coverage::CoverageCollector;
pub use foundry_evm_fuzz::Fuzzer;
pub use foundry_evm_traces::{StackSnapshotType, TracingInspector, TracingInspectorConfig};

pub use revm_inspectors::access_list::AccessListInspector;
pub use revm_inspectors::{access_list::AccessListInspector, transfer::TransferInspector};

mod chisel_state;
pub use chisel_state::ChiselState;
Expand Down
Loading