permissionless bond_extra in nomination pools

frame/nomination-pools/benchmarking/src/lib.rs

@@ -30,7 +30,7 @@ use frame_system::RawOrigin as RuntimeOrigin;
 use pallet_nomination_pools::{
 	BalanceOf, BondExtra, BondedPoolInner, BondedPools, ConfigOp, MaxPoolMembers,
 	MaxPoolMembersPerPool, MaxPools, Metadata, MinCreateBond, MinJoinBond, Pallet as Pools,
-	PoolMembers, PoolRoles, PoolState, RewardPools, SubPoolsStorage,
+	PoolMembers, PoolRoles, PoolState, RewardPools, SubPoolsStorage, ClaimableAction,
 };
 use sp_runtime::traits::{Bounded, StaticLookup, Zero};
 use sp_staking::{EraIndex, StakingInterface};
@@ -268,6 +268,25 @@ frame_benchmarking::benchmarks! {
 		);
 	}
 
+	root_bond_extra {
+		let origin_weight = Pools::<T>::depositor_min_bond() * 2u32.into();
+		let scenario = ListScenario::<T>::new(origin_weight, true)?;
+		let scenario_creator1_lookup = T::Lookup::unlookup(scenario.creator1.clone());
+		let extra = (scenario.dest_weight - origin_weight).max(CurrencyOf::<T>::minimum_balance());
+
+		// transfer exactly `extra` to the depositor of the src pool (1), from the reward balance
+		let reward_account1 = Pools::<T>::create_reward_account(1);
+		assert!(extra >= CurrencyOf::<T>::minimum_balance());
+		CurrencyOf::<T>::deposit_creating(&reward_account1, extra);
+
+	}:_(RuntimeOrigin::Signed(scenario.creator1.clone()), scenario_creator1_lookup)
+	verify {
+		assert!(
+			T::Staking::active_stake(&scenario.origin1).unwrap() >=
+			scenario.dest_weight
+		);
+	}
+
 	claim_payout {
 		let origin_weight = Pools::<T>::depositor_min_bond() * 2u32.into();
 		let ed = CurrencyOf::<T>::minimum_balance();
@@ -652,6 +671,28 @@ frame_benchmarking::benchmarks! {
 		assert!(T::Staking::nominations(Pools::<T>::create_bonded_account(1)).is_none());
 	}
 
+	set_claimable_action {
+		// Create a pool
+		let min_create_bond = Pools::<T>::depositor_min_bond();
+		let (depositor, pool_account) = create_pool_account::<T>(0, min_create_bond);
+
+		// Add a new member
+		let min_join_bond = MinJoinBond::<T>::get().max(CurrencyOf::<T>::minimum_balance());
+		let joiner = create_funded_user_with_balance::<T>("joiner", 0, min_join_bond * 2u32.into());
+		let joiner_lookup = T::Lookup::unlookup(joiner.clone());
+		Pools::<T>::join(RuntimeOrigin::Signed(joiner.clone()).into(), min_join_bond, 1)
+			.unwrap();
+
+		// Sanity check join worked
+		assert_eq!(
+			T::Staking::active_stake(&pool_account).unwrap(),
+			min_create_bond + min_join_bond
+		);
+	}:_(RuntimeOrigin::Signed(joiner.clone()), true)
+	verify {
+		assert_eq!(ClaimableAction::<T>::get(joiner), true);
+	}
+
 	impl_benchmark_test_suite!(
 		Pallet,
 		crate::mock::new_test_ext(),

frame/nomination-pools/src/lib.rs

@@ -1276,6 +1276,10 @@ pub mod pallet {
 	pub type ReversePoolIdLookup<T: Config> =
 		CountedStorageMap<_, Twox64Concat, T::AccountId, PoolId, OptionQuery>;
 
+	/// Member decision for operator claimable reward action.
+	#[pallet::storage]
+	pub type ClaimableAction<T: Config> = StorageMap<_, Twox64Concat, T::AccountId, bool, ValueQuery>;
+
 	#[pallet::genesis_config]
 	pub struct GenesisConfig<T: Config> {
 		pub min_join_bond: BalanceOf<T>,
@@ -1433,6 +1437,8 @@ pub mod pallet {
 		PoolIdInUse,
 		/// Pool id provided is not correct/usable.
 		InvalidPoolId,
+		/// The caller is not the operator for this pool.
+		NotRoot,
 	}
 
 	#[derive(Encode, Decode, PartialEq, TypeInfo, frame_support::PalletError, RuntimeDebug)]
@@ -1566,6 +1572,61 @@ pub mod pallet {
 			Ok(())
 		}
 
+		// TODO: Update weight info
+		// Investigate adding helper function to remove code duplication.
+		#[pallet::weight(
+			T::WeightInfo::bond_extra_transfer()
+			.max(T::WeightInfo::bond_extra_reward())
+		)]
+		#[transactional]
+		pub fn root_bond_extra(
+			origin: OriginFor<T>, 
+			member_account: AccountIdLookupOf<T>,
+		) -> DispatchResult {
+			let who = ensure_signed(origin)?;
+			let member_account = T::Lookup::lookup(member_account)?;
+			let (mut member, mut bonded_pool, mut reward_pool) =
+				Self::get_member_with_pools(&member_account)?;
+
+			ensure!(bonded_pool.is_root(&who), Error::<T>::NotRoot);
+			ensure!(ClaimableAction::<T>::get(&member_account), Error::<T>::DoesNotHavePermission);
+
+			// IMPORTANT: reward pool records must be updated with the old points. why?
+			reward_pool.update_records(bonded_pool.id, bonded_pool.points)?;
+
+		    // A member who has no skin in the game anymore cannot claim any rewards.
+		    ensure!(!member.active_points().is_zero(), Error::<T>::FullyUnbonding);
+
+		    let current_reward_counter = 
+				reward_pool.current_reward_counter(bonded_pool.id, bonded_pool.points)?;
+		    let pending_rewards = member.pending_rewards(current_reward_counter)?;
+
+			if !pending_rewards.is_zero() {
+				member.last_recorded_reward_counter = current_reward_counter;
+				reward_pool.register_claimed_reward(pending_rewards);
+			}
+
+			let points_issued = bonded_pool.try_bond_funds(
+				&bonded_pool.reward_account(), 
+				pending_rewards, 
+				BondType::Later
+			)?;
+
+		    bonded_pool.ok_to_be_open(pending_rewards)?;
+			member.points = member.points.saturating_add(points_issued);
+
+			Self::deposit_event(Event::<T>::Bonded {
+				member: member_account.clone(),
+				pool_id: member.pool_id,
+				bonded: pending_rewards,
+				joined: false,
+			});
+
+			Self::put_member_with_pools(&member_account, member, bonded_pool, reward_pool);
+
+			Ok(())
+		}
+
 		/// A bonded member can use this to claim their payout based on the rewards that the pool
 		/// has accumulated since their last claimed payout (OR since joining if this is there first
 		/// time claiming rewards). The payout will be transferred to the member's account.
@@ -2079,6 +2140,19 @@ pub mod pallet {
 			ensure!(bonded_pool.can_nominate(&who), Error::<T>::NotNominator);
 			T::Staking::chill(&bonded_pool.bonded_account())
 		}
+
+		// TODO: For when the pool member leaves or is kiked out, clear storage.
+		// Update weight info
+		#[pallet::weight(T::DbWeight::get().reads_writes(1, 1))]
+		pub fn set_claimable_action(origin: OriginFor<T>, action: bool) -> DispatchResult {
+			let who = ensure_signed(origin)?;
+
+			ensure!(PoolMembers::<T>::contains_key(&who), Error::<T>::PoolMemberNotFound);
+			<ClaimableAction::<T>>::mutate(who, |delegate| {
+				*delegate = action;	
+			});
+			Ok(())
+		}
 	}
 
 	#[pallet::hooks]
@@ -2265,7 +2339,7 @@ impl<T: Config> Pallet<T> {
 			// We check for zero above
 			.div(current_points)
 	}
-
+	// TODO: Investigate logic here to add conditional event emission on different account types.
 	/// If the member has some rewards, transfer a payout from the reward pool to the member.
 	// Emits events and potentially modifies pool state if any arithmetic saturates, but does
 	// not persist any of the mutable inputs to storage.

frame/nomination-pools/src/tests.rs

@@ -4207,10 +4207,10 @@ mod create {
 		ExtBuilder::default().build_and_execute(|| {
 			let ed = Balances::minimum_balance();
 
-			Balances::make_free_balance_be(&11, StakingMock::minimum_bond() + ed);
+			Balances::make_free_balance_be(&11, StakingMock::minimum_nominator_bond() + ed);
 			assert_ok!(Pools::create(
 				RuntimeOrigin::signed(11),
-				StakingMock::minimum_bond(),
+				StakingMock::minimum_nominator_bond(),
 				123,
 				456,
 				789
@@ -4241,6 +4241,39 @@ mod create {
 	}
 }
 
+#[test]
+fn set_claimable_action_works() {
+	ExtBuilder::default().build_and_execute(|| {
+		// Given
+		Balances::make_free_balance_be(&11, ExistentialDeposit::get() + 2);
+		assert!(!PoolMembers::<Runtime>::contains_key(&11));
+
+		// When
+		assert_ok!(Pools::join(RuntimeOrigin::signed(11), 2, 1));
+
+		// Then
+		assert_eq!(
+			pool_events_since_last_call(),
+			vec![
+				Event::Created { depositor: 10, pool_id: 1 },
+				Event::Bonded { member: 10, pool_id: 1, bonded: 10, joined: true },
+				Event::Bonded { member: 11, pool_id: 1, bonded: 2, joined: true },
+			]
+		);
+
+		// Give pool operator permission.
+		assert_eq!(ClaimableAction::<Runtime>::get(11), false);
+		assert_noop!(Pools::set_claimable_action(RuntimeOrigin::signed(12), true), Error::<T>::PoolMemberNotFound);
+		assert_ok!(Pools::set_claimable_action(RuntimeOrigin::signed(11), true));
+
+		// then
+		assert_eq!(ClaimableAction::<Runtime>::get(11), true);
+
+		ClaimableAction::<Runtime>::remove(11);
+		assert_eq!(ClaimableAction::<Runtime>::get(11), false);
+	});
+}
+
 mod nominate {
 	use super::*;
 
@@ -4553,6 +4586,7 @@ mod bond_extra {
 
 			// when
 			assert_ok!(Pools::bond_extra(RuntimeOrigin::signed(10), BondExtra::Rewards));
+			assert_eq!(Balances::free_balance(&default_reward_account()), 7);
 
 			// then
 			assert_eq!(Balances::free_balance(10), 35);
@@ -4584,6 +4618,46 @@ mod bond_extra {
 			);
 		})
 	}
+
+	#[test]
+	fn root_bond_extra_from_rewards() {
+		ExtBuilder::default().add_members(vec![(20, 20)]).build_and_execute(|| {
+			Balances::make_free_balance_be(&default_reward_account(), 8);
+			// ... if which only 3 is claimable to make sure the reward account does not die.
+			let claimable_reward = 8 - ExistentialDeposit::get();
+			// NOTE: easier to read of we use 3, so let's use the number instead of variable.
+			assert_eq!(claimable_reward, 3, "test is correct if rewards are divisible by 3");
+
+			// given
+			assert_eq!(PoolMembers::<Runtime>::get(10).unwrap().points, 10);
+			assert_eq!(PoolMembers::<Runtime>::get(20).unwrap().points, 20);
+			assert_eq!(BondedPools::<Runtime>::get(1).unwrap().points, 30);
+			assert_eq!(Balances::free_balance(10), 35);
+			assert_eq!(Balances::free_balance(20), 20);
+
+			assert_noop!(Pools::root_bond_extra(RuntimeOrigin::signed(900), 10), Error::<Runtime>::DoesNotHavePermission);
+			assert_ok!(Pools::set_claimable_action(RuntimeOrigin::signed(10), true));
+			assert_ok!(Pools::root_bond_extra(RuntimeOrigin::signed(900), 10));
+			assert_eq!(Balances::free_balance(&default_reward_account()), 7);
+
+			// then
+			assert_eq!(Balances::free_balance(10), 35);
+			assert_eq!(PoolMembers::<Runtime>::get(10).unwrap().points, 10 + 1);
+			assert_eq!(BondedPools::<Runtime>::get(1).unwrap().points, 30 + 1);
+
+			// when
+			assert_noop!(Pools::root_bond_extra(RuntimeOrigin::signed(900), 20), Error::<Runtime>::DoesNotHavePermission);
+			assert_ok!(Pools::set_claimable_action(RuntimeOrigin::signed(20), true));
+			assert_ok!(Pools::root_bond_extra(RuntimeOrigin::signed(900), 20));
+
+			// then
+			assert_eq!(Balances::free_balance(20), 20);
+			// 20's share of the rewards is the other 2/3 of the rewards, since they have 20/30 of
+			// the shares
+			assert_eq!(PoolMembers::<Runtime>::get(20).unwrap().points, 20 + 2);
+			assert_eq!(BondedPools::<Runtime>::get(1).unwrap().points, 30 + 3);
+		})
+	}
 }
 
 mod update_roles {