Lines
64.29 %
Functions
40 %
Branches
100 %
// Copyright 2019-2025 PureStake Inc.
// This file is part of Moonbeam.
// Moonbeam is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// Moonbeam is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
// You should have received a copy of the GNU General Public License
// along with Moonbeam. If not, see <http://www.gnu.org/licenses/>.
//! Substrate EVM tracing.
//!
//! The purpose of this crate is enable tracing the EVM opcode execution and will be used by
//! both Dapp developers - to get a granular view on their transactions - and indexers to access
//! the EVM callstack (internal transactions).
//! Proxies EVM messages to the host functions.
#![cfg_attr(not(feature = "std"), no_std)]
pub mod tracer {
use ethereum_types::H256;
use evm_tracing_events::{EvmEvent, GasometerEvent, RuntimeEvent, StepEventFilter};
use parity_scale_codec::{Decode, Encode};
use evm::tracing::{using as evm_using, EventListener as EvmListener};
use evm_gasometer::tracing::{using as gasometer_using, EventListener as GasometerListener};
use evm_runtime::tracing::{using as runtime_using, EventListener as RuntimeListener};
use sp_runtime::DispatchError;
use sp_std::{cell::RefCell, rc::Rc};
/// The current EthereumXcmTransaction trace status.
#[derive(Clone, Debug, Encode, Decode, PartialEq, Eq)]
pub enum EthereumTracingStatus {
/// A full block trace.
Block,
/// A single transaction.
Transaction(H256),
/// Exit signal.
TransactionExited,
}
environmental::environmental!(ETHEREUM_TRACING_STATUS: EthereumTracingStatus);
struct ListenerProxy<T>(pub Rc<RefCell<T>>);
impl<T: GasometerListener> GasometerListener for ListenerProxy<T> {
fn event(&mut self, event: evm_gasometer::tracing::Event) {
self.0.borrow_mut().event(event);
impl<T: RuntimeListener> RuntimeListener for ListenerProxy<T> {
fn event(&mut self, event: evm_runtime::tracing::Event) {
impl<T: EvmListener> EvmListener for ListenerProxy<T> {
fn event(&mut self, event: evm::tracing::Event) {
pub struct EthereumTracer;
impl EthereumTracer {
pub fn transaction(
tx_hash: H256,
func: impl FnOnce() -> Result<(), DispatchError>,
) -> Result<(), DispatchError> {
ETHEREUM_TRACING_STATUS::using(&mut EthereumTracingStatus::Transaction(tx_hash), func)
pub fn block(
ETHEREUM_TRACING_STATUS::using(&mut EthereumTracingStatus::Block, func)
pub fn transaction_exited() {
ETHEREUM_TRACING_STATUS::with(|state| {
*state = EthereumTracingStatus::TransactionExited
});
pub fn status() -> Option<EthereumTracingStatus> {
ETHEREUM_TRACING_STATUS::with(|state| state.clone())
pub struct EvmTracer {
step_event_filter: StepEventFilter,
impl EvmTracer {
pub fn new() -> Self {
Self {
step_event_filter: moonbeam_primitives_ext::moonbeam_ext::step_event_filter(),
/// Setup event listeners and execute provided closure.
///
/// Consume the tracer and return it alongside the return value of
/// the closure.
pub fn trace<R, F: FnOnce() -> R>(self, f: F) {
let wrapped = Rc::new(RefCell::new(self));
let mut gasometer = ListenerProxy(Rc::clone(&wrapped));
let mut runtime = ListenerProxy(Rc::clone(&wrapped));
let mut evm = ListenerProxy(Rc::clone(&wrapped));
// Each line wraps the previous `f` into a `using` call.
// Listening to new events results in adding one new line.
// Order is irrelevant when registering listeners.
let f = || runtime_using(&mut runtime, f);
let f = || gasometer_using(&mut gasometer, f);
let f = || evm_using(&mut evm, f);
f();
pub fn emit_new() {
moonbeam_primitives_ext::moonbeam_ext::call_list_new();
impl EvmListener for EvmTracer {
/// Proxies `evm::tracing::Event` to the host.
let event: EvmEvent = event.into();
let message = event.encode();
moonbeam_primitives_ext::moonbeam_ext::evm_event(message);
impl GasometerListener for EvmTracer {
/// Proxies `evm_gasometer::tracing::Event` to the host.
let event: GasometerEvent = event.into();
moonbeam_primitives_ext::moonbeam_ext::gasometer_event(message);
impl RuntimeListener for EvmTracer {
/// Proxies `evm_runtime::tracing::Event` to the host.
let event = RuntimeEvent::from_evm_event(event, self.step_event_filter);
moonbeam_primitives_ext::moonbeam_ext::runtime_event(message);