mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-04-29 23:07:57 +00:00
bb8ddc46c1
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>
352 lines
10 KiB
Rust
352 lines
10 KiB
Rust
// 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.
|
|
|
|
use super::*;
|
|
use crate as root_offences;
|
|
|
|
use frame_election_provider_support::{
|
|
bounds::{ElectionBounds, ElectionBoundsBuilder},
|
|
onchain, SequentialPhragmen,
|
|
};
|
|
use frame_support::{
|
|
derive_impl, parameter_types,
|
|
traits::{ConstU32, ConstU64, Hooks, OneSessionHandler},
|
|
};
|
|
use pallet_staking::StakerStatus;
|
|
use sp_core::H256;
|
|
use sp_runtime::{
|
|
curve::PiecewiseLinear,
|
|
testing::UintAuthorityId,
|
|
traits::{BlakeTwo256, IdentityLookup, Zero},
|
|
BuildStorage,
|
|
};
|
|
use sp_staking::{EraIndex, SessionIndex};
|
|
use sp_std::collections::btree_map::BTreeMap;
|
|
|
|
type Block = frame_system::mocking::MockBlock<Test>;
|
|
type AccountId = u64;
|
|
type Balance = u64;
|
|
type BlockNumber = u64;
|
|
|
|
pub const INIT_TIMESTAMP: u64 = 30_000;
|
|
pub const BLOCK_TIME: u64 = 1000;
|
|
|
|
frame_support::construct_runtime!(
|
|
pub enum Test
|
|
{
|
|
System: frame_system,
|
|
Timestamp: pallet_timestamp,
|
|
Balances: pallet_balances,
|
|
Staking: pallet_staking,
|
|
Session: pallet_session,
|
|
RootOffences: root_offences,
|
|
Historical: pallet_session::historical,
|
|
}
|
|
);
|
|
|
|
/// Another session handler struct to test on_disabled.
|
|
pub struct OtherSessionHandler;
|
|
impl OneSessionHandler<AccountId> for OtherSessionHandler {
|
|
type Key = UintAuthorityId;
|
|
|
|
fn on_genesis_session<'a, I: 'a>(_: I)
|
|
where
|
|
I: Iterator<Item = (&'a AccountId, Self::Key)>,
|
|
AccountId: 'a,
|
|
{
|
|
}
|
|
|
|
fn on_new_session<'a, I: 'a>(_: bool, _: I, _: I)
|
|
where
|
|
I: Iterator<Item = (&'a AccountId, Self::Key)>,
|
|
AccountId: 'a,
|
|
{
|
|
}
|
|
|
|
fn on_disabled(_validator_index: u32) {}
|
|
}
|
|
|
|
impl sp_runtime::BoundToRuntimeAppPublic for OtherSessionHandler {
|
|
type Public = UintAuthorityId;
|
|
}
|
|
|
|
#[derive_impl(frame_system::config_preludes::TestDefaultConfig as frame_system::DefaultConfig)]
|
|
impl frame_system::Config for Test {
|
|
type BaseCallFilter = frame_support::traits::Everything;
|
|
type BlockWeights = ();
|
|
type BlockLength = ();
|
|
type DbWeight = ();
|
|
type RuntimeOrigin = RuntimeOrigin;
|
|
type Nonce = u64;
|
|
type Hash = H256;
|
|
type RuntimeCall = RuntimeCall;
|
|
type Hashing = BlakeTwo256;
|
|
type AccountId = u64;
|
|
type Lookup = IdentityLookup<Self::AccountId>;
|
|
type Block = Block;
|
|
type RuntimeEvent = RuntimeEvent;
|
|
type BlockHashCount = ConstU64<250>;
|
|
type Version = ();
|
|
type PalletInfo = PalletInfo;
|
|
type AccountData = pallet_balances::AccountData<u64>;
|
|
type OnNewAccount = ();
|
|
type OnKilledAccount = ();
|
|
type SystemWeightInfo = ();
|
|
type SS58Prefix = ();
|
|
type OnSetCode = ();
|
|
type MaxConsumers = ConstU32<16>;
|
|
}
|
|
|
|
impl pallet_balances::Config for Test {
|
|
type MaxLocks = ();
|
|
type MaxReserves = ();
|
|
type ReserveIdentifier = [u8; 8];
|
|
type Balance = Balance;
|
|
type RuntimeEvent = RuntimeEvent;
|
|
type DustRemoval = ();
|
|
type ExistentialDeposit = ConstU64<1>;
|
|
type AccountStore = System;
|
|
type WeightInfo = ();
|
|
type FreezeIdentifier = ();
|
|
type MaxFreezes = ();
|
|
type RuntimeHoldReason = ();
|
|
type RuntimeFreezeReason = ();
|
|
}
|
|
|
|
pallet_staking_reward_curve::build! {
|
|
const REWARD_CURVE: PiecewiseLinear<'static> = curve!(
|
|
min_inflation: 0_025_000u64,
|
|
max_inflation: 0_100_000,
|
|
ideal_stake: 0_500_000,
|
|
falloff: 0_050_000,
|
|
max_piece_count: 40,
|
|
test_precision: 0_005_000,
|
|
);
|
|
}
|
|
|
|
parameter_types! {
|
|
pub static ElectionsBounds: ElectionBounds = ElectionBoundsBuilder::default().build();
|
|
}
|
|
|
|
pub struct OnChainSeqPhragmen;
|
|
impl onchain::Config for OnChainSeqPhragmen {
|
|
type System = Test;
|
|
type Solver = SequentialPhragmen<AccountId, Perbill>;
|
|
type DataProvider = Staking;
|
|
type WeightInfo = ();
|
|
type MaxWinners = ConstU32<100>;
|
|
type Bounds = ElectionsBounds;
|
|
}
|
|
|
|
parameter_types! {
|
|
pub const RewardCurve: &'static PiecewiseLinear<'static> = &REWARD_CURVE;
|
|
pub static Offset: BlockNumber = 0;
|
|
pub const Period: BlockNumber = 1;
|
|
pub static SessionsPerEra: SessionIndex = 3;
|
|
pub static SlashDeferDuration: EraIndex = 0;
|
|
pub const BondingDuration: EraIndex = 3;
|
|
pub static LedgerSlashPerEra: (BalanceOf<Test>, BTreeMap<EraIndex, BalanceOf<Test>>) = (Zero::zero(), BTreeMap::new());
|
|
pub const OffendingValidatorsThreshold: Perbill = Perbill::from_percent(75);
|
|
}
|
|
|
|
impl pallet_staking::Config for Test {
|
|
type Currency = Balances;
|
|
type CurrencyBalance = <Self as pallet_balances::Config>::Balance;
|
|
type UnixTime = Timestamp;
|
|
type CurrencyToVote = ();
|
|
type RewardRemainder = ();
|
|
type RuntimeEvent = RuntimeEvent;
|
|
type Slash = ();
|
|
type Reward = ();
|
|
type SessionsPerEra = SessionsPerEra;
|
|
type SlashDeferDuration = SlashDeferDuration;
|
|
type AdminOrigin = frame_system::EnsureRoot<Self::AccountId>;
|
|
type BondingDuration = BondingDuration;
|
|
type SessionInterface = Self;
|
|
type EraPayout = pallet_staking::ConvertCurve<RewardCurve>;
|
|
type NextNewSession = Session;
|
|
type MaxExposurePageSize = ConstU32<64>;
|
|
type OffendingValidatorsThreshold = OffendingValidatorsThreshold;
|
|
type ElectionProvider = onchain::OnChainExecution<OnChainSeqPhragmen>;
|
|
type GenesisElectionProvider = Self::ElectionProvider;
|
|
type TargetList = pallet_staking::UseValidatorsMap<Self>;
|
|
type NominationsQuota = pallet_staking::FixedNominationsQuota<16>;
|
|
type MaxUnlockingChunks = ConstU32<32>;
|
|
type HistoryDepth = ConstU32<84>;
|
|
type MaxControllersInDeprecationBatch = ConstU32<100>;
|
|
type VoterList = pallet_staking::UseNominatorsAndValidatorsMap<Self>;
|
|
type EventListeners = ();
|
|
type BenchmarkingConfig = pallet_staking::TestBenchmarkingConfig;
|
|
type WeightInfo = ();
|
|
}
|
|
|
|
impl pallet_session::historical::Config for Test {
|
|
type FullIdentification = pallet_staking::Exposure<AccountId, Balance>;
|
|
type FullIdentificationOf = pallet_staking::ExposureOf<Test>;
|
|
}
|
|
|
|
sp_runtime::impl_opaque_keys! {
|
|
pub struct SessionKeys {
|
|
pub other: OtherSessionHandler,
|
|
}
|
|
}
|
|
|
|
impl pallet_session::Config for Test {
|
|
type SessionManager = pallet_session::historical::NoteHistoricalRoot<Test, Staking>;
|
|
type Keys = SessionKeys;
|
|
type ShouldEndSession = pallet_session::PeriodicSessions<Period, Offset>;
|
|
type SessionHandler = (OtherSessionHandler,);
|
|
type RuntimeEvent = RuntimeEvent;
|
|
type ValidatorId = AccountId;
|
|
type ValidatorIdOf = pallet_staking::StashOf<Test>;
|
|
type NextSessionRotation = pallet_session::PeriodicSessions<Period, Offset>;
|
|
type WeightInfo = ();
|
|
}
|
|
|
|
impl pallet_timestamp::Config for Test {
|
|
type Moment = u64;
|
|
type OnTimestampSet = ();
|
|
type MinimumPeriod = ConstU64<5>;
|
|
type WeightInfo = ();
|
|
}
|
|
|
|
impl Config for Test {
|
|
type RuntimeEvent = RuntimeEvent;
|
|
}
|
|
|
|
pub struct ExtBuilder {
|
|
validator_count: u32,
|
|
minimum_validator_count: u32,
|
|
invulnerables: Vec<AccountId>,
|
|
balance_factor: Balance,
|
|
}
|
|
|
|
impl Default for ExtBuilder {
|
|
fn default() -> Self {
|
|
Self {
|
|
validator_count: 2,
|
|
minimum_validator_count: 0,
|
|
invulnerables: vec![],
|
|
balance_factor: 1,
|
|
}
|
|
}
|
|
}
|
|
|
|
impl ExtBuilder {
|
|
fn build(self) -> sp_io::TestExternalities {
|
|
let mut storage = frame_system::GenesisConfig::<Test>::default().build_storage().unwrap();
|
|
|
|
pallet_balances::GenesisConfig::<Test> {
|
|
balances: vec![
|
|
// controllers (still used in some tests. Soon to be deprecated).
|
|
(10, self.balance_factor * 50),
|
|
(20, self.balance_factor * 50),
|
|
(30, self.balance_factor * 50),
|
|
(40, self.balance_factor * 50),
|
|
// stashes
|
|
(11, self.balance_factor * 1000),
|
|
(21, self.balance_factor * 1000),
|
|
(31, self.balance_factor * 500),
|
|
(41, self.balance_factor * 1000),
|
|
],
|
|
}
|
|
.assimilate_storage(&mut storage)
|
|
.unwrap();
|
|
|
|
let stakers = vec![
|
|
// (stash, ctrl, stake, status)
|
|
// these two will be elected in the default test where we elect 2.
|
|
(11, 11, 1000, StakerStatus::<AccountId>::Validator),
|
|
(21, 21, 1000, StakerStatus::<AccountId>::Validator),
|
|
// a loser validator
|
|
(31, 31, 500, StakerStatus::<AccountId>::Validator),
|
|
// an idle validator
|
|
(41, 41, 1000, StakerStatus::<AccountId>::Idle),
|
|
];
|
|
|
|
let _ = pallet_staking::GenesisConfig::<Test> {
|
|
stakers: stakers.clone(),
|
|
..Default::default()
|
|
};
|
|
|
|
let _ = pallet_staking::GenesisConfig::<Test> {
|
|
stakers: stakers.clone(),
|
|
validator_count: self.validator_count,
|
|
minimum_validator_count: self.minimum_validator_count,
|
|
invulnerables: self.invulnerables,
|
|
slash_reward_fraction: Perbill::from_percent(10),
|
|
..Default::default()
|
|
}
|
|
.assimilate_storage(&mut storage);
|
|
|
|
let _ = pallet_session::GenesisConfig::<Test> {
|
|
keys: stakers
|
|
.into_iter()
|
|
.map(|(id, ..)| (id, id, SessionKeys { other: id.into() }))
|
|
.collect(),
|
|
}
|
|
.assimilate_storage(&mut storage);
|
|
|
|
storage.into()
|
|
}
|
|
|
|
pub fn build_and_execute(self, test: impl FnOnce() -> ()) {
|
|
let mut ext = self.build();
|
|
ext.execute_with(test);
|
|
}
|
|
}
|
|
|
|
/// Progresses from the current block number (whatever that may be) to the `P * session_index + 1`.
|
|
pub(crate) fn start_session(session_index: SessionIndex) {
|
|
let end: u64 = if Offset::get().is_zero() {
|
|
(session_index as u64) * Period::get()
|
|
} else {
|
|
Offset::get() + (session_index.saturating_sub(1) as u64) * Period::get()
|
|
};
|
|
run_to_block(end);
|
|
// session must have progressed properly.
|
|
assert_eq!(
|
|
Session::current_index(),
|
|
session_index,
|
|
"current session index = {}, expected = {}",
|
|
Session::current_index(),
|
|
session_index,
|
|
);
|
|
}
|
|
|
|
/// Progress to the given block, triggering session and era changes as we progress.
|
|
///
|
|
/// This will finalize the previous block, initialize up to the given block, essentially simulating
|
|
/// a block import/propose process where we first initialize the block, then execute some stuff (not
|
|
/// in the function), and then finalize the block.
|
|
pub(crate) fn run_to_block(n: BlockNumber) {
|
|
Staking::on_finalize(System::block_number());
|
|
for b in (System::block_number() + 1)..=n {
|
|
System::set_block_number(b);
|
|
Session::on_initialize(b);
|
|
<Staking as Hooks<u64>>::on_initialize(b);
|
|
Timestamp::set_timestamp(System::block_number() * BLOCK_TIME + INIT_TIMESTAMP);
|
|
if b != n {
|
|
Staking::on_finalize(System::block_number());
|
|
}
|
|
}
|
|
}
|
|
|
|
pub(crate) fn active_era() -> EraIndex {
|
|
Staking::active_era().unwrap().index
|
|
}
|