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

Improvements to polkadot-sdk-frame umbrella crate #4782

Open
1 of 3 tasks
Tracked by #5242
kianenigma opened this issue Jun 13, 2024 · 2 comments
Open
1 of 3 tasks
Tracked by #5242

Improvements to polkadot-sdk-frame umbrella crate #4782

kianenigma opened this issue Jun 13, 2024 · 2 comments
Assignees
@gupnik
Labels
T1-FRAME This PR/Issue is related to core FRAME, the framework. T11-documentation This PR/Issue is related to documentation.

Comments

@kianenigma
Copy link
Contributor

kianenigma commented Jun 13, 2024 •
edited
Loading

  • In the docs, explicitely mention the suggested use of prelude modules as the suggested way. Atm, this is not easily visibile in the first example that you would encounter, if you start digging into the crate docs.
  • Provide proper errors for #[cfg(not(feature = "experimental"))] that, instead of not working, provide a compiler error that says the frame crate is experimental.
  • Update the umbrella_crate reference doc to holistically cover both polkadot-sdk and polkadot-sdk-frame umbrellas.
@kianenigma kianenigma added T1-FRAME This PR/Issue is related to core FRAME, the framework. T11-documentation This PR/Issue is related to documentation. labels Jun 13, 2024
@kianenigma
Copy link
Contributor Author

kianenigma commented Aug 5, 2024 •
edited
Loading

  • Make preludes use-able: As in: I should be able to write a reasonable pallet + runtime + tests + benchmarks without needing to use anything other than prelude::* + runtime::prelude::* + testing::prelude::* + benchmarking::prelude::*.
  • Either remove the experimental flag, or document the issues that need to be removed before we remove it.

@kianenigma kianenigma mentioned this issue Aug 5, 2024
Open
21 tasks
@shawntabrizi
Copy link
Member

You are not exporting TokenError, and perhaps other DispatchError variants.

@kianenigma kianenigma mentioned this issue Oct 9, 2024
Merged
@serban300 serban300 mentioned this issue Oct 9, 2024
Open
4 tasks
@kianenigma kianenigma mentioned this issue Oct 9, 2024
Merged
3 tasks
github-merge-queue bot pushed a commit that referenced this issue Oct 14, 2024
@serban300
Use the umbrella crate for the parachain template (#5991)
d7f01a1 
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 kianenigma mentioned this issue Oct 21, 2024
Merged
2 tasks
github-merge-queue bot pushed a commit that referenced this issue Oct 29, 2024
@kianenigma @gui1117
@re-gius @seadanda @shawntabrizi @ggwpez
Use frame umbrella crate in pallet-proxy and pallet-multisig (#5995)
9584dbd 
A step towards #4782

In order to nail down the right preludes in `polkadot-sdk-frame`, we
need to migrate a number of pallets to be written with it. Moreover,
migrating our pallets to this simpler patter will encourage the
ecosystem to also follow along.

If this PR is approved and has no unwanted negative consequences, I will
make a tracking issue to migrate all pallets to this umbrella crate.

TODO: 

- [x] fix frame benchmarking template. Can we detect the umbrella crate
in there and have an `if else`? cc @ggwpez
- [x] Migrate benchmarking to v2 @re-gius a good candidate for you, you
can open a PR against my branch.
- [x] tracking issue with follow-ups

---------

Co-authored-by: Guillaume Thiolliere <[email protected]>
Co-authored-by: Giuseppe Re <[email protected]>
Co-authored-by: Dónal Murray <[email protected]>
Co-authored-by: Shawn Tabrizi <[email protected]>
Co-authored-by: Oliver Tale-Yazdi <[email protected]>
mordamax pushed a commit to paritytech-stg/polkadot-sdk that referenced this issue Oct 29, 2024
@kianenigma @gui1117
@re-gius @seadanda @shawntabrizi @ggwpez @mordamax
Use frame umbrella crate in pallet-proxy and pallet-multisig (par…
4a5379b 
…itytech#5995)

A step towards paritytech#4782

In order to nail down the right preludes in `polkadot-sdk-frame`, we
need to migrate a number of pallets to be written with it. Moreover,
migrating our pallets to this simpler patter will encourage the
ecosystem to also follow along.

If this PR is approved and has no unwanted negative consequences, I will
make a tracking issue to migrate all pallets to this umbrella crate.

TODO: 

- [x] fix frame benchmarking template. Can we detect the umbrella crate
in there and have an `if else`? cc @ggwpez
- [x] Migrate benchmarking to v2 @re-gius a good candidate for you, you
can open a PR against my branch.
- [x] tracking issue with follow-ups

---------

Co-authored-by: Guillaume Thiolliere <[email protected]>
Co-authored-by: Giuseppe Re <[email protected]>
Co-authored-by: Dónal Murray <[email protected]>
Co-authored-by: Shawn Tabrizi <[email protected]>
Co-authored-by: Oliver Tale-Yazdi <[email protected]>
mordamax pushed a commit to paritytech-stg/polkadot-sdk that referenced this issue Oct 29, 2024
@kianenigma @gui1117
@re-gius @seadanda @shawntabrizi @ggwpez @mordamax
Use frame umbrella crate in pallet-proxy and pallet-multisig (par…
f7d40ab 
…itytech#5995)

A step towards paritytech#4782

In order to nail down the right preludes in `polkadot-sdk-frame`, we
need to migrate a number of pallets to be written with it. Moreover,
migrating our pallets to this simpler patter will encourage the
ecosystem to also follow along.

If this PR is approved and has no unwanted negative consequences, I will
make a tracking issue to migrate all pallets to this umbrella crate.

TODO: 

- [x] fix frame benchmarking template. Can we detect the umbrella crate
in there and have an `if else`? cc @ggwpez
- [x] Migrate benchmarking to v2 @re-gius a good candidate for you, you
can open a PR against my branch.
- [x] tracking issue with follow-ups

---------

Co-authored-by: Guillaume Thiolliere <[email protected]>
Co-authored-by: Giuseppe Re <[email protected]>
Co-authored-by: Dónal Murray <[email protected]>
Co-authored-by: Shawn Tabrizi <[email protected]>
Co-authored-by: Oliver Tale-Yazdi <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@gupnik gupnik

Labels
T1-FRAME This PR/Issue is related to core FRAME, the framework. T11-documentation This PR/Issue is related to documentation.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@shawntabrizi @kianenigma @gupnik