change: ETCM-12427 use concrete type for CommitteeMember (#1080)

Author: AmbientTea

changelog.md

@@ -27,6 +27,9 @@ current `moment: Moment` as input instead of slot.
 *Important:* for backward compatibiliyt, chains that used the slot-based version should pass the
 *starting timestamp of the slot* to the new IDP instead of the actual timestamp. See the implementation
 of the demo node for reference.
+* `pallet-session-validator-management` is no longer configured with a `CommitteeMember` type and instead
+uses `sp_session_validator_management::CommitteeMember` type directly. As this type was the only type
+supported by the toolkit, this change is backwards compatible for existing chains.
 
 ## Removed
 

demo/node/src/command/mod.rs

@@ -71,6 +71,7 @@ pub fn run() -> sc_cli::Result<()> {
 				_,
 				_,
 				_,
+				_,
 				BlockProducerMetadataType,
 				WizardBindings,
 				AccountId32,

demo/node/src/inherent_data.rs

@@ -1,6 +1,6 @@
 use authority_selection_inherents::{
 	AriadneInherentDataProvider as AriadneIDP, AuthoritySelectionDataSource,
-	AuthoritySelectionInputs, CommitteeMember,
+	AuthoritySelectionInputs,
 };
 use derive_new::new;
 use jsonrpsee::core::async_trait;
@@ -56,7 +56,8 @@ where
 	T: HeaderBackend<Block>,
 	T::Api: SessionValidatorManagementApi<
 			Block,
-			CommitteeMember<CrossChainPublic, SessionKeys>,
+			CrossChainPublic,
+			SessionKeys,
 			AuthoritySelectionInputs,
 			ScEpochNumber,
 		>,
@@ -182,7 +183,8 @@ where
 	T: ProvideRuntimeApi<Block> + Send + Sync + HeaderBackend<Block>,
 	T::Api: SessionValidatorManagementApi<
 			Block,
-			CommitteeMember<CrossChainPublic, SessionKeys>,
+			CrossChainPublic,
+			SessionKeys,
 			AuthoritySelectionInputs,
 			ScEpochNumber,
 		>,

demo/node/src/rpc.rs

@@ -6,9 +6,7 @@
 #![warn(missing_docs)]
 
 use crate::data_sources::DataSources;
-use authority_selection_inherents::{
-	AuthoritySelectionInputs, CandidateValidationApi, CommitteeMember,
-};
+use authority_selection_inherents::{AuthoritySelectionInputs, CandidateValidationApi};
 use jsonrpsee::RpcModule;
 use pallet_block_producer_fees_rpc::*;
 use pallet_block_producer_metadata_rpc::*;
@@ -81,7 +79,8 @@ where
 	C::Api: sp_block_producer_metadata::BlockProducerMetadataApi<Block, BlockProducerMetadataType>,
 	C::Api: sp_session_validator_management::SessionValidatorManagementApi<
 			Block,
-			CommitteeMember<CrossChainPublic, SessionKeys>,
+			CrossChainPublic,
+			SessionKeys,
 			AuthoritySelectionInputs,
 			ScEpochNumber,
 		>,

demo/node/src/staging.rs

@@ -1,6 +1,5 @@
 use crate::chain_spec::get_account_id_from_seed;
 use crate::chain_spec::*;
-use authority_selection_inherents::CommitteeMember;
 use partner_chains_demo_runtime::{
 	AccountId, AuraConfig, BalancesConfig, BridgeConfig, GovernedMapConfig, GrandpaConfig,
 	RuntimeGenesisConfig, SessionCommitteeManagementConfig, SessionConfig, SidechainConfig,
@@ -10,6 +9,7 @@ use sc_service::{ChainType, Properties};
 use sidechain_domain::*;
 use sp_core::bytes::from_hex;
 use sp_core::{ed25519, sr25519};
+use sp_session_validator_management::CommitteeMember;
 use std::str::FromStr;
 
 pub fn authority_keys(

demo/node/src/testnet.rs

@@ -1,5 +1,4 @@
 use crate::chain_spec::*;
-use authority_selection_inherents::CommitteeMember;
 use partner_chains_demo_runtime::{
 	AccountId, AuraConfig, BalancesConfig, BridgeConfig, GovernedMapConfig, GrandpaConfig,
 	RuntimeGenesisConfig, SessionCommitteeManagementConfig, SessionConfig, SidechainConfig,
@@ -10,6 +9,7 @@ use sidechain_domain::*;
 use sidechain_slots::SlotsPerEpoch;
 use sp_core::bytes::from_hex;
 use sp_core::{ed25519, sr25519};
+use sp_session_validator_management::CommitteeMember;
 use std::str::FromStr;
 
 pub fn authority_keys(

demo/node/src/tests/runtime_api_mock.rs

@@ -1,5 +1,5 @@
 use super::mock::mock_genesis_utxo;
-use authority_selection_inherents::{AuthoritySelectionInputs, CommitteeMember};
+use authority_selection_inherents::AuthoritySelectionInputs;
 use hex_literal::hex;
 use partner_chains_demo_runtime::opaque::SessionKeys;
 use partner_chains_demo_runtime::{BlockAuthor, CrossChainPublic};
@@ -14,6 +14,7 @@ use sp_inherents::InherentIdentifier;
 use sp_runtime::Digest;
 use sp_runtime::key_types::{AURA, GRANDPA};
 use sp_runtime::traits::{Block as BlockT, Header as HeaderT, NumberFor, Zero};
+use sp_session_validator_management::CommitteeMember;
 use sp_sidechain::GetGenesisUtxo;
 use std::collections::HashMap;
 
@@ -70,7 +71,7 @@ sp_api::mock_impl_runtime_apis! {
 		fn genesis_utxo() -> UtxoId { mock_genesis_utxo() }
 	}
 
-	impl sp_session_validator_management::SessionValidatorManagementApi<Block, CommitteeMember<CrossChainPublic, SessionKeys>, AuthoritySelectionInputs, ScEpochNumber> for TestApi {
+	impl sp_session_validator_management::SessionValidatorManagementApi<Block, CrossChainPublic, SessionKeys, AuthoritySelectionInputs, ScEpochNumber> for TestApi {
 		fn get_current_committee() -> (ScEpochNumber, Vec<CommitteeMember<CrossChainPublic, SessionKeys>>) {
 			unimplemented!()
 		}

demo/runtime/src/lib.rs

@@ -12,8 +12,8 @@ extern crate alloc;
 use alloc::collections::BTreeMap;
 use alloc::string::String;
 use authority_selection_inherents::{
-	AuthoritySelectionInputs, CommitteeMember, PermissionedCandidateDataError,
-	RegistrationDataError, StakeError, select_authorities, validate_permissioned_candidate_data,
+	AuthoritySelectionInputs, PermissionedCandidateDataError, RegistrationDataError, StakeError,
+	select_authorities, validate_permissioned_candidate_data,
 };
 use frame_support::dynamic_params::{dynamic_pallet_params, dynamic_params};
 use frame_support::genesis_builder_helper::{build_state, get_preset};
@@ -30,6 +30,7 @@ use frame_system::EnsureRoot;
 use opaque::SessionKeys;
 use pallet_block_producer_metadata;
 use pallet_grandpa::AuthorityId as GrandpaId;
+use pallet_session_validator_management::CommitteeMemberOf;
 use pallet_transaction_payment::{ConstFeeMultiplier, FungibleAdapter, Multiplier};
 use parity_scale_codec::{Decode, DecodeWithMemTracking, Encode, MaxEncodedLen};
 use scale_info::TypeInfo;
@@ -58,6 +59,7 @@ use sp_runtime::{
 	},
 	transaction_validity::{TransactionSource, TransactionValidity},
 };
+use sp_session_validator_management::CommitteeMember;
 use sp_sidechain::SidechainStatus;
 use sp_std::prelude::*;
 use sp_version::RuntimeVersion;
@@ -351,13 +353,12 @@ impl pallet_session_validator_management::Config for Runtime {
 	type AuthorityKeys = SessionKeys;
 	type AuthoritySelectionInputs = AuthoritySelectionInputs;
 	type WeightInfo = pallet_session_validator_management::weights::SubstrateWeight<Runtime>;
-	type CommitteeMember = CommitteeMember<CrossChainPublic, SessionKeys>;
 	type MainChainScriptsOrigin = EnsureRoot<Self::AccountId>;
 
 	fn select_authorities(
 		input: AuthoritySelectionInputs,
 		sidechain_epoch: ScEpochNumber,
-	) -> Option<BoundedVec<Self::CommitteeMember, Self::MaxValidators>> {
+	) -> Option<BoundedVec<CommitteeMemberOf<Self>, Self::MaxValidators>> {
 		select_authorities::<sidechain_domain::cross_chain_app::Public, SessionKeys, MaxValidators>(
 			Sidechain::genesis_utxo(),
 			input,
@@ -1088,10 +1089,11 @@ impl_runtime_apis! {
 		}
 	}
 
-	#[api_version(2)]
+	#[api_version(3)]
 	impl sp_session_validator_management::SessionValidatorManagementApi<
 		Block,
-		CommitteeMember<CrossChainPublic, SessionKeys>,
+		CrossChainPublic,
+		SessionKeys,
 		AuthoritySelectionInputs,
 		sidechain_domain::ScEpochNumber
 	> for Runtime {

demo/runtime/src/mock.rs

@@ -10,6 +10,7 @@ use frame_support::{
 };
 use frame_system::EnsureRoot;
 use hex_literal::hex;
+use pallet_session_validator_management::CommitteeMemberOf;
 use plutus::ToDatum;
 use sidechain_domain::*;
 use sp_consensus_aura::sr25519::AuthorityId as AuraId;
@@ -165,20 +166,19 @@ impl pallet_session_validator_management::Config for Test {
 	type AuthorityId = CrossChainPublic;
 	type AuthorityKeys = TestSessionKeys;
 	type AuthoritySelectionInputs = AuthoritySelectionInputs;
-	type CommitteeMember = (Self::AuthorityId, Self::AuthorityKeys);
 	type MainChainScriptsOrigin = EnsureRoot<Self::AccountId>;
 
 	/// Mock simply selects all valid registered candidates as validators.
 	fn select_authorities(
 		input: AuthoritySelectionInputs,
 		_sidechain_epoch: ScEpochNumber,
-	) -> Option<BoundedVec<(Self::AuthorityId, Self::AuthorityKeys), Self::MaxValidators>> {
+	) -> Option<BoundedVec<CommitteeMemberOf<Self>, Self::MaxValidators>> {
 		let candidates: Vec<_> = filter_trustless_candidates_registrations::<
 			Self::AuthorityId,
 			Self::AuthorityKeys,
 		>(input.registered_candidates, Sidechain::genesis_utxo())
 		.into_iter()
-		.map(|(c, _)| (c.account_id().clone(), c.account_keys().clone()))
+		.map(|(c, _)| c.into())
 		.collect();
 		if candidates.is_empty() { None } else { Some(BoundedVec::truncate_from(candidates)) }
 	}
@@ -225,10 +225,7 @@ impl pallet_grandpa::Config for Test {
 pub fn new_test_ext() -> sp_io::TestExternalities {
 	let mut t = frame_system::GenesisConfig::<Test>::default().build_storage().unwrap();
 
-	let initial_authorities: Vec<_> = vec![
-		(alice().cross_chain.public(), alice().session()),
-		(bob().cross_chain.public(), bob().session()),
-	];
+	let initial_authorities: Vec<_> = vec![alice().as_permissioned(), bob().as_permissioned()];
 
 	let session_keys: Vec<_> =
 		vec![(alice().account(), alice().session()), (bob().account(), bob().session())];
@@ -423,6 +420,9 @@ impl TestKeys {
 				.collect(),
 		)
 	}
+	pub fn as_permissioned(&self) -> CommitteeMemberOf<Test> {
+		CommitteeMember::permissioned(self.cross_chain.public(), self.session())
+	}
 }
 
 pub fn pair_from_seed<P: Pair>(seed: &str) -> P {
@@ -482,6 +482,6 @@ macro_rules! assert_aura_authorities {
 }
 pub(crate) use assert_aura_authorities;
 use sidechain_slots::SlotsPerEpoch;
-use sp_session_validator_management::MainChainScripts;
+use sp_session_validator_management::{CommitteeMember, MainChainScripts};
 
 use crate::CrossChainPublic;

toolkit/cli/node-commands/src/lib.rs

@@ -23,7 +23,6 @@ use sp_runtime::AccountId32;
 use sp_runtime::DeserializeOwned;
 use sp_runtime::Serialize;
 use sp_runtime::traits::Block as BlockT;
-use sp_session_validator_management::CommitteeMember as CommitteeMemberT;
 use sp_session_validator_management::SessionValidatorManagementApi;
 use sp_session_validator_management_query::SessionValidatorManagementQuery;
 use sp_session_validator_management_query::commands::*;
@@ -148,7 +147,8 @@ pub enum PartnerChainsSubcommand<
 pub fn run<
 	Cli,
 	Block,
-	CommitteeMember,
+	AuthorityId,
+	AuthorityKeys,
 	Client,
 	BlockProducerMetadata,
 	RuntimeBindings: PartnerChainRuntime + Send + Sync,
@@ -170,15 +170,15 @@ where
 		+ GetSidechainStatus<Block>
 		+ SessionValidatorManagementApi<
 			Block,
-			CommitteeMember,
+			AuthorityId,
+			AuthorityKeys,
 			AuthoritySelectionInputs,
 			ScEpochNumber,
 		> + CandidateValidationApi<Block>,
 	Block: BlockT,
 	NumberFor<Block>: From<u32> + Into<u32>,
-	CommitteeMember: CommitteeMemberT + Encode + Decode + Send + Sync + 'static,
-	CommitteeMember::AuthorityId: Decode + Encode + AsRef<[u8]> + Send + Sync + 'static,
-	CommitteeMember::AuthorityKeys: Decode + Encode,
+	AuthorityId: Decode + Encode + AsRef<[u8]> + Send + Sync + Clone + 'static,
+	AuthorityKeys: Decode + Encode + Send + Sync + Clone + 'static,
 	BlockProducerMetadata: DeserializeOwned + Encode + Send + Sync,
 	PartnerchainAddress: Serialize + Clone + Sync + Send + FromStrStdErr + Encode + 'static,
 {