feat: initialize Kurdistan SDK - independent fork of Polkadot SDK

pezkuwi/runtime/teyrchains/src/reward_points.rs

@@ -0,0 +1,95 @@
+// Copyright (C) Parity Technologies (UK) Ltd.
+// This file is part of Pezkuwi.
+
+// Pezkuwi 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.
+
+// Pezkuwi 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 Pezkuwi.  If not, see <http://www.gnu.org/licenses/>.
+
+//! An implementation of the `RewardValidators` trait used by `inclusion` that employs
+//! `pallet-staking` to compute the rewards.
+//!
+//! Based on <https://research.web3.foundation/en/latest/polkadot/overview/2-token-economics.html>
+//! which doesn't currently mention availability bitfields. As such, we don't reward them
+//! for the time being, although we will build schemes to do so in the future.
+
+use crate::{session_info, shared};
+use alloc::collections::btree_set::BTreeSet;
+use frame_support::traits::{Defensive, RewardsReporter, ValidatorSet};
+use pezkuwi_primitives::{SessionIndex, ValidatorIndex};
+
+/// The amount of era points given by backing a candidate that is included.
+pub const BACKING_POINTS: u32 = 20;
+/// The amount of era points given by dispute voting on a candidate.
+pub const DISPUTE_STATEMENT_POINTS: u32 = 20;
+
+/// Rewards validators for participating in teyrchains with era points in pallet-staking.
+pub struct RewardValidatorsWithEraPoints<C, R>(core::marker::PhantomData<(C, R)>);
+
+impl<C, R> RewardValidatorsWithEraPoints<C, R>
+where
+	C: session_info::Config,
+	C::ValidatorSet: ValidatorSet<C::AccountId, ValidatorId = C::AccountId>,
+	R: RewardsReporter<C::AccountId>,
+{
+	/// Reward validators in session with points, but only if they are in the active set.
+	fn reward_only_active(
+		session_index: SessionIndex,
+		indices: impl IntoIterator<Item = ValidatorIndex>,
+		points: u32,
+	) {
+		let validators = session_info::AccountKeys::<C>::get(&session_index);
+		let validators = match validators
+			.defensive_proof("account_keys are present for dispute_period sessions")
+		{
+			Some(validators) => validators,
+			None => return,
+		};
+		// limit rewards to the active validator set
+		let active_set: BTreeSet<_> = C::ValidatorSet::validators().into_iter().collect();
+
+		let rewards = indices
+			.into_iter()
+			.filter_map(|i| validators.get(i.0 as usize).cloned())
+			.filter(|v| active_set.contains(v))
+			.map(|v| (v, points));
+
+		R::reward_by_ids(rewards);
+	}
+}
+
+impl<C, R> crate::inclusion::RewardValidators for RewardValidatorsWithEraPoints<C, R>
+where
+	C: shared::Config + session_info::Config,
+	C::ValidatorSet: ValidatorSet<C::AccountId, ValidatorId = C::AccountId>,
+	R: RewardsReporter<C::AccountId>,
+{
+	fn reward_backing(indices: impl IntoIterator<Item = ValidatorIndex>) {
+		let session_index = shared::CurrentSessionIndex::<C>::get();
+		Self::reward_only_active(session_index, indices, BACKING_POINTS);
+	}
+
+	fn reward_bitfields(_validators: impl IntoIterator<Item = ValidatorIndex>) {}
+}
+
+impl<C, R> crate::disputes::RewardValidators for RewardValidatorsWithEraPoints<C, R>
+where
+	C: session_info::Config,
+	C::ValidatorSet: ValidatorSet<C::AccountId, ValidatorId = C::AccountId>,
+	R: RewardsReporter<C::AccountId>,
+{
+	fn reward_dispute_statement(
+		session: SessionIndex,
+		validators: impl IntoIterator<Item = ValidatorIndex>,
+	) {
+		Self::reward_only_active(session, validators, DISPUTE_STATEMENT_POINTS);
+	}
+}