Display events in the debugging trace

Author: integraledelebesgue

CHANGELOG.md

@@ -9,6 +9,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Forge
 
+#### Added
+
+- Contract debug traces now include emitted Starknet events via the `events` trace component and `detailed` trace verbosity.
+
 #### Changed
 
 - `snforge_scarb_plugin` diagnostics for named-argument kind violations now include both possible values and invalid arguments found.

crates/data-transformer/src/shared/path.rs

@@ -86,5 +86,5 @@ fn extract_generic_args(
         return Err(PathSplitError::MoreThanOneGenericArg);
     };
 
-    Ok(generic_arg.to_string())
+    Ok((*generic_arg).to_string())
 }

crates/debugging/src/trace/collect.rs

@@ -1,9 +1,10 @@
 use crate::contracts_data_store::ContractsDataStore;
 use crate::trace::types::{
-    CallerAddress, ContractAddress, ContractName, ContractTrace, Gas, Selector, TestName,
-    TraceInfo, TransformedCallResult, TransformedCalldata,
+    CallerAddress, ContractAddress, ContractName, ContractTrace, Event, Events, Gas, Selector,
+    TestName, TraceInfo, TransformedCallResult, TransformedCalldata,
 };
 use crate::{Context, Trace};
+use blockifier::execution::call_info::OrderedEvent;
 use cheatnet::runtime_extensions::call_to_blockifier_runtime_extension::rpc::{
     CallFailure, CallSuccess,
 };
@@ -53,6 +54,7 @@ impl<'a> Collector<'a> {
             call_type: components.call_type(entry_point.call_type),
             nested_calls,
             call_result: components.call_result_lazy(|| self.collect_transformed_call_result(abi)),
+            events: components.events_lazy(|| self.collect_events()),
             gas: components.gas_lazy(|| self.collect_gas()),
         };
 
@@ -150,6 +152,23 @@ impl<'a> Collector<'a> {
             .l2_gas)
     }
 
+    fn collect_events(&self) -> Events {
+        Events(
+            self.call_trace
+                .events
+                .iter()
+                .map(Self::collect_event)
+                .collect(),
+        )
+    }
+
+    fn collect_event(event: &OrderedEvent) -> Event {
+        Event {
+            keys: event.event.keys.iter().map(|key| key.0).collect(),
+            data: event.event.data.0.clone(),
+        }
+    }
+
     fn class_hash(&self) -> &ClassHash {
         self.call_trace
             .entry_point

crates/debugging/src/trace/components.rs

@@ -1,5 +1,6 @@
 use crate::trace::types::{
-    CallerAddress, ContractAddress, ContractName, Gas, TransformedCallResult, TransformedCalldata,
+    CallerAddress, ContractAddress, ContractName, Events, Gas, TransformedCallResult,
+    TransformedCalldata,
 };
 use blockifier::execution::entry_point::CallType;
 use paste::paste;
@@ -42,6 +43,8 @@ pub enum Component {
     CallType,
     /// The result of the call, transformed for display.
     CallResult,
+    /// The raw events emitted by the call.
+    Events,
     /// The L2 gas used by the call.
     Gas,
 }
@@ -125,3 +128,4 @@ impl_component_container!(CallerAddress);
 impl_component_container!(CallType);
 impl_component_container!(CallResult, TransformedCallResult);
 impl_component_container!(Gas);
+impl_component_container!(Events);

crates/debugging/src/trace/types.rs

@@ -2,12 +2,14 @@ use crate::Context;
 use crate::trace::collect::Collector;
 use crate::trace::components::{
     CallResultContainer, CallTypeContainer, CalldataContainer, CallerAddressContainer,
-    ContractAddressContainer, ContractNameContainer, EntryPointTypeContainer, GasContainer,
+    ContractAddressContainer, ContractNameContainer, EntryPointTypeContainer, EventsContainer,
+    GasContainer,
 };
 use crate::tree::TreeSerialize;
 use cheatnet::trace_data::CallTrace;
 use starknet_api::core::ContractAddress as ApiContractAddress;
 use starknet_api::execution_resources::GasAmount as ApiGasAmount;
+use starknet_types_core::felt::Felt;
 use std::fmt;
 use std::fmt::Display;
 
@@ -33,6 +35,7 @@ pub struct TraceInfo {
     pub call_type: CallTypeContainer,
     pub nested_calls: Vec<ContractTrace>,
     pub call_result: CallResultContainer,
+    pub events: EventsContainer,
     pub gas: GasContainer,
 }
 
@@ -60,6 +63,15 @@ pub struct CallerAddress(pub ApiContractAddress);
 #[derive(Debug, Clone)]
 pub struct Gas(pub ApiGasAmount);
 
+#[derive(Debug, Clone)]
+pub struct Events(pub Vec<Event>);
+
+#[derive(Debug, Clone)]
+pub struct Event {
+    pub keys: Vec<Felt>,
+    pub data: Vec<Felt>,
+}
+
 impl Trace {
     /// Creates a new [`Trace`] from a given [`Context`] and a test name.
     #[must_use]

crates/debugging/src/tree/ui/as_tree_node.rs

@@ -34,6 +34,7 @@ impl AsTreeNode for TraceInfo {
         parent.leaf_optional(self.caller_address.as_option());
         parent.leaf_optional(self.call_type.as_option());
         parent.leaf_optional(self.call_result.as_option());
+        parent.leaf_optional(self.events.as_option());
         parent.leaf_optional(self.gas.as_option());
         for nested_call in &self.nested_calls {
             parent.as_tree_node(nested_call);

crates/debugging/src/tree/ui/display.rs

@@ -1,6 +1,6 @@
 use crate::trace::types::{
-    CallerAddress, ContractAddress, ContractName, Gas, Selector, TestName, TransformedCallResult,
-    TransformedCalldata,
+    CallerAddress, ContractAddress, ContractName, Event, Events, Gas, Selector, TestName,
+    TransformedCallResult, TransformedCalldata,
 };
 use blockifier::execution::entry_point::CallType;
 use starknet_api::contract_class::EntryPointType;
@@ -84,6 +84,20 @@ impl NodeDisplay for TransformedCallResult {
     }
 }
 
+impl NodeDisplay for Events {
+    const TAG: &'static str = "events";
+    fn string_pretty(&self) -> String {
+        format!(
+            "[{}]",
+            self.0
+                .iter()
+                .map(Event::string_pretty)
+                .collect::<Vec<_>>()
+                .join(", ")
+        )
+    }
+}
+
 impl NodeDisplay for Gas {
     const TAG: &'static str = "L2 gas";
     fn string_pretty(&self) -> String {
@@ -102,3 +116,21 @@ fn string_hex(data: impl Into<Felt>) -> String {
 fn string_debug(data: impl Debug) -> String {
     format!("{data:?}")
 }
+
+impl Event {
+    fn string_pretty(&self) -> String {
+        format!(
+            "Event {{ keys: [{}], data: [{}] }}",
+            self.keys
+                .iter()
+                .map(Felt::to_hex_string)
+                .collect::<Vec<_>>()
+                .join(", "),
+            self.data
+                .iter()
+                .map(Felt::to_hex_string)
+                .collect::<Vec<_>>()
+                .join(", "),
+        )
+    }
+}

crates/forge-runner/src/debugging/component.rs

@@ -19,6 +19,8 @@ pub enum Component {
     CallType,
     /// The result of the call, transformed for display.
     CallResult,
+    /// The raw events emitted by the call.
+    Events,
     /// The L2 gas used by the call.
     Gas,
 }
@@ -33,6 +35,7 @@ impl Component {
             | Component::CallerAddress
             | Component::EntryPointType
             | Component::CallType
+            | Component::Events
             | Component::Gas => TraceVerbosity::Detailed,
         }
     }
@@ -48,6 +51,7 @@ impl From<&Component> for debugging::Component {
             Component::CallerAddress => debugging::Component::CallerAddress,
             Component::CallType => debugging::Component::CallType,
             Component::CallResult => debugging::Component::CallResult,
+            Component::Events => debugging::Component::Events,
             Component::Gas => debugging::Component::Gas,
         }
     }

crates/forge/tests/data/debugging/src/lib.cairo

@@ -8,7 +8,7 @@ struct RecursiveCall {
 
 #[starknet::interface]
 trait RecursiveCaller<T> {
-    fn execute_calls(self: @T, calls: Array<RecursiveCall>) -> Array<RecursiveCall>;
+    fn execute_calls(ref self: T, calls: Array<RecursiveCall>) -> Array<RecursiveCall>;
 }
 
 #[starknet::interface]
@@ -20,7 +20,7 @@ trait Failing<TContractState> {
 mod SimpleContract {
     use core::array::ArrayTrait;
     use core::traits::Into;
-    use starknet::{ContractAddress, get_contract_address};
+    use starknet::ContractAddress;
     use super::{
         Failing, RecursiveCall, RecursiveCaller, RecursiveCallerDispatcher,
         RecursiveCallerDispatcherTrait,
@@ -30,12 +30,24 @@ mod SimpleContract {
     #[storage]
     struct Storage {}
 
+    #[event]
+    #[derive(Drop, starknet::Event)]
+    enum Event {
+        CallsExecuted: CallsExecuted,
+    }
+
+    #[derive(Drop, starknet::Event)]
+    struct CallsExecuted {
+        calls_len: felt252,
+    }
 
     #[abi(embed_v0)]
     impl RecursiveCallerImpl of RecursiveCaller<ContractState> {
         fn execute_calls(
-            self: @ContractState, calls: Array<RecursiveCall>,
+            ref self: ContractState, calls: Array<RecursiveCall>,
         ) -> Array<RecursiveCall> {
+            self.emit(Event::CallsExecuted(CallsExecuted { calls_len: calls.len().into() }));
+
             let mut i = 0;
             #[cairofmt::skip]
             while i < calls.len() {

crates/forge/tests/data/debugging_events/Scarb.toml

@@ -0,0 +1,10 @@
+[package]
+name = "debugging_events"
+version = "0.1.0"
+edition = "2023_01"
+
+[dependencies]
+starknet = ">=2.8.0"
+
+[dev-dependencies]
+snforge_std = { path = "../../../../../snforge_std" }