[pallet-revive] Add tracing support (2/2)

cumulus/parachains/runtimes/assets/asset-hub-westend/src/lib.rs

@@ -2307,6 +2307,67 @@ impl_runtime_apis! {
 				key
 			)
 		}
+
+		fn trace_block(
+			block: Block,
+			config: pallet_revive::evm::TracerConfig
+		) -> Vec<(u32, pallet_revive::evm::CallTrace)> {
+			use pallet_revive::tracing::trace;
+			let mut tracer = config.build(Revive::evm_gas_from_weight);
+			let mut traces = vec![];
+			let (header, extrinsics) = block.deconstruct();
+
+			Executive::initialize_block(&header);
+			for (index, ext) in extrinsics.into_iter().enumerate() {
+				trace(&mut tracer, || {
+					let _ = Executive::apply_extrinsic(ext);
+				});
+
+				if let Some(tx_trace) = tracer.collect_traces().pop() {
+					traces.push((index as u32, tx_trace));
+				}
+			}
+
+			traces
+		}
+
+		fn trace_tx(
+			block: Block,
+			tx_index: u32,
+			config: pallet_revive::evm::TracerConfig
+		) -> Option<pallet_revive::evm::CallTrace> {
+			use pallet_revive::tracing::trace;
+			let mut tracer = config.build(Revive::evm_gas_from_weight);
+			let (header, extrinsics) = block.deconstruct();
+
+			Executive::initialize_block(&header);
+			for (index, ext) in extrinsics.into_iter().enumerate() {
+				if index as u32 == tx_index {
+					trace(&mut tracer, || {
+						let _ = Executive::apply_extrinsic(ext);
+					});
+					break;
+				} else {
+					let _ = Executive::apply_extrinsic(ext);
+				}
+			}
+
+			tracer.collect_traces().pop()
+		}
+
+		fn trace_call(
+			tx: pallet_revive::evm::GenericTransaction,
+			config: pallet_revive::evm::TracerConfig)
+			-> Result<pallet_revive::evm::CallTrace, pallet_revive::EthTransactError>
+		{
+			use pallet_revive::tracing::trace;
+			let mut tracer = config.build(Revive::evm_gas_from_weight);
+			trace(&mut tracer, || {
+				Self::eth_transact(tx)
+			})?;
+
+			Ok(tracer.collect_traces().pop().expect("eth_transact succeeded, trace must exist, qed"))
+		}
 	}
 }
 

prdoc/pr_7167.prdoc

@@ -0,0 +1,16 @@
+title: '[pallet-revive] Add tracing support (2/2)'
+doc:
+- audience: Runtime Dev
+  description: |-
+    - Add debug endpoint to eth-rpc for capturing a block or a single transaction traces
+    - Use in-memory DB for non-archive node
+
+    See:
+    -  PR #7166
+crates:
+- name: pallet-revive-eth-rpc
+  bump: minor
+- name: pallet-revive
+  bump: minor
+- name: asset-hub-westend-runtime
+  bump: minor

substrate/bin/node/runtime/src/lib.rs

@@ -3406,6 +3406,67 @@ impl_runtime_apis! {
 				key
 			)
 		}
+
+		fn trace_block(
+			block: Block,
+			config: pallet_revive::evm::TracerConfig
+		) -> Vec<(u32, pallet_revive::evm::CallTrace)> {
+			use pallet_revive::tracing::trace;
+			let mut tracer = config.build(Revive::evm_gas_from_weight);
+			let mut traces = vec![];
+			let (header, extrinsics) = block.deconstruct();
+
+			Executive::initialize_block(&header);
+			for (index, ext) in extrinsics.into_iter().enumerate() {
+				trace(&mut tracer, || {
+					let _ = Executive::apply_extrinsic(ext);
+				});
+
+				if let Some(tx_trace) = tracer.collect_traces().pop() {
+					traces.push((index as u32, tx_trace));
+				}
+			}
+
+			traces
+		}
+
+		fn trace_tx(
+			block: Block,
+			tx_index: u32,
+			config: pallet_revive::evm::TracerConfig
+		) -> Option<pallet_revive::evm::CallTrace> {
+			use pallet_revive::tracing::trace;
+			let mut tracer = config.build(Revive::evm_gas_from_weight);
+			let (header, extrinsics) = block.deconstruct();
+
+			Executive::initialize_block(&header);
+			for (index, ext) in extrinsics.into_iter().enumerate() {
+				if index as u32 == tx_index {
+					trace(&mut tracer, || {
+						let _ = Executive::apply_extrinsic(ext);
+					});
+					break;
+				} else {
+					let _ = Executive::apply_extrinsic(ext);
+				}
+			}
+
+			tracer.collect_traces().pop()
+		}
+
+		fn trace_call(
+			tx: pallet_revive::evm::GenericTransaction,
+			config: pallet_revive::evm::TracerConfig)
+			-> Result<pallet_revive::evm::CallTrace, pallet_revive::EthTransactError>
+		{
+			use pallet_revive::tracing::trace;
+			let mut tracer = config.build(Revive::evm_gas_from_weight);
+			trace(&mut tracer, || {
+				Self::eth_transact(tx)
+			})?;
+
+			Ok(tracer.collect_traces().pop().expect("eth_transact succeeded, trace must exist, qed"))
+		}
 	}
 
 	impl pallet_transaction_payment_rpc_runtime_api::TransactionPaymentApi<

substrate/frame/revive/Cargo.toml

@@ -17,6 +17,7 @@ workspace = true
 targets = ["x86_64-unknown-linux-gnu"]
 
 [dependencies]
+alloy-core = { workspace = true, features = ["sol-types"] }
 codec = { features = ["derive", "max-encoded-len"], workspace = true }
 derive_more = { workspace = true }
 environmental = { workspace = true }
@@ -77,6 +78,7 @@ xcm-builder = { workspace = true, default-features = true }
 [features]
 default = ["std"]
 std = [
+	"alloy-core/std",
 	"codec/std",
 	"environmental/std",
 	"ethabi/std",

substrate/frame/revive/rpc/Cargo.toml

@@ -41,7 +41,6 @@ path = "examples/rust/remark-extrinsic.rs"
 anyhow = { workspace = true }
 clap = { workspace = true, features = ["derive", "env"] }
 codec = { workspace = true, features = ["derive"] }
-ethabi = { version = "18.0.0" }
 futures = { workspace = true, features = ["thread-pool"] }
 hex = { workspace = true }
 jsonrpsee = { workspace = true, features = ["full"] }
@@ -57,6 +56,7 @@ sc-service = { workspace = true, default-features = true }
 sp-arithmetic = { workspace = true, default-features = true }
 sp-core = { workspace = true, default-features = true }
 sp-crypto-hashing = { workspace = true }
+sp-runtime = { workspace = true, default-features = true }
 sp-weights = { workspace = true, default-features = true }
 sqlx = { version = "0.8.2", features = ["macros", "runtime-tokio", "sqlite"] }
 subxt = { workspace = true, default-features = true, features = [
@@ -70,6 +70,7 @@ tokio = { workspace = true, features = ["full"] }
 
 [dev-dependencies]
 env_logger = { workspace = true }
+ethabi = { version = "18.0.0" }
 pretty_assertions = { workspace = true }
 static_init = { workspace = true }
 substrate-cli-test-utils = { workspace = true }

substrate/frame/revive/rpc/examples/js/.solhint.json

@@ -0,0 +1,9 @@
+{
+	"extends": "solhint:recommended",
+	"rules": {
+		"compiler-version": ["error", "^0.8.0"],
+		"gas-custom-errors": "off",
+		"one-contract-per-file": "off",
+		"no-empty-blocks": "off"
+	}
+}

substrate/frame/revive/rpc/examples/js/contracts/Flipper.sol

@@ -20,7 +20,7 @@ contract FlipperCaller {
     address public flipperAddress;
 
     // Constructor to initialize Flipper's address
-    constructor(address _flipperAddress) {
+    constructor(address _flipperAddress) public {
         flipperAddress = _flipperAddress;
     }
 

substrate/frame/revive/rpc/examples/js/contracts/PiggyBank.sol

@@ -6,7 +6,7 @@ contract PiggyBank {
     uint256 private balance;
     address public owner;
 
-    constructor() {
+    constructor() public {
         owner = msg.sender;
         balance = 0;
     }
@@ -21,7 +21,7 @@ contract PiggyBank {
     }
 
     function withdraw(uint256 withdrawAmount) public returns (uint256 remainingBal) {
-        require(msg.sender == owner);
+		require(msg.sender == owner, "You are not the owner");
         balance -= withdrawAmount;
         (bool success, ) = payable(msg.sender).call{value: withdrawAmount}("");
         require(success, "Transfer failed");

substrate/frame/revive/rpc/examples/js/contracts/Tracing.sol

@@ -0,0 +1,52 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+contract TracingCaller {
+	event TraceEvent(uint256 value, string message);
+    address payable public callee;
+
+	constructor(address payable _callee) public payable {
+        require(_callee != address(0), "Callee address cannot be zero");
+        callee = _callee;
+    }
+
+    function start(uint256 counter) external {
+        if (counter == 0) {
+			return;
+        }
+
+        uint256 paymentAmount = 0.01 ether;
+        callee.transfer(paymentAmount);
+
+        emit TraceEvent(counter, "before");
+		TracingCallee(callee).consumeGas(counter);
+		emit TraceEvent(counter, "after");
+
+        try TracingCallee(callee).failingFunction{value: paymentAmount}() {
+        } catch {
+        }
+
+		this.start(counter - 1);
+    }
+}
+
+contract TracingCallee {
+    event CalleeCalled(uint256 counter);
+
+    function consumeGas(uint256 counter) external {
+		// burn some gas
+        for (uint256 i = 0; i < 10; i++) {
+			uint256(keccak256(abi.encodePacked(i)));
+        }
+
+        emit CalleeCalled(counter);
+    }
+
+	function failingFunction() external payable {
+        require(false, "This function always fails");
+    }
+
+	// Enable contract to receive Ether
+    receive() external payable {}
+}
+

substrate/frame/revive/rpc/examples/js/package.json

@@ -7,12 +7,14 @@
 		"dev": "vite",
 		"build": "tsc && vite build",
 		"preview": "vite preview",
-		"prettier": "prettier --write ."
+		"prettier": "prettier --write .",
+		"solhint": "solhint \"contracts/**/*.sol\""
 	},
 	"dependencies": {
 		"@parity/revive": "^0.0.9",
 		"ethers": "^6.13.5",
 		"solc": "^0.8.28",
+		"solhint": "^5.0.5",
 		"viem": "^2.22.4"
 	},
 	"devDependencies": {