docs: add documentation to OnCheckEvmTransaction trait

Grigoriy Simonov · Grigoriy Simonov · commit 3fce93280d9e · 2023-09-21T07:15:47.000Z
diff --git a/frame/evm/src/lib.rs b/frame/evm/src/lib.rs
@@ -1055,13 +1055,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
`@@ -1055,13 +1055,20 @@ impl<T> OnCreate<T> for Tuple {`
`1055`	`1055`	`}`
`1056`	`1056`	`}`
`1057`	`1057`
	`1058`	`+/// Implements additional EVM transaction validation logic`
`1058`	`1059`	`pub trait OnCheckEvmTransaction<T: Config> {`
	`1060`	`+ /// Validate EVM transaction.`
	`1061`	`+ ///`
	`1062`	`+ /// This method should be called before frontier's built-in validations.`
	`1063`	`+ ///`
	`1064`	+ /// - `v`: Transaction data to validate. Method can modify transaction data before frontier's built-in validations.
`1059`	`1065`	`fn on_check_evm_transaction(`
`1060`	`1066`	`v: &mut CheckEvmTransaction,`
`1061`	`1067`	`origin: &H160,`
`1062`	`1068`	`) -> Result<(), TransactionValidationError>;`
`1063`	`1069`	`}`
`1064`	`1070`
	`1071`	`+/// Implementation for () does not specify any additional validations.`
`1065`	`1072`	`impl<T: Config> OnCheckEvmTransaction<T> for () {`
`1066`	`1073`	`fn on_check_evm_transaction(`
`1067`	`1074`	`_v: &mut CheckEvmTransaction,`