git.delta.rocks / unique-network / refs/commits / 2e3b6c3dad3e

1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// This file is part of Unique Network.34// Unique Network is free software: you can redistribute it and/or modify5// it under the terms of the GNU General Public License as published by6// the Free Software Foundation, either version 3 of the License, or7// (at your option) any later version.89// Unique Network is distributed in the hope that it will be useful,10// but WITHOUT ANY WARRANTY; without even the implied warranty of11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the12// GNU General Public License for more details.1314// You should have received a copy of the GNU General Public License15// along with Unique Network. If not, see <http://www.gnu.org/licenses/>.1617//! # App Promotion pallet18//!19//! The pallet implements the mechanics of staking and sponsoring collections/contracts.20//!21//! - [`Config`]22//! - [`Pallet`]23//! - [`Error`]24//! - [`Event`]25//!26//! ## Overview27//! The App Promotion pallet allows fund holders to stake at a certain daily rate of return.28//! The mechanics implemented in the pallet allow it to act as a sponsor for collections / contracts,29//! the list of which is set by the pallet administrator.30//!31//!32//! ## Interface33//!	The pallet provides interfaces for funds, collection/contract operations (see [types] module).3435//!36//! ### Dispatchable Functions37//!	- [`set_admin_address`][`Pallet::set_admin_address`] - sets an address as the the admin.38//! - [`stake`][`Pallet::stake`] - stakes the amount of native tokens.39//! - [`unstake`][`Pallet::unstake`] - unstakes all stakes.40//! - [`sponsor_collection`][`Pallet::sponsor_collection`] - sets the pallet to be the sponsor for the collection.41//! - [`stop_sponsoring_collection`][`Pallet::stop_sponsoring_collection`] - removes the pallet as the sponsor for the collection.42//! - [`sponsor_contract`][`Pallet::sponsor_contract`] - sets the pallet to be the sponsor for the contract.43//! - [`stop_sponsoring_contract`][`Pallet::stop_sponsoring_contract`] - removes the pallet as the sponsor for the contract.44//! - [`payout_stakers`][`Pallet::payout_stakers`] - recalculates interest for the specified number of stakers.45//!4647// #![recursion_limit = "1024"]48#![cfg_attr(not(feature = "std"), no_std)]4950#[cfg(feature = "runtime-benchmarks")]51mod benchmarking;5253pub mod types;54pub mod weights;5556use sp_std::{57	vec::{Vec},58	vec,59	iter::Sum,60	borrow::ToOwned,61	cell::RefCell,62};63use sp_core::H160;64use codec::EncodeLike;65use pallet_balances::BalanceLock;66pub use types::*;6768use up_data_structs::CollectionId;6970use frame_support::{71	dispatch::{DispatchResult},72	traits::{73		Currency, Get, LockableCurrency, WithdrawReasons, tokens::Balance, ExistenceRequirement,74	},75	ensure,76};7778use weights::WeightInfo;7980pub use pallet::*;81use pallet_evm::account::CrossAccountId;82use sp_runtime::{83	Perbill,84	traits::{BlockNumberProvider, CheckedAdd, CheckedSub, AccountIdConversion, Zero},85	ArithmeticError,86};8788pub const LOCK_IDENTIFIER: [u8; 8] = *b"appstake";8990const PENDING_LIMIT_PER_BLOCK: u32 = 3;9192type BalanceOf<T> =93	<<T as Config>::Currency as Currency<<T as frame_system::Config>::AccountId>>::Balance;9495#[frame_support::pallet]96pub mod pallet {97	use super::*;98	use frame_support::{99		Blake2_128Concat, Twox64Concat, pallet_prelude::*, storage::Key, PalletId,100		traits::ReservableCurrency, weights::Weight,101	};102	use frame_system::pallet_prelude::*;103104	#[pallet::config]105	pub trait Config:106		frame_system::Config + pallet_evm::Config + pallet_configuration::Config107	{108		/// Type to interact with the native token109		type Currency: ExtendedLockableCurrency<Self::AccountId>110			+ ReservableCurrency<Self::AccountId>;111112		/// Type for interacting with collections113		type CollectionHandler: CollectionHandler<114			AccountId = Self::AccountId,115			CollectionId = CollectionId,116		>;117118		/// Type for interacting with conrtacts119		type ContractHandler: ContractHandler<AccountId = Self::CrossAccountId, ContractId = H160>;120121		/// `AccountId` for treasury122		type TreasuryAccountId: Get<Self::AccountId>;123124		/// The app's pallet id, used for deriving its sovereign account address.125		#[pallet::constant]126		type PalletId: Get<PalletId>;127128		/// In relay blocks.129		#[pallet::constant]130		type RecalculationInterval: Get<Self::BlockNumber>;131132		/// In parachain blocks.133		#[pallet::constant]134		type PendingInterval: Get<Self::BlockNumber>;135136		/// Rate of return for interval in blocks defined in `RecalculationInterval`.137		#[pallet::constant]138		type IntervalIncome: Get<Perbill>;139140		/// Decimals for the `Currency`.141		#[pallet::constant]142		type Nominal: Get<BalanceOf<Self>>;143144		/// Weight information for extrinsics in this pallet.145		type WeightInfo: WeightInfo;146147		// The relay block number provider148		type RelayBlockNumberProvider: BlockNumberProvider<BlockNumber = Self::BlockNumber>;149150		/// Events compatible with [`frame_system::Config::Event`].151		type RuntimeEvent: IsType<<Self as frame_system::Config>::RuntimeEvent> + From<Event<Self>>;152	}153154	#[pallet::pallet]155	#[pallet::generate_store(pub(super) trait Store)]156	pub struct Pallet<T>(_);157158	#[pallet::event]159	#[pallet::generate_deposit(fn deposit_event)]160	pub enum Event<T: Config> {161		/// Staking recalculation was performed162		///163		/// # Arguments164		/// * AccountId: account of the staker.165		/// * Balance : recalculation base166		/// * Balance : total income167		StakingRecalculation(168			/// An recalculated staker169			T::AccountId,170			/// Base on which interest is calculated171			BalanceOf<T>,172			/// Amount of accrued interest173			BalanceOf<T>,174		),175176		/// Staking was performed177		///178		/// # Arguments179		/// * AccountId: account of the staker180		/// * Balance : staking amount181		Stake(T::AccountId, BalanceOf<T>),182183		/// Unstaking was performed184		///185		/// # Arguments186		/// * AccountId: account of the staker187		/// * Balance : unstaking amount188		Unstake(T::AccountId, BalanceOf<T>),189190		/// The admin was set191		///192		/// # Arguments193		/// * AccountId: account address of the admin194		SetAdmin(T::AccountId),195	}196197	#[pallet::error]198	pub enum Error<T> {199		/// Error due to action requiring admin to be set.200		AdminNotSet,201		/// No permission to perform an action.202		NoPermission,203		/// Insufficient funds to perform an action.204		NotSufficientFunds,205		/// Occurs when a pending unstake cannot be added in this block. PENDING_LIMIT_PER_BLOCK` limits exceeded.206		PendingForBlockOverflow,207		/// The error is due to the fact that the collection/contract must already be sponsored in order to perform the action.208		SponsorNotSet,209		/// Errors caused by incorrect actions with a locked balance.210		IncorrectLockedBalanceOperation,211	}212213	/// Stores the total staked amount.214	#[pallet::storage]215	pub type TotalStaked<T: Config> = StorageValue<Value = BalanceOf<T>, QueryKind = ValueQuery>;216217	/// Stores the `admin` account. Some extrinsics can only be executed if they were signed by `admin`.218	#[pallet::storage]219	pub type Admin<T: Config> = StorageValue<Value = T::AccountId, QueryKind = OptionQuery>;220221	/// Stores the amount of tokens staked by account in the blocknumber.222	///223	/// * **Key1** - Staker account.224	/// * **Key2** - Relay block number when the stake was made.225	/// * **(Balance, BlockNumber)** - Balance of the stake.226	/// The number of the relay block in which we must perform the interest recalculation227	#[pallet::storage]228	pub type Staked<T: Config> = StorageNMap<229		Key = (230			Key<Blake2_128Concat, T::AccountId>,231			Key<Twox64Concat, T::BlockNumber>,232		),233		Value = (BalanceOf<T>, T::BlockNumber),234		QueryKind = ValueQuery,235	>;236237	/// Stores amount of stakes for an `Account`.238	///239	/// * **Key** - Staker account.240	/// * **Value** - Amount of stakes.241	#[pallet::storage]242	pub type StakesPerAccount<T: Config> =243		StorageMap<_, Blake2_128Concat, T::AccountId, u8, ValueQuery>;244245	/// Stores amount of stakes for an `Account`.246	///247	/// * **Key** - Staker account.248	/// * **Value** - Amount of stakes.249	#[pallet::storage]250	pub type PendingUnstake<T: Config> = StorageMap<251		_,252		Twox64Concat,253		T::BlockNumber,254		BoundedVec<(T::AccountId, BalanceOf<T>), ConstU32<PENDING_LIMIT_PER_BLOCK>>,255		ValueQuery,256	>;257258	/// Stores a key for record for which the revenue recalculation was performed.259	/// If `None`, then recalculation has not yet been performed or calculations have been completed for all stakers.260	#[pallet::storage]261	#[pallet::getter(fn get_next_calculated_record)]262	pub type PreviousCalculatedRecord<T: Config> =263		StorageValue<Value = (T::AccountId, T::BlockNumber), QueryKind = OptionQuery>;264265	#[pallet::storage]266	pub(crate) type IsMigrated<T: Config> = StorageValue<Value = bool, QueryKind = ValueQuery>;267268	#[pallet::hooks]269	impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {270		/// Block overflow is impossible due to the fact that the unstake algorithm in on_initialize271		/// implies the execution of a strictly limited number of relatively lightweight operations.272		/// A separate benchmark has been implemented to scale the weight depending on the number of pendings.273		fn on_initialize(current_block_number: T::BlockNumber) -> Weight274		where275			<T as frame_system::Config>::BlockNumber: From<u32>,276		{277			let block_pending = PendingUnstake::<T>::take(current_block_number);278			let counter = block_pending.len() as u32;279280			if !block_pending.is_empty() {281				block_pending.into_iter().for_each(|(staker, amount)| {282					Self::get_locked_balance(&staker).map(|b| {283						let new_state = b.amount.checked_sub(&amount).unwrap_or_default();284						Self::set_lock_unchecked(&staker, new_state);285					});286				});287			}288289			<T as Config>::WeightInfo::on_initialize(counter)290		}291292		fn on_runtime_upgrade() -> Weight {293			let mut consumed_weight = Weight::zero();294			let mut add_weight = |reads, writes, weight| {295				consumed_weight += T::DbWeight::get().reads_writes(reads, writes);296				consumed_weight += weight;297			};298299			if <IsMigrated<T>>::get() {300				add_weight(1, 0, Weight::zero());301				return consumed_weight;302			} else {303				add_weight(1, 1, Weight::zero());304				<IsMigrated<T>>::set(true);305			}306			<PendingUnstake<T>>::drain().for_each(|(_, v)| {307				add_weight(1, 1, Weight::zero());308				v.into_iter().for_each(|(staker, amount)| {309					<<T as Config>::Currency as ReservableCurrency<T::AccountId>>::unreserve(310						&staker, amount,311					);312					add_weight(1, 1, Weight::zero());313				});314			});315316			consumed_weight317		}318319		#[cfg(feature = "try-runtime")]320		fn pre_upgrade() -> Result<Vec<u8>, &'static str> {321			use sp_std::collections::btree_map::BTreeMap;322			if <IsMigrated<T>>::get() {323				return Ok(Default::default());324			}325			// Staker -> (total amount of reserved balance, reserved by promotion);326			let mut pre_state: BTreeMap<T::AccountId, (BalanceOf<T>, BalanceOf<T>)> =327				BTreeMap::new();328329			<PendingUnstake<T>>::iter().for_each(|(_, v)| {330				v.into_iter().for_each(|(staker, amount)| {331					if let Some((_, reserved_balance)) = pre_state.get_mut(&staker) {332						*reserved_balance += amount;333					} else {334						let total_reserve = <<T as Config>::Currency as ReservableCurrency<335							T::AccountId,336						>>::reserved_balance(&staker);337						pre_state.insert(staker, (total_reserve, amount));338					}339				})340			});341342			Ok(pre_state.encode())343		}344345		#[cfg(feature = "try-runtime")]346		fn post_upgrade(pre_state: Vec<u8>) -> Result<(), &'static str> {347			use sp_std::collections::btree_map::BTreeMap;348349			if <IsMigrated<T>>::get() {350				return Ok(());351			}352353			ensure!(354				<PendingUnstake<T>>::iter().collect::<Vec<_>>().len() == 0,355				"pendingUnstake storage isn't empty"356			);357358			let mut is_ok = true;359360			let pre_state: BTreeMap<T::AccountId, (BalanceOf<T>, BalanceOf<T>)> =361				Decode::decode(&mut &pre_state[..]).map_err(|_| "failed to decode pre_state")?;362			for (staker, (total_reserved, reserved_by_promo)) in pre_state.into_iter() {363				let new_state_reserve = <<T as Config>::Currency as ReservableCurrency<364					T::AccountId,365				>>::reserved_balance(&staker);366				if new_state_reserve != total_reserved - reserved_by_promo {367					is_ok = false;368					log::error!(369								"Incorrect reserved balance for {:?}. New balance: {:?}. Before runtime upgrade: total reserve - {:?}, reserved by promo - {:?}",370								staker, new_state_reserve, total_reserved, reserved_by_promo371							);372				}373			}374375			if is_ok {376				Ok(())377			} else {378				Err("Incorrect balance for some of stakers... See logs")379			}380		}381	}382383	#[pallet::call]384	impl<T: Config> Pallet<T>385	where386		T::BlockNumber: From<u32> + Into<u32>,387		<<T as Config>::Currency as Currency<T::AccountId>>::Balance: Sum + From<u128>,388	{389		/// Sets an address as the the admin.390		///391		/// # Permissions392		///393		/// * Sudo394		///395		/// # Arguments396		///397		/// * `admin`: account of the new admin.398		#[pallet::call_index(0)]399		#[pallet::weight(<T as Config>::WeightInfo::set_admin_address())]400		pub fn set_admin_address(origin: OriginFor<T>, admin: T::CrossAccountId) -> DispatchResult {401			ensure_root(origin)?;402403			<Admin<T>>::set(Some(admin.as_sub().to_owned()));404405			Self::deposit_event(Event::SetAdmin(admin.as_sub().to_owned()));406407			Ok(())408		}409410		/// Stakes the amount of native tokens.411		/// Sets `amount` to the locked state.412		/// The maximum number of stakes for a staker is 10.413		///414		/// # Arguments415		///416		/// * `amount`: in native tokens.417		#[pallet::call_index(1)]418		#[pallet::weight(<T as Config>::WeightInfo::stake())]419		pub fn stake(staker: OriginFor<T>, amount: BalanceOf<T>) -> DispatchResult {420			let staker_id = ensure_signed(staker)?;421422			ensure!(423				StakesPerAccount::<T>::get(&staker_id) < 10,424				Error::<T>::NoPermission425			);426427			ensure!(428				amount >= <BalanceOf<T>>::from(100u128) * T::Nominal::get(),429				ArithmeticError::Underflow430			);431			let config = <PalletConfiguration<T>>::get();432433			let balance =434				<<T as Config>::Currency as Currency<T::AccountId>>::free_balance(&staker_id);435436			// checks that we can lock `amount` on the `staker` account.437			ensure!(438				amount439					<= match Self::get_locked_balance(&staker_id) {440						Some(lock) => balance441							.checked_sub(&lock.amount)442							.ok_or(ArithmeticError::Underflow)?,443						None => balance,444					},445				ArithmeticError::Underflow446			);447448			Self::add_lock_balance(&staker_id, amount)?;449450			let block_number = T::RelayBlockNumberProvider::current_block_number();451452			// Calculation of the number of recalculation periods,453			// after how much the first interest calculation should be performed for the stake454			let recalculate_after_interval: T::BlockNumber =455				if block_number % config.recalculation_interval == 0u32.into() {456					1u32.into()457				} else {458					2u32.into()459				};460461			// Сalculation of the number of the relay block462			// in which it is necessary to accrue remuneration for the stake.463			let recalc_block = (block_number / config.recalculation_interval464				+ recalculate_after_interval)465				* config.recalculation_interval;466467			<Staked<T>>::insert((&staker_id, block_number), {468				let mut balance_and_recalc_block = <Staked<T>>::get((&staker_id, block_number));469				balance_and_recalc_block.0 = balance_and_recalc_block470					.0471					.checked_add(&amount)472					.ok_or(ArithmeticError::Overflow)?;473				balance_and_recalc_block.1 = recalc_block;474				balance_and_recalc_block475			});476477			<TotalStaked<T>>::set(478				<TotalStaked<T>>::get()479					.checked_add(&amount)480					.ok_or(ArithmeticError::Overflow)?,481			);482483			StakesPerAccount::<T>::mutate(&staker_id, |stakes| *stakes += 1);484485			Self::deposit_event(Event::Stake(staker_id, amount));486487			Ok(())488		}489490		/// Unstakes all stakes.491		/// Moves the sum of all stakes to the `reserved` state.492		/// After the end of `PendingInterval` this sum becomes completely493		/// free for further use.494		#[pallet::call_index(2)]495		#[pallet::weight(<T as Config>::WeightInfo::unstake())]496		pub fn unstake(staker: OriginFor<T>) -> DispatchResultWithPostInfo {497			let staker_id = ensure_signed(staker)?;498			let config = <PalletConfiguration<T>>::get();499500			// calculate block number where the sum would be free501			let block = <frame_system::Pallet<T>>::block_number() + config.pending_interval;502503			let mut pendings = <PendingUnstake<T>>::get(block);504505			// checks that we can do unreserve stakes in the block506			ensure!(!pendings.is_full(), Error::<T>::PendingForBlockOverflow);507508			let mut total_stakes = 0u64;509510			let total_staked: BalanceOf<T> = Staked::<T>::drain_prefix((&staker_id,))511				.map(|(_, (amount, _))| {512					total_stakes += 1;513					amount514				})515				.sum();516517			if total_staked.is_zero() {518				return Ok(None::<Weight>.into()); // TO-DO519			}520521			pendings522				.try_push((staker_id.clone(), total_staked))523				.map_err(|_| Error::<T>::PendingForBlockOverflow)?;524525			<PendingUnstake<T>>::insert(block, pendings);526527			TotalStaked::<T>::set(528				TotalStaked::<T>::get()529					.checked_sub(&total_staked)530					.ok_or(ArithmeticError::Underflow)?,531			);532533			StakesPerAccount::<T>::remove(&staker_id);534535			Self::deposit_event(Event::Unstake(staker_id, total_staked));536537			Ok(None::<Weight>.into())538		}539540		/// Sets the pallet to be the sponsor for the collection.541		///542		/// # Permissions543		///544		/// * Pallet admin545		///546		/// # Arguments547		///548		/// * `collection_id`: ID of the collection that will be sponsored by `pallet_id`549		#[pallet::call_index(3)]550		#[pallet::weight(<T as Config>::WeightInfo::sponsor_collection())]551		pub fn sponsor_collection(552			admin: OriginFor<T>,553			collection_id: CollectionId,554		) -> DispatchResult {555			let admin_id = ensure_signed(admin)?;556			ensure!(557				admin_id == Admin::<T>::get().ok_or(Error::<T>::AdminNotSet)?,558				Error::<T>::NoPermission559			);560561			T::CollectionHandler::set_sponsor(Self::account_id(), collection_id)562		}563564		/// Removes the pallet as the sponsor for the collection.565		/// Returns [`NoPermission`][`Error::NoPermission`]566		/// if the pallet wasn't the sponsor.567		///568		/// # Permissions569		///570		/// * Pallet admin571		///572		/// # Arguments573		///574		/// * `collection_id`: ID of the collection that is sponsored by `pallet_id`575		#[pallet::call_index(4)]576		#[pallet::weight(<T as Config>::WeightInfo::stop_sponsoring_collection())]577		pub fn stop_sponsoring_collection(578			admin: OriginFor<T>,579			collection_id: CollectionId,580		) -> DispatchResult {581			let admin_id = ensure_signed(admin)?;582583			ensure!(584				admin_id == Admin::<T>::get().ok_or(Error::<T>::AdminNotSet)?,585				Error::<T>::NoPermission586			);587588			ensure!(589				T::CollectionHandler::sponsor(collection_id)?.ok_or(<Error<T>>::SponsorNotSet)?590					== Self::account_id(),591				<Error<T>>::NoPermission592			);593			T::CollectionHandler::remove_collection_sponsor(collection_id)594		}595596		/// Sets the pallet to be the sponsor for the contract.597		///598		/// # Permissions599		///600		/// * Pallet admin601		///602		/// # Arguments603		///604		/// * `contract_id`: the contract address that will be sponsored by `pallet_id`605		#[pallet::call_index(5)]606		#[pallet::weight(<T as Config>::WeightInfo::sponsor_contract())]607		pub fn sponsor_contract(admin: OriginFor<T>, contract_id: H160) -> DispatchResult {608			let admin_id = ensure_signed(admin)?;609610			ensure!(611				admin_id == Admin::<T>::get().ok_or(Error::<T>::AdminNotSet)?,612				Error::<T>::NoPermission613			);614615			T::ContractHandler::set_sponsor(616				T::CrossAccountId::from_sub(Self::account_id()),617				contract_id,618			)619		}620621		/// Removes the pallet as the sponsor for the contract.622		/// Returns [`NoPermission`][`Error::NoPermission`]623		/// if the pallet wasn't the sponsor.624		///625		/// # Permissions626		///627		/// * Pallet admin628		///629		/// # Arguments630		///631		/// * `contract_id`: the contract address that is sponsored by `pallet_id`632		#[pallet::call_index(6)]633		#[pallet::weight(<T as Config>::WeightInfo::stop_sponsoring_contract())]634		pub fn stop_sponsoring_contract(admin: OriginFor<T>, contract_id: H160) -> DispatchResult {635			let admin_id = ensure_signed(admin)?;636637			ensure!(638				admin_id == Admin::<T>::get().ok_or(Error::<T>::AdminNotSet)?,639				Error::<T>::NoPermission640			);641642			ensure!(643				T::ContractHandler::sponsor(contract_id)?644					.ok_or(<Error<T>>::SponsorNotSet)?645					.as_sub() == &Self::account_id(),646				<Error<T>>::NoPermission647			);648			T::ContractHandler::remove_contract_sponsor(contract_id)649		}650651		/// Recalculates interest for the specified number of stakers.652		/// If all stakers are not recalculated, the next call of the extrinsic653		/// will continue the recalculation, from those stakers for whom this654		/// was not perform in last call.655		///656		/// # Permissions657		///658		/// * Pallet admin659		///660		/// # Arguments661		///662		/// * `stakers_number`: the number of stakers for which recalculation will be performed663		#[pallet::call_index(7)]664		#[pallet::weight(<T as Config>::WeightInfo::payout_stakers(stakers_number.unwrap_or(DEFAULT_NUMBER_PAYOUTS) as u32))]665		pub fn payout_stakers(admin: OriginFor<T>, stakers_number: Option<u8>) -> DispatchResult {666			let admin_id = ensure_signed(admin)?;667668			ensure!(669				admin_id == Admin::<T>::get().ok_or(Error::<T>::AdminNotSet)?,670				Error::<T>::NoPermission671			);672			let config = <PalletConfiguration<T>>::get();673674			let mut stakers_number = stakers_number.unwrap_or(DEFAULT_NUMBER_PAYOUTS);675676			ensure!(677				stakers_number <= config.max_stakers_per_calculation && stakers_number != 0,678				Error::<T>::NoPermission679			);680681			// calculate the number of the current recalculation block,682			// this is necessary in order to understand which stakers we should calculate interest683			let current_recalc_block = Self::get_current_recalc_block(684				T::RelayBlockNumberProvider::current_block_number(),685				&config,686			);687688			// calculate the number of the next recalculation block,689			// this value is set for the stakers to whom the recalculation will be performed690			let next_recalc_block = current_recalc_block + config.recalculation_interval;691692			let mut storage_iterator = Self::get_next_calculated_key()693				.map_or(Staked::<T>::iter(), |key| Staked::<T>::iter_from(key));694695			PreviousCalculatedRecord::<T>::set(None);696697			{698				// Address handled in the last payout loop iteration (below)699				let last_id = RefCell::new(None);700				// Block number (as a part of the key) for which calculation was performed in the last payout loop iteration701				let mut last_staked_calculated_block = Default::default();702				// Reward balance for the address in the iteration703				let income_acc = RefCell::new(BalanceOf::<T>::default());704				// Staked balance for the address in the iteration (before stake is recalculated)705				let amount_acc = RefCell::new(BalanceOf::<T>::default());706707				// This closure is used to finalize handling single staker address in each of the two conditions: (1) when we break out of the payout708				// loop because we reached the number of stakes for rewarding, (2) When all stakes by the single address are handled and the payout709				// loop switches to handling the next staker address:710				//   1. Transfer full reward amount to the payee711				//   2. Lock the reward in staking lock712				//   3. Update TotalStaked amount713				//   4. Issue StakingRecalculation event714				let flush_stake = || -> DispatchResult {715					if let Some(last_id) = &*last_id.borrow() {716						if !income_acc.borrow().is_zero() {717							<<T as Config>::Currency as Currency<T::AccountId>>::transfer(718								&T::TreasuryAccountId::get(),719								last_id,720								*income_acc.borrow(),721								ExistenceRequirement::KeepAlive,722							)?;723724							Self::add_lock_balance(last_id, *income_acc.borrow())?;725							<TotalStaked<T>>::try_mutate(|staked| -> DispatchResult {726								*staked = staked727									.checked_add(&*income_acc.borrow())728									.ok_or(ArithmeticError::Overflow)?;729								Ok(())730							})?;731732							Self::deposit_event(Event::StakingRecalculation(733								last_id.clone(),734								*amount_acc.borrow(),735								*income_acc.borrow(),736							));737						}738739						*income_acc.borrow_mut() = BalanceOf::<T>::default();740						*amount_acc.borrow_mut() = BalanceOf::<T>::default();741					}742					Ok(())743				};744745				// Reward payment loop. Should loop for no more than config.max_stakers_per_calculation746				// iterations in one extrinsic call747				//748				// stakers_number - keeps the remaining number of iterations (staker addresses to handle)749				// next_recalc_block_for_stake - is taken from the state and stores the starting relay block from which reward should be paid out750				// income_acc - stores the reward amount to pay to the staker address (accumulates over all address stake records)751				while let Some((752					(current_id, staked_block),753					(amount, next_recalc_block_for_stake),754				)) = storage_iterator.next()755				{756					// last_id is not equal current_id when we switch to handling a new staker address757					// or just start handling the very first address. In the latter case last_id will be None and758					// flush_stake will do nothing759					if last_id.borrow().as_ref() != Some(&current_id) {760						if stakers_number > 0 {761							flush_stake()?;762							*last_id.borrow_mut() = Some(current_id.clone());763							stakers_number -= 1;764						}765						// Break out if we reached the address limit766						else {767							if let Some(staker) = &*last_id.borrow() {768								// Save the last calculated record to pick up in the next extrinsic call769								PreviousCalculatedRecord::<T>::set(Some((770									staker.clone(),771									last_staked_calculated_block,772								)));773							}774							break;775						};776					};777778					// Increase accumulated reward for current address and update current staking record, i.e. (address, staked_block) -> amount779					if current_recalc_block >= next_recalc_block_for_stake {780						*amount_acc.borrow_mut() += amount;781						Self::recalculate_and_insert_stake(782							&current_id,783							staked_block,784							next_recalc_block,785							amount,786							((current_recalc_block - next_recalc_block_for_stake)787								/ config.recalculation_interval)788								.into() + 1,789							&mut *income_acc.borrow_mut(),790						);791					}792					last_staked_calculated_block = staked_block;793				}794				flush_stake()?;795			}796797			Ok(())798		}799	}800}801802impl<T: Config> Pallet<T> {803	/// The account address of the app promotion pot.804	///805	/// This actually does computation. If you need to keep using it, then make sure you cache the806	/// value and only call this once.807	pub fn account_id() -> T::AccountId {808		T::PalletId::get().into_account_truncating()809	}810811	// /// Unlocks the balance that was locked by the pallet.812	// ///813	// /// - `staker`: staker account.814	// /// - `amount`: amount of unlocked funds.815	// fn unlock_balance(staker: &T::AccountId, amount: BalanceOf<T>) -> DispatchResult {816	// 	let locked_balance = Self::get_locked_balance(staker)817	// 		.map(|l| l.amount)818	// 		.ok_or(<Error<T>>::IncorrectLockedBalanceOperation)?;819820	// 	// It is understood that we cannot unlock more funds than were locked by staking.821	// 	// Therefore, if implemented correctly, this error should not occur.822	// 	Self::set_lock_unchecked(823	// 		staker,824	// 		locked_balance825	// 			.checked_sub(&amount)826	// 			.ok_or(ArithmeticError::Underflow)?,827	// 	);828	// 	Ok(())829	// }830831	/// Adds the balance to locked by the pallet.832	///833	/// - `staker`: staker account.834	/// - `amount`: amount of added locked funds.835	fn add_lock_balance(staker: &T::AccountId, amount: BalanceOf<T>) -> DispatchResult {836		Self::get_locked_balance(staker)837			.map_or(<BalanceOf<T>>::default(), |l| l.amount)838			.checked_add(&amount)839			.map(|new_lock| Self::set_lock_unchecked(staker, new_lock))840			.ok_or(ArithmeticError::Overflow.into())841	}842843	/// Sets the new state of a balance locked by the pallet.844	///845	/// - `staker`: staker account.846	/// - `amount`: amount of locked funds.847	fn set_lock_unchecked(staker: &T::AccountId, amount: BalanceOf<T>) {848		if amount.is_zero() {849			<<T as Config>::Currency as LockableCurrency<T::AccountId>>::remove_lock(850				LOCK_IDENTIFIER,851				&staker,852			);853		} else {854			<<T as Config>::Currency as LockableCurrency<T::AccountId>>::set_lock(855				LOCK_IDENTIFIER,856				staker,857				amount,858				WithdrawReasons::all(),859			)860		}861	}862863	/// Returns the balance locked by the pallet for the staker.864	///865	/// - `staker`: staker account.866	pub fn get_locked_balance(867		staker: impl EncodeLike<T::AccountId>,868	) -> Option<BalanceLock<BalanceOf<T>>> {869		<<T as Config>::Currency as ExtendedLockableCurrency<T::AccountId>>::locks(staker)870			.into_iter()871			.find(|l| l.id == LOCK_IDENTIFIER)872	}873874	/// Returns the total staked balance for the staker.875	///876	/// - `staker`: staker account.877	pub fn total_staked_by_id(staker: impl EncodeLike<T::AccountId>) -> Option<BalanceOf<T>> {878		let staked = Staked::<T>::iter_prefix((staker,))879			.into_iter()880			.fold(<BalanceOf<T>>::default(), |acc, (_, (amount, _))| {881				acc + amount882			});883		if staked != <BalanceOf<T>>::default() {884			Some(staked)885		} else {886			None887		}888	}889890	/// Returns all relay block numbers when stake was made,891	/// the amount of the stake.892	///893	/// - `staker`: staker account.894	pub fn total_staked_by_id_per_block(895		staker: impl EncodeLike<T::AccountId>,896	) -> Option<Vec<(T::BlockNumber, BalanceOf<T>)>> {897		let mut staked = Staked::<T>::iter_prefix((staker,))898			.into_iter()899			.map(|(block, (amount, _))| (block, amount))900			.collect::<Vec<_>>();901		staked.sort_by_key(|(block, _)| *block);902		if !staked.is_empty() {903			Some(staked)904		} else {905			None906		}907	}908909	/// Returns the total staked balance for the staker.910	/// If `staker` is `None`, returns the total amount staked.911	/// - `staker`: staker account.912	pub fn cross_id_total_staked(staker: Option<T::CrossAccountId>) -> Option<BalanceOf<T>> {913		staker.map_or(Some(<TotalStaked<T>>::get()), |s| {914			Self::total_staked_by_id(s.as_sub())915		})916	}917918	// pub fn cross_id_locked_balance(staker: T::CrossAccountId) -> BalanceOf<T> {919	// 	Self::get_locked_balance(staker.as_sub())920	// 		.map(|l| l.amount)921	// 		.unwrap_or_default()922	// }923924	/// Returns all relay block numbers when stake was made,925	/// the amount of the stake.926	///927	/// - `staker`: staker account.928	pub fn cross_id_total_staked_per_block(929		staker: T::CrossAccountId,930	) -> Vec<(T::BlockNumber, BalanceOf<T>)> {931		Self::total_staked_by_id_per_block(staker.as_sub()).unwrap_or_default()932	}933934	fn recalculate_and_insert_stake(935		staker: &T::AccountId,936		staked_block: T::BlockNumber,937		next_recalc_block: T::BlockNumber,938		base: BalanceOf<T>,939		iters: u32,940		income_acc: &mut BalanceOf<T>,941	) {942		let income = Self::calculate_income(base, iters);943944		base.checked_add(&income).map(|res| {945			<Staked<T>>::insert((staker, staked_block), (res, next_recalc_block));946			*income_acc += income;947		});948	}949950	fn calculate_income<I>(base: I, iters: u32) -> I951	where952		I: EncodeLike<BalanceOf<T>> + Balance,953	{954		let config = <PalletConfiguration<T>>::get();955		let mut income = base;956957		(0..iters).for_each(|_| income += config.interval_income * income);958959		income - base960	}961962	/// Get relay block number rounded down to multiples of config.recalculation_interval.963	/// We need it to reward stakers in integer parts of recalculation_interval964	fn get_current_recalc_block(965		current_relay_block: T::BlockNumber,966		config: &PalletConfiguration<T>,967	) -> T::BlockNumber {968		(current_relay_block / config.recalculation_interval) * config.recalculation_interval969	}970971	fn get_next_calculated_key() -> Option<Vec<u8>> {972		Self::get_next_calculated_record().map(|key| Staked::<T>::hashed_key_for(key))973	}974}975976impl<T: Config> Pallet<T>977where978	<<T as Config>::Currency as Currency<T::AccountId>>::Balance: Sum,979{980	/// Returns the amount reserved by the pending.981	/// If `staker` is `None`, returns the total pending.982	///983	/// -`staker`: staker account.984	///985	/// Since user funds are not transferred anywhere by staking, overflow protection is provided986	/// at the level of the associated type `Balance` of `Currency` trait. In order to overflow,987	/// the staker must have more funds on his account than the maximum set for `Balance` type.988	pub fn cross_id_pending_unstake(staker: Option<T::CrossAccountId>) -> BalanceOf<T> {989		staker.map_or(990			PendingUnstake::<T>::iter_values()991				.flat_map(|pendings| pendings.into_iter().map(|(_, amount)| amount))992				.sum(),993			|s| {994				PendingUnstake::<T>::iter_values()995					.flatten()996					.filter_map(|(id, amount)| {997						if id == *s.as_sub() {998							Some(amount)999						} else {1000							None1001						}1002					})1003					.sum()1004			},1005		)1006	}10071008	/// Returns all parachain block numbers when unreserve is expected,1009	/// the amount of the unreserved funds.1010	///1011	/// - `staker`: staker account.1012	pub fn cross_id_pending_unstake_per_block(1013		staker: T::CrossAccountId,1014	) -> Vec<(T::BlockNumber, BalanceOf<T>)> {1015		let mut unsorted_res = vec![];1016		PendingUnstake::<T>::iter().for_each(|(block, pendings)| {1017			pendings.into_iter().for_each(|(id, amount)| {1018				if id == *staker.as_sub() {1019					unsorted_res.push((block, amount));1020				};1021			})1022		});10231024		unsorted_res.sort_by_key(|(block, _)| *block);1025		unsorted_res1026	}1027}