[FRAME Core] Default Pallet Config Trait / derive_impl #13454

kianenigma · 2023-02-23T23:58:40Z

related to Vision: Improve Developer Experience with better Config Traits polkadot-sdk#288
The majority of this PR is contributions of @sam0x17 🤝

WARNING

This feature is not extensively used and tested in Substrate crates yet. Its usage in tests is encouraged (whilst reporting any issues you encounter), but not in production yet.

See paritytech/polkadot-sdk#171 to track the progress.

At a Glance

In short, this PR adds the ability for a pallet to define one or more defaults for its trait Config). This is dine via #[pallet::config(with_default)].
Then, when writing impl Config for Runtime, one of these defaults can be used to elide any missing type item. This is done via #[derive_impl(path_to_default_impl)]
At the moment, this is limited to type items that do not rely on frame_system::Config. Such types must be marked by #[pallet::no_default].
RuntimeEvent is one such type and is automatically excluded.

End-to-End Example

See ./frame/example/default-config for the live version of this example.

Details

derive_impl

This PR adds several attribute proc macros to frame_support, most notably #[derive_impl(..)] and #[register_default_impl(..)], which in tandem make it possible to create trait impls that provide sane defaults and (via macros) dynamically inject the non-colliding trait items from these impls into downstream trait impls that want to use the sane defaults but potentially override some of them.

This is a general-purpose behavior that can be used for a number of things, though the specific purpose of this PR is to use this for implementing "default" pallet test config traits, as outlined below.

Changes/Additions

Adds a new optional option to #[pallet::config]: #[pallet::config(with_default)]. When enabled, this option will spit out a pub trait DefaultConfig in the pallet containing trait items from the pallet's Config that are not marked with #[pallet::no_default] (a new attribute).
Adds a new pallet attribute #[pallet::no_default], used in tandem with #[pallet::config(with_default)] as described above.
Default configs implemented for frame_system
Example default-config-example pallet added demonstrating how to use this
Numerous UI and unit tests covering all of this
Documentation covering these additions

frame/examples/basic/src/tests.rs

kianenigma · 2023-02-24T00:07:46Z

bot clean

xlc · 2023-02-24T00:13:34Z

For Get types, we could make it fn block_number() { 100 } and use the default trait impl feature of Rust.
The only downside is that will be a big breakinig change.

ggwpez

Looks very cool on first glance!

frame/balances/src/lib.rs

frame/examples/basic/src/tests.rs

frame/support/procedural/src/derive_impl.rs

frame/system/src/lib.rs

kianenigma · 2023-02-24T14:55:32Z

For Get types, we could make it fn block_number() { 100 } and use the default trait impl feature of Rust. The only downside is that will be a big breakinig change.

Yeah we've discussed this as well many times, but never got to a census about it :( but as you said, it will be a big change. This is all backwards compatible. Even this line of work can be partially set aside once we have default associated type in Rust.

ggwpez · 2023-03-01T11:22:35Z

@thiolliere I bet you are interested in this 😄
It aims to give default Config trait impls.

Co-authored-by: Oliver Tale-Yazdi <[email protected]>

kianenigma · 2023-05-29T09:20:55Z

bot rebase

paritytech-processbot · 2023-05-29T09:21:01Z

Rebased

frame/support/test/tests/pallet_ui.rs

KiChjang

LGTM after addressing my comment

frame/support/test/tests/pallet_ui.rs

kianenigma · 2023-05-30T08:06:32Z

bot merge

- #13454

* first draft, probably won't work * first draft, probably won't work * good progress.. * good milestone, still a lot to do. * EVERYTHING WORKS * Update frame/support/procedural/src/derive_impl.rs Co-authored-by: Oliver Tale-Yazdi <[email protected]> * Update frame/support/procedural/src/derive_impl.rs Co-authored-by: Oliver Tale-Yazdi <[email protected]> * clean up + cargo fmt * import tokens WIP * export_tokens working with impl Trait * WIP / notes * use macro_magic 0.2.0's export_tokens to access foreign items * token importing working properly using macro_magic 0.2.5 * combine_impls almost working * successfully get foreign path via macro_magic 0.2.6 * combine_impls using implementing_type generics * working + clean up * more clean up * decrease rightwards drift and add docs to combine_impls * add support for macros to impl_item_ident in case we hit that * add docs for impl_item_ident method * fix no_std issues * re-export of macro_magic working in pallets 🎉 * clean up + fully resolve no_std issue with macro_magic with v0.2.11 * remove trait item code for different trait item types since this is now handled directly by combine_impls * clean up * remove dev comments * only generate default trait if #[pallet::default_trait] is attached * authorship and most other pallets now compiling * compiling 🎉 * add check for more than two pallet attributes on Config trait * remove unused import in nomination-pool * clean up debug code * upgrade to macro_magic v0.2.12 * add neater #[register_default_config(SomeIdent)] macro * really just a thin wrapper around #[export_tokens] * upgrade to macro_magic 0.3.1 * rewrite parsing to be compatible with syn 2.x, compiling 🎉 * remove unused keywords * macro stubs for the new pallet:: macros, preliminary docs * upgrade to macro_magic v0.3.2 * rename register_default_config => register_default_impl * bump to macro_magic v0.3.3 * custom disambiguation_path working as 2nd arg to derive_impl * overhaul docs * fixes, ident-style paths shortcut working * remove ident-style shortcut because it makes testing difficult * add passing UI tests for derive_impl * switch to `ForeignPath as DisambiguationPath` syntax + update docs * add UI test for bad foreign path * add UI test for bad disambiguation path * add UI test for missing disambiguation path * add UI test for attached to non impl * fix derive_impl_attr_args_parsing test * move tests to bottom * fix nightly issue * add doc notes on importing/re-exporting * remove explicit use of macro_magic::use_attr Co-authored-by: Bastian Köcher <[email protected]> * use explicit macro_magic::use_attr Co-authored-by: Bastian Köcher <[email protected]> * remove unneeded {} Co-authored-by: Bastian Köcher <[email protected]> * remove unneeded collect Co-authored-by: Bastian Köcher <[email protected]> * add docs for TestDefaultConfig * remove unneeded `#[export_tokens]` on `DefaultConfig` * add docs for auto-generated `DefaultConfig` * no need to clone Co-authored-by: Bastian Köcher <[email protected]> * clean up combine_impls + compiling again * remove unused dependency * simplify struct definition Co-authored-by: Bastian Köcher <[email protected]> * fix register_default_impl docs * reduce rightward drift / refactor Co-authored-by: Keith Yeung <[email protected]> * fix derive_impl after keith's changes * simplify disambiguation_path calculation Co-authored-by: Keith Yeung <[email protected]> * compiling again * simplify parsing of trait item Co-authored-by: Keith Yeung <[email protected]> * rename preludes => prelude Co-authored-by: Keith Yeung <[email protected]> * fix other places where we used preludes instead of prelude * fix indents * simplify PalletAttr parsing Co-authored-by: Keith Yeung <[email protected]> * go back to having no_default and constant as keywords * make it more clear that disambiguation_path is optional * make default_trait_items just a Vec instead of Option<Vec> * rename foreign_path => default_impl_path within substrate * fix docs * Change {} to ; Co-authored-by: Bastian Köcher <[email protected]> * highlight full end-to-end example with link * add pallet-default-config-example, start by copying dev mode code * update dev-mode specific docs * use Person and Points instead of Dummy and Bar * add docs to example pallet * revert changes to pallets other than the default config example * fix outdated references to basic example pallet * re-order docs to be a bit more clear * better errors for extra attributes * add UI tests for duplicate/extra attributes on trait items * change `#[pallet::default_config]` to option on `#[pallet::config()]` * update UI tests * add UI test covering missing `#[pallet::config(with_default)]` when `#[pallet::no_default]` is used * add note about new optional conventions * improve docs about `DefaultConfig` and link to these from a few places * fix doc comment * fix old comment referencing `pallet::default_config` * use u32 instead of u64 for block number Co-authored-by: Kian Paimani <[email protected]> * use () instead of u32 for `AccountData` Co-authored-by: Kian Paimani <[email protected]> * use ConstU32<10> for BlockHashCount instead of ConstU64<10> Co-authored-by: Kian Paimani <[email protected]> * people are not dummies Co-authored-by: Liam Aharon <[email protected]> * fix wording Co-authored-by: Just van Stam <[email protected]> * Person => People and compiling again * add docs for `prelude` module in frame_system * update Cargo.lock * cleaner example * tweaks * update docs more * update docs more * update docs more * update docs more * fix ui tests * err * Update frame/support/test/tests/pallet_ui.rs * update ui tests --------- Co-authored-by: Oliver Tale-Yazdi <[email protected]> Co-authored-by: Sam Johnson <[email protected]> Co-authored-by: parity-processbot <> Co-authored-by: Bastian Köcher <[email protected]> Co-authored-by: Keith Yeung <[email protected]> Co-authored-by: Liam Aharon <[email protected]> Co-authored-by: Just van Stam <[email protected]>

kianenigma commented Feb 23, 2023

View reviewed changes

frame/examples/basic/src/tests.rs Outdated Show resolved Hide resolved

ggwpez reviewed Feb 24, 2023

View reviewed changes

kianenigma assigned sam0x17 Feb 24, 2023

gavofyork mentioned this pull request Aug 24, 2023

Tokens Horizon paritytech/polkadot-sdk#327

Open

20 tasks

kianenigma and others added 18 commits March 29, 2023 02:33

first draft, probably won't work

83ebbbe

first draft, probably won't work

8597691

good progress..

8090642

good milestone, still a lot to do.

6294102

EVERYTHING WORKS

a0a6423

Update frame/support/procedural/src/derive_impl.rs

749df49

Co-authored-by: Oliver Tale-Yazdi <[email protected]>

Update frame/support/procedural/src/derive_impl.rs

0777136

Co-authored-by: Oliver Tale-Yazdi <[email protected]>

clean up + cargo fmt

7d5d50f

import tokens WIP

6c6f8c5

export_tokens working with impl Trait

9abec0a

WIP / notes

930cc25

use macro_magic 0.2.0's export_tokens to access foreign items

01c88ad

token importing working properly using macro_magic 0.2.5

4b481be

combine_impls almost working

4ff18f4

successfully get foreign path via macro_magic 0.2.6

cd0753c

combine_impls using implementing_type generics

07d80f5

working + clean up

7dc8022

more clean up

c8924cc

sam0x17 force-pushed the kiz-simpkified-runtime branch from edbcc99 to c8924cc Compare March 29, 2023 06:47

kianenigma added 2 commits May 28, 2023 10:32

fix ui tests

e141483

err

4b6fe4a

kianenigma requested a review from KiChjang May 29, 2023 09:20

Merge remote-tracking branch 'origin/master' into kiz-simpkified-runtime

d3d7d93

sam0x17 mentioned this pull request May 29, 2023

Improve documentation for fast-unstake pallet #14101

Merged

4 tasks

KiChjang reviewed May 29, 2023

View reviewed changes

frame/support/test/tests/pallet_ui.rs Outdated Show resolved Hide resolved

KiChjang approved these changes May 29, 2023

View reviewed changes

kianenigma commented May 29, 2023

View reviewed changes

frame/support/test/tests/pallet_ui.rs Outdated Show resolved Hide resolved

kianenigma and others added 3 commits May 29, 2023 19:58

Update frame/support/test/tests/pallet_ui.rs

9ee1b09

Master.into()

41da6cd

update ui tests

638c1fa

paritytech-processbot bot merged commit 06d8934 into master May 30, 2023

paritytech-processbot bot deleted the kiz-simpkified-runtime branch May 30, 2023 08:06

kianenigma changed the title ~~Default Pallet Config Trait / derive_impl~~ [FRAME Core] Default Pallet Config Trait / derive_impl May 30, 2023

This was referenced Jun 1, 2023

refactor Offchain Worker examples #14280

Open

add pallet macro kitchensink example/template #14052

Merged

Shawn Tabrizi - Tracking Issue - Berkeley Polkadot-Blockchain-Academy/pba-content#592

Open

ggwpez mentioned this pull request Jun 9, 2023

Use default config trait in mock runtimes #14336

Closed

sam0x17 mentioned this pull request Jun 13, 2023

update macro_magic to 0.4.1 #14356

Merged

bkchr mentioned this pull request Jun 24, 2023

add frame_system::DefaultConfig to individual pallet DefaultConfigs #14453

Merged

brunopgalvao added a commit that referenced this pull request Jul 16, 2023

use DefaultConfig

4f4e456

- #13454

kianenigma mentioned this pull request Jul 21, 2023

test-runtime: GenesisBuilder runtime API impl + tests #14310

Merged

crystalin mentioned this pull request Oct 20, 2023

Update substrate/polkadot/cumulus from v0.9.43 to v1.1.0 moonbeam-foundation/moonbeam#2535

Closed

JesseAbram mentioned this pull request Oct 26, 2023

Update substrate and subxt entropyxyz/entropy-core#435

Merged

Roznovjak mentioned this pull request Nov 27, 2023

chore: upgrade to polkadot-v1.1.0 galacticcouncil/hydration-node#691

Merged

15 tasks

Roznovjak mentioned this pull request Dec 4, 2023

chore: upgrade to polkadot-v1.1.0 galacticcouncil/Basilisk-node#645

Merged

10 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[FRAME Core] Default Pallet Config Trait / derive_impl #13454

[FRAME Core] Default Pallet Config Trait / derive_impl #13454

kianenigma commented Feb 23, 2023 •

edited

Loading

kianenigma commented Feb 24, 2023

xlc commented Feb 24, 2023 •

edited

Loading

ggwpez left a comment

kianenigma commented Feb 24, 2023

ggwpez commented Mar 1, 2023

kianenigma commented May 29, 2023

paritytech-processbot bot commented May 29, 2023

KiChjang left a comment

kianenigma commented May 30, 2023

[FRAME Core] Default Pallet Config Trait / derive_impl #13454

[FRAME Core] Default Pallet Config Trait / derive_impl #13454

Conversation

kianenigma commented Feb 23, 2023 • edited Loading

WARNING

At a Glance

End-to-End Example

Details

derive_impl

Changes/Additions

kianenigma commented Feb 24, 2023

xlc commented Feb 24, 2023 • edited Loading

ggwpez left a comment

Choose a reason for hiding this comment

kianenigma commented Feb 24, 2023

ggwpez commented Mar 1, 2023

kianenigma commented May 29, 2023

paritytech-processbot bot commented May 29, 2023

KiChjang left a comment

Choose a reason for hiding this comment

kianenigma commented May 30, 2023

kianenigma commented Feb 23, 2023 •

edited

Loading

xlc commented Feb 24, 2023 •

edited

Loading