Session Delayed Para Changes / Actions Queue (#2406)

* initial implementation of lifecycles and upgrades * clean up a bit * fix doc comment * more rigid lifecycle checks * include paras which are transitioning, and lifecycle query * format guide * update api * update guide * explicit outgoing state, fix genesis * handle outgoing with transitioning paras * do not include transitioning paras in identifier * Update roadmap/implementers-guide/src/runtime/paras.md * Update roadmap/implementers-guide/src/runtime/paras.md * Update roadmap/implementers-guide/src/runtime/paras.md * Apply suggestions from code review * Use matches macro * Correct terms * Apply suggestions from code review * actions queue * Revert "actions queue" This reverts commit b2e9011ec8937d6c73e99292416c9692aeb30f73. * collapse onboarding state * starting actions queue * consolidate actions queue * schedule para initialize result * more actions queue for upgrade/downgrade * clean up with fully implemented actions queue * fix tests * fix scheduler tests * fix hrmp tests * fix test * doc fixes * fix hrmp test w/ valid para * Update paras.md * fix paras registrar * Update propose_parachain.rs * fix merge * Introduce "shared" module * fix rococo build * fix up and use shared * guide updates * add shared config to common tests * add shared to test-runtime * remove println * fix note Co-authored-by: Gavin Wood <gavin@parity.io>
2026-05-31 07:31:02 +00:00 · 2021-02-18 23:20:18 -04:00
parent 006602eff2
commit a5defa7c7f
20 changed files with 654 additions and 698 deletions
@@ -0,0 +1,79 @@
+// Copyright 2021 Parity Technologies (UK) Ltd.
+// This file is part of Polkadot.
+
+// Polkadot 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.
+
+// Polkadot 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 Polkadot.  If not, see <http://www.gnu.org/licenses/>.
+
+//! A module for any shared state that other pallets may want access to.
+//!
+//! To avoid cyclic dependencies, it is important that this module is not
+//! dependent on any of the other modules.
+
+use primitives::v1::SessionIndex;
+use frame_support::{
+	decl_storage, decl_module, decl_error,
+	weights::Weight,
+};
+use crate::initializer::SessionChangeNotification;
+
+pub trait Config: frame_system::Config { }
+
+// `SESSION_DELAY` is used to delay any changes to Paras registration or configurations.
+// Wait until the session index is 2 larger then the current index to apply any changes,
+// which guarantees that at least one full session has passed before any changes are applied.
+pub(crate) const SESSION_DELAY: SessionIndex = 2;
+
+decl_storage! {
+	trait Store for Module<T: Config> as ParasShared {
+		/// The current session index.
+		CurrentSessionIndex get(fn session_index): SessionIndex;
+	}
+}
+
+decl_error! {
+	pub enum Error for Module<T: Config> { }
+}
+
+decl_module! {
+	/// The session info module.
+	pub struct Module<T: Config> for enum Call where origin: <T as frame_system::Config>::Origin {
+		type Error = Error<T>;
+	}
+}
+
+impl<T: Config> Module<T> {
+	/// Called by the initializer to initialize the configuration module.
+	pub(crate) fn initializer_initialize(_now: T::BlockNumber) -> Weight {
+		0
+	}
+
+	/// Called by the initializer to finalize the configuration module.
+	pub(crate) fn initializer_finalize() { }
+
+	/// Called by the initializer to note that a new session has started.
+	///
+	/// Returns the list of outgoing paras from the actions queue.
+	pub(crate) fn initializer_on_new_session(notification: &SessionChangeNotification<T::BlockNumber>) {
+		CurrentSessionIndex::set(notification.session_index);
+	}
+
+	/// Return the session index that should be used for any future scheduled changes.
+	pub (crate) fn scheduled_session() -> SessionIndex {
+		Self::session_index().saturating_add(SESSION_DELAY)
+	}
+
+	#[cfg(test)]
+	pub(crate) fn set_session_index(index: SessionIndex) {
+		CurrentSessionIndex::set(index);
+	}
+}