Update pallet-nis to support Block Number Provider

polkadot/runtime/rococo/src/lib.rs

@@ -1320,6 +1320,7 @@ impl pallet_nis::Config for Runtime {
 	type MaxIntakeWeight = MaxIntakeWeight;
 	type ThawThrottle = ThawThrottle;
 	type RuntimeHoldReason = RuntimeHoldReason;
+	type BlockNumberProvider = System;
 	#[cfg(feature = "runtime-benchmarks")]
 	type BenchmarkSetup = ();
 }

prdoc/pr_6764.prdoc

@@ -0,0 +1,15 @@
+# Schema: Polkadot SDK PRDoc Schema (prdoc) v1.0.0
+# See doc at https://raw.githubusercontent.com/paritytech/polkadot-sdk/master/prdoc/schema_user.json
+
+title: Update pallet-nis to support Block Number Provider
+
+doc:
+  - audience: Runtime Dev
+    description: |
+      This PR makes the block number provider used in the nis pallet configurable. 
+      Before this PR, pallet-nis always used the system block number, 
+      with this PR some runtime can opt to use the relay chain block number instead.
+
+crates:
+  - name: pallet-nis
+    bump: major

substrate/bin/node/runtime/src/lib.rs

@@ -2248,6 +2248,7 @@ impl pallet_nis::Config for Runtime {
 	type MaxIntakeWeight = MaxIntakeWeight;
 	type ThawThrottle = ThawThrottle;
 	type RuntimeHoldReason = RuntimeHoldReason;
+	type BlockNumberProvider = System;
 	#[cfg(feature = "runtime-benchmarks")]
 	type BenchmarkSetup = SetupAsset;
 }

substrate/frame/nis/Cargo.toml

@@ -20,6 +20,7 @@ codec = { features = ["derive"], workspace = true }
 frame-benchmarking = { optional = true, workspace = true }
 frame-support = { workspace = true }
 frame-system = { workspace = true }
+log = { workspace = true }
 scale-info = { features = ["derive"], workspace = true }
 sp-arithmetic = { workspace = true }
 sp-core = { workspace = true }
@@ -36,6 +37,7 @@ std = [
 	"frame-benchmarking?/std",
 	"frame-support/std",
 	"frame-system/std",
+	"log/std",
 	"pallet-balances/std",
 	"scale-info/std",
 	"sp-arithmetic/std",

substrate/frame/nis/src/benchmarking.rs

@@ -27,7 +27,7 @@ use frame_support::traits::{
 use frame_system::RawOrigin;
 use sp_arithmetic::Perquintill;
 use sp_runtime::{
-	traits::{Bounded, One, Zero},
+	traits::{BlockNumberProvider, Bounded, One, Zero},
 	DispatchError, PerThing,
 };
 
@@ -57,6 +57,12 @@ fn fill_queues<T: Config>() -> Result<(), DispatchError> {
 	Ok(())
 }
 
+fn set_block_number<T: Config>(
+	n: <<T as Config>::BlockNumberProvider as BlockNumberProvider>::BlockNumber,
+) {
+	<T as crate::Config>::BlockNumberProvider::set_block_number(n);
+}
+
 benchmarks! {
 	place_bid {
 		let l in 0..(T::MaxQueueLen::get() - 1);
@@ -166,7 +172,7 @@ benchmarks! {
 		Nis::<T>::place_bid(RawOrigin::Signed(caller.clone()).into(), bid, 1)?;
 		Nis::<T>::place_bid(RawOrigin::Signed(caller.clone()).into(), bid, 1)?;
 		Nis::<T>::process_queues(Perquintill::one(), 1, 2, &mut WeightCounter::unlimited());
-		frame_system::Pallet::<T>::set_block_number(Receipts::<T>::get(0).unwrap().expiry);
+		set_block_number::<T>(Receipts::<T>::get(0).unwrap().expiry);
 	}: _(RawOrigin::Signed(caller.clone()), 0, None)
 	verify {
 		assert!(Receipts::<T>::get(0).is_none());
@@ -184,7 +190,7 @@ benchmarks! {
 		Nis::<T>::place_bid(RawOrigin::Signed(caller.clone()).into(), bid, 1)?;
 		Nis::<T>::place_bid(RawOrigin::Signed(caller.clone()).into(), bid, 1)?;
 		Nis::<T>::process_queues(Perquintill::one(), 1, 2, &mut WeightCounter::unlimited());
-		frame_system::Pallet::<T>::set_block_number(Receipts::<T>::get(0).unwrap().expiry);
+		set_block_number::<T>(Receipts::<T>::get(0).unwrap().expiry);
 		Nis::<T>::communify(RawOrigin::Signed(caller.clone()).into(), 0)?;
 	}: _(RawOrigin::Signed(caller.clone()), 0)
 	verify {

substrate/frame/nis/src/lib.rs

@@ -91,12 +91,16 @@ use sp_runtime::{
 };
 
 mod benchmarking;
+pub mod migration;
 #[cfg(test)]
 mod mock;
 #[cfg(test)]
 mod tests;
 pub mod weights;
 
+/// The log target of this pallet.
+pub const LOG_TARGET: &'static str = "runtime::nis";
+
 pub struct WithMaximumOf<A: TypedGet>(core::marker::PhantomData<A>);
 impl<A: TypedGet> Convert<Perquintill, A::Type> for WithMaximumOf<A>
 where
@@ -190,21 +194,26 @@ pub mod pallet {
 		},
 		PalletId,
 	};
-	use frame_system::pallet_prelude::*;
+	use frame_system::pallet_prelude::{BlockNumberFor as SystemBlockNumberFor, *};
 	use sp_arithmetic::{PerThing, Perquintill};
 	use sp_runtime::{
-		traits::{AccountIdConversion, Bounded, Convert, ConvertBack, Saturating, Zero},
+		traits::{
+			AccountIdConversion, BlockNumberProvider, Bounded, Convert, ConvertBack, Saturating,
+			Zero,
+		},
 		Rounding, TokenError,
 	};
 
-	type BalanceOf<T> =
+	pub(crate) type BlockNumberFor<T> =
+		<<T as Config>::BlockNumberProvider as BlockNumberProvider>::BlockNumber;
+	pub(crate) type BalanceOf<T> =
 		<<T as Config>::Currency as FunInspect<<T as frame_system::Config>::AccountId>>::Balance;
 	type DebtOf<T> =
 		fungible::Debt<<T as frame_system::Config>::AccountId, <T as Config>::Currency>;
-	type ReceiptRecordOf<T> =
+	pub(crate) type ReceiptRecordOf<T> =
 		ReceiptRecord<<T as frame_system::Config>::AccountId, BlockNumberFor<T>, BalanceOf<T>>;
 	type IssuanceInfoOf<T> = IssuanceInfo<BalanceOf<T>>;
-	type SummaryRecordOf<T> = SummaryRecord<BlockNumberFor<T>, BalanceOf<T>>;
+	pub(crate) type SummaryRecordOf<T> = SummaryRecord<BlockNumberFor<T>, BalanceOf<T>>;
 	type BidOf<T> = Bid<BalanceOf<T>, <T as frame_system::Config>::AccountId>;
 	type QueueTotalsTypeOf<T> = BoundedVec<(u32, BalanceOf<T>), <T as Config>::QueueCount>;
 
@@ -312,6 +321,25 @@ pub mod pallet {
 		#[pallet::constant]
 		type ThawThrottle: Get<(Perquintill, BlockNumberFor<Self>)>;
 
+		/// Abstracted source of block numbers for this pallet.
+		///
+		/// This provider decouples the pallet from direct use of the system block number, allowing:
+		/// - Integration with external block number sources.
+		/// - Custom timekeeping mechanisms (e.g. mock timelines for testing)
+		/// - Composite block numbers (e.g. parachain blocks vs relay chain blocks)
+		///
+		/// # Example: Using Relay Chain Block Numbers
+		/// ```rust,ignore
+		/// impl Config for Runtime {
+		///     type BlockNumberProvider = frame_system::Pallet<Runtime>;
+		/// }
+		/// ```
+		///
+		/// # Warning
+		/// Only implement custom providers if you need alternative timekeeping - most
+		/// pallets should use the system block number through `frame_system::Pallet<Runtime>`.
+		type BlockNumberProvider: BlockNumberProvider<BlockNumber: Default>;
+
 		/// Setup the state for benchmarking.
 		#[cfg(feature = "runtime-benchmarks")]
 		type BenchmarkSetup: crate::BenchmarkSetup;
@@ -407,6 +435,9 @@ pub mod pallet {
 	pub type Receipts<T> =
 		StorageMap<_, Blake2_128Concat, ReceiptIndex, ReceiptRecordOf<T>, OptionQuery>;
 
+	#[pallet::storage]
+	pub type LastProcessedBlock<T> = StorageValue<_, BlockNumberFor<T>, ValueQuery>;
+
 	#[pallet::event]
 	#[pallet::generate_deposit(pub(super) fn deposit_event)]
 	pub enum Event<T: Config> {
@@ -515,12 +546,19 @@ pub mod pallet {
 	}
 
 	#[pallet::hooks]
-	impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {
-		fn on_initialize(n: BlockNumberFor<T>) -> Weight {
+	impl<T: Config> Hooks<SystemBlockNumberFor<T>> for Pallet<T> {
+		fn on_initialize(_n: SystemBlockNumberFor<T>) -> Weight {
+			let block_number = T::BlockNumberProvider::current_block_number();
 			let mut weight_counter =
 				WeightCounter { used: Weight::zero(), limit: T::MaxIntakeWeight::get() };
-			if T::IntakePeriod::get().is_zero() || (n % T::IntakePeriod::get()).is_zero() {
+			let last_processed = LastProcessedBlock::<T>::get();
+			let intake_period = T::IntakePeriod::get();
+			if intake_period.is_zero() ||
+				block_number.saturating_sub(last_processed) >= intake_period
+			{
 				if weight_counter.check_accrue(T::WeightInfo::process_queues()) {
+					LastProcessedBlock::<T>::put(block_number);
+					weight_counter.check_accrue(T::DbWeight::get().writes(1));
 					Self::process_queues(
 						T::Target::get(),
 						T::QueueCount::get(),
@@ -693,7 +731,7 @@ pub mod pallet {
 			let (owner, mut on_hold) = receipt.owner.ok_or(Error::<T>::AlreadyCommunal)?;
 			ensure!(owner == who, Error::<T>::NotOwner);
 
-			let now = frame_system::Pallet::<T>::block_number();
+			let now = T::BlockNumberProvider::current_block_number();
 			ensure!(now >= receipt.expiry, Error::<T>::NotExpired);
 
 			let mut summary: SummaryRecordOf<T> = Summary::<T>::get();
@@ -800,7 +838,7 @@ pub mod pallet {
 				Receipts::<T>::get(index).ok_or(Error::<T>::UnknownReceipt)?;
 			// If found, check it is actually communal.
 			ensure!(receipt.owner.is_none(), Error::<T>::NotOwner);
-			let now = frame_system::Pallet::<T>::block_number();
+			let now = T::BlockNumberProvider::current_block_number();
 			ensure!(now >= receipt.expiry, Error::<T>::NotExpired);
 
 			let mut summary: SummaryRecordOf<T> = Summary::<T>::get();
@@ -1032,7 +1070,7 @@ pub mod pallet {
 				return
 			}
 
-			let now = frame_system::Pallet::<T>::block_number();
+			let now = T::BlockNumberProvider::current_block_number();
 			let our_account = Self::account_id();
 			let issuance: IssuanceInfoOf<T> = Self::issuance_with(&our_account, &summary);
 			let mut remaining = target.saturating_sub(summary.proportion_owed) * issuance.effective;