From 7d9a0b7cc31c00c91e6afa0abe0fa184ac6aad86 Mon Sep 17 00:00:00 2001
From: eskimor <eskimor@users.noreply.github.com>
Date: Fri, 3 Mar 2023 21:50:42 +0100
Subject: [PATCH] Freeze note on `SessionInfo`. (#6818)
* Add note about frozen `SessionInfo`.
* Better comment.
---------
Co-authored-by: eskimor <eskimor@no-such-url.com>
---
polkadot/primitives/src/v2/mod.rs | 3 +++
1 file changed, 3 insertions(+)
diff --git a/polkadot/primitives/src/v2/mod.rs b/polkadot/primitives/src/v2/mod.rs
index 06326676c9d..9191ebea5b2 100644
--- a/polkadot/primitives/src/v2/mod.rs
+++ b/polkadot/primitives/src/v2/mod.rs
@@ -1603,6 +1603,9 @@ pub fn supermajority_threshold(n: usize) -> usize {
}
/// Information about validator sets of a session.
+///
+/// NOTE: `SessionInfo` is frozen. Do not include new fields, consider creating a separate runtime
+/// API. Reasoning and further outlook [here](https://github.com/paritytech/polkadot/issues/6586).
#[derive(Clone, Encode, Decode, RuntimeDebug, TypeInfo)]
#[cfg_attr(feature = "std", derive(PartialEq))]
pub struct SessionInfo {
--
GitLab