feat: Draft of pallet_session_keys_registration

Author: Klapeyron

Cargo.lock

@@ -57,6 +57,7 @@ members = [
 	"toolkit/governed-map/primitives",
 	"toolkit/governed-map/pallet",
 	"toolkit/committee-selection/selection-simulator",
+	"toolkit/session_keys_registration",
 ]
 resolver = "2"
 
@@ -198,6 +199,7 @@ pallet-aura = { default-features = false, git = "https://github.com/paritytech/p
 pallet-balances = { default-features = false, git = "https://github.com/paritytech/polkadot-sdk.git", tag = "polkadot-stable2506" }
 pallet-grandpa = { default-features = false, git = "https://github.com/paritytech/polkadot-sdk.git", tag = "polkadot-stable2506" }
 pallet-session = { default-features = false, git = "https://github.com/paritytech/polkadot-sdk.git", tag = "polkadot-stable2506" }
+pallet-staking = { default-features = false, git = "https://github.com/paritytech/polkadot-sdk.git", tag = "polkadot-stable2506" }
 pallet-sudo = { default-features = false, git = "https://github.com/paritytech/polkadot-sdk.git", tag = "polkadot-stable2506" }
 pallet-timestamp = { default-features = false, git = "https://github.com/paritytech/polkadot-sdk.git", tag = "polkadot-stable2506" }
 pallet-transaction-payment = { default-features = false, git = "https://github.com/paritytech/polkadot-sdk.git", tag = "polkadot-stable2506" }
@@ -330,5 +332,8 @@ partner-chains-mock-data-sources = { path = "toolkit/data-sources/mock", default
 sp-governed-map = { path = "toolkit/governed-map/primitives", default-features = false }
 pallet-governed-map = { path = "toolkit/governed-map/pallet", default-features = false }
 
+# Session Keys Registration
+pallet-session-keys-registration = { path = "toolkit/session_keys_registration", default-features = false }
+
 # demo node
 partner-chains-demo-runtime = { path = "demo/runtime" }

Cargo.toml

@@ -93,6 +93,7 @@ pallet-governed-map = { workspace = true }
 sp-governed-map = { workspace = true }
 sp-block-producer-fees = { workspace = true }
 pallet-block-producer-fees = { workspace = true }
+pallet-session-keys-registration = { workspace = true }
 
 [dev-dependencies]
 sp-io = { workspace = true }
@@ -139,6 +140,7 @@ std = [
 	"pallet-transaction-payment/std",
 	"pallet-address-associations/std",
 	"pallet-block-producer-metadata/std",
+	"pallet-session-keys-registration/std",
 	"sp-block-producer-metadata/std",
 	"sp-api/std",
 	"sp-block-builder/std",

demo/runtime/Cargo.toml

@@ -681,6 +681,10 @@ impl pallet_governed_map::Config for Runtime {
 	type BenchmarkHelper = ();
 }
 
+impl pallet_session_keys_registration::Config for Runtime {
+	type PalletsOrigin = OriginCaller;
+}
+
 impl crate::test_helper_pallet::Config for Runtime {}
 
 // Create the runtime by composing the FRAME pallets that were previously configured.
@@ -702,7 +706,8 @@ construct_runtime!(
 		BlockProducerMetadata: pallet_block_producer_metadata,
 		BlockProductionLog: pallet_block_production_log,
 		BlockParticipation: pallet_block_participation,
-		Session: pallet_session,
+		Session: pallet_session exclude_parts { Call },
+		SessionKeysRegistration: pallet_session_keys_registration,
 		// Historical: pallet_session::historical,
 		NativeTokenManagement: pallet_native_token_management,
 		GovernedMap: pallet_governed_map,

demo/runtime/src/lib.rs

@@ -0,0 +1,41 @@
+[package]
+name = "pallet-session-keys-registration"
+authors.workspace = true
+edition.workspace = true
+homepage.workspace = true
+repository.workspace = true
+version.workspace = true
+license = "Apache-2.0"
+description = "Pallet for registering session keys for the partner chains"
+
+[lints]
+workspace = true
+
+[dependencies]
+frame-support = { workspace = true, default-features = false }
+frame-system = { workspace = true, default-features = false }
+parity-scale-codec = { workspace = true }
+scale-info = { workspace = true, default-features = false, features = [
+    "derive",
+] }
+sp-runtime = { workspace = true, default-features = false }
+pallet-session = { workspace = true }
+
+[dev-dependencies]
+pallet-staking = { workspace = true }
+sp-core = { workspace = true }
+sp-io = { workspace = true }
+sp-staking = { workspace = true }
+sp-tracing = { workspace = true }
+
+[features]
+default = ["std"]
+std = [
+    "frame-support/std",
+    "frame-system/std",
+    "parity-scale-codec/std",
+    "scale-info/std",
+    "sp-runtime/std",
+    "pallet-session/std",
+    "pallet-staking/std",
+]

toolkit/session_keys_registration/Cargo.toml

@@ -0,0 +1,47 @@
+#![cfg_attr(not(feature = "std"), no_std)]
+
+#[cfg(test)]
+mod mock;
+
+#[cfg(test)]
+mod tests;
+
+pub use pallet::*;
+
+#[frame_support::pallet]
+pub mod pallet {
+	use frame_support::{dispatch::DispatchResultWithPostInfo, pallet_prelude::*};
+	use scale_info::prelude::boxed::Box;
+	use sp_runtime::Vec;
+
+	#[pallet::pallet]
+	pub struct Pallet<T>(_);
+
+	#[pallet::config]
+	pub trait Config: frame_system::Config + pallet_session::Config {
+		/// The caller origin, overarching type of all pallets origins.
+		type PalletsOrigin: Parameter +
+			Into<<Self as frame_system::Config>::RuntimeOrigin> +
+			IsType<<<Self as frame_system::Config>::RuntimeOrigin as frame_support::traits::OriginTrait>::PalletsOrigin>;
+	}
+
+	impl<T: Config> Pallet<T> {
+		/// Invokes the `pallet_session::Call::set_keys` function to set the session keys.
+		///
+		/// Allows the caller to set the session keys for the next session for particular user.
+		///
+		/// ## Complexity
+		/// - `O(1)`. Actual cost depends on the number of length of `T::Keys::key_ids()` which is
+		///   fixed.
+		pub fn set_keys(
+			as_origin: Box<T::PalletsOrigin>,
+			keys: <T as pallet_session::Config>::Keys,
+			proof: Vec<u8>,
+		) -> DispatchResultWithPostInfo {
+			let call = pallet_session::Call::<T>::set_keys { keys, proof };
+
+			use frame_support::traits::UnfilteredDispatchable;
+			call.dispatch_bypass_filter((*as_origin).into())
+		}
+	}
+}

toolkit/session_keys_registration/src/lib.rs

@@ -0,0 +1,100 @@
+use crate as pallet_session_keys_registration;
+
+use frame_support::derive_impl;
+use frame_support::traits::{OnFinalize, OnInitialize};
+use sp_core::parameter_types;
+use sp_runtime::key_types::DUMMY;
+use sp_runtime::testing::UintAuthorityId;
+use sp_runtime::{BuildStorage, KeyTypeId};
+use sp_staking::SessionIndex;
+
+type Block = frame_system::mocking::MockBlock<Test>;
+
+sp_runtime::impl_opaque_keys! {
+	pub struct SessionKeys {
+		pub foo: UintAuthorityId,
+	}
+}
+
+frame_support::construct_runtime!(
+	pub enum Test
+	{
+		System: frame_system,
+		Session: pallet_session,
+		SessionKeysRegistration: pallet_session_keys_registration,
+	}
+);
+
+type AccountId = u64;
+
+pub struct TestSessionHandler;
+impl pallet_session::SessionHandler<AccountId> for TestSessionHandler {
+	const KEY_TYPE_IDS: &'static [KeyTypeId] = &[DUMMY];
+
+	fn on_genesis_session<Ks: sp_runtime::traits::OpaqueKeys>(_validators: &[(AccountId, Ks)]) {}
+
+	fn on_new_session<Ks: sp_runtime::traits::OpaqueKeys>(
+		_: bool,
+		_: &[(AccountId, Ks)],
+		_: &[(AccountId, Ks)],
+	) {
+	}
+
+	fn on_disabled(_: u32) {}
+}
+
+#[derive_impl(frame_system::config_preludes::TestDefaultConfig)]
+impl frame_system::Config for Test {
+	type Block = Block;
+}
+
+parameter_types! {
+	pub const Period: u64 = 1;
+	pub const Offset: u64 = 0;
+}
+
+impl pallet_session::Config for Test {
+	type RuntimeEvent = RuntimeEvent;
+	type ValidatorId = u64;
+	type ValidatorIdOf = sp_runtime::traits::ConvertInto;
+	type ShouldEndSession = pallet_session::PeriodicSessions<Period, Offset>;
+	type NextSessionRotation = pallet_session::PeriodicSessions<Period, Offset>;
+	type SessionManager = ();
+	type SessionHandler = TestSessionHandler;
+	type Keys = SessionKeys;
+	type DisablingStrategy = ();
+	type WeightInfo = ();
+}
+
+impl pallet_session_keys_registration::Config for Test {
+	type PalletsOrigin = OriginCaller;
+}
+
+pub fn new_test_ext() -> sp_io::TestExternalities {
+	sp_tracing::try_init_simple();
+	let t = frame_system::GenesisConfig::<Test>::default().build_storage().unwrap();
+	sp_io::TestExternalities::new(t)
+}
+
+pub fn start_session(session_index: SessionIndex) {
+	for i in Session::current_index()..session_index {
+		System::on_finalize(System::block_number());
+		Session::on_finalize(System::block_number());
+
+		let parent_hash = if System::block_number() > 1 {
+			let hdr = System::finalize();
+			hdr.hash()
+		} else {
+			System::parent_hash()
+		};
+
+		System::reset_events();
+		System::initialize(&(i as u64 + 1), &parent_hash, &Default::default());
+		System::set_block_number((i + 1).into());
+
+		System::on_initialize(System::block_number());
+		Session::on_initialize(System::block_number());
+	}
+
+	assert_eq!(Session::current_index(), session_index);
+}