Change the Config of the MaxRococoNum Slot from a Constant to a Stora…

…ge function (#7217) * set MaxPermanentSlots and MaxTemporarySlots with a extrinsic instead of a constant * delete the MaxPermanentSlots and MaxTemporarySlots constants from config on Rococo and Westend * migration code for assigned slots * remove getters * little refactor * set values in the GenesisConfig * refactor in the migration, adding it in the rococo runtime * refactor: fmt * Minor fix * pre_upgrade check * add migration to mod v1 * Logs following Substrate#12873 * fix: current storage version set to 1 * use enact when try-runtime * Vec seems to be missing * feature gate import * fix as per #13993 * address comments Co-authored-by: Oliver Tale-Yazdi <[email protected]> * address comments Co-authored-by: Oliver Tale-Yazdi <[email protected]> * benchmarking for assign_perm_parachain_slot extrinsic * benchmark all the extrinsics of the pallet * cargo fmt for assigned slots * migration added for westend * licence in benchmarking file * BuildGenesisConfig * assigned_slots default in genesis * cargo fmt * assigned_slots fix tests config * cargo fmt * fix benchmarking compile error * fix benchmarking imports * benchmark worst case scenario for validation code and head data * add assigned_slots in frame_benchmarking on Rococo and Westend * modify values for para_id in benchmarking * delete the assigned_slots in westend frame_benchmarking * fix benchmarkings and add it to westend * cargo fmt * ".git/.scripts/commands/bench/bench.sh" --subcommand=runtime --runtime=rococo --target_dir=polkadot --pallet=runtime_common::assigned_slots * ".git/.scripts/commands/bench/bench.sh" --subcommand=runtime --runtime=westend --target_dir=polkadot --pallet=runtime_common::assigned_slots * use generated weights in assigned_slots pallet * small changes in set_max_permanent_slots and set_max_temporary_slots * revert last commit * address some comments * wrap migration with VersionCheckedMigrateToV1 * add experimental feature in pallet, and assers in post_upgrade migration * clean warnings * clean unnecesary experimental flag * small typo in comments * cargo fmt * small comments fixes --------- Co-authored-by: al3mart <[email protected]> Co-authored-by: Oliver Tale-Yazdi <[email protected]> Co-authored-by: command-bot <>
paritytech · Aug 15, 2023 · 1bddab1 · 1bddab1
1 parent e074364
commit 1bddab1
Show file tree

Hide file tree

Showing 13 changed files with 727 additions and 45 deletions.
diff --git a/node/service/src/chain_spec.rs b/node/service/src/chain_spec.rs
@@ -515,6 +515,7 @@ fn westend_staging_testnet_config_genesis(wasm_binary: &[u8]) -> westend::Runtim
 		},
 		xcm_pallet: Default::default(),
 		nomination_pools: Default::default(),
+		assigned_slots: Default::default(),
 	}
 }
 
@@ -1023,6 +1024,7 @@ fn rococo_staging_testnet_config_genesis(
 		},
 		xcm_pallet: Default::default(),
 		nis_counterpart_balances: Default::default(),
+		assigned_slots: Default::default(),
 	}
 }
 
@@ -1484,6 +1486,7 @@ pub fn westend_testnet_genesis(
 		},
 		xcm_pallet: Default::default(),
 		nomination_pools: Default::default(),
+		assigned_slots: Default::default(),
 	}
 }
 
@@ -1573,6 +1576,7 @@ pub fn rococo_testnet_genesis(
 		},
 		xcm_pallet: Default::default(),
 		nis_counterpart_balances: Default::default(),
+		assigned_slots: Default::default(),
 	}
 }
 

diff --git a/runtime/common/Cargo.toml b/runtime/common/Cargo.toml
@@ -64,6 +64,9 @@ test-helpers = { package = "polkadot-primitives-test-helpers", path = "../../pri
 
 [features]
 default = ["std"]
+experimental = [
+	"frame-support/experimental"
+]
 no_std = []
 std = [
 	"bitvec/std",

diff --git a/runtime/common/src/assigned_slots/benchmarking.rs b/runtime/common/src/assigned_slots/benchmarking.rs
@@ -0,0 +1,160 @@
+// Copyright (C) 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/>.
+
+//! Benchmarking for assigned_slots pallet
+
+#![cfg(feature = "runtime-benchmarks")]
+use super::*;
+
+use frame_benchmarking::v2::*;
+use frame_support::assert_ok;
+use frame_system::{pallet_prelude::BlockNumberFor, RawOrigin};
+use primitives::Id as ParaId;
+use sp_runtime::traits::Bounded;
+
+type CurrencyOf<T> = <<T as Config>::Leaser as Leaser<BlockNumberFor<T>>>::Currency;
+type BalanceOf<T> = <<<T as Config>::Leaser as Leaser<BlockNumberFor<T>>>::Currency as Currency<
+	<T as frame_system::Config>::AccountId,
+>>::Balance;
+#[benchmarks(where T: Config)]
+mod benchmarks {
+	use super::*;
+
+	use crate::assigned_slots::Pallet as AssignedSlots;
+
+	fn register_parachain<T: Config>(para_id: ParaId) {
+		let who: T::AccountId = whitelisted_caller();
+		let worst_validation_code = T::Registrar::worst_validation_code();
+		let worst_head_data = T::Registrar::worst_head_data();
+
+		CurrencyOf::<T>::make_free_balance_be(&who, BalanceOf::<T>::max_value());
+
+		assert_ok!(T::Registrar::register(
+			who,
+			para_id,
+			worst_head_data,
+			worst_validation_code.clone()
+		));
+		assert_ok!(paras::Pallet::<T>::add_trusted_validation_code(
+			frame_system::Origin::<T>::Root.into(),
+			worst_validation_code,
+		));
+		T::Registrar::execute_pending_transitions();
+	}
+
+	#[benchmark]
+	fn assign_perm_parachain_slot() {
+		let para_id = ParaId::from(1_u32);
+		let caller = RawOrigin::Root;
+
+		let _ =
+			AssignedSlots::<T>::set_max_permanent_slots(frame_system::Origin::<T>::Root.into(), 10);
+		register_parachain::<T>(para_id);
+
+		let counter = PermanentSlotCount::<T>::get();
+		let current_lease_period: BlockNumberFor<T> =
+			T::Leaser::lease_period_index(frame_system::Pallet::<T>::block_number())
+				.and_then(|x| Some(x.0))
+				.unwrap();
+		#[extrinsic_call]
+		assign_perm_parachain_slot(caller, para_id);
+
+		assert_eq!(
+			PermanentSlots::<T>::get(para_id),
+			Some((
+				current_lease_period,
+				LeasePeriodOf::<T>::from(T::PermanentSlotLeasePeriodLength::get()),
+			))
+		);
+		assert_eq!(PermanentSlotCount::<T>::get(), counter + 1);
+	}
+
+	#[benchmark]
+	fn assign_temp_parachain_slot() {
+		let para_id = ParaId::from(2_u32);
+		let caller = RawOrigin::Root;
+
+		let _ =
+			AssignedSlots::<T>::set_max_temporary_slots(frame_system::Origin::<T>::Root.into(), 10);
+		register_parachain::<T>(para_id);
+
+		let current_lease_period: BlockNumberFor<T> =
+			T::Leaser::lease_period_index(frame_system::Pallet::<T>::block_number())
+				.and_then(|x| Some(x.0))
+				.unwrap();
+
+		let counter = TemporarySlotCount::<T>::get();
+		#[extrinsic_call]
+		assign_temp_parachain_slot(caller, para_id, SlotLeasePeriodStart::Current);
+
+		let tmp = ParachainTemporarySlot {
+			manager: whitelisted_caller(),
+			period_begin: current_lease_period,
+			period_count: LeasePeriodOf::<T>::from(T::TemporarySlotLeasePeriodLength::get()),
+			last_lease: Some(BlockNumberFor::<T>::zero()),
+			lease_count: 1,
+		};
+		assert_eq!(TemporarySlots::<T>::get(para_id), Some(tmp));
+		assert_eq!(TemporarySlotCount::<T>::get(), counter + 1);
+	}
+
+	#[benchmark]
+	fn unassign_parachain_slot() {
+		let para_id = ParaId::from(3_u32);
+		let caller = RawOrigin::Root;
+
+		let _ =
+			AssignedSlots::<T>::set_max_temporary_slots(frame_system::Origin::<T>::Root.into(), 10);
+		register_parachain::<T>(para_id);
+
+		let _ = AssignedSlots::<T>::assign_temp_parachain_slot(
+			caller.clone().into(),
+			para_id,
+			SlotLeasePeriodStart::Current,
+		);
+
+		let counter = TemporarySlotCount::<T>::get();
+		#[extrinsic_call]
+		unassign_parachain_slot(caller, para_id);
+
+		assert_eq!(TemporarySlots::<T>::get(para_id), None);
+		assert_eq!(TemporarySlotCount::<T>::get(), counter - 1);
+	}
+
+	#[benchmark]
+	fn set_max_permanent_slots() {
+		let caller = RawOrigin::Root;
+		#[extrinsic_call]
+		set_max_permanent_slots(caller, u32::MAX);
+
+		assert_eq!(MaxPermanentSlots::<T>::get(), u32::MAX);
+	}
+
+	#[benchmark]
+	fn set_max_temporary_slots() {
+		let caller = RawOrigin::Root;
+		#[extrinsic_call]
+		set_max_temporary_slots(caller, u32::MAX);
+
+		assert_eq!(MaxTemporarySlots::<T>::get(), u32::MAX);
+	}
+
+	impl_benchmark_test_suite!(
+		AssignedSlots,
+		crate::assigned_slots::tests::new_test_ext(),
+		crate::assigned_slots::tests::Test,
+	);
+}
diff --git a/runtime/common/src/assigned_slots/migration.rs b/runtime/common/src/assigned_slots/migration.rs
@@ -0,0 +1,77 @@
+// Copyright (C) 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/>.
+
+use super::{Config, MaxPermanentSlots, MaxTemporarySlots, Pallet, LOG_TARGET};
+use frame_support::{
+	dispatch::GetStorageVersion,
+	traits::{Get, OnRuntimeUpgrade},
+};
+
+#[cfg(feature = "try-runtime")]
+use frame_support::ensure;
+#[cfg(feature = "try-runtime")]
+use sp_std::vec::Vec;
+
+pub mod v1 {
+
+	use super::*;
+	pub struct MigrateToV1<T>(sp_std::marker::PhantomData<T>);
+	impl<T: Config> OnRuntimeUpgrade for MigrateToV1<T> {
+		#[cfg(feature = "try-runtime")]
+		fn pre_upgrade() -> Result<Vec<u8>, sp_runtime::TryRuntimeError> {
+			let onchain_version = Pallet::<T>::on_chain_storage_version();
+			ensure!(onchain_version < 1, "assigned_slots::MigrateToV1 migration can be deleted");
+			Ok(Default::default())
+		}
+
+		fn on_runtime_upgrade() -> frame_support::weights::Weight {
+			let onchain_version = Pallet::<T>::on_chain_storage_version();
+			if onchain_version < 1 {
+				const MAX_PERMANENT_SLOTS: u32 = 100;
+				const MAX_TEMPORARY_SLOTS: u32 = 100;
+
+				<MaxPermanentSlots<T>>::put(MAX_PERMANENT_SLOTS);
+				<MaxTemporarySlots<T>>::put(MAX_TEMPORARY_SLOTS);
+				// Return the weight consumed by the migration.
+				T::DbWeight::get().reads_writes(1, 3)
+			} else {
+				log::info!(target: LOG_TARGET, "MigrateToV1 should be removed");
+				T::DbWeight::get().reads(1)
+			}
+		}
+
+		#[cfg(feature = "try-runtime")]
+		fn post_upgrade(_state: Vec<u8>) -> Result<(), sp_runtime::TryRuntimeError> {
+			let onchain_version = Pallet::<T>::on_chain_storage_version();
+			ensure!(onchain_version == 1, "assigned_slots::MigrateToV1 needs to be run");
+			assert_eq!(<MaxPermanentSlots<T>>::get(), 100);
+			assert_eq!(<MaxTemporarySlots<T>>::get(), 100);
+			Ok(())
+		}
+	}
+
+	/// [`VersionUncheckedMigrateToV1`] wrapped in a
+	/// [`frame_support::migrations::VersionedRuntimeUpgrade`], ensuring the migration is only
+	/// performed when on-chain version is 0.
+	#[cfg(feature = "experimental")]
+	pub type VersionCheckedMigrateToV1<T> = frame_support::migrations::VersionedRuntimeUpgrade<
+		0,
+		1,
+		MigrateToV1<T>,
+		Pallet<T>,
+		<T as frame_system::Config>::DbWeight,
+	>;
+}