Make polkadot-sdk templates OMNI and GREAT again -- part 2
#5242
Labels
C1-mentor
A task where a mentor is available. Please indicate in the issue who the mentor could be.
C2-good-first-issue
A task for a first time contributor to become familiar with the Polkadot-SDK.
I6-meta
A specific issue for grouping tasks or bugs of a specific category.
Comments
kianenigma
added
I6-meta
|
Just for a record: here is a comment with some pending-follow-ups improvements that can be done in the context of Provide GenesisConfig presets task: |
kianenigma
added
C1-mentor
github-merge-queue bot
pushed a commit
that referenced
this issue
Sep 23, 2024
# Description * This is part of [issue 5242](#5242), specifically getting solochain to use `#[frame::runtime]` * Furthermore, reinforced the convention of `Template` instead of `TemplateModule` ## Integration * Should be integrated into the `solochain` template and documentation ## Review Notes * Refactored `solochain` template from [construct_runtime!](https://paritytech.github.io/polkadot-sdk/master/frame_support/macro.construct_runtime.html) to [#[runtime]](https://paritytech.github.io/polkadot-sdk/master/frame_support/attr.runtime.html). * AFAIU `Template` is our new convention, and preferred over `TemplateModule`. # Out of scope * The [#[runtime]](https://paritytech.github.io/polkadot-sdk/master/frame_support/attr.runtime.html) documentation is still very rudimentary, and should ideally be expanded to explain the macro, both what it does and the input options. * Furthermore, suggest update [#[runtime]](https://paritytech.github.io/polkadot-sdk/master/frame_support/attr.runtime.html) documentation to replace `#[crate::runtime]` with `#[frame_support::runtime]` --------- Co-authored-by: Jan-Jan <[email protected]> Co-authored-by: Oliver Tale-Yazdi <[email protected]> Co-authored-by: Shawn Tabrizi <[email protected]> Co-authored-by: command-bot <>
|
2 tasks
|
Doesnt #5991 check the umbrela/Frame for the parachain part? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Note
The follow-up to #3155, and a huge shoutout to @rzadp so far for his help.
Now we have a new system that syncs our 3 templates into 3 repos, every few weeks, all automatic, guaranteed to work.
The purpose of these 3 templates will be to demonstrate all the latest features of polkadot-sdk, and act as un-opinionated starting points. We expect other teams to build more opinionated templates, and feel free to add these to https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/polkadot_sdk/templates/index.html
I have spread the word of what needs to be done to push the template revamp to full completion in the above issue, but the thread has gotten a bit unorganized by now. In this issue, I will re-iterate the action items.
Tip
All of the work mentioned here is, in my opinion, high impact, and relatively simple. This means: great oppurtunity for both Parity and external contributors!
FRAME / Umbrella Related
Integrate latest features of FRAME and umbrella crates into templates.
Use
polkadot-sdkandpolkadot-sdk-frameThe entire template should mostly be 3 crates:
polkadot-sdkplus,codecandscale-info. For the case ofpolkadot-sdk-frame, please useprelude::*. If a prelude is missing something, open a PR and add it. If there should be further preludes (e.g.frame::benchmarking_prelude::*?) please add one.I have logged a few important issues about
polkadot-sdk-framethat are not solved yet either, most notably:polkadot-sdk-frameumbrella crate #4782Use
#[frame::runtime]Use
#[derive_impl]Note that this also means in the testing code of the template pallet that lives in each template. For production, there is still an ongoing exploration by @gupnik to see if we can use it or not. See #5111 (comment)
Prepare Templates for OMNI Node future
see: #5568
Provide
GenesisConfigpresets.The runtime should start exposing at least a
developmentgenesis-config, which should be used for testing. Other chain-specs that are currently embedded in the node should also be replicated.GenesisConfigpresets for templates runtimes (minimal and solochain) #5790GenesisConfigpresets for templates runtimes (minimal and solochain) #5790Make
nodecompilation optional - #5940The node doesn't compile by default when you do
cargo build. It should be feature gated behind--features with-node. By default, the template only compiles the runtime and produces a wam. Instead, the user is invited to downloadpolkadot-omni-node/polkadot-parachain.To run this wasm, one is expected to use do either of:
polkadot-omni-node+zombienetchopsticks.yamlList:
Provide
chopsticks.yamlMark templates in
substrate-developer-hubas archived.More ideas? Yes, Sky's the limit!
There is a lot more that can be done to make the
polkadot-sdktemplates look nice. Be creative and proactive! Look to your favorite tools, repos and templates, and see what elements they have that make enjoy using them, and being them over :)The text was updated successfully, but these errors were encountered: