gear_common/

pallet_tests.rs

// This file is part of Gear.

// Copyright (C) 2023-2025 Gear Technologies Inc.
// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0

// This program 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.

// This program 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 this program. If not, see <https://www.gnu.org/licenses/>.

//! Module contains macros that help to implement Config type
//! for various pallets of Substrate.
//! All used types should be in scope.

use frame_support::{pallet_prelude::*, sp_runtime::Perbill, weights::RuntimeDbWeight};
use frame_system::limits::BlockWeights;

#[macro_export]
macro_rules! impl_pallet_balances {
    ($( $tokens:tt )*) => {
        #[allow(dead_code)]
        type BalancesConfigDustRemoval = ();

        mod pallet_tests_balances_config_impl {
            use super::*;

            $crate::impl_pallet_balances_inner!($( $tokens )*);
        }
    };
}

#[macro_export]
macro_rules! impl_pallet_balances_inner {
    ($runtime:ty) => {
        impl pallet_balances::Config for $runtime {
            type MaxLocks = ();
            type MaxFreezes = ConstU32<1>;
            type MaxReserves = ();
            type RuntimeFreezeReason = RuntimeFreezeReason;
            type FreezeIdentifier = RuntimeFreezeReason;
            type RuntimeHoldReason = RuntimeHoldReason;
            type ReserveIdentifier = [u8; 8];
            type Balance = Balance;
            type DustRemoval = BalancesConfigDustRemoval;
            type RuntimeEvent = RuntimeEvent;
            type ExistentialDeposit = ExistentialDeposit;
            type AccountStore = System;
            type WeightInfo = ();
        }
    };

    ($runtime:ty, DustRemoval = $dust_removal:ty $(, $( $rest:tt )*)?) => {
        type BalancesConfigDustRemoval = $dust_removal;

        $crate::impl_pallet_balances_inner!($runtime $(, $( $rest )*)?);
    };
}

pub const NORMAL_DISPATCH_WEIGHT_RATIO: Perbill = Perbill::from_percent(75);
pub const MAX_BLOCK: u64 = 250_000_000_000;

frame_support::parameter_types! {
    pub RuntimeBlockWeights: BlockWeights = BlockWeights::with_sensible_defaults(
        Weight::from_parts(MAX_BLOCK, u64::MAX),
        NORMAL_DISPATCH_WEIGHT_RATIO,
    );
    pub const SS58Prefix: u8 = 42;
    pub const DbWeight: RuntimeDbWeight = RuntimeDbWeight { read: 1_110, write: 2_300 };
    pub const MinimumPeriod: u64 = 500;
}

#[macro_export]
macro_rules! impl_pallet_system {
    ($( $tokens:tt )*) => {
        #[allow(dead_code)]
        type SystemConfigDbWeight = $crate::pallet_tests::DbWeight;
        #[allow(dead_code)]
        type SystemConfigBlockWeights = $crate::pallet_tests::RuntimeBlockWeights;

        mod pallet_tests_system_config_impl {
            use super::*;

            $crate::impl_pallet_system_inner!($( $tokens )*);
        }
    };
}

#[macro_export]
macro_rules! impl_pallet_system_inner {
    ($runtime:ty$(,)?) => {
        impl frame_system::Config for $runtime {
            type BaseCallFilter = frame_support::traits::Everything;
            type BlockWeights = SystemConfigBlockWeights;
            type BlockLength = ();
            type DbWeight = SystemConfigDbWeight;
            type RuntimeOrigin = RuntimeOrigin;
            type RuntimeCall = RuntimeCall;
            type Nonce = u64;
            type Hash = H256;
            type Hashing = BlakeTwo256;
            type AccountId = AccountId;
            type Lookup = IdentityLookup<Self::AccountId>;
            type Block = Block;
            type RuntimeEvent = RuntimeEvent;
            type BlockHashCount = BlockHashCount;
            type RuntimeTask = ();
            type Version = ();
            type PalletInfo = PalletInfo;
            type AccountData = pallet_balances::AccountData<Balance>;
            type OnNewAccount = ();
            type OnKilledAccount = ();
            type SystemWeightInfo = ();
            type SS58Prefix = $crate::pallet_tests::SS58Prefix;
            type OnSetCode = ();
            type MaxConsumers = frame_support::traits::ConstU32<16>;
            type MultiBlockMigrator = ();
            type SingleBlockMigrations = ();
            type PreInherents = ();
            type PostInherents = ();
            type PostTransactions = ();
        }
    };

    ($runtime:ty, DbWeight = $db_weight:ty $(, $( $rest:tt )*)?) => {
        type SystemConfigDbWeight = $db_weight;

        $crate::impl_pallet_system_inner!($runtime, $($( $rest )*)?);
    };

    ($runtime:ty, BlockWeights = $block_weights:ty $(, $( $rest:tt )*)?) => {
        type SystemConfigBlockWeights = $block_weights;

        $crate::impl_pallet_system_inner!($runtime, $($( $rest )*)?);
    };
}

#[macro_export]
macro_rules! impl_pallet_timestamp {
    ($runtime:ty) => {
        impl pallet_timestamp::Config for Test {
            type Moment = u64;
            type OnTimestampSet = ();
            type MinimumPeriod = $crate::pallet_tests::MinimumPeriod;
            type WeightInfo = ();
        }
    };
}

#[macro_export]
macro_rules! impl_pallet_authorship {
    ($( $tokens:tt )*) => {
        #[allow(dead_code)]
        pub struct FixedBlockAuthor;

        impl FindAuthor<AccountId> for FixedBlockAuthor {
            fn find_author<'a, I: 'a>(_: I) -> Option<AccountId> {
                Some(BLOCK_AUTHOR)
            }
        }

        #[allow(dead_code)]
        type AuthorshipFindAuthor = FixedBlockAuthor;
        #[allow(dead_code)]
        type AuthorshipEventHandler = ();

        mod pallet_tests_authorship_config_impl {
            use super::*;

            $crate::impl_pallet_authorship_inner!($( $tokens )*);
        }
    };
}

#[macro_export]
macro_rules! impl_pallet_authorship_inner {
    ($runtime:ty$(,)?) => {
        impl pallet_authorship::Config for $runtime {
            type FindAuthor = AuthorshipFindAuthor;
            type EventHandler = AuthorshipEventHandler;
        }
    };

    ($runtime:ty, FindAuthor = $find_author:ty $(, $( $rest:tt )*)?) => {
        type AuthorshipFindAuthor = $find_author;

        $crate::impl_pallet_authorship_inner!($runtime, $($( $rest )*)?);
    };

    ($runtime:ty, EventHandler = $event_handler:ty $(, $( $rest:tt )*)?) => {
        type AuthorshipEventHandler = $event_handler;

        $crate::impl_pallet_authorship_inner!($runtime, $($( $rest )*)?);
    };
}

#[macro_export]
macro_rules! impl_pallet_staking {
    ($( $tokens:tt )*) => {
        #[allow(dead_code)]
        pub struct DummyEraPayout;
        impl pallet_staking::EraPayout<u128> for DummyEraPayout {
            fn era_payout(
                _total_staked: u128,
                total_issuance: u128,
                _era_duration_millis: u64,
            ) -> (u128, u128) {
                // At each era have 1% `total_issuance` increase
                (Permill::from_percent(1) * total_issuance, 0)
            }
        }

        type DataProviderInfo = (
            AccountId,
            BlockNumber,
            pallet_staking::Pallet<Test>,
            ConstU32<100>,
        );

        #[allow(dead_code)]
        type StakingConfigEraPayout = DummyEraPayout;
        #[allow(dead_code)]
        type StakingConfigSlash = ();
        #[allow(dead_code)]
        type StakingConfigReward = ();
        #[allow(dead_code)]
        type StakingConfigNextNewSession = ();
        #[allow(dead_code)]
        type StakingConfigElectionProvider =
            frame_election_provider_support::NoElection<DataProviderInfo>;
        #[allow(dead_code)]
        type StakingConfigGenesisElectionProvider =
            frame_election_provider_support::NoElection<DataProviderInfo>;

        mod pallet_tests_staking_config_impl {
            use super::*;

            $crate::impl_pallet_staking_inner!($( $tokens )*);
        }
    };
}

#[macro_export]
macro_rules! impl_pallet_staking_inner {
    ($runtime:ty$(,)?) => {
        parameter_types! {
            // 6 sessions in an era
            pub const SessionsPerEra: u32 = 6;
            // 8 eras for unbonding
            pub const BondingDuration: u32 = 8;
            pub const SlashDeferDuration: u32 = 7;
            pub const MaxExposurePageSize: u32 = 256;
            pub const OffendingValidatorsThreshold: Perbill = Perbill::from_percent(17);
            pub const HistoryDepth: u32 = 84;
            pub const MaxNominations: u32 = 16;
            pub const MaxControllersInDeprecationBatch: u32 = 5900;
        }

        impl pallet_staking::Config for Test {
            type Currency = Balances;
            type UnixTime = Timestamp;
            type CurrencyBalance = <Self as pallet_balances::Config>::Balance;
            type CurrencyToVote = ();
            type ElectionProvider = StakingConfigElectionProvider;
            type GenesisElectionProvider = StakingConfigGenesisElectionProvider;
            type RewardRemainder = ();
            type RuntimeEvent = RuntimeEvent;
            type Slash = StakingConfigSlash;
            type Reward = StakingConfigReward;
            type SessionsPerEra = SessionsPerEra;
            type BondingDuration = BondingDuration;
            type SlashDeferDuration = SlashDeferDuration;
            type AdminOrigin = frame_system::EnsureRoot<AccountId>;
            type SessionInterface = ();
            type EraPayout = StakingConfigEraPayout;
            type NextNewSession = StakingConfigNextNewSession;
            type MaxExposurePageSize = MaxExposurePageSize;
            type VoterList = pallet_staking::UseNominatorsAndValidatorsMap<Self>;
            type TargetList = pallet_staking::UseValidatorsMap<Self>;
            type NominationsQuota = pallet_staking::FixedNominationsQuota<16>;
            type MaxUnlockingChunks = ConstU32<32>;
            type HistoryDepth = HistoryDepth;
            type EventListeners = ();
            type WeightInfo = ();
            type BenchmarkingConfig = pallet_staking::TestBenchmarkingConfig;
            type MaxControllersInDeprecationBatch = MaxControllersInDeprecationBatch;
            type DisablingStrategy = pallet_staking::UpToLimitDisablingStrategy;
        }
    };

    ($runtime:ty, EraPayout = $era_payout:ty $(, $( $rest:tt )*)?) => {
        type StakingConfigEraPayout = $era_payout;

        $crate::impl_pallet_staking_inner!($runtime, $($( $rest )*)?);
    };

    ($runtime:ty, Slash = $slash:ty $(, $( $rest:tt )*)?) => {
        type StakingConfigSlash = $slash;

        $crate::impl_pallet_staking_inner!($runtime, $($( $rest )*)?);
    };

    ($runtime:ty, Reward = $reward:ty $(, $( $rest:tt )*)?) => {
        type StakingConfigReward = $reward;

        $crate::impl_pallet_staking_inner!($runtime, $($( $rest )*)?);
    };

    ($runtime:ty, NextNewSession = $next_new_session:ty $(, $( $rest:tt )*)?) => {
        type StakingConfigNextNewSession = $next_new_session;

        $crate::impl_pallet_staking_inner!($runtime, $($( $rest )*)?);
    };

    ($runtime:ty, ElectionProvider = $election_provider:ty $(, $( $rest:tt )*)?) => {
        type StakingConfigElectionProvider = $election_provider;

        $crate::impl_pallet_staking_inner!($runtime, $($( $rest )*)?);
    };

    (
        $runtime:ty, GenesisElectionProvider = $genesis_election_provider:ty $(, $( $rest:tt )*)?
    ) => {
        type StakingConfigGenesisElectionProvider = $genesis_election_provider;

        $crate::impl_pallet_staking_inner!($runtime, $($( $rest )*)?);
    };
}