Prepare pallets for async backing

Author: dastansam

Cargo.lock

@@ -51,6 +51,7 @@ pallet-elections-phragmen.workspace = true
 pallet-message-queue.workspace = true
 cumulus-primitives-core.workspace = true
 cumulus-pallet-xcm.workspace = true
+cumulus-pallet-parachain-system.workspace = true
 
 parachain-info.workspace = true
 parachains-common.workspace = true

integration-tests/Cargo.toml

@@ -583,7 +583,7 @@ fn e2e_test() {
 		assert_close_enough!(sub_account_held_plmc, plmc_balance, Perquintill::from_float(0.999));
 
 		let otm_duration = Multiplier::force_new(5).calculate_vesting_duration::<PolimecRuntime>();
-		let now = PolimecSystem::block_number();
+		let now = PolkadotSystem::block_number();
 		inst.jump_to_block(now + otm_duration);
 
 		let treasury_account = <PolimecRuntime as pallet_proxy_bonding::Config>::Treasury::get();

integration-tests/src/tests/e2e.rs

@@ -163,10 +163,10 @@ use frame_support::{
 	},
 	weights::Weight,
 };
-use frame_system::pallet_prelude::{BlockNumberFor, OriginFor};
+use frame_system::pallet_prelude::OriginFor;
 use parity_scale_codec::{Decode, Encode};
 use sp_runtime::{
-	traits::{Bounded as ArithBounded, One, Saturating, StaticLookup, Zero},
+	traits::{BlockNumberProvider, Bounded as ArithBounded, One, Saturating, StaticLookup, Zero},
 	ArithmeticError, DispatchError, DispatchResult,
 };
 
@@ -199,11 +199,12 @@ pub type CreditOf<T> = Credit<<T as frame_system::Config>::AccountId, <T as Conf
 
 pub type CallOf<T> = <T as frame_system::Config>::RuntimeCall;
 pub type BoundedCallOf<T> = Bounded<CallOf<T>, <T as frame_system::Config>::Hashing>;
+pub type BlockNumberFor<T> = <<T as Config>::BlockNumberProvider as BlockNumberProvider>::BlockNumber;
 type AccountIdLookupOf<T> = <<T as frame_system::Config>::Lookup as StaticLookup>::Source;
 
 #[frame_support::pallet]
 pub mod pallet {
-	use super::{DispatchResult, *};
+	use super::{BlockNumberFor, DispatchResult, *};
 	use frame_support::{
 		pallet_prelude::*,
 		traits::{
@@ -212,6 +213,7 @@ pub mod pallet {
 		},
 	};
 	use frame_system::pallet_prelude::*;
+	use sp_runtime::traits::BlockNumberProvider;
 	/// The current storage version.
 	const STORAGE_VERSION: StorageVersion = StorageVersion::new(1);
 
@@ -350,6 +352,9 @@ pub mod pallet {
 
 		/// Type returning the total electorate.
 		type Electorate: GetElectorate<BalanceOf<Self>>;
+
+		/// Block number provider.
+		type BlockNumberProvider: BlockNumberProvider<BlockNumber = frame_system::pallet_prelude::BlockNumberFor<Self>>;
 	}
 
 	/// The number of (public) proposals that have been made so far.
@@ -610,7 +615,7 @@ pub mod pallet {
 			let proposal_hash = proposal.hash();
 
 			if let Some((until, _)) = <Blacklist<T>>::get(proposal_hash) {
-				ensure!(<frame_system::Pallet<T>>::block_number() >= until, Error::<T>::ProposalBlacklisted,);
+				ensure!(T::BlockNumberProvider::current_block_number() >= until, Error::<T>::ProposalBlacklisted,);
 			}
 
 			T::Fungible::hold(&HoldReason::Proposal.into(), &who, value)?;
@@ -700,7 +705,7 @@ pub mod pallet {
 			T::ExternalOrigin::ensure_origin(origin)?;
 			ensure!(!<NextExternal<T>>::exists(), Error::<T>::DuplicateProposal);
 			if let Some((until, _)) = <Blacklist<T>>::get(proposal.hash()) {
-				ensure!(<frame_system::Pallet<T>>::block_number() >= until, Error::<T>::ProposalBlacklisted,);
+				ensure!(T::BlockNumberProvider::current_block_number() >= until, Error::<T>::ProposalBlacklisted,);
 			}
 			<NextExternal<T>>::put((proposal, VoteThreshold::SuperMajorityApprove));
 			Ok(())
@@ -790,7 +795,7 @@ pub mod pallet {
 			ensure!(proposal_hash == ext_proposal.hash(), Error::<T>::InvalidHash);
 
 			<NextExternal<T>>::kill();
-			let now = <frame_system::Pallet<T>>::block_number();
+			let now = T::BlockNumberProvider::current_block_number();
 			let ref_index = Self::inject_referendum(now.saturating_add(voting_period), ext_proposal, threshold, delay);
 			Self::transfer_metadata(MetadataOwner::External, MetadataOwner::Referendum(ref_index));
 			Ok(())
@@ -820,7 +825,7 @@ pub mod pallet {
 			let insert_position = existing_vetoers.binary_search(&who).err().ok_or(Error::<T>::AlreadyVetoed)?;
 			existing_vetoers.try_insert(insert_position, who.clone()).map_err(|_| Error::<T>::TooMany)?;
 
-			let until = <frame_system::Pallet<T>>::block_number().saturating_add(T::CooloffPeriod::get());
+			let until = T::BlockNumberProvider::current_block_number().saturating_add(T::CooloffPeriod::get());
 			<Blacklist<T>>::insert(&proposal_hash, (until, existing_vetoers));
 
 			Self::deposit_event(Event::<T>::Vetoed { who, proposal_hash, until });
@@ -1196,7 +1201,7 @@ impl<T: Config> Pallet<T> {
 		delay: BlockNumberFor<T>,
 	) -> ReferendumIndex {
 		<Pallet<T>>::inject_referendum(
-			<frame_system::Pallet<T>>::block_number().saturating_add(T::VotingPeriod::get()),
+			T::BlockNumberProvider::current_block_number().saturating_add(T::VotingPeriod::get()),
 			proposal,
 			threshold,
 			delay,
@@ -1291,7 +1296,7 @@ impl<T: Config> Pallet<T> {
 						if let Some((lock_periods, balance)) = votes[i].1.locked_if(approved) {
 							let unlock_at =
 								end.saturating_add(T::VoteLockingPeriod::get().saturating_mul(lock_periods.into()));
-							let now = frame_system::Pallet::<T>::block_number();
+							let now = T::BlockNumberProvider::current_block_number();
 							if now < unlock_at {
 								ensure!(matches!(scope, UnvoteScope::Any), Error::<T>::NoPermission);
 								prior.accumulate(unlock_at, balance)
@@ -1380,7 +1385,7 @@ impl<T: Config> Pallet<T> {
 				Voting::Delegating { balance, target, conviction, delegations, mut prior, .. } => {
 					// remove any delegation votes to our current target.
 					Self::reduce_upstream_delegation(&target, conviction.votes(balance));
-					let now = frame_system::Pallet::<T>::block_number();
+					let now = T::BlockNumberProvider::current_block_number();
 					let lock_periods = conviction.lock_periods().into();
 					let unlock_block = now.saturating_add(T::VoteLockingPeriod::get().saturating_mul(lock_periods));
 					prior.accumulate(unlock_block, balance);
@@ -1413,7 +1418,7 @@ impl<T: Config> Pallet<T> {
 				Voting::Delegating { balance, target, conviction, delegations, mut prior } => {
 					// remove any delegation votes to our current target.
 					let votes = Self::reduce_upstream_delegation(&target, conviction.votes(balance));
-					let now = frame_system::Pallet::<T>::block_number();
+					let now = T::BlockNumberProvider::current_block_number();
 					let lock_periods = conviction.lock_periods().into();
 					let unlock_block = now.saturating_add(T::VoteLockingPeriod::get().saturating_mul(lock_periods));
 					prior.accumulate(unlock_block, balance);
@@ -1432,7 +1437,7 @@ impl<T: Config> Pallet<T> {
 	/// a security hole) but may be reduced from what they are currently.
 	fn update_lock(who: &T::AccountId) -> DispatchResult {
 		let lock_needed = VotingOf::<T>::mutate(who, |voting| {
-			voting.rejig(frame_system::Pallet::<T>::block_number());
+			voting.rejig(T::BlockNumberProvider::current_block_number());
 			voting.locked_balance()
 		});
 		if lock_needed.is_zero() {

pallets/democracy/src/lib.rs

@@ -149,6 +149,7 @@ impl GetElectorate<BalanceOf<Test>> for Electorate {
 
 impl Config for Test {
 	type BlacklistOrigin = EnsureRoot<u64>;
+	type BlockNumberProvider = System;
 	type CancelProposalOrigin = EnsureRoot<u64>;
 	type CancellationOrigin = EnsureSignedBy<Four, u64>;
 	type CooloffPeriod = ConstU64<2>;

pallets/democracy/src/tests.rs

@@ -55,7 +55,7 @@ pub mod pallet {
 		pallet_prelude::{ValueQuery, *},
 		PalletId,
 	};
-	use frame_system::pallet_prelude::*;
+	use frame_system::pallet_prelude::{BlockNumberFor, *};
 	use sp_runtime::{
 		traits::{AccountIdConversion, CheckedDiv},
 		Saturating,
@@ -115,6 +115,9 @@ pub mod pallet {
 		/// The Whitelisted policy for the dispenser. Users' credentials should have the same
 		/// policy to be eligible for token dispensing.
 		type WhitelistedPolicy: Get<Cid>;
+
+		// /// Block number provider.
+		// type BlockNumberProvider: BlockNumberProvider<BlockNumber = BlockNumberFor<Self>>;
 	}
 
 	#[pallet::pallet]

pallets/dispenser/src/lib.rs

@@ -50,6 +50,8 @@ hex.workspace = true
 # Used in the instantiator.
 itertools.workspace = true
 sp-io.workspace = true
+cumulus-pallet-parachain-system.workspace = true
+cumulus-primitives-core.workspace = true
 
 [dev-dependencies]
 pallet-timestamp.workspace = true

pallets/funding/Cargo.toml

@@ -97,7 +97,7 @@ pub fn string_account<AccountId: Decode>(
 
 #[benchmarks(
 	where
-	T: Config + frame_system::Config<RuntimeEvent = <T as Config>::RuntimeEvent> + pallet_balances::Config<Balance = Balance> + core::fmt::Debug,
+	T: Config + frame_system::Config<RuntimeEvent = <T as Config>::RuntimeEvent> + pallet_balances::Config<Balance = Balance> + cumulus_pallet_parachain_system::Config + sp_std::fmt::Debug,
 	<T as Config>::RuntimeEvent: TryInto<Event<T>> + Parameter + Member,
 	<T as Config>::Price: From<u128>,
 	T::Hash: From<H256>,

pallets/funding/src/benchmarking.rs

@@ -84,7 +84,7 @@ impl<T: Config> Pallet<T> {
 		// * Get variables *
 		let project_metadata = ProjectsMetadata::<T>::get(project_id).ok_or(Error::<T>::ProjectMetadataNotFound)?;
 		let mut project_details = ProjectsDetails::<T>::get(project_id).ok_or(Error::<T>::ProjectDetailsNotFound)?;
-		let now = <frame_system::Pallet<T>>::block_number();
+		let now = <T as Config>::BlockNumberProvider::current_block_number();
 		let evaluation_id = NextEvaluationId::<T>::get();
 		let plmc_usd_price =
 			<PriceProviderOf<T>>::get_decimals_aware_price(Location::here(), USD_DECIMALS, PLMC_DECIMALS)

pallets/funding/src/functions/2_evaluation.rs

@@ -22,7 +22,7 @@ impl<T: Config> Pallet<T> {
 
 		// Fetch current bucket details and other required info
 		let mut current_bucket = Buckets::<T>::get(project_id).ok_or(Error::<T>::BucketNotFound)?;
-		let now = <frame_system::Pallet<T>>::block_number();
+		let now = <T as Config>::BlockNumberProvider::current_block_number();
 		let mut amount_to_bid = ct_amount;
 		let project_policy = project_metadata.policy_ipfs_cid.ok_or(Error::<T>::ImpossibleState)?;
 

pallets/funding/src/functions/3_auction.rs

@@ -9,7 +9,7 @@ impl<T: Config> Pallet<T> {
 		let project_metadata = ProjectsMetadata::<T>::get(project_id).ok_or(Error::<T>::ProjectMetadataNotFound)?;
 		let mut project_details = ProjectsDetails::<T>::get(project_id).ok_or(Error::<T>::ProjectDetailsNotFound)?;
 		let bucket = Buckets::<T>::get(project_id).ok_or(Error::<T>::BucketNotFound)?;
-		let now = <frame_system::Pallet<T>>::block_number();
+		let now = <T as Config>::BlockNumberProvider::current_block_number();
 		let issuer_did = project_details.issuer_did.clone();
 		let ct_amount_oversubscribed = CTAmountOversubscribed::<T>::get(project_id);
 

pallets/funding/src/functions/4_funding_end.rs

@@ -28,7 +28,7 @@ impl<T: Config> Pallet<T> {
 		let mut project_details = ProjectsDetails::<T>::get(project_id).ok_or(Error::<T>::ProjectDetailsNotFound)?;
 		let token_information =
 			ProjectsMetadata::<T>::get(project_id).ok_or(Error::<T>::ProjectMetadataNotFound)?.token_information;
-		let now = <frame_system::Pallet<T>>::block_number();
+		let now = <T as Config>::BlockNumberProvider::current_block_number();
 
 		project_details.funding_end_block = Some(now);
 
@@ -38,7 +38,7 @@ impl<T: Config> Pallet<T> {
 				let multiplier: MultiplierOf<T> =
 					ParticipationMode::OTM.multiplier().try_into().map_err(|_| Error::<T>::ImpossibleState)?;
 				let duration = multiplier.calculate_vesting_duration::<T>();
-				let now = <frame_system::Pallet<T>>::block_number();
+				let now = <T as Config>::BlockNumberProvider::current_block_number();
 				ReleaseType::Locked(duration.saturating_add(now))
 			};
 			<pallet_proxy_bonding::Pallet<T>>::set_release_type(

pallets/funding/src/functions/5_settlement.rs

@@ -263,7 +263,7 @@ impl<T: Config> Pallet<T> {
 		skip_end_check: bool,
 	) -> DispatchResult {
 		/* Verify */
-		let now = <frame_system::Pallet<T>>::block_number();
+		let now = <T as Config>::BlockNumberProvider::current_block_number();
 		ensure!(project_details.status == current_round, Error::<T>::IncorrectRound);
 		ensure!(project_details.round_duration.ended(now) || skip_end_check, Error::<T>::TooEarlyForRound);
 

pallets/funding/src/functions/misc.rs

@@ -17,7 +17,6 @@ use frame_support::{
 	},
 	transactional,
 };
-use frame_system::pallet_prelude::BlockNumberFor;
 use polimec_common::{
 	credentials::{Did, InvestorType},
 	USD_DECIMALS,

pallets/funding/src/functions/mod.rs

@@ -237,7 +237,7 @@ impl<T: Config> Pallet<T> {
 			.enumerate()
 			// Filter out schedules with future starting blocks before collecting them into a vector.
 			.filter_map(|(i, schedule)| {
-				if schedule.starting_block > <frame_system::Pallet<T>>::block_number() {
+				if schedule.starting_block > <T as Config>::BlockNumberProvider::current_block_number() {
 					None
 				} else {
 					Some((i, schedule.ending_block_as_balance::<BlockNumberToBalanceOf<T>>()))

pallets/funding/src/functions/runtime_api.rs

@@ -13,7 +13,7 @@ use sp_runtime::traits::TrailingZeroInput;
 use InvestorType::{self, *};
 
 impl<
-		T: Config,
+		T: Config + cumulus_pallet_parachain_system::Config,
 		AllPalletsWithoutSystem: OnFinalize<BlockNumberFor<T>> + OnIdle<BlockNumberFor<T>> + OnInitialize<BlockNumberFor<T>>,
 		RuntimeEvent: From<Event<T>> + TryInto<Event<T>> + Parameter + Member + IsType<<T as frame_system::Config>::RuntimeEvent>,
 	> Instantiator<T, AllPalletsWithoutSystem, RuntimeEvent>

pallets/funding/src/instantiator/calculations.rs

@@ -7,7 +7,7 @@ use polimec_common::assets::AcceptedFundingAsset;
 
 // general chain interactions
 impl<
-		T: Config + pallet_balances::Config<Balance = Balance>,
+		T: Config + pallet_balances::Config<Balance = Balance> + cumulus_pallet_parachain_system::Config,
 		AllPalletsWithoutSystem: OnFinalize<BlockNumberFor<T>> + OnIdle<BlockNumberFor<T>> + OnInitialize<BlockNumberFor<T>>,
 		RuntimeEvent: From<Event<T>> + TryInto<Event<T>> + Parameter + Member + IsType<<T as frame_system::Config>::RuntimeEvent>,
 	> Instantiator<T, AllPalletsWithoutSystem, RuntimeEvent>
@@ -145,13 +145,13 @@ impl<
 	}
 
 	pub fn current_block(&mut self) -> BlockNumberFor<T> {
-		self.execute(|| frame_system::Pallet::<T>::block_number())
+		self.execute(|| <T as Config>::BlockNumberProvider::current_block_number())
 	}
 
 	pub fn advance_time(&mut self, amount: BlockNumberFor<T>) {
 		self.execute(|| {
 			for _block in 0u32..amount.saturated_into() {
-				let mut current_block = frame_system::Pallet::<T>::block_number();
+				let mut current_block = <T as Config>::BlockNumberProvider::current_block_number();
 
 				<AllPalletsWithoutSystem as OnFinalize<BlockNumberFor<T>>>::on_finalize(current_block);
 				<frame_system::Pallet<T> as OnFinalize<BlockNumberFor<T>>>::on_finalize(current_block);
@@ -165,13 +165,21 @@ impl<
 				<frame_system::Pallet<T> as OnInitialize<BlockNumberFor<T>>>::on_initialize(current_block);
 				<AllPalletsWithoutSystem as OnInitialize<BlockNumberFor<T>>>::on_initialize(current_block);
 			}
-		})
+		});
+
+		let current_block = self.current_block();
+		// in case we are relying on parachain system
+		self.set_relay_chain_block_number(current_block + amount);
 	}
 
 	pub fn jump_to_block(&mut self, block: BlockNumberFor<T>) {
 		let current_block = self.current_block();
 		if block > current_block {
-			self.execute(|| frame_system::Pallet::<T>::set_block_number(block - One::one()));
+			self.execute(|| {
+				frame_system::Pallet::<T>::set_block_number(block - One::one());
+			});
+			self.set_relay_chain_block_number(block - One::one());
+
 			self.advance_time(One::one());
 		} else {
 			// panic!("Cannot jump to a block in the present or past")
@@ -217,11 +225,35 @@ impl<
 			});
 		}
 	}
+
+	/// NOTE: this is a workaround function to advance relaychain's block number, since
+	/// `<T as Config>::BlockNumberProvider::set_block_number` is not working in tests
+	///
+	/// It is cloned version of the above trait function implementation in [`cumulus_pallet_parachain_system::RelaychainDataProvider`]
+	///
+	/// TODO: remove this function once the issue is fixed
+	pub fn set_relay_chain_block_number(&mut self, to: BlockNumberFor<T>) {
+		use cumulus_pallet_parachain_system::ValidationData;
+		use cumulus_primitives_core::PersistedValidationData;
+
+		self.execute(|| {
+			let mut validation_data = ValidationData::<T>::get().unwrap_or_else(||
+				// PersistedValidationData does not impl default in non-std
+				PersistedValidationData {
+					parent_head: vec![].into(),
+					relay_parent_number: Default::default(),
+					max_pov_size: Default::default(),
+					relay_parent_storage_root: Default::default(),
+				});
+			validation_data.relay_parent_number = to.saturated_into();
+			ValidationData::<T>::put(validation_data)
+		});
+	}
 }
 
 // assertions
 impl<
-		T: Config + pallet_balances::Config<Balance = Balance>,
+		T: Config + pallet_balances::Config<Balance = Balance> + cumulus_pallet_parachain_system::Config,
 		AllPalletsWithoutSystem: OnFinalize<BlockNumberFor<T>> + OnIdle<BlockNumberFor<T>> + OnInitialize<BlockNumberFor<T>>,
 		RuntimeEvent: From<Event<T>> + TryInto<Event<T>> + Parameter + Member + IsType<<T as frame_system::Config>::RuntimeEvent>,
 	> Instantiator<T, AllPalletsWithoutSystem, RuntimeEvent>
@@ -328,7 +360,7 @@ impl<
 
 // project chain interactions
 impl<
-		T: Config + pallet_balances::Config<Balance = Balance>,
+		T: Config + pallet_balances::Config<Balance = Balance> + cumulus_pallet_parachain_system::Config,
 		AllPalletsWithoutSystem: OnFinalize<BlockNumberFor<T>> + OnIdle<BlockNumberFor<T>> + OnInitialize<BlockNumberFor<T>>,
 		RuntimeEvent: From<Event<T>> + TryInto<Event<T>> + Parameter + Member + IsType<<T as frame_system::Config>::RuntimeEvent>,
 	> Instantiator<T, AllPalletsWithoutSystem, RuntimeEvent>

pallets/funding/src/instantiator/chain_interactions.rs

@@ -32,7 +32,6 @@ use frame_support::{
 	weights::Weight,
 	Parameter,
 };
-use frame_system::pallet_prelude::BlockNumberFor;
 use itertools::Itertools;
 use parity_scale_codec::Decode;
 use polimec_common::{credentials::InvestorType, migration_types::MigrationOrigin};