Migrate pallet-grandpa to use the FRAME umbrella crate #8264

Wolfenheimm · 2025-04-16T17:16:47Z

Description

This PR migrates pallet-grandpa to use the polkadot-sdk-frame (FRAME umbrella crate), as tracked in #6504. All direct imports from frame_support, sp_runtime, and similar crates have been replaced with imports from the umbrella crate, using the appropriate prelude or domain-specific modules. Where necessary, missing items have been re-exported from the umbrella crate to ensure all functionality is available exclusively via frame.

Resolves pallet-grandpa in issue #6504

Integration

Downstream projects should now import all FRAME types, traits, and macros for pallet-grandpa via the frame crate and its preludes.
No direct imports from frame_support, sp_runtime, or other underlying crates should remain in the pallet.

Example usage:

- use frame_support::{assert_ok, traits::OnFinalize};
+ use frame::{assert_ok, traits::OnFinalize};

Review Notes

All imports in pallet-grandpa now use frame (umbrella crate) and its preludes.
Any missing types, traits, or macros required by pallet-grandpa have been added to the appropriate prelude or re-exported in frame.
All tests and benchmarks have been updated to use only the frame crate for imports.
No logic changes are introduced—only import and re-export adjustments for the migration.

Checklist

My PR includes a detailed description as outlined in the "Description" and its two subsections above.
My PR follows the labeling requirements of this project (at minimum one label for T required).
I have made corresponding changes to the documentation (if applicable).
I have added tests that prove my fix is effective or that my feature works (if applicable).

Thank you for your review!

…te. Begin modifying files...

…There is still a strange issue when running tests with runtime-benchmarks regarding a UNIX timestamp

Wolfenheimm · 2025-04-16T17:24:27Z

@re-gius Good day! I've decided to write this PR for pallet-grandpa, I'm available for any required changes.

One issue I noticed from my PR is that I cannot run tests without adding the runtime-benchmarks feature, if this is ok then it's as intended.

Looking forward to the review!

…s in mock

substrate/frame/grandpa/Cargo.toml

substrate/frame/grandpa/src/migrations/v5.rs

substrate/frame/src/lib.rs

Co-authored-by: Bastian Köcher <[email protected]>

…rame lib triage. Revert benchmarks to original and fix imports...

substrate/frame/grandpa/src/migrations/v5.rs

re-gius

Please:

merge the changes from master branch
run taplo format --config .config/taplo.toml to fix any toml formatting issues

substrate/frame/grandpa/src/migrations/v5.rs

substrate/frame/grandpa/src/benchmarking.rs

…lla-crate-grandpa

…om/Wolfenheimm/polkadot-sdk into wolfenheimm-umbrella-crate-grandpa

github-actions · 2025-04-23T07:37:10Z

Review required! Latest push from author must always be reviewed

substrate/frame/grandpa/src/benchmarking.rs

Co-authored-by: Giuseppe Re <[email protected]>

Wolfenheimm · 2025-05-03T09:49:54Z

@re-gius, apologies for the previous issues and thank you for pointing them out - I'm seeing quite a few errors here in the workflow - is there anything else I should focus on?

i.e. "You can just apply the patch (git apply PATCH_NAME) that was printed to make this CI check succeed." in check-umbrella. Not quite sure how to approach that one.

re-gius

Hope that my comments are enough to solve most of the issues

re-gius · 2025-05-06T10:50:43Z

substrate/frame/support/src/lib.rs

@@ -122,6 +122,12 @@ pub use sp_runtime::{
 	self, print, traits::Printable, ConsensusEngineId, MAX_MODULE_ERROR_ENCODED_SIZE,
 };

+pub use self::migrations::VersionedMigration;


Please remove all the changes from this file, you shouldn't touch it. It's better to change only the frame umbrella crate.

re-gius · 2025-05-06T10:51:45Z

substrate/frame/grandpa/Cargo.toml

 	"pallet-timestamp/std",
 	"scale-info/std",
 	"sp-application-crypto/std",
 	"sp-consensus-grandpa/std",
-	"sp-core/std",
-	"sp-io/std",
-	"sp-runtime/std",
 	"sp-session/std",
 	"sp-staking/std",


Add "sp-weights/std" here

re-gius · 2025-05-06T10:53:53Z

substrate/frame/src/lib.rs

-			VariantCount, VariantCountOf,
+			Contains, Currency, Defensive, DefensiveSaturating, EitherOf,
+			EstimateNextSessionRotation, Everything, InsideBoth, InstanceFilter, IsSubType,
+			KeyOwnerProofSystem, MapSuccess, NoOpPoll, OnFinalize, OnRuntimeUpgrade,


OnFinalize here creates ambiguous imports in pallet staking-async, so it's better to avoid it

Wolfenheimm added 6 commits April 15, 2025 17:09

Strip the Cargo.toml of umbrella items and add the frame umbrella cra…

d8c85d7

…te. Begin modifying files...

Fix lib.rs imports

10f7141

Fix tests, Issue remains with the reward curve macro in mock

03f4497

Fix equivocation

979300d

Fix default_weights, Began benchmarking

527db9c

Move the remaining mod/structs into the frame crate, fix benchmarks, …

05bae2a

…There is still a strange issue when running tests with runtime-benchmarks regarding a UNIX timestamp

Wolfenheimm requested a review from a team as a code owner April 16, 2025 17:16

Wolfenheimm marked this pull request as draft April 16, 2025 17:17

Add prdoc

3961a18

Wolfenheimm added 2 commits April 16, 2025 13:40

Merge branch 'master' into wolfenheimm-umbrella-crate-grandpa

1dfb76e

Fix cargo dependency double-up after merge mistake, fix proper import…

b75a5b5

…s in mock

Wolfenheimm marked this pull request as ready for review April 16, 2025 18:19

Wolfenheimm added 2 commits April 16, 2025 14:41

Remove unused import

a34f437

Merge branch 'master' into wolfenheimm-umbrella-crate-grandpa

1bcbc02

bkchr reviewed Apr 17, 2025

View reviewed changes

substrate/frame/grandpa/Cargo.toml Outdated Show resolved Hide resolved

substrate/frame/grandpa/src/migrations/v5.rs Outdated Show resolved Hide resolved

substrate/frame/src/lib.rs Outdated Show resolved Hide resolved

Wolfenheimm and others added 12 commits April 18, 2025 13:31

Merge branch 'master' into wolfenheimm-umbrella-crate-grandpa

2b8651d

Remove experimental feature from grandpa's cargo

c70fce3

Co-authored-by: Bastian Köcher <[email protected]>

Cleanup unneeded comment block from old imports

675cfce

Co-authored-by: Bastian Köcher <[email protected]>

Begin cleaning lib, fix import positions in v4/v5

6a3a352

Merge from master and fix imports in frame lib.rs

98aec30

Fix OnFinalize/OnInitialize trait disambiguation in mock.rs

099d16a

Cleanup on isle grandpa - fix remaining imports due to cleanup from f…

f4865ae

…rame lib triage. Revert benchmarks to original and fix imports...

Remove experimental feature from cargo

c65e255

Place frame-benchmarking back to OG (tested optional flag)

9cebf2b

Fix import in v4

65636c5

Removed unnecessary sp_weights import (exsists in frame)

866b54b

Fix sp_io import

e08141e

Wolfenheimm mentioned this pull request Apr 18, 2025

[tracking] Migrate pallets to FRAME umbrella crate #6504

Closed

48 tasks

Move location of imports...

6a079bb

bkchr approved these changes Apr 22, 2025

View reviewed changes

substrate/frame/grandpa/src/migrations/v5.rs Outdated Show resolved Hide resolved

bkchr requested a review from re-gius April 22, 2025 09:28

Update substrate/frame/grandpa/src/migrations/v5.rs

4a69b1b

re-gius added the T2-pallets This PR/Issue is related to a particular pallet. label Apr 22, 2025

re-gius reviewed Apr 22, 2025

View reviewed changes

substrate/frame/grandpa/src/migrations/v5.rs Outdated Show resolved Hide resolved

substrate/frame/grandpa/src/benchmarking.rs Show resolved Hide resolved

Wolfenheimm added 2 commits April 23, 2025 03:36

Merge remote-tracking branch 'upstream/master' into wolfenheimm-umbre…

f64ece7

…lla-crate-grandpa

Merge branch 'wolfenheimm-umbrella-crate-grandpa' of https://github.c…

2a87372

…om/Wolfenheimm/polkadot-sdk into wolfenheimm-umbrella-crate-grandpa

github-actions bot requested a review from bkchr April 23, 2025 07:37

Wolfenheimm added 8 commits April 23, 2025 03:40

Fix mock.rs due to changes

2e9f6fb

Fix via taplo

531103f

Remove unused import

353a705

Add runtime benchmarks feature macro

cb3a63a

Runtime-benchmarks import

10ceb27

Add try runtime macro for sp_runtime import in v5

57f9c53

Merge branch 'master' into wolfenheimm-umbrella-crate-grandpa

d17f5ea

Merge branch 'master' into wolfenheimm-umbrella-crate-grandpa

cf4476e

re-gius reviewed Apr 24, 2025

View reviewed changes

substrate/frame/grandpa/src/benchmarking.rs Outdated Show resolved Hide resolved

Wolfenheimm and others added 7 commits April 24, 2025 12:28

Update substrate/frame/grandpa/src/benchmarking.rs

a6ba4aa

Co-authored-by: Giuseppe Re <[email protected]>

Merge branch 'master' into wolfenheimm-umbrella-crate-grandpa

475809a

Merge branch 'master' into wolfenheimm-umbrella-crate-grandpa

0832844

Fix prdoc

c07c867

Merge branch 'master' into wolfenheimm-umbrella-crate-grandpa

312c3f8

revert cargo change

267c0ce

Yet another cargo fix...

e33357f

Wolfenheimm added 2 commits May 3, 2025 05:50

Merge branch 'master' into wolfenheimm-umbrella-crate-grandpa

c9490e0

Merge branch 'master' into wolfenheimm-umbrella-crate-grandpa

fd2e7e9

re-gius reviewed May 6, 2025

View reviewed changes

Wolfenheimm closed this May 30, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Migrate pallet-grandpa to use the FRAME umbrella crate #8264

Migrate pallet-grandpa to use the FRAME umbrella crate #8264

Uh oh!

Wolfenheimm commented Apr 16, 2025 •

edited

Loading

Uh oh!

Wolfenheimm commented Apr 16, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

re-gius left a comment

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Apr 23, 2025

Uh oh!

Uh oh!

Wolfenheimm commented May 3, 2025 •

edited

Loading

Uh oh!

re-gius left a comment

Uh oh!

re-gius May 6, 2025

Uh oh!

re-gius May 6, 2025

Uh oh!

re-gius May 6, 2025

Uh oh!

Uh oh!

Migrate pallet-grandpa to use the FRAME umbrella crate #8264

Migrate pallet-grandpa to use the FRAME umbrella crate #8264

Uh oh!

Conversation

Wolfenheimm commented Apr 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Integration

Review Notes

Checklist

Uh oh!

Wolfenheimm commented Apr 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

re-gius left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Apr 23, 2025

Uh oh!

Uh oh!

Wolfenheimm commented May 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

re-gius left a comment

Choose a reason for hiding this comment

Uh oh!

re-gius May 6, 2025

Choose a reason for hiding this comment

Uh oh!

re-gius May 6, 2025

Choose a reason for hiding this comment

Uh oh!

re-gius May 6, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Wolfenheimm commented Apr 16, 2025 •

edited

Loading

Wolfenheimm commented Apr 16, 2025 •

edited

Loading

Wolfenheimm commented May 3, 2025 •

edited

Loading