Kanas/module invalidity

prdoc/pr_11724.prdoc

@@ -0,0 +1,17 @@
+title: Kanas/module invalidity
+doc:
+- audience:
+  - Node Dev
+  - Runtime Dev
+  description: |-
+    # Description
+
+    This PR implements descriptive module invalidity support for transactions as proposed in #11337. It extends the `InvalidTransaction` enum with a new `Module(ModuleError)` variant, allowing pallets to return pallet-specific, descriptive error data during the transaction validation phase (e.g., in `TransactionExtension`).
+
+crates:
+- name: sc-rpc-api
+  bump: minor
+- name: sc-rpc-spec-v2
+  bump: minor
+- name: sp-runtime
+  bump: minor

substrate/client/rpc-api/src/author/error.rs

@@ -111,6 +111,13 @@ impl From<Error> for ErrorObjectOwned {
 					Some(format!("Custom error: {}", e)),
 				)
 			},
+			Error::Pool(PoolError::InvalidTransaction(InvalidTransaction::Module(e))) => {
+				ErrorObject::owned(
+					POOL_INVALID_TX,
+					"Invalid Transaction",
+					Some(format!("Module error: index: {}, error: {:?}", e.index, e.error)),
+				)
+			},
 			Error::Pool(PoolError::InvalidTransaction(e)) => {
 				let msg: &str = e.into();
 				ErrorObject::owned(

substrate/client/rpc-spec-v2/src/transaction/error.rs

@@ -47,6 +47,14 @@ impl<Hash> From<Error> for TransactionEvent<Hash> {
 					error: format!("Invalid transaction with custom error: {}", e),
 				})
 			},
+			Error::Pool(PoolError::InvalidTransaction(InvalidTransaction::Module(e))) => {
+				TransactionEvent::Invalid(TransactionError {
+					error: format!(
+						"Invalid transaction: Module error: index: {}, error: {:?}",
+						e.index, e.error
+					),
+				})
+			},
 			Error::Pool(PoolError::InvalidTransaction(e)) => {
 				let msg: &str = e.into();
 				TransactionEvent::Invalid(TransactionError {

substrate/primitives/runtime/src/transaction_validity.rs

@@ -19,7 +19,7 @@
 
 use crate::{
 	codec::{Decode, Encode},
-	Debug,
+	Debug, ModuleError,
 };
 use alloc::{vec, vec::Vec};
 use scale_info::TypeInfo;
@@ -89,6 +89,8 @@ pub enum InvalidTransaction {
 	IndeterminateImplicit,
 	/// The transaction extension did not authorize any origin.
 	UnknownOrigin,
+	/// An error in a module.
+	Module(ModuleError),
 }
 
 impl InvalidTransaction {
@@ -129,6 +131,9 @@ impl From<InvalidTransaction> for &'static str {
 			InvalidTransaction::UnknownOrigin => {
 				"The transaction extension did not authorize any origin"
 			},
+			InvalidTransaction::Module(ModuleError { message, .. }) => {
+				message.unwrap_or("Unknown module error")
+			},
 		}
 	}
 }
@@ -480,7 +485,7 @@ mod tests {
 		);
 
 		// decode back
-		assert_eq!(TransactionValidity::decode(&mut &*encoded), Ok(v));
+		assert_eq!(TransactionValidity::decode(&mut &*encoded), Ok(v.clone()));
 	}
 
 	#[test]
@@ -507,4 +512,23 @@ mod tests {
 			}
 		);
 	}
+
+	#[test]
+	fn module_invalidity_should_encode_and_decode() {
+		let v: TransactionValidity = Err(InvalidTransaction::Module(ModuleError {
+			index: 1,
+			error: [2, 0, 0, 0],
+			message: Some("Test error"),
+		})
+		.into());
+
+		let encoded = v.encode();
+		assert_eq!(TransactionValidity::decode(&mut &*encoded), Ok(v.clone()));
+
+		let error_str: &'static str = match v {
+			Err(TransactionValidityError::Invalid(e)) => e.into(),
+			_ => panic!("Expected invalid error"),
+		};
+		assert_eq!(error_str, "Test error");
+	}
 }