Skip to content
Merged
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
23 changes: 16 additions & 7 deletions rust/op-reth/crates/rpc/src/debank.rs
Original file line number Diff line number Diff line change
Expand Up @@ -590,6 +590,8 @@ impl From<&CallLog> for DebankEvent {

// ─── Trace building ───────────────────────────────────────────────────────────

const PARENT_CALL_FAILED_ERROR: &str = "parent call failed";

enum DebankTraceOrLog {
Trace(DebankTraceNode),
Log(DebankEvent),
Expand All @@ -612,8 +614,12 @@ fn build_trace_node(
trace_address: Vec<usize>,
log_index: &mut usize,
) -> DebankTraceNode {
let mut trace: DebankTrace = node.into();
if !parent_success && trace.error.is_empty() {
trace.error = PARENT_CALL_FAILED_ERROR.to_string();
}
let mut debank_node = DebankTraceNode {
trace: node.into(),
trace,
children: Vec::new(),
success: node.trace.success && parent_success,
};
Expand All @@ -626,14 +632,12 @@ fn build_trace_node(
let id = debank_node.trace.id.clone();
let contract_id = node.execution_address();

let mut child_trace_address = Vec::new();
for pos in node.ordering.iter() {
match &pos {
TraceMemberOrder::Call(i) => {
let child_node = &nodes[node.children[*i]];
let mut trace_address = trace_address.clone();
trace_address.push(*i);
child_trace_address = trace_address.clone();
let child_trace = build_trace_node(
tx_id.clone(),
id.clone(),
Expand All @@ -655,8 +659,8 @@ fn build_trace_node(
child_event.contract_id = contract_id;
child_event.parent_trace_id = id.clone();
child_event.id = child_event.debank_id();
child_event.idx = *log_index;
if debank_node.success {
child_event.idx = *log_index;
*log_index += 1;
}
debank_node.children.push(DebankTraceOrLog::Log(child_event));
Expand All @@ -668,24 +672,29 @@ fn build_trace_node(
// selfdestructs are not recorded as individual call traces but are derived from
// the call trace and are added as additional `TransactionTrace` objects
if node.is_selfdestruct() {
child_trace_address.last_mut().map(|last| *last += 1);
let mut selfdestruct_trace_address = trace_address;
selfdestruct_trace_address.push(debank_node.trace.subtraces);
debank_node.trace.subtraces += 1;
let success = debank_node.success;
let mut selfdestruct_trace = DebankTrace {
from_addr: node.trace.selfdestruct_address.unwrap_or_default(),
to_addr: node.trace.selfdestruct_refund_target.unwrap_or_default(),
value: node.trace.selfdestruct_transferred_value.unwrap_or_default(),
trace_address: child_trace_address,
trace_address: selfdestruct_trace_address,
parent_trace_id: id.clone(),
pos_in_parent_trace: debank_node.children.len(),
tx_id: tx_id.clone(),
call_create_type: "suicide".to_string(),
..Default::default()
};
if !success {
selfdestruct_trace.error = PARENT_CALL_FAILED_ERROR.to_string();
}
selfdestruct_trace.id = selfdestruct_trace.debank_id();
debank_node.children.push(DebankTraceOrLog::Trace(DebankTraceNode {
trace: selfdestruct_trace,
children: vec![],
success: parent_success && debank_node.success,
success,
}));
}
debank_node
Expand Down
156 changes: 156 additions & 0 deletions rust/op-reth/crates/rpc/tests/debank_errtrace.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,156 @@
//! Regression tests for failed-parent DeBank traces.

use alloy_primitives::{Address, B256 as H256};
use reth_optimism_rpc::debank::{DebankTrace, build_debank_traces};
use revm::interpreter::InstructionResult;
use revm_inspectors::tracing::{
CallTraceArena,
types::{CallKind, CallLog, CallTrace, CallTraceNode, TraceMemberOrder},
};
use std::cell::RefCell;

const PARENT_CALL_FAILED_ERROR: &str = "parent call failed";

fn addr(byte: u8) -> Address {
Address::repeat_byte(byte)
}

fn call_trace_node(
idx: usize,
parent: Option<usize>,
address: Address,
success: bool,
status: InstructionResult,
children: Vec<usize>,
) -> CallTraceNode {
let ordering = (0..children.len()).map(TraceMemberOrder::Call).collect();
CallTraceNode {
parent,
children,
idx,
trace: CallTrace {
success,
address,
kind: CallKind::Call,
status: Some(status),
..Default::default()
},
ordering,
..Default::default()
}
}

fn call_trace_arena(nodes: Vec<CallTraceNode>) -> CallTraceArena {
let mut arena = CallTraceArena::default();
*arena.nodes_mut() = nodes;
arena
}

fn trace_for_address(traces: &[DebankTrace], address: Address) -> &DebankTrace {
traces.iter().find(|trace| trace.to_addr == address).unwrap()
}

fn with_log(mut node: CallTraceNode) -> CallTraceNode {
node.logs.push(CallLog::default());
node.ordering.push(TraceMemberOrder::Log(0));
node
}

#[test]
fn successful_descendants_of_failed_call_are_error_traces() {
let arena = call_trace_arena(vec![
call_trace_node(0, None, addr(1), true, InstructionResult::Stop, vec![1, 4]),
call_trace_node(1, Some(0), addr(2), false, InstructionResult::Revert, vec![2, 3]),
call_trace_node(2, Some(1), addr(3), true, InstructionResult::Stop, vec![]),
call_trace_node(3, Some(1), addr(4), false, InstructionResult::OutOfGas, vec![]),
call_trace_node(4, Some(0), addr(5), true, InstructionResult::Stop, vec![]),
]);

let (traces, error_traces, _, _) =
build_debank_traces(H256::repeat_byte(0xaa), arena, &RefCell::new(0));

assert_eq!(traces.len(), 2);
assert_eq!(error_traces.len(), 3);
assert_eq!(trace_for_address(&error_traces, addr(2)).error, "Reverted");
assert_eq!(trace_for_address(&error_traces, addr(3)).error, PARENT_CALL_FAILED_ERROR);
assert_eq!(trace_for_address(&error_traces, addr(4)).error, "Out of gas");
}

#[test]
fn failed_parent_marks_selfdestruct_and_uses_nested_trace_address() {
let mut selfdestruct =
call_trace_node(1, Some(0), addr(2), true, InstructionResult::SelfDestruct, vec![]);
selfdestruct.trace.selfdestruct_address = Some(addr(3));
selfdestruct.trace.selfdestruct_refund_target = Some(addr(4));
let arena = call_trace_arena(vec![
call_trace_node(0, None, addr(1), false, InstructionResult::Revert, vec![1]),
selfdestruct,
]);

let (traces, error_traces, _, _) =
build_debank_traces(H256::repeat_byte(0xaa), arena, &RefCell::new(0));

assert!(traces.is_empty());
assert_eq!(error_traces.len(), 3);
let child = trace_for_address(&error_traces, addr(2));
assert_eq!(child.error, PARENT_CALL_FAILED_ERROR);
assert_eq!(child.trace_address, vec![0]);
let selfdestruct = trace_for_address(&error_traces, addr(4));
assert_eq!(selfdestruct.error, PARENT_CALL_FAILED_ERROR);
assert_eq!(selfdestruct.trace_address, vec![0, 0]);
}

#[test]
fn root_selfdestruct_uses_first_child_trace_address() {
let mut root = call_trace_node(0, None, addr(1), true, InstructionResult::SelfDestruct, vec![]);
root.trace.selfdestruct_address = Some(addr(2));
root.trace.selfdestruct_refund_target = Some(addr(3));

let (traces, error_traces, _, _) = build_debank_traces(
H256::repeat_byte(0xaa),
call_trace_arena(vec![root]),
&RefCell::new(0),
);

assert!(error_traces.is_empty());
assert_eq!(traces.len(), 2);
let selfdestruct = trace_for_address(&traces, addr(3));
assert_eq!(selfdestruct.trace_address, vec![0]);
}

#[test]
fn selfdestruct_follows_existing_child_trace_addresses() {
let mut selfdestruct =
call_trace_node(1, Some(0), addr(2), true, InstructionResult::SelfDestruct, vec![2]);
selfdestruct.trace.selfdestruct_address = Some(addr(3));
selfdestruct.trace.selfdestruct_refund_target = Some(addr(4));
let arena = call_trace_arena(vec![
call_trace_node(0, None, addr(1), true, InstructionResult::Stop, vec![1]),
selfdestruct,
call_trace_node(2, Some(1), addr(5), true, InstructionResult::Stop, vec![]),
]);

let (traces, error_traces, _, _) =
build_debank_traces(H256::repeat_byte(0xaa), arena, &RefCell::new(0));

assert!(error_traces.is_empty());
assert_eq!(trace_for_address(&traces, addr(5)).trace_address, vec![0, 0]);
assert_eq!(trace_for_address(&traces, addr(4)).trace_address, vec![0, 1]);
}

#[test]
fn error_event_index_stays_zero_after_successful_event() {
let arena = call_trace_arena(vec![
call_trace_node(0, None, addr(1), true, InstructionResult::Stop, vec![1, 2]),
with_log(call_trace_node(1, Some(0), addr(2), true, InstructionResult::Stop, vec![])),
with_log(call_trace_node(2, Some(0), addr(3), false, InstructionResult::Revert, vec![])),
]);

let (_, _, events, error_events) =
build_debank_traces(H256::repeat_byte(0xaa), arena, &RefCell::new(0));

assert_eq!(events.len(), 1);
assert_eq!(events[0].idx, 0);
assert_eq!(error_events.len(), 1);
assert_eq!(error_events[0].idx, 0);
}
Loading