Migrate pallet-grandpa to attribute macros (#8724)

* frame/grandpa: migrate Config * frame/grandpa: migrate decl_module * frame/grandpa: migrate decl_event * frame/grandpa: migrate decl_error * frame/grandpa: migrate decl_storage * frame/grandpa: make report_equivocation_unsigned pub(super) * frame/grandpa: remove unused imports * frame/grandpa: replace deprecated Module with Pallet * frame/grandpa: add RawEvent for compatibility * frame/grandpa: create migration to new storage prefix * frame/grandpa: bump version to 4.0.0 * frame/grandpa: address review comments * Try using version 3.1 instead * frame/grandpa: tweak log text to say cancelled
2026-07-20 12:45:40 +00:00 · 2021-05-26 18:26:15 +02:00
parent 4ee5da2403
commit acef22bbd2
14 changed files with 417 additions and 225 deletions
@@ -0,0 +1,128 @@
+// This file is part of Substrate.
+
+// Copyright (C) 2021 Parity Technologies (UK) Ltd.
+// SPDX-License-Identifier: Apache-2.0
+
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// 	http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+use frame_support::{
+	weights::Weight,
+	traits::{GetPalletVersion, PalletVersion, Get},
+};
+use sp_io::hashing::twox_128;
+
+/// The old prefix.
+pub const OLD_PREFIX: &[u8] = b"GrandpaFinality";
+
+/// Migrate the entire storage of this pallet to a new prefix.
+///
+/// This new prefix must be the same as the one set in construct_runtime. For safety, use
+/// `PalletInfo` to get it, as:
+/// `<Runtime as frame_system::Config>::PalletInfo::name::<GrandpaPallet>`.
+///
+/// The old storage prefix, `GrandpaFinality` is hardcoded in the migration code.
+pub fn migrate<
+	T: frame_system::Config,
+	P: GetPalletVersion,
+	N: AsRef<str>,
+>(new_pallet_name: N) -> Weight {
+
+	if new_pallet_name.as_ref().as_bytes() == OLD_PREFIX {
+		log::info!(
+			target: "runtime::afg",
+			"New pallet name is equal to the old prefix. No migration needs to be done.",
+		);
+		return 0;
+	}
+	let maybe_storage_version = <P as GetPalletVersion>::storage_version();
+	log::info!(
+		target: "runtime::afg",
+		"Running migration to v3.1 for grandpa with storage version {:?}",
+		maybe_storage_version,
+	);
+
+	match maybe_storage_version {
+		Some(storage_version) if storage_version <= PalletVersion::new(3, 0, 0) => {
+			log::info!("new prefix: {}", new_pallet_name.as_ref());
+			frame_support::storage::migration::move_pallet(
+				OLD_PREFIX,
+				new_pallet_name.as_ref().as_bytes(),
+			);
+			<T as frame_system::Config>::BlockWeights::get().max_block
+		}
+		_ => {
+			log::warn!(
+				target: "runtime::afg",
+				"Attempted to apply migration to v3.1 but cancelled because storage version is {:?}",
+				maybe_storage_version,
+			);
+			0
+		},
+	}
+}
+
+/// Some checks prior to migration. This can be linked to
+/// [`frame_support::traits::OnRuntimeUpgrade::pre_upgrade`] for further testing.
+///
+/// Panics if anything goes wrong.
+pub fn pre_migration<
+	T: frame_system::Config,
+	P: GetPalletVersion + 'static,
+	N: AsRef<str>,
+>(new: N) {
+	let new = new.as_ref();
+	log::info!("pre-migration grandpa test with new = {}", new);
+
+	// the next key must exist, and start with the hash of `OLD_PREFIX`.
+	let next_key = sp_io::storage::next_key(&twox_128(OLD_PREFIX)).unwrap();
+	assert!(next_key.starts_with(&twox_128(OLD_PREFIX)));
+
+	// The pallet version is already stored using the pallet name
+	let storage_key = PalletVersion::storage_key::<T::PalletInfo, P>().unwrap();
+
+	// ensure nothing is stored in the new prefix.
+	assert!(
+		sp_io::storage::next_key(&twox_128(new.as_bytes())).map_or(
+			// either nothing is there
+			true,
+			// or we ensure that it has no common prefix with twox_128(new),
+			// or isn't the pallet version that is already stored using the pallet name
+			|next_key| {
+				!next_key.starts_with(&twox_128(new.as_bytes())) || next_key == storage_key
+			},
+		),
+		"unexpected next_key({}) = {:?}",
+		new,
+		sp_core::hexdisplay::HexDisplay::from(
+			&sp_io::storage::next_key(&twox_128(new.as_bytes())).unwrap()
+		),
+	);
+	// ensure storage version is 3.
+	assert!(<P as GetPalletVersion>::storage_version().unwrap().major == 3);
+}
+
+/// Some checks for after migration. This can be linked to
+/// [`frame_support::traits::OnRuntimeUpgrade::post_upgrade`] for further testing.
+///
+/// Panics if anything goes wrong.
+pub fn post_migration<P: GetPalletVersion>() {
+	log::info!("post-migration grandpa");
+
+	// Assert that nothing remains at the old prefix
+	assert!(
+		sp_io::storage::next_key(&twox_128(OLD_PREFIX)).map_or(
+			true,
+			|next_key| !next_key.starts_with(&twox_128(OLD_PREFIX))
+		)
+	);
+}