git.delta.rocks / unique-network / refs/commits / 834c75ed844b

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 promotion18//!19//! The app promotion pallet is designed to ... .20//!21//! ## Interface22//!23//! ### Dispatchable Functions24//!25//! * `start_inflation` - This method sets the inflation start date. Can be only called once.26//! Inflation start block can be backdated and will catch up. The method will create Treasury27//!	account if it does not exist and perform the first inflation deposit.2829// #![recursion_limit = "1024"]30#![cfg_attr(not(feature = "std"), no_std)]3132#[cfg(feature = "runtime-benchmarks")]33mod benchmarking;34#[cfg(test)]35mod tests;36pub mod types;37pub mod weights;3839use sp_std::{vec::Vec, iter::Sum, borrow::ToOwned};40use sp_core::H160;41use codec::EncodeLike;42use pallet_balances::BalanceLock;43pub use types::*;4445// use up_common::constants::{DAYS, UNIQUE};46use up_data_structs::CollectionId;4748use frame_support::{49	dispatch::{DispatchResult},50	traits::{51		Currency, Get, LockableCurrency, WithdrawReasons, tokens::Balance, ExistenceRequirement,52	},53	ensure,54};5556use weights::WeightInfo;5758pub use pallet::*;59use pallet_evm::account::CrossAccountId;60use sp_runtime::{61	Perbill,62	traits::{BlockNumberProvider, CheckedAdd, CheckedSub, AccountIdConversion, Zero},63	ArithmeticError,64};6566type BalanceOf<T> =67	<<T as Config>::Currency as Currency<<T as frame_system::Config>::AccountId>>::Balance;6869// const SECONDS_TO_BLOCK: u32 = 6;70// const DAY: u32 = 60 * 60 * 24 / SECONDS_TO_BLOCK;71// const WEEK: u32 = 7 * DAY;72// const TWO_WEEK: u32 = 2 * WEEK;73// const YEAR: u32 = DAY * 365;7475pub const LOCK_IDENTIFIER: [u8; 8] = *b"appstake";7677#[frame_support::pallet]78pub mod pallet {79	use super::*;80	use frame_support::{Blake2_128Concat, Twox64Concat, pallet_prelude::*, storage::Key, PalletId};81	use frame_system::pallet_prelude::*;8283	#[pallet::config]84	pub trait Config: frame_system::Config + pallet_evm::account::Config {85		type Currency: ExtendedLockableCurrency<Self::AccountId>;8687		type CollectionHandler: CollectionHandler<88			AccountId = Self::AccountId,89			CollectionId = CollectionId,90		>;9192		type ContractHandler: ContractHandler<AccountId = Self::CrossAccountId, ContractId = H160>;9394		type TreasuryAccountId: Get<Self::AccountId>;9596		/// The app's pallet id, used for deriving its sovereign account ID.97		#[pallet::constant]98		type PalletId: Get<PalletId>;99100		/// In relay blocks.101		#[pallet::constant]102		type RecalculationInterval: Get<Self::BlockNumber>;103		/// In relay blocks.104		#[pallet::constant]105		type PendingInterval: Get<Self::BlockNumber>;106107		/// In chain blocks.108		#[pallet::constant]109		type Day: Get<Self::BlockNumber>; // useless110111		#[pallet::constant]112		type Nominal: Get<BalanceOf<Self>>;113114		#[pallet::constant]115		type IntervalIncome: Get<Perbill>;116117		/// Weight information for extrinsics in this pallet.118		type WeightInfo: WeightInfo;119120		// The relay block number provider121		type RelayBlockNumberProvider: BlockNumberProvider<BlockNumber = Self::BlockNumber>;122123		/// Events compatible with [`frame_system::Config::Event`].124		type Event: IsType<<Self as frame_system::Config>::Event> + From<Event<Self>>;125	}126127	#[pallet::pallet]128	#[pallet::generate_store(pub(super) trait Store)]129	pub struct Pallet<T>(_);130131	#[pallet::event]132	#[pallet::generate_deposit(fn deposit_event)]133	pub enum Event<T: Config> {134		StakingRecalculation(135			/// An recalculated staker136			T::AccountId,137			/// Base on which interest is calculated138			BalanceOf<T>,139			/// Amount of accrued interest140			BalanceOf<T>,141		),142	}143144	#[pallet::error]145	pub enum Error<T> {146		/// Error due to action requiring admin to be set147		AdminNotSet,148		/// No permission to perform an action149		NoPermission,150		/// Insufficient funds to perform an action151		NotSufficientFounds,152		/// An error related to the fact that an invalid argument was passed to perform an action153		InvalidArgument,154	}155156	#[pallet::storage]157	pub type TotalStaked<T: Config> = StorageValue<Value = BalanceOf<T>, QueryKind = ValueQuery>;158159	#[pallet::storage]160	pub type Admin<T: Config> = StorageValue<Value = T::AccountId, QueryKind = OptionQuery>;161162	/// Amount of tokens staked by account in the blocknumber.163	#[pallet::storage]164	pub type Staked<T: Config> = StorageNMap<165		Key = (166			Key<Blake2_128Concat, T::AccountId>,167			Key<Twox64Concat, T::BlockNumber>,168		),169		Value = (BalanceOf<T>, T::BlockNumber),170		QueryKind = ValueQuery,171	>;172	/// Amount of stakes for an Account173	#[pallet::storage]174	pub type StakesPerAccount<T: Config> =175		StorageMap<_, Blake2_128Concat, T::AccountId, u8, ValueQuery>;176177	/// Amount of tokens pending unstake per user per block.178	#[pallet::storage]179	pub type PendingUnstake<T: Config> = StorageNMap<180		Key = (181			Key<Blake2_128Concat, T::AccountId>,182			Key<Twox64Concat, T::BlockNumber>,183		),184		Value = BalanceOf<T>,185		QueryKind = ValueQuery,186	>;187188	/// A block when app-promotion has started .I think this is redundant, because we only need `NextInterestBlock`.189	#[pallet::storage]190	pub type StartBlock<T: Config> = StorageValue<Value = T::BlockNumber, QueryKind = ValueQuery>;191192	/// Next target block when interest is recalculated193	#[pallet::storage]194	#[pallet::getter(fn get_interest_block)]195	pub type NextInterestBlock<T: Config> =196		StorageValue<Value = T::BlockNumber, QueryKind = ValueQuery>;197198	/// Stores hash a record for which the last revenue recalculation was performed.199	/// If `None`, then recalculation has not yet been performed or calculations have been completed for all stakers.200	#[pallet::storage]201	#[pallet::getter(fn get_next_calculated_record)]202	pub type NextCalculatedRecord<T: Config> =203		StorageValue<Value = (T::AccountId, T::BlockNumber), QueryKind = OptionQuery>;204205	#[pallet::hooks]206	impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {207		fn on_initialize(current_block: T::BlockNumber) -> Weight208		where209			<T as frame_system::Config>::BlockNumber: From<u32>,210		{211			let mut consumed_weight = 0;212			// let mut add_weight = |reads, writes, weight| {213			// 	consumed_weight += T::DbWeight::get().reads_writes(reads, writes);214			// 	consumed_weight += weight;215			// };216217			let current_relay_block = T::RelayBlockNumberProvider::current_block_number();218			PendingUnstake::<T>::iter()219				.filter_map(|((staker, block), amount)| {220					if block <= current_relay_block {221						Some((staker, block, amount))222					} else {223						None224					}225				})226				.for_each(|(staker, block, amount)| {227					Self::unlock_balance_unchecked(&staker, amount);228					<PendingUnstake<T>>::remove((staker, block));229				});230231			// let next_interest_block = Self::get_interest_block();232			// let current_relay_block = T::RelayBlockNumberProvider::current_block_number();233			// if next_interest_block != 0.into() && current_relay_block >= next_interest_block {234			// 	let mut acc = <BalanceOf<T>>::default();235			// 	let mut base_acc = <BalanceOf<T>>::default();236237			// 	NextInterestBlock::<T>::set(238			// 		NextInterestBlock::<T>::get() + T::RecalculationInterval::get(),239			// 	);240			// 	add_weight(0, 1, 0);241242			// 	Staked::<T>::iter()243			// 		.filter(|((_, block), _)| {244			// 			*block + T::RecalculationInterval::get() <= current_relay_block245			// 		})246			// 		.for_each(|((staker, block), amount)| {247			// 			Self::recalculate_stake(&staker, block, amount, &mut acc);248			// 			add_weight(0, 0, T::WeightInfo::recalculate_stake());249			// 			base_acc += amount;250			// 		});251			// 	<TotalStaked<T>>::get()252			// 		.checked_add(&acc)253			// 		.map(|res| <TotalStaked<T>>::set(res));254255			// 	Self::deposit_event(Event::StakingRecalculation(base_acc, acc));256			// 	add_weight(0, 1, 0);257			// } else {258			// 	add_weight(1, 0, 0)259			// };260			consumed_weight261		}262	}263264	#[pallet::call]265	impl<T: Config> Pallet<T>266	where267		T::BlockNumber: From<u32> + Into<u32>,268		<<T as Config>::Currency as Currency<T::AccountId>>::Balance: Sum + From<u128>,269	{270		#[pallet::weight(T::WeightInfo::set_admin_address())]271		pub fn set_admin_address(origin: OriginFor<T>, admin: T::CrossAccountId) -> DispatchResult {272			ensure_root(origin)?;273			<Admin<T>>::set(Some(admin.as_sub().to_owned()));274275			Ok(())276		}277278		#[pallet::weight(T::WeightInfo::start_app_promotion())]279		pub fn start_app_promotion(280			origin: OriginFor<T>,281			promotion_start_relay_block: Option<T::BlockNumber>,282		) -> DispatchResult283		where284			<T as frame_system::Config>::BlockNumber: From<u32>,285		{286			ensure_root(origin)?;287288			// Start app-promotion mechanics if it has not been yet initialized289			if <StartBlock<T>>::get() == 0u32.into() {290				let start_block = promotion_start_relay_block291					.unwrap_or(T::RelayBlockNumberProvider::current_block_number());292293				// Set promotion global start block294				<StartBlock<T>>::set(start_block);295296				<NextInterestBlock<T>>::set(start_block + T::RecalculationInterval::get());297			}298299			Ok(())300		}301302		#[pallet::weight(T::WeightInfo::stop_app_promotion())]303		pub fn stop_app_promotion(origin: OriginFor<T>) -> DispatchResult304		where305			<T as frame_system::Config>::BlockNumber: From<u32>,306		{307			ensure_root(origin)?;308309			if <StartBlock<T>>::get() != 0u32.into() {310				<StartBlock<T>>::set(T::BlockNumber::default());311				<NextInterestBlock<T>>::set(T::BlockNumber::default());312			}313314			Ok(())315		}316317		#[pallet::weight(T::WeightInfo::stake())]318		pub fn stake(staker: OriginFor<T>, amount: BalanceOf<T>) -> DispatchResult {319			let staker_id = ensure_signed(staker)?;320321			ensure!(322				StakesPerAccount::<T>::get(&staker_id) < 10,323				Error::<T>::NoPermission324			);325326			ensure!(327				amount >= Into::<BalanceOf<T>>::into(100u128) * T::Nominal::get(),328				ArithmeticError::Underflow329			);330331			let balance =332				<<T as Config>::Currency as Currency<T::AccountId>>::free_balance(&staker_id);333334			ensure!(balance >= amount, ArithmeticError::Underflow);335336			<<T as Config>::Currency as Currency<T::AccountId>>::ensure_can_withdraw(337				&staker_id,338				amount,339				WithdrawReasons::all(),340				balance - amount,341			)?;342343			Self::add_lock_balance(&staker_id, amount)?;344345			let block_number = T::RelayBlockNumberProvider::current_block_number();346			let recalc_block = (block_number / T::RecalculationInterval::get() + 2u32.into())347				* T::RecalculationInterval::get();348349			<Staked<T>>::insert((&staker_id, block_number), {350				let mut balance_and_recalc_block = <Staked<T>>::get((&staker_id, block_number));351				balance_and_recalc_block.0 = balance_and_recalc_block352					.0353					.checked_add(&amount)354					.ok_or(ArithmeticError::Overflow)?;355				balance_and_recalc_block.1 = recalc_block;356				balance_and_recalc_block357			});358359			<TotalStaked<T>>::set(360				<TotalStaked<T>>::get()361					.checked_add(&amount)362					.ok_or(ArithmeticError::Overflow)?,363			);364365			StakesPerAccount::<T>::mutate(&staker_id, |stakes| *stakes += 1);366			Ok(())367		}368369		#[pallet::weight(T::WeightInfo::unstake())]370		pub fn unstake(staker: OriginFor<T>) -> DispatchResultWithPostInfo {371			let staker_id = ensure_signed(staker)?;372373			let mut total_stakes = 0u64;374375			let total_staked: BalanceOf<T> = Staked::<T>::drain_prefix((&staker_id,))376				.map(|(_, (amount, _))| {377					total_stakes += 1;378					amount379				})380				.sum();381382			if total_staked.is_zero() {383				return Ok(None.into());384			}385			let block =386				T::RelayBlockNumberProvider::current_block_number() + T::PendingInterval::get();387			<PendingUnstake<T>>::insert(388				(&staker_id, block),389				<PendingUnstake<T>>::get((&staker_id, block))390					.checked_add(&total_staked)391					.ok_or(ArithmeticError::Overflow)?,392			);393394			TotalStaked::<T>::set(395				TotalStaked::<T>::get()396					.checked_sub(&total_staked)397					.ok_or(ArithmeticError::Underflow)?,398			); // when error we should recover initial stake state for the staker399400			StakesPerAccount::<T>::remove(&staker_id);401402			Ok(None.into())403		}404405		#[pallet::weight(T::WeightInfo::sponsor_collection())]406		pub fn sponsor_collection(407			admin: OriginFor<T>,408			collection_id: CollectionId,409		) -> DispatchResult {410			let admin_id = ensure_signed(admin)?;411			ensure!(412				admin_id == Admin::<T>::get().ok_or(Error::<T>::AdminNotSet)?,413				Error::<T>::NoPermission414			);415416			T::CollectionHandler::set_sponsor(Self::account_id(), collection_id)417		}418		#[pallet::weight(T::WeightInfo::stop_sponsoring_collection())]419		pub fn stop_sponsoring_collection(420			admin: OriginFor<T>,421			collection_id: CollectionId,422		) -> DispatchResult {423			let admin_id = ensure_signed(admin)?;424425			ensure!(426				admin_id == Admin::<T>::get().ok_or(Error::<T>::AdminNotSet)?,427				Error::<T>::NoPermission428			);429430			ensure!(431				T::CollectionHandler::get_sponsor(collection_id)?432					.ok_or(<Error<T>>::InvalidArgument)?433					== Self::account_id(),434				<Error<T>>::NoPermission435			);436			T::CollectionHandler::remove_collection_sponsor(collection_id)437		}438439		#[pallet::weight(T::WeightInfo::sponsor_contract())]440		pub fn sponsor_conract(admin: OriginFor<T>, contract_id: H160) -> DispatchResult {441			let admin_id = ensure_signed(admin)?;442443			ensure!(444				admin_id == Admin::<T>::get().ok_or(Error::<T>::AdminNotSet)?,445				Error::<T>::NoPermission446			);447448			T::ContractHandler::set_sponsor(449				T::CrossAccountId::from_sub(Self::account_id()),450				contract_id,451			)452		}453454		#[pallet::weight(T::WeightInfo::stop_sponsoring_contract())]455		pub fn stop_sponsoring_contract(admin: OriginFor<T>, contract_id: H160) -> DispatchResult {456			let admin_id = ensure_signed(admin)?;457458			ensure!(459				admin_id == Admin::<T>::get().ok_or(Error::<T>::AdminNotSet)?,460				Error::<T>::NoPermission461			);462463			ensure!(464				T::ContractHandler::get_sponsor(contract_id)?.ok_or(<Error<T>>::InvalidArgument)?465					== T::CrossAccountId::from_sub(Self::account_id()),466				<Error<T>>::NoPermission467			);468			T::ContractHandler::remove_contract_sponsor(contract_id)469		}470471		#[pallet::weight(0)]472		pub fn payout_stakers(admin: OriginFor<T>, stakers_number: Option<u8>) -> DispatchResult {473			let admin_id = ensure_signed(admin)?;474475			ensure!(476				admin_id == Admin::<T>::get().ok_or(Error::<T>::AdminNotSet)?,477				Error::<T>::NoPermission478			);479480			let current_recalc_block =481				Self::get_current_recalc_block(T::RelayBlockNumberProvider::current_block_number());482			let next_recalc_block = current_recalc_block + T::RecalculationInterval::get();483484			let mut storage_iterator = Self::get_next_calculated_key()485				.map_or(Staked::<T>::iter().skip(0), |key| {486					Staked::<T>::iter_from(key).skip(1)487				});488489			NextCalculatedRecord::<T>::set(None);490491			{492				let mut stakers_number = stakers_number.unwrap_or(20);493				let mut current_id = admin_id;494				let mut income_acc = BalanceOf::<T>::default();495496				while let Some(((id, staked_block), (amount, next_recalc_block_for_stake))) =497					storage_iterator.next()498				{499					if current_id != id {500						if income_acc != BalanceOf::<T>::default() {501							<T::Currency as Currency<T::AccountId>>::transfer(502								&T::TreasuryAccountId::get(),503								&current_id,504								income_acc,505								ExistenceRequirement::KeepAlive,506							)507							.and_then(|_| Self::add_lock_balance(&current_id, income_acc))?;508509							Self::deposit_event(Event::StakingRecalculation(510								current_id, amount, income_acc,511							));512						}513514						if stakers_number == 0 {515							NextCalculatedRecord::<T>::set(Some((id, staked_block)));516							break;517						}518						stakers_number -= 1;519						income_acc = BalanceOf::<T>::default();520						current_id = id;521					};522					if current_recalc_block >= next_recalc_block_for_stake {523						Self::recalculate_and_insert_stake(524							&current_id,525							staked_block,526							next_recalc_block,527							amount,528							((current_recalc_block - next_recalc_block_for_stake)529								/ T::RecalculationInterval::get())530							.into() + 1,531							&mut income_acc,532						);533					}534				}535			}536537			Ok(())538		}539	}540}541542impl<T: Config> Pallet<T> {543	pub fn account_id() -> T::AccountId {544		T::PalletId::get().into_account_truncating()545	}546547	fn unlock_balance_unchecked(staker: &T::AccountId, amount: BalanceOf<T>) {548		let mut locked_balance = Self::get_locked_balance(staker).map(|l| l.amount).unwrap();549		locked_balance -= amount;550		Self::set_lock_unchecked(staker, locked_balance);551	}552553	fn add_lock_balance(staker: &T::AccountId, amount: BalanceOf<T>) -> DispatchResult {554		Self::get_locked_balance(staker)555			.map_or(<BalanceOf<T>>::default(), |l| l.amount)556			.checked_add(&amount)557			.map(|new_lock| Self::set_lock_unchecked(staker, new_lock))558			.ok_or(ArithmeticError::Overflow.into())559	}560561	fn set_lock_unchecked(staker: &T::AccountId, amount: BalanceOf<T>) {562		if amount.is_zero() {563			<T::Currency as LockableCurrency<T::AccountId>>::remove_lock(LOCK_IDENTIFIER, &staker);564		} else {565			<T::Currency as LockableCurrency<T::AccountId>>::set_lock(566				LOCK_IDENTIFIER,567				staker,568				amount,569				WithdrawReasons::all(),570			)571		}572	}573574	pub fn get_locked_balance(575		staker: impl EncodeLike<T::AccountId>,576	) -> Option<BalanceLock<BalanceOf<T>>> {577		<T::Currency as ExtendedLockableCurrency<T::AccountId>>::locks(staker)578			.into_iter()579			.find(|l| l.id == LOCK_IDENTIFIER)580	}581582	pub fn total_staked_by_id(staker: impl EncodeLike<T::AccountId>) -> Option<BalanceOf<T>> {583		let staked = Staked::<T>::iter_prefix((staker,))584			.into_iter()585			.fold(<BalanceOf<T>>::default(), |acc, (_, (amount, _))| {586				acc + amount587			});588		if staked != <BalanceOf<T>>::default() {589			Some(staked)590		} else {591			None592		}593	}594595	pub fn total_staked_by_id_per_block(596		staker: impl EncodeLike<T::AccountId>,597	) -> Option<Vec<(T::BlockNumber, BalanceOf<T>)>> {598		let mut staked = Staked::<T>::iter_prefix((staker,))599			.into_iter()600			.map(|(block, (amount, _))| (block, amount))601			.collect::<Vec<_>>();602		staked.sort_by_key(|(block, _)| *block);603		if !staked.is_empty() {604			Some(staked)605		} else {606			None607		}608	}609610	pub fn cross_id_total_staked(staker: Option<T::CrossAccountId>) -> Option<BalanceOf<T>> {611		staker.map_or(Some(<TotalStaked<T>>::get()), |s| {612			Self::total_staked_by_id(s.as_sub())613		})614		// Self::total_staked_by_id(staker.as_sub())615	}616617	pub fn cross_id_locked_balance(staker: T::CrossAccountId) -> BalanceOf<T> {618		Self::get_locked_balance(staker.as_sub())619			.map(|l| l.amount)620			.unwrap_or_default()621	}622623	pub fn cross_id_total_staked_per_block(624		staker: T::CrossAccountId,625	) -> Vec<(T::BlockNumber, BalanceOf<T>)> {626		Self::total_staked_by_id_per_block(staker.as_sub()).unwrap_or_default()627	}628629	fn recalculate_and_insert_stake(630		staker: &T::AccountId,631		staked_block: T::BlockNumber,632		next_recalc_block: T::BlockNumber,633		base: BalanceOf<T>,634		iters: u32,635		income_acc: &mut BalanceOf<T>,636	) {637		let income = Self::calculate_income(base, iters);638639		base.checked_add(&income).map(|res| {640			<Staked<T>>::insert((staker, staked_block), (res, next_recalc_block));641			*income_acc += income;642		});643	}644645	fn calculate_income<I>(base: I, iters: u32) -> I646	where647		I: EncodeLike<BalanceOf<T>> + Balance,648	{649		let mut income = base;650651		(0..iters).for_each(|_| income += T::IntervalIncome::get() * income);652653		income - base654	}655656	fn get_current_recalc_block(current_relay_block: T::BlockNumber) -> T::BlockNumber {657		(current_relay_block / T::RecalculationInterval::get()) * T::RecalculationInterval::get()658	}659660	// fn get_next_recalc_block(current_relay_block: T::BlockNumber) -> T::BlockNumber {661	// 	Self::get_current_recalc_block(current_relay_block) + T::RecalculationInterval::get()662	// }663664	fn get_next_calculated_key() -> Option<Vec<u8>> {665		Self::get_next_calculated_record().map(|key| Staked::<T>::hashed_key_for(key))666	}667}668669impl<T: Config> Pallet<T>670where671	<<T as Config>::Currency as Currency<T::AccountId>>::Balance: Sum,672{673	pub fn cross_id_pending_unstake(staker: Option<T::CrossAccountId>) -> BalanceOf<T> {674		staker.map_or(PendingUnstake::<T>::iter_values().sum(), |s| {675			PendingUnstake::<T>::iter_prefix_values((s.as_sub(),)).sum()676		})677	}678679	pub fn cross_id_pending_unstake_per_block(680		staker: T::CrossAccountId,681	) -> Vec<(T::BlockNumber, BalanceOf<T>)> {682		let mut unsorted_res = PendingUnstake::<T>::iter_prefix((staker.as_sub(),))683			.into_iter()684			.collect::<Vec<_>>();685		unsorted_res.sort_by_key(|(block, _)| *block);686		unsorted_res687	}688}