Provider Boosting implementation

Makefile

@@ -191,9 +191,6 @@ benchmarks-multi:
 benchmarks-multi-local:
 	./scripts/run_benchmarks.sh -t bench-dev $(PALLETS)
 
-benchmarks-capacity:
-	./scripts/run_benchmark.sh -p capacity
-
 .PHONY: docs
 docs:
 	RUSTC_BOOTSTRAP=1 RUSTDOCFLAGS="--enable-index-page -Zunstable-options" cargo doc --no-deps --features frequency

common/primitives/src/capacity.rs

@@ -1,7 +1,12 @@
 use crate::msa::MessageSourceId;
 use frame_support::traits::tokens::Balance;
+use scale_info::TypeInfo;
+use sp_core::{Decode, Encode, MaxEncodedLen, RuntimeDebug};
 use sp_runtime::DispatchError;
 
+/// The type of a Reward Era
+pub type RewardEra = u32;
+
 /// A trait for checking that a target MSA can be staked to.
 pub trait TargetValidator {
 	/// Checks if an MSA is a valid target.
@@ -15,19 +20,24 @@ impl TargetValidator for () {
 	}
 }
 
-/// A trait for Non-transferable asset.
+/// A trait for Non-transferable asset
 pub trait Nontransferable {
 	/// Scalar type for representing balance of an account.
 	type Balance: Balance;
 
-	/// The balance Capacity for an MSA account.
+	/// The balance Capacity for an MSA.
 	fn balance(msa_id: MessageSourceId) -> Self::Balance;
 
-	/// Reduce Capacity of an MSA account by amount.
-	fn deduct(msa_id: MessageSourceId, amount: Self::Balance) -> Result<(), DispatchError>;
+	/// Reduce Capacity of an MSA by amount.
+	fn deduct(msa_id: MessageSourceId, capacity_amount: Self::Balance)
+		-> Result<(), DispatchError>;
 
-	/// Increase Capacity of an MSA account by an amount.
-	fn deposit(msa_id: MessageSourceId, amount: Self::Balance) -> Result<(), DispatchError>;
+	/// Increase Staked Token + Capacity amounts of an MSA. (unused)
+	fn deposit(
+		msa_id: MessageSourceId,
+		token_amount: Self::Balance,
+		capacity_amount: Self::Balance,
+	) -> Result<(), DispatchError>;
 }
 
 /// A trait for replenishing Capacity.
@@ -47,3 +57,22 @@ pub trait Replenishable {
 	/// Checks if an account can be replenished.
 	fn can_replenish(msa_id: MessageSourceId) -> bool;
 }
+
+/// Result of checking a Boost History item to see if it's eligible for a reward.
+#[derive(
+	Copy, Clone, Default, Encode, Eq, Decode, RuntimeDebug, MaxEncodedLen, PartialEq, TypeInfo,
+)]
+
+pub struct UnclaimedRewardInfo<Balance, BlockNumber> {
+	/// The Reward Era for which this reward was earned
+	pub reward_era: RewardEra,
+	/// When this reward expires, i.e. can no longer be claimed
+	pub expires_at_block: BlockNumber,
+	/// The total staked in this era as of the current block
+	pub staked_amount: Balance,
+	/// The amount staked in this era that is eligible for rewards.  Does not count additional amounts
+	/// staked in this era.
+	pub eligible_amount: Balance,
+	/// The amount in token of the reward (only if it can be calculated using only on chain data)
+	pub earned_amount: Balance,
+}

designdocs/capacity.md

@@ -117,7 +117,7 @@ Stakes some amount of tokens to the network and generates Capacity.
 ///
 /// - Returns Error::InsufficientBalance if the sender does not have free balance amount needed to stake.
 /// - Returns Error::InvalidTarget if attempting to stake to an invalid target.
-/// - Returns Error::InsufficientStakingAmount if attempting to stake an amount below the minimum amount.
+/// - Returns Error::StakingAmountBelowMinimum if attempting to stake an amount below the minimum amount.
 /// - Returns Error::BalanceTooLowtoStake if the sender does not have
 ///           free balance amount > MinimumTokenBalance after staking.
 pub fn stake(origin: OriginFor<T>, target: MessageSourceId, amount: BalanceOf<T>) -> DispatchResult {}
@@ -211,7 +211,7 @@ pub enum Error<T> {
   /// Capacity is not available for the given MSA.
   InsufficientBalance,
   /// Staker is attempting to stake an amount below the minimum amount.
-  InsufficientStakingAmount,
+  StakingAmountBelowMinimum,
   /// Staker is attempting to stake a zero amount.
   ZeroAmountNotAllowed,
   /// Origin has no Staking Account
@@ -828,7 +828,7 @@ Note that Capacity transactions do not get refunded for overcharges.
 
 ## Non-goals
 
-Staking rewards and re-staking are left for another design document.
+Rewards and re-staking are left for another design document.
 
 ## Benefits and Risk
 

designdocs/provider_boosting_economic_model.md

@@ -66,11 +66,13 @@ This document does not:
 
 ### Formula
 
-The Provider Boost reward in FRQCY tokens for a given Era <i>e</i> is
+The Provider Boost reward in FRQCY tokens for a given Era <i>e</i> is a simple interest model, with the following formula:
 
 R = <i>min</i>(R<sub>era</sub>*L<sub>u</sub>/L<sub>T</sub>, L<sub>u</sub>*P<sub>max</sub>)
 
-Put into words, if the pool of Rewards per Era is R<sub>era</sub> FRQCY, then the Reward amount in FRQCY earned by a given Provider Booster will be proportional to how much they've locked for Provider Boosting out of the total, OR P<sub>max</sub> times the amount locked, whichever is less.
+Put into words, if the pool of Rewards per Era is 
+
+R<sub>era</sub> FRQCY, then the Reward amount in FRQCY earned by a given Provider Booster will be proportional to how much they've locked for Provider Boosting out of the total OR P<sub>max</sub> times the amount locked, whichever is less.
 
 Put another way, there is a fixed number of tokens to be rewarded each Era (R<sub>era</sub>), split up according to each Provider Boost account holder's percentage of the locked total. However, the reward return each Era for every individual account (P<sub>max</sub>) is capped at some rate, for example, 10%.
 
@@ -93,4 +95,4 @@ Rewards are not prorated; they are calculated only for balances held for an enti
 - Provider Boost Rewards are not minted until they are explicitly <i>claimed</i> by the Provider Boost account holder, by calling a non-free extrinsic.
 - Rewards must be claimed within a certain number of Provider Boost Eras.
 - When claimed, all available, unexpired Rewards for each previous Era are minted and transferred to the same account that locked them.
-- **Is there a cap on how much can be claimed at once?**
+- Currently there is no cap on how much can be claimed at once.