[pallet-revive] add tracing for selfdestruct

prdoc/pr_10244.prdoc

@@ -0,0 +1,7 @@
+title: '[pallet-revive] add tracing for selfdestruct'
+doc:
+- audience: Runtime Dev
+  description: Add tracing for selfdestruct
+crates:
+- name: pallet-revive
+  bump: patch

substrate/frame/revive/src/evm/api/debug_rpc_types.rs

@@ -163,6 +163,8 @@ pub enum CallType {
 	Create,
 	/// A create2 call.
 	Create2,
+	/// A selfdestruct call.
+	Selfdestruct,
 }
 
 /// A Trace

substrate/frame/revive/src/evm/tracing/call_tracing.rs

@@ -61,6 +61,16 @@ impl<Gas: Default, GasMapper: Fn(Weight) -> Gas> Tracing for CallTracer<Gas, Gas
 		self.code_with_salt = Some((code.clone(), salt.is_some()));
 	}
 
+	fn terminate(&mut self, from: H160, gas_left: Weight) {
+		self.traces.push(CallTrace {
+			from,
+			to: H160::zero(),
+			call_type: CallType::Selfdestruct,
+			gas: (self.gas_mapper)(gas_left),
+			..Default::default()
+		});
+	}
+
 	fn enter_child_span(
 		&mut self,
 		from: H160,

substrate/frame/revive/src/exec.rs

@@ -1727,6 +1727,12 @@ where
 	}
 
 	fn terminate_if_same_tx(&mut self, beneficiary: &H160) -> Result<CodeRemoved, DispatchError> {
+		if_tracing(|tracer| {
+			tracer.terminate(
+				self.caller().account_id().map(T::AddressMapper::to_address).unwrap_or_default(),
+				self.top_frame().nested_gas.gas_left(),
+			);
+		});
 		let (account_id, contract_address, contract_info) = {
 			let frame = self.top_frame_mut();
 			if frame.entry_point == ExportedFunction::Constructor {

substrate/frame/revive/src/tests/pvm.rs

@@ -5165,3 +5165,35 @@ fn existential_deposit_shall_not_charged_twice() {
 		assert_eq!(get_balance(&callee_account), Contracts::min_balance());
 	});
 }
+
+#[test]
+fn self_destruct_by_syscall_tracing_works() {
+	let (binary, _code_hash) = compile_module("self_destruct_by_syscall").unwrap();
+	ExtBuilder::default().existential_deposit(50).build().execute_with(|| {
+		let _ = <Test as Config>::Currency::set_balance(&ALICE, 1_000_000);
+		let mut tracer = CallTracer::new(Default::default(), |_| U256::zero());
+
+		// Instantiate the BOB contract.
+		let Contract { addr, .. } = builder::bare_instantiate(Code::Upload(binary))
+			.native_value(100_000)
+			.build_and_unwrap_contract();
+
+		// Check that the BOB contract has been instantiated.
+		get_contract(&addr);
+
+		trace(&mut tracer, || {
+			builder::call(addr).build().unwrap();
+		});
+
+		let trace = tracer.collect_trace();
+		assert_eq!(
+			trace,
+			Some(CallTrace {
+				from: ALICE_ADDR,
+				to: H160::zero(),
+				call_type: CallType::Selfdestruct,
+				..Default::default()
+			})
+		);
+	});
+}

substrate/frame/revive/src/tracing.rs

@@ -58,6 +58,9 @@ pub trait Tracing {
 	) {
 	}
 
+	/// Called when a contract calls terminates (selfdestructs)
+	fn terminate(&mut self, _from: H160, _gas_left: Weight) {}
+
 	/// Record the next code and salt to be instantiated.
 	fn instantiate_code(&mut self, _code: &Code, _salt: Option<&[u8; 32]>) {}