mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-05-31 07:31:02 +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>
740 lines
22 KiB
Rust
740 lines
22 KiB
Rust
// Copyright (C) Parity Technologies (UK) Ltd.
|
|
// This file is part of Polkadot.
|
|
|
|
// Polkadot is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
|
|
// Polkadot is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with Polkadot. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
//! Mocks for all the traits.
|
|
|
|
use crate::{
|
|
assigner_coretime, assigner_on_demand, assigner_parachains, configuration, coretime, disputes,
|
|
dmp, hrmp,
|
|
inclusion::{self, AggregateMessageOrigin, UmpQueueId},
|
|
initializer, origin, paras,
|
|
paras::ParaKind,
|
|
paras_inherent, scheduler,
|
|
scheduler::common::{AssignmentProvider, AssignmentProviderConfig},
|
|
session_info, shared, ParaId,
|
|
};
|
|
use frame_support::pallet_prelude::*;
|
|
use primitives::CoreIndex;
|
|
|
|
use frame_support::{
|
|
assert_ok, derive_impl, parameter_types,
|
|
traits::{
|
|
Currency, ProcessMessage, ProcessMessageError, ValidatorSet, ValidatorSetWithIdentification,
|
|
},
|
|
weights::{Weight, WeightMeter},
|
|
};
|
|
use frame_support_test::TestRandomness;
|
|
use frame_system::limits;
|
|
use parity_scale_codec::Decode;
|
|
use primitives::{
|
|
AuthorityDiscoveryId, Balance, BlockNumber, CandidateHash, Moment, SessionIndex, UpwardMessage,
|
|
ValidationCode, ValidatorIndex,
|
|
};
|
|
use sp_core::{ConstU32, H256};
|
|
use sp_io::TestExternalities;
|
|
use sp_runtime::{
|
|
traits::{AccountIdConversion, BlakeTwo256, IdentityLookup},
|
|
transaction_validity::TransactionPriority,
|
|
BuildStorage, FixedU128, Perbill, Permill,
|
|
};
|
|
use sp_std::collections::vec_deque::VecDeque;
|
|
use std::{cell::RefCell, collections::HashMap};
|
|
use xcm::v4::{Assets, Location, SendError, SendResult, SendXcm, Xcm, XcmHash};
|
|
|
|
type UncheckedExtrinsic = frame_system::mocking::MockUncheckedExtrinsic<Test>;
|
|
type Block = frame_system::mocking::MockBlockU32<Test>;
|
|
|
|
frame_support::construct_runtime!(
|
|
pub enum Test
|
|
{
|
|
System: frame_system,
|
|
Balances: pallet_balances,
|
|
MessageQueue: pallet_message_queue,
|
|
Paras: paras,
|
|
Configuration: configuration,
|
|
ParasShared: shared,
|
|
ParaInclusion: inclusion,
|
|
ParaInherent: paras_inherent,
|
|
Scheduler: scheduler,
|
|
MockAssigner: mock_assigner,
|
|
ParachainsAssigner: assigner_parachains,
|
|
OnDemandAssigner: assigner_on_demand,
|
|
CoretimeAssigner: assigner_coretime,
|
|
Coretime: coretime,
|
|
Initializer: initializer,
|
|
Dmp: dmp,
|
|
Hrmp: hrmp,
|
|
ParachainsOrigin: origin,
|
|
SessionInfo: session_info,
|
|
Disputes: disputes,
|
|
Babe: pallet_babe,
|
|
}
|
|
);
|
|
|
|
impl<C> frame_system::offchain::SendTransactionTypes<C> for Test
|
|
where
|
|
RuntimeCall: From<C>,
|
|
{
|
|
type Extrinsic = UncheckedExtrinsic;
|
|
type OverarchingCall = RuntimeCall;
|
|
}
|
|
|
|
parameter_types! {
|
|
pub const BlockHashCount: u32 = 250;
|
|
pub static BlockWeights: frame_system::limits::BlockWeights =
|
|
frame_system::limits::BlockWeights::simple_max(
|
|
Weight::from_parts(4 * 1024 * 1024, u64::MAX),
|
|
);
|
|
pub static BlockLength: limits::BlockLength = limits::BlockLength::max_with_normal_ratio(u32::MAX, Perbill::from_percent(75));
|
|
}
|
|
|
|
pub type AccountId = u64;
|
|
|
|
#[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 = BlockWeights;
|
|
type BlockLength = BlockLength;
|
|
type DbWeight = ();
|
|
type RuntimeOrigin = RuntimeOrigin;
|
|
type RuntimeCall = RuntimeCall;
|
|
type Nonce = u64;
|
|
type Hash = H256;
|
|
type Hashing = BlakeTwo256;
|
|
type AccountId = u64;
|
|
type Lookup = IdentityLookup<u64>;
|
|
type Block = Block;
|
|
type RuntimeEvent = RuntimeEvent;
|
|
type BlockHashCount = BlockHashCount;
|
|
type Version = ();
|
|
type PalletInfo = PalletInfo;
|
|
type AccountData = pallet_balances::AccountData<u128>;
|
|
type OnNewAccount = ();
|
|
type OnKilledAccount = ();
|
|
type SystemWeightInfo = ();
|
|
type SS58Prefix = ();
|
|
type OnSetCode = ();
|
|
type MaxConsumers = ConstU32<16>;
|
|
}
|
|
|
|
parameter_types! {
|
|
pub static ExistentialDeposit: u64 = 1;
|
|
}
|
|
|
|
impl pallet_balances::Config for Test {
|
|
type MaxLocks = ();
|
|
type MaxReserves = ();
|
|
type ReserveIdentifier = [u8; 8];
|
|
type Balance = Balance;
|
|
type RuntimeEvent = RuntimeEvent;
|
|
type DustRemoval = ();
|
|
type ExistentialDeposit = ExistentialDeposit;
|
|
type AccountStore = System;
|
|
type WeightInfo = ();
|
|
type RuntimeHoldReason = RuntimeHoldReason;
|
|
type RuntimeFreezeReason = RuntimeFreezeReason;
|
|
type FreezeIdentifier = ();
|
|
type MaxFreezes = ConstU32<0>;
|
|
}
|
|
|
|
parameter_types! {
|
|
pub const EpochDuration: u64 = 10;
|
|
pub const ExpectedBlockTime: Moment = 6_000;
|
|
pub const ReportLongevity: u64 = 10;
|
|
pub const MaxAuthorities: u32 = 100_000;
|
|
}
|
|
|
|
impl pallet_babe::Config for Test {
|
|
type EpochDuration = EpochDuration;
|
|
type ExpectedBlockTime = ExpectedBlockTime;
|
|
|
|
// session module is the trigger
|
|
type EpochChangeTrigger = pallet_babe::ExternalTrigger;
|
|
type DisabledValidators = ();
|
|
type WeightInfo = ();
|
|
type MaxAuthorities = MaxAuthorities;
|
|
type MaxNominators = ConstU32<0>;
|
|
type KeyOwnerProof = sp_core::Void;
|
|
type EquivocationReportSystem = ();
|
|
}
|
|
|
|
parameter_types! {
|
|
pub const MinimumPeriod: Moment = 6_000 / 2;
|
|
}
|
|
|
|
impl pallet_timestamp::Config for Test {
|
|
type Moment = Moment;
|
|
type OnTimestampSet = ();
|
|
type MinimumPeriod = MinimumPeriod;
|
|
type WeightInfo = ();
|
|
}
|
|
|
|
impl crate::initializer::Config for Test {
|
|
type Randomness = TestRandomness<Self>;
|
|
type ForceOrigin = frame_system::EnsureRoot<u64>;
|
|
type WeightInfo = ();
|
|
type CoretimeOnNewSession = Coretime;
|
|
}
|
|
|
|
impl crate::configuration::Config for Test {
|
|
type WeightInfo = crate::configuration::TestWeightInfo;
|
|
}
|
|
|
|
pub struct MockDisabledValidators {}
|
|
impl frame_support::traits::DisabledValidators for MockDisabledValidators {
|
|
/// Returns true if the given validator is disabled.
|
|
fn is_disabled(index: u32) -> bool {
|
|
disabled_validators().iter().any(|v| *v == index)
|
|
}
|
|
|
|
/// Returns a hardcoded list (`DISABLED_VALIDATORS`) of disabled validators
|
|
fn disabled_validators() -> Vec<u32> {
|
|
disabled_validators()
|
|
}
|
|
}
|
|
|
|
impl crate::shared::Config for Test {
|
|
type DisabledValidators = MockDisabledValidators;
|
|
}
|
|
|
|
impl origin::Config for Test {}
|
|
|
|
parameter_types! {
|
|
pub const ParasUnsignedPriority: TransactionPriority = TransactionPriority::max_value();
|
|
}
|
|
|
|
/// A very dumb implementation of `EstimateNextSessionRotation`. At the moment of writing, this
|
|
/// is more to satisfy type requirements rather than to test anything.
|
|
pub struct TestNextSessionRotation;
|
|
|
|
impl frame_support::traits::EstimateNextSessionRotation<u32> for TestNextSessionRotation {
|
|
fn average_session_length() -> u32 {
|
|
10
|
|
}
|
|
|
|
fn estimate_current_session_progress(_now: u32) -> (Option<Permill>, Weight) {
|
|
(None, Weight::zero())
|
|
}
|
|
|
|
fn estimate_next_session_rotation(_now: u32) -> (Option<u32>, Weight) {
|
|
(None, Weight::zero())
|
|
}
|
|
}
|
|
|
|
impl crate::paras::Config for Test {
|
|
type RuntimeEvent = RuntimeEvent;
|
|
type WeightInfo = crate::paras::TestWeightInfo;
|
|
type UnsignedPriority = ParasUnsignedPriority;
|
|
type QueueFootprinter = ParaInclusion;
|
|
type NextSessionRotation = TestNextSessionRotation;
|
|
type OnNewHead = ();
|
|
type AssignCoretime = ();
|
|
}
|
|
|
|
impl crate::dmp::Config for Test {}
|
|
|
|
parameter_types! {
|
|
pub const FirstMessageFactorPercent: u64 = 100;
|
|
}
|
|
|
|
impl crate::hrmp::Config for Test {
|
|
type RuntimeOrigin = RuntimeOrigin;
|
|
type RuntimeEvent = RuntimeEvent;
|
|
type ChannelManager = frame_system::EnsureRoot<u64>;
|
|
type Currency = pallet_balances::Pallet<Test>;
|
|
type WeightInfo = crate::hrmp::TestWeightInfo;
|
|
}
|
|
|
|
impl crate::disputes::Config for Test {
|
|
type RuntimeEvent = RuntimeEvent;
|
|
type RewardValidators = Self;
|
|
type SlashingHandler = Self;
|
|
type WeightInfo = crate::disputes::TestWeightInfo;
|
|
}
|
|
|
|
thread_local! {
|
|
pub static REWARD_VALIDATORS: RefCell<Vec<(SessionIndex, Vec<ValidatorIndex>)>> = RefCell::new(Vec::new());
|
|
pub static PUNISH_VALIDATORS_FOR: RefCell<Vec<(SessionIndex, Vec<ValidatorIndex>)>> = RefCell::new(Vec::new());
|
|
pub static PUNISH_VALIDATORS_AGAINST: RefCell<Vec<(SessionIndex, Vec<ValidatorIndex>)>> = RefCell::new(Vec::new());
|
|
pub static PUNISH_BACKERS_FOR: RefCell<Vec<(SessionIndex, Vec<ValidatorIndex>)>> = RefCell::new(Vec::new());
|
|
}
|
|
|
|
impl crate::disputes::RewardValidators for Test {
|
|
fn reward_dispute_statement(
|
|
session: SessionIndex,
|
|
validators: impl IntoIterator<Item = ValidatorIndex>,
|
|
) {
|
|
REWARD_VALIDATORS.with(|r| r.borrow_mut().push((session, validators.into_iter().collect())))
|
|
}
|
|
}
|
|
|
|
impl crate::disputes::SlashingHandler<BlockNumber> for Test {
|
|
fn punish_for_invalid(
|
|
session: SessionIndex,
|
|
_: CandidateHash,
|
|
losers: impl IntoIterator<Item = ValidatorIndex>,
|
|
backers: impl IntoIterator<Item = ValidatorIndex>,
|
|
) {
|
|
PUNISH_VALIDATORS_FOR
|
|
.with(|r| r.borrow_mut().push((session, losers.into_iter().collect())));
|
|
PUNISH_BACKERS_FOR.with(|r| r.borrow_mut().push((session, backers.into_iter().collect())));
|
|
}
|
|
|
|
fn punish_against_valid(
|
|
session: SessionIndex,
|
|
_: CandidateHash,
|
|
losers: impl IntoIterator<Item = ValidatorIndex>,
|
|
_backers: impl IntoIterator<Item = ValidatorIndex>,
|
|
) {
|
|
PUNISH_VALIDATORS_AGAINST
|
|
.with(|r| r.borrow_mut().push((session, losers.into_iter().collect())))
|
|
}
|
|
|
|
fn initializer_initialize(_now: BlockNumber) -> Weight {
|
|
Weight::zero()
|
|
}
|
|
|
|
fn initializer_finalize() {}
|
|
|
|
fn initializer_on_new_session(_: SessionIndex) {}
|
|
}
|
|
|
|
impl crate::scheduler::Config for Test {
|
|
type AssignmentProvider = MockAssigner;
|
|
}
|
|
|
|
pub struct TestMessageQueueWeight;
|
|
impl pallet_message_queue::WeightInfo for TestMessageQueueWeight {
|
|
fn ready_ring_knit() -> Weight {
|
|
Weight::zero()
|
|
}
|
|
fn ready_ring_unknit() -> Weight {
|
|
Weight::zero()
|
|
}
|
|
fn service_queue_base() -> Weight {
|
|
Weight::zero()
|
|
}
|
|
fn service_page_base_completion() -> Weight {
|
|
Weight::zero()
|
|
}
|
|
fn service_page_base_no_completion() -> Weight {
|
|
Weight::zero()
|
|
}
|
|
fn service_page_item() -> Weight {
|
|
Weight::zero()
|
|
}
|
|
fn bump_service_head() -> Weight {
|
|
Weight::zero()
|
|
}
|
|
fn reap_page() -> Weight {
|
|
Weight::zero()
|
|
}
|
|
fn execute_overweight_page_removed() -> Weight {
|
|
Weight::zero()
|
|
}
|
|
fn execute_overweight_page_updated() -> Weight {
|
|
Weight::zero()
|
|
}
|
|
}
|
|
parameter_types! {
|
|
pub const MessageQueueServiceWeight: Weight = Weight::from_all(500);
|
|
}
|
|
|
|
pub type MessageQueueSize = u32;
|
|
|
|
impl pallet_message_queue::Config for Test {
|
|
type Size = MessageQueueSize;
|
|
type RuntimeEvent = RuntimeEvent;
|
|
type WeightInfo = TestMessageQueueWeight;
|
|
type MessageProcessor = TestProcessMessage;
|
|
type QueueChangeHandler = ParaInclusion;
|
|
type QueuePausedQuery = ();
|
|
type HeapSize = ConstU32<65536>;
|
|
type MaxStale = ConstU32<8>;
|
|
type ServiceWeight = MessageQueueServiceWeight;
|
|
}
|
|
|
|
parameter_types! {
|
|
pub const OnDemandTrafficDefaultValue: FixedU128 = FixedU128::from_u32(1);
|
|
}
|
|
|
|
impl assigner_parachains::Config for Test {}
|
|
|
|
impl assigner_on_demand::Config for Test {
|
|
type RuntimeEvent = RuntimeEvent;
|
|
type Currency = Balances;
|
|
type TrafficDefaultValue = OnDemandTrafficDefaultValue;
|
|
type WeightInfo = crate::assigner_on_demand::TestWeightInfo;
|
|
}
|
|
|
|
impl assigner_coretime::Config for Test {}
|
|
|
|
parameter_types! {
|
|
pub const BrokerId: u32 = 10u32;
|
|
}
|
|
|
|
impl coretime::Config for Test {
|
|
type RuntimeOrigin = RuntimeOrigin;
|
|
type RuntimeEvent = RuntimeEvent;
|
|
type Currency = pallet_balances::Pallet<Test>;
|
|
type BrokerId = BrokerId;
|
|
type WeightInfo = crate::coretime::TestWeightInfo;
|
|
type SendXcm = DummyXcmSender;
|
|
}
|
|
|
|
pub struct DummyXcmSender;
|
|
impl SendXcm for DummyXcmSender {
|
|
type Ticket = ();
|
|
fn validate(_: &mut Option<Location>, _: &mut Option<Xcm<()>>) -> SendResult<Self::Ticket> {
|
|
Ok(((), Assets::new()))
|
|
}
|
|
|
|
/// Actually carry out the delivery operation for a previously validated message sending.
|
|
fn deliver(_ticket: Self::Ticket) -> Result<XcmHash, SendError> {
|
|
Ok([0u8; 32])
|
|
}
|
|
}
|
|
|
|
impl crate::inclusion::Config for Test {
|
|
type WeightInfo = ();
|
|
type RuntimeEvent = RuntimeEvent;
|
|
type DisputesHandler = Disputes;
|
|
type RewardValidators = TestRewardValidators;
|
|
type MessageQueue = MessageQueue;
|
|
}
|
|
|
|
impl crate::paras_inherent::Config for Test {
|
|
type WeightInfo = crate::paras_inherent::TestWeightInfo;
|
|
}
|
|
|
|
pub struct MockValidatorSet;
|
|
|
|
impl ValidatorSet<AccountId> for MockValidatorSet {
|
|
type ValidatorId = AccountId;
|
|
type ValidatorIdOf = ValidatorIdOf;
|
|
fn session_index() -> SessionIndex {
|
|
0
|
|
}
|
|
fn validators() -> Vec<Self::ValidatorId> {
|
|
Vec::new()
|
|
}
|
|
}
|
|
|
|
impl ValidatorSetWithIdentification<AccountId> for MockValidatorSet {
|
|
type Identification = ();
|
|
type IdentificationOf = FoolIdentificationOf;
|
|
}
|
|
|
|
/// A mock assigner which acts as the scheduler's `AssignmentProvider` for tests. The mock
|
|
/// assigner provides bare minimum functionality to test scheduler internals. Since they
|
|
/// have no direct effect on scheduler state, AssignmentProvider functions such as
|
|
/// `push_back_assignment` can be left empty.
|
|
pub mod mock_assigner {
|
|
use crate::scheduler::common::Assignment;
|
|
|
|
use super::*;
|
|
pub use pallet::*;
|
|
|
|
#[frame_support::pallet]
|
|
pub mod pallet {
|
|
use super::*;
|
|
|
|
#[pallet::pallet]
|
|
#[pallet::without_storage_info]
|
|
pub struct Pallet<T>(_);
|
|
|
|
#[pallet::config]
|
|
pub trait Config: frame_system::Config + configuration::Config + paras::Config {}
|
|
|
|
#[pallet::storage]
|
|
pub(super) type MockAssignmentQueue<T: Config> =
|
|
StorageValue<_, VecDeque<Assignment>, ValueQuery>;
|
|
|
|
#[pallet::storage]
|
|
pub(super) type MockProviderConfig<T: Config> =
|
|
StorageValue<_, AssignmentProviderConfig<BlockNumber>, OptionQuery>;
|
|
|
|
#[pallet::storage]
|
|
pub(super) type MockCoreCount<T: Config> = StorageValue<_, u32, OptionQuery>;
|
|
}
|
|
|
|
impl<T: Config> Pallet<T> {
|
|
/// Adds a claim to the `MockAssignmentQueue` this claim can later be popped by the
|
|
/// scheduler when filling the claim queue for tests.
|
|
pub fn add_test_assignment(assignment: Assignment) {
|
|
MockAssignmentQueue::<T>::mutate(|queue| queue.push_back(assignment));
|
|
}
|
|
|
|
// This configuration needs to be customized to service `get_provider_config` in
|
|
// scheduler tests.
|
|
pub fn set_assignment_provider_config(config: AssignmentProviderConfig<BlockNumber>) {
|
|
MockProviderConfig::<T>::set(Some(config));
|
|
}
|
|
|
|
// Allows for customized core count in scheduler tests, rather than a core count
|
|
// derived from on-demand config + parachain count.
|
|
pub fn set_core_count(count: u32) {
|
|
MockCoreCount::<T>::set(Some(count));
|
|
}
|
|
}
|
|
|
|
impl<T: Config> AssignmentProvider<BlockNumber> for Pallet<T> {
|
|
// With regards to popping_assignments, the scheduler just needs to be tested under
|
|
// the following two conditions:
|
|
// 1. An assignment is provided
|
|
// 2. No assignment is provided
|
|
// A simple assignment queue populated to fit each test fulfills these needs.
|
|
fn pop_assignment_for_core(_core_idx: CoreIndex) -> Option<Assignment> {
|
|
let mut queue: VecDeque<Assignment> = MockAssignmentQueue::<T>::get();
|
|
let front = queue.pop_front();
|
|
// Write changes to storage.
|
|
MockAssignmentQueue::<T>::set(queue);
|
|
front
|
|
}
|
|
|
|
// We don't care about core affinity in the test assigner
|
|
fn report_processed(_assignment: Assignment) {}
|
|
|
|
// The results of this are tested in assigner_on_demand tests. No need to represent it
|
|
// in the mock assigner.
|
|
fn push_back_assignment(_assignment: Assignment) {}
|
|
|
|
// Gets the provider config we set earlier using `set_assignment_provider_config`, falling
|
|
// back to the on demand parachain configuration if none was set.
|
|
fn get_provider_config(_core_idx: CoreIndex) -> AssignmentProviderConfig<BlockNumber> {
|
|
match MockProviderConfig::<T>::get() {
|
|
Some(config) => config,
|
|
None => AssignmentProviderConfig {
|
|
max_availability_timeouts: 1,
|
|
ttl: BlockNumber::from(5u32),
|
|
},
|
|
}
|
|
}
|
|
#[cfg(any(feature = "runtime-benchmarks", test))]
|
|
fn get_mock_assignment(_: CoreIndex, para_id: ParaId) -> Assignment {
|
|
Assignment::Bulk(para_id)
|
|
}
|
|
|
|
fn session_core_count() -> u32 {
|
|
MockCoreCount::<T>::get().unwrap_or(5)
|
|
}
|
|
}
|
|
}
|
|
|
|
impl mock_assigner::pallet::Config for Test {}
|
|
|
|
pub struct FoolIdentificationOf;
|
|
impl sp_runtime::traits::Convert<AccountId, Option<()>> for FoolIdentificationOf {
|
|
fn convert(_: AccountId) -> Option<()> {
|
|
Some(())
|
|
}
|
|
}
|
|
|
|
pub struct ValidatorIdOf;
|
|
impl sp_runtime::traits::Convert<AccountId, Option<AccountId>> for ValidatorIdOf {
|
|
fn convert(a: AccountId) -> Option<AccountId> {
|
|
Some(a)
|
|
}
|
|
}
|
|
|
|
impl crate::session_info::Config for Test {
|
|
type ValidatorSet = MockValidatorSet;
|
|
}
|
|
|
|
thread_local! {
|
|
pub static DISCOVERY_AUTHORITIES: RefCell<Vec<AuthorityDiscoveryId>> = RefCell::new(Vec::new());
|
|
}
|
|
|
|
pub fn discovery_authorities() -> Vec<AuthorityDiscoveryId> {
|
|
DISCOVERY_AUTHORITIES.with(|r| r.borrow().clone())
|
|
}
|
|
|
|
pub fn set_discovery_authorities(new: Vec<AuthorityDiscoveryId>) {
|
|
DISCOVERY_AUTHORITIES.with(|r| *r.borrow_mut() = new);
|
|
}
|
|
|
|
impl crate::session_info::AuthorityDiscoveryConfig for Test {
|
|
fn authorities() -> Vec<AuthorityDiscoveryId> {
|
|
discovery_authorities()
|
|
}
|
|
}
|
|
|
|
thread_local! {
|
|
pub static BACKING_REWARDS: RefCell<HashMap<ValidatorIndex, usize>>
|
|
= RefCell::new(HashMap::new());
|
|
|
|
pub static AVAILABILITY_REWARDS: RefCell<HashMap<ValidatorIndex, usize>>
|
|
= RefCell::new(HashMap::new());
|
|
|
|
pub static DISABLED_VALIDATORS: RefCell<Vec<u32>> = RefCell::new(vec![]);
|
|
}
|
|
|
|
pub fn backing_rewards() -> HashMap<ValidatorIndex, usize> {
|
|
BACKING_REWARDS.with(|r| r.borrow().clone())
|
|
}
|
|
|
|
pub fn availability_rewards() -> HashMap<ValidatorIndex, usize> {
|
|
AVAILABILITY_REWARDS.with(|r| r.borrow().clone())
|
|
}
|
|
|
|
pub fn disabled_validators() -> Vec<u32> {
|
|
DISABLED_VALIDATORS.with(|r| r.borrow().clone())
|
|
}
|
|
|
|
parameter_types! {
|
|
pub static Processed: Vec<(ParaId, UpwardMessage)> = vec![];
|
|
}
|
|
|
|
/// An implementation of a UMP sink that just records which messages were processed.
|
|
///
|
|
/// A message's weight is defined by the first 4 bytes of its data, which we decode into a
|
|
/// `u32`.
|
|
pub struct TestProcessMessage;
|
|
impl ProcessMessage for TestProcessMessage {
|
|
type Origin = AggregateMessageOrigin;
|
|
|
|
fn process_message(
|
|
message: &[u8],
|
|
origin: AggregateMessageOrigin,
|
|
meter: &mut WeightMeter,
|
|
_id: &mut [u8; 32],
|
|
) -> Result<bool, ProcessMessageError> {
|
|
let para = match origin {
|
|
AggregateMessageOrigin::Ump(UmpQueueId::Para(p)) => p,
|
|
};
|
|
|
|
let required = match u32::decode(&mut &message[..]) {
|
|
Ok(w) => Weight::from_parts(w as u64, w as u64),
|
|
Err(_) => return Err(ProcessMessageError::Corrupt), // same as the real `ProcessMessage`
|
|
};
|
|
if meter.try_consume(required).is_err() {
|
|
return Err(ProcessMessageError::Overweight(required))
|
|
}
|
|
|
|
let mut processed = Processed::get();
|
|
processed.push((para, message.to_vec()));
|
|
Processed::set(processed);
|
|
Ok(true)
|
|
}
|
|
}
|
|
|
|
pub struct TestRewardValidators;
|
|
|
|
impl inclusion::RewardValidators for TestRewardValidators {
|
|
fn reward_backing(v: impl IntoIterator<Item = ValidatorIndex>) {
|
|
BACKING_REWARDS.with(|r| {
|
|
let mut r = r.borrow_mut();
|
|
for i in v {
|
|
*r.entry(i).or_insert(0) += 1;
|
|
}
|
|
})
|
|
}
|
|
fn reward_bitfields(v: impl IntoIterator<Item = ValidatorIndex>) {
|
|
AVAILABILITY_REWARDS.with(|r| {
|
|
let mut r = r.borrow_mut();
|
|
for i in v {
|
|
*r.entry(i).or_insert(0) += 1;
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
/// Create a new set of test externalities.
|
|
pub fn new_test_ext(state: MockGenesisConfig) -> TestExternalities {
|
|
use sp_keystore::{testing::MemoryKeystore, KeystoreExt, KeystorePtr};
|
|
use sp_std::sync::Arc;
|
|
|
|
sp_tracing::try_init_simple();
|
|
|
|
BACKING_REWARDS.with(|r| r.borrow_mut().clear());
|
|
AVAILABILITY_REWARDS.with(|r| r.borrow_mut().clear());
|
|
|
|
let mut t = state.system.build_storage().unwrap();
|
|
state.configuration.assimilate_storage(&mut t).unwrap();
|
|
state.paras.assimilate_storage(&mut t).unwrap();
|
|
|
|
let mut ext: TestExternalities = t.into();
|
|
ext.register_extension(KeystoreExt(Arc::new(MemoryKeystore::new()) as KeystorePtr));
|
|
|
|
ext
|
|
}
|
|
|
|
#[derive(Default)]
|
|
pub struct MockGenesisConfig {
|
|
pub system: frame_system::GenesisConfig<Test>,
|
|
pub configuration: crate::configuration::GenesisConfig<Test>,
|
|
pub paras: crate::paras::GenesisConfig<Test>,
|
|
}
|
|
|
|
pub fn assert_last_event(generic_event: RuntimeEvent) {
|
|
let events = frame_system::Pallet::<Test>::events();
|
|
let system_event: <Test as frame_system::Config>::RuntimeEvent = generic_event.into();
|
|
// compare to the last event record
|
|
let frame_system::EventRecord { event, .. } = &events[events.len() - 1];
|
|
assert_eq!(event, &system_event);
|
|
}
|
|
|
|
pub fn assert_last_events<E>(generic_events: E)
|
|
where
|
|
E: DoubleEndedIterator<Item = RuntimeEvent> + ExactSizeIterator,
|
|
{
|
|
for (i, (got, want)) in frame_system::Pallet::<Test>::events()
|
|
.into_iter()
|
|
.rev()
|
|
.map(|e| e.event)
|
|
.zip(generic_events.rev().map(<Test as frame_system::Config>::RuntimeEvent::from))
|
|
.rev()
|
|
.enumerate()
|
|
{
|
|
assert_eq!((i, got), (i, want));
|
|
}
|
|
}
|
|
|
|
pub(crate) fn register_parachain_with_balance(id: ParaId, balance: Balance) {
|
|
let validation_code: ValidationCode = vec![1].into();
|
|
assert_ok!(Paras::schedule_para_initialize(
|
|
id,
|
|
crate::paras::ParaGenesisArgs {
|
|
para_kind: ParaKind::Parachain,
|
|
genesis_head: vec![1].into(),
|
|
validation_code: validation_code.clone(),
|
|
},
|
|
));
|
|
|
|
assert_ok!(Paras::add_trusted_validation_code(RuntimeOrigin::root(), validation_code));
|
|
<Test as crate::hrmp::Config>::Currency::make_free_balance_be(
|
|
&id.into_account_truncating(),
|
|
balance,
|
|
);
|
|
}
|
|
|
|
pub(crate) fn register_parachain(id: ParaId) {
|
|
register_parachain_with_balance(id, 1000);
|
|
}
|
|
|
|
pub(crate) fn deregister_parachain(id: ParaId) {
|
|
assert_ok!(Paras::schedule_para_cleanup(id));
|
|
}
|
|
|
|
/// Calls `schedule_para_cleanup` in a new storage transactions, since it assumes rollback on error.
|
|
pub(crate) fn try_deregister_parachain(id: ParaId) -> crate::DispatchResult {
|
|
frame_support::storage::transactional::with_storage_layer(|| Paras::schedule_para_cleanup(id))
|
|
}
|
|
|
|
pub(crate) fn set_disabled_validators(disabled: Vec<u32>) {
|
|
DISABLED_VALIDATORS.with(|d| *d.borrow_mut() = disabled)
|
|
}
|