Add "run to block" tools by aurexav · Pull Request #7109 · paritytech/polkadot-sdk

aurexav · 2025-01-10T08:24:28Z

Introduce frame_system::Pallet::run_to_block, frame_system::Pallet::run_to_block_with, and frame_system::RunToBlockHooks to establish a generic run_to_block mechanism for mock tests, minimizing redundant implementations across various pallets.

Closes #299.

Polkadot address: 156HGo9setPcU2qhFMVWLkcmtCEGySLwNqa3DaEiYSWtte4Y

Signed-off-by: Xavier Lau <x@acg.box>

bkchr

Nice work! Left some minor things to fix up :)

substrate/frame/system/src/lib.rs

bkchr · 2025-01-10T16:19:58Z

substrate/frame/system/src/lib.rs

+	after_initialize: Box<dyn 'a + FnMut(BlockNumberFor<T>)>,
+	before_finalize: Box<dyn 'a + FnMut(BlockNumberFor<T>)>,
+	after_finalize: Box<dyn 'a + FnMut(BlockNumberFor<T>)>,
+	_marker: PhantomData<&'a T>,


As we are using T, this should not be required.

Yep, did a refactor and forgot about this.

bkchr · 2025-01-10T16:24:29Z

substrate/frame/system/src/lib.rs

+	/// provided closures at each block.
+	///
+	/// These hooks allows custom logic to be executed at each block at specific location.
+	/// For example, you might use one of them to set a timestamp for each block.


Maybe mentioning that finalize_block is called before each on_initialize.

bkchr · 2025-01-10T16:29:43Z

substrate/frame/staking/src/mock.rs

 			// having `timestamp::on_initialize` called before `staking::on_initialize`. Also, if
 			// session length is 1, then it is already triggered.


The comment doesn't really hold? :D

bkchr · 2025-01-10T16:33:02Z

substrate/frame/staking/src/mock.rs

+	// Revert the `Authorship::OnInitialize`'s `note_author` reward for easy testing.
+	for i in start_session_idx..end_session_idx {
+		let blocks_per_session = if i == 0 {
+			// Skip block 0.
+			period - 1
+		} else {
+			period
+		};
+		let extra_reward_points = blocks_per_session as RewardPoint * 20;
+
+		ErasRewardPoints::<Test>::mutate(i / sessions_per_era, |p| {
+			if let Some(author_11) = p.individual.get_mut(&11) {
+				p.total = p.total.saturating_sub(extra_reward_points);
+				*author_11 = (*author_11).saturating_sub(extra_reward_points);
+			}
+		});
+	}


Can we not just set the EventHandler to () to prevent this from happening?

Aha, missed this one.

bkchr · 2025-01-10T16:34:25Z

substrate/frame/staking/src/mock.rs

+				System::run_to_block_with::<AllPalletsWithSystem>(
+					1,
+					frame_system::RunToBlockHooks::default().after_initialize(|_| {
+						Timestamp::set_timestamp(INIT_TIMESTAMP);
+					}),
+				);


Can we not just call the run_to_block function here? (I know that the timestamp would be different, but the current setting here is wrong any way)

But the origin code appears to be equivalent to running to block 1?

What I mean is to use run_to_block from this file and not call System::run_to_block manually.

Okay, then reset the timestamp.

Make sense, to keep logic in a single place.

bkchr · 2025-01-11T07:49:17Z

substrate/frame/staking/src/mock.rs

+				System::run_to_block_with::<AllPalletsWithSystem>(
+					1,
+					frame_system::RunToBlockHooks::default().after_initialize(|_| {
+						Timestamp::set_timestamp(INIT_TIMESTAMP);
+					}),
+				);


What I mean is to use run_to_block from this file and not call System::run_to_block manually.

bkchr · 2025-01-11T07:51:24Z

/tip medium

substrate-tip-bot · 2025-01-11T07:51:51Z

@bkchr A referendum for a medium (80 DOT) tip was successfully submitted for @aurexav (156HGo9setPcU2qhFMVWLkcmtCEGySLwNqa3DaEiYSWtte4Y on polkadot).

Referendum number: 1379.

gui1117

Looks good to me, thank you

gui1117 · 2025-01-15T09:56:02Z

/cmd prdoc --audience runtime_dev --bump patch

…ump patch'

prdoc/pr_7109.prdoc

* master: (33 commits) Implement `pallet-asset-rewards` (#3926) [pallet-revive] Add host function `to_account_id` (#7091) [pallet-revive] Remove revive events (#7164) [pallet-revive] Remove debug buffer (#7163) litep2p: Provide partial results to speedup GetRecord queries (#7099) [pallet-revive] Bump asset-hub westend spec version (#7176) Remove 0 as a special case in gas/storage meters (#6890) [pallet-revive] Fix `caller_is_root` return value (#7086) req-resp/litep2p: Reject inbound requests from banned peers (#7158) Add "run to block" tools (#7109) Fix reversed error message in DispatchInfo (#7170) approval-voting: Make importing of duplicate assignment idempotent (#6971) Parachains: Use relay chain slot for velocity measurement (#6825) PRDOC: Document `validate: false` (#7117) xcm: convert properly assets in xcmpayment apis (#7134) CI: Only format umbrella crate during umbrella check (#7139) approval-voting: Fix sending of assignments after restart (#6973) Retry approval on availability failure if the check is still needed (#6807) [pallet-revive-eth-rpc] persist eth transaction hash (#6836) litep2p: Sufix litep2p to the identify agent version for visibility (#7133) ...

Introduce `frame_system::Pallet::run_to_block`, `frame_system::Pallet::run_to_block_with`, and `frame_system::RunToBlockHooks` to establish a generic `run_to_block` mechanism for mock tests, minimizing redundant implementations across various pallets. Closes paritytech#299. --- Polkadot address: 156HGo9setPcU2qhFMVWLkcmtCEGySLwNqa3DaEiYSWtte4Y --------- Signed-off-by: Xavier Lau <x@acg.box> Co-authored-by: Bastian Köcher <git@kchr.de> Co-authored-by: command-bot <> Co-authored-by: Guillaume Thiolliere <guillaume.thiolliere@parity.io> Co-authored-by: Guillaume Thiolliere <gui.thiolliere@gmail.com>

aurexav requested review from a team and cheme as code owners January 10, 2025 08:24

Add RunToBlockHooks

bc44314

Signed-off-by: Xavier Lau <x@acg.box>

aurexav force-pushed the master branch from c9ec467 to bc44314 Compare January 10, 2025 08:29

aurexav changed the title ~~Add RunToBlockHooks~~ Add "run to block" tools Jan 10, 2025

Merge branch 'master' into master

505e453

bkchr reviewed Jan 10, 2025

View reviewed changes

bkchr added the T1-FRAME This PR/Issue is related to core FRAME, the framework. label Jan 10, 2025

Fixes

2359bcc

paritytech-review-bot bot requested a review from a team January 10, 2025 17:23

Improve logic

4bc3223

aurexav requested a review from bkchr January 11, 2025 01:17

Apply suggestions from code review

b0f23c5

bkchr approved these changes Jan 11, 2025

View reviewed changes

Avoiding maintain different run_to_block

464d53e

bkchr requested review from ggwpez and gui1117 January 11, 2025 07:57

gui1117 approved these changes Jan 15, 2025

View reviewed changes

Update from gui1117 running command 'prdoc --audience runtime_dev --b…

96935ea

…ump patch'

gui1117 reviewed Jan 15, 2025

View reviewed changes

prdoc/pr_7109.prdoc Outdated Show resolved Hide resolved

Update prdoc/pr_7109.prdoc

aac0aaf

gui1117 enabled auto-merge January 15, 2025 10:00

Merge branch 'master' into master

67ce182

gui1117 added this pull request to the merge queue Jan 15, 2025

Merged via the queue into paritytech:master with commit b72e76f Jan 15, 2025

ggwpez mentioned this pull request Jun 4, 2025

Bump to stable2503 polkadot-fellows/runtimes#711

Merged

7 tasks

github-actions bot mentioned this pull request Jun 10, 2025

Update polkadot-sdk from stable2412 to stable2503 moondance-labs/tanssi#1087

Closed

This was referenced Jul 16, 2025

Update polkadot-sdk from stable2412 to stable2503 moonbeam-foundation/moonbeam#3362

Closed

Update polkadot-sdk from stable2412 to stable2503-7 moonbeam-foundation/moonbeam#3363

Closed

pgherveou added this to [preview] release tracker Mar 20, 2026

github-project-automation bot moved this to Todo in [preview] release tracker Mar 20, 2026

github-project-automation bot moved this from Todo to Done in [preview] release tracker Mar 20, 2026

pgherveou removed this from [preview] release tracker Mar 20, 2026

pgherveou added this to [preview] release tracker Mar 23, 2026

github-project-automation bot moved this to Todo in [preview] release tracker Mar 23, 2026

github-project-automation bot moved this from Todo to Done in [preview] release tracker Mar 23, 2026

		// having `timestamp::on_initialize` called before `staking::on_initialize`. Also, if
		// session length is 1, then it is already triggered.

Conversation

aurexav commented Jan 10, 2025

Uh oh!

bkchr left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aurexav Jan 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bkchr commented Jan 11, 2025

Uh oh!

substrate-tip-bot bot commented Jan 11, 2025

Uh oh!

gui1117 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gui1117 commented Jan 15, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

aurexav Jan 11, 2025 •

edited

Loading

gui1117 left a comment •

edited

Loading