Allow modules to validate transaction, second attempt (#2463)

* first impl * rename origin::inherent to none * fix * fix * Apply suggestions from code review Co-Authored-By: thiolliere <gui.thiolliere@gmail.com> * comment * better error * doc * (add unsigned module 🤦) * doc * fix * implement for node-template as well * add validated unsigned to executor * fix * fix * bump version * testing xt * remove extraneous logic * licence * impl test
2026-04-27 12:48:00 +00:00 · 2019-05-10 14:13:05 +02:00
parent 4aa44ab280
commit dfbaedd535
22 changed files with 414 additions and 85 deletions
@@ -0,0 +1,153 @@
+// Copyright 2019 Parity Technologies (UK) Ltd.
+// This file is part of Substrate.
+
+// Substrate is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// Substrate is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with Substrate.  If not, see <http://www.gnu.org/licenses/>.
+
+#[doc(hidden)]
+pub use crate::runtime_primitives::traits::ValidateUnsigned;
+#[doc(hidden)]
+pub use crate::runtime_primitives::transaction_validity::TransactionValidity;
+#[doc(hidden)]
+pub use crate::runtime_primitives::ApplyError;
+
+
+/// Implement `ValidateUnsigned` for `Runtime`.
+/// All given modules need to implement `ValidateUnsigned`.
+///
+/// # Example
+///
+/// ```
+/// # mod timestamp {
+/// # 	pub struct Module;
+/// #
+/// # 	impl srml_support::unsigned::ValidateUnsigned for Module {
+/// # 		type Call = Call;
+/// #
+/// # 		fn validate_unsigned(call: &Self::Call) -> srml_support::unsigned::TransactionValidity {
+/// # 			unimplemented!();
+/// # 		}
+/// # 	}
+/// #
+/// # 	pub enum Call {
+/// # 	}
+/// # }
+/// #
+/// # pub type Timestamp = timestamp::Module;
+/// #
+/// #
+/// # pub enum Call {
+/// # 	Timestamp(timestamp::Call),
+/// # }
+/// # #[allow(unused)]
+/// pub struct Runtime;
+///
+/// srml_support::impl_outer_validate_unsigned! {
+/// 	impl ValidateUnsigned for Runtime {
+/// 		Timestamp
+/// 	}
+/// }
+/// ```
+#[macro_export]
+macro_rules! impl_outer_validate_unsigned {
+	(
+		impl ValidateUnsigned for $runtime:ident {
+			$( $module:ident )*
+		}
+	) => {
+		impl $crate::unsigned::ValidateUnsigned for $runtime {
+			type Call = Call;
+
+			fn validate_unsigned(call: &Self::Call) -> $crate::unsigned::TransactionValidity {
+				#[allow(unreachable_patterns)]
+				match call {
+					$( Call::$module(inner_call) => $module::validate_unsigned(inner_call), )*
+					_ => $crate::unsigned::TransactionValidity::Invalid($crate::unsigned::ApplyError::BadSignature as i8),
+				}
+			}
+		}
+	};
+}
+
+#[cfg(test)]
+mod test_empty_call {
+	pub enum Call {
+	}
+
+	pub struct Runtime;
+
+	impl_outer_validate_unsigned! {
+		impl ValidateUnsigned for Runtime {
+		}
+	}
+}
+
+#[cfg(test)]
+mod test_partial_and_full_call {
+	pub mod timestamp {
+		pub struct Module;
+
+		impl super::super::ValidateUnsigned for Module {
+			type Call = Call;
+
+			fn validate_unsigned(_call: &Self::Call) -> super::super::TransactionValidity {
+				unimplemented!();
+			}
+		}
+
+		pub enum Call {
+			Foo,
+		}
+	}
+
+	mod test_full_unsigned {
+		pub type Timestamp = super::timestamp::Module;
+
+		pub enum Call {
+			Timestamp(super::timestamp::Call),
+		}
+
+		pub struct Runtime;
+
+		impl_outer_validate_unsigned! {
+			impl ValidateUnsigned for Runtime {
+				Timestamp
+			}
+		}
+
+		#[test]
+		fn used() {
+			let _ = Call::Timestamp(super::timestamp::Call::Foo);
+			let _ = Runtime;
+		}
+	}
+
+	mod test_not_full_unsigned {
+		pub enum Call {
+			Timestamp(super::timestamp::Call),
+		}
+
+		pub struct Runtime;
+
+		impl_outer_validate_unsigned! {
+			impl ValidateUnsigned for Runtime {
+			}
+		}
+
+		#[test]
+		fn used() {
+			let _ = Call::Timestamp(super::timestamp::Call::Foo);
+			let _ = Runtime;
+		}
+	}
+}