Freeze note on SessionInfo. (#6818)

eskimor · eskimor · web-flow · commit 43753085a9ed · 2023-03-03T21:50:42.000+01:00
* Add note about frozen `SessionInfo`.

* Better comment.

---------

Co-authored-by: eskimor &lt;eskimor@no-such-url.com&gt;
diff --git a/primitives/src/v2/mod.rs b/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 {

Original file line number	Diff line number	Diff line change
`@@ -1603,6 +1603,9 @@ pub fn supermajority_threshold(n: usize) -> usize {`
`1603`	`1603`	`}`
`1604`	`1604`
`1605`	`1605`	`/// Information about validator sets of a session.`
	`1606`	`+///`
	`1607`	+/// NOTE: `SessionInfo` is frozen. Do not include new fields, consider creating a separate runtime
	`1608`	`+/// API. Reasoning and further outlook [here](https://github.com/paritytech/polkadot/issues/6586).`
`1606`	`1609`	`#[derive(Clone, Encode, Decode, RuntimeDebug, TypeInfo)]`
`1607`	`1610`	`#[cfg_attr(feature = "std", derive(PartialEq))]`
`1608`	`1611`	`pub struct SessionInfo {`