[tracking] Migrate pallets to umbrella crate

[re-gius]

Migrate all pallets to polkadot-sdk-frame by adding types and preludes to it when necessary. As a reference, you can look into #5995.

The guidelines of the umbrella crate are as follows:

polkadot-sdk/substrate/frame/src/lib.rs

Lines 134 to 150 in 06a68be

	//! ## Maintenance Note
	//!
	//! > Notes for the maintainers of this crate, describing how the re-exports and preludes should
	//! > work.
	//!
	//! * Preludes should be extensive. The goal of this pallet is to be ONLY used with the preludes.
	//! The domain-specific modules are just a backup, aiming to keep things organized. Don't hesitate
	//! in adding more items to the main prelude.
	//! * The only non-module, non-prelude items exported from the top level crate is the `pallet`
	//! macro, such that we can have the `#[frame::pallet] mod pallet { .. }` syntax working.
	//! * In most cases, you might want to create a domain-specific module, but also add it to the
	//! preludes, such as `hashing`.
	//! * The only items that should NOT be in preludes are those that have been placed in
	//! `frame-support`/`sp-runtime`, but in truth are related to just one pallet.
	//! * The currency related traits are kept out of the preludes to encourage a deliberate choice of
	//! one over the other.
	//! * `runtime::apis` should expose all common runtime APIs that all FRAME-based runtimes need.

✅ Checklist:

• Add polkadot-sdk-frame to the Cargo.toml
• Remove all imports from frame_support, sp_runtime and similar, and replace with the appropriate prelude::*
• For items that are now not in scope, use the above guideline to decide if you should add them to prelude, or reside to using deps
• Update Cargo.toml to remove all unneeded dependencies.

👉 If you want to work on this: Please check that there is not already a merge request for the pallet that you want to work on (here or in the comments below). Please pick only one or a small set of pallets - not all at once. This keeps review times low. Add a comment below to announce the pallets you're working on.

Pallet list

• pallet-alliance Migrate pallet-alliance to umbrella crate #6541
• pallet-asset-conversion
• pallet-asset-rate
• pallet-assets
• pallet-assets-freezer Migrate pallet-assets-freezer to umbrella crate #6599
• pallet-atomic-swap Migrate pallet-atomic-swap to umbrella crate #6601
• pallet-aura Migrate pallet-aura to umbrella crate #6622
• pallet-authority-discovery Migrate pallet-authority-discovery to umbrella crate  #6619
• pallet-authorship Migrate pallet-authorship to umbrella crate #6620
• pallet-babe Use frame umbrella crate in pallet-babe & pallet-staking-reward-curve #6412
• pallet-bags-list
• pallet-balances
• pallet-beefy
• pallet-beefy-mmr
• pallet-benchmarking
• pallet-bounties
• pallet-broker
• pallet-child-bounties
• pallet-collective
• pallet-contracts with sub-pallets
• pallet-conviction-voting
• pallet-core-fellowship
• pallet-delegated-staking
• pallet-democracy
• pallet-election-provider-multi-phase with sub-pallets
• pallet-election-provider-support with sub-pallets
• pallet-elections-phragmen
• pallet-examples with sub-pallets
• pallet-executive
• pallet-fast-unstake
• pallet-glutton
• pallet-grandpa
• pallet-identity
• pallet-im-online Migrate pallet-im-online to umbrella crate #6736
• pallet-indices Migrate pallet-indices to umbrella crate #6737
• pallet-insecure-randomness-collective-flip Migrate pallet-insecure-randomness-collective-flip to umbrella crate #6738
• pallet-lottery
• pallet-membership
• pallet-merkle-mountain-range
• pallet-message-queue
• pallet-metadata-hash-extensions
• pallet-migrations
• pallet-mixnet
• pallet-multisig Use frame umbrella crate in pallet-proxy and pallet-multisig #5995
• pallet-nft-fractionalization
• pallet-nfts + pallet-nfts-runtime-api
• pallet-nis Migrate pallet-nis benchmark to v2 #6293
• pallet-node-authorization
• pallet-nomination-pools and sub-pallets
• pallet-offences
• pallet-paged-list Migrate pallet-paged-list to umbrella crate #6931
• pallet-paged-list-fuzzer Migrate pallet-paged-list-fuzzer to umbrella crate #6930
• pallet-parameters
• pallet-preimage
• pallet-proxy Use frame umbrella crate in pallet-proxy and pallet-multisig #5995
• pallet-ranked-collective
• pallet-recovery Migrate pallet-recovery to umbrella crate #6894
• pallet-referenda
• pallet-remark
• pallet-revive and sub-pallets
• pallet-root-offences
• pallet-root-testing
• pallet-safe-mode
• pallet-salary
• pallet-sassafras
• pallet-scheduler
• pallet-scored-pool
• pallet-session
• pallet-society
• pallet-staking
• pallet-staking-reward-curve Use frame umbrella crate in pallet-babe & pallet-staking-reward-curve #6412
• pallet-staking-reward-fn
• pallet-staking-runtime-api
• pallet-state-trie-migration
• pallet-statement
• pallet-sudo
• pallet-timestamp Migrate pallet-timestamp to umbrella crate #6523
• pallet-tips Migrate pallet-tips to umbrella crate #6532
• pallet-transaction-payment
• pallet-transaction-storage
• pallet-treasury
• pallet-tx-pause Migrate pallet-tx-pause to umbrella crate #6630
• pallet-uniques
• pallet-utility
• pallet-verify-signature Migrate pallet-verify-signature to umbrella crate #6515
• pallet-vesting
• pallet-whitelist Migrate pallet-whitelist to umbrella crate #6514

[bennethxyz]

Can I pick this up @re-gius

Thinking this should be a tracking issue as it involves more than one crate but happy to do it!

[re-gius]

Can I pick this up @re-gius

Thinking this should be a tracking issue as it involves more than one crate but happy to do it!

Yes, it's going to be a tracking issue. You are more than welcome to start working at some pallets/crates, ideally one or two per PR.

[Krayt78]

Are there still some pallets to work on or are you doing all of them?

[AurevoirXavier]

Why do we have to import codec, scale-info & log every-time even when it is in the umbrella crate?

Because they hardcoded some of those things in the frame-support's macros. Suggest changing those marcos usage to frame::codec instead of ::crate::codec/crate::codec.

[FasmaHouse]

Thanks for the quick response @AurevoirXavier

Suggest changing those marcos usage to frame::codec instead of ::crate::codec/crate::codec.

Should we not all do this then?

[AurevoirXavier]

Should we not all do this then?

I'm happy to see that.

cc @kianenigma

[FasmaHouse]

Maybe at the final stages, when all crates are ported then one PR can help correct all the other crates?

[AurevoirXavier]

Maybe at the final stages, when all crates are ported then one PR can help correct all the other crates?

Yes.

[Krayt78]

taking pallet scheduler

[Krayt78]

Why do we have to import codec, scale-info & log every-time even when it is in the umbrella crate?

Because they hardcoded some of those things in the frame-support's macros. Suggest changing those marcos usage to frame::codec instead of ::crate::codec/crate::codec.

oh yeah i am having the same issue with the defensive! macro in frame support, i have no idea how to fix that without rewritting the macro to not use frame support

[re-gius]

Thanks for al your work on this PR. I should get a few reviews done by this week, and then pick up new PRs in January.

I'll ask other engineers from Parity to help, but also notice that the end of December is usually an inactivity period for low-priority tasks like this.

One important thing I want to mention is: read the guidelines. Don't be scared to add imports to the umbrella crate preludes, as longs as they are used across multiple pallets. If something like:

import A1;
import A2;
...
import A10;

becomes

import frame::{A1, A2, ..., A10);

then you're probably doing it wrong. The ultimate goal is to only have something like import frame::prelude::* and, even when that is not possible, imports should be significantly leaner than before.

[Krayt78]

Taking pallet-paged-list and pallet-paged-list-fuzzer since they go together

[UtkarshBhardwaj007]

Hi, I'd like to work on this. I will pickup pallet-mixnet to start with.

[seemantaggarwal]

Hi, I'd like to work on this. I will pickup pallet-child-bounties to start with.

[AurevoirXavier]

Pick pallet-salary.

[FasmaHouse]

taking pallet-exampl-task & pallet-example-offchain-worker

[tobi-michael]

taking pallet-executive

[Aenyi]

taking pallet-fast-unstake & pallet-glutton

[Nathy-bajo]

taking pallet-sudo & pallet-statement

[tifecool]

taking pallet-paraameter & pallet-preimage