// This file is part of Astar.

// Copyright (C) Stake Technologies Pte.Ltd.
// SPDX-License-Identifier: GPL-3.0-or-later

// Astar 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.

// Astar 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 Astar. If not, see <http://www.gnu.org/licenses/>.

//! # dApp Staking v3 Pallet
//!
//! For detailed high level documentation, please refer to the attached README.md file.
//! The crate level docs will cover overall pallet structure & implementation details.
//!
//! ## Overview
//!
//! Pallet that implements the dApp staking v3 protocol.
//! It covers everything from locking, staking, tier configuration & assignment, reward calculation & payout.
//!
//! The `types` module contains all of the types used to implement the pallet.
//! All of these _types_ are extensively tested in their dedicated `test_types` module.
//!
//! Rest of the pallet logic is concentrated in the lib.rs file.
//! This logic is tested in the `tests` module, with the help of extensive `testing_utils`.
//!

#![cfg_attr(not(feature = "std"), no_std)]

use frame_support::{
    pallet_prelude::*,
    traits::{
        fungible::{Inspect as FunInspect, MutateFreeze as FunMutateFreeze},
        StorageVersion,
    },
    weights::Weight,
};
use frame_system::pallet_prelude::*;
use sp_arithmetic::fixed_point::FixedU128;
use sp_runtime::{
    traits::{One, Saturating, UniqueSaturatedInto, Zero},
    Perbill, Permill, SaturatedConversion,
};
pub use sp_std::vec::Vec;

use astar_primitives::{
    dapp_staking::{
        AccountCheck, CycleConfiguration, DAppId, EraNumber, Observer as DAppStakingObserver,
        PeriodNumber, Rank, RankedTier, SmartContractHandle, StakingRewardHandler, TierId,
        TierSlots as TierSlotFunc,
    },
    oracle::PriceProvider,
    Balance, BlockNumber,
};

pub use pallet::*;

#[cfg(test)]
mod test;

#[cfg(feature = "runtime-benchmarks")]
mod benchmarking;

mod types;
pub use types::*;

pub mod migration;
pub mod weights;

pub use weights::WeightInfo;

const LOG_TARGET: &str = "dapp-staking";

/// Helper enum for benchmarking.
pub(crate) enum TierAssignment {
    /// Real tier assignment calculation should be done.
    Real,
    /// Dummy tier assignment calculation should be done, e.g. default value should be returned.
    #[cfg(feature = "runtime-benchmarks")]
    Dummy,
}

#[doc = include_str!("../README.md")]
#[frame_support::pallet]
pub mod pallet {
    use super::*;

    /// The current storage version.
    pub const STORAGE_VERSION: StorageVersion = StorageVersion::new(8);

    #[pallet::pallet]
    #[pallet::storage_version(STORAGE_VERSION)]
    pub struct Pallet<T>(_);

    #[cfg(feature = "runtime-benchmarks")]
    pub trait BenchmarkHelper<SmartContract, AccountId> {
        fn get_smart_contract(id: u32) -> SmartContract;

        fn set_balance(account: &AccountId, balance: Balance);
    }

    #[pallet::config]
    pub trait Config: frame_system::Config {
        /// The overarching event type.
        type RuntimeEvent: From<Event<Self>>
            + IsType<<Self as frame_system::Config>::RuntimeEvent>
            + TryInto<Event<Self>>;

        /// The overarching freeze reason.
        type RuntimeFreezeReason: From<FreezeReason>;

        /// Currency used for staking.
        /// Reference: <https://github.com/paritytech/substrate/pull/12951/>
        type Currency: FunMutateFreeze<
            Self::AccountId,
            Id = Self::RuntimeFreezeReason,
            Balance = Balance,
        >;

        /// Describes smart contract in the context required by dApp staking.
        type SmartContract: Parameter
            + Member
            + MaxEncodedLen
            + SmartContractHandle<Self::AccountId>;

        /// Privileged origin that is allowed to register smart contracts to the protocol.
        type ContractRegisterOrigin: EnsureOrigin<<Self as frame_system::Config>::RuntimeOrigin>;

        /// Privileged origin that is allowed to unregister smart contracts from the protocol.
        type ContractUnregisterOrigin: EnsureOrigin<<Self as frame_system::Config>::RuntimeOrigin>;

        /// Privileged origin for managing dApp staking pallet.
        type ManagerOrigin: EnsureOrigin<<Self as frame_system::Config>::RuntimeOrigin>;

        /// Used to provide price information about the native token.
        type NativePriceProvider: PriceProvider;

        /// Used to handle reward payouts & reward pool amount fetching.
        type StakingRewardHandler: StakingRewardHandler<Self::AccountId>;

        /// Describes era length, subperiods & period length, as well as cycle length.
        type CycleConfiguration: CycleConfiguration;

        /// dApp staking event observers, notified when certain events occur.
        type Observers: DAppStakingObserver;

        /// Used to check whether an account is allowed to participate in dApp staking.
        type AccountCheck: AccountCheck<Self::AccountId>;

        /// Used to calculate total number of tier slots for some price.
        type TierSlots: TierSlotFunc;

        /// Base native currency price used to calculate base number of slots.
        /// This is used to adjust tier configuration, tier thresholds specifically, based on the native token price changes.
        ///
        /// When dApp staking thresholds were modeled, a base price was set from which the initial configuration is derived.
        /// E.g. for a price of 0.05$, we get 100 slots, and certain tier thresholds.
        /// Using these values as the base, we can adjust the configuration based on the current price.
        ///
        /// This is connected with the `TierSlots` associated type, since it's used to calculate the total number of slots for the given price.
        #[pallet::constant]
        type BaseNativeCurrencyPrice: Get<FixedU128>;

        /// Maximum length of a single era reward span length entry.
        #[pallet::constant]
        type EraRewardSpanLength: Get<u32>;

        /// Number of periods for which we keep rewards available for claiming.
        /// After that period, they are no longer claimable.
        #[pallet::constant]
        type RewardRetentionInPeriods: Get<PeriodNumber>;

        /// Maximum number of contracts that can be integrated into dApp staking at once.
        #[pallet::constant]
        type MaxNumberOfContracts: Get<u32>;

        /// Maximum number of unlocking chunks that can exist per account at a time.
        #[pallet::constant]
        type MaxUnlockingChunks: Get<u32>;

        /// Minimum amount an account has to lock in dApp staking in order to participate.
        #[pallet::constant]
        type MinimumLockedAmount: Get<Balance>;

        /// Number of standard eras that need to pass before unlocking chunk can be claimed.
        /// Even though it's expressed in 'eras', it's actually measured in number of blocks.
        #[pallet::constant]
        type UnlockingPeriod: Get<EraNumber>;

        /// Maximum amount of stake contract entries an account is allowed to have at once.
        #[pallet::constant]
        type MaxNumberOfStakedContracts: Get<u32>;

        /// Minimum amount staker can stake on a contract.
        #[pallet::constant]
        type MinimumStakeAmount: Get<Balance>;

        /// Number of different tiers.
        #[pallet::constant]
        type NumberOfTiers: Get<u32>;

        /// Tier ranking enabled.
        #[pallet::constant]
        type RankingEnabled: Get<bool>;

        /// Weight info for various calls & operations in the pallet.
        type WeightInfo: WeightInfo;

        /// Helper trait for benchmarks.
        #[cfg(feature = "runtime-benchmarks")]
        type BenchmarkHelper: BenchmarkHelper<Self::SmartContract, Self::AccountId>;
    }

    #[pallet::event]
    #[pallet::generate_deposit(pub(crate) fn deposit_event)]
    pub enum Event<T: Config> {
        /// Maintenance mode has been either enabled or disabled.
        MaintenanceMode { enabled: bool },
        /// New era has started.
        NewEra { era: EraNumber },
        /// New subperiod has started.
        NewSubperiod {
            subperiod: Subperiod,
            number: PeriodNumber,
        },
        /// A smart contract has been registered for dApp staking
        DAppRegistered {
            owner: T::AccountId,
            smart_contract: T::SmartContract,
            dapp_id: DAppId,
        },
        /// dApp reward destination has been updated.
        DAppRewardDestinationUpdated {
            smart_contract: T::SmartContract,
            beneficiary: Option<T::AccountId>,
        },
        /// dApp owner has been changed.
        DAppOwnerChanged {
            smart_contract: T::SmartContract,
            new_owner: T::AccountId,
        },
        /// dApp has been unregistered
        DAppUnregistered {
            smart_contract: T::SmartContract,
            era: EraNumber,
        },
        /// Account has locked some amount into dApp staking.
        Locked {
            account: T::AccountId,
            amount: Balance,
        },
        /// Account has started the unlocking process for some amount.
        Unlocking {
            account: T::AccountId,
            amount: Balance,
        },
        /// Account has claimed unlocked amount, removing the lock from it.
        ClaimedUnlocked {
            account: T::AccountId,
            amount: Balance,
        },
        /// Account has relocked all of the unlocking chunks.
        Relock {
            account: T::AccountId,
            amount: Balance,
        },
        /// Account has staked some amount on a smart contract.
        Stake {
            account: T::AccountId,
            smart_contract: T::SmartContract,
            amount: Balance,
        },
        /// Account has unstaked some amount from a smart contract.
        Unstake {
            account: T::AccountId,
            smart_contract: T::SmartContract,
            amount: Balance,
        },
        /// Account has claimed some stake rewards.
        Reward {
            account: T::AccountId,
            era: EraNumber,
            amount: Balance,
        },
        /// Bonus reward has been paid out to a loyal staker.
        BonusReward {
            account: T::AccountId,
            smart_contract: T::SmartContract,
            period: PeriodNumber,
            amount: Balance,
        },
        /// dApp reward has been paid out to a beneficiary.
        DAppReward {
            beneficiary: T::AccountId,
            smart_contract: T::SmartContract,
            tier_id: TierId,
            rank: Rank,
            era: EraNumber,
            amount: Balance,
        },
        /// Account has unstaked funds from an unregistered smart contract
        UnstakeFromUnregistered {
            account: T::AccountId,
            smart_contract: T::SmartContract,
            amount: Balance,
        },
        /// Some expired stake entries have been removed from storage.
        ExpiredEntriesRemoved { account: T::AccountId, count: u16 },
        /// Privileged origin has forced a new era and possibly a subperiod to start from next block.
        Force { forcing_type: ForcingType },
    }

    #[pallet::error]
    pub enum Error<T> {
        /// Pallet is disabled/in maintenance mode.
        Disabled,
        /// Smart contract already exists within dApp staking protocol.
        ContractAlreadyExists,
        /// Maximum number of smart contracts has been reached.
        ExceededMaxNumberOfContracts,
        /// Not possible to assign a new dApp Id.
        /// This should never happen since current type can support up to 65536 - 1 unique dApps.
        NewDAppIdUnavailable,
        /// Specified smart contract does not exist in dApp staking.
        ContractNotFound,
        /// Call origin is not dApp owner.
        OriginNotOwner,
        /// Performing locking or staking with 0 amount.
        ZeroAmount,
        /// Total locked amount for staker is below minimum threshold.
        LockedAmountBelowThreshold,
        /// Account is not allowed to participate in dApp staking due to some external reason (e.g. account is already a collator).
        AccountNotAvailableForDappStaking,
        /// Cannot add additional unlocking chunks due to capacity limit.
        TooManyUnlockingChunks,
        /// Remaining stake prevents entire balance of starting the unlocking process.
        RemainingStakePreventsFullUnlock,
        /// There are no eligible unlocked chunks to claim. This can happen either if no eligible chunks exist, or if user has no chunks at all.
        NoUnlockedChunksToClaim,
        /// There are no unlocking chunks available to relock.
        NoUnlockingChunks,
        /// The amount being staked is too large compared to what's available for staking.
        UnavailableStakeFunds,
        /// There are unclaimed rewards remaining from past eras or periods. They should be claimed before attempting any stake modification again.
        UnclaimedRewards,
        /// An unexpected error occurred while trying to stake.
        InternalStakeError,
        /// Total staked amount on contract is below the minimum required value.
        InsufficientStakeAmount,
        /// Stake operation is rejected since period ends in the next era.
        PeriodEndsInNextEra,
        /// Unstaking is rejected since the period in which past stake was active has passed.
        UnstakeFromPastPeriod,
        /// Unstake amount is greater than the staked amount.
        UnstakeAmountTooLarge,
        /// Account has no staking information for the contract.
        NoStakingInfo,
        /// An unexpected error occurred while trying to unstake.
        InternalUnstakeError,
        /// Rewards are no longer claimable since they are too old.
        RewardExpired,
        /// Reward payout has failed due to an unexpected reason.
        RewardPayoutFailed,
        /// There are no claimable rewards.
        NoClaimableRewards,
        /// An unexpected error occurred while trying to claim staker rewards.
        InternalClaimStakerError,
        /// Account is has no eligible stake amount for bonus reward.
        NotEligibleForBonusReward,
        /// An unexpected error occurred while trying to claim bonus reward.
        InternalClaimBonusError,
        /// Claim era is invalid - it must be in history, and rewards must exist for it.
        InvalidClaimEra,
        /// No dApp tier info exists for the specified era. This can be because era has expired
        /// or because during the specified era there were no eligible rewards or protocol wasn't active.
        NoDAppTierInfo,
        /// An unexpected error occurred while trying to claim dApp reward.
        InternalClaimDAppError,
        /// Contract is still active, not unregistered.
        ContractStillActive,
        /// There are too many contract stake entries for the account. This can be cleaned up by either unstaking or cleaning expired entries.
        TooManyStakedContracts,
        /// There are no expired entries to cleanup for the account.
        NoExpiredEntries,
        /// Force call is not allowed in production.
        ForceNotAllowed,
    }

    /// General information about dApp staking protocol state.
    #[pallet::storage]
    #[pallet::whitelist_storage]
    pub type ActiveProtocolState<T: Config> = StorageValue<_, ProtocolState, ValueQuery>;

    /// Counter for unique dApp identifiers.
    #[pallet::storage]
    pub type NextDAppId<T: Config> = StorageValue<_, DAppId, ValueQuery>;

    /// Map of all dApps integrated into dApp staking protocol.
    ///
    /// Even though dApp is integrated, it does not mean it's still actively participating in dApp staking.
    /// It might have been unregistered at some point in history.
    #[pallet::storage]
    pub type IntegratedDApps<T: Config> = CountedStorageMap<
        Hasher = Blake2_128Concat,
        Key = T::SmartContract,
        Value = DAppInfo<T::AccountId>,
        QueryKind = OptionQuery,
        MaxValues = ConstU32<{ DAppId::MAX as u32 }>,
    >;

    /// General locked/staked information for each account.
    #[pallet::storage]
    pub type Ledger<T: Config> =
        StorageMap<_, Blake2_128Concat, T::AccountId, AccountLedgerFor<T>, ValueQuery>;

    /// Information about how much each staker has staked for each smart contract in some period.
    #[pallet::storage]
    pub type StakerInfo<T: Config> = StorageDoubleMap<
        _,
        Blake2_128Concat,
        T::AccountId,
        Blake2_128Concat,
        T::SmartContract,
        SingularStakingInfo,
        OptionQuery,
    >;

    /// Information about how much has been staked on a smart contract in some era or period.
    #[pallet::storage]
    pub type ContractStake<T: Config> = StorageMap<
        Hasher = Twox64Concat,
        Key = DAppId,
        Value = ContractStakeAmount,
        QueryKind = ValueQuery,
        MaxValues = ConstU32<{ DAppId::MAX as u32 }>,
    >;

    /// General information about the current era.
    #[pallet::storage]
    pub type CurrentEraInfo<T: Config> = StorageValue<_, EraInfo, ValueQuery>;

    /// Information about rewards for each era.
    ///
    /// Since each entry is a 'span', covering up to `T::EraRewardSpanLength` entries, only certain era value keys can exist in storage.
    /// For the sake of simplicity, valid `era` keys are calculated as:
    ///
    /// era_key = era - (era % T::EraRewardSpanLength)
    ///
    /// This means that e.g. in case `EraRewardSpanLength = 8`, only era values 0, 8, 16, 24, etc. can exist in storage.
    /// Eras 1-7 will be stored in the same entry as era 0, eras 9-15 will be stored in the same entry as era 8, etc.
    #[pallet::storage]
    pub type EraRewards<T: Config> =
        StorageMap<_, Twox64Concat, EraNumber, EraRewardSpan<T::EraRewardSpanLength>, OptionQuery>;

    /// Information about period's end.
    #[pallet::storage]
    pub type PeriodEnd<T: Config> =
        StorageMap<_, Twox64Concat, PeriodNumber, PeriodEndInfo, OptionQuery>;

    /// Static tier parameters used to calculate tier configuration.
    #[pallet::storage]
    pub type StaticTierParams<T: Config> =
        StorageValue<_, TierParameters<T::NumberOfTiers>, ValueQuery>;

    /// Tier configuration user for current & preceding eras.
    #[pallet::storage]
    pub type TierConfig<T: Config> = StorageValue<
        _,
        TiersConfiguration<T::NumberOfTiers, T::TierSlots, T::BaseNativeCurrencyPrice>,
        ValueQuery,
    >;

    /// Information about which tier a dApp belonged to in a specific era.
    #[pallet::storage]
    pub type DAppTiers<T: Config> =
        StorageMap<_, Twox64Concat, EraNumber, DAppTierRewardsFor<T>, OptionQuery>;

    /// History cleanup marker - holds information about which DB entries should be cleaned up next, when applicable.
    #[pallet::storage]
    pub type HistoryCleanupMarker<T: Config> = StorageValue<_, CleanupMarker, ValueQuery>;

    #[pallet::type_value]
    pub fn DefaultSafeguard<T: Config>() -> bool {
        // In production, safeguard is enabled by default.
        // Safeguard can be disabled per chain via Genesis Config.
        true
    }

    /// Safeguard to prevent unwanted operations in production.
    /// Kept as a storage without extrinsic setter, so we can still enable it for some
    /// chain-fork debugging if required.
    #[pallet::storage]
    pub type Safeguard<T: Config> = StorageValue<_, bool, ValueQuery, DefaultSafeguard<T>>;

    #[pallet::genesis_config]
    pub struct GenesisConfig<T> {
        pub reward_portion: Vec<Permill>,
        pub slot_distribution: Vec<Permill>,
        pub tier_thresholds: Vec<TierThreshold>,
        pub slots_per_tier: Vec<u16>,
        pub safeguard: Option<bool>,
        #[serde(skip)]
        pub _config: PhantomData<T>,
    }

    impl<T: Config> Default for GenesisConfig<T> {
        fn default() -> Self {
            use sp_std::vec;
            let num_tiers = T::NumberOfTiers::get();
            Self {
                reward_portion: vec![Permill::from_percent(100 / num_tiers); num_tiers as usize],
                slot_distribution: vec![Permill::from_percent(100 / num_tiers); num_tiers as usize],
                tier_thresholds: (0..num_tiers)
                    .rev()
                    .map(|i| TierThreshold::FixedPercentage {
                        required_percentage: Perbill::from_percent(i),
                    })
                    .collect(),
                slots_per_tier: vec![100; num_tiers as usize],
                safeguard: None,
                _config: Default::default(),
            }
        }
    }

    #[pallet::genesis_build]
    impl<T: Config> BuildGenesisConfig for GenesisConfig<T> {
        fn build(&self) {
            // Prepare tier parameters & verify their correctness
            let tier_params = TierParameters::<T::NumberOfTiers> {
                reward_portion: BoundedVec::<Permill, T::NumberOfTiers>::try_from(
                    self.reward_portion.clone(),
                )
                .expect("Invalid number of reward portions provided."),
                slot_distribution: BoundedVec::<Permill, T::NumberOfTiers>::try_from(
                    self.slot_distribution.clone(),
                )
                .expect("Invalid number of slot distributions provided."),
                tier_thresholds: BoundedVec::<TierThreshold, T::NumberOfTiers>::try_from(
                    self.tier_thresholds.clone(),
                )
                .expect("Invalid number of tier thresholds provided."),
            };
            assert!(
                tier_params.is_valid(),
                "Invalid tier parameters values provided."
            );

            let total_issuance = T::Currency::total_issuance();
            let tier_thresholds = tier_params
                .tier_thresholds
                .iter()
                .map(|t| t.threshold(total_issuance))
                .collect::<Vec<Balance>>()
                .try_into()
                .expect("Invalid number of tier thresholds provided.");

            let tier_config =
                TiersConfiguration::<T::NumberOfTiers, T::TierSlots, T::BaseNativeCurrencyPrice> {
                    slots_per_tier: BoundedVec::<u16, T::NumberOfTiers>::try_from(
                        self.slots_per_tier.clone(),
                    )
                    .expect("Invalid number of slots per tier entries provided."),
                    reward_portion: tier_params.reward_portion.clone(),
                    tier_thresholds,
                    _phantom: Default::default(),
                };
            assert!(
                tier_config.is_valid(),
                "Invalid tier config values provided."
            );

            // Prepare initial protocol state
            let protocol_state = ProtocolState {
                era: 1,
                next_era_start: Pallet::<T>::blocks_per_voting_period()
                    .checked_add(1)
                    .expect("Must not overflow - especially not at genesis."),
                period_info: PeriodInfo {
                    number: 1,
                    subperiod: Subperiod::Voting,
                    next_subperiod_start_era: 2,
                },
                maintenance: false,
            };

            // Initialize necessary storage items
            ActiveProtocolState::<T>::put(protocol_state);
            StaticTierParams::<T>::put(tier_params);
            TierConfig::<T>::put(tier_config.clone());

            if self.safeguard.is_some() {
                Safeguard::<T>::put(self.safeguard.unwrap());
            }
        }
    }

    #[pallet::hooks]
    impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {
        fn on_initialize(now: BlockNumberFor<T>) -> Weight {
            let now = now.saturated_into();
            Self::era_and_period_handler(now, TierAssignment::Real)
        }

        fn on_idle(_block: BlockNumberFor<T>, remaining_weight: Weight) -> Weight {
            Self::expired_entry_cleanup(&remaining_weight)
        }

        fn integrity_test() {
            // dApp staking params
            // Sanity checks
            assert!(T::EraRewardSpanLength::get() > 0);
            assert!(T::RewardRetentionInPeriods::get() > 0);
            assert!(T::MaxNumberOfContracts::get() > 0);
            assert!(T::MaxUnlockingChunks::get() > 0);
            assert!(T::UnlockingPeriod::get() > 0);
            assert!(T::MaxNumberOfStakedContracts::get() > 0);

            assert!(T::MinimumLockedAmount::get() > 0);
            assert!(T::MinimumStakeAmount::get() > 0);
            assert!(T::MinimumLockedAmount::get() >= T::MinimumStakeAmount::get());

            // Cycle config
            assert!(T::CycleConfiguration::periods_per_cycle() > 0);
            assert!(T::CycleConfiguration::eras_per_voting_subperiod() > 0);
            assert!(T::CycleConfiguration::eras_per_build_and_earn_subperiod() > 0);
            assert!(T::CycleConfiguration::blocks_per_era() > 0);
        }

        #[cfg(feature = "try-runtime")]
        fn try_state(_n: BlockNumberFor<T>) -> Result<(), sp_runtime::TryRuntimeError> {
            Self::do_try_state()?;
            Ok(())
        }
    }

    /// A reason for freezing funds.
    #[pallet::composite_enum]
    pub enum FreezeReason {
        /// Account is participating in dApp staking.
        #[codec(index = 0)]
        DAppStaking,
    }

    #[pallet::call]
    impl<T: Config> Pallet<T> {
        /// Wrapper around _legacy-like_ `unbond_and_unstake`.
        ///
        /// Used to support legacy Ledger users so they can start the unlocking process for their funds.
        #[pallet::call_index(4)]
        #[pallet::weight(T::WeightInfo::unlock())]
        pub fn unbond_and_unstake(
            origin: OriginFor<T>,
            _contract_id: T::SmartContract,
            #[pallet::compact] value: Balance,
        ) -> DispatchResult {
            // Once new period begins, all stakes are reset to zero, so all it remains to be done is the `unlock`
            Self::unlock(origin, value)
        }

        /// Wrapper around _legacy-like_ `withdraw_unbonded`.
        ///
        /// Used to support legacy Ledger users so they can reclaim unlocked chunks back into
        /// their _transferable_ free balance.
        #[pallet::call_index(5)]
        #[pallet::weight(T::WeightInfo::claim_unlocked(T::MaxNumberOfStakedContracts::get()))]
        pub fn withdraw_unbonded(origin: OriginFor<T>) -> DispatchResultWithPostInfo {
            Self::claim_unlocked(origin)
        }

        /// Used to enable or disable maintenance mode.
        /// Can only be called by manager origin.
        #[pallet::call_index(0)]
        #[pallet::weight(T::WeightInfo::maintenance_mode())]
        pub fn maintenance_mode(origin: OriginFor<T>, enabled: bool) -> DispatchResult {
            T::ManagerOrigin::ensure_origin(origin)?;
            ActiveProtocolState::<T>::mutate(|state| state.maintenance = enabled);

            Self::deposit_event(Event::<T>::MaintenanceMode { enabled });
            Ok(())
        }

        /// Used to register a new contract for dApp staking.
        ///
        /// If successful, smart contract will be assigned a simple, unique numerical identifier.
        /// Owner is set to be initial beneficiary & manager of the dApp.
        #[pallet::call_index(1)]
        #[pallet::weight(T::WeightInfo::register())]
        pub fn register(
            origin: OriginFor<T>,
            owner: T::AccountId,
            smart_contract: T::SmartContract,
        ) -> DispatchResult {
            Self::ensure_pallet_enabled()?;
            T::ContractRegisterOrigin::ensure_origin(origin)?;

            ensure!(
                !IntegratedDApps::<T>::contains_key(&smart_contract),
                Error::<T>::ContractAlreadyExists,
            );

            ensure!(
                IntegratedDApps::<T>::count() < T::MaxNumberOfContracts::get().into(),
                Error::<T>::ExceededMaxNumberOfContracts
            );

            let dapp_id = NextDAppId::<T>::get();
            // MAX value must never be assigned as a dApp Id since it serves as a sentinel value.
            ensure!(dapp_id < DAppId::MAX, Error::<T>::NewDAppIdUnavailable);

            IntegratedDApps::<T>::insert(
                &smart_contract,
                DAppInfo {
                    owner: owner.clone(),
                    id: dapp_id,
                    reward_beneficiary: None,
                },
            );

            NextDAppId::<T>::put(dapp_id.saturating_add(1));

            Self::deposit_event(Event::<T>::DAppRegistered {
                owner,
                smart_contract,
                dapp_id,
            });

            Ok(())
        }

        /// Used to modify the reward beneficiary account for a dApp.
        ///
        /// Caller has to be dApp owner.
        /// If set to `None`, rewards will be deposited to the dApp owner.
        /// After this call, all existing & future rewards will be paid out to the beneficiary.
        #[pallet::call_index(2)]
        #[pallet::weight(T::WeightInfo::set_dapp_reward_beneficiary())]
        pub fn set_dapp_reward_beneficiary(
            origin: OriginFor<T>,
            smart_contract: T::SmartContract,
            beneficiary: Option<T::AccountId>,
        ) -> DispatchResult {
            Self::ensure_pallet_enabled()?;
            let dev_account = ensure_signed(origin)?;

            IntegratedDApps::<T>::try_mutate(
                &smart_contract,
                |maybe_dapp_info| -> DispatchResult {
                    let dapp_info = maybe_dapp_info
                        .as_mut()
                        .ok_or(Error::<T>::ContractNotFound)?;

                    ensure!(dapp_info.owner == dev_account, Error::<T>::OriginNotOwner);

                    dapp_info.reward_beneficiary = beneficiary.clone();

                    Ok(())
                },
            )?;

            Self::deposit_event(Event::<T>::DAppRewardDestinationUpdated {
                smart_contract,
                beneficiary,
            });

            Ok(())
        }

        /// Used to change dApp owner.
        ///
        /// Can be called by dApp owner or dApp staking manager origin.
        /// This is useful in two cases:
        /// 1. when the dApp owner account is compromised, manager can change the owner to a new account
        /// 2. if project wants to transfer ownership to a new account (DAO, multisig, etc.).
        #[pallet::call_index(3)]
        #[pallet::weight(T::WeightInfo::set_dapp_owner())]
        pub fn set_dapp_owner(
            origin: OriginFor<T>,
            smart_contract: T::SmartContract,
            new_owner: T::AccountId,
        ) -> DispatchResult {
            Self::ensure_pallet_enabled()?;
            let origin = ensure_signed_or_root(origin)?;

            IntegratedDApps::<T>::try_mutate(
                &smart_contract,
                |maybe_dapp_info| -> DispatchResult {
                    let dapp_info = maybe_dapp_info
                        .as_mut()
                        .ok_or(Error::<T>::ContractNotFound)?;

                    // If manager origin, `None`, no need to check if caller is the owner.
                    if let Some(caller) = origin {
                        ensure!(dapp_info.owner == caller, Error::<T>::OriginNotOwner);
                    }

                    dapp_info.owner = new_owner.clone();

                    Ok(())
                },
            )?;

            Self::deposit_event(Event::<T>::DAppOwnerChanged {
                smart_contract,
                new_owner,
            });

            Ok(())
        }

        /// Unregister dApp from dApp staking protocol, making it ineligible for future rewards.
        /// This doesn't remove the dApp completely from the system just yet, but it can no longer be used for staking.
        ///
        /// Can be called by dApp staking manager origin.
        #[pallet::call_index(6)]
        #[pallet::weight(T::WeightInfo::unregister())]
        pub fn unregister(
            origin: OriginFor<T>,
            smart_contract: T::SmartContract,
        ) -> DispatchResult {
            Self::ensure_pallet_enabled()?;
            T::ContractUnregisterOrigin::ensure_origin(origin)?;

            let dapp_info =
                IntegratedDApps::<T>::get(&smart_contract).ok_or(Error::<T>::ContractNotFound)?;

            ContractStake::<T>::remove(&dapp_info.id);
            IntegratedDApps::<T>::remove(&smart_contract);

            let current_era = ActiveProtocolState::<T>::get().era;
            Self::deposit_event(Event::<T>::DAppUnregistered {
                smart_contract,
                era: current_era,
            });

            Ok(())
        }

        /// Locks additional funds into dApp staking.
        ///
        /// In case caller account doesn't have sufficient balance to cover the specified amount, everything is locked.
        /// After adjustment, lock amount must be greater than zero and in total must be equal or greater than the minimum locked amount.
        ///
        /// Locked amount can immediately be used for staking.
        #[pallet::call_index(7)]
        #[pallet::weight(T::WeightInfo::lock_new_account().max(T::WeightInfo::lock_existing_account()))]
        pub fn lock(
            origin: OriginFor<T>,
            #[pallet::compact] amount: Balance,
        ) -> DispatchResultWithPostInfo {
            Self::ensure_pallet_enabled()?;
            let account = ensure_signed(origin)?;

            let mut ledger = Ledger::<T>::get(&account);

            // Only do the check for new accounts.
            // External logic should ensure that accounts which are already participating in dApp staking aren't
            // allowed to participate elsewhere where they shouldn't.
            let is_new_account = ledger.is_empty();
            if is_new_account {
                ensure!(
                    T::AccountCheck::allowed_to_stake(&account),
                    Error::<T>::AccountNotAvailableForDappStaking
                );
            }

            // Calculate & check amount available for locking
            let available_balance =
                T::Currency::total_balance(&account).saturating_sub(ledger.total_locked_amount());
            let amount_to_lock = available_balance.min(amount);
            ensure!(!amount_to_lock.is_zero(), Error::<T>::ZeroAmount);

            ledger.add_lock_amount(amount_to_lock);

            ensure!(
                ledger.active_locked_amount() >= T::MinimumLockedAmount::get(),
                Error::<T>::LockedAmountBelowThreshold
            );

            Self::update_ledger(&account, ledger)?;
            CurrentEraInfo::<T>::mutate(|era_info| {
                era_info.add_locked(amount_to_lock);
            });

            Self::deposit_event(Event::<T>::Locked {
                account,
                amount: amount_to_lock,
            });

            Ok(Some(if is_new_account {
                T::WeightInfo::lock_new_account()
            } else {
                T::WeightInfo::lock_existing_account()
            })
            .into())
        }

        /// Attempts to start the unlocking process for the specified amount.
        ///
        /// Only the amount that isn't actively used for staking can be unlocked.
        /// If the amount is greater than the available amount for unlocking, everything is unlocked.
        /// If the remaining locked amount would take the account below the minimum locked amount, everything is unlocked.
        #[pallet::call_index(8)]
        #[pallet::weight(T::WeightInfo::unlock())]
        pub fn unlock(origin: OriginFor<T>, #[pallet::compact] amount: Balance) -> DispatchResult {
            Self::ensure_pallet_enabled()?;
            let account = ensure_signed(origin)?;

            let state = ActiveProtocolState::<T>::get();
            let mut ledger = Ledger::<T>::get(&account);

            let available_for_unlocking = ledger.unlockable_amount(state.period_info.number);
            let amount_to_unlock = available_for_unlocking.min(amount);

            // Ensure we unlock everything if remaining amount is below threshold.
            let remaining_amount = ledger
                .active_locked_amount()
                .saturating_sub(amount_to_unlock);
            let amount_to_unlock = if remaining_amount < T::MinimumLockedAmount::get() {
                ensure!(
                    ledger.staked_amount(state.period_info.number).is_zero(),
                    Error::<T>::RemainingStakePreventsFullUnlock
                );
                ledger.active_locked_amount()
            } else {
                amount_to_unlock
            };

            // Sanity check
            ensure!(!amount_to_unlock.is_zero(), Error::<T>::ZeroAmount);

            // Update ledger with new lock and unlocking amounts
            ledger.subtract_lock_amount(amount_to_unlock);

            let current_block = frame_system::Pallet::<T>::block_number();
            let unlock_block = current_block.saturating_add(Self::unlocking_period().into());
            ledger
                .add_unlocking_chunk(amount_to_unlock, unlock_block.saturated_into())
                .map_err(|_| Error::<T>::TooManyUnlockingChunks)?;

            // Update storage
            Self::update_ledger(&account, ledger)?;
            CurrentEraInfo::<T>::mutate(|era_info| {
                era_info.unlocking_started(amount_to_unlock);
            });

            Self::deposit_event(Event::<T>::Unlocking {
                account,
                amount: amount_to_unlock,
            });

            Ok(())
        }

        /// Claims all of fully unlocked chunks, removing the lock from them.
        #[pallet::call_index(9)]
        #[pallet::weight(T::WeightInfo::claim_unlocked(T::MaxNumberOfStakedContracts::get()))]
        pub fn claim_unlocked(origin: OriginFor<T>) -> DispatchResultWithPostInfo {
            Self::ensure_pallet_enabled()?;
            let account = ensure_signed(origin)?;

            Self::internal_claim_unlocked(account)
        }

        #[pallet::call_index(10)]
        #[pallet::weight(T::WeightInfo::relock_unlocking())]
        pub fn relock_unlocking(origin: OriginFor<T>) -> DispatchResult {
            Self::ensure_pallet_enabled()?;
            let account = ensure_signed(origin)?;

            let mut ledger = Ledger::<T>::get(&account);

            ensure!(!ledger.unlocking.is_empty(), Error::<T>::NoUnlockingChunks);

            let amount = ledger.consume_unlocking_chunks();

            ledger.add_lock_amount(amount);
            ensure!(
                ledger.active_locked_amount() >= T::MinimumLockedAmount::get(),
                Error::<T>::LockedAmountBelowThreshold
            );

            Self::update_ledger(&account, ledger)?;
            CurrentEraInfo::<T>::mutate(|era_info| {
                era_info.add_locked(amount);
                era_info.unlocking_removed(amount);
            });

            Self::deposit_event(Event::<T>::Relock { account, amount });

            Ok(())
        }

        /// Stake the specified amount on a smart contract.
        /// The precise `amount` specified **must** be available for staking.
        /// The total amount staked on a dApp must be greater than the minimum required value.
        ///
        /// Depending on the period type, appropriate stake amount will be updated. During `Voting` subperiod, `voting` stake amount is updated,
        /// and same for `Build&Earn` subperiod.
        ///
        /// Staked amount is only eligible for rewards from the next era onwards.
        #[pallet::call_index(11)]
        #[pallet::weight(T::WeightInfo::stake())]
        pub fn stake(
            origin: OriginFor<T>,
            smart_contract: T::SmartContract,
            #[pallet::compact] amount: Balance,
        ) -> DispatchResult {
            Self::ensure_pallet_enabled()?;
            let account = ensure_signed(origin)?;

            ensure!(amount > 0, Error::<T>::ZeroAmount);

            let dapp_info =
                IntegratedDApps::<T>::get(&smart_contract).ok_or(Error::<T>::ContractNotFound)?;

            let protocol_state = ActiveProtocolState::<T>::get();
            let current_era = protocol_state.era;
            ensure!(
                !protocol_state
                    .period_info
                    .is_next_period(current_era.saturating_add(1)),
                Error::<T>::PeriodEndsInNextEra
            );

            let mut ledger = Ledger::<T>::get(&account);

            // In case old stake rewards are unclaimed & have expired, clean them up.
            let threshold_period = Self::oldest_claimable_period(protocol_state.period_number());
            let _ignore = ledger.maybe_cleanup_expired(threshold_period);

            // 1.
            // Increase stake amount for the next era & current period in staker's ledger
            ledger
                .add_stake_amount(amount, current_era, protocol_state.period_info)
                .map_err(|err| match err {
                    AccountLedgerError::InvalidPeriod | AccountLedgerError::InvalidEra => {
                        Error::<T>::UnclaimedRewards
                    }
                    AccountLedgerError::UnavailableStakeFunds => Error::<T>::UnavailableStakeFunds,
                    // Defensive check, should never happen
                    _ => Error::<T>::InternalStakeError,
                })?;

            // 2.
            // Update `StakerInfo` storage with the new stake amount on the specified contract.
            //
            // There are two distinct scenarios:
            // 1. Existing entry matches the current period number - just update it.
            // 2. Entry doesn't exist or it's for an older period - create a new one.
            //
            // This is ok since we only use this storage entry to keep track of how much each staker
            // has staked on each contract in the current period. We only ever need the latest information.
            // This is because `AccountLedger` is the one keeping information about how much was staked when.
            let (mut new_staking_info, is_new_entry) =
                match StakerInfo::<T>::get(&account, &smart_contract) {
                    // Entry with matching period exists
                    Some(staking_info)
                        if staking_info.period_number() == protocol_state.period_number() =>
                    {
                        (staking_info, false)
                    }
                    // Entry exists but period doesn't match. Bonus reward might still be claimable.
                    Some(staking_info)
                        if staking_info.period_number() >= threshold_period
                            && staking_info.is_loyal() =>
                    {
                        return Err(Error::<T>::UnclaimedRewards.into());
                    }
                    // No valid entry exists
                    _ => (
                        SingularStakingInfo::new(
                            protocol_state.period_number(),
                            protocol_state.subperiod(),
                        ),
                        true,
                    ),
                };
            new_staking_info.stake(amount, current_era, protocol_state.subperiod());
            ensure!(
                new_staking_info.total_staked_amount() >= T::MinimumStakeAmount::get(),
                Error::<T>::InsufficientStakeAmount
            );

            if is_new_entry {
                ledger.contract_stake_count.saturating_inc();
                ensure!(
                    ledger.contract_stake_count <= T::MaxNumberOfStakedContracts::get(),
                    Error::<T>::TooManyStakedContracts
                );
            }

            // 3.
            // Update `ContractStake` storage with the new stake amount on the specified contract.
            let mut contract_stake_info = ContractStake::<T>::get(&dapp_info.id);
            contract_stake_info.stake(amount, protocol_state.period_info, current_era);

            // 4.
            // Update total staked amount for the next era.
            CurrentEraInfo::<T>::mutate(|era_info| {
                era_info.add_stake_amount(amount, protocol_state.subperiod());
            });

            // 5.
            // Update remaining storage entries
            Self::update_ledger(&account, ledger)?;
            StakerInfo::<T>::insert(&account, &smart_contract, new_staking_info);
            ContractStake::<T>::insert(&dapp_info.id, contract_stake_info);

            Self::deposit_event(Event::<T>::Stake {
                account,
                smart_contract,
                amount,
            });

            Ok(())
        }

        /// Unstake the specified amount from a smart contract.
        /// The `amount` specified **must** not exceed what's staked, otherwise the call will fail.
        ///
        /// If unstaking the specified `amount` would take staker below the minimum stake threshold, everything is unstaked.
        ///
        /// Depending on the period type, appropriate stake amount will be updated.
        /// In case amount is unstaked during `Voting` subperiod, the `voting` amount is reduced.
        /// In case amount is unstaked during `Build&Earn` subperiod, first the `build_and_earn` is reduced,
        /// and any spillover is subtracted from the `voting` amount.
        #[pallet::call_index(12)]
        #[pallet::weight(T::WeightInfo::unstake())]
        pub fn unstake(
            origin: OriginFor<T>,
            smart_contract: T::SmartContract,
            #[pallet::compact] amount: Balance,
        ) -> DispatchResult {
            Self::ensure_pallet_enabled()?;
            let account = ensure_signed(origin)?;

            ensure!(amount > 0, Error::<T>::ZeroAmount);

            let dapp_info =
                IntegratedDApps::<T>::get(&smart_contract).ok_or(Error::<T>::ContractNotFound)?;

            let protocol_state = ActiveProtocolState::<T>::get();
            let current_era = protocol_state.era;

            let mut ledger = Ledger::<T>::get(&account);

            // 1.
            // Update `StakerInfo` storage with the reduced stake amount on the specified contract.
            let (new_staking_info, amount, era_and_amount_pairs) =
                match StakerInfo::<T>::get(&account, &smart_contract) {
                    Some(mut staking_info) => {
                        ensure!(
                            staking_info.period_number() == protocol_state.period_number(),
                            Error::<T>::UnstakeFromPastPeriod
                        );
                        ensure!(
                            staking_info.total_staked_amount() >= amount,
                            Error::<T>::UnstakeAmountTooLarge
                        );

                        // If unstaking would take the total staked amount below the minimum required value,
                        // unstake everything.
                        let amount = if staking_info.total_staked_amount().saturating_sub(amount)
                            < T::MinimumStakeAmount::get()
                        {
                            staking_info.total_staked_amount()
                        } else {
                            amount
                        };

                        let era_and_amount_pairs =
                            staking_info.unstake(amount, current_era, protocol_state.subperiod());

                        (staking_info, amount, era_and_amount_pairs)
                    }
                    None => {
                        return Err(Error::<T>::NoStakingInfo.into());
                    }
                };

            // 2.
            // Reduce stake amount
            ledger
                .unstake_amount(amount, current_era, protocol_state.period_info)
                .map_err(|err| match err {
                    AccountLedgerError::InvalidPeriod | AccountLedgerError::InvalidEra => {
                        Error::<T>::UnclaimedRewards
                    }
                    // This is a defensive check, which should never happen since we calculate the correct value above.
                    AccountLedgerError::UnstakeAmountLargerThanStake => {
                        Error::<T>::UnstakeAmountTooLarge
                    }
                    _ => Error::<T>::InternalUnstakeError,
                })?;

            // 3.
            // Update `ContractStake` storage with the reduced stake amount on the specified contract.
            let mut contract_stake_info = ContractStake::<T>::get(&dapp_info.id);
            contract_stake_info.unstake(
                era_and_amount_pairs,
                protocol_state.period_info,
                current_era,
            );

            // 4.
            // Update total staked amount for the next era.
            CurrentEraInfo::<T>::mutate(|era_info| {
                era_info.unstake_amount(amount);
            });

            // 5.
            // Update remaining storage entries
            ContractStake::<T>::insert(&dapp_info.id, contract_stake_info);

            if new_staking_info.is_empty() {
                ledger.contract_stake_count.saturating_dec();
                StakerInfo::<T>::remove(&account, &smart_contract);
            } else {
                StakerInfo::<T>::insert(&account, &smart_contract, new_staking_info);
            }

            Self::update_ledger(&account, ledger)?;

            Self::deposit_event(Event::<T>::Unstake {
                account,
                smart_contract,
                amount,
            });

            Ok(())
        }

        /// Claims some staker rewards, if user has any.
        /// In the case of a successful call, at least one era will be claimed, with the possibility of multiple claims happening.
        #[pallet::call_index(13)]
        #[pallet::weight({
            let max_span_length = T::EraRewardSpanLength::get();
            T::WeightInfo::claim_staker_rewards_ongoing_period(max_span_length)
                .max(T::WeightInfo::claim_staker_rewards_past_period(max_span_length))
        })]
        pub fn claim_staker_rewards(origin: OriginFor<T>) -> DispatchResultWithPostInfo {
            Self::ensure_pallet_enabled()?;
            let account = ensure_signed(origin)?;

            Self::internal_claim_staker_rewards_for(account)
        }

        /// Used to claim bonus reward for a smart contract, if eligible.
        #[pallet::call_index(14)]
        #[pallet::weight(T::WeightInfo::claim_bonus_reward())]
        pub fn claim_bonus_reward(
            origin: OriginFor<T>,
            smart_contract: T::SmartContract,
        ) -> DispatchResult {
            Self::ensure_pallet_enabled()?;
            let account = ensure_signed(origin)?;

            Self::internal_claim_bonus_reward_for(account, smart_contract)
        }

        /// Used to claim dApp reward for the specified era.
        #[pallet::call_index(15)]
        #[pallet::weight(T::WeightInfo::claim_dapp_reward())]
        pub fn claim_dapp_reward(
            origin: OriginFor<T>,
            smart_contract: T::SmartContract,
            #[pallet::compact] era: EraNumber,
        ) -> DispatchResult {
            Self::ensure_pallet_enabled()?;

            // To keep in line with legacy behavior, dApp rewards can be claimed by anyone.
            let _ = ensure_signed(origin)?;

            let dapp_info =
                IntegratedDApps::<T>::get(&smart_contract).ok_or(Error::<T>::ContractNotFound)?;

            // Make sure provided era has ended
            let protocol_state = ActiveProtocolState::<T>::get();
            ensure!(era < protocol_state.era, Error::<T>::InvalidClaimEra);

            // 'Consume' dApp reward for the specified era, if possible.
            let mut dapp_tiers = DAppTiers::<T>::get(&era).ok_or(Error::<T>::NoDAppTierInfo)?;
            ensure!(
                dapp_tiers.period >= Self::oldest_claimable_period(protocol_state.period_number()),
                Error::<T>::RewardExpired
            );

            let (amount, ranked_tier) =
                dapp_tiers
                    .try_claim(dapp_info.id)
                    .map_err(|error| match error {
                        DAppTierError::NoDAppInTiers => Error::<T>::NoClaimableRewards,
                        _ => Error::<T>::InternalClaimDAppError,
                    })?;

            let (tier_id, rank) = ranked_tier.deconstruct();

            // Get reward destination, and deposit the reward.
            let beneficiary = dapp_info.reward_beneficiary();
            T::StakingRewardHandler::payout_reward(&beneficiary, amount)
                .map_err(|_| Error::<T>::RewardPayoutFailed)?;

            // Write back updated struct to prevent double reward claims
            DAppTiers::<T>::insert(&era, dapp_tiers);

            Self::deposit_event(Event::<T>::DAppReward {
                beneficiary: beneficiary.clone(),
                smart_contract,
                tier_id,
                rank,
                era,
                amount,
            });

            Ok(())
        }

        /// Used to unstake funds from a contract that was unregistered after an account staked on it.
        /// This is required if staker wants to re-stake these funds on another active contract during the ongoing period.
        #[pallet::call_index(16)]
        #[pallet::weight(T::WeightInfo::unstake_from_unregistered())]
        pub fn unstake_from_unregistered(
            origin: OriginFor<T>,
            smart_contract: T::SmartContract,
        ) -> DispatchResult {
            Self::ensure_pallet_enabled()?;
            let account = ensure_signed(origin)?;

            ensure!(
                !IntegratedDApps::<T>::contains_key(&smart_contract),
                Error::<T>::ContractStillActive
            );

            let protocol_state = ActiveProtocolState::<T>::get();
            let current_era = protocol_state.era;

            // Extract total staked amount on the specified unregistered contract
            let amount = match StakerInfo::<T>::get(&account, &smart_contract) {
                Some(staking_info) => {
                    ensure!(
                        staking_info.period_number() == protocol_state.period_number(),
                        Error::<T>::UnstakeFromPastPeriod
                    );

                    staking_info.total_staked_amount()
                }
                None => {
                    return Err(Error::<T>::NoStakingInfo.into());
                }
            };

            // Reduce stake amount in ledger
            let mut ledger = Ledger::<T>::get(&account);
            ledger
                .unstake_amount(amount, current_era, protocol_state.period_info)
                .map_err(|err| match err {
                    // These are all defensive checks, which should never fail since we already checked them above.
                    AccountLedgerError::InvalidPeriod | AccountLedgerError::InvalidEra => {
                        Error::<T>::UnclaimedRewards
                    }
                    _ => Error::<T>::InternalUnstakeError,
                })?;

            // Update total staked amount for the next era.
            // This means 'fake' stake total amount has been kept until now, even though contract was unregistered.
            // Although strange, it's been requested to keep it like this from the team.
            CurrentEraInfo::<T>::mutate(|era_info| {
                era_info.unstake_amount(amount);
            });

            // Update remaining storage entries
            Self::update_ledger(&account, ledger)?;
            StakerInfo::<T>::remove(&account, &smart_contract);

            Self::deposit_event(Event::<T>::UnstakeFromUnregistered {
                account,
                smart_contract,
                amount,
            });

            Ok(())
        }

        /// Cleanup expired stake entries for the contract.
        ///
        /// Entry is considered to be expired if:
        /// 1. It's from a past period & the account wasn't a loyal staker, meaning there's no claimable bonus reward.
        /// 2. It's from a period older than the oldest claimable period, regardless whether the account was loyal or not.
        #[pallet::call_index(17)]
        #[pallet::weight(T::WeightInfo::cleanup_expired_entries(
            T::MaxNumberOfStakedContracts::get()
        ))]
        pub fn cleanup_expired_entries(origin: OriginFor<T>) -> DispatchResultWithPostInfo {
            Self::ensure_pallet_enabled()?;
            let account = ensure_signed(origin)?;

            let protocol_state = ActiveProtocolState::<T>::get();
            let current_period = protocol_state.period_number();
            let threshold_period = Self::oldest_claimable_period(current_period);

            // Find all entries which are from past periods & don't have claimable bonus rewards.
            // This is bounded by max allowed number of stake entries per account.
            let to_be_deleted: Vec<T::SmartContract> = StakerInfo::<T>::iter_prefix(&account)
                .filter_map(|(smart_contract, stake_info)| {
                    if stake_info.period_number() < current_period && !stake_info.is_loyal()
                        || stake_info.period_number() < threshold_period
                    {
                        Some(smart_contract)
                    } else {
                        None
                    }
                })
                .collect();
            let entries_to_delete = to_be_deleted.len();

            ensure!(!entries_to_delete.is_zero(), Error::<T>::NoExpiredEntries);

            // Remove all expired entries.
            for smart_contract in to_be_deleted {
                StakerInfo::<T>::remove(&account, &smart_contract);
            }

            // Remove expired stake entries from the ledger.
            let mut ledger = Ledger::<T>::get(&account);
            ledger
                .contract_stake_count
                .saturating_reduce(entries_to_delete.unique_saturated_into());
            ledger.maybe_cleanup_expired(threshold_period); // Not necessary but we do it for the sake of consistency
            Self::update_ledger(&account, ledger)?;

            Self::deposit_event(Event::<T>::ExpiredEntriesRemoved {
                account,
                count: entries_to_delete.unique_saturated_into(),
            });

            Ok(Some(T::WeightInfo::cleanup_expired_entries(
                entries_to_delete.unique_saturated_into(),
            ))
            .into())
        }

        /// Used to force a change of era or subperiod.
        /// The effect isn't immediate but will happen on the next block.
        ///
        /// Used for testing purposes, when we want to force an era change, or a subperiod change.
        /// Not intended to be used in production, except in case of unforeseen circumstances.
        ///
        /// Can only be called by the root origin.
        #[pallet::call_index(18)]
        #[pallet::weight(T::WeightInfo::force())]
        pub fn force(origin: OriginFor<T>, forcing_type: ForcingType) -> DispatchResult {
            Self::ensure_pallet_enabled()?;
            ensure_root(origin)?;

            ensure!(!Safeguard::<T>::get(), Error::<T>::ForceNotAllowed);

            // Ensure a 'change' happens on the next block
            ActiveProtocolState::<T>::mutate(|state| {
                let current_block = frame_system::Pallet::<T>::block_number();
                state.next_era_start = current_block.saturating_add(One::one()).saturated_into();

                match forcing_type {
                    ForcingType::Era => (),
                    ForcingType::Subperiod => {
                        state.period_info.next_subperiod_start_era = state.era.saturating_add(1);
                    }
                }

                //       Right now it won't account for the full weight incurred by calling this notification.
                //       It's not a big problem since this call is not expected to be called ever in production.
                //       Also, in case of subperiod forcing, the alignment will be broken but since this is only call for testing,
                //       we don't need to concern ourselves with it.
                Self::notify_block_before_new_era(&state);
            });

            Self::deposit_event(Event::<T>::Force { forcing_type });

            Ok(())
        }

        /// Claims some staker rewards for the specified account, if they have any.
        /// In the case of a successful call, at least one era will be claimed, with the possibility of multiple claims happening.
        #[pallet::call_index(19)]
        #[pallet::weight({
            let max_span_length = T::EraRewardSpanLength::get();
            T::WeightInfo::claim_staker_rewards_ongoing_period(max_span_length)
                .max(T::WeightInfo::claim_staker_rewards_past_period(max_span_length))
        })]
        pub fn claim_staker_rewards_for(
            origin: OriginFor<T>,
            account: T::AccountId,
        ) -> DispatchResultWithPostInfo {
            Self::ensure_pallet_enabled()?;
            ensure_signed(origin)?;

            Self::internal_claim_staker_rewards_for(account)
        }

        /// Used to claim bonus reward for a smart contract on behalf of the specified account, if eligible.
        #[pallet::call_index(20)]
        #[pallet::weight(T::WeightInfo::claim_bonus_reward())]
        pub fn claim_bonus_reward_for(
            origin: OriginFor<T>,
            account: T::AccountId,
            smart_contract: T::SmartContract,
        ) -> DispatchResult {
            Self::ensure_pallet_enabled()?;
            ensure_signed(origin)?;

            Self::internal_claim_bonus_reward_for(account, smart_contract)
        }
    }

    impl<T: Config> Pallet<T> {
        /// `true` if the account is a staker, `false` otherwise.
        pub fn is_staker(account: &T::AccountId) -> bool {
            Ledger::<T>::contains_key(account)
        }

        /// `Err` if pallet disabled for maintenance, `Ok` otherwise.
        pub(crate) fn ensure_pallet_enabled() -> Result<(), Error<T>> {
            if ActiveProtocolState::<T>::get().maintenance {
                Err(Error::<T>::Disabled)
            } else {
                Ok(())
            }
        }

        /// Update the account ledger, and dApp staking balance freeze.
        ///
        /// In case account ledger is empty, entries from the DB are removed and freeze is thawed.
        ///
        /// This call can fail if the `freeze` or `thaw` operations fail. This should never happen since
        /// runtime definition must ensure it supports necessary freezes.
        pub(crate) fn update_ledger(
            account: &T::AccountId,
            ledger: AccountLedgerFor<T>,
        ) -> Result<(), DispatchError> {
            if ledger.is_empty() {
                Ledger::<T>::remove(&account);
                T::Currency::thaw(&FreezeReason::DAppStaking.into(), account)?;
            } else {
                T::Currency::set_freeze(
                    &FreezeReason::DAppStaking.into(),
                    account,
                    ledger.total_locked_amount(),
                )?;
                Ledger::<T>::insert(account, ledger);
            }

            Ok(())
        }

        /// Returns the number of blocks per voting period.
        pub(crate) fn blocks_per_voting_period() -> BlockNumber {
            T::CycleConfiguration::blocks_per_era()
                .saturating_mul(T::CycleConfiguration::eras_per_voting_subperiod().into())
        }

        /// Calculates the `EraRewardSpan` index for the specified era.
        pub fn era_reward_span_index(era: EraNumber) -> EraNumber {
            era.saturating_sub(era % T::EraRewardSpanLength::get())
        }

        /// Return the oldest period for which rewards can be claimed.
        /// All rewards before that period are considered to be expired.
        pub(crate) fn oldest_claimable_period(current_period: PeriodNumber) -> PeriodNumber {
            current_period.saturating_sub(T::RewardRetentionInPeriods::get())
        }

        /// Unlocking period expressed in the number of blocks.
        pub fn unlocking_period() -> BlockNumber {
            T::CycleConfiguration::blocks_per_era().saturating_mul(T::UnlockingPeriod::get().into())
        }

        /// Returns the dApp tier assignment for the current era, based on the current stake amounts.
        pub fn get_dapp_tier_assignment() -> BTreeMap<DAppId, RankedTier> {
            let protocol_state = ActiveProtocolState::<T>::get();

            let (dapp_tiers, _count) = Self::get_dapp_tier_assignment_and_rewards(
                protocol_state.era,
                protocol_state.period_number(),
                Balance::zero(),
            );

            dapp_tiers.dapps.into_inner()
        }

        /// Assign eligible dApps into appropriate tiers, and calculate reward for each tier.
        ///
        /// ### Algorithm
        ///
        /// 1. Read in over all contract stake entries. In case staked amount is zero for the current era, ignore it.
        ///    This information is used to calculate 'score' per dApp, which is used to determine the tier.
        ///
        /// 2. Sort the entries by the score, in descending order - the top score dApp comes first.
        ///
        /// 3. Calculate rewards for each tier.
        ///    This is done by dividing the total reward pool into tier reward pools,
        ///    after which the tier reward pool is divided by the number of available slots in the tier.
        ///
        /// 4. Read in tier configuration. This contains information about how many slots per tier there are,
        ///    as well as the threshold for each tier. Threshold is the minimum amount of stake required to be eligible for a tier.
        ///    Iterate over tier thresholds & capacities, starting from the top tier, and assign dApps to them.
        ///
        ///    ```text
        ////   for each tier:
        ///        for each unassigned dApp:
        ///            if tier has capacity && dApp satisfies the tier threshold:
        ///                add dapp to the tier
        ///            else:
        ///               exit loop since no more dApps will satisfy the threshold since they are sorted by score
        ///    ```
        ///    (Sort the entries by dApp ID, in ascending order. This is so we can efficiently search for them using binary search.)
        ///
        /// The returned object contains information about each dApp that made it into a tier.
        /// Alongside tier assignment info, number of read DB contract stake entries is returned.
        pub(crate) fn get_dapp_tier_assignment_and_rewards(
            era: EraNumber,
            period: PeriodNumber,
            dapp_reward_pool: Balance,
        ) -> (DAppTierRewardsFor<T>, DAppId) {
            let mut dapp_stakes = Vec::with_capacity(T::MaxNumberOfContracts::get() as usize);

            // 1.
            // Iterate over all staked dApps.
            // This is bounded by max amount of dApps we allow to be registered.
            let mut counter = 0;
            for (dapp_id, stake_amount) in ContractStake::<T>::iter() {
                counter.saturating_inc();

                // Skip dApps which don't have ANY amount staked
                if let Some(stake_amount) = stake_amount.get(era, period) {
                    if !stake_amount.total().is_zero() {
                        dapp_stakes.push((dapp_id, stake_amount.total()));
                    }
                }
            }

            // 2.
            // Sort by amount staked, in reverse - top dApp will end in the first place, 0th index.
            dapp_stakes.sort_unstable_by(|(_, amount_1), (_, amount_2)| amount_2.cmp(amount_1));

            let tier_config = TierConfig::<T>::get();

            // In case when tier has 1 more free slot, but two dApps with exactly same score satisfy the threshold,
            // one of them will be assigned to the tier, and the other one will be assigned to the lower tier, if it exists.
            //
            // In the current implementation, the dApp with the lower dApp Id has the advantage.
            // There is no guarantee this will persist in the future, so it's best for dApps to do their
            // best to avoid getting themselves into such situations.

            // 3. Calculate rewards.
            let tier_rewards = tier_config
                .reward_portion
                .iter()
                .zip(tier_config.slots_per_tier.iter())
                .map(|(percent, slots)| {
                    if slots.is_zero() {
                        Zero::zero()
                    } else {
                        *percent * dapp_reward_pool / <u16 as Into<Balance>>::into(*slots)
                    }
                })
                .collect::<Vec<_>>();

            // 4.
            // Iterate over configured tier and potential dApps.
            // Each dApp will be assigned to the best possible tier if it satisfies the required condition,
            // and tier capacity hasn't been filled yet.
            let mut dapp_tiers = BTreeMap::new();
            let mut tier_slots = BTreeMap::new();

            let mut upper_bound = Balance::zero();
            let mut rank_rewards = Vec::new();

            for (tier_id, (tier_capacity, lower_bound)) in tier_config
                .slots_per_tier
                .iter()
                .zip(tier_config.tier_thresholds.iter())
                .enumerate()
            {
                // Iterate over dApps until one of two conditions has been met:
                // 1. Tier has no more capacity
                // 2. dApp doesn't satisfy the tier threshold (since they're sorted, none of the following dApps will satisfy the condition either)
                for (dapp_id, staked_amount) in dapp_stakes
                    .iter()
                    .skip(dapp_tiers.len())
                    .take_while(|(_, amount)| amount.ge(lower_bound))
                    .take(*tier_capacity as usize)
                {
                    let rank = if T::RankingEnabled::get() {
                        RankedTier::find_rank(*lower_bound, upper_bound, *staked_amount)
                    } else {
                        0
                    };
                    tier_slots.insert(*dapp_id, RankedTier::new_saturated(tier_id as u8, rank));
                }

                // sum of all ranks for this tier
                let ranks_sum = tier_slots
                    .iter()
                    .fold(0u32, |accum, (_, x)| accum.saturating_add(x.rank().into()));

                let reward_per_rank = if ranks_sum.is_zero() {
                    Balance::zero()
                } else {
                    // calculate reward per rank
                    let tier_reward = tier_rewards.get(tier_id).copied().unwrap_or_default();
                    let empty_slots = tier_capacity.saturating_sub(tier_slots.len() as u16);
                    let remaining_reward = tier_reward.saturating_mul(empty_slots.into());
                    // make sure required reward doesn't exceed remaining reward
                    let reward_per_rank = tier_reward.saturating_div(RankedTier::MAX_RANK.into());
                    let expected_reward_for_ranks =
                        reward_per_rank.saturating_mul(ranks_sum.into());
                    let reward_for_ranks = expected_reward_for_ranks.min(remaining_reward);
                    // re-calculate reward per rank based on available reward
                    reward_for_ranks.saturating_div(ranks_sum.into())
                };

                rank_rewards.push(reward_per_rank);
                dapp_tiers.append(&mut tier_slots);
                upper_bound = *lower_bound; // current threshold becomes upper bound for next tier
            }

            // 5.
            // Prepare and return tier & rewards info.
            // In case rewards creation fails, we just write the default value. This should never happen though.
            (
                DAppTierRewards::<T::MaxNumberOfContracts, T::NumberOfTiers>::new(
                    dapp_tiers,
                    tier_rewards,
                    period,
                    rank_rewards,
                )
                .unwrap_or_default(),
                counter,
            )
        }

        /// Used to handle era & period transitions.
        pub(crate) fn era_and_period_handler(
            now: BlockNumber,
            tier_assignment: TierAssignment,
        ) -> Weight {
            let mut protocol_state = ActiveProtocolState::<T>::get();

            // `ActiveProtocolState` is whitelisted, so we need to account for its read.
            let mut consumed_weight = T::DbWeight::get().reads(1);

            // We should not modify pallet storage while in maintenance mode.
            // This is a safety measure, since maintenance mode is expected to be
            // enabled in case some misbehavior or corrupted storage is detected.
            if protocol_state.maintenance {
                return consumed_weight;
            }

            // Inform observers about the upcoming new era, if it's the case.
            if protocol_state.next_era_start == now.saturating_add(1) {
                consumed_weight
                    .saturating_accrue(Self::notify_block_before_new_era(&protocol_state));
            }

            // Nothing to do if it's not new era
            if !protocol_state.is_new_era(now) {
                return consumed_weight;
            }

            // At this point it's clear that an era change will happen
            let mut era_info = CurrentEraInfo::<T>::get();

            let current_era = protocol_state.era;
            let next_era = current_era.saturating_add(1);
            let (maybe_period_event, era_reward) = match protocol_state.subperiod() {
                // Voting subperiod only lasts for one 'prolonged' era
                Subperiod::Voting => {
                    // For the sake of consistency, we put zero reward into storage. There are no rewards for the voting subperiod.
                    let era_reward = EraReward {
                        staker_reward_pool: Balance::zero(),
                        staked: era_info.total_staked_amount(),
                        dapp_reward_pool: Balance::zero(),
                    };

                    let next_subperiod_start_era = next_era
                        .saturating_add(T::CycleConfiguration::eras_per_build_and_earn_subperiod());
                    let build_and_earn_start_block =
                        now.saturating_add(T::CycleConfiguration::blocks_per_era());
                    protocol_state.advance_to_next_subperiod(
                        next_subperiod_start_era,
                        build_and_earn_start_block,
                    );

                    era_info.migrate_to_next_era(Some(protocol_state.subperiod()));

                    consumed_weight
                        .saturating_accrue(T::WeightInfo::on_initialize_voting_to_build_and_earn());

                    (
                        Some(Event::<T>::NewSubperiod {
                            subperiod: protocol_state.subperiod(),
                            number: protocol_state.period_number(),
                        }),
                        era_reward,
                    )
                }
                Subperiod::BuildAndEarn => {
                    let staked = era_info.total_staked_amount();
                    let (staker_reward_pool, dapp_reward_pool) =
                        T::StakingRewardHandler::staker_and_dapp_reward_pools(staked);
                    let era_reward = EraReward {
                        staker_reward_pool,
                        staked,
                        dapp_reward_pool,
                    };

                    // Distribute dapps into tiers, write it into storage
                    //
                    // To help with benchmarking, it's possible to omit real tier calculation using the `Dummy` approach.
                    // This must never be used in production code, obviously.
                    let (dapp_tier_rewards, counter) = match tier_assignment {
                        TierAssignment::Real => Self::get_dapp_tier_assignment_and_rewards(
                            current_era,
                            protocol_state.period_number(),
                            dapp_reward_pool,
                        ),
                        #[cfg(feature = "runtime-benchmarks")]
                        TierAssignment::Dummy => (DAppTierRewardsFor::<T>::default(), 0),
                    };
                    DAppTiers::<T>::insert(&current_era, dapp_tier_rewards);

                    consumed_weight
                        .saturating_accrue(T::WeightInfo::dapp_tier_assignment(counter.into()));

                    // Switch to `Voting` period if conditions are met.
                    if protocol_state.period_info.is_next_period(next_era) {
                        // Store info about period end
                        let bonus_reward_pool = T::StakingRewardHandler::bonus_reward_pool();
                        PeriodEnd::<T>::insert(
                            &protocol_state.period_number(),
                            PeriodEndInfo {
                                bonus_reward_pool,
                                total_vp_stake: era_info.staked_amount(Subperiod::Voting),
                                final_era: current_era,
                            },
                        );

                        // For the sake of consistency we treat the whole `Voting` period as a single era.
                        // This means no special handling is required for this period, it only lasts potentially longer than a single standard era.
                        let next_subperiod_start_era = next_era.saturating_add(1);
                        let voting_period_length = Self::blocks_per_voting_period();
                        let next_era_start_block = now.saturating_add(voting_period_length);

                        protocol_state.advance_to_next_subperiod(
                            next_subperiod_start_era,
                            next_era_start_block,
                        );

                        era_info.migrate_to_next_era(Some(protocol_state.subperiod()));

                        // Update historical cleanup marker.
                        // Must be called with the new period number.
                        Self::update_cleanup_marker(protocol_state.period_number());

                        consumed_weight.saturating_accrue(
                            T::WeightInfo::on_initialize_build_and_earn_to_voting(),
                        );

                        (
                            Some(Event::<T>::NewSubperiod {
                                subperiod: protocol_state.subperiod(),
                                number: protocol_state.period_number(),
                            }),
                            era_reward,
                        )
                    } else {
                        let next_era_start_block =
                            now.saturating_add(T::CycleConfiguration::blocks_per_era());
                        protocol_state.next_era_start = next_era_start_block;

                        era_info.migrate_to_next_era(None);

                        consumed_weight.saturating_accrue(
                            T::WeightInfo::on_initialize_build_and_earn_to_build_and_earn(),
                        );

                        (None, era_reward)
                    }
                }
            };

            // Update storage items
            protocol_state.era = next_era;
            ActiveProtocolState::<T>::put(protocol_state);

            CurrentEraInfo::<T>::put(era_info);

            let era_span_index = Self::era_reward_span_index(current_era);
            let mut span = EraRewards::<T>::get(&era_span_index).unwrap_or(EraRewardSpan::new());
            if let Err(_) = span.push(current_era, era_reward) {
                // This must never happen but we log the error just in case.
                log::error!(
                    target: LOG_TARGET,
                    "Failed to push era {} into the era reward span.",
                    current_era
                );
            }
            EraRewards::<T>::insert(&era_span_index, span);

            // Re-calculate tier configuration for the upcoming new era
            let tier_params = StaticTierParams::<T>::get();
            let average_price = T::NativePriceProvider::average_price();
            let total_issuance = T::Currency::total_issuance();

            let new_tier_config =
                TierConfig::<T>::get().calculate_new(&tier_params, average_price, total_issuance);

            // Validate new tier configuration
            if new_tier_config.is_valid() {
                TierConfig::<T>::put(new_tier_config);
            } else {
                log::warn!(
                    target: LOG_TARGET,
                    "New tier configuration is invalid for era {}, preserving old one.",
                    next_era
                );
            }

            Self::deposit_event(Event::<T>::NewEra { era: next_era });
            if let Some(period_event) = maybe_period_event {
                Self::deposit_event(period_event);
            }

            consumed_weight
        }

        /// Used to notify observers about the upcoming new era in the next block.
        fn notify_block_before_new_era(protocol_state: &ProtocolState) -> Weight {
            let next_era = protocol_state.era.saturating_add(1);
            T::Observers::block_before_new_era(next_era)
        }

        /// Updates the cleanup marker with the new oldest valid era if possible.
        ///
        /// It's possible that the call will be a no-op since we haven't advanced enough periods yet.
        fn update_cleanup_marker(new_period_number: PeriodNumber) {
            // 1. Find out the latest expired period; rewards can no longer be claimed for it or any older period.
            let latest_expired_period = match new_period_number
                .checked_sub(T::RewardRetentionInPeriods::get().saturating_add(1))
            {
                Some(period) if !period.is_zero() => period,
                // Haven't advanced enough periods to have any expired entries.
                _ => return,
            };

            // 2. Find the oldest valid era for which rewards can still be claimed.
            //    Technically, this will be `Voting` subperiod era but it doesn't matter.
            //
            //    Also, remove the expired `PeriodEnd` entry since it's no longer needed.
            let oldest_valid_era = match PeriodEnd::<T>::take(latest_expired_period) {
                Some(period_end_info) => period_end_info.final_era.saturating_add(1),
                None => {
                    // Should never happen but nothing we can do if it does.
                    log::error!(
                        target: LOG_TARGET,
                        "No `PeriodEnd` entry for the expired period: {}",
                        latest_expired_period
                    );
                    return;
                }
            };

            // 3. Update the cleanup marker with the new oldest valid era.
            HistoryCleanupMarker::<T>::mutate(|marker| {
                marker.oldest_valid_era = oldest_valid_era;
            });
        }

        /// Attempt to cleanup some expired entries, if enough remaining weight & applicable entries exist.
        ///
        /// Returns consumed weight.
        fn expired_entry_cleanup(remaining_weight: &Weight) -> Weight {
            // Need to be able to process one full pass
            if remaining_weight.any_lt(T::WeightInfo::on_idle_cleanup()) {
                return Weight::zero();
            }

            // Get the cleanup marker and ensure we have pending cleanups.
            let mut cleanup_marker = HistoryCleanupMarker::<T>::get();
            if !cleanup_marker.has_pending_cleanups() {
                return T::DbWeight::get().reads(1);
            }

            // 1. Attempt to cleanup one expired `EraRewards` entry.
            if cleanup_marker.era_reward_index < cleanup_marker.oldest_valid_era {
                if let Some(era_reward) = EraRewards::<T>::get(cleanup_marker.era_reward_index) {
                    // If oldest valid era comes AFTER this span, it's safe to delete it.
                    if era_reward.last_era() < cleanup_marker.oldest_valid_era {
                        EraRewards::<T>::remove(cleanup_marker.era_reward_index);
                        cleanup_marker
                            .era_reward_index
                            .saturating_accrue(T::EraRewardSpanLength::get());
                    }
                } else {
                    // Can happen if the entry is part of history before dApp staking v3
                    log::warn!(
                        target: LOG_TARGET,
                        "Era rewards span for era {} is missing, but cleanup marker is set.",
                        cleanup_marker.era_reward_index
                    );
                    cleanup_marker
                        .era_reward_index
                        .saturating_accrue(T::EraRewardSpanLength::get());
                }
            }

            // 2. Attempt to cleanup one expired `DAppTiers` entry.
            if cleanup_marker.dapp_tiers_index < cleanup_marker.oldest_valid_era {
                DAppTiers::<T>::remove(cleanup_marker.dapp_tiers_index);
                cleanup_marker.dapp_tiers_index.saturating_inc();
            }

            // Store the updated cleanup marker
            HistoryCleanupMarker::<T>::put(cleanup_marker);

            // We could try & cleanup more entries, but since it's not a critical operation and can happen whenever,
            // we opt for the simpler solution where only 1 entry per block is cleaned up.
            // It can be changed though.

            // It could end up being less than this weight, but this won't occur often enough to be important.
            T::WeightInfo::on_idle_cleanup()
        }

        /// Internal function that executes the `claim_unlocked` logic for the specified account.
        fn internal_claim_unlocked(account: T::AccountId) -> DispatchResultWithPostInfo {
            let mut ledger = Ledger::<T>::get(&account);

            let current_block = frame_system::Pallet::<T>::block_number();
            let amount = ledger.claim_unlocked(current_block.saturated_into());
            ensure!(amount > Zero::zero(), Error::<T>::NoUnlockedChunksToClaim);

            // In case it's full unlock, account is exiting dApp staking, ensure all storage is cleaned up.
            let removed_entries = if ledger.is_empty() {
                let _ = StakerInfo::<T>::clear_prefix(&account, ledger.contract_stake_count, None);
                ledger.contract_stake_count
            } else {
                0
            };

            Self::update_ledger(&account, ledger)?;
            CurrentEraInfo::<T>::mutate(|era_info| {
                era_info.unlocking_removed(amount);
            });

            Self::deposit_event(Event::<T>::ClaimedUnlocked { account, amount });

            Ok(Some(T::WeightInfo::claim_unlocked(removed_entries)).into())
        }

        /// Internal function that executes the `claim_staker_rewards_` logic for the specified account.
        fn internal_claim_staker_rewards_for(account: T::AccountId) -> DispatchResultWithPostInfo {
            let mut ledger = Ledger::<T>::get(&account);
            let staked_period = ledger
                .staked_period()
                .ok_or(Error::<T>::NoClaimableRewards)?;

            // Check if the rewards have expired
            let protocol_state = ActiveProtocolState::<T>::get();
            ensure!(
                staked_period >= Self::oldest_claimable_period(protocol_state.period_number()),
                Error::<T>::RewardExpired
            );

            // Calculate the reward claim span
            let earliest_staked_era = ledger
                .earliest_staked_era()
                .ok_or(Error::<T>::InternalClaimStakerError)?;
            let era_rewards =
                EraRewards::<T>::get(Self::era_reward_span_index(earliest_staked_era))
                    .ok_or(Error::<T>::NoClaimableRewards)?;

            // The last era for which we can theoretically claim rewards.
            // And indicator if we know the period's ending era.
            let (last_period_era, period_end) = if staked_period == protocol_state.period_number() {
                (protocol_state.era.saturating_sub(1), None)
            } else {
                PeriodEnd::<T>::get(&staked_period)
                    .map(|info| (info.final_era, Some(info.final_era)))
                    .ok_or(Error::<T>::InternalClaimStakerError)?
            };

            // The last era for which we can claim rewards for this account.
            let last_claim_era = era_rewards.last_era().min(last_period_era);

            // Get chunks for reward claiming
            let rewards_iter =
                ledger
                    .claim_up_to_era(last_claim_era, period_end)
                    .map_err(|err| match err {
                        AccountLedgerError::NothingToClaim => Error::<T>::NoClaimableRewards,
                        _ => Error::<T>::InternalClaimStakerError,
                    })?;

            // Calculate rewards
            let mut rewards: Vec<_> = Vec::new();
            let mut reward_sum = Balance::zero();
            for (era, amount) in rewards_iter {
                let era_reward = era_rewards
                    .get(era)
                    .ok_or(Error::<T>::InternalClaimStakerError)?;

                // Optimization, and zero-division protection
                if amount.is_zero() || era_reward.staked.is_zero() {
                    continue;
                }
                let staker_reward = Perbill::from_rational(amount, era_reward.staked)
                    * era_reward.staker_reward_pool;

                rewards.push((era, staker_reward));
                reward_sum.saturating_accrue(staker_reward);
            }
            let rewards_len: u32 = rewards.len().unique_saturated_into();

            T::StakingRewardHandler::payout_reward(&account, reward_sum)
                .map_err(|_| Error::<T>::RewardPayoutFailed)?;

            Self::update_ledger(&account, ledger)?;

            rewards.into_iter().for_each(|(era, reward)| {
                Self::deposit_event(Event::<T>::Reward {
                    account: account.clone(),
                    era,
                    amount: reward,
                });
            });

            Ok(Some(if period_end.is_some() {
                T::WeightInfo::claim_staker_rewards_past_period(rewards_len)
            } else {
                T::WeightInfo::claim_staker_rewards_ongoing_period(rewards_len)
            })
            .into())
        }

        /// Internal function that executes the `claim_bonus_reward` logic for the specified account & smart contract.
        fn internal_claim_bonus_reward_for(
            account: T::AccountId,
            smart_contract: T::SmartContract,
        ) -> DispatchResult {
            let staker_info = StakerInfo::<T>::get(&account, &smart_contract)
                .ok_or(Error::<T>::NoClaimableRewards)?;
            let protocol_state = ActiveProtocolState::<T>::get();

            // Ensure:
            // 1. Period for which rewards are being claimed has ended.
            // 2. Account has been a loyal staker.
            // 3. Rewards haven't expired.
            let staked_period = staker_info.period_number();
            ensure!(
                staked_period < protocol_state.period_number(),
                Error::<T>::NoClaimableRewards
            );
            ensure!(
                staker_info.is_loyal(),
                Error::<T>::NotEligibleForBonusReward
            );
            ensure!(
                staker_info.period_number()
                    >= Self::oldest_claimable_period(protocol_state.period_number()),
                Error::<T>::RewardExpired
            );

            let period_end_info =
                PeriodEnd::<T>::get(&staked_period).ok_or(Error::<T>::InternalClaimBonusError)?;
            // Defensive check - we should never get this far in function if no voting period stake exists.
            ensure!(
                !period_end_info.total_vp_stake.is_zero(),
                Error::<T>::InternalClaimBonusError
            );

            let eligible_amount = staker_info.staked_amount(Subperiod::Voting);
            let bonus_reward =
                Perbill::from_rational(eligible_amount, period_end_info.total_vp_stake)
                    * period_end_info.bonus_reward_pool;

            T::StakingRewardHandler::payout_reward(&account, bonus_reward)
                .map_err(|_| Error::<T>::RewardPayoutFailed)?;

            // Cleanup entry since the reward has been claimed
            StakerInfo::<T>::remove(&account, &smart_contract);
            Ledger::<T>::mutate(&account, |ledger| {
                ledger.contract_stake_count.saturating_dec();
            });

            Self::deposit_event(Event::<T>::BonusReward {
                account: account.clone(),
                smart_contract,
                period: staked_period,
                amount: bonus_reward,
            });

            Ok(())
        }

        /// Ensure the correctness of the state of this pallet.
        #[cfg(any(feature = "try-runtime", test))]
        pub fn do_try_state() -> Result<(), sp_runtime::TryRuntimeError> {
            Self::try_state_protocol()?;
            Self::try_state_next_dapp_id()?;
            Self::try_state_integrated_dapps()?;
            Self::try_state_tiers()?;
            Self::try_state_ledger()?;
            Self::try_state_contract_stake()?;
            Self::try_state_era_rewards()?;

            Ok(())
        }

        /// ### Invariants of active protocol storage items
        ///
        /// 1. [`PeriodInfo`] number in [`ActiveProtocolState`] must always be greater than the number of elements in [`PeriodEnd`].
        /// 2. Ensures the `era` number and `next_era_start` block number are valid.
        #[cfg(any(feature = "try-runtime", test))]
        pub fn try_state_protocol() -> Result<(), sp_runtime::TryRuntimeError> {
            let protocol_state = ActiveProtocolState::<T>::get();

            // Invariant 1
            if PeriodEnd::<T>::iter().count() >= protocol_state.period_info.number as usize {
                return Err("Number of periods in `PeriodEnd` exceeds or is equal to actual `PeriodInfo` number.".into());
            }

            // Invariant 2
            if protocol_state.era == 0 {
                return Err("Invalid era number in ActiveProtocolState.".into());
            }

            let current_block: BlockNumber =
                frame_system::Pallet::<T>::block_number().saturated_into();
            if current_block > protocol_state.next_era_start {
                return Err(
                    "Next era start block number is in the past in ActiveProtocolState.".into(),
                );
            }

            Ok(())
        }

        /// ### Invariants of NextDAppId
        ///
        /// 1. [`NextDAppId`] must always be greater than or equal to the number of dapps in [`IntegratedDApps`].
        /// 2. [`NextDAppId`] must always be greater than or equal to the number of contracts in [`ContractStake`].
        #[cfg(any(feature = "try-runtime", test))]
        pub fn try_state_next_dapp_id() -> Result<(), sp_runtime::TryRuntimeError> {
            let next_dapp_id = NextDAppId::<T>::get();

            // Invariant 1
            if next_dapp_id < IntegratedDApps::<T>::count() as u16 {
                return Err("Number of integrated dapps is greater than NextDAppId.".into());
            }

            // Invariant 2
            if next_dapp_id < ContractStake::<T>::iter().count() as u16 {
                return Err("Number of contract stake infos is greater than NextDAppId.".into());
            }

            Ok(())
        }

        /// ### Invariants of IntegratedDApps
        ///
        /// 1. The number of entries in [`IntegratedDApps`] should not exceed the [`T::MaxNumberOfContracts`] constant.
        #[cfg(any(feature = "try-runtime", test))]
        pub fn try_state_integrated_dapps() -> Result<(), sp_runtime::TryRuntimeError> {
            let integrated_dapps_count = IntegratedDApps::<T>::count();
            let max_number_of_contracts = T::MaxNumberOfContracts::get();

            if integrated_dapps_count > max_number_of_contracts {
                return Err("Number of integrated dapps exceeds the maximum allowed.".into());
            }

            Ok(())
        }

        /// ### Invariants of StaticTierParams and TierConfig
        ///
        /// 1. The [`T::NumberOfTiers`] constant must always be equal to the number of `slot_distribution`, `reward_portion`, `tier_thresholds` in [`StaticTierParams`].
        /// 2. The [`T::NumberOfTiers`] constant must always be equal to the number of `slots_per_tier`, `reward_portion`, `tier_thresholds` in [`TierConfig`].
        #[cfg(any(feature = "try-runtime", test))]
        pub fn try_state_tiers() -> Result<(), sp_runtime::TryRuntimeError> {
            let nb_tiers = T::NumberOfTiers::get();
            let tier_params = StaticTierParams::<T>::get();
            let tier_config = TierConfig::<T>::get();

            // Invariant 1
            if nb_tiers != tier_params.slot_distribution.len() as u32 {
                return Err(
                    "Number of tiers is incorrect in slot_distribution in StaticTierParams.".into(),
                );
            }
            if nb_tiers != tier_params.reward_portion.len() as u32 {
                return Err(
                    "Number of tiers is incorrect in reward_portion in StaticTierParams.".into(),
                );
            }
            if nb_tiers != tier_params.tier_thresholds.len() as u32 {
                return Err(
                    "Number of tiers is incorrect in tier_thresholds in StaticTierParams.".into(),
                );
            }

            // Invariant 2
            if nb_tiers != tier_config.slots_per_tier.len() as u32 {
                return Err(
                    "Number of tiers is incorrect in slots_per_tier in StaticTierParams.".into(),
                );
            }
            if nb_tiers != tier_config.reward_portion.len() as u32 {
                return Err(
                    "Number of tiers is incorrect in reward_portion in StaticTierParams.".into(),
                );
            }
            if nb_tiers != tier_config.tier_thresholds.len() as u32 {
                return Err(
                    "Number of tiers is incorrect in tier_thresholds in StaticTierParams.".into(),
                );
            }

            Ok(())
        }

        /// ### Invariants of Ledger
        ///
        /// 1. Iterating over all [`Ledger`] accounts should yield the correct locked and stakes amounts compared to current era in [`CurrentEraInfo`].
        /// 2. The number of unlocking chunks in [`Ledger`] for any account should not exceed the [`T::MaxUnlockingChunks`] constant.
        /// 3. Each staking entry in [`Ledger`] should be greater than or equal to the [`T::MinimumStakeAmount`] constant.
        /// 4. Each locking entry in [`Ledger`] should be greater than or equal to the [`T::MinimumLockedAmount`] constant.
        /// 5. The number of staking entries per account in [`Ledger`] should not exceed the [`T::MaxNumberOfStakedContracts`] constant.
        #[cfg(any(feature = "try-runtime", test))]
        pub fn try_state_ledger() -> Result<(), sp_runtime::TryRuntimeError> {
            let current_period_number = ActiveProtocolState::<T>::get().period_number();
            let current_era_info = CurrentEraInfo::<T>::get();
            let current_era_total_stake = current_era_info.total_staked_amount_next_era();

            // Yield amounts in [`Ledger`]
            let mut ledger_total_stake = Balance::zero();
            let mut ledger_total_locked = Balance::zero();
            let mut ledger_total_unlocking = Balance::zero();

            for (_, ledger) in Ledger::<T>::iter() {
                let account_stake = ledger.staked_amount(current_period_number);

                ledger_total_stake += account_stake;
                ledger_total_locked += ledger.active_locked_amount();
                ledger_total_unlocking += ledger.unlocking_amount();

                // Invariant 2
                if ledger.unlocking.len() > T::MaxUnlockingChunks::get() as usize {
                    return Err("An account exceeds the maximum unlocking chunks.".into());
                }

                // Invariant 3
                if account_stake > Balance::zero() && account_stake < T::MinimumStakeAmount::get() {
                    return Err(
                        "An account has a stake amount lower than the minimum allowed.".into(),
                    );
                }

                // Invariant 4
                if ledger.active_locked_amount() > Balance::zero()
                    && ledger.active_locked_amount() < T::MinimumLockedAmount::get()
                {
                    return Err(
                        "An account has a locked amount lower than the minimum allowed.".into(),
                    );
                }

                // Invariant 5
                if ledger.contract_stake_count > T::MaxNumberOfStakedContracts::get() {
                    return Err("An account exceeds the maximum number of staked contracts.".into());
                }
            }

            // Invariant 1
            if ledger_total_stake != current_era_total_stake {
                return Err(
                    "Mismatch between Ledger total staked amounts and CurrentEraInfo total.".into(),
                );
            }

            if ledger_total_locked != current_era_info.total_locked {
                return Err(
                    "Mismatch between Ledger total locked amounts and CurrentEraInfo total.".into(),
                );
            }

            if ledger_total_unlocking != current_era_info.unlocking {
                return Err(
                    "Mismatch between Ledger total unlocked amounts and CurrentEraInfo total."
                        .into(),
                );
            }

            Ok(())
        }

        /// ### Invariants of ContractStake
        ///
        /// 1. Each staking entry in [`ContractStake`] should be greater than or equal to the [`T::MinimumStakeAmount`] constant.
        #[cfg(any(feature = "try-runtime", test))]
        pub fn try_state_contract_stake() -> Result<(), sp_runtime::TryRuntimeError> {
            let current_period_number = ActiveProtocolState::<T>::get().period_number();

            for (_, contract) in ContractStake::<T>::iter() {
                let contract_stake = contract.total_staked_amount(current_period_number);

                // Invariant 1
                if contract_stake > Balance::zero() && contract_stake < T::MinimumStakeAmount::get()
                {
                    return Err(
                        "A contract has a staked amount lower than the minimum allowed.".into(),
                    );
                }
            }

            Ok(())
        }

        /// ### Invariants of EraRewards
        ///
        /// 1. Era number in [`DAppTiers`] must also be stored in one of the span of [`EraRewards`].
        /// 2. Each span lenght entry in [`EraRewards`] should be lower than or equal to the [`T::EraRewardSpanLength`] constant.
        #[cfg(any(feature = "try-runtime", test))]
        pub fn try_state_era_rewards() -> Result<(), sp_runtime::TryRuntimeError> {
            let era_rewards = EraRewards::<T>::iter().collect::<Vec<_>>();
            let dapp_tiers = DAppTiers::<T>::iter().collect::<Vec<_>>();

            // Invariant 1
            for (era, _) in &dapp_tiers {
                let mut found = false;
                for (_, span) in &era_rewards {
                    if *era >= span.first_era() && *era <= span.last_era() {
                        found = true;
                        break;
                    }
                }

                // Invariant 1
                if !found {
                    return Err("Era in DAppTiers is not found in any span in EraRewards.".into());
                }
            }

            for (_, span) in &era_rewards {
                // Invariant 3
                if span.len() > T::EraRewardSpanLength::get() as usize {
                    return Err(
                        "Span length for a era exceeds the maximum allowed span length.".into(),
                    );
                }
            }

            Ok(())
        }
    }
}