pallet_session/migrations/
v1.rs

1// This file is part of Substrate.
2
3// Copyright (C) Parity Technologies (UK) Ltd.
4// SPDX-License-Identifier: Apache-2.0
5
6// Licensed under the Apache License, Version 2.0 (the "License");
7// you may not use this file except in compliance with the License.
8// You may obtain a copy of the License at
9//
10// 	http://www.apache.org/licenses/LICENSE-2.0
11//
12// Unless required by applicable law or agreed to in writing, software
13// distributed under the License is distributed on an "AS IS" BASIS,
14// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15// See the License for the specific language governing permissions and
16// limitations under the License.
17
18use crate::{Config, DisabledValidators as NewDisabledValidators, Pallet, Vec};
19use frame_support::{
20	pallet_prelude::{Get, ValueQuery, Weight},
21	traits::UncheckedOnRuntimeUpgrade,
22};
23use sp_staking::offence::OffenceSeverity;
24
25#[cfg(feature = "try-runtime")]
26use sp_runtime::TryRuntimeError;
27
28#[cfg(feature = "try-runtime")]
29use frame_support::ensure;
30use frame_support::migrations::VersionedMigration;
31
32/// This is the storage getting migrated.
33#[frame_support::storage_alias]
34type DisabledValidators<T: Config> = StorageValue<Pallet<T>, Vec<u32>, ValueQuery>;
35
36pub trait MigrateDisabledValidators {
37	/// Peek the list of disabled validators and their offence severity.
38	#[cfg(feature = "try-runtime")]
39	fn peek_disabled() -> Vec<(u32, OffenceSeverity)>;
40
41	/// Return the list of disabled validators and their offence severity, removing them from the
42	/// underlying storage.
43	fn take_disabled() -> Vec<(u32, OffenceSeverity)>;
44}
45
46pub struct InitOffenceSeverity<T>(core::marker::PhantomData<T>);
47impl<T: Config> MigrateDisabledValidators for InitOffenceSeverity<T> {
48	#[cfg(feature = "try-runtime")]
49	fn peek_disabled() -> Vec<(u32, OffenceSeverity)> {
50		DisabledValidators::<T>::get()
51			.iter()
52			.map(|v| (*v, OffenceSeverity::max_severity()))
53			.collect::<Vec<_>>()
54	}
55
56	fn take_disabled() -> Vec<(u32, OffenceSeverity)> {
57		DisabledValidators::<T>::take()
58			.iter()
59			.map(|v| (*v, OffenceSeverity::max_severity()))
60			.collect::<Vec<_>>()
61	}
62}
63pub struct VersionUncheckedMigrateV0ToV1<T, S: MigrateDisabledValidators>(
64	core::marker::PhantomData<(T, S)>,
65);
66
67impl<T: Config, S: MigrateDisabledValidators> UncheckedOnRuntimeUpgrade
68	for VersionUncheckedMigrateV0ToV1<T, S>
69{
70	fn on_runtime_upgrade() -> Weight {
71		let disabled = S::take_disabled();
72		NewDisabledValidators::<T>::put(disabled);
73
74		T::DbWeight::get().reads_writes(1, 1)
75	}
76
77	#[cfg(feature = "try-runtime")]
78	fn pre_upgrade() -> Result<Vec<u8>, TryRuntimeError> {
79		let source_disabled = S::peek_disabled().iter().map(|(v, _s)| *v).collect::<Vec<_>>();
80		let existing_disabled = DisabledValidators::<T>::get();
81
82		ensure!(source_disabled == existing_disabled, "Disabled validators mismatch");
83		Ok(Vec::new())
84	}
85	#[cfg(feature = "try-runtime")]
86	fn post_upgrade(_state: Vec<u8>) -> Result<(), TryRuntimeError> {
87		let validators_max_index = crate::Validators::<T>::get().len() as u32 - 1;
88
89		for (v, _s) in NewDisabledValidators::<T>::get() {
90			ensure!(v <= validators_max_index, "Disabled validator index out of bounds");
91		}
92
93		Ok(())
94	}
95}
96
97pub type MigrateV0ToV1<T, S> = VersionedMigration<
98	0,
99	1,
100	VersionUncheckedMigrateV0ToV1<T, S>,
101	Pallet<T>,
102	<T as frame_system::Config>::DbWeight,
103>;
pallet_session/migrations/v1.rs

pallet_session/migrations/
v1.rs
