Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update pallet-nis to support Block Number Provider #6764

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Update pallet-nis to support Block Number Provider #6764

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7aab0eb
include BlockNumberProvider in config
Doordashcon Dec 4, 2024
f2bfa0c
BlockNumberProvider: Default
Doordashcon Dec 5, 2024
f947458
add prdoc & benchmark helper function
Doordashcon Dec 8, 2024
edc68f2
remove BlockNumberFor import benchmarks
Doordashcon Dec 8, 2024
f73ae91
Merge branch 'master' into BNP-pallet-nis
Doordashcon Dec 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions polkadot/runtime/rococo/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1304,6 +1304,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 = ();
}
Expand Down
15 changes: 15 additions & 0 deletions prdoc/pr_6764.prdoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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: minor
1 change: 1 addition & 0 deletions substrate/bin/node/runtime/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1904,6 +1904,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;
}
Expand Down
12 changes: 9 additions & 3 deletions substrate/frame/nis/src/benchmarking.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
};

Expand Down Expand Up @@ -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);
Expand Down Expand Up @@ -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());
Expand All @@ -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 {
Expand Down
25 changes: 17 additions & 8 deletions substrate/frame/nis/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,13 +190,18 @@ 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 BlockNumberFor<T> =
<<T as Config>::BlockNumberProvider as BlockNumberProvider>::BlockNumber;
type BalanceOf<T> =
<<T as Config>::Currency as FunInspect<<T as frame_system::Config>::AccountId>>::Balance;
type DebtOf<T> =
Expand Down Expand Up @@ -312,6 +317,8 @@ pub mod pallet {
#[pallet::constant]
type ThawThrottle: Get<(Perquintill, BlockNumberFor<Self>)>;

type BlockNumberProvider: BlockNumberProvider<BlockNumber: Default>;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing docs.


/// Setup the state for benchmarking.
#[cfg(feature = "runtime-benchmarks")]
type BenchmarkSetup: crate::BenchmarkSetup;
Expand Down Expand Up @@ -515,11 +522,13 @@ 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() {
if T::IntakePeriod::get().is_zero() || (block_number % T::IntakePeriod::get()).is_zero()
{
if weight_counter.check_accrue(T::WeightInfo::process_queues()) {
Self::process_queues(
T::Target::get(),
Expand Down Expand Up @@ -693,7 +702,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();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Misses a migration for the Receipts to change the expiry to the "new clock". (Not required when switched to System as block number provider.

Copy link
Contributor

@gui1117 gui1117 Dec 9, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Most of those PR is for pallet in the relay chain to go to a parachain without requiring migration.

But in the wider scope I can see parachain could also make use of the relay chain block number provider when they are going more agile and skip some blocks.
In this case a migration would help indeed. We can just provide a function helper to do this migration, no need for storage versioning. Because parachain could change the configuration of the block number whenever they want, so unrelated to the version of the pallet.

@kianenigma do you think we should provide the block number migration function for all such pallets? I think some approved one don't have it.
Or should it be done on-demand when people ask for it?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would not include a migration for the time being, assuming the PR and code-doc are super clear under which circumstances you do, and do not need a migration.

Copy link
Member

@bkchr bkchr Dec 9, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But in the wider scope I can see parachain could also make use of the relay chain block number provider when they are going more agile and skip some blocks.

This is the entire point of this exercise. Otherwise it is quite useless. Not sure why we approve prs without a migration. Also requiring everyone to write their own migration is a little bit stupid. Especially as by just "reading the docs" it will not be that easy. Block numbers are stored internally in some structures and may not be that obvious for others to find them etc. This will just end up in a mess, if people are forced to write their own migrations.

ensure!(now >= receipt.expiry, Error::<T>::NotExpired);

let mut summary: SummaryRecordOf<T> = Summary::<T>::get();
Expand Down Expand Up @@ -800,7 +809,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();
Expand Down Expand Up @@ -1032,7 +1041,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;
Expand Down
31 changes: 22 additions & 9 deletions substrate/frame/nis/src/mock.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ use frame_support::{
};
use pallet_balances::{Instance1, Instance2};
use sp_core::ConstU128;
use sp_runtime::BuildStorage;
use sp_runtime::{traits::BlockNumberProvider, BuildStorage};

type Block = frame_system::mocking::MockBlock<Test>;

Expand Down Expand Up @@ -123,6 +123,7 @@ impl pallet_nis::Config for Test {
type MinReceipt = MinReceipt;
type ThawThrottle = ThawThrottle;
type RuntimeHoldReason = RuntimeHoldReason;
type BlockNumberProvider = System;
#[cfg(feature = "runtime-benchmarks")]
type BenchmarkSetup = ();
}
Expand All @@ -147,13 +148,25 @@ pub fn new_test_ext_empty() -> sp_io::TestExternalities {
}

pub fn run_to_block(n: u64) {
while System::block_number() < n {
Nis::on_finalize(System::block_number());
Balances::on_finalize(System::block_number());
System::on_finalize(System::block_number());
System::set_block_number(System::block_number() + 1);
System::on_initialize(System::block_number());
Balances::on_initialize(System::block_number());
Nis::on_initialize(System::block_number());
while <Test as pallet_nis::Config>::BlockNumberProvider::current_block_number() < n {
Nis::on_finalize(<Test as pallet_nis::Config>::BlockNumberProvider::current_block_number());
Balances::on_finalize(
<Test as pallet_nis::Config>::BlockNumberProvider::current_block_number(),
);
System::on_finalize(
<Test as pallet_nis::Config>::BlockNumberProvider::current_block_number(),
);
System::set_block_number(
<Test as pallet_nis::Config>::BlockNumberProvider::current_block_number() + 1,
);
System::on_initialize(
<Test as pallet_nis::Config>::BlockNumberProvider::current_block_number(),
);
Balances::on_initialize(
<Test as pallet_nis::Config>::BlockNumberProvider::current_block_number(),
);
Nis::on_initialize(
<Test as pallet_nis::Config>::BlockNumberProvider::current_block_number(),
);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

on_finalize/on_initialize is taking system block number. Here is works because both pallet_nis block number and system block number are the same.
I think the code is cleaner if we use system block number same as before in this test no?

}
}
Loading