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

Jump to bottom

[tracking] Migrate pallets to umbrella crate #6504

Open
10 of 92 tasks
re-gius opened this issue Nov 15, 2024 · 49 comments
Open
10 of 92 tasks

[tracking] Migrate pallets to umbrella crate #6504

re-gius opened this issue Nov 15, 2024 · 49 comments
Labels
C2-good-first-issue A task for a first time contributor to become familiar with the Polkadot-SDK. D0-easy Can be fixed primarily by duplicating and adapting code by an intermediate coder. I4-refactor Code needs refactoring. R0-silent Changes should not be mentioned in any release notes T1-FRAME This PR/Issue is related to core FRAME, the framework.

Comments

@re-gius
Copy link
Contributor

re-gius commented Nov 15, 2024 •
edited
Loading

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
@re-gius re-gius added R0-silent Changes should not be mentioned in any release notes I4-refactor Code needs refactoring. T1-FRAME This PR/Issue is related to core FRAME, the framework. D0-easy Can be fixed primarily by duplicating and adapting code by an intermediate coder. C2-good-first-issue A task for a first time contributor to become familiar with the Polkadot-SDK. labels Nov 15, 2024
@bennethxyz
Copy link

bennethxyz commented Nov 15, 2024 •
edited
Loading

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
Copy link
Contributor Author

re-gius commented Nov 15, 2024 •
edited
Loading

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.

This was referenced Nov 17, 2024
Draft
Draft
Draft
Open
Open
@re-gius re-gius changed the title Migrate pallets to umbrella crate [tracking] Migrate pallets to umbrella crate Nov 18, 2024
This was referenced Nov 18, 2024
Open
Open
This was referenced Nov 19, 2024
Open
Draft
Draft
Draft
Closed
Merged
Merged
Open
Open
Open
This was referenced Nov 24, 2024
Draft
Draft
Draft
Open
@Krayt78
Copy link
Contributor

Krayt78 commented Nov 27, 2024

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

This was referenced Jan 17, 2025
Open
Open
Open
@re-gius
Copy link
Contributor Author

re-gius commented Jan 17, 2025

#7177 has been merged. Please remove the experimental feature flag for the umbrella crate in your Cargo.toml files.

This was referenced Jan 17, 2025
Open
Open
Open
Open
Open
@bennethxyz
Copy link

please review all open PRs @re-gius, experimental flag removed.

This was referenced Jan 19, 2025
Closed
Open
Open
Open
github-merge-queue bot pushed a commit that referenced this issue Jan 20, 2025
@yrong
Migrate pallet-mmr to umbrella crate (#7081)
569ce71 
Part of #6504
github-merge-queue bot pushed a commit that referenced this issue Jan 20, 2025
@runcomet @re-gius
Migrate pallet-assets-freezer to umbrella crate (#6599)
711e6ff 
Part of #6504

### Added modules

- `utility`: Traits not tied to any direct operation in the runtime.

polkadot address: 14SRqZTC1d8rfxL8W1tBTnfUBPU23ACFVPzp61FyGf4ftUFg

---------

Co-authored-by: Giuseppe Re <[email protected]>
Nathy-bajo pushed a commit to Nathy-bajo/polkadot-sdk that referenced this issue Jan 21, 2025
@yrong @Nathy-bajo
Migrate pallet-mmr to umbrella crate (paritytech#7081)
de52e8a 
Part of paritytech#6504
Nathy-bajo pushed a commit to Nathy-bajo/polkadot-sdk that referenced this issue Jan 21, 2025
@runcomet @re-gius @Nathy-bajo
Migrate pallet-assets-freezer to umbrella crate (paritytech#6599)
3ccdbfe 
Part of paritytech#6504

- `utility`: Traits not tied to any direct operation in the runtime.

polkadot address: 14SRqZTC1d8rfxL8W1tBTnfUBPU23ACFVPzp61FyGf4ftUFg

---------

Co-authored-by: Giuseppe Re <[email protected]>
Nathy-bajo pushed a commit to Nathy-bajo/polkadot-sdk that referenced this issue Jan 21, 2025
@yrong @Nathy-bajo
Migrate pallet-mmr to umbrella crate (paritytech#7081)
7a55595 
Part of paritytech#6504
Nathy-bajo pushed a commit to Nathy-bajo/polkadot-sdk that referenced this issue Jan 21, 2025
@runcomet @re-gius @Nathy-bajo
Migrate pallet-assets-freezer to umbrella crate (paritytech#6599)
87c9f60 
Part of paritytech#6504

- `utility`: Traits not tied to any direct operation in the runtime.

polkadot address: 14SRqZTC1d8rfxL8W1tBTnfUBPU23ACFVPzp61FyGf4ftUFg

---------

Co-authored-by: Giuseppe Re <[email protected]>
github-merge-queue bot pushed a commit that referenced this issue Jan 21, 2025
@Krayt78 @bkchr @re-gius
Migrate pallet-paged-list-fuzzer to umbrella crate (#6930)
9edaef0 
Part of  #6504

---------

Co-authored-by: Bastian Köcher <[email protected]>
Co-authored-by: Giuseppe Re <[email protected]>
mordamax pushed a commit to paritytech-stg/polkadot-sdk that referenced this issue Jan 21, 2025
@yrong @mordamax
Migrate pallet-mmr to umbrella crate (paritytech#7081)
f9badca 
Part of paritytech#6504
mordamax pushed a commit to paritytech-stg/polkadot-sdk that referenced this issue Jan 21, 2025
@runcomet @re-gius @mordamax
Migrate pallet-assets-freezer to umbrella crate (paritytech#6599)
fb1ff1a 
Part of paritytech#6504

### Added modules

- `utility`: Traits not tied to any direct operation in the runtime.

polkadot address: 14SRqZTC1d8rfxL8W1tBTnfUBPU23ACFVPzp61FyGf4ftUFg

---------

Co-authored-by: Giuseppe Re <[email protected]>
mordamax pushed a commit to paritytech-stg/polkadot-sdk that referenced this issue Jan 21, 2025
@Krayt78 @bkchr
@re-gius @mordamax
Migrate pallet-paged-list-fuzzer to umbrella crate (paritytech#6930)
7d7c9b6 
Part of  paritytech#6504

---------

Co-authored-by: Bastian Köcher <[email protected]>
Co-authored-by: Giuseppe Re <[email protected]>
mordamax pushed a commit to paritytech-stg/polkadot-sdk that referenced this issue Jan 22, 2025
@yrong @mordamax
Migrate pallet-mmr to umbrella crate (paritytech#7081)
4d278c2 
Part of paritytech#6504
mordamax pushed a commit to paritytech-stg/polkadot-sdk that referenced this issue Jan 22, 2025
@runcomet @re-gius @mordamax
Migrate pallet-assets-freezer to umbrella crate (paritytech#6599)
9d7e427 
Part of paritytech#6504

### Added modules

- `utility`: Traits not tied to any direct operation in the runtime.

polkadot address: 14SRqZTC1d8rfxL8W1tBTnfUBPU23ACFVPzp61FyGf4ftUFg

---------

Co-authored-by: Giuseppe Re <[email protected]>
mordamax pushed a commit to paritytech-stg/polkadot-sdk that referenced this issue Jan 22, 2025
@Krayt78 @bkchr
@re-gius @mordamax
Migrate pallet-paged-list-fuzzer to umbrella crate (paritytech#6930)
51e38fe 
Part of  paritytech#6504

---------

Co-authored-by: Bastian Köcher <[email protected]>
Co-authored-by: Giuseppe Re <[email protected]>
github-merge-queue bot pushed a commit that referenced this issue Jan 22, 2025
@FereMouSiopi @bkchr
Migrate pallet-insecure-randomness-collective-flip to umbrella crate (
89b0228 
#6738)

Part of #6504

---------

Co-authored-by: command-bot <>
Co-authored-by: Bastian Köcher <[email protected]>
This was referenced Jan 24, 2025
Open
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
C2-good-first-issue A task for a first time contributor to become familiar with the Polkadot-SDK. D0-easy Can be fixed primarily by duplicating and adapting code by an intermediate coder. I4-refactor Code needs refactoring. R0-silent Changes should not be mentioned in any release notes T1-FRAME This PR/Issue is related to core FRAME, the framework.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests