Implement #[pallet::composite_enum] #13722

KiChjang · 2023-03-27T14:47:22Z

This PR adds a couple of new pallet parts: FreezeReason, HoldReason, LockId and SlashReason. The corresponding aggregate enums RuntimeFreezeReason, RuntimeHoldReason, RuntimeLockId and RuntimeSlashReason are also generated by construct_runtime. This is primarily used in pallets that wish to provide a reason for freezing funds, holding funds, locking funds and/or slashing funds in them.

#[pallet::composite_enum] is also added as an attribute to put on top of an enum declared in a pallet module. It now only accepts FreezeReason, HoldReason, LockId and SlashReason as identifiers for the enum; any other identifier gets rejected during pallet attribute parsing. If there are no #[derive] attributes marked for the enum, the code would then automatically add derives for the Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Decode, Encode, MaxEncodedLen, RuntimeDebug, TypeInfo traits.

sam0x17

Would be cool to have a UI test ensuring that it complains if you try to provide an argument to #[hold_reason(..)] since none are supported

xlc

how generalize can we make this be?
what happen if we need a freeze reason? withdraw reason?
a Task for the omni scheduler?

…d-reason

KiChjang · 2023-03-28T12:14:08Z

I could add slash reason/reserve reason/lock ID within this PR, but it's best to check and see whether this approach is good first.

And as Basti has mentioned in this comment, it makes sense to have separate attributes for different things.

kianenigma · 2023-03-28T14:21:57Z

I could add slash reason/reserve reason/lock ID within this PR, but it's best to check and see whether this approach is good first.

If we want to add those now, it would require us to pretty much copy paste the existing diff with new names. Could it be that under the hood we have a general system for a pallet to define "composite_parts", but statically only allow it to be hold_reason for now?

As for Basti's comment, If the main reason is that typos are hard to detect, I think the can manually check it by having construct_runtime name the composite enums that are acceptable. Then, if any pallet is producing a composite enum that is not in the list, there will be a warning and it will be ignored.

I won't strongly push back on this either as the broad currency refactor is greatly more important, but I want to bring it up one more time before heading to review and merge.

xlc · 2023-03-28T20:52:37Z

Yeah this is a very useful pattern and I want to make sure this feature not only available to core pallets. For example, ORML may want to define some LockReason enum. We cannot do it without modify some low level FRAME code. It will be great if this macro can be implemented in such way that users can define custom enum type.

Something like #[pallet::aggregated(HoldReason)]

KiChjang · 2023-03-30T06:34:16Z

With the latest commit, the code now supports an attribute called #[pallet::composite_enum], and will check whether the name of the enum is either of FreezeReason, HoldReason, LockId or SlashReason. I haven't still supported arbitrary identifiers yet, because of a few unresolved questions:

As mentioned previously, hunting down for spelling mistakes is tough, and the current setup doesn't really attempt to solve it. Putting the name of the enum on the attribute doesn't really solve anything; in fact, it simply just moves the problem to the attribute.
The way construct_runtime knows which enum to expand is by creating new pallet parts, each for the 4 new different aggregate enums. If we support arbitrary identifiers, we'll need to figure out an easy way to create new pallet parts that are named after the new identifiers, OR completely refrain from using pallet parts to know which aggregate enums to expand and think of a new way to gather that info from pallets.
Reporting metadata information for custom aggregate enums. We can't exactly create new fields for the pallet metadata, but I guess we can create a hashmap for it. It's not 100% trivial but I think this is not a big challenge as compared with the other issues mentioned.

However, even with the problems listed above, the basic infrastructure of supporting arbitrary aggregate enum identifiers are in place, and it should take less effort to parse and expand them when we figure out the best way to resolve the aforementioned issues.

sam0x17

re-reviewed for composite stuff, 👍🏻

sam0x17 · 2023-03-31T12:59:08Z

frame/support/procedural/src/pallet/parse/composite.rs

+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.


This is great for our purposes. I wonder, though, how easy would it be for an outside user to add a custom composite for, say, their own parachain? Would they have to patch this file?

They'd actually have to do a little more stuff:

Modify the parser in construct_runtime so that it knows how to scan for the existence of a new aggregate enum via a new pallet part.

Instruct construct_runtime to check for the new pallet part and expanding it into the aggregate enum, complete with conversion functions as well.

Scan for all pallets during the expansion mentioned in 2 for any other pallets that contain the new pallet part, and aggregate all of them into an aggregated enum.

ggwpez

Is there a way to reduce code duplication?
Maybe use a decl macro?

frame/support/test/tests/pallet_ui/lock_id_duplicate.stderr

frame/support/procedural/src/construct_runtime/expand/freeze_reason.rs

frame/support/procedural/src/pallet/parse/composite.rs

…d-reason

KiChjang · 2023-04-04T12:28:38Z

bot merge

* Implement #[pallet::hold_reason] * Appease clippy * cargo fmt * Update test expectations * Update test expectations * Support composite_enum attribute instead * Update test expectations * Change hold_reason to composite_enum * Add UI test for unsupported identifier when using composite_enum * Fix comment * Add documentation for pallet::composable_enum * More docs * cargo fmt

Polkadot-Forum · 2023-05-02T08:44:04Z

This pull request has been mentioned on Polkadot Forum. There might be relevant details there:

https://forum.polkadot.network/t/april-updates-for-substrate-and-polkadot-devs/2764/1

* Implement #[pallet::hold_reason] * Appease clippy * cargo fmt * Update test expectations * Update test expectations * Support composite_enum attribute instead * Update test expectations * Change hold_reason to composite_enum * Add UI test for unsupported identifier when using composite_enum * Fix comment * Add documentation for pallet::composable_enum * More docs * cargo fmt

Implement #[pallet::hold_reason]

dc5050b

KiChjang force-pushed the kckyeung/pallet-hold-reason branch from 127e0bb to dc5050b Compare March 27, 2023 15:21

sam0x17 approved these changes Mar 27, 2023

View reviewed changes

KiChjang added 2 commits March 28, 2023 18:30

Appease clippy

284cf9a

cargo fmt

d179822

xlc reviewed Mar 28, 2023

View reviewed changes

Merge remote-tracking branch 'origin/master' into kckyeung/pallet-hol…

e24a75d

…d-reason

KiChjang mentioned this pull request Mar 28, 2023

Add metadata V15 with Runtime API support paritytech/frame-metadata#48

Merged

KiChjang added 2 commits March 28, 2023 20:21

Update test expectations

30d7c4a

Update test expectations

c9e8b5f

kianenigma added B1-note_worthy Changes should be noted in the release notes T1-runtime This PR/Issue is related to the topic “runtime”. and removed B0-silent Changes should not be mentioned in any release notes labels Mar 28, 2023

Support composite_enum attribute instead

1dfea46

KiChjang changed the title ~~Implement #[pallet::hold_reason]~~ Implement #[pallet::composite_enum] Mar 30, 2023

Update test expectations

5ae02ee

sam0x17 approved these changes Mar 31, 2023

View reviewed changes

ggwpez approved these changes Mar 31, 2023

View reviewed changes

KiChjang added 4 commits April 1, 2023 02:00

Change hold_reason to composite_enum

5203114

Add UI test for unsupported identifier when using composite_enum

cda2f56

Fix comment

5c8f46a

Add documentation for pallet::composable_enum

f52054b

sam0x17 approved these changes Apr 3, 2023

View reviewed changes

KiChjang added 3 commits April 4, 2023 01:53

More docs

0a0502a

Merge remote-tracking branch 'origin/master' into kckyeung/pallet-hol…

b2b36d2

…d-reason

cargo fmt

cc0353f

paritytech-processbot bot merged commit 057f2af into master Apr 4, 2023

paritytech-processbot bot deleted the kckyeung/pallet-hold-reason branch April 4, 2023 12:28

xlc mentioned this pull request Apr 4, 2023

Make composite_enum generalized paritytech/polkadot-sdk#190

Open

KiChjang changed the title ~~Implement #[pallet::composite_enum]~~ Implement #[pallet::composable_enum] Apr 5, 2023

KiChjang changed the title ~~Implement #[pallet::composable_enum]~~ Implement #[pallet::composite_enum] Apr 5, 2023

KiChjang mentioned this pull request Apr 17, 2023

Track additional composite enum metadata paritytech/frame-metadata#55

Closed

github-actions bot mentioned this pull request Jun 15, 2023

Update substrate/polkadot/cumulus from v0.9.40 to v0.9.43 moonbeam-foundation/moonbeam#2354

Closed

kacperzuk-neti mentioned this pull request Jun 23, 2023

Polkadot v0.9.43 liberland/liberland_substrate#295

Merged

15 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement #[pallet::composite_enum] #13722

Implement #[pallet::composite_enum] #13722

KiChjang commented Mar 27, 2023 •

edited

Loading

sam0x17 left a comment

xlc left a comment

KiChjang commented Mar 28, 2023

kianenigma commented Mar 28, 2023

xlc commented Mar 28, 2023 •

edited

Loading

KiChjang commented Mar 30, 2023 •

edited

Loading

sam0x17 left a comment

sam0x17 Mar 31, 2023 •

edited

Loading

KiChjang Apr 1, 2023

ggwpez left a comment

KiChjang commented Apr 4, 2023

Polkadot-Forum commented May 2, 2023

Implement #[pallet::composite_enum] #13722

Implement #[pallet::composite_enum] #13722

Conversation

KiChjang commented Mar 27, 2023 • edited Loading

sam0x17 left a comment

Choose a reason for hiding this comment

xlc left a comment

Choose a reason for hiding this comment

KiChjang commented Mar 28, 2023

kianenigma commented Mar 28, 2023

xlc commented Mar 28, 2023 • edited Loading

KiChjang commented Mar 30, 2023 • edited Loading

sam0x17 left a comment

Choose a reason for hiding this comment

sam0x17 Mar 31, 2023 • edited Loading

Choose a reason for hiding this comment

KiChjang Apr 1, 2023

Choose a reason for hiding this comment

ggwpez left a comment

Choose a reason for hiding this comment

KiChjang commented Apr 4, 2023

Polkadot-Forum commented May 2, 2023

KiChjang commented Mar 27, 2023 •

edited

Loading

xlc commented Mar 28, 2023 •

edited

Loading

KiChjang commented Mar 30, 2023 •

edited

Loading

sam0x17 Mar 31, 2023 •

edited

Loading