Rename pallet trait Trait to Config (#7599)

* rename Trait to Config

* add test asserting using Trait is still valid.

* fix ui tests

Author: gui1117

src/benchmarking.rs

@@ -31,7 +31,7 @@ use frame_system::Module as System;
 const BLOCK_NUMBER: u32 = 2;
 
 // Add `n` named items to the schedule
-fn fill_schedule<T: Trait> (when: T::BlockNumber, n: u32) -> Result<(), &'static str> {
+fn fill_schedule<T: Config> (when: T::BlockNumber, n: u32) -> Result<(), &'static str> {
 	// Essentially a no-op call.
 	let call = frame_system::Call::set_storage(vec![]);
 	for i in 0..n {

src/lib.rs

@@ -18,7 +18,7 @@
 //! # Scheduler
 //! A module for scheduling dispatches.
 //!
-//! - [`scheduler::Trait`](./trait.Trait.html)
+//! - [`scheduler::Config`](./trait.Config.html)
 //! - [`Call`](./enum.Call.html)
 //! - [`Module`](./struct.Module.html)
 //!
@@ -29,7 +29,7 @@
 //! may be named or anonymous and may be canceled.
 //!
 //! **NOTE:** The scheduled calls will be dispatched with the default filter
-//! for the origin: namely `frame_system::Trait::BaseCallFilter` for all origin
+//! for the origin: namely `frame_system::Config::BaseCallFilter` for all origin
 //! except root which will get no filter. And not the filter contained in origin
 //! use to call `fn schedule`.
 //!
@@ -70,27 +70,27 @@ pub use weights::WeightInfo;
 /// pallet is dependent on specific other pallets, then their configuration traits
 /// should be added to our implied traits list.
 ///
-/// `system::Trait` should always be included in our implied traits.
-pub trait Trait: system::Trait {
+/// `system::Config` should always be included in our implied traits.
+pub trait Config: system::Config {
 	/// The overarching event type.
-	type Event: From<Event<Self>> + Into<<Self as system::Trait>::Event>;
+	type Event: From<Event<Self>> + Into<<Self as system::Config>::Event>;
 
 	/// The aggregated origin which the dispatch will take.
 	type Origin: OriginTrait<PalletsOrigin =
-		Self::PalletsOrigin> + From<Self::PalletsOrigin> + IsType<<Self as system::Trait>::Origin>;
+		Self::PalletsOrigin> + From<Self::PalletsOrigin> + IsType<<Self as system::Config>::Origin>;
 
 	/// The caller origin, overarching type of all pallets origins.
 	type PalletsOrigin: From<system::RawOrigin<Self::AccountId>> + Codec + Clone + Eq;
 
 	/// The aggregated call type.
-	type Call: Parameter + Dispatchable<Origin=<Self as Trait>::Origin> + GetDispatchInfo + From<system::Call<Self>>;
+	type Call: Parameter + Dispatchable<Origin=<Self as Config>::Origin> + GetDispatchInfo + From<system::Call<Self>>;
 
 	/// The maximum weight that may be scheduled per block for any dispatchables of less priority
 	/// than `schedule::HARD_DEADLINE`.
 	type MaximumWeight: Get<Weight>;
 
 	/// Required origin to schedule or cancel calls.
-	type ScheduleOrigin: EnsureOrigin<<Self as system::Trait>::Origin>;
+	type ScheduleOrigin: EnsureOrigin<<Self as system::Config>::Origin>;
 
 	/// The maximum number of scheduled calls in the queue for a single block.
 	/// Not strictly enforced, but used for weight estimation.
@@ -150,10 +150,10 @@ impl Default for Releases {
 }
 
 decl_storage! {
-	trait Store for Module<T: Trait> as Scheduler {
+	trait Store for Module<T: Config> as Scheduler {
 		/// Items to be executed, indexed by the block number that they should be executed on.
 		pub Agenda: map hasher(twox_64_concat) T::BlockNumber
-			=> Vec<Option<Scheduled<<T as Trait>::Call, T::BlockNumber, T::PalletsOrigin, T::AccountId>>>;
+			=> Vec<Option<Scheduled<<T as Config>::Call, T::BlockNumber, T::PalletsOrigin, T::AccountId>>>;
 
 		/// Lookup from identity to the block number and index of the task.
 		Lookup: map hasher(twox_64_concat) Vec<u8> => Option<TaskAddress<T::BlockNumber>>;
@@ -166,7 +166,7 @@ decl_storage! {
 }
 
 decl_event!(
-	pub enum Event<T> where <T as system::Trait>::BlockNumber {
+	pub enum Event<T> where <T as system::Config>::BlockNumber {
 		/// Scheduled some task. \[when, index\]
 		Scheduled(BlockNumber, u32),
 		/// Canceled some task. \[when, index\]
@@ -177,7 +177,7 @@ decl_event!(
 );
 
 decl_error! {
-	pub enum Error for Module<T: Trait> {
+	pub enum Error for Module<T: Config> {
 		/// Failed to schedule a call
 		FailedToSchedule,
 		/// Cannot find the scheduled call.
@@ -191,7 +191,7 @@ decl_error! {
 
 decl_module! {
 	/// Scheduler module declaration.
-	pub struct Module<T: Trait> for enum Call where origin: <T as system::Trait>::Origin {
+	pub struct Module<T: Config> for enum Call where origin: <T as system::Config>::Origin {
 		type Error = Error<T>;
 		fn deposit_event() = default;
 
@@ -210,10 +210,10 @@ decl_module! {
 			when: T::BlockNumber,
 			maybe_periodic: Option<schedule::Period<T::BlockNumber>>,
 			priority: schedule::Priority,
-			call: Box<<T as Trait>::Call>,
+			call: Box<<T as Config>::Call>,
 		) {
 			T::ScheduleOrigin::ensure_origin(origin.clone())?;
-			let origin = <T as Trait>::Origin::from(origin);
+			let origin = <T as Config>::Origin::from(origin);
 			Self::do_schedule(DispatchTime::At(when), maybe_periodic, priority, origin.caller().clone(), *call)?;
 		}
 
@@ -230,7 +230,7 @@ decl_module! {
 		#[weight = T::WeightInfo::cancel(T::MaxScheduledPerBlock::get())]
 		fn cancel(origin, when: T::BlockNumber, index: u32) {
 			T::ScheduleOrigin::ensure_origin(origin.clone())?;
-			let origin = <T as Trait>::Origin::from(origin);
+			let origin = <T as Config>::Origin::from(origin);
 			Self::do_cancel(Some(origin.caller().clone()), (when, index))?;
 		}
 
@@ -250,10 +250,10 @@ decl_module! {
 			when: T::BlockNumber,
 			maybe_periodic: Option<schedule::Period<T::BlockNumber>>,
 			priority: schedule::Priority,
-			call: Box<<T as Trait>::Call>,
+			call: Box<<T as Config>::Call>,
 		) {
 			T::ScheduleOrigin::ensure_origin(origin.clone())?;
-			let origin = <T as Trait>::Origin::from(origin);
+			let origin = <T as Config>::Origin::from(origin);
 			Self::do_schedule_named(
 				id, DispatchTime::At(when), maybe_periodic, priority, origin.caller().clone(), *call
 			)?;
@@ -272,7 +272,7 @@ decl_module! {
 		#[weight = T::WeightInfo::cancel_named(T::MaxScheduledPerBlock::get())]
 		fn cancel_named(origin, id: Vec<u8>) {
 			T::ScheduleOrigin::ensure_origin(origin.clone())?;
-			let origin = <T as Trait>::Origin::from(origin);
+			let origin = <T as Config>::Origin::from(origin);
 			Self::do_cancel_named(Some(origin.caller().clone()), id)?;
 		}
 
@@ -286,10 +286,10 @@ decl_module! {
 			after: T::BlockNumber,
 			maybe_periodic: Option<schedule::Period<T::BlockNumber>>,
 			priority: schedule::Priority,
-			call: Box<<T as Trait>::Call>,
+			call: Box<<T as Config>::Call>,
 		) {
 			T::ScheduleOrigin::ensure_origin(origin.clone())?;
-			let origin = <T as Trait>::Origin::from(origin);
+			let origin = <T as Config>::Origin::from(origin);
 			Self::do_schedule(
 				DispatchTime::After(after), maybe_periodic, priority, origin.caller().clone(), *call
 			)?;
@@ -306,10 +306,10 @@ decl_module! {
 			after: T::BlockNumber,
 			maybe_periodic: Option<schedule::Period<T::BlockNumber>>,
 			priority: schedule::Priority,
-			call: Box<<T as Trait>::Call>,
+			call: Box<<T as Config>::Call>,
 		) {
 			T::ScheduleOrigin::ensure_origin(origin.clone())?;
-			let origin = <T as Trait>::Origin::from(origin);
+			let origin = <T as Config>::Origin::from(origin);
 			Self::do_schedule_named(
 				id, DispatchTime::After(after), maybe_periodic, priority, origin.caller().clone(), *call
 			)?;
@@ -347,7 +347,7 @@ decl_module! {
 					*cumulative_weight = cumulative_weight
 						.saturating_add(s.call.get_dispatch_info().weight);
 
-					let origin = <<T as Trait>::Origin as From<T::PalletsOrigin>>::from(
+					let origin = <<T as Config>::Origin as From<T::PalletsOrigin>>::from(
 						s.origin.clone()
 					).into();
 
@@ -415,15 +415,15 @@ decl_module! {
 	}
 }
 
-impl<T: Trait> Module<T> {
+impl<T: Config> Module<T> {
 	/// Migrate storage format from V1 to V2.
 	/// Return true if migration is performed.
 	pub fn migrate_v1_to_t2() -> bool {
 		if StorageVersion::get() == Releases::V1 {
 			StorageVersion::put(Releases::V2);
 
 			Agenda::<T>::translate::<
-				Vec<Option<ScheduledV1<<T as Trait>::Call, T::BlockNumber>>>, _
+				Vec<Option<ScheduledV1<<T as Config>::Call, T::BlockNumber>>>, _
 			>(|_, agenda| Some(
 				agenda
 					.into_iter()
@@ -447,7 +447,7 @@ impl<T: Trait> Module<T> {
 	/// Helper to migrate scheduler when the pallet origin type has changed.
 	pub fn migrate_origin<OldOrigin: Into<T::PalletsOrigin> + codec::Decode>() {
 		Agenda::<T>::translate::<
-			Vec<Option<Scheduled<<T as Trait>::Call, T::BlockNumber, OldOrigin, T::AccountId>>>, _
+			Vec<Option<Scheduled<<T as Config>::Call, T::BlockNumber, OldOrigin, T::AccountId>>>, _
 		>(|_, agenda| Some(
 			agenda
 				.into_iter()
@@ -485,7 +485,7 @@ impl<T: Trait> Module<T> {
 		maybe_periodic: Option<schedule::Period<T::BlockNumber>>,
 		priority: schedule::Priority,
 		origin: T::PalletsOrigin,
-		call: <T as Trait>::Call
+		call: <T as Config>::Call
 	) -> Result<TaskAddress<T::BlockNumber>, DispatchError> {
 		let when = Self::resolve_time(when)?;
 
@@ -569,7 +569,7 @@ impl<T: Trait> Module<T> {
 		maybe_periodic: Option<schedule::Period<T::BlockNumber>>,
 		priority: schedule::Priority,
 		origin: T::PalletsOrigin,
-		call: <T as Trait>::Call,
+		call: <T as Config>::Call,
 	) -> Result<TaskAddress<T::BlockNumber>, DispatchError> {
 		// ensure id it is unique
 		if Lookup::<T>::contains_key(&id) {
@@ -657,15 +657,15 @@ impl<T: Trait> Module<T> {
 	}
 }
 
-impl<T: Trait> schedule::Anon<T::BlockNumber, <T as Trait>::Call, T::PalletsOrigin> for Module<T> {
+impl<T: Config> schedule::Anon<T::BlockNumber, <T as Config>::Call, T::PalletsOrigin> for Module<T> {
 	type Address = TaskAddress<T::BlockNumber>;
 
 	fn schedule(
 		when: DispatchTime<T::BlockNumber>,
 		maybe_periodic: Option<schedule::Period<T::BlockNumber>>,
 		priority: schedule::Priority,
 		origin: T::PalletsOrigin,
-		call: <T as Trait>::Call
+		call: <T as Config>::Call
 	) -> Result<Self::Address, DispatchError> {
 		Self::do_schedule(when, maybe_periodic, priority, origin, call)
 	}
@@ -686,7 +686,7 @@ impl<T: Trait> schedule::Anon<T::BlockNumber, <T as Trait>::Call, T::PalletsOrig
 	}
 }
 
-impl<T: Trait> schedule::Named<T::BlockNumber, <T as Trait>::Call, T::PalletsOrigin> for Module<T> {
+impl<T: Config> schedule::Named<T::BlockNumber, <T as Config>::Call, T::PalletsOrigin> for Module<T> {
 	type Address = TaskAddress<T::BlockNumber>;
 
 	fn schedule_named(
@@ -695,7 +695,7 @@ impl<T: Trait> schedule::Named<T::BlockNumber, <T as Trait>::Call, T::PalletsOri
 		maybe_periodic: Option<schedule::Period<T::BlockNumber>>,
 		priority: schedule::Priority,
 		origin: T::PalletsOrigin,
-		call: <T as Trait>::Call,
+		call: <T as Config>::Call,
 	) -> Result<Self::Address, ()> {
 		Self::do_schedule_named(id, when, maybe_periodic, priority, origin, call).map_err(|_| ())
 	}
@@ -746,19 +746,19 @@ mod tests {
 		pub fn log() -> Vec<(OriginCaller, u32)> {
 			LOG.with(|log| log.borrow().clone())
 		}
-		pub trait Trait: system::Trait {
-			type Event: From<Event> + Into<<Self as system::Trait>::Event>;
+		pub trait Config: system::Config {
+			type Event: From<Event> + Into<<Self as system::Config>::Event>;
 		}
 		decl_event! {
 			pub enum Event {
 				Logged(u32, Weight),
 			}
 		}
 		decl_module! {
-			pub struct Module<T: Trait> for enum Call
+			pub struct Module<T: Config> for enum Call
 			where
-				origin: <T as system::Trait>::Origin,
-				<T as system::Trait>::Origin: OriginTrait<PalletsOrigin = OriginCaller>
+				origin: <T as system::Config>::Origin,
+				<T as system::Config>::Origin: OriginTrait<PalletsOrigin = OriginCaller>
 			{
 				fn deposit_event() = default;
 
@@ -816,7 +816,7 @@ mod tests {
 		pub const MaximumBlockLength: u32 = 2 * 1024;
 		pub const AvailableBlockRatio: Perbill = Perbill::one();
 	}
-	impl system::Trait for Test {
+	impl system::Config for Test {
 		type BaseCallFilter = BaseFilter;
 		type Origin = Origin;
 		type Call = Call;
@@ -843,7 +843,7 @@ mod tests {
 		type OnKilledAccount = ();
 		type SystemWeightInfo = ();
 	}
-	impl logger::Trait for Test {
+	impl logger::Config for Test {
 		type Event = ();
 	}
 	parameter_types! {
@@ -854,7 +854,7 @@ mod tests {
 		pub const One: u64 = 1;
 	}
 
-	impl Trait for Test {
+	impl Config for Test {
 		type Event = ();
 		type Origin = Origin;
 		type PalletsOrigin = OriginCaller;
@@ -889,7 +889,7 @@ mod tests {
 	fn basic_scheduling_works() {
 		new_test_ext().execute_with(|| {
 			let call = Call::Logger(logger::Call::log(42, 1000));
-			assert!(!<Test as frame_system::Trait>::BaseCallFilter::filter(&call));
+			assert!(!<Test as frame_system::Config>::BaseCallFilter::filter(&call));
 			assert_ok!(Scheduler::do_schedule(DispatchTime::At(4), None, 127, root(), call));
 			run_to_block(3);
 			assert!(logger::log().is_empty());
@@ -905,7 +905,7 @@ mod tests {
 		new_test_ext().execute_with(|| {
 			run_to_block(2);
 			let call = Call::Logger(logger::Call::log(42, 1000));
-			assert!(!<Test as frame_system::Trait>::BaseCallFilter::filter(&call));
+			assert!(!<Test as frame_system::Config>::BaseCallFilter::filter(&call));
 			// This will schedule the call 3 blocks after the next block... so block 3 + 3 = 6
 			assert_ok!(Scheduler::do_schedule(DispatchTime::After(3), None, 127, root(), call));
 			run_to_block(5);
@@ -922,7 +922,7 @@ mod tests {
 		new_test_ext().execute_with(|| {
 			run_to_block(2);
 			let call = Call::Logger(logger::Call::log(42, 1000));
-			assert!(!<Test as frame_system::Trait>::BaseCallFilter::filter(&call));
+			assert!(!<Test as frame_system::Config>::BaseCallFilter::filter(&call));
 			assert_ok!(Scheduler::do_schedule(DispatchTime::After(0), None, 127, root(), call));
 			// Will trigger on the next block.
 			run_to_block(3);
@@ -960,7 +960,7 @@ mod tests {
 	fn reschedule_works() {
 		new_test_ext().execute_with(|| {
 			let call = Call::Logger(logger::Call::log(42, 1000));
-			assert!(!<Test as frame_system::Trait>::BaseCallFilter::filter(&call));
+			assert!(!<Test as frame_system::Config>::BaseCallFilter::filter(&call));
 			assert_eq!(Scheduler::do_schedule(DispatchTime::At(4), None, 127, root(), call).unwrap(), (4, 0));
 
 			run_to_block(3);
@@ -985,7 +985,7 @@ mod tests {
 	fn reschedule_named_works() {
 		new_test_ext().execute_with(|| {
 			let call = Call::Logger(logger::Call::log(42, 1000));
-			assert!(!<Test as frame_system::Trait>::BaseCallFilter::filter(&call));
+			assert!(!<Test as frame_system::Config>::BaseCallFilter::filter(&call));
 			assert_eq!(Scheduler::do_schedule_named(
 				1u32.encode(), DispatchTime::At(4), None, 127, root(), call
 			).unwrap(), (4, 0));
@@ -1012,7 +1012,7 @@ mod tests {
 	fn reschedule_named_perodic_works() {
 		new_test_ext().execute_with(|| {
 			let call = Call::Logger(logger::Call::log(42, 1000));
-			assert!(!<Test as frame_system::Trait>::BaseCallFilter::filter(&call));
+			assert!(!<Test as frame_system::Config>::BaseCallFilter::filter(&call));
 			assert_eq!(Scheduler::do_schedule_named(
 				1u32.encode(), DispatchTime::At(4), Some((3, 3)), 127, root(), call
 			).unwrap(), (4, 0));
@@ -1203,10 +1203,10 @@ mod tests {
 	#[test]
 	fn on_initialize_weight_is_correct() {
 		new_test_ext().execute_with(|| {
-			let base_weight: Weight = <Test as frame_system::Trait>::DbWeight::get().reads_writes(1, 2);
+			let base_weight: Weight = <Test as frame_system::Config>::DbWeight::get().reads_writes(1, 2);
 			let base_multiplier = 0;
-			let named_multiplier = <Test as frame_system::Trait>::DbWeight::get().writes(1);
-			let periodic_multiplier = <Test as frame_system::Trait>::DbWeight::get().reads_writes(1, 1);
+			let named_multiplier = <Test as frame_system::Config>::DbWeight::get().writes(1);
+			let periodic_multiplier = <Test as frame_system::Config>::DbWeight::get().reads_writes(1, 1);
 
 			// Named
 			assert_ok!(

src/weights.rs

@@ -52,7 +52,7 @@ pub trait WeightInfo {
 
 /// Weights for pallet_scheduler using the Substrate node and recommended hardware.
 pub struct SubstrateWeight<T>(PhantomData<T>);
-impl<T: frame_system::Trait> WeightInfo for SubstrateWeight<T> {
+impl<T: frame_system::Config> WeightInfo for SubstrateWeight<T> {
 	fn schedule(s: u32, ) -> Weight {
 		(35_029_000 as Weight)
 			.saturating_add((77_000 as Weight).saturating_mul(s as Weight))