Use the umbrella crate for the parachain template #5991

serban300 · 2024-10-09T11:04:09Z

Use the umbrella crate for the parachain template

This covers almost all the dependencies. There are just a few exceptions for which I created a separate issue: #5993

Also related to: #4782

kianenigma

You can decide to do this in a separate PR, but part of the issue requirement is also to move the runtime+pallet to polkadot-sdk-frame umbrella crate.

You can see the minimal template for how this works.

You might need to add more items to the preludes in polkadot-sdk-frame for this. See #4782

serban300 · 2024-10-09T12:14:36Z

You can decide to do this in a separate PR, but part of the issue requirement is also to move the runtime+pallet to polkadot-sdk-frame umbrella crate.

You can see the minimal template for how this works.

You might need to add more items to the preludes in polkadot-sdk-frame for this. See #4782

@kianenigma I migrated also the runtime + pallet, but I had to keep a few of the old crates because of some limitations. I will create a follow-up issue for this.

This PR is ready for review. PTAL !

kianenigma · 2024-10-09T14:41:48Z

@kianenigma I migrated also the runtime + pallet, but I had to keep a few of the old crates because of some limitations. I will create a follow-up issue for this.

But you have not migrated them to polkadot-sdk-frame, have you? you have migrated them to polkadot-sdk, they are different :)

In fact, I see now that even in the original PR for the minimal template, we have not fully moved the runtime to the polkadot-sdk-frame.

In short, I think for our templates, we should build the pallet+runtime ONLY with polkadot-sdk-frame.

Pinging a few heads to agree with this: @ggwpez @franciscoaguirre @muharem @shawntabrizi and if agreed, I suggest not further deferring this goal.

I am fixing a lot of the little shortcomings in polkadot-sdk-frame #5995. But, we should also ack that we can never nail frame umbrella crate until we start using it. I suggest we proceed with making it the sole dependency of all 3 template runtime, and in the process we will learn all the little items that are left to do.

serban300 · 2024-10-09T14:46:38Z

@kianenigma I migrated also the runtime + pallet, but I had to keep a few of the old crates because of some limitations. I will create a follow-up issue for this.

But you have not migrated them to polkadot-sdk-frame, have you? you have migrated them to polkadot-sdk, they are different :)

In fact, I see now that even in the original PR for the minimal template, we have not fully moved the runtime to the polkadot-sdk-frame.

In short, I think for our templates, we should build the pallet+runtime ONLY with polkadot-sdk-frame.

Pinging a few heads to agree with this: @ggwpez @franciscoaguirre @muharem @shawntabrizi and if agreed, I suggest not further deferring this goal.

I am fixing a lot of the little shortcomings in polkadot-sdk-frame #5995. But, we should also ack that we can never nail frame umbrella crate until we start using it. I suggest we proceed with making it the sole dependency of all 3 template runtime, and in the process we will learn all the little items that are left to do.

Oh sorry, I didn't know that. I thought I had to use polkadot-sdk everywhere.

But what's the difference ? Isn't it another way of referring to the same crates in the end ?

kianenigma · 2024-10-09T15:16:29Z

Oh sorry, I didn't know that. I thought I had to use polkadot-sdk everywhere.

But what's the difference ? Isn't it another way of referring to the same crates in the end ?

Similar, but the polkadot-sdk-frame is both a re-export of common crates (similar to polkadot-sdk), and it provides various preludes that clean up a lot of the need for various dependencies to be declared from different places.

Please see this commit d253bc5 and the docs for polkadot-sdk-frame in the PR I linked above.

kianenigma · 2024-10-09T15:30:05Z

We can still merge this PR as is, happy to take a step back and not be a blocker as it is a clear improvement :)

But my overall intention here is to standardize:

with this PR and #5995:

All pallets in our repo should be moved to use frame
All pallets in our templates should be built solely with frame
All template runtimes should also aim to be used only with frame+frame::runtime.
In all cases so far:

option 1: we import frame as polkadot_sdk::polkadot_sdk_frame
option 2: we import it standalone as frame only

All node side template code should be moved to use polkadot-sdk umbrella crate.

As for the decision tree above, I am personally in favor of using it just as frame, with a clear guideline/doc that says "if you need more crates, please import polkadot-sdk". This is because if polkadot-sdk is in scope, I think people still tend to fallback to use polkadot_sdk::sp_something::deep::path::Type versus adding it to frame::prelude::/frame::runtime::prelude which is already in scope. But both are acceptable IMO.

I would like to make a decision about the "umbrella crate strategy", and present it in Sub0, so please chime in, and be contrarion if you want to :)

templates/parachain/node/src/chain_spec.rs

templates/parachain/pallets/template/src/lib.rs

templates/parachain/pallets/template/src/mock.rs

ggwpez · 2024-10-09T15:41:25Z

In all cases so far:
option 1: we import frame as polkadot_sdk::polkadot_sdk_frame
option 2: we import it standalone as frame only

I think there is not much difference, as long as people are using the frame crate at all (no matter where they import it from).
The import location can be changed with one line, so the difficult part is to use it in the beginning i think.

serban300 · 2024-10-11T07:24:18Z

@kianenigma @ggwpez

Implemented the suggestions. For the pallet I used only the frame dependency. Indeed it simplified things significantly. For the runtime we needed the polkadot-sdk dependency anyway, so I used only that. But imported polkadot_sdk::* as you suggested. PTAL !

templates/parachain/pallets/template/src/lib.rs

bkchr · 2024-10-14T07:12:02Z

templates/parachain/node/Cargo.toml

@@ -22,82 +19,31 @@ jsonrpsee = { features = ["server"], workspace = true }
 futures = { workspace = true }
 serde_json = { workspace = true, default-features = true }
 docify = { workspace = true }
+color-print = { workspace = true }
+
+polkadot-sdk = { workspace = true, features = ["experimental", "node"] }


Why are we enabling a experimental feature in our templates? There is something fishy again..

I would soon remove this flag from the frame umbrella crate, rest assured.

Looks like it wasn't needed. Removed it.

bkchr · 2024-10-14T07:12:16Z

substrate/frame/support/src/lib.rs

@@ -915,7 +915,7 @@ pub mod pallet_prelude {
 	pub use scale_info::TypeInfo;
 	pub use sp_inherents::MakeFatalError;
 	pub use sp_runtime::{
-		traits::{MaybeSerializeDeserialize, Member, ValidateUnsigned},
+		traits::{CheckedAdd, MaybeSerializeDeserialize, Member, One, ValidateUnsigned},


What about all the other Checked* traits and Zero?

Added them.

serban300 added the T17-Templates This PR/Issue is related to templates label Oct 9, 2024

serban300 self-assigned this Oct 9, 2024

serban300 added 2 commits October 9, 2024 14:04

pallet-parachain-template

5113d31

parachain-template-runtime

9800173

serban300 force-pushed the parachain-template-umbrella branch from 62d9103 to 1123cd1 Compare October 9, 2024 11:04

serban300 added the R0-silent Changes should not be mentioned in any release notes label Oct 9, 2024

parachain-template-node

58869d0

serban300 force-pushed the parachain-template-umbrella branch from 1123cd1 to 58869d0 Compare October 9, 2024 11:15

kianenigma reviewed Oct 9, 2024

View reviewed changes

serban300 marked this pull request as ready for review October 9, 2024 12:13

serban300 mentioned this pull request Oct 9, 2024

Follow up for: Use the umbrella crate for the parachain template #5993

Open

4 tasks

serban300 requested review from franciscoaguirre and ggwpez October 9, 2024 12:26

serban300 changed the title ~~[Draft] Use the umbrella crate for the parachain template~~ Use the umbrella crate for the parachain template Oct 9, 2024

kianenigma reviewed Oct 9, 2024

View reviewed changes

templates/parachain/node/src/chain_spec.rs Outdated Show resolved Hide resolved

kianenigma reviewed Oct 9, 2024

View reviewed changes

templates/parachain/pallets/template/src/lib.rs Outdated Show resolved Hide resolved

kianenigma reviewed Oct 9, 2024

View reviewed changes

templates/parachain/pallets/template/src/mock.rs Outdated Show resolved Hide resolved

serban300 added 2 commits October 11, 2024 10:18

Address CR comments

3a68ee8

Merge branch 'master' into parachain-template-umbrella

042b6df

serban300 added 2 commits October 11, 2024 10:41

Fix

d0d0968

Fix warning

551c072

acatangiu approved these changes Oct 11, 2024

View reviewed changes

kianenigma reviewed Oct 11, 2024

View reviewed changes

templates/parachain/pallets/template/src/lib.rs Outdated Show resolved Hide resolved

kianenigma approved these changes Oct 11, 2024

View reviewed changes

Add traits to pallet_prelude

abb88a6

serban300 requested a review from a team as a code owner October 11, 2024 18:52

Merge branch 'master' into parachain-template-umbrella

765345b

serban300 enabled auto-merge October 11, 2024 19:05

bkchr reviewed Oct 14, 2024

View reviewed changes

Address review comments

0de030a

paritytech-review-bot bot requested a review from a team October 14, 2024 09:58

serban300 added 4 commits October 14, 2024 14:03

fix

a2817e4

fix

769a54d

fix

5471129

Remove unneeded feature

79e1e47

bkchr approved these changes Oct 14, 2024

View reviewed changes

serban300 added this pull request to the merge queue Oct 14, 2024

Merged via the queue into paritytech:master with commit d7f01a1 Oct 14, 2024
199 of 204 checks passed

serban300 deleted the parachain-template-umbrella branch October 14, 2024 16:01

franciscoaguirre mentioned this pull request Oct 23, 2024

Use umbrella crate for parachain template #5759

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use the umbrella crate for the parachain template #5991

Use the umbrella crate for the parachain template #5991

serban300 commented Oct 9, 2024 •

edited

Loading

kianenigma left a comment

serban300 commented Oct 9, 2024 •

edited

Loading

kianenigma commented Oct 9, 2024

serban300 commented Oct 9, 2024

kianenigma commented Oct 9, 2024

kianenigma commented Oct 9, 2024 •

edited

Loading

ggwpez commented Oct 9, 2024

serban300 commented Oct 11, 2024

bkchr Oct 14, 2024

kianenigma Oct 14, 2024

serban300 Oct 14, 2024

bkchr Oct 14, 2024

serban300 Oct 14, 2024

Use the umbrella crate for the parachain template #5991

Use the umbrella crate for the parachain template #5991

Conversation

serban300 commented Oct 9, 2024 • edited Loading

kianenigma left a comment

Choose a reason for hiding this comment

serban300 commented Oct 9, 2024 • edited Loading

kianenigma commented Oct 9, 2024

serban300 commented Oct 9, 2024

kianenigma commented Oct 9, 2024

kianenigma commented Oct 9, 2024 • edited Loading

ggwpez commented Oct 9, 2024

serban300 commented Oct 11, 2024

bkchr Oct 14, 2024

Choose a reason for hiding this comment

kianenigma Oct 14, 2024

Choose a reason for hiding this comment

serban300 Oct 14, 2024

Choose a reason for hiding this comment

bkchr Oct 14, 2024

Choose a reason for hiding this comment

serban300 Oct 14, 2024

Choose a reason for hiding this comment

serban300 commented Oct 9, 2024 •

edited

Loading

serban300 commented Oct 9, 2024 •

edited

Loading

kianenigma commented Oct 9, 2024 •

edited

Loading