change: replace abstract ScEpochNumber with domain type in selection pallet (#1068)

Author: AmbientTea

demo/runtime/src/lib.rs

@@ -343,7 +343,6 @@ impl pallet_session_validator_management::Config for Runtime {
 	type AuthorityId = CrossChainPublic;
 	type AuthorityKeys = SessionKeys;
 	type AuthoritySelectionInputs = AuthoritySelectionInputs;
-	type ScEpochNumber = ScEpochNumber;
 	type WeightInfo = pallet_session_validator_management::weights::SubstrateWeight<Runtime>;
 	type CommitteeMember = CommitteeMember<CrossChainPublic, SessionKeys>;
 	type MainChainScriptsOrigin = EnsureRoot<Self::AccountId>;

demo/runtime/src/mock.rs

@@ -165,7 +165,6 @@ impl pallet_session_validator_management::Config for Test {
 	type AuthorityId = CrossChainPublic;
 	type AuthorityKeys = TestSessionKeys;
 	type AuthoritySelectionInputs = AuthoritySelectionInputs;
-	type ScEpochNumber = ScEpochNumber;
 	type CommitteeMember = (Self::AuthorityId, Self::AuthorityKeys);
 	type MainChainScriptsOrigin = EnsureRoot<Self::AccountId>;
 

toolkit/committee-selection/pallet/src/lib.rs

@@ -133,7 +133,6 @@
 //! 	type AuthorityId = CrossChainPublic;
 //! 	type AuthorityKeys = SessionKeys;
 //! 	type AuthoritySelectionInputs = authority_selection_inherents::AuthoritySelectionInputs;
-//! 	type ScEpochNumber = sidechain_domain::ScEpochNumber;
 //! 	type WeightInfo = pallet_session_validator_management::weights::SubstrateWeight<Runtime>;
 //! 	type CommitteeMember = authority_selection_inherents::CommitteeMember<CrossChainPublic, SessionKeys>;
 //! 	type MainChainScriptsOrigin = EnsureRoot<Self::AccountId>;
@@ -262,13 +261,12 @@ pub mod pallet {
 	use frame_system::pallet_prelude::*;
 	use log::{info, warn};
 	use sidechain_domain::byte_string::SizedByteString;
-	use sidechain_domain::{MainchainAddress, PolicyId};
+	use sidechain_domain::{MainchainAddress, PolicyId, ScEpochNumber};
 	use sp_core::blake2_256;
 	use sp_runtime::traits::{MaybeSerializeDeserialize, One, Zero};
 	use sp_session_validator_management::*;
 	use sp_std::collections::btree_set::BTreeSet;
-	use sp_std::fmt::Display;
-	use sp_std::{ops::Add, vec::Vec};
+	use sp_std::vec::Vec;
 
 	const STORAGE_VERSION: StorageVersion = StorageVersion::new(1);
 
@@ -292,18 +290,6 @@ pub mod pallet {
 		type AuthorityKeys: Parameter + Member + MaybeSerializeDeserialize + Ord + MaxEncodedLen;
 		/// Type of input data used by `select_authorities` to select a committee.
 		type AuthoritySelectionInputs: Parameter;
-		/// Type of the epoch number used by the partner chain.
-		type ScEpochNumber: Parameter
-			+ MaxEncodedLen
-			+ Zero
-			+ Display
-			+ Add
-			+ One
-			+ Default
-			+ Ord
-			+ Copy
-			+ From<u64>
-			+ Into<u64>;
 
 		/// Type of committee members returned by `select_authorities`.
 		type CommitteeMember: Parameter
@@ -319,11 +305,11 @@ pub mod pallet {
 		/// Should return [None] if selection was impossible for the given input.
 		fn select_authorities(
 			input: Self::AuthoritySelectionInputs,
-			sidechain_epoch: Self::ScEpochNumber,
+			sidechain_epoch: ScEpochNumber,
 		) -> Option<BoundedVec<Self::CommitteeMember, Self::MaxValidators>>;
 
 		/// Should return the current partner chain epoch.
-		fn current_epoch_number() -> Self::ScEpochNumber;
+		fn current_epoch_number() -> ScEpochNumber;
 
 		/// Weight functions needed for pallet_session_validator_management.
 		type WeightInfo: WeightInfo;
@@ -343,27 +329,23 @@ pub mod pallet {
 	#[derive(CloneNoBound, Encode, Decode, TypeInfo, MaxEncodedLen)]
 	#[scale_info(skip_type_params(MaxValidators))]
 	/// Committee info type used on-chain.
-	pub struct CommitteeInfo<ScEpochNumber: Clone, CommitteeMember: Clone, MaxValidators> {
+	pub struct CommitteeInfo<CommitteeMember: Clone, MaxValidators> {
 		/// Epoch number the committee is selected for.
 		pub epoch: ScEpochNumber,
 		/// List of committee members.
 		pub committee: BoundedVec<CommitteeMember, MaxValidators>,
 	}
 
-	impl<ScEpochNumber: Clone, CommitteeMember: Clone, MaxValidators>
-		CommitteeInfo<ScEpochNumber, CommitteeMember, MaxValidators>
-	{
+	impl<CommitteeMember: Clone, MaxValidators> CommitteeInfo<CommitteeMember, MaxValidators> {
 		/// Returns committee info as a pair of epoch number and list of committee members
 		pub fn as_pair(self) -> (ScEpochNumber, Vec<CommitteeMember>) {
 			(self.epoch, self.committee.to_vec())
 		}
 	}
 
-	impl<ScEpochNumber, CommitteeMember, MaxValidators> Default
-		for CommitteeInfo<ScEpochNumber, CommitteeMember, MaxValidators>
+	impl<CommitteeMember, MaxValidators> Default for CommitteeInfo<CommitteeMember, MaxValidators>
 	where
 		CommitteeMember: Clone,
-		ScEpochNumber: Clone + Zero,
 	{
 		fn default() -> Self {
 			Self { epoch: ScEpochNumber::zero(), committee: BoundedVec::new() }
@@ -375,18 +357,12 @@ pub mod pallet {
 		StorageValue<_, BoundedBTreeSet<T::AccountId, T::MaxValidators>, ValueQuery>;
 
 	#[pallet::storage]
-	pub type CurrentCommittee<T: Config> = StorageValue<
-		_,
-		CommitteeInfo<T::ScEpochNumber, T::CommitteeMember, T::MaxValidators>,
-		ValueQuery,
-	>;
+	pub type CurrentCommittee<T: Config> =
+		StorageValue<_, CommitteeInfo<T::CommitteeMember, T::MaxValidators>, ValueQuery>;
 
 	#[pallet::storage]
-	pub type NextCommittee<T: Config> = StorageValue<
-		_,
-		CommitteeInfo<T::ScEpochNumber, T::CommitteeMember, T::MaxValidators>,
-		OptionQuery,
-	>;
+	pub type NextCommittee<T: Config> =
+		StorageValue<_, CommitteeInfo<T::CommitteeMember, T::MaxValidators>, OptionQuery>;
 
 	/// Stores the stage of handling the inputs change. Used by session manager, to decide
 	/// if the session should be ended quickly, to speed up using the newly selected committee.
@@ -428,7 +404,7 @@ pub mod pallet {
 			ProvidedAccounts::<T>::set(provided_accounts.try_into().unwrap());
 
 			let committee_info =
-				CommitteeInfo { epoch: T::ScEpochNumber::zero(), committee: initial_authorities };
+				CommitteeInfo { epoch: ScEpochNumber::zero(), committee: initial_authorities };
 			CurrentCommittee::<T>::put(committee_info);
 			MainChainScriptsConfiguration::<T>::put(self.main_chain_scripts.clone());
 		}
@@ -545,7 +521,7 @@ pub mod pallet {
 		pub fn set(
 			origin: OriginFor<T>,
 			validators: BoundedVec<T::CommitteeMember, T::MaxValidators>,
-			for_epoch_number: T::ScEpochNumber,
+			for_epoch_number: ScEpochNumber,
 			selection_inputs_hash: SizedByteString<32>,
 		) -> DispatchResult {
 			ensure_none(origin)?;
@@ -588,7 +564,7 @@ pub mod pallet {
 
 	impl<T: Config> Pallet<T> {
 		/// Returns epoch number for which next committee hasn't been set yet.
-		pub fn get_next_unset_epoch_number() -> T::ScEpochNumber {
+		pub fn get_next_unset_epoch_number() -> ScEpochNumber {
 			NextCommittee::<T>::get()
 				.map(|next_committee| next_committee.epoch + One::one())
 				.unwrap_or(CurrentCommittee::<T>::get().epoch + One::one())
@@ -605,14 +581,13 @@ pub mod pallet {
 		}
 
 		/// Returns current committee from storage.
-		pub fn current_committee_storage()
-		-> CommitteeInfo<T::ScEpochNumber, T::CommitteeMember, T::MaxValidators> {
+		pub fn current_committee_storage() -> CommitteeInfo<T::CommitteeMember, T::MaxValidators> {
 			CurrentCommittee::<T>::get()
 		}
 
 		/// Returns next committee from storage.
 		pub fn next_committee_storage()
-		-> Option<CommitteeInfo<T::ScEpochNumber, T::CommitteeMember, T::MaxValidators>> {
+		-> Option<CommitteeInfo<T::CommitteeMember, T::MaxValidators>> {
 			NextCommittee::<T>::get()
 		}
 
@@ -644,7 +619,7 @@ pub mod pallet {
 		/// Calculates committee using configured `select_authorities` function
 		pub fn calculate_committee(
 			authority_selection_inputs: T::AuthoritySelectionInputs,
-			sidechain_epoch: T::ScEpochNumber,
+			sidechain_epoch: ScEpochNumber,
 		) -> Option<Vec<T::CommitteeMember>> {
 			T::select_authorities(authority_selection_inputs, sidechain_epoch).map(|c| c.to_vec())
 		}

toolkit/committee-selection/pallet/src/migrations/v0.rs

@@ -4,6 +4,7 @@ use frame_support::pallet_prelude::{OptionQuery, ValueQuery, Zero};
 use frame_support::{BoundedVec, CloneNoBound, storage_alias};
 use parity_scale_codec::{Decode, Encode, MaxEncodedLen};
 use scale_info::TypeInfo;
+use sidechain_domain::ScEpochNumber;
 
 #[derive(CloneNoBound, Encode, Decode, TypeInfo, MaxEncodedLen)]
 #[scale_info(skip_type_params(MaxValidators))]
@@ -17,12 +18,11 @@ pub struct LegacyCommitteeInfo<
 	pub committee: BoundedVec<(AuthorityId, AuthorityKeys), MaxValidators>,
 }
 
-impl<ScEpochNumber, AuthorityId, AuthorityKeys, MaxValidators> Default
+impl<AuthorityId, AuthorityKeys, MaxValidators> Default
 	for LegacyCommitteeInfo<ScEpochNumber, AuthorityId, AuthorityKeys, MaxValidators>
 where
 	AuthorityId: Clone,
 	AuthorityKeys: Clone,
-	ScEpochNumber: Clone + Zero,
 {
 	fn default() -> Self {
 		Self { epoch: ScEpochNumber::zero(), committee: BoundedVec::new() }
@@ -33,7 +33,7 @@ where
 pub type CurrentCommittee<T: crate::pallet::Config> = StorageValue<
 	crate::Pallet<T>,
 	LegacyCommitteeInfo<
-		<T as crate::pallet::Config>::ScEpochNumber,
+		ScEpochNumber,
 		<T as crate::pallet::Config>::AuthorityId,
 		<T as crate::pallet::Config>::AuthorityKeys,
 		<T as crate::pallet::Config>::MaxValidators,
@@ -45,7 +45,7 @@ pub type CurrentCommittee<T: crate::pallet::Config> = StorageValue<
 pub type NextCommittee<T: crate::pallet::Config> = StorageValue<
 	crate::Pallet<T>,
 	LegacyCommitteeInfo<
-		<T as crate::pallet::Config>::ScEpochNumber,
+		ScEpochNumber,
 		<T as crate::pallet::Config>::AuthorityId,
 		<T as crate::pallet::Config>::AuthorityKeys,
 		<T as crate::pallet::Config>::MaxValidators,

toolkit/committee-selection/pallet/src/migrations/v1.rs

@@ -2,6 +2,7 @@
 #[cfg(feature = "try-runtime")]
 extern crate alloc;
 use frame_support::traits::UncheckedOnRuntimeUpgrade;
+use sidechain_domain::ScEpochNumber;
 #[cfg(feature = "try-runtime")]
 use {
 	alloc::vec::Vec, parity_scale_codec::Encode, sp_session_validator_management::CommitteeMember,
@@ -30,32 +31,26 @@ where
 		use sp_runtime::BoundedVec;
 
 		let current_committee_v0 = v0::CurrentCommittee::<T>::get();
-		let current_committee_v1 = crate::pallet::CommitteeInfo::<
-			T::ScEpochNumber,
-			T::CommitteeMember,
-			T::MaxValidators,
-		> {
-			epoch: current_committee_v0.epoch,
-			committee: BoundedVec::truncate_from(
-				current_committee_v0.committee.into_iter().map(From::from).collect(),
-			),
-		};
+		let current_committee_v1 =
+			crate::pallet::CommitteeInfo::<T::CommitteeMember, T::MaxValidators> {
+				epoch: current_committee_v0.epoch,
+				committee: BoundedVec::truncate_from(
+					current_committee_v0.committee.into_iter().map(From::from).collect(),
+				),
+			};
 
 		crate::CurrentCommittee::<T>::put(current_committee_v1);
 
 		let Some(next_committee_v0) = v0::NextCommittee::<T>::get() else {
 			return T::DbWeight::get().reads_writes(2, 1);
 		};
-		let next_committee_v1 = crate::pallet::CommitteeInfo::<
-			T::ScEpochNumber,
-			T::CommitteeMember,
-			T::MaxValidators,
-		> {
-			epoch: next_committee_v0.epoch,
-			committee: BoundedVec::truncate_from(
-				next_committee_v0.committee.into_iter().map(From::from).collect(),
-			),
-		};
+		let next_committee_v1 =
+			crate::pallet::CommitteeInfo::<T::CommitteeMember, T::MaxValidators> {
+				epoch: next_committee_v0.epoch,
+				committee: BoundedVec::truncate_from(
+					next_committee_v0.committee.into_iter().map(From::from).collect(),
+				),
+			};
 
 		crate::NextCommittee::<T>::put(next_committee_v1);
 
@@ -76,15 +71,10 @@ where
 		use v0::LegacyCommitteeInfo;
 
 		let (current_committee_v0, next_committee_v0): (
-			LegacyCommitteeInfo<
-				T::ScEpochNumber,
-				T::AuthorityId,
-				T::AuthorityKeys,
-				T::MaxValidators,
-			>,
+			LegacyCommitteeInfo<ScEpochNumber, T::AuthorityId, T::AuthorityKeys, T::MaxValidators>,
 			Option<
 				LegacyCommitteeInfo<
-					T::ScEpochNumber,
+					ScEpochNumber,
 					T::AuthorityId,
 					T::AuthorityKeys,
 					T::MaxValidators,

toolkit/committee-selection/pallet/src/mock.rs

@@ -8,6 +8,7 @@ use frame_support::{
 };
 use frame_system::EnsureRoot;
 use pallet_balances::AccountData;
+use sidechain_domain::ScEpochNumber;
 use sidechain_domain::byte_string::SizedByteString;
 use sp_core::{H256, blake2_256};
 use sp_runtime::{
@@ -22,7 +23,6 @@ type Block = frame_system::mocking::MockBlock<Test>;
 
 type AccountId = u64;
 type AuthorityId = u64;
-pub type ScEpochNumber = u64;
 pub type AuthorityKeys = u64;
 
 sp_runtime::impl_opaque_keys! {
@@ -41,6 +41,7 @@ impl From<u64> for SessionKeys {
 #[frame_support::pallet]
 pub mod mock_pallet {
 	use frame_support::pallet_prelude::*;
+	use sidechain_domain::ScEpochNumber;
 
 	#[pallet::pallet]
 	pub struct Pallet<T>(_);
@@ -49,7 +50,7 @@ pub mod mock_pallet {
 	pub trait Config: frame_system::Config {}
 
 	#[pallet::storage]
-	pub type CurrentEpoch<T: Config> = StorageValue<_, u64, ValueQuery>;
+	pub type CurrentEpoch<T: Config> = StorageValue<_, ScEpochNumber, ValueQuery>;
 }
 
 // Configure a mock runtime to test the pallet.
@@ -114,19 +115,18 @@ impl pallet::Config for Test {
 	type AuthorityKeys = AuthorityKeys;
 	type AuthoritySelectionInputs =
 		BoundedVec<(Self::AuthorityId, Self::AuthorityKeys), Self::MaxValidators>;
-	type ScEpochNumber = ScEpochNumber;
 	type CommitteeMember = (Self::AuthorityId, Self::AuthorityKeys);
 	type MainChainScriptsOrigin = EnsureRoot<Self::AccountId>;
 
 	fn select_authorities(
 		input: Self::AuthoritySelectionInputs,
-		_sidechain_epoch: Self::ScEpochNumber,
+		_sidechain_epoch: ScEpochNumber,
 	) -> Option<BoundedVec<(Self::AuthorityId, Self::AuthorityKeys), Self::MaxValidators>> {
 		// This is a good approximation of the real selection algorithm, that returns None iff there are no valid candidates to select from.
 		if input.is_empty() { None } else { Some(input) }
 	}
 
-	fn current_epoch_number() -> Self::ScEpochNumber {
+	fn current_epoch_number() -> ScEpochNumber {
 		current_epoch_number()
 	}
 
@@ -243,7 +243,7 @@ pub fn set_validators_directly(
 	SessionCommitteeManagement::set(
 		RuntimeOrigin::none(),
 		BoundedVec::truncate_from(expected_validators),
-		for_epoch,
+		for_epoch.into(),
 		data_hash,
 	)
 }
@@ -267,7 +267,7 @@ pub fn create_inherent_set_validators_call(
 	<SessionCommitteeManagement as ProvideInherent>::create_inherent(&inherent_data.0)
 }
 
-pub(crate) fn current_epoch_number() -> u64 {
+pub(crate) fn current_epoch_number() -> ScEpochNumber {
 	mock_pallet::CurrentEpoch::<Test>::get()
 }