docs: add documentation to OnCheckEvmTransaction trait

Grigoriy Simonov · Grigoriy Simonov · commit 777cabefbb90 · 2023-09-11T07:21:01.000Z
diff --git a/frame/evm/src/lib.rs b/frame/evm/src/lib.rs
@@ -1051,13 +1051,20 @@ impl<T> OnCreate<T> for Tuple {
 	}
 }
 
+/// Implements additional EVM transaction validation logic
 pub trait OnCheckEvmTransaction<T: Config> {
+	/// Validate EVM transaction.
+	///
+	/// This method should be called before frontier's built-in validations.
+	///
+	/// - `v`: Transaction data to validate. Method can modify transaction data before frontier's built-in validations.
 	fn on_check_evm_transaction(
 		v: &mut CheckEvmTransaction,
 		origin: &H160,
 	) -> Result<(), TransactionValidationError>;
 }
 
+/// Implementation for () does not specify any additional validations.
 impl<T: Config> OnCheckEvmTransaction<T> for () {
 	fn on_check_evm_transaction(
 		_v: &mut CheckEvmTransaction,

Original file line number	Diff line number	Diff line change
`@@ -1051,13 +1051,20 @@ impl<T> OnCreate<T> for Tuple {`
`1051`	`1051`	`}`
`1052`	`1052`	`}`
`1053`	`1053`
	`1054`	`+/// Implements additional EVM transaction validation logic`
`1054`	`1055`	`pub trait OnCheckEvmTransaction<T: Config> {`
	`1056`	`+ /// Validate EVM transaction.`
	`1057`	`+ ///`
	`1058`	`+ /// This method should be called before frontier's built-in validations.`
	`1059`	`+ ///`
	`1060`	+ /// - `v`: Transaction data to validate. Method can modify transaction data before frontier's built-in validations.
`1055`	`1061`	`fn on_check_evm_transaction(`
`1056`	`1062`	`v: &mut CheckEvmTransaction,`
`1057`	`1063`	`origin: &H160,`
`1058`	`1064`	`) -> Result<(), TransactionValidationError>;`
`1059`	`1065`	`}`
`1060`	`1066`
	`1067`	`+/// Implementation for () does not specify any additional validations.`
`1061`	`1068`	`impl<T: Config> OnCheckEvmTransaction<T> for () {`
`1062`	`1069`	`fn on_check_evm_transaction(`
`1063`	`1070`	`_v: &mut CheckEvmTransaction,`