mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-04-26 11:07:56 +00:00
[frame] #[pallet::composite_enum] improved variant count handling + removed pallet_balances's MaxHolds config (#2657)
I started this investigation/issue based on @liamaharon question [here](https://github.com/paritytech/polkadot-sdk/pull/1801#discussion_r1410452499). ## Problem The `pallet_balances` integrity test should correctly detect that the runtime has correct distinct `HoldReasons` variant count. I assume the same situation exists for RuntimeFreezeReason. It is not a critical problem, if we set `MaxHolds` with a sufficiently large value, everything should be ok. However, in this case, the integrity_test check becomes less useful. **Situation for "any" runtime:** - `HoldReason` enums from different pallets: ```rust /// from pallet_nis #[pallet::composite_enum] pub enum HoldReason { NftReceipt, } /// from pallet_preimage #[pallet::composite_enum] pub enum HoldReason { Preimage, } // from pallet_state-trie-migration #[pallet::composite_enum] pub enum HoldReason { SlashForContinueMigrate, SlashForMigrateCustomTop, SlashForMigrateCustomChild, } ``` - generated `RuntimeHoldReason` enum looks like: ```rust pub enum RuntimeHoldReason { #[codec(index = 32u8)] Preimage(pallet_preimage::HoldReason), #[codec(index = 38u8)] Nis(pallet_nis::HoldReason), #[codec(index = 42u8)] StateTrieMigration(pallet_state_trie_migration::HoldReason), } ``` - composite enum `RuntimeHoldReason` variant count is detected as `3` - we set `type MaxHolds = ConstU32<3>` - `pallet_balances::integrity_test` is ok with `3`(at least 3) However, the real problem can occur in a live runtime where some functionality might stop working. This is due to a total of 5 distinct hold reasons (for pallets with multi-instance support, it is even more), and not all of them can be used because of an incorrect `MaxHolds`, which is deemed acceptable according to the `integrity_test`: ``` // pseudo-code - if we try to call all of these: T::Currency::hold(&pallet_nis::HoldReason::NftReceipt.into(), &nft_owner, deposit)?; T::Currency::hold(&pallet_preimage::HoldReason::Preimage.into(), &nft_owner, deposit)?; T::Currency::hold(&pallet_state_trie_migration::HoldReason::SlashForContinueMigrate.into(), &nft_owner, deposit)?; // With `type MaxHolds = ConstU32<3>` these two will fail T::Currency::hold(&pallet_state_trie_migration::HoldReason::SlashForMigrateCustomTop.into(), &nft_owner, deposit)?; T::Currency::hold(&pallet_state_trie_migration::HoldReason::SlashForMigrateCustomChild.into(), &nft_owner, deposit)?; ``` ## Solutions A macro `#[pallet::*]` expansion is extended of `VariantCount` implementation for the `#[pallet::composite_enum]` enum type. This expansion generates the `VariantCount` implementation for pallets' `HoldReason`, `FreezeReason`, `LockId`, and `SlashReason`. Enum variants must be plain enum values without fields to ensure a deterministic count. The composite runtime enum, `RuntimeHoldReason` and `RuntimeFreezeReason`, now sets `VariantCount::VARIANT_COUNT` as the sum of pallets' enum `VariantCount::VARIANT_COUNT`: ```rust #[frame_support::pallet(dev_mode)] mod module_single_instance { #[pallet::composite_enum] pub enum HoldReason { ModuleSingleInstanceReason1, ModuleSingleInstanceReason2, } ... } #[frame_support::pallet(dev_mode)] mod module_multi_instance { #[pallet::composite_enum] pub enum HoldReason<I: 'static = ()> { ModuleMultiInstanceReason1, ModuleMultiInstanceReason2, ModuleMultiInstanceReason3, } ... } impl self::sp_api_hidden_includes_construct_runtime::hidden_include::traits::VariantCount for RuntimeHoldReason { const VARIANT_COUNT: u32 = 0 + module_single_instance::HoldReason::VARIANT_COUNT + module_multi_instance::HoldReason::<module_multi_instance::Instance1>::VARIANT_COUNT + module_multi_instance::HoldReason::<module_multi_instance::Instance2>::VARIANT_COUNT + module_multi_instance::HoldReason::<module_multi_instance::Instance3>::VARIANT_COUNT; } ``` In addition, `MaxHolds` is removed (as suggested [here](https://github.com/paritytech/polkadot-sdk/pull/2657#discussion_r1443324573)) from `pallet_balances`, and its `Holds` are now bounded to `RuntimeHoldReason::VARIANT_COUNT`. Therefore, there is no need to let the runtime specify `MaxHolds`. ## For reviewers Relevant changes can be found here: - `substrate/frame/support/procedural/src/lib.rs` - `substrate/frame/support/procedural/src/pallet/parse/composite.rs` - `substrate/frame/support/procedural/src/pallet/expand/composite.rs` - `substrate/frame/support/procedural/src/construct_runtime/expand/composite_helper.rs` - `substrate/frame/support/procedural/src/construct_runtime/expand/hold_reason.rs` - `substrate/frame/support/procedural/src/construct_runtime/expand/freeze_reason.rs` - `substrate/frame/support/src/traits/misc.rs` And the rest of the files is just about removed `MaxHolds` from `pallet_balances` ## Next steps Do the same for `MaxFreezes` https://github.com/paritytech/polkadot-sdk/issues/2997. --------- Co-authored-by: command-bot <> Co-authored-by: Bastian Köcher <git@kchr.de> Co-authored-by: Dónal Murray <donal.murray@parity.io> Co-authored-by: gupnik <nikhilgupta.iitk@gmail.com>
This commit is contained in:
Branislav Kontur
@@ -0,0 +1,274 @@
|
||||
// This file is part of Substrate.
|
||||
|
||||
// Copyright (C) Parity Technologies (UK) Ltd.
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// 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.
|
||||
|
||||
//! General tests for composite_enum macro and its handling, test for:
|
||||
//! * variant_count works
|
||||
|
||||
#![recursion_limit = "128"]
|
||||
|
||||
use codec::Encode;
|
||||
use frame_support::{derive_impl, traits::VariantCount};
|
||||
use sp_core::sr25519;
|
||||
use sp_runtime::{
|
||||
generic,
|
||||
traits::{BlakeTwo256, Verify},
|
||||
};
|
||||
|
||||
#[frame_support::pallet(dev_mode)]
|
||||
mod module_single_instance {
|
||||
|
||||
#[pallet::composite_enum]
|
||||
pub enum HoldReason {
|
||||
ModuleSingleInstanceReason1,
|
||||
ModuleSingleInstanceReason2,
|
||||
}
|
||||
|
||||
#[pallet::composite_enum]
|
||||
pub enum FreezeReason {
|
||||
ModuleSingleInstanceReason1,
|
||||
ModuleSingleInstanceReason2,
|
||||
}
|
||||
|
||||
#[pallet::pallet]
|
||||
pub struct Pallet<T>(_);
|
||||
|
||||
#[pallet::config]
|
||||
pub trait Config: frame_system::Config {
|
||||
type RuntimeHoldReason: From<HoldReason>;
|
||||
type RuntimeFreezeReason: From<FreezeReason>;
|
||||
}
|
||||
}
|
||||
|
||||
#[frame_support::pallet(dev_mode)]
|
||||
mod module_multi_instance {
|
||||
|
||||
#[pallet::composite_enum]
|
||||
pub enum HoldReason<I: 'static = ()> {
|
||||
ModuleMultiInstanceReason1,
|
||||
ModuleMultiInstanceReason2,
|
||||
ModuleMultiInstanceReason3,
|
||||
}
|
||||
|
||||
#[pallet::composite_enum]
|
||||
pub enum FreezeReason<I: 'static = ()> {
|
||||
ModuleMultiInstanceReason1,
|
||||
}
|
||||
|
||||
#[pallet::pallet]
|
||||
pub struct Pallet<T, I = ()>(_);
|
||||
|
||||
#[pallet::config]
|
||||
pub trait Config<I: 'static = ()>: frame_system::Config {
|
||||
type RuntimeHoldReason: From<HoldReason<I>>;
|
||||
type RuntimeFreezeReason: From<FreezeReason<I>>;
|
||||
}
|
||||
}
|
||||
|
||||
#[frame_support::pallet(dev_mode)]
|
||||
mod module_composite_enum_consumer {
|
||||
use super::*;
|
||||
|
||||
#[pallet::pallet]
|
||||
pub struct Pallet<T, I = ()>(_);
|
||||
|
||||
#[pallet::config]
|
||||
pub trait Config<I: 'static = ()>: frame_system::Config {
|
||||
// consume `HoldReason` `composite_enum`
|
||||
type RuntimeHoldReason: VariantCount;
|
||||
// consume `FreezeReason` `composite_enum`
|
||||
type RuntimeFreezeReason: VariantCount;
|
||||
}
|
||||
}
|
||||
|
||||
pub type BlockNumber = u64;
|
||||
pub type Signature = sr25519::Signature;
|
||||
pub type AccountId = <Signature as Verify>::Signer;
|
||||
pub type Header = generic::Header<BlockNumber, BlakeTwo256>;
|
||||
pub type UncheckedExtrinsic = generic::UncheckedExtrinsic<u32, RuntimeCall, Signature, ()>;
|
||||
pub type Block = generic::Block<Header, UncheckedExtrinsic>;
|
||||
|
||||
frame_support::construct_runtime!(
|
||||
pub enum Runtime
|
||||
{
|
||||
System: frame_system,
|
||||
ModuleSingleInstance: module_single_instance,
|
||||
ModuleMultiInstance0: module_multi_instance,
|
||||
ModuleMultiInstance1: module_multi_instance::<Instance1>,
|
||||
ModuleMultiInstance2: module_multi_instance::<Instance2>,
|
||||
ModuleMultiInstance3: module_multi_instance::<Instance3>,
|
||||
ModuleCompositeEnumConsumer: module_composite_enum_consumer,
|
||||
}
|
||||
);
|
||||
|
||||
#[derive_impl(frame_system::config_preludes::TestDefaultConfig as frame_system::DefaultConfig)]
|
||||
impl frame_system::Config for Runtime {
|
||||
type Block = Block;
|
||||
}
|
||||
|
||||
impl module_single_instance::Config for Runtime {
|
||||
type RuntimeHoldReason = RuntimeHoldReason;
|
||||
type RuntimeFreezeReason = RuntimeFreezeReason;
|
||||
}
|
||||
|
||||
impl module_multi_instance::Config for Runtime {
|
||||
type RuntimeHoldReason = RuntimeHoldReason;
|
||||
type RuntimeFreezeReason = RuntimeFreezeReason;
|
||||
}
|
||||
impl module_multi_instance::Config<module_multi_instance::Instance1> for Runtime {
|
||||
type RuntimeHoldReason = RuntimeHoldReason;
|
||||
type RuntimeFreezeReason = RuntimeFreezeReason;
|
||||
}
|
||||
impl module_multi_instance::Config<module_multi_instance::Instance2> for Runtime {
|
||||
type RuntimeHoldReason = RuntimeHoldReason;
|
||||
type RuntimeFreezeReason = RuntimeFreezeReason;
|
||||
}
|
||||
impl module_multi_instance::Config<module_multi_instance::Instance3> for Runtime {
|
||||
type RuntimeHoldReason = RuntimeHoldReason;
|
||||
type RuntimeFreezeReason = RuntimeFreezeReason;
|
||||
}
|
||||
|
||||
impl module_composite_enum_consumer::Config for Runtime {
|
||||
type RuntimeHoldReason = RuntimeHoldReason;
|
||||
type RuntimeFreezeReason = RuntimeFreezeReason;
|
||||
}
|
||||
|
||||
fn list_all_hold_reason_variants() -> Vec<RuntimeHoldReason> {
|
||||
let variants = vec![
|
||||
RuntimeHoldReason::ModuleSingleInstance(module_single_instance::HoldReason::ModuleSingleInstanceReason1),
|
||||
RuntimeHoldReason::ModuleSingleInstance(module_single_instance::HoldReason::ModuleSingleInstanceReason2),
|
||||
RuntimeHoldReason::ModuleMultiInstance0(<module_multi_instance::HoldReason>::ModuleMultiInstanceReason1),
|
||||
RuntimeHoldReason::ModuleMultiInstance0(<module_multi_instance::HoldReason>::ModuleMultiInstanceReason2),
|
||||
RuntimeHoldReason::ModuleMultiInstance0(<module_multi_instance::HoldReason>::ModuleMultiInstanceReason3),
|
||||
RuntimeHoldReason::ModuleMultiInstance0(<module_multi_instance::HoldReason>::__Ignore(Default::default())),
|
||||
RuntimeHoldReason::ModuleMultiInstance1(module_multi_instance::HoldReason::<module_multi_instance::Instance1>::ModuleMultiInstanceReason1),
|
||||
RuntimeHoldReason::ModuleMultiInstance1(module_multi_instance::HoldReason::<module_multi_instance::Instance1>::ModuleMultiInstanceReason2),
|
||||
RuntimeHoldReason::ModuleMultiInstance1(module_multi_instance::HoldReason::<module_multi_instance::Instance1>::ModuleMultiInstanceReason3),
|
||||
RuntimeHoldReason::ModuleMultiInstance1(module_multi_instance::HoldReason::<module_multi_instance::Instance1>::__Ignore(Default::default())),
|
||||
RuntimeHoldReason::ModuleMultiInstance2(module_multi_instance::HoldReason::<module_multi_instance::Instance2>::ModuleMultiInstanceReason1),
|
||||
RuntimeHoldReason::ModuleMultiInstance2(module_multi_instance::HoldReason::<module_multi_instance::Instance2>::ModuleMultiInstanceReason2),
|
||||
RuntimeHoldReason::ModuleMultiInstance2(module_multi_instance::HoldReason::<module_multi_instance::Instance2>::ModuleMultiInstanceReason3),
|
||||
RuntimeHoldReason::ModuleMultiInstance2(module_multi_instance::HoldReason::<module_multi_instance::Instance2>::__Ignore(Default::default())),
|
||||
RuntimeHoldReason::ModuleMultiInstance3(module_multi_instance::HoldReason::<module_multi_instance::Instance3>::ModuleMultiInstanceReason1),
|
||||
RuntimeHoldReason::ModuleMultiInstance3(module_multi_instance::HoldReason::<module_multi_instance::Instance3>::ModuleMultiInstanceReason2),
|
||||
RuntimeHoldReason::ModuleMultiInstance3(module_multi_instance::HoldReason::<module_multi_instance::Instance3>::ModuleMultiInstanceReason3),
|
||||
RuntimeHoldReason::ModuleMultiInstance3(module_multi_instance::HoldReason::<module_multi_instance::Instance3>::__Ignore(Default::default())),
|
||||
];
|
||||
// check that we didn't miss any value
|
||||
for v in &variants {
|
||||
match v {
|
||||
RuntimeHoldReason::ModuleSingleInstance(inner) => match inner {
|
||||
module_single_instance::HoldReason::ModuleSingleInstanceReason1
|
||||
| module_single_instance::HoldReason::ModuleSingleInstanceReason2 => (),
|
||||
}
|
||||
RuntimeHoldReason::ModuleMultiInstance0(inner) => match inner {
|
||||
<module_multi_instance::HoldReason>::ModuleMultiInstanceReason1
|
||||
| <module_multi_instance::HoldReason>::ModuleMultiInstanceReason2
|
||||
| <module_multi_instance::HoldReason>::ModuleMultiInstanceReason3
|
||||
| module_multi_instance::HoldReason::<()>::__Ignore(_) => (),
|
||||
}
|
||||
RuntimeHoldReason::ModuleMultiInstance1(inner) => match inner {
|
||||
module_multi_instance::HoldReason::<module_multi_instance::Instance1>::ModuleMultiInstanceReason1
|
||||
| module_multi_instance::HoldReason::<module_multi_instance::Instance1>::ModuleMultiInstanceReason2
|
||||
| module_multi_instance::HoldReason::<module_multi_instance::Instance1>::ModuleMultiInstanceReason3
|
||||
| module_multi_instance::HoldReason::<module_multi_instance::Instance1>::__Ignore(_) => (),
|
||||
}
|
||||
RuntimeHoldReason::ModuleMultiInstance2(inner) => match inner {
|
||||
module_multi_instance::HoldReason::<module_multi_instance::Instance2>::ModuleMultiInstanceReason1
|
||||
| module_multi_instance::HoldReason::<module_multi_instance::Instance2>::ModuleMultiInstanceReason2
|
||||
| module_multi_instance::HoldReason::<module_multi_instance::Instance2>::ModuleMultiInstanceReason3
|
||||
| module_multi_instance::HoldReason::<module_multi_instance::Instance2>::__Ignore(_) => (),
|
||||
}
|
||||
RuntimeHoldReason::ModuleMultiInstance3(inner) => match inner {
|
||||
module_multi_instance::HoldReason::<module_multi_instance::Instance3>::ModuleMultiInstanceReason1
|
||||
| module_multi_instance::HoldReason::<module_multi_instance::Instance3>::ModuleMultiInstanceReason2
|
||||
| module_multi_instance::HoldReason::<module_multi_instance::Instance3>::ModuleMultiInstanceReason3
|
||||
| module_multi_instance::HoldReason::<module_multi_instance::Instance3>::__Ignore(_) => (),
|
||||
}
|
||||
}
|
||||
}
|
||||
variants
|
||||
}
|
||||
|
||||
fn list_all_freeze_reason_variants() -> Vec<RuntimeFreezeReason> {
|
||||
let variants = vec![
|
||||
RuntimeFreezeReason::ModuleSingleInstance(module_single_instance::FreezeReason::ModuleSingleInstanceReason1),
|
||||
RuntimeFreezeReason::ModuleSingleInstance(module_single_instance::FreezeReason::ModuleSingleInstanceReason2),
|
||||
RuntimeFreezeReason::ModuleMultiInstance0(<module_multi_instance::FreezeReason>::ModuleMultiInstanceReason1),
|
||||
RuntimeFreezeReason::ModuleMultiInstance0(<module_multi_instance::FreezeReason>::__Ignore(Default::default())),
|
||||
RuntimeFreezeReason::ModuleMultiInstance1(module_multi_instance::FreezeReason::<module_multi_instance::Instance1>::ModuleMultiInstanceReason1),
|
||||
RuntimeFreezeReason::ModuleMultiInstance1(module_multi_instance::FreezeReason::<module_multi_instance::Instance1>::__Ignore(Default::default())),
|
||||
RuntimeFreezeReason::ModuleMultiInstance2(module_multi_instance::FreezeReason::<module_multi_instance::Instance2>::ModuleMultiInstanceReason1),
|
||||
RuntimeFreezeReason::ModuleMultiInstance2(module_multi_instance::FreezeReason::<module_multi_instance::Instance2>::__Ignore(Default::default())),
|
||||
RuntimeFreezeReason::ModuleMultiInstance3(module_multi_instance::FreezeReason::<module_multi_instance::Instance3>::ModuleMultiInstanceReason1),
|
||||
RuntimeFreezeReason::ModuleMultiInstance3(module_multi_instance::FreezeReason::<module_multi_instance::Instance3>::__Ignore(Default::default())),
|
||||
];
|
||||
// check that we didn't miss any value
|
||||
for v in &variants {
|
||||
match v {
|
||||
RuntimeFreezeReason::ModuleSingleInstance(inner) => match inner {
|
||||
module_single_instance::FreezeReason::ModuleSingleInstanceReason1
|
||||
| module_single_instance::FreezeReason::ModuleSingleInstanceReason2 => (),
|
||||
}
|
||||
RuntimeFreezeReason::ModuleMultiInstance0(inner) => match inner {
|
||||
<module_multi_instance::FreezeReason>::ModuleMultiInstanceReason1
|
||||
| module_multi_instance::FreezeReason::<()>::__Ignore(_) => (),
|
||||
}
|
||||
RuntimeFreezeReason::ModuleMultiInstance1(inner) => match inner {
|
||||
module_multi_instance::FreezeReason::<module_multi_instance::Instance1>::ModuleMultiInstanceReason1
|
||||
| module_multi_instance::FreezeReason::<module_multi_instance::Instance1>::__Ignore(_) => (),
|
||||
}
|
||||
RuntimeFreezeReason::ModuleMultiInstance2(inner) => match inner {
|
||||
module_multi_instance::FreezeReason::<module_multi_instance::Instance2>::ModuleMultiInstanceReason1
|
||||
| module_multi_instance::FreezeReason::<module_multi_instance::Instance2>::__Ignore(_) => (),
|
||||
}
|
||||
RuntimeFreezeReason::ModuleMultiInstance3(inner) => match inner {
|
||||
module_multi_instance::FreezeReason::<module_multi_instance::Instance3>::ModuleMultiInstanceReason1
|
||||
| module_multi_instance::FreezeReason::<module_multi_instance::Instance3>::__Ignore(_) => (),
|
||||
}
|
||||
}
|
||||
}
|
||||
variants
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn runtime_hold_reason_variant_count_works() {
|
||||
assert_eq!(RuntimeHoldReason::VARIANT_COUNT as usize, list_all_hold_reason_variants().len());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn runtime_freeze_reason_variant_count_works() {
|
||||
assert_eq!(
|
||||
RuntimeFreezeReason::VARIANT_COUNT as usize,
|
||||
list_all_freeze_reason_variants().len()
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn check_unique_encodings_for_hold_reason() {
|
||||
let variants = list_all_hold_reason_variants();
|
||||
let unique_encoded_variants =
|
||||
variants.iter().map(|v| v.encode()).collect::<std::collections::HashSet<_>>();
|
||||
assert_eq!(unique_encoded_variants.len(), variants.len());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn check_unique_encodings_for_freeze_reason() {
|
||||
let variants = list_all_freeze_reason_variants();
|
||||
let unique_encoded_variants =
|
||||
variants.iter().map(|v| v.encode()).collect::<std::collections::HashSet<_>>();
|
||||
assert_eq!(unique_encoded_variants.len(), variants.len());
|
||||
}
|
||||
Reference in New Issue
Block a user