Files
pezkuwi-subxt/substrate/frame/nomination-pools/src/tests.rs
T
Kian Paimani b56c0e4cb6 Fast Unstake Pallet (#12129)
* add failing test for itamar

* an ugly example of fast unstake

* Revert "add failing test for itamar"

This reverts commit 16c4d8015698a0684c090c54fce8b470a2d2feb2.

* fast unstake wip

* clean it up a bit

* some comments

* on_idle logic

* fix

* comment

* new working version, checks all pass, looking good

* some notes

* add mock boilerplate

* more boilerplate

* simplify the weight stuff

* ExtBuilder for pools

* fmt

* rm bags-list, simplify setup_works

* mock + tests boilerplate

* make some benchmarks work

* mock boilerplate

* tests boilerplate

* run_to_block works

* add Error enums

* add test

* note

* make UnstakeRequest fields pub

* some tests

* fix origin

* fmt

* add fast_unstake_events_since_last_call

* text

* rewrite some benchmes and fix them -- the outcome is still strange

* Fix weights

* cleanup

* Update frame/election-provider-support/solution-type/src/single_page.rs

* fix build

* Fix pools tests

* iterate teset + mock

* test unfinished

* cleanup and add some tests

* add test successful_multi_queue

* comment

* rm Head check

* add TODO

* complete successful_multi_queue

* + test early_exit

* fix a lot of things above the beautiful atlantic ocean 🌊

* seemingly it is finished now

* Fix build

* ".git/.scripts/fmt.sh" 1

* Fix slashing amount as well

* better docs

* abstract types

* rm use

* import

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

Co-authored-by: Nitwit <47109040+nitwit69@users.noreply.github.com>

* Update frame/fast-unstake/src/types.rs

Co-authored-by: Nitwit <47109040+nitwit69@users.noreply.github.com>

* Fix build

* fmt

* Update frame/fast-unstake/src/lib.rs

Co-authored-by: Keith Yeung <kungfukeith11@gmail.com>

* make bounded

* feedback from code review with Ankan

* Update frame/fast-unstake/src/lib.rs

Co-authored-by: Roman Useinov <roman.useinov@gmail.com>

* Update frame/fast-unstake/src/lib.rs

Co-authored-by: Roman Useinov <roman.useinov@gmail.com>

* Update frame/fast-unstake/src/lib.rs

Co-authored-by: Roman Useinov <roman.useinov@gmail.com>

* Update frame/fast-unstake/src/lib.rs

Co-authored-by: Roman Useinov <roman.useinov@gmail.com>

* Update frame/fast-unstake/src/lib.rs

Co-authored-by: Roman Useinov <roman.useinov@gmail.com>

* Update frame/fast-unstake/src/lib.rs

Co-authored-by: Roman Useinov <roman.useinov@gmail.com>

* Update frame/fast-unstake/src/lib.rs

Co-authored-by: Roman Useinov <roman.useinov@gmail.com>

* Update frame/fast-unstake/src/lib.rs

Co-authored-by: Roman Useinov <roman.useinov@gmail.com>

* Update frame/fast-unstake/src/lib.rs

Co-authored-by: Roman Useinov <roman.useinov@gmail.com>

* Update frame/fast-unstake/src/mock.rs

* update to master

* some final review comments

* fmt

* fix clippy

* remove unused

* ".git/.scripts/fmt.sh" 1

* make it all build again

* fmt

* undo fishy change

Co-authored-by: Ross Bulat <ross@jkrbinvestments.com>
Co-authored-by: command-bot <>
Co-authored-by: Nitwit <47109040+nitwit69@users.noreply.github.com>
Co-authored-by: Keith Yeung <kungfukeith11@gmail.com>
Co-authored-by: Roman Useinov <roman.useinov@gmail.com>
2022-09-23 09:36:33 +00:00

5353 lines
167 KiB
Rust

// This file is part of Substrate.
// Copyright (C) 2020-2022 Parity Technologies (UK) Ltd.
// SPDX-License-Identifier: Apache-2.0
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
use super::*;
use crate::{mock::*, Event};
use frame_support::{assert_err, assert_noop, assert_ok, assert_storage_noop, bounded_btree_map};
use pallet_balances::Event as BEvent;
use sp_runtime::traits::Dispatchable;
macro_rules! unbonding_pools_with_era {
($($k:expr => $v:expr),* $(,)?) => {{
use sp_std::iter::{Iterator, IntoIterator};
let not_bounded: BTreeMap<_, _> = Iterator::collect(IntoIterator::into_iter([$(($k, $v),)*]));
UnbondingPoolsWithEra::try_from(not_bounded).unwrap()
}};
}
macro_rules! member_unbonding_eras {
($( $any:tt )*) => {{
let x: BoundedBTreeMap<EraIndex, Balance, MaxUnbonding> = bounded_btree_map!($( $any )*);
x
}};
}
pub const DEFAULT_ROLES: PoolRoles<AccountId> =
PoolRoles { depositor: 10, root: Some(900), nominator: Some(901), state_toggler: Some(902) };
#[test]
fn test_setup_works() {
ExtBuilder::default().build_and_execute(|| {
assert_eq!(BondedPools::<Runtime>::count(), 1);
assert_eq!(RewardPools::<Runtime>::count(), 1);
assert_eq!(SubPoolsStorage::<Runtime>::count(), 0);
assert_eq!(PoolMembers::<Runtime>::count(), 1);
assert_eq!(StakingMock::bonding_duration(), 3);
assert!(Metadata::<T>::contains_key(1));
let last_pool = LastPoolId::<Runtime>::get();
assert_eq!(
BondedPool::<Runtime>::get(last_pool).unwrap(),
BondedPool::<Runtime> {
id: last_pool,
inner: BondedPoolInner {
state: PoolState::Open,
points: 10,
member_counter: 1,
roles: DEFAULT_ROLES
},
}
);
assert_eq!(
RewardPools::<Runtime>::get(last_pool).unwrap(),
RewardPool::<Runtime> {
last_recorded_reward_counter: Zero::zero(),
last_recorded_total_payouts: 0,
total_rewards_claimed: 0
}
);
assert_eq!(
PoolMembers::<Runtime>::get(10).unwrap(),
PoolMember::<Runtime> { pool_id: last_pool, points: 10, ..Default::default() }
);
let bonded_account = Pools::create_bonded_account(last_pool);
let reward_account = Pools::create_reward_account(last_pool);
// the bonded_account should be bonded by the depositor's funds.
assert_eq!(StakingMock::active_stake(&bonded_account).unwrap(), 10);
assert_eq!(StakingMock::total_stake(&bonded_account).unwrap(), 10);
// but not nominating yet.
assert!(Nominations::get().is_none());
// reward account should have an initial ED in it.
assert_eq!(Balances::free_balance(&reward_account), Balances::minimum_balance());
})
}
mod bonded_pool {
use super::*;
#[test]
fn balance_to_point_works() {
ExtBuilder::default().build_and_execute(|| {
let mut bonded_pool = BondedPool::<Runtime> {
id: 123123,
inner: BondedPoolInner {
state: PoolState::Open,
points: 100,
member_counter: 1,
roles: DEFAULT_ROLES,
},
};
// 1 points : 1 balance ratio
StakingMock::set_bonded_balance(bonded_pool.bonded_account(), 100);
assert_eq!(bonded_pool.balance_to_point(10), 10);
assert_eq!(bonded_pool.balance_to_point(0), 0);
// 2 points : 1 balance ratio
StakingMock::set_bonded_balance(bonded_pool.bonded_account(), 50);
assert_eq!(bonded_pool.balance_to_point(10), 20);
// 1 points : 2 balance ratio
StakingMock::set_bonded_balance(bonded_pool.bonded_account(), 100);
bonded_pool.points = 50;
assert_eq!(bonded_pool.balance_to_point(10), 5);
// 100 points : 0 balance ratio
StakingMock::set_bonded_balance(bonded_pool.bonded_account(), 0);
bonded_pool.points = 100;
assert_eq!(bonded_pool.balance_to_point(10), 100 * 10);
// 0 points : 100 balance
StakingMock::set_bonded_balance(bonded_pool.bonded_account(), 100);
bonded_pool.points = 0;
assert_eq!(bonded_pool.balance_to_point(10), 10);
// 10 points : 3 balance ratio
StakingMock::set_bonded_balance(bonded_pool.bonded_account(), 30);
bonded_pool.points = 100;
assert_eq!(bonded_pool.balance_to_point(10), 33);
// 2 points : 3 balance ratio
StakingMock::set_bonded_balance(bonded_pool.bonded_account(), 300);
bonded_pool.points = 200;
assert_eq!(bonded_pool.balance_to_point(10), 6);
// 4 points : 9 balance ratio
StakingMock::set_bonded_balance(bonded_pool.bonded_account(), 900);
bonded_pool.points = 400;
assert_eq!(bonded_pool.balance_to_point(90), 40);
})
}
#[test]
fn points_to_balance_works() {
ExtBuilder::default().build_and_execute(|| {
// 1 balance : 1 points ratio
let mut bonded_pool = BondedPool::<Runtime> {
id: 123123,
inner: BondedPoolInner {
state: PoolState::Open,
points: 100,
member_counter: 1,
roles: DEFAULT_ROLES,
},
};
StakingMock::set_bonded_balance(bonded_pool.bonded_account(), 100);
assert_eq!(bonded_pool.points_to_balance(10), 10);
assert_eq!(bonded_pool.points_to_balance(0), 0);
// 2 balance : 1 points ratio
bonded_pool.points = 50;
assert_eq!(bonded_pool.points_to_balance(10), 20);
// 100 balance : 0 points ratio
StakingMock::set_bonded_balance(bonded_pool.bonded_account(), 100);
bonded_pool.points = 0;
assert_eq!(bonded_pool.points_to_balance(10), 0);
// 0 balance : 100 points ratio
StakingMock::set_bonded_balance(bonded_pool.bonded_account(), 0);
bonded_pool.points = 100;
assert_eq!(bonded_pool.points_to_balance(10), 0);
// 10 balance : 3 points ratio
StakingMock::set_bonded_balance(bonded_pool.bonded_account(), 100);
bonded_pool.points = 30;
assert_eq!(bonded_pool.points_to_balance(10), 33);
// 2 balance : 3 points ratio
StakingMock::set_bonded_balance(bonded_pool.bonded_account(), 200);
bonded_pool.points = 300;
assert_eq!(bonded_pool.points_to_balance(10), 6);
// 4 balance : 9 points ratio
StakingMock::set_bonded_balance(bonded_pool.bonded_account(), 400);
bonded_pool.points = 900;
assert_eq!(bonded_pool.points_to_balance(90), 40);
})
}
#[test]
fn ok_to_join_with_works() {
ExtBuilder::default().build_and_execute(|| {
let pool = BondedPool::<Runtime> {
id: 123,
inner: BondedPoolInner {
state: PoolState::Open,
points: 100,
member_counter: 1,
roles: DEFAULT_ROLES,
},
};
let max_points_to_balance: u128 =
<<Runtime as Config>::MaxPointsToBalance as Get<u8>>::get().into();
// Simulate a 100% slashed pool
StakingMock::set_bonded_balance(pool.bonded_account(), 0);
assert_noop!(pool.ok_to_join(0), Error::<Runtime>::OverflowRisk);
// Simulate a slashed pool at `MaxPointsToBalance` + 1 slashed pool
StakingMock::set_bonded_balance(
pool.bonded_account(),
max_points_to_balance.saturating_add(1).into(),
);
assert_ok!(pool.ok_to_join(0));
// Simulate a slashed pool at `MaxPointsToBalance`
StakingMock::set_bonded_balance(pool.bonded_account(), max_points_to_balance);
assert_noop!(pool.ok_to_join(0), Error::<Runtime>::OverflowRisk);
StakingMock::set_bonded_balance(
pool.bonded_account(),
Balance::MAX / max_points_to_balance,
);
// New bonded balance would be over threshold of Balance type
assert_noop!(pool.ok_to_join(0), Error::<Runtime>::OverflowRisk);
// and a sanity check
StakingMock::set_bonded_balance(
pool.bonded_account(),
Balance::MAX / max_points_to_balance - 1,
);
assert_ok!(pool.ok_to_join(0));
});
}
}
mod reward_pool {
#[test]
fn current_balance_only_counts_balance_over_existential_deposit() {
use super::*;
ExtBuilder::default().build_and_execute(|| {
let reward_account = Pools::create_reward_account(2);
// Given
assert_eq!(Balances::free_balance(&reward_account), 0);
// Then
assert_eq!(RewardPool::<Runtime>::current_balance(2), 0);
// Given
Balances::make_free_balance_be(&reward_account, Balances::minimum_balance());
// Then
assert_eq!(RewardPool::<Runtime>::current_balance(2), 0);
// Given
Balances::make_free_balance_be(&reward_account, Balances::minimum_balance() + 1);
// Then
assert_eq!(RewardPool::<Runtime>::current_balance(2), 1);
});
}
}
mod unbond_pool {
use super::*;
#[test]
fn points_to_issue_works() {
ExtBuilder::default().build_and_execute(|| {
// 1 points : 1 balance ratio
let unbond_pool = UnbondPool::<Runtime> { points: 100, balance: 100 };
assert_eq!(unbond_pool.balance_to_point(10), 10);
assert_eq!(unbond_pool.balance_to_point(0), 0);
// 2 points : 1 balance ratio
let unbond_pool = UnbondPool::<Runtime> { points: 100, balance: 50 };
assert_eq!(unbond_pool.balance_to_point(10), 20);
// 1 points : 2 balance ratio
let unbond_pool = UnbondPool::<Runtime> { points: 50, balance: 100 };
assert_eq!(unbond_pool.balance_to_point(10), 5);
// 100 points : 0 balance ratio
let unbond_pool = UnbondPool::<Runtime> { points: 100, balance: 0 };
assert_eq!(unbond_pool.balance_to_point(10), 100 * 10);
// 0 points : 100 balance
let unbond_pool = UnbondPool::<Runtime> { points: 0, balance: 100 };
assert_eq!(unbond_pool.balance_to_point(10), 10);
// 10 points : 3 balance ratio
let unbond_pool = UnbondPool::<Runtime> { points: 100, balance: 30 };
assert_eq!(unbond_pool.balance_to_point(10), 33);
// 2 points : 3 balance ratio
let unbond_pool = UnbondPool::<Runtime> { points: 200, balance: 300 };
assert_eq!(unbond_pool.balance_to_point(10), 6);
// 4 points : 9 balance ratio
let unbond_pool = UnbondPool::<Runtime> { points: 400, balance: 900 };
assert_eq!(unbond_pool.balance_to_point(90), 40);
})
}
#[test]
fn balance_to_unbond_works() {
// 1 balance : 1 points ratio
let unbond_pool = UnbondPool::<Runtime> { points: 100, balance: 100 };
assert_eq!(unbond_pool.point_to_balance(10), 10);
assert_eq!(unbond_pool.point_to_balance(0), 0);
// 1 balance : 2 points ratio
let unbond_pool = UnbondPool::<Runtime> { points: 100, balance: 50 };
assert_eq!(unbond_pool.point_to_balance(10), 5);
// 2 balance : 1 points ratio
let unbond_pool = UnbondPool::<Runtime> { points: 50, balance: 100 };
assert_eq!(unbond_pool.point_to_balance(10), 20);
// 100 balance : 0 points ratio
let unbond_pool = UnbondPool::<Runtime> { points: 0, balance: 100 };
assert_eq!(unbond_pool.point_to_balance(10), 0);
// 0 balance : 100 points ratio
let unbond_pool = UnbondPool::<Runtime> { points: 100, balance: 0 };
assert_eq!(unbond_pool.point_to_balance(10), 0);
// 10 balance : 3 points ratio
let unbond_pool = UnbondPool::<Runtime> { points: 30, balance: 100 };
assert_eq!(unbond_pool.point_to_balance(10), 33);
// 2 balance : 3 points ratio
let unbond_pool = UnbondPool::<Runtime> { points: 300, balance: 200 };
assert_eq!(unbond_pool.point_to_balance(10), 6);
// 4 balance : 9 points ratio
let unbond_pool = UnbondPool::<Runtime> { points: 900, balance: 400 };
assert_eq!(unbond_pool.point_to_balance(90), 40);
}
}
mod sub_pools {
use super::*;
#[test]
fn maybe_merge_pools_works() {
ExtBuilder::default().build_and_execute(|| {
assert_eq!(TotalUnbondingPools::<Runtime>::get(), 5);
assert_eq!(BondingDuration::get(), 3);
assert_eq!(PostUnbondingPoolsWindow::get(), 2);
// Given
let mut sub_pool_0 = SubPools::<Runtime> {
no_era: UnbondPool::<Runtime>::default(),
with_era: unbonding_pools_with_era! {
0 => UnbondPool::<Runtime> { points: 10, balance: 10 },
1 => UnbondPool::<Runtime> { points: 10, balance: 10 },
2 => UnbondPool::<Runtime> { points: 20, balance: 20 },
3 => UnbondPool::<Runtime> { points: 30, balance: 30 },
4 => UnbondPool::<Runtime> { points: 40, balance: 40 },
},
};
// When `current_era < TotalUnbondingPools`,
let sub_pool_1 = sub_pool_0.clone().maybe_merge_pools(0);
// Then it exits early without modifications
assert_eq!(sub_pool_1, sub_pool_0);
// When `current_era == TotalUnbondingPools`,
let sub_pool_1 = sub_pool_1.maybe_merge_pools(1);
// Then it exits early without modifications
assert_eq!(sub_pool_1, sub_pool_0);
// When `current_era - TotalUnbondingPools == 0`,
let mut sub_pool_1 = sub_pool_1.maybe_merge_pools(2);
// Then era 0 is merged into the `no_era` pool
sub_pool_0.no_era = sub_pool_0.with_era.remove(&0).unwrap();
assert_eq!(sub_pool_1, sub_pool_0);
// Given we have entries for era 1..=5
sub_pool_1
.with_era
.try_insert(5, UnbondPool::<Runtime> { points: 50, balance: 50 })
.unwrap();
sub_pool_0
.with_era
.try_insert(5, UnbondPool::<Runtime> { points: 50, balance: 50 })
.unwrap();
// When `current_era - TotalUnbondingPools == 1`
let sub_pool_2 = sub_pool_1.maybe_merge_pools(3);
let era_1_pool = sub_pool_0.with_era.remove(&1).unwrap();
// Then era 1 is merged into the `no_era` pool
sub_pool_0.no_era.points += era_1_pool.points;
sub_pool_0.no_era.balance += era_1_pool.balance;
assert_eq!(sub_pool_2, sub_pool_0);
// When `current_era - TotalUnbondingPools == 5`, so all pools with era <= 4 are removed
let sub_pool_3 = sub_pool_2.maybe_merge_pools(7);
// Then all eras <= 5 are merged into the `no_era` pool
for era in 2..=5 {
let to_merge = sub_pool_0.with_era.remove(&era).unwrap();
sub_pool_0.no_era.points += to_merge.points;
sub_pool_0.no_era.balance += to_merge.balance;
}
assert_eq!(sub_pool_3, sub_pool_0);
});
}
}
mod join {
use super::*;
#[test]
fn join_works() {
let bonded = |points, member_counter| BondedPool::<Runtime> {
id: 1,
inner: BondedPoolInner {
state: PoolState::Open,
points,
member_counter,
roles: DEFAULT_ROLES,
},
};
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 },
]
);
assert_eq!(
PoolMembers::<Runtime>::get(&11).unwrap(),
PoolMember::<Runtime> { pool_id: 1, points: 2, ..Default::default() }
);
assert_eq!(BondedPool::<Runtime>::get(1).unwrap(), bonded(12, 2));
// Given
// The bonded balance is slashed in half
StakingMock::set_bonded_balance(Pools::create_bonded_account(1), 6);
// And
Balances::make_free_balance_be(&12, ExistentialDeposit::get() + 12);
assert!(!PoolMembers::<Runtime>::contains_key(&12));
// When
assert_ok!(Pools::join(RuntimeOrigin::signed(12), 12, 1));
// Then
assert_eq!(
pool_events_since_last_call(),
vec![Event::Bonded { member: 12, pool_id: 1, bonded: 12, joined: true }]
);
assert_eq!(
PoolMembers::<Runtime>::get(&12).unwrap(),
PoolMember::<Runtime> { pool_id: 1, points: 24, ..Default::default() }
);
assert_eq!(BondedPool::<Runtime>::get(1).unwrap(), bonded(12 + 24, 3));
});
}
#[test]
fn join_errors_correctly() {
ExtBuilder::default().with_check(0).build_and_execute(|| {
// 10 is already part of the default pool created.
assert_eq!(PoolMembers::<Runtime>::get(&10).unwrap().pool_id, 1);
assert_noop!(
Pools::join(RuntimeOrigin::signed(10), 420, 123),
Error::<Runtime>::AccountBelongsToOtherPool
);
assert_noop!(
Pools::join(RuntimeOrigin::signed(11), 420, 123),
Error::<Runtime>::PoolNotFound
);
// Force the pools bonded balance to 0, simulating a 100% slash
StakingMock::set_bonded_balance(Pools::create_bonded_account(1), 0);
assert_noop!(
Pools::join(RuntimeOrigin::signed(11), 420, 1),
Error::<Runtime>::OverflowRisk
);
// Given a mocked bonded pool
BondedPool::<Runtime> {
id: 123,
inner: BondedPoolInner {
member_counter: 1,
state: PoolState::Open,
points: 100,
roles: DEFAULT_ROLES,
},
}
.put();
// and reward pool
RewardPools::<Runtime>::insert(123, RewardPool::<Runtime> { ..Default::default() });
// Force the points:balance ratio to `MaxPointsToBalance` (100/10)
let max_points_to_balance: u128 =
<<Runtime as Config>::MaxPointsToBalance as Get<u8>>::get().into();
StakingMock::set_bonded_balance(
Pools::create_bonded_account(123),
max_points_to_balance,
);
assert_noop!(
Pools::join(RuntimeOrigin::signed(11), 420, 123),
Error::<Runtime>::OverflowRisk
);
StakingMock::set_bonded_balance(
Pools::create_bonded_account(123),
Balance::MAX / max_points_to_balance,
);
// Balance needs to be gt Balance::MAX / `MaxPointsToBalance`
assert_noop!(
Pools::join(RuntimeOrigin::signed(11), 5, 123),
Error::<Runtime>::OverflowRisk
);
StakingMock::set_bonded_balance(Pools::create_bonded_account(1), max_points_to_balance);
// Cannot join a pool that isn't open
unsafe_set_state(123, PoolState::Blocked);
assert_noop!(
Pools::join(RuntimeOrigin::signed(11), max_points_to_balance, 123),
Error::<Runtime>::NotOpen
);
unsafe_set_state(123, PoolState::Destroying);
assert_noop!(
Pools::join(RuntimeOrigin::signed(11), max_points_to_balance, 123),
Error::<Runtime>::NotOpen
);
// Given
MinJoinBond::<Runtime>::put(100);
// Then
assert_noop!(
Pools::join(RuntimeOrigin::signed(11), 99, 123),
Error::<Runtime>::MinimumBondNotMet
);
});
}
#[test]
#[cfg_attr(debug_assertions, should_panic(expected = "Defensive failure has been triggered!"))]
#[cfg_attr(not(debug_assertions), should_panic)]
fn join_panics_when_reward_pool_not_found() {
ExtBuilder::default().build_and_execute(|| {
StakingMock::set_bonded_balance(Pools::create_bonded_account(123), 100);
BondedPool::<Runtime> {
id: 123,
inner: BondedPoolInner {
state: PoolState::Open,
points: 100,
member_counter: 1,
roles: DEFAULT_ROLES,
},
}
.put();
let _ = Pools::join(RuntimeOrigin::signed(11), 420, 123);
});
}
#[test]
fn join_max_member_limits_are_respected() {
ExtBuilder::default().build_and_execute(|| {
// Given
assert_eq!(MaxPoolMembersPerPool::<Runtime>::get(), Some(3));
for i in 1..3 {
let account = i + 100;
Balances::make_free_balance_be(&account, 100 + Balances::minimum_balance());
assert_ok!(Pools::join(RuntimeOrigin::signed(account), 100, 1));
}
Balances::make_free_balance_be(&103, 100 + Balances::minimum_balance());
// 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: 101, pool_id: 1, bonded: 100, joined: true },
Event::Bonded { member: 102, pool_id: 1, bonded: 100, joined: true }
]
);
assert_noop!(
Pools::join(RuntimeOrigin::signed(103), 100, 1),
Error::<Runtime>::MaxPoolMembers
);
// Given
assert_eq!(PoolMembers::<Runtime>::count(), 3);
assert_eq!(MaxPoolMembers::<Runtime>::get(), Some(4));
Balances::make_free_balance_be(&104, 100 + Balances::minimum_balance());
assert_ok!(Pools::create(RuntimeOrigin::signed(104), 100, 104, 104, 104));
let pool_account = BondedPools::<Runtime>::iter()
.find(|(_, bonded_pool)| bonded_pool.roles.depositor == 104)
.map(|(pool_account, _)| pool_account)
.unwrap();
// Then
assert_eq!(
pool_events_since_last_call(),
vec![
Event::Created { depositor: 104, pool_id: 2 },
Event::Bonded { member: 104, pool_id: 2, bonded: 100, joined: true }
]
);
assert_noop!(
Pools::join(RuntimeOrigin::signed(103), 100, pool_account),
Error::<Runtime>::MaxPoolMembers
);
});
}
}
mod claim_payout {
use super::*;
fn del(points: Balance, last_recorded_reward_counter: u128) -> PoolMember<Runtime> {
PoolMember {
pool_id: 1,
points,
last_recorded_reward_counter: last_recorded_reward_counter.into(),
unbonding_eras: Default::default(),
}
}
fn del_float(points: Balance, last_recorded_reward_counter: f64) -> PoolMember<Runtime> {
PoolMember {
pool_id: 1,
points,
last_recorded_reward_counter: RewardCounter::from_float(last_recorded_reward_counter),
unbonding_eras: Default::default(),
}
}
fn rew(
last_recorded_reward_counter: u128,
last_recorded_total_payouts: Balance,
total_rewards_claimed: Balance,
) -> RewardPool<Runtime> {
RewardPool {
last_recorded_reward_counter: last_recorded_reward_counter.into(),
last_recorded_total_payouts,
total_rewards_claimed,
}
}
#[test]
fn claim_payout_works() {
ExtBuilder::default()
.add_members(vec![(40, 40), (50, 50)])
.build_and_execute(|| {
// Given each member currently has a free balance of
Balances::make_free_balance_be(&10, 0);
Balances::make_free_balance_be(&40, 0);
Balances::make_free_balance_be(&50, 0);
let ed = Balances::minimum_balance();
// and the reward pool has earned 100 in rewards
assert_eq!(Balances::free_balance(default_reward_account()), ed);
assert_ok!(Balances::mutate_account(&default_reward_account(), |a| a.free += 100));
let _ = pool_events_since_last_call();
// When
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(10)));
// Then
assert_eq!(
pool_events_since_last_call(),
vec![Event::PaidOut { member: 10, pool_id: 1, payout: 10 },]
);
// last recorded reward counter at the time of this member's payout is 1
assert_eq!(PoolMembers::<Runtime>::get(10).unwrap(), del(10, 1));
// pool's 'last_recorded_reward_counter' and 'last_recorded_total_payouts' don't
// really change unless if someone bonds/unbonds.
assert_eq!(RewardPools::<Runtime>::get(&1).unwrap(), rew(0, 0, 10));
assert_eq!(Balances::free_balance(&10), 10);
assert_eq!(Balances::free_balance(&default_reward_account()), ed + 90);
// When
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(40)));
// Then
assert_eq!(
pool_events_since_last_call(),
vec![Event::PaidOut { member: 40, pool_id: 1, payout: 40 }]
);
assert_eq!(PoolMembers::<Runtime>::get(40).unwrap(), del(40, 1));
assert_eq!(RewardPools::<Runtime>::get(&1).unwrap(), rew(0, 0, 50));
assert_eq!(Balances::free_balance(&40), 40);
assert_eq!(Balances::free_balance(&default_reward_account()), ed + 50);
// When
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(50)));
// Then
assert_eq!(
pool_events_since_last_call(),
vec![Event::PaidOut { member: 50, pool_id: 1, payout: 50 }]
);
assert_eq!(PoolMembers::<Runtime>::get(50).unwrap(), del(50, 1));
assert_eq!(RewardPools::<Runtime>::get(&1).unwrap(), rew(0, 0, 100));
assert_eq!(Balances::free_balance(&50), 50);
assert_eq!(Balances::free_balance(&default_reward_account()), ed + 0);
// Given the reward pool has some new rewards
assert_ok!(Balances::mutate_account(&default_reward_account(), |a| a.free += 50));
// When
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(10)));
// Then
assert_eq!(
pool_events_since_last_call(),
vec![Event::PaidOut { member: 10, pool_id: 1, payout: 5 }]
);
assert_eq!(PoolMembers::<Runtime>::get(10).unwrap(), del_float(10, 1.5));
assert_eq!(RewardPools::<Runtime>::get(&1).unwrap(), rew(0, 0, 105));
assert_eq!(Balances::free_balance(&10), 10 + 5);
assert_eq!(Balances::free_balance(&default_reward_account()), ed + 45);
// When
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(40)));
// Then
assert_eq!(
pool_events_since_last_call(),
vec![Event::PaidOut { member: 40, pool_id: 1, payout: 20 }]
);
assert_eq!(PoolMembers::<Runtime>::get(40).unwrap(), del_float(40, 1.5));
assert_eq!(RewardPools::<Runtime>::get(&1).unwrap(), rew(0, 0, 125));
assert_eq!(Balances::free_balance(&40), 40 + 20);
assert_eq!(Balances::free_balance(&default_reward_account()), ed + 25);
// Given del 50 hasn't claimed and the reward pools has just earned 50
assert_ok!(Balances::mutate_account(&default_reward_account(), |a| a.free += 50));
assert_eq!(Balances::free_balance(&default_reward_account()), ed + 75);
// When
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(50)));
// Then
assert_eq!(
pool_events_since_last_call(),
vec![Event::PaidOut { member: 50, pool_id: 1, payout: 50 }]
);
assert_eq!(PoolMembers::<Runtime>::get(50).unwrap(), del_float(50, 2.0));
assert_eq!(RewardPools::<Runtime>::get(&1).unwrap(), rew(0, 0, 175));
assert_eq!(Balances::free_balance(&50), 50 + 50);
assert_eq!(Balances::free_balance(&default_reward_account()), ed + 25);
// When
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(10)));
// Then
assert_eq!(
pool_events_since_last_call(),
vec![Event::PaidOut { member: 10, pool_id: 1, payout: 5 }]
);
assert_eq!(PoolMembers::<Runtime>::get(10).unwrap(), del(10, 2));
assert_eq!(RewardPools::<Runtime>::get(&1).unwrap(), rew(0, 0, 180));
assert_eq!(Balances::free_balance(&10), 15 + 5);
assert_eq!(Balances::free_balance(&default_reward_account()), ed + 20);
// Given del 40 hasn't claimed and the reward pool has just earned 400
assert_ok!(Balances::mutate_account(&default_reward_account(), |a| a.free += 400));
assert_eq!(Balances::free_balance(&default_reward_account()), ed + 420);
// When
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(10)));
// Then
assert_eq!(
pool_events_since_last_call(),
vec![Event::PaidOut { member: 10, pool_id: 1, payout: 40 }]
);
// We expect a payout of 40
assert_eq!(PoolMembers::<Runtime>::get(10).unwrap(), del(10, 6));
assert_eq!(RewardPools::<Runtime>::get(&1).unwrap(), rew(0, 0, 220));
assert_eq!(Balances::free_balance(&10), 20 + 40);
assert_eq!(Balances::free_balance(&default_reward_account()), ed + 380);
// Given del 40 + del 50 haven't claimed and the reward pool has earned 20
assert_ok!(Balances::mutate_account(&default_reward_account(), |a| a.free += 20));
assert_eq!(Balances::free_balance(&default_reward_account()), ed + 400);
// When
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(10)));
// Then
assert_eq!(
pool_events_since_last_call(),
vec![Event::PaidOut { member: 10, pool_id: 1, payout: 2 }]
);
assert_eq!(PoolMembers::<Runtime>::get(10).unwrap(), del_float(10, 6.2));
assert_eq!(RewardPools::<Runtime>::get(&1).unwrap(), rew(0, 0, 222));
assert_eq!(Balances::free_balance(&10), 60 + 2);
assert_eq!(Balances::free_balance(&default_reward_account()), ed + 398);
// When
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(40)));
// Then
assert_eq!(
pool_events_since_last_call(),
vec![Event::PaidOut { member: 40, pool_id: 1, payout: 188 }]
);
assert_eq!(PoolMembers::<Runtime>::get(40).unwrap(), del_float(40, 6.2));
assert_eq!(RewardPools::<Runtime>::get(&1).unwrap(), rew(0, 0, 410));
assert_eq!(Balances::free_balance(&40), 60 + 188);
assert_eq!(Balances::free_balance(&default_reward_account()), ed + 210);
// When
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(50)));
// Then
assert_eq!(
pool_events_since_last_call(),
vec![Event::PaidOut { member: 50, pool_id: 1, payout: 210 }]
);
assert_eq!(PoolMembers::<Runtime>::get(50).unwrap(), del_float(50, 6.2));
assert_eq!(RewardPools::<Runtime>::get(&1).unwrap(), rew(0, 0, 620));
assert_eq!(Balances::free_balance(&50), 100 + 210);
assert_eq!(Balances::free_balance(&default_reward_account()), ed + 0);
});
}
#[test]
fn reward_payout_errors_if_a_member_is_fully_unbonding() {
ExtBuilder::default().add_members(vec![(11, 11)]).build_and_execute(|| {
// fully unbond the member.
assert_ok!(fully_unbond_permissioned(11));
assert_noop!(
Pools::claim_payout(RuntimeOrigin::signed(11)),
Error::<Runtime>::FullyUnbonding
);
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: 11, joined: true },
Event::Unbonded { member: 11, pool_id: 1, points: 11, balance: 11, era: 3 }
]
);
});
}
#[test]
fn do_reward_payout_works_with_a_pool_of_1() {
let del = |last_recorded_reward_counter| del_float(10, last_recorded_reward_counter);
ExtBuilder::default().build_and_execute(|| {
let (mut member, mut bonded_pool, mut reward_pool) =
Pools::get_member_with_pools(&10).unwrap();
let ed = Balances::minimum_balance();
let payout =
Pools::do_reward_payout(&10, &mut member, &mut bonded_pool, &mut reward_pool)
.unwrap();
// Then
assert_eq!(payout, 0);
assert_eq!(member, del(0.0));
assert_eq!(reward_pool, rew(0, 0, 0));
// Given the pool has earned some rewards for the first time
assert_ok!(Balances::mutate_account(&default_reward_account(), |a| a.free += 5));
// When
let payout =
Pools::do_reward_payout(&10, &mut member, &mut bonded_pool, &mut reward_pool)
.unwrap();
// 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::PaidOut { member: 10, pool_id: 1, payout: 5 }
]
);
assert_eq!(payout, 5);
assert_eq!(reward_pool, rew(0, 0, 5));
assert_eq!(member, del(0.5));
// Given the pool has earned rewards again
assert_ok!(Balances::mutate_account(&default_reward_account(), |a| a.free += 10));
// When
let payout =
Pools::do_reward_payout(&10, &mut member, &mut bonded_pool, &mut reward_pool)
.unwrap();
// Then
assert_eq!(
pool_events_since_last_call(),
vec![Event::PaidOut { member: 10, pool_id: 1, payout: 10 }]
);
assert_eq!(payout, 10);
assert_eq!(reward_pool, rew(0, 0, 15));
assert_eq!(member, del(1.5));
// Given the pool has earned no new rewards
Balances::make_free_balance_be(&default_reward_account(), ed + 0);
// When
let payout =
Pools::do_reward_payout(&10, &mut member, &mut bonded_pool, &mut reward_pool)
.unwrap();
// Then
assert_eq!(pool_events_since_last_call(), vec![]);
assert_eq!(payout, 0);
assert_eq!(reward_pool, rew(0, 0, 15));
assert_eq!(member, del(1.5));
});
}
#[test]
fn do_reward_payout_works_with_a_pool_of_3() {
ExtBuilder::default()
.add_members(vec![(40, 40), (50, 50)])
.build_and_execute(|| {
let mut bonded_pool = BondedPool::<Runtime>::get(1).unwrap();
let mut reward_pool = RewardPools::<Runtime>::get(1).unwrap();
let mut del_10 = PoolMembers::<Runtime>::get(10).unwrap();
let mut del_40 = PoolMembers::<Runtime>::get(40).unwrap();
let mut del_50 = PoolMembers::<Runtime>::get(50).unwrap();
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: 40, pool_id: 1, bonded: 40, joined: true },
Event::Bonded { member: 50, pool_id: 1, bonded: 50, joined: true }
]
);
// Given we have a total of 100 points split among the members
assert_eq!(del_50.points + del_40.points + del_10.points, 100);
assert_eq!(bonded_pool.points, 100);
// and the reward pool has earned 100 in rewards
assert_ok!(Balances::mutate_account(&default_reward_account(), |a| a.free += 100));
// When
let payout =
Pools::do_reward_payout(&10, &mut del_10, &mut bonded_pool, &mut reward_pool)
.unwrap();
// Then
assert_eq!(
pool_events_since_last_call(),
vec![Event::PaidOut { member: 10, pool_id: 1, payout: 10 }]
);
assert_eq!(payout, 10);
assert_eq!(del_10, del(10, 1));
assert_eq!(reward_pool, rew(0, 0, 10));
// When
let payout =
Pools::do_reward_payout(&40, &mut del_40, &mut bonded_pool, &mut reward_pool)
.unwrap();
// Then
assert_eq!(
pool_events_since_last_call(),
vec![Event::PaidOut { member: 40, pool_id: 1, payout: 40 }]
);
assert_eq!(payout, 40);
assert_eq!(del_40, del(40, 1));
assert_eq!(reward_pool, rew(0, 0, 50));
// When
let payout =
Pools::do_reward_payout(&50, &mut del_50, &mut bonded_pool, &mut reward_pool)
.unwrap();
// Then
assert_eq!(
pool_events_since_last_call(),
vec![Event::PaidOut { member: 50, pool_id: 1, payout: 50 }]
);
assert_eq!(payout, 50);
assert_eq!(del_50, del(50, 1));
assert_eq!(reward_pool, rew(0, 0, 100));
// Given the reward pool has some new rewards
assert_ok!(Balances::mutate_account(&default_reward_account(), |a| a.free += 50));
// When
let payout =
Pools::do_reward_payout(&10, &mut del_10, &mut bonded_pool, &mut reward_pool)
.unwrap();
// Then
assert_eq!(
pool_events_since_last_call(),
vec![Event::PaidOut { member: 10, pool_id: 1, payout: 5 }]
);
assert_eq!(payout, 5);
assert_eq!(del_10, del_float(10, 1.5));
assert_eq!(reward_pool, rew(0, 0, 105));
// When
let payout =
Pools::do_reward_payout(&40, &mut del_40, &mut bonded_pool, &mut reward_pool)
.unwrap();
// Then
assert_eq!(
pool_events_since_last_call(),
vec![Event::PaidOut { member: 40, pool_id: 1, payout: 20 }]
);
assert_eq!(payout, 20);
assert_eq!(del_40, del_float(40, 1.5));
assert_eq!(reward_pool, rew(0, 0, 125));
// Given del_50 hasn't claimed and the reward pools has just earned 50
assert_ok!(Balances::mutate_account(&default_reward_account(), |a| a.free += 50));
// When
let payout =
Pools::do_reward_payout(&50, &mut del_50, &mut bonded_pool, &mut reward_pool)
.unwrap();
// Then
assert_eq!(
pool_events_since_last_call(),
vec![Event::PaidOut { member: 50, pool_id: 1, payout: 50 }]
);
assert_eq!(payout, 50);
assert_eq!(del_50, del_float(50, 2.0));
assert_eq!(reward_pool, rew(0, 0, 175));
// When
let payout =
Pools::do_reward_payout(&10, &mut del_10, &mut bonded_pool, &mut reward_pool)
.unwrap();
// Then
assert_eq!(
pool_events_since_last_call(),
vec![Event::PaidOut { member: 10, pool_id: 1, payout: 5 }]
);
assert_eq!(payout, 5);
assert_eq!(del_10, del_float(10, 2.0));
assert_eq!(reward_pool, rew(0, 0, 180));
// Given del_40 hasn't claimed and the reward pool has just earned 400
assert_ok!(Balances::mutate_account(&default_reward_account(), |a| a.free += 400));
// When
let payout =
Pools::do_reward_payout(&10, &mut del_10, &mut bonded_pool, &mut reward_pool)
.unwrap();
// Then
assert_eq!(
pool_events_since_last_call(),
vec![Event::PaidOut { member: 10, pool_id: 1, payout: 40 }]
);
assert_eq!(payout, 40);
assert_eq!(del_10, del_float(10, 6.0));
assert_eq!(reward_pool, rew(0, 0, 220));
// Given del_40 + del_50 haven't claimed and the reward pool has earned 20
assert_ok!(Balances::mutate_account(&default_reward_account(), |a| a.free += 20));
// When
let payout =
Pools::do_reward_payout(&10, &mut del_10, &mut bonded_pool, &mut reward_pool)
.unwrap();
// Then
assert_eq!(payout, 2);
assert_eq!(del_10, del_float(10, 6.2));
assert_eq!(reward_pool, rew(0, 0, 222));
// When
let payout =
Pools::do_reward_payout(&40, &mut del_40, &mut bonded_pool, &mut reward_pool)
.unwrap();
// Then
assert_eq!(payout, 188); // 20 (from the 50) + 160 (from the 400) + 8 (from the 20)
assert_eq!(del_40, del_float(40, 6.2));
assert_eq!(reward_pool, rew(0, 0, 410));
// When
let payout =
Pools::do_reward_payout(&50, &mut del_50, &mut bonded_pool, &mut reward_pool)
.unwrap();
// Then
assert_eq!(payout, 210); // 200 (from the 400) + 10 (from the 20)
assert_eq!(del_50, del_float(50, 6.2));
assert_eq!(reward_pool, rew(0, 0, 620));
});
}
#[test]
fn rewards_distribution_is_fair_basic() {
ExtBuilder::default().build_and_execute(|| {
// reward pool by 10.
Balances::mutate_account(&default_reward_account(), |f| f.free += 10).unwrap();
// 20 joins afterwards.
Balances::make_free_balance_be(&20, Balances::minimum_balance() + 10);
assert_ok!(Pools::join(RuntimeOrigin::signed(20), 10, 1));
// reward by another 20
Balances::mutate_account(&default_reward_account(), |f| f.free += 20).unwrap();
// 10 should claim 10 + 10, 20 should claim 20 / 2.
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(10)));
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(20)));
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: 20, pool_id: 1, bonded: 10, joined: true },
Event::PaidOut { member: 10, pool_id: 1, payout: 20 },
Event::PaidOut { member: 20, pool_id: 1, payout: 10 },
]
);
// any upcoming rewards are shared equally.
Balances::mutate_account(&default_reward_account(), |f| f.free += 20).unwrap();
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(10)));
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(20)));
assert_eq!(
pool_events_since_last_call(),
vec![
Event::PaidOut { member: 10, pool_id: 1, payout: 10 },
Event::PaidOut { member: 20, pool_id: 1, payout: 10 },
]
);
});
}
#[test]
fn rewards_distribution_is_fair_basic_with_fractions() {
// basically checks the case where the amount of rewards is less than the pool shares. for
// this, we have to rely on fixed point arithmetic.
ExtBuilder::default().build_and_execute(|| {
Balances::mutate_account(&default_reward_account(), |f| f.free += 3).unwrap();
Balances::make_free_balance_be(&20, Balances::minimum_balance() + 10);
assert_ok!(Pools::join(RuntimeOrigin::signed(20), 10, 1));
Balances::mutate_account(&default_reward_account(), |f| f.free += 6).unwrap();
// 10 should claim 3, 20 should claim 3 + 3.
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(10)));
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(20)));
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: 20, pool_id: 1, bonded: 10, joined: true },
Event::PaidOut { member: 10, pool_id: 1, payout: 3 + 3 },
Event::PaidOut { member: 20, pool_id: 1, payout: 3 },
]
);
// any upcoming rewards are shared equally.
Balances::mutate_account(&default_reward_account(), |f| f.free += 8).unwrap();
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(10)));
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(20)));
assert_eq!(
pool_events_since_last_call(),
vec![
Event::PaidOut { member: 10, pool_id: 1, payout: 4 },
Event::PaidOut { member: 20, pool_id: 1, payout: 4 },
]
);
// uneven upcoming rewards are shared equally, rounded down.
Balances::mutate_account(&default_reward_account(), |f| f.free += 7).unwrap();
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(10)));
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(20)));
assert_eq!(
pool_events_since_last_call(),
vec![
Event::PaidOut { member: 10, pool_id: 1, payout: 3 },
Event::PaidOut { member: 20, pool_id: 1, payout: 3 },
]
);
});
}
#[test]
fn rewards_distribution_is_fair_3() {
ExtBuilder::default().build_and_execute(|| {
let ed = Balances::minimum_balance();
Balances::mutate_account(&default_reward_account(), |f| f.free += 30).unwrap();
Balances::make_free_balance_be(&20, ed + 10);
assert_ok!(Pools::join(RuntimeOrigin::signed(20), 10, 1));
Balances::mutate_account(&default_reward_account(), |f| f.free += 100).unwrap();
Balances::make_free_balance_be(&30, ed + 10);
assert_ok!(Pools::join(RuntimeOrigin::signed(30), 10, 1));
Balances::mutate_account(&default_reward_account(), |f| f.free += 60).unwrap();
// 10 should claim 10, 20 should claim nothing.
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(10)));
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(20)));
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(30)));
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: 20, pool_id: 1, bonded: 10, joined: true },
Event::Bonded { member: 30, pool_id: 1, bonded: 10, joined: true },
Event::PaidOut { member: 10, pool_id: 1, payout: 30 + 100 / 2 + 60 / 3 },
Event::PaidOut { member: 20, pool_id: 1, payout: 100 / 2 + 60 / 3 },
Event::PaidOut { member: 30, pool_id: 1, payout: 60 / 3 },
]
);
// any upcoming rewards are shared equally.
Balances::mutate_account(&default_reward_account(), |f| f.free += 30).unwrap();
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(10)));
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(20)));
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(30)));
assert_eq!(
pool_events_since_last_call(),
vec![
Event::PaidOut { member: 10, pool_id: 1, payout: 10 },
Event::PaidOut { member: 20, pool_id: 1, payout: 10 },
Event::PaidOut { member: 30, pool_id: 1, payout: 10 },
]
);
});
}
#[test]
fn pending_rewards_per_member_works() {
ExtBuilder::default().build_and_execute(|| {
let ed = Balances::minimum_balance();
assert_eq!(Pools::pending_rewards(10), Some(0));
Balances::mutate_account(&default_reward_account(), |f| f.free += 30).unwrap();
assert_eq!(Pools::pending_rewards(10), Some(30));
assert_eq!(Pools::pending_rewards(20), None);
Balances::make_free_balance_be(&20, ed + 10);
assert_ok!(Pools::join(RuntimeOrigin::signed(20), 10, 1));
assert_eq!(Pools::pending_rewards(10), Some(30));
assert_eq!(Pools::pending_rewards(20), Some(0));
Balances::mutate_account(&default_reward_account(), |f| f.free += 100).unwrap();
assert_eq!(Pools::pending_rewards(10), Some(30 + 50));
assert_eq!(Pools::pending_rewards(20), Some(50));
assert_eq!(Pools::pending_rewards(30), None);
Balances::make_free_balance_be(&30, ed + 10);
assert_ok!(Pools::join(RuntimeOrigin::signed(30), 10, 1));
assert_eq!(Pools::pending_rewards(10), Some(30 + 50));
assert_eq!(Pools::pending_rewards(20), Some(50));
assert_eq!(Pools::pending_rewards(30), Some(0));
Balances::mutate_account(&default_reward_account(), |f| f.free += 60).unwrap();
assert_eq!(Pools::pending_rewards(10), Some(30 + 50 + 20));
assert_eq!(Pools::pending_rewards(20), Some(50 + 20));
assert_eq!(Pools::pending_rewards(30), Some(20));
// 10 should claim 10, 20 should claim nothing.
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(10)));
assert_eq!(Pools::pending_rewards(10), Some(0));
assert_eq!(Pools::pending_rewards(20), Some(50 + 20));
assert_eq!(Pools::pending_rewards(30), Some(20));
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(20)));
assert_eq!(Pools::pending_rewards(10), Some(0));
assert_eq!(Pools::pending_rewards(20), Some(0));
assert_eq!(Pools::pending_rewards(30), Some(20));
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(30)));
assert_eq!(Pools::pending_rewards(10), Some(0));
assert_eq!(Pools::pending_rewards(20), Some(0));
assert_eq!(Pools::pending_rewards(30), Some(0));
});
}
#[test]
fn rewards_distribution_is_fair_bond_extra() {
ExtBuilder::default().build_and_execute(|| {
let ed = Balances::minimum_balance();
Balances::make_free_balance_be(&20, ed + 20);
assert_ok!(Pools::join(RuntimeOrigin::signed(20), 20, 1));
Balances::make_free_balance_be(&30, ed + 20);
assert_ok!(Pools::join(RuntimeOrigin::signed(30), 10, 1));
Balances::mutate_account(&default_reward_account(), |f| f.free += 40).unwrap();
// everyone claims.
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(10)));
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(20)));
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(30)));
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: 20, pool_id: 1, bonded: 20, joined: true },
Event::Bonded { member: 30, pool_id: 1, bonded: 10, joined: true },
Event::PaidOut { member: 10, pool_id: 1, payout: 10 },
Event::PaidOut { member: 20, pool_id: 1, payout: 20 },
Event::PaidOut { member: 30, pool_id: 1, payout: 10 }
]
);
// 30 now bumps itself to be like 20.
assert_ok!(Pools::bond_extra(RuntimeOrigin::signed(30), BondExtra::FreeBalance(10)));
// more rewards come in.
Balances::mutate_account(&default_reward_account(), |f| f.free += 100).unwrap();
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(10)));
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(20)));
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(30)));
assert_eq!(
pool_events_since_last_call(),
vec![
Event::Bonded { member: 30, pool_id: 1, bonded: 10, joined: false },
Event::PaidOut { member: 10, pool_id: 1, payout: 20 },
Event::PaidOut { member: 20, pool_id: 1, payout: 40 },
Event::PaidOut { member: 30, pool_id: 1, payout: 40 }
]
);
});
}
#[test]
fn rewards_distribution_is_fair_unbond() {
ExtBuilder::default().build_and_execute(|| {
let ed = Balances::minimum_balance();
Balances::make_free_balance_be(&20, ed + 20);
assert_ok!(Pools::join(RuntimeOrigin::signed(20), 20, 1));
Balances::mutate_account(&default_reward_account(), |f| f.free += 30).unwrap();
// everyone claims.
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(10)));
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(20)));
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: 20, pool_id: 1, bonded: 20, joined: true },
Event::PaidOut { member: 10, pool_id: 1, payout: 10 },
Event::PaidOut { member: 20, pool_id: 1, payout: 20 }
]
);
// 20 unbonds to be equal to 10 (10 points each).
assert_ok!(Pools::unbond(RuntimeOrigin::signed(20), 20, 10));
// more rewards come in.
Balances::mutate_account(&default_reward_account(), |f| f.free += 100).unwrap();
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(10)));
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(20)));
assert_eq!(
pool_events_since_last_call(),
vec![
Event::Unbonded { member: 20, pool_id: 1, balance: 10, points: 10, era: 3 },
Event::PaidOut { member: 10, pool_id: 1, payout: 50 },
Event::PaidOut { member: 20, pool_id: 1, payout: 50 },
]
);
});
}
#[test]
fn unclaimed_reward_is_safe() {
ExtBuilder::default().build_and_execute(|| {
let ed = Balances::minimum_balance();
Balances::make_free_balance_be(&20, ed + 20);
assert_ok!(Pools::join(RuntimeOrigin::signed(20), 20, 1));
Balances::make_free_balance_be(&30, ed + 20);
assert_ok!(Pools::join(RuntimeOrigin::signed(30), 10, 1));
// 10 gets 10, 20 gets 20, 30 gets 10
Balances::mutate_account(&default_reward_account(), |f| f.free += 40).unwrap();
// some claim.
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(10)));
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(20)));
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: 20, pool_id: 1, bonded: 20, joined: true },
Event::Bonded { member: 30, pool_id: 1, bonded: 10, joined: true },
Event::PaidOut { member: 10, pool_id: 1, payout: 10 },
Event::PaidOut { member: 20, pool_id: 1, payout: 20 }
]
);
// 10 gets 20, 20 gets 40, 30 gets 20
Balances::mutate_account(&default_reward_account(), |f| f.free += 80).unwrap();
// some claim.
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(10)));
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(20)));
assert_eq!(
pool_events_since_last_call(),
vec![
Event::PaidOut { member: 10, pool_id: 1, payout: 20 },
Event::PaidOut { member: 20, pool_id: 1, payout: 40 }
]
);
// 10 gets 20, 20 gets 40, 30 gets 20
Balances::mutate_account(&default_reward_account(), |f| f.free += 80).unwrap();
// some claim.
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(10)));
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(20)));
assert_eq!(
pool_events_since_last_call(),
vec![
Event::PaidOut { member: 10, pool_id: 1, payout: 20 },
Event::PaidOut { member: 20, pool_id: 1, payout: 40 }
]
);
// now 30 claims all at once
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(30)));
assert_eq!(
pool_events_since_last_call(),
vec![Event::PaidOut { member: 30, pool_id: 1, payout: 10 + 20 + 20 }]
);
});
}
#[test]
fn bond_extra_and_delayed_claim() {
ExtBuilder::default().build_and_execute(|| {
let ed = Balances::minimum_balance();
Balances::make_free_balance_be(&20, ed + 200);
assert_ok!(Pools::join(RuntimeOrigin::signed(20), 20, 1));
// 10 gets 10, 20 gets 20, 30 gets 10
Balances::mutate_account(&default_reward_account(), |f| f.free += 30).unwrap();
// some claim.
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(10)));
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: 20, pool_id: 1, bonded: 20, joined: true },
Event::PaidOut { member: 10, pool_id: 1, payout: 10 }
]
);
// 20 has not claimed yet, more reward comes
Balances::mutate_account(&default_reward_account(), |f| f.free += 60).unwrap();
// and 20 bonds more -- they should not have more share of this reward.
assert_ok!(Pools::bond_extra(RuntimeOrigin::signed(20), BondExtra::FreeBalance(10)));
// everyone claim.
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(10)));
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(20)));
assert_eq!(
pool_events_since_last_call(),
vec![
// 20 + 40, which means the extra amount they bonded did not impact us.
Event::PaidOut { member: 20, pool_id: 1, payout: 60 },
Event::Bonded { member: 20, pool_id: 1, bonded: 10, joined: false },
Event::PaidOut { member: 10, pool_id: 1, payout: 20 }
]
);
// but in the next round of rewards, the extra10 they bonded has an impact.
Balances::mutate_account(&default_reward_account(), |f| f.free += 60).unwrap();
// everyone claim.
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(10)));
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(20)));
assert_eq!(
pool_events_since_last_call(),
vec![
Event::PaidOut { member: 10, pool_id: 1, payout: 15 },
Event::PaidOut { member: 20, pool_id: 1, payout: 45 }
]
);
});
}
#[test]
fn create_sets_recorded_data() {
ExtBuilder::default().build_and_execute(|| {
MaxPools::<Runtime>::set(None);
// pool 10 has already been created.
let (member_10, _, reward_pool_10) = Pools::get_member_with_pools(&10).unwrap();
assert_eq!(reward_pool_10.last_recorded_total_payouts, 0);
assert_eq!(reward_pool_10.total_rewards_claimed, 0);
assert_eq!(reward_pool_10.last_recorded_reward_counter, 0.into());
assert_eq!(member_10.last_recorded_reward_counter, 0.into());
// transfer some reward to pool 1.
Balances::mutate_account(&default_reward_account(), |f| f.free += 60).unwrap();
// create pool 2
Balances::make_free_balance_be(&20, 100);
assert_ok!(Pools::create(RuntimeOrigin::signed(20), 10, 20, 20, 20));
// has no impact -- initial
let (member_20, _, reward_pool_20) = Pools::get_member_with_pools(&20).unwrap();
assert_eq!(reward_pool_20.last_recorded_total_payouts, 0);
assert_eq!(reward_pool_20.total_rewards_claimed, 0);
assert_eq!(reward_pool_20.last_recorded_reward_counter, 0.into());
assert_eq!(member_20.last_recorded_reward_counter, 0.into());
// pre-fund the reward account of pool id 3 with some funds.
Balances::make_free_balance_be(&Pools::create_reward_account(3), 10);
// create pool 3
Balances::make_free_balance_be(&30, 100);
assert_ok!(Pools::create(RuntimeOrigin::signed(30), 10, 30, 30, 30));
// reward counter is still the same.
let (member_30, _, reward_pool_30) = Pools::get_member_with_pools(&30).unwrap();
assert_eq!(
Balances::free_balance(&Pools::create_reward_account(3)),
10 + Balances::minimum_balance()
);
assert_eq!(reward_pool_30.last_recorded_total_payouts, 0);
assert_eq!(reward_pool_30.total_rewards_claimed, 0);
assert_eq!(reward_pool_30.last_recorded_reward_counter, 0.into());
assert_eq!(member_30.last_recorded_reward_counter, 0.into());
// and 30 can claim the reward now.
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(30)));
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::Created { depositor: 20, pool_id: 2 },
Event::Bonded { member: 20, pool_id: 2, bonded: 10, joined: true },
Event::Created { depositor: 30, pool_id: 3 },
Event::Bonded { member: 30, pool_id: 3, bonded: 10, joined: true },
Event::PaidOut { member: 30, pool_id: 3, payout: 10 }
]
);
})
}
#[test]
fn join_updates_recorded_data() {
ExtBuilder::default().build_and_execute(|| {
MaxPoolMembers::<Runtime>::set(None);
MaxPoolMembersPerPool::<Runtime>::set(None);
let join = |x, y| {
Balances::make_free_balance_be(&x, y + Balances::minimum_balance());
assert_ok!(Pools::join(RuntimeOrigin::signed(x), y, 1));
};
{
let (member_10, _, reward_pool_10) = Pools::get_member_with_pools(&10).unwrap();
assert_eq!(reward_pool_10.last_recorded_total_payouts, 0);
assert_eq!(reward_pool_10.total_rewards_claimed, 0);
assert_eq!(reward_pool_10.last_recorded_reward_counter, 0.into());
assert_eq!(member_10.last_recorded_reward_counter, 0.into());
}
// someone joins without any rewards being issued.
{
join(20, 10);
let (member, _, reward_pool) = Pools::get_member_with_pools(&20).unwrap();
// reward counter is 0 both before..
assert_eq!(member.last_recorded_reward_counter, 0.into());
assert_eq!(reward_pool.last_recorded_total_payouts, 0);
assert_eq!(reward_pool.last_recorded_reward_counter, 0.into());
}
// transfer some reward to pool 1.
Balances::mutate_account(&default_reward_account(), |f| f.free += 60).unwrap();
{
join(30, 10);
let (member, _, reward_pool) = Pools::get_member_with_pools(&30).unwrap();
assert_eq!(reward_pool.last_recorded_total_payouts, 60);
// explanation: we have a total of 20 points so far (excluding the 10 that just got
// bonded), and 60 unclaimed rewards. each share is then roughly worth of 3 units of
// rewards, thus reward counter is 3. member's reward counter is the same
assert_eq!(member.last_recorded_reward_counter, 3.into());
assert_eq!(reward_pool.last_recorded_reward_counter, 3.into());
}
// someone else joins
{
join(40, 10);
let (member, _, reward_pool) = Pools::get_member_with_pools(&40).unwrap();
// reward counter does not change since no rewards have came in.
assert_eq!(member.last_recorded_reward_counter, 3.into());
assert_eq!(reward_pool.last_recorded_reward_counter, 3.into());
assert_eq!(reward_pool.last_recorded_total_payouts, 60);
}
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: 20, pool_id: 1, bonded: 10, joined: true },
Event::Bonded { member: 30, pool_id: 1, bonded: 10, joined: true },
Event::Bonded { member: 40, pool_id: 1, bonded: 10, joined: true }
]
);
})
}
#[test]
fn bond_extra_updates_recorded_data() {
ExtBuilder::default().add_members(vec![(20, 20)]).build_and_execute(|| {
MaxPoolMembers::<Runtime>::set(None);
MaxPoolMembersPerPool::<Runtime>::set(None);
// initial state of pool 1.
{
let (member_10, _, reward_pool_10) = Pools::get_member_with_pools(&10).unwrap();
assert_eq!(reward_pool_10.last_recorded_total_payouts, 0);
assert_eq!(reward_pool_10.total_rewards_claimed, 0);
assert_eq!(reward_pool_10.last_recorded_reward_counter, 0.into());
assert_eq!(member_10.last_recorded_reward_counter, 0.into());
}
Balances::make_free_balance_be(&10, 100);
Balances::make_free_balance_be(&20, 100);
// 10 bonds extra without any rewards.
{
assert_ok!(Pools::bond_extra(
RuntimeOrigin::signed(10),
BondExtra::FreeBalance(10)
));
let (member, _, reward_pool) = Pools::get_member_with_pools(&10).unwrap();
assert_eq!(member.last_recorded_reward_counter, 0.into());
assert_eq!(reward_pool.last_recorded_total_payouts, 0);
assert_eq!(reward_pool.last_recorded_reward_counter, 0.into());
}
// 10 bonds extra again with some rewards. This reward should be split equally between
// 10 and 20, as they both have equal points now.
Balances::mutate_account(&default_reward_account(), |f| f.free += 30).unwrap();
{
assert_ok!(Pools::bond_extra(
RuntimeOrigin::signed(10),
BondExtra::FreeBalance(10)
));
let (member, _, reward_pool) = Pools::get_member_with_pools(&10).unwrap();
// explanation: before bond_extra takes place, there is 40 points and 30 balance in
// the system, RewardCounter is therefore 7.5
assert_eq!(member.last_recorded_reward_counter, RewardCounter::from_float(0.75));
assert_eq!(
reward_pool.last_recorded_reward_counter,
RewardCounter::from_float(0.75)
);
assert_eq!(reward_pool.last_recorded_total_payouts, 30);
}
// 20 bonds extra again, without further rewards.
{
assert_ok!(Pools::bond_extra(
RuntimeOrigin::signed(20),
BondExtra::FreeBalance(10)
));
let (member, _, reward_pool) = Pools::get_member_with_pools(&20).unwrap();
assert_eq!(member.last_recorded_reward_counter, RewardCounter::from_float(0.75));
assert_eq!(
reward_pool.last_recorded_reward_counter,
RewardCounter::from_float(0.75)
);
assert_eq!(reward_pool.last_recorded_total_payouts, 30);
}
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: 20, pool_id: 1, bonded: 20, joined: true },
Event::Bonded { member: 10, pool_id: 1, bonded: 10, joined: false },
Event::PaidOut { member: 10, pool_id: 1, payout: 15 },
Event::Bonded { member: 10, pool_id: 1, bonded: 10, joined: false },
Event::PaidOut { member: 20, pool_id: 1, payout: 15 },
Event::Bonded { member: 20, pool_id: 1, bonded: 10, joined: false }
]
);
})
}
#[test]
fn bond_extra_pending_rewards_works() {
ExtBuilder::default().add_members(vec![(20, 20)]).build_and_execute(|| {
MaxPoolMembers::<Runtime>::set(None);
MaxPoolMembersPerPool::<Runtime>::set(None);
// pool receives some rewards.
Balances::mutate_account(&default_reward_account(), |f| f.free += 30).unwrap();
System::reset_events();
// 10 cashes it out, and bonds it.
{
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(10)));
let (member, _, reward_pool) = Pools::get_member_with_pools(&10).unwrap();
// there is 30 points and 30 reward points in the system RC is 1.
assert_eq!(member.last_recorded_reward_counter, 1.into());
assert_eq!(reward_pool.total_rewards_claimed, 10);
// these two are not updated -- only updated when the points change.
assert_eq!(reward_pool.last_recorded_total_payouts, 0);
assert_eq!(reward_pool.last_recorded_reward_counter, 0.into());
assert_eq!(
pool_events_since_last_call(),
vec![Event::PaidOut { member: 10, pool_id: 1, payout: 10 }]
);
}
// 20 re-bonds it.
{
assert_ok!(Pools::bond_extra(RuntimeOrigin::signed(20), BondExtra::Rewards));
let (member, _, reward_pool) = Pools::get_member_with_pools(&10).unwrap();
assert_eq!(member.last_recorded_reward_counter, 1.into());
assert_eq!(reward_pool.total_rewards_claimed, 30);
// since points change, these two are updated.
assert_eq!(reward_pool.last_recorded_total_payouts, 30);
assert_eq!(reward_pool.last_recorded_reward_counter, 1.into());
assert_eq!(
pool_events_since_last_call(),
vec![
Event::PaidOut { member: 20, pool_id: 1, payout: 20 },
Event::Bonded { member: 20, pool_id: 1, bonded: 20, joined: false }
]
);
}
})
}
#[test]
fn unbond_updates_recorded_data() {
ExtBuilder::default()
.add_members(vec![(20, 20), (30, 20)])
.build_and_execute(|| {
MaxPoolMembers::<Runtime>::set(None);
MaxPoolMembersPerPool::<Runtime>::set(None);
// initial state of pool 1.
{
let (member, _, reward_pool) = Pools::get_member_with_pools(&10).unwrap();
assert_eq!(reward_pool.last_recorded_total_payouts, 0);
assert_eq!(reward_pool.total_rewards_claimed, 0);
assert_eq!(reward_pool.last_recorded_reward_counter, 0.into());
assert_eq!(member.last_recorded_reward_counter, 0.into());
}
// 20 unbonds without any rewards.
{
assert_ok!(Pools::unbond(RuntimeOrigin::signed(20), 20, 10));
let (member, _, reward_pool) = Pools::get_member_with_pools(&20).unwrap();
assert_eq!(member.last_recorded_reward_counter, 0.into());
assert_eq!(reward_pool.last_recorded_total_payouts, 0);
assert_eq!(reward_pool.last_recorded_reward_counter, 0.into());
}
// some rewards come in.
Balances::mutate_account(&default_reward_account(), |f| f.free += 30).unwrap();
// and 30 also unbonds half.
{
assert_ok!(Pools::unbond(RuntimeOrigin::signed(30), 30, 10));
let (member, _, reward_pool) = Pools::get_member_with_pools(&30).unwrap();
// 30 reward in the system, and 40 points before this unbond to collect it,
// RewardCounter is 3/4.
assert_eq!(
member.last_recorded_reward_counter,
RewardCounter::from_float(0.75)
);
assert_eq!(reward_pool.last_recorded_total_payouts, 30);
assert_eq!(
reward_pool.last_recorded_reward_counter,
RewardCounter::from_float(0.75)
);
}
// 30 unbonds again, not change this time.
{
assert_ok!(Pools::unbond(RuntimeOrigin::signed(30), 30, 5));
let (member, _, reward_pool) = Pools::get_member_with_pools(&30).unwrap();
assert_eq!(
member.last_recorded_reward_counter,
RewardCounter::from_float(0.75)
);
assert_eq!(reward_pool.last_recorded_total_payouts, 30);
assert_eq!(
reward_pool.last_recorded_reward_counter,
RewardCounter::from_float(0.75)
);
}
// 20 unbonds again, not change this time, just collecting their reward.
{
assert_ok!(Pools::unbond(RuntimeOrigin::signed(20), 20, 5));
let (member, _, reward_pool) = Pools::get_member_with_pools(&20).unwrap();
assert_eq!(
member.last_recorded_reward_counter,
RewardCounter::from_float(0.75)
);
assert_eq!(reward_pool.last_recorded_total_payouts, 30);
assert_eq!(
reward_pool.last_recorded_reward_counter,
RewardCounter::from_float(0.75)
);
}
// trigger 10's reward as well to see all of the payouts.
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(10)));
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: 20, pool_id: 1, bonded: 20, joined: true },
Event::Bonded { member: 30, pool_id: 1, bonded: 20, joined: true },
Event::Unbonded { member: 20, pool_id: 1, balance: 10, points: 10, era: 3 },
Event::PaidOut { member: 30, pool_id: 1, payout: 15 },
Event::Unbonded { member: 30, pool_id: 1, balance: 10, points: 10, era: 3 },
Event::Unbonded { member: 30, pool_id: 1, balance: 5, points: 5, era: 3 },
Event::PaidOut { member: 20, pool_id: 1, payout: 7 },
Event::Unbonded { member: 20, pool_id: 1, balance: 5, points: 5, era: 3 },
Event::PaidOut { member: 10, pool_id: 1, payout: 7 }
]
);
})
}
#[test]
fn rewards_are_rounded_down_depositor_collects_them() {
ExtBuilder::default().add_members(vec![(20, 20)]).build_and_execute(|| {
// initial balance of 10.
assert_eq!(Balances::free_balance(&10), 35);
assert_eq!(
Balances::free_balance(&default_reward_account()),
Balances::minimum_balance()
);
// some rewards come in.
Balances::mutate_account(&default_reward_account(), |f| f.free += 40).unwrap();
// everyone claims
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(10)));
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(20)));
// some dust (1) remains in the reward account.
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: 20, pool_id: 1, bonded: 20, joined: true },
Event::PaidOut { member: 10, pool_id: 1, payout: 13 },
Event::PaidOut { member: 20, pool_id: 1, payout: 26 }
]
);
// start dismantling the pool.
assert_ok!(Pools::set_state(RuntimeOrigin::signed(902), 1, PoolState::Destroying));
assert_ok!(fully_unbond_permissioned(20));
CurrentEra::set(3);
assert_ok!(Pools::withdraw_unbonded(RuntimeOrigin::signed(20), 20, 0));
assert_ok!(fully_unbond_permissioned(10));
CurrentEra::set(6);
assert_ok!(Pools::withdraw_unbonded(RuntimeOrigin::signed(10), 10, 0));
assert_eq!(
pool_events_since_last_call(),
vec![
Event::StateChanged { pool_id: 1, new_state: PoolState::Destroying },
Event::Unbonded { member: 20, pool_id: 1, balance: 20, points: 20, era: 3 },
Event::Withdrawn { member: 20, pool_id: 1, balance: 20, points: 20 },
Event::MemberRemoved { pool_id: 1, member: 20 },
Event::Unbonded { member: 10, pool_id: 1, balance: 10, points: 10, era: 6 },
Event::Withdrawn { member: 10, pool_id: 1, balance: 10, points: 10 },
Event::MemberRemoved { pool_id: 1, member: 10 },
Event::Destroyed { pool_id: 1 }
]
);
assert!(!Metadata::<T>::contains_key(1));
// original ed + ed put into reward account + reward + bond + dust.
assert_eq!(Balances::free_balance(&10), 35 + 5 + 13 + 10 + 1);
})
}
#[test]
fn claim_payout_large_numbers() {
let unit = 10u128.pow(12); // akin to KSM
ExistentialDeposit::set(unit);
StakingMinBond::set(unit * 1000);
ExtBuilder::default()
.max_members(Some(4))
.max_members_per_pool(Some(4))
.add_members(vec![(20, 1500 * unit), (21, 2500 * unit), (22, 5000 * unit)])
.build_and_execute(|| {
// some rewards come in.
assert_eq!(Balances::free_balance(&default_reward_account()), unit);
Balances::mutate_account(&default_reward_account(), |f| f.free += unit / 1000)
.unwrap();
// everyone claims
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(10)));
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(20)));
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(21)));
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(22)));
assert_eq!(
pool_events_since_last_call(),
vec![
Event::Created { depositor: 10, pool_id: 1 },
Event::Bonded {
member: 10,
pool_id: 1,
bonded: 1000000000000000,
joined: true
},
Event::Bonded {
member: 20,
pool_id: 1,
bonded: 1500000000000000,
joined: true
},
Event::Bonded {
member: 21,
pool_id: 1,
bonded: 2500000000000000,
joined: true
},
Event::Bonded {
member: 22,
pool_id: 1,
bonded: 5000000000000000,
joined: true
},
Event::PaidOut { member: 10, pool_id: 1, payout: 100000000 },
Event::PaidOut { member: 20, pool_id: 1, payout: 150000000 },
Event::PaidOut { member: 21, pool_id: 1, payout: 250000000 },
Event::PaidOut { member: 22, pool_id: 1, payout: 500000000 }
]
);
})
}
}
mod unbond {
use super::*;
#[test]
fn member_unbond_open() {
// depositor in pool, pool state open
// - member unbond above limit
// - member unbonds to 0
// - member cannot unbond between within limit and 0
ExtBuilder::default()
.min_join_bond(10)
.add_members(vec![(20, 20)])
.build_and_execute(|| {
// can unbond to above limit
assert_ok!(Pools::unbond(RuntimeOrigin::signed(20), 20, 5));
assert_eq!(PoolMembers::<Runtime>::get(20).unwrap().active_points(), 15);
assert_eq!(PoolMembers::<Runtime>::get(20).unwrap().unbonding_points(), 5);
// cannot go to below 10:
assert_noop!(
Pools::unbond(RuntimeOrigin::signed(20), 20, 10),
Error::<T>::MinimumBondNotMet
);
// but can go to 0
assert_ok!(Pools::unbond(RuntimeOrigin::signed(20), 20, 15));
assert_eq!(PoolMembers::<Runtime>::get(20).unwrap().active_points(), 0);
assert_eq!(PoolMembers::<Runtime>::get(20).unwrap().unbonding_points(), 20);
})
}
#[test]
fn member_kicked() {
// depositor in pool, pool state blocked
// - member cannot be kicked to above limit
// - member cannot be kicked between within limit and 0
// - member kicked to 0
ExtBuilder::default()
.min_join_bond(10)
.add_members(vec![(20, 20)])
.build_and_execute(|| {
unsafe_set_state(1, PoolState::Blocked);
let kicker = DEFAULT_ROLES.state_toggler.unwrap();
// cannot be kicked to above the limit.
assert_noop!(
Pools::unbond(RuntimeOrigin::signed(kicker), 20, 5),
Error::<T>::PartialUnbondNotAllowedPermissionlessly
);
// cannot go to below 10:
assert_noop!(
Pools::unbond(RuntimeOrigin::signed(kicker), 20, 15),
Error::<T>::PartialUnbondNotAllowedPermissionlessly
);
// but they themselves can do an unbond
assert_ok!(Pools::unbond(RuntimeOrigin::signed(20), 20, 2));
assert_eq!(PoolMembers::<Runtime>::get(20).unwrap().active_points(), 18);
assert_eq!(PoolMembers::<Runtime>::get(20).unwrap().unbonding_points(), 2);
// can be kicked to 0.
assert_ok!(Pools::unbond(RuntimeOrigin::signed(kicker), 20, 18));
assert_eq!(PoolMembers::<Runtime>::get(20).unwrap().active_points(), 0);
assert_eq!(PoolMembers::<Runtime>::get(20).unwrap().unbonding_points(), 20);
})
}
#[test]
fn member_unbond_destroying() {
// depositor in pool, pool state destroying
// - member cannot be permissionlessly unbonded to above limit
// - member cannot be permissionlessly unbonded between within limit and 0
// - member permissionlessly unbonded to 0
ExtBuilder::default()
.min_join_bond(10)
.add_members(vec![(20, 20)])
.build_and_execute(|| {
unsafe_set_state(1, PoolState::Destroying);
let random = 123;
// cannot be kicked to above the limit.
assert_noop!(
Pools::unbond(RuntimeOrigin::signed(random), 20, 5),
Error::<T>::PartialUnbondNotAllowedPermissionlessly
);
// cannot go to below 10:
assert_noop!(
Pools::unbond(RuntimeOrigin::signed(random), 20, 15),
Error::<T>::PartialUnbondNotAllowedPermissionlessly
);
// but they themselves can do an unbond
assert_ok!(Pools::unbond(RuntimeOrigin::signed(20), 20, 2));
assert_eq!(PoolMembers::<Runtime>::get(20).unwrap().active_points(), 18);
assert_eq!(PoolMembers::<Runtime>::get(20).unwrap().unbonding_points(), 2);
// but can go to 0
assert_ok!(Pools::unbond(RuntimeOrigin::signed(random), 20, 18));
assert_eq!(PoolMembers::<Runtime>::get(20).unwrap().active_points(), 0);
assert_eq!(PoolMembers::<Runtime>::get(20).unwrap().unbonding_points(), 20);
})
}
#[test]
fn depositor_unbond_open() {
// depositor in pool, pool state open
// - depositor unbonds to above limit
// - depositor cannot unbond to below limit or 0
ExtBuilder::default().min_join_bond(10).build_and_execute(|| {
// give the depositor some extra funds.
assert_ok!(Pools::bond_extra(RuntimeOrigin::signed(10), BondExtra::FreeBalance(10)));
assert_eq!(PoolMembers::<T>::get(10).unwrap().points, 20);
// can unbond to above the limit.
assert_ok!(Pools::unbond(RuntimeOrigin::signed(10), 10, 5));
assert_eq!(PoolMembers::<Runtime>::get(10).unwrap().active_points(), 15);
assert_eq!(PoolMembers::<Runtime>::get(10).unwrap().unbonding_points(), 5);
// cannot go to below 10:
assert_noop!(
Pools::unbond(RuntimeOrigin::signed(10), 10, 10),
Error::<T>::MinimumBondNotMet
);
// cannot go to 0 either.
assert_noop!(
Pools::unbond(RuntimeOrigin::signed(10), 10, 15),
Error::<T>::MinimumBondNotMet
);
})
}
#[test]
fn depositor_kick() {
// depositor in pool, pool state blocked
// - depositor can never be kicked.
ExtBuilder::default().min_join_bond(10).build_and_execute(|| {
// give the depositor some extra funds.
assert_ok!(Pools::bond_extra(RuntimeOrigin::signed(10), BondExtra::FreeBalance(10)));
assert_eq!(PoolMembers::<T>::get(10).unwrap().points, 20);
// set the stage
unsafe_set_state(1, PoolState::Blocked);
let kicker = DEFAULT_ROLES.state_toggler.unwrap();
// cannot be kicked to above limit.
assert_noop!(
Pools::unbond(RuntimeOrigin::signed(kicker), 10, 5),
Error::<T>::PartialUnbondNotAllowedPermissionlessly
);
// or below the limit
assert_noop!(
Pools::unbond(RuntimeOrigin::signed(kicker), 10, 15),
Error::<T>::PartialUnbondNotAllowedPermissionlessly
);
// or 0.
assert_noop!(
Pools::unbond(RuntimeOrigin::signed(kicker), 10, 20),
Error::<T>::DoesNotHavePermission
);
// they themselves cannot do it either
assert_noop!(
Pools::unbond(RuntimeOrigin::signed(10), 10, 20),
Error::<T>::MinimumBondNotMet
);
})
}
#[test]
fn depositor_unbond_destroying_permissionless() {
// depositor can never be permissionlessly unbonded.
ExtBuilder::default().min_join_bond(10).build_and_execute(|| {
// give the depositor some extra funds.
assert_ok!(Pools::bond_extra(RuntimeOrigin::signed(10), BondExtra::FreeBalance(10)));
assert_eq!(PoolMembers::<T>::get(10).unwrap().points, 20);
// set the stage
unsafe_set_state(1, PoolState::Destroying);
let random = 123;
// cannot be kicked to above limit.
assert_noop!(
Pools::unbond(RuntimeOrigin::signed(random), 10, 5),
Error::<T>::PartialUnbondNotAllowedPermissionlessly
);
// or below the limit
assert_noop!(
Pools::unbond(RuntimeOrigin::signed(random), 10, 15),
Error::<T>::PartialUnbondNotAllowedPermissionlessly
);
// or 0.
assert_noop!(
Pools::unbond(RuntimeOrigin::signed(random), 10, 20),
Error::<T>::DoesNotHavePermission
);
// they themselves can do it in this case though.
assert_ok!(Pools::unbond(RuntimeOrigin::signed(10), 10, 20));
})
}
#[test]
fn depositor_unbond_destroying_not_last_member() {
// deposit in pool, pool state destroying
// - depositor can never leave if there is another member in the pool.
ExtBuilder::default()
.min_join_bond(10)
.add_members(vec![(20, 20)])
.build_and_execute(|| {
// give the depositor some extra funds.
assert_ok!(Pools::bond_extra(
RuntimeOrigin::signed(10),
BondExtra::FreeBalance(10)
));
assert_eq!(PoolMembers::<T>::get(10).unwrap().points, 20);
// set the stage
unsafe_set_state(1, PoolState::Destroying);
// can go above the limit
assert_ok!(Pools::unbond(RuntimeOrigin::signed(10), 10, 5));
assert_eq!(PoolMembers::<Runtime>::get(10).unwrap().active_points(), 15);
assert_eq!(PoolMembers::<Runtime>::get(10).unwrap().unbonding_points(), 5);
// but not below the limit
assert_noop!(
Pools::unbond(RuntimeOrigin::signed(10), 10, 10),
Error::<T>::MinimumBondNotMet
);
// and certainly not zero
assert_noop!(
Pools::unbond(RuntimeOrigin::signed(10), 10, 15),
Error::<T>::MinimumBondNotMet
);
})
}
#[test]
fn depositor_unbond_destroying_last_member() {
// deposit in pool, pool state destroying
// - depositor can unbond to above limit always.
// - depositor cannot unbond to below limit if last.
// - depositor can unbond to 0 if last and destroying.
ExtBuilder::default().min_join_bond(10).build_and_execute(|| {
// give the depositor some extra funds.
assert_ok!(Pools::bond_extra(RuntimeOrigin::signed(10), BondExtra::FreeBalance(10)));
assert_eq!(PoolMembers::<T>::get(10).unwrap().points, 20);
// set the stage
unsafe_set_state(1, PoolState::Destroying);
// can unbond to above the limit.
assert_ok!(Pools::unbond(RuntimeOrigin::signed(10), 10, 5));
assert_eq!(PoolMembers::<Runtime>::get(10).unwrap().active_points(), 15);
assert_eq!(PoolMembers::<Runtime>::get(10).unwrap().unbonding_points(), 5);
// still cannot go to below limit
assert_noop!(
Pools::unbond(RuntimeOrigin::signed(10), 10, 10),
Error::<T>::MinimumBondNotMet
);
// can go to 0 too.
assert_ok!(Pools::unbond(RuntimeOrigin::signed(10), 10, 15));
assert_eq!(PoolMembers::<Runtime>::get(10).unwrap().active_points(), 0);
assert_eq!(PoolMembers::<Runtime>::get(10).unwrap().unbonding_points(), 20);
})
}
#[test]
fn unbond_of_1_works() {
ExtBuilder::default().build_and_execute(|| {
unsafe_set_state(1, PoolState::Destroying);
assert_ok!(fully_unbond_permissioned(10));
assert_eq!(
SubPoolsStorage::<Runtime>::get(1).unwrap().with_era,
unbonding_pools_with_era! { 0 + 3 => UnbondPool::<Runtime> { points: 10, balance: 10 }}
);
assert_eq!(
BondedPool::<Runtime>::get(1).unwrap(),
BondedPool {
id: 1,
inner: BondedPoolInner {
state: PoolState::Destroying,
points: 0,
member_counter: 1,
roles: DEFAULT_ROLES,
}
}
);
assert_eq!(StakingMock::active_stake(&default_bonded_account()).unwrap(), 0);
});
}
#[test]
fn unbond_of_3_works() {
ExtBuilder::default()
.add_members(vec![(40, 40), (550, 550)])
.build_and_execute(|| {
let ed = Balances::minimum_balance();
// Given a slash from 600 -> 100
StakingMock::set_bonded_balance(default_bonded_account(), 100);
// and unclaimed rewards of 600.
Balances::make_free_balance_be(&default_reward_account(), ed + 600);
// When
assert_ok!(fully_unbond_permissioned(40));
// Then
assert_eq!(
SubPoolsStorage::<Runtime>::get(1).unwrap().with_era,
unbonding_pools_with_era! { 0 + 3 => UnbondPool { points: 6, balance: 6 }}
);
assert_eq!(
BondedPool::<Runtime>::get(1).unwrap(),
BondedPool {
id: 1,
inner: BondedPoolInner {
state: PoolState::Open,
points: 560,
member_counter: 3,
roles: DEFAULT_ROLES,
}
}
);
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: 40, pool_id: 1, bonded: 40, joined: true },
Event::Bonded { member: 550, pool_id: 1, bonded: 550, joined: true },
Event::PaidOut { member: 40, pool_id: 1, payout: 40 },
Event::Unbonded { member: 40, pool_id: 1, points: 6, balance: 6, era: 3 }
]
);
assert_eq!(StakingMock::active_stake(&default_bonded_account()).unwrap(), 94);
assert_eq!(
PoolMembers::<Runtime>::get(40).unwrap().unbonding_eras,
member_unbonding_eras!(0 + 3 => 6)
);
assert_eq!(Balances::free_balance(&40), 40 + 40); // We claim rewards when unbonding
// When
unsafe_set_state(1, PoolState::Destroying);
assert_ok!(fully_unbond_permissioned(550));
// Then
assert_eq!(
SubPoolsStorage::<Runtime>::get(&1).unwrap().with_era,
unbonding_pools_with_era! { 0 + 3 => UnbondPool { points: 98, balance: 98 }}
);
assert_eq!(
BondedPool::<Runtime>::get(1).unwrap(),
BondedPool {
id: 1,
inner: BondedPoolInner {
state: PoolState::Destroying,
points: 10,
member_counter: 3,
roles: DEFAULT_ROLES
}
}
);
assert_eq!(StakingMock::active_stake(&default_bonded_account()).unwrap(), 2);
assert_eq!(
PoolMembers::<Runtime>::get(550).unwrap().unbonding_eras,
member_unbonding_eras!(0 + 3 => 92)
);
assert_eq!(Balances::free_balance(&550), 550 + 550);
assert_eq!(
pool_events_since_last_call(),
vec![
Event::PaidOut { member: 550, pool_id: 1, payout: 550 },
Event::Unbonded {
member: 550,
pool_id: 1,
points: 92,
balance: 92,
era: 3
}
]
);
// When
CurrentEra::set(3);
assert_ok!(Pools::withdraw_unbonded(RuntimeOrigin::signed(10), 40, 0));
assert_ok!(Pools::withdraw_unbonded(RuntimeOrigin::signed(10), 550, 0));
assert_ok!(fully_unbond_permissioned(10));
// Then
assert_eq!(
SubPoolsStorage::<Runtime>::get(1).unwrap().with_era,
unbonding_pools_with_era! { 6 => UnbondPool { points: 2, balance: 2 }}
);
assert_eq!(
BondedPool::<Runtime>::get(1).unwrap(),
BondedPool {
id: 1,
inner: BondedPoolInner {
state: PoolState::Destroying,
points: 0,
member_counter: 1,
roles: DEFAULT_ROLES
}
}
);
assert_eq!(StakingMock::active_stake(&default_bonded_account()).unwrap(), 0);
assert_eq!(Balances::free_balance(&550), 550 + 550 + 92);
assert_eq!(
pool_events_since_last_call(),
vec![
Event::Withdrawn { member: 40, pool_id: 1, points: 6, balance: 6 },
Event::MemberRemoved { pool_id: 1, member: 40 },
Event::Withdrawn { member: 550, pool_id: 1, points: 92, balance: 92 },
Event::MemberRemoved { pool_id: 1, member: 550 },
Event::PaidOut { member: 10, pool_id: 1, payout: 10 },
Event::Unbonded { member: 10, pool_id: 1, points: 2, balance: 2, era: 6 }
]
);
});
}
#[test]
fn unbond_merges_older_pools() {
ExtBuilder::default().with_check(1).build_and_execute(|| {
// Given
assert_eq!(StakingMock::bonding_duration(), 3);
SubPoolsStorage::<Runtime>::insert(
1,
SubPools {
no_era: Default::default(),
with_era: unbonding_pools_with_era! {
0 + 3 => UnbondPool { balance: 10, points: 100 },
1 + 3 => UnbondPool { balance: 20, points: 20 },
2 + 3 => UnbondPool { balance: 101, points: 101}
},
},
);
unsafe_set_state(1, PoolState::Destroying);
// When
let current_era = 1 + TotalUnbondingPools::<Runtime>::get();
CurrentEra::set(current_era);
assert_ok!(fully_unbond_permissioned(10));
// Then
assert_eq!(
SubPoolsStorage::<Runtime>::get(1).unwrap(),
SubPools {
no_era: UnbondPool { balance: 10 + 20, points: 100 + 20 },
with_era: unbonding_pools_with_era! {
2 + 3 => UnbondPool { balance: 101, points: 101},
current_era + 3 => UnbondPool { balance: 10, points: 10 },
},
},
);
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::Unbonded { member: 10, pool_id: 1, points: 10, balance: 10, era: 9 }
]
);
});
}
#[test]
fn unbond_kick_works() {
// Kick: the pool is blocked and the caller is either the root or state-toggler.
ExtBuilder::default()
.add_members(vec![(100, 100), (200, 200)])
.build_and_execute(|| {
// Given
unsafe_set_state(1, PoolState::Blocked);
let bonded_pool = BondedPool::<Runtime>::get(1).unwrap();
assert_eq!(bonded_pool.roles.root.unwrap(), 900);
assert_eq!(bonded_pool.roles.nominator.unwrap(), 901);
assert_eq!(bonded_pool.roles.state_toggler.unwrap(), 902);
// When the nominator tries to kick, then its a noop
assert_noop!(
Pools::fully_unbond(RuntimeOrigin::signed(901), 100),
Error::<Runtime>::NotKickerOrDestroying
);
// When the root kicks then its ok
assert_ok!(Pools::fully_unbond(RuntimeOrigin::signed(900), 100));
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: 100, pool_id: 1, bonded: 100, joined: true },
Event::Bonded { member: 200, pool_id: 1, bonded: 200, joined: true },
Event::Unbonded {
member: 100,
pool_id: 1,
points: 100,
balance: 100,
era: 3
},
]
);
// When the state toggler kicks then its ok
assert_ok!(Pools::fully_unbond(RuntimeOrigin::signed(902), 200));
assert_eq!(
pool_events_since_last_call(),
vec![Event::Unbonded {
member: 200,
pool_id: 1,
points: 200,
balance: 200,
era: 3
}]
);
assert_eq!(
BondedPool::<Runtime>::get(1).unwrap(),
BondedPool {
id: 1,
inner: BondedPoolInner {
roles: DEFAULT_ROLES,
state: PoolState::Blocked,
points: 10, // Only 10 points because 200 + 100 was unbonded
member_counter: 3,
}
}
);
assert_eq!(StakingMock::active_stake(&default_bonded_account()).unwrap(), 10);
assert_eq!(
SubPoolsStorage::<Runtime>::get(1).unwrap(),
SubPools {
no_era: Default::default(),
with_era: unbonding_pools_with_era! {
0 + 3 => UnbondPool { points: 100 + 200, balance: 100 + 200 }
},
}
);
assert_eq!(
*UnbondingBalanceMap::get().get(&default_bonded_account()).unwrap(),
100 + 200
);
});
}
#[test]
fn unbond_permissionless_works() {
// Scenarios where non-admin accounts can unbond others
ExtBuilder::default().add_members(vec![(100, 100)]).build_and_execute(|| {
// Given the pool is blocked
unsafe_set_state(1, PoolState::Blocked);
// A permissionless unbond attempt errors
assert_noop!(
Pools::fully_unbond(RuntimeOrigin::signed(420), 100),
Error::<Runtime>::NotKickerOrDestroying
);
// permissionless unbond must be full
assert_noop!(
Pools::unbond(RuntimeOrigin::signed(420), 100, 80),
Error::<Runtime>::PartialUnbondNotAllowedPermissionlessly,
);
// Given the pool is destroying
unsafe_set_state(1, PoolState::Destroying);
// The depositor cannot be fully unbonded until they are the last member
assert_noop!(
Pools::fully_unbond(RuntimeOrigin::signed(10), 10),
Error::<Runtime>::MinimumBondNotMet,
);
// Any account can unbond a member that is not the depositor
assert_ok!(Pools::fully_unbond(RuntimeOrigin::signed(420), 100));
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: 100, pool_id: 1, bonded: 100, joined: true },
Event::Unbonded { member: 100, pool_id: 1, points: 100, balance: 100, era: 3 }
]
);
// still permissionless unbond must be full
assert_noop!(
Pools::unbond(RuntimeOrigin::signed(420), 100, 80),
Error::<Runtime>::PartialUnbondNotAllowedPermissionlessly,
);
// Given the pool is blocked
unsafe_set_state(1, PoolState::Blocked);
// The depositor cannot be unbonded
assert_noop!(
Pools::fully_unbond(RuntimeOrigin::signed(420), 10),
Error::<Runtime>::DoesNotHavePermission
);
// Given the pools is destroying
unsafe_set_state(1, PoolState::Destroying);
// The depositor cannot be unbonded yet.
assert_noop!(
Pools::fully_unbond(RuntimeOrigin::signed(420), 10),
Error::<Runtime>::DoesNotHavePermission,
);
// but when everyone is unbonded it can..
CurrentEra::set(3);
assert_ok!(Pools::withdraw_unbonded(RuntimeOrigin::signed(10), 100, 0));
// still permissionless unbond must be full.
assert_noop!(
Pools::unbond(RuntimeOrigin::signed(420), 10, 5),
Error::<Runtime>::PartialUnbondNotAllowedPermissionlessly,
);
// depositor can never be unbonded permissionlessly .
assert_noop!(
Pools::fully_unbond(RuntimeOrigin::signed(420), 10),
Error::<T>::DoesNotHavePermission
);
// but depositor itself can do it.
assert_ok!(Pools::fully_unbond(RuntimeOrigin::signed(10), 10));
assert_eq!(BondedPools::<Runtime>::get(1).unwrap().points, 0);
assert_eq!(
SubPoolsStorage::<Runtime>::get(1).unwrap(),
SubPools {
no_era: Default::default(),
with_era: unbonding_pools_with_era! {
3 + 3 => UnbondPool { points: 10, balance: 10 }
}
}
);
assert_eq!(StakingMock::active_stake(&default_bonded_account()).unwrap(), 0);
assert_eq!(*UnbondingBalanceMap::get().get(&default_bonded_account()).unwrap(), 10);
});
}
#[test]
#[cfg_attr(debug_assertions, should_panic(expected = "Defensive failure has been triggered!"))]
#[cfg_attr(not(debug_assertions), should_panic)]
fn unbond_errors_correctly() {
ExtBuilder::default().build_and_execute(|| {
assert_noop!(
Pools::fully_unbond(RuntimeOrigin::signed(11), 11),
Error::<Runtime>::PoolMemberNotFound
);
// Add the member
let member = PoolMember { pool_id: 2, points: 10, ..Default::default() };
PoolMembers::<Runtime>::insert(11, member);
let _ = Pools::fully_unbond(RuntimeOrigin::signed(11), 11);
});
}
#[test]
#[cfg_attr(debug_assertions, should_panic(expected = "Defensive failure has been triggered!"))]
#[cfg_attr(not(debug_assertions), should_panic)]
fn unbond_panics_when_reward_pool_not_found() {
ExtBuilder::default().build_and_execute(|| {
let member = PoolMember { pool_id: 2, points: 10, ..Default::default() };
PoolMembers::<Runtime>::insert(11, member);
BondedPool::<Runtime> {
id: 1,
inner: BondedPoolInner {
state: PoolState::Open,
points: 10,
member_counter: 1,
roles: DEFAULT_ROLES,
},
}
.put();
let _ = Pools::fully_unbond(RuntimeOrigin::signed(11), 11);
});
}
#[test]
fn partial_unbond_era_tracking() {
ExtBuilder::default().ed(1).build_and_execute(|| {
// to make the depositor capable of withdrawing.
StakingMinBond::set(1);
MinCreateBond::<T>::set(1);
MinJoinBond::<T>::set(1);
assert_eq!(Pools::depositor_min_bond(), 1);
// given
assert_eq!(PoolMembers::<Runtime>::get(10).unwrap().active_points(), 10);
assert_eq!(PoolMembers::<Runtime>::get(10).unwrap().unbonding_points(), 0);
assert_eq!(PoolMembers::<Runtime>::get(10).unwrap().pool_id, 1);
assert_eq!(
PoolMembers::<Runtime>::get(10).unwrap().unbonding_eras,
member_unbonding_eras!()
);
assert_eq!(BondedPool::<Runtime>::get(1).unwrap().points, 10);
assert!(SubPoolsStorage::<Runtime>::get(1).is_none());
assert_eq!(CurrentEra::get(), 0);
assert_eq!(BondingDuration::get(), 3);
// so the depositor can leave, just keeps the test simpler.
unsafe_set_state(1, PoolState::Destroying);
// when: casual unbond
assert_ok!(Pools::unbond(RuntimeOrigin::signed(10), 10, 1));
// then
assert_eq!(PoolMembers::<Runtime>::get(10).unwrap().active_points(), 9);
assert_eq!(PoolMembers::<Runtime>::get(10).unwrap().unbonding_points(), 1);
assert_eq!(BondedPool::<Runtime>::get(1).unwrap().points, 9);
assert_eq!(
PoolMembers::<Runtime>::get(10).unwrap().unbonding_eras,
member_unbonding_eras!(3 => 1)
);
assert_eq!(
SubPoolsStorage::<Runtime>::get(1).unwrap(),
SubPools {
no_era: Default::default(),
with_era: unbonding_pools_with_era! {
3 => UnbondPool { points: 1, balance: 1 }
}
}
);
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::Unbonded { member: 10, pool_id: 1, points: 1, balance: 1, era: 3 }
]
);
// when: casual further unbond, same era.
assert_ok!(Pools::unbond(RuntimeOrigin::signed(10), 10, 5));
// then
assert_eq!(PoolMembers::<Runtime>::get(10).unwrap().active_points(), 4);
assert_eq!(PoolMembers::<Runtime>::get(10).unwrap().unbonding_points(), 6);
assert_eq!(BondedPool::<Runtime>::get(1).unwrap().points, 4);
assert_eq!(
PoolMembers::<Runtime>::get(10).unwrap().unbonding_eras,
member_unbonding_eras!(3 => 6)
);
assert_eq!(
SubPoolsStorage::<Runtime>::get(1).unwrap(),
SubPools {
no_era: Default::default(),
with_era: unbonding_pools_with_era! {
3 => UnbondPool { points: 6, balance: 6 }
}
}
);
assert_eq!(
pool_events_since_last_call(),
vec![Event::Unbonded { member: 10, pool_id: 1, points: 5, balance: 5, era: 3 }]
);
// when: casual further unbond, next era.
CurrentEra::set(1);
assert_ok!(Pools::unbond(RuntimeOrigin::signed(10), 10, 1));
// then
assert_eq!(PoolMembers::<Runtime>::get(10).unwrap().active_points(), 3);
assert_eq!(PoolMembers::<Runtime>::get(10).unwrap().unbonding_points(), 7);
assert_eq!(BondedPool::<Runtime>::get(1).unwrap().points, 3);
assert_eq!(
PoolMembers::<Runtime>::get(10).unwrap().unbonding_eras,
member_unbonding_eras!(3 => 6, 4 => 1)
);
assert_eq!(
SubPoolsStorage::<Runtime>::get(1).unwrap(),
SubPools {
no_era: Default::default(),
with_era: unbonding_pools_with_era! {
3 => UnbondPool { points: 6, balance: 6 },
4 => UnbondPool { points: 1, balance: 1 }
}
}
);
assert_eq!(
pool_events_since_last_call(),
vec![Event::Unbonded { member: 10, pool_id: 1, points: 1, balance: 1, era: 4 }]
);
// when: unbonding more than our active: error
assert_noop!(
frame_support::storage::with_storage_layer(|| Pools::unbond(
RuntimeOrigin::signed(10),
10,
5
)),
Error::<Runtime>::MinimumBondNotMet
);
// instead:
assert_ok!(Pools::unbond(RuntimeOrigin::signed(10), 10, 3));
// then
assert_eq!(PoolMembers::<Runtime>::get(10).unwrap().active_points(), 0);
assert_eq!(PoolMembers::<Runtime>::get(10).unwrap().unbonding_points(), 10);
assert_eq!(BondedPool::<Runtime>::get(1).unwrap().points, 0);
assert_eq!(
PoolMembers::<Runtime>::get(10).unwrap().unbonding_eras,
member_unbonding_eras!(3 => 6, 4 => 4)
);
assert_eq!(
SubPoolsStorage::<Runtime>::get(1).unwrap(),
SubPools {
no_era: Default::default(),
with_era: unbonding_pools_with_era! {
3 => UnbondPool { points: 6, balance: 6 },
4 => UnbondPool { points: 4, balance: 4 }
}
}
);
assert_eq!(
pool_events_since_last_call(),
vec![Event::Unbonded { member: 10, pool_id: 1, points: 3, balance: 3, era: 4 }]
);
});
}
#[test]
fn partial_unbond_max_chunks() {
ExtBuilder::default().add_members(vec![(20, 20)]).ed(1).build_and_execute(|| {
MaxUnbonding::set(2);
// given
assert_ok!(Pools::unbond(RuntimeOrigin::signed(20), 20, 2));
CurrentEra::set(1);
assert_ok!(Pools::unbond(RuntimeOrigin::signed(20), 20, 3));
assert_eq!(
PoolMembers::<Runtime>::get(20).unwrap().unbonding_eras,
member_unbonding_eras!(3 => 2, 4 => 3)
);
// when
CurrentEra::set(2);
assert_noop!(
frame_support::storage::with_storage_layer(|| Pools::unbond(
RuntimeOrigin::signed(20),
20,
4
)),
Error::<Runtime>::MaxUnbondingLimit
);
// when
MaxUnbonding::set(3);
assert_ok!(Pools::unbond(RuntimeOrigin::signed(20), 20, 1));
assert_eq!(
PoolMembers::<Runtime>::get(20).unwrap().unbonding_eras,
member_unbonding_eras!(3 => 2, 4 => 3, 5 => 1)
);
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: 20, pool_id: 1, bonded: 20, joined: true },
Event::Unbonded { member: 20, pool_id: 1, points: 2, balance: 2, era: 3 },
Event::Unbonded { member: 20, pool_id: 1, points: 3, balance: 3, era: 4 },
Event::Unbonded { member: 20, pool_id: 1, points: 1, balance: 1, era: 5 }
]
);
})
}
// depositor can unbond only up to `MinCreateBond`.
#[test]
fn depositor_permissioned_partial_unbond() {
ExtBuilder::default().ed(1).build_and_execute(|| {
// given
StakingMinBond::set(5);
assert_eq!(Pools::depositor_min_bond(), 5);
assert_eq!(PoolMembers::<Runtime>::get(10).unwrap().active_points(), 10);
assert_eq!(PoolMembers::<Runtime>::get(10).unwrap().unbonding_points(), 0);
// can unbond a bit..
assert_ok!(Pools::unbond(RuntimeOrigin::signed(10), 10, 3));
assert_eq!(PoolMembers::<Runtime>::get(10).unwrap().active_points(), 7);
assert_eq!(PoolMembers::<Runtime>::get(10).unwrap().unbonding_points(), 3);
// but not less than 2
assert_noop!(
Pools::unbond(RuntimeOrigin::signed(10), 10, 6),
Error::<Runtime>::MinimumBondNotMet
);
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::Unbonded { member: 10, pool_id: 1, points: 3, balance: 3, era: 3 }
]
);
});
}
#[test]
fn depositor_permissioned_partial_unbond_slashed() {
ExtBuilder::default().ed(1).build_and_execute(|| {
// given
assert_eq!(MinCreateBond::<Runtime>::get(), 2);
assert_eq!(PoolMembers::<Runtime>::get(10).unwrap().active_points(), 10);
assert_eq!(PoolMembers::<Runtime>::get(10).unwrap().unbonding_points(), 0);
// slash the default pool
StakingMock::set_bonded_balance(Pools::create_bonded_account(1), 5);
// cannot unbond even 7, because the value of shares is now less.
assert_noop!(
Pools::unbond(RuntimeOrigin::signed(10), 10, 7),
Error::<Runtime>::MinimumBondNotMet
);
});
}
#[test]
fn every_unbonding_triggers_payout() {
ExtBuilder::default().add_members(vec![(20, 20)]).build_and_execute(|| {
let initial_reward_account = Balances::free_balance(default_reward_account());
assert_eq!(initial_reward_account, Balances::minimum_balance());
assert_eq!(initial_reward_account, 5);
Balances::make_free_balance_be(
&default_reward_account(),
4 * Balances::minimum_balance(),
);
assert_ok!(Pools::unbond(RuntimeOrigin::signed(20), 20, 2));
assert_eq!(
pool_events_since_last_call(),
vec![
// 2/3 of ed, which is 20's share.
Event::Created { depositor: 10, pool_id: 1 },
Event::Bonded { member: 10, pool_id: 1, bonded: 10, joined: true },
Event::Bonded { member: 20, pool_id: 1, bonded: 20, joined: true },
Event::PaidOut { member: 20, pool_id: 1, payout: 10 },
Event::Unbonded { member: 20, pool_id: 1, balance: 2, points: 2, era: 3 }
]
);
CurrentEra::set(1);
Balances::make_free_balance_be(
&default_reward_account(),
4 * Balances::minimum_balance(),
);
assert_ok!(Pools::unbond(RuntimeOrigin::signed(20), 20, 3));
assert_eq!(
pool_events_since_last_call(),
vec![
// 2/3 of ed, which is 20's share.
Event::PaidOut { member: 20, pool_id: 1, payout: 6 },
Event::Unbonded { member: 20, pool_id: 1, points: 3, balance: 3, era: 4 }
]
);
CurrentEra::set(2);
Balances::make_free_balance_be(
&default_reward_account(),
4 * Balances::minimum_balance(),
);
assert_ok!(Pools::unbond(RuntimeOrigin::signed(20), 20, 5));
assert_eq!(
pool_events_since_last_call(),
vec![
Event::PaidOut { member: 20, pool_id: 1, payout: 3 },
Event::Unbonded { member: 20, pool_id: 1, points: 5, balance: 5, era: 5 }
]
);
assert_eq!(
PoolMembers::<Runtime>::get(20).unwrap().unbonding_eras,
member_unbonding_eras!(3 => 2, 4 => 3, 5 => 5)
);
});
}
}
mod pool_withdraw_unbonded {
use super::*;
#[test]
fn pool_withdraw_unbonded_works() {
ExtBuilder::default().build_and_execute(|| {
// Given 10 unbond'ed directly against the pool account
assert_ok!(StakingMock::unbond(default_bonded_account(), 5));
// and the pool account only has 10 balance
assert_eq!(StakingMock::active_stake(&default_bonded_account()), Some(5));
assert_eq!(StakingMock::total_stake(&default_bonded_account()), Some(10));
assert_eq!(Balances::free_balance(&default_bonded_account()), 10);
// When
assert_ok!(Pools::pool_withdraw_unbonded(RuntimeOrigin::signed(10), 1, 0));
// Then there unbonding balance is no longer locked
assert_eq!(StakingMock::active_stake(&default_bonded_account()), Some(5));
assert_eq!(StakingMock::total_stake(&default_bonded_account()), Some(5));
assert_eq!(Balances::free_balance(&default_bonded_account()), 10);
});
}
}
mod withdraw_unbonded {
use super::*;
use frame_support::bounded_btree_map;
#[test]
fn withdraw_unbonded_works_against_slashed_no_era_sub_pool() {
ExtBuilder::default()
.add_members(vec![(40, 40), (550, 550)])
.build_and_execute(|| {
// reduce the noise a bit.
let _ = balances_events_since_last_call();
// Given
assert_eq!(StakingMock::bonding_duration(), 3);
assert_ok!(Pools::fully_unbond(RuntimeOrigin::signed(550), 550));
assert_ok!(Pools::fully_unbond(RuntimeOrigin::signed(40), 40));
assert_eq!(Balances::free_balance(&default_bonded_account()), 600);
let mut current_era = 1;
CurrentEra::set(current_era);
let mut sub_pools = SubPoolsStorage::<Runtime>::get(1).unwrap();
let unbond_pool = sub_pools.with_era.get_mut(&3).unwrap();
// Sanity check
assert_eq!(*unbond_pool, UnbondPool { points: 550 + 40, balance: 550 + 40 });
// Simulate a slash to the pool with_era(current_era), decreasing the balance by
// half
{
unbond_pool.balance /= 2; // 295
SubPoolsStorage::<Runtime>::insert(1, sub_pools);
// Update the equivalent of the unbonding chunks for the `StakingMock`
let mut x = UnbondingBalanceMap::get();
*x.get_mut(&default_bonded_account()).unwrap() /= 5;
UnbondingBalanceMap::set(&x);
Balances::make_free_balance_be(
&default_bonded_account(),
Balances::free_balance(&default_bonded_account()) / 2, // 300
);
StakingMock::set_bonded_balance(
default_bonded_account(),
StakingMock::active_stake(&default_bonded_account()).unwrap() / 2,
);
};
// Advance the current_era to ensure all `with_era` pools will be merged into
// `no_era` pool
current_era += TotalUnbondingPools::<Runtime>::get();
CurrentEra::set(current_era);
// Simulate some other call to unbond that would merge `with_era` pools into
// `no_era`
let sub_pools =
SubPoolsStorage::<Runtime>::get(1).unwrap().maybe_merge_pools(current_era);
SubPoolsStorage::<Runtime>::insert(1, sub_pools);
assert_eq!(
SubPoolsStorage::<Runtime>::get(1).unwrap(),
SubPools {
no_era: UnbondPool { points: 550 + 40, balance: 275 + 20 },
with_era: Default::default()
}
);
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: 40, pool_id: 1, bonded: 40, joined: true },
Event::Bonded { member: 550, pool_id: 1, bonded: 550, joined: true },
Event::Unbonded {
member: 550,
pool_id: 1,
points: 550,
balance: 550,
era: 3
},
Event::Unbonded { member: 40, pool_id: 1, points: 40, balance: 40, era: 3 },
]
);
assert_eq!(
balances_events_since_last_call(),
vec![BEvent::BalanceSet {
who: default_bonded_account(),
free: 300,
reserved: 0
}]
);
// When
assert_ok!(Pools::withdraw_unbonded(RuntimeOrigin::signed(550), 550, 0));
// Then
assert_eq!(
SubPoolsStorage::<Runtime>::get(1).unwrap().no_era,
UnbondPool { points: 40, balance: 20 }
);
assert_eq!(
pool_events_since_last_call(),
vec![
Event::Withdrawn { member: 550, pool_id: 1, balance: 275, points: 550 },
Event::MemberRemoved { pool_id: 1, member: 550 }
]
);
assert_eq!(
balances_events_since_last_call(),
vec![BEvent::Transfer { from: default_bonded_account(), to: 550, amount: 275 }]
);
// When
assert_ok!(Pools::withdraw_unbonded(RuntimeOrigin::signed(40), 40, 0));
// Then
assert_eq!(
SubPoolsStorage::<Runtime>::get(1).unwrap().no_era,
UnbondPool { points: 0, balance: 0 }
);
assert!(!PoolMembers::<Runtime>::contains_key(40));
assert_eq!(
pool_events_since_last_call(),
vec![
Event::Withdrawn { member: 40, pool_id: 1, balance: 20, points: 40 },
Event::MemberRemoved { pool_id: 1, member: 40 }
]
);
assert_eq!(
balances_events_since_last_call(),
vec![BEvent::Transfer { from: default_bonded_account(), to: 40, amount: 20 }]
);
// now, finally, the depositor can take out its share.
unsafe_set_state(1, PoolState::Destroying);
assert_ok!(fully_unbond_permissioned(10));
current_era += 3;
CurrentEra::set(current_era);
// when
assert_ok!(Pools::withdraw_unbonded(RuntimeOrigin::signed(10), 10, 0));
assert_eq!(
pool_events_since_last_call(),
vec![
Event::Unbonded { member: 10, pool_id: 1, balance: 5, points: 5, era: 9 },
Event::Withdrawn { member: 10, pool_id: 1, balance: 5, points: 5 },
Event::MemberRemoved { pool_id: 1, member: 10 },
Event::Destroyed { pool_id: 1 }
]
);
assert!(!Metadata::<T>::contains_key(1));
assert_eq!(
balances_events_since_last_call(),
vec![
BEvent::Transfer { from: default_bonded_account(), to: 10, amount: 5 },
BEvent::Transfer { from: default_reward_account(), to: 10, amount: 5 }
]
);
});
}
#[test]
fn withdraw_unbonded_works_against_slashed_with_era_sub_pools() {
ExtBuilder::default()
.add_members(vec![(40, 40), (550, 550)])
.build_and_execute(|| {
let _ = balances_events_since_last_call();
// Given
// current bond is 600, we slash it all to 300.
StakingMock::set_bonded_balance(default_bonded_account(), 300);
Balances::make_free_balance_be(&default_bonded_account(), 300);
assert_eq!(StakingMock::total_stake(&default_bonded_account()), Some(300));
assert_ok!(fully_unbond_permissioned(40));
assert_ok!(fully_unbond_permissioned(550));
assert_eq!(
SubPoolsStorage::<Runtime>::get(&1).unwrap().with_era,
unbonding_pools_with_era! { 3 => UnbondPool { points: 550 / 2 + 40 / 2, balance: 550 / 2 + 40 / 2
}}
);
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: 40, pool_id: 1, bonded: 40, joined: true },
Event::Bonded { member: 550, pool_id: 1, bonded: 550, joined: true },
Event::Unbonded { member: 40, pool_id: 1, balance: 20, points: 20, era: 3 },
Event::Unbonded {
member: 550,
pool_id: 1,
balance: 275,
points: 275,
era: 3,
}
]
);
assert_eq!(
balances_events_since_last_call(),
vec![BEvent::BalanceSet {
who: default_bonded_account(),
free: 300,
reserved: 0
},]
);
CurrentEra::set(StakingMock::bonding_duration());
// When
assert_ok!(Pools::withdraw_unbonded(RuntimeOrigin::signed(40), 40, 0));
// Then
assert_eq!(
balances_events_since_last_call(),
vec![BEvent::Transfer { from: default_bonded_account(), to: 40, amount: 20 },]
);
assert_eq!(
pool_events_since_last_call(),
vec![
Event::Withdrawn { member: 40, pool_id: 1, balance: 20, points: 20 },
Event::MemberRemoved { pool_id: 1, member: 40 }
]
);
assert_eq!(
SubPoolsStorage::<Runtime>::get(&1).unwrap().with_era,
unbonding_pools_with_era! { 3 => UnbondPool { points: 550 / 2, balance: 550 / 2 }}
);
// When
assert_ok!(Pools::withdraw_unbonded(RuntimeOrigin::signed(550), 550, 0));
// Then
assert_eq!(
balances_events_since_last_call(),
vec![BEvent::Transfer { from: default_bonded_account(), to: 550, amount: 275 },]
);
assert_eq!(
pool_events_since_last_call(),
vec![
Event::Withdrawn { member: 550, pool_id: 1, balance: 275, points: 275 },
Event::MemberRemoved { pool_id: 1, member: 550 }
]
);
assert!(SubPoolsStorage::<Runtime>::get(&1).unwrap().with_era.is_empty());
// now, finally, the depositor can take out its share.
unsafe_set_state(1, PoolState::Destroying);
assert_ok!(fully_unbond_permissioned(10));
// because everyone else has left, the points
assert_eq!(
SubPoolsStorage::<Runtime>::get(&1).unwrap().with_era,
unbonding_pools_with_era! { 6 => UnbondPool { points: 5, balance: 5 }}
);
CurrentEra::set(CurrentEra::get() + 3);
// set metadata to check that it's being removed on dissolve
assert_ok!(Pools::set_metadata(RuntimeOrigin::signed(900), 1, vec![1, 1]));
assert!(Metadata::<T>::contains_key(1));
// when
assert_ok!(Pools::withdraw_unbonded(RuntimeOrigin::signed(10), 10, 0));
// then
assert_eq!(Balances::free_balance(&10), 10 + 35);
assert_eq!(Balances::free_balance(&default_bonded_account()), 0);
// in this test 10 also gets a fair share of the slash, because the slash was
// applied to the bonded account.
assert_eq!(
pool_events_since_last_call(),
vec![
Event::Unbonded { member: 10, pool_id: 1, points: 5, balance: 5, era: 6 },
Event::Withdrawn { member: 10, pool_id: 1, points: 5, balance: 5 },
Event::MemberRemoved { pool_id: 1, member: 10 },
Event::Destroyed { pool_id: 1 }
]
);
assert!(!Metadata::<T>::contains_key(1));
assert_eq!(
balances_events_since_last_call(),
vec![
BEvent::Transfer { from: default_bonded_account(), to: 10, amount: 5 },
BEvent::Transfer { from: default_reward_account(), to: 10, amount: 5 }
]
);
});
}
#[test]
fn withdraw_unbonded_handles_faulty_sub_pool_accounting() {
ExtBuilder::default().build_and_execute(|| {
// Given
assert_eq!(Balances::minimum_balance(), 5);
assert_eq!(Balances::free_balance(&10), 35);
assert_eq!(Balances::free_balance(&default_bonded_account()), 10);
unsafe_set_state(1, PoolState::Destroying);
assert_ok!(Pools::fully_unbond(RuntimeOrigin::signed(10), 10));
// Simulate a slash that is not accounted for in the sub pools.
Balances::make_free_balance_be(&default_bonded_account(), 5);
assert_eq!(
SubPoolsStorage::<Runtime>::get(1).unwrap().with_era,
//------------------------------balance decrease is not account for
unbonding_pools_with_era! { 0 + 3 => UnbondPool { points: 10, balance: 10 } }
);
CurrentEra::set(0 + 3);
// When
assert_ok!(Pools::withdraw_unbonded(RuntimeOrigin::signed(10), 10, 0));
// Then
assert_eq!(Balances::free_balance(10), 10 + 35);
assert_eq!(Balances::free_balance(&default_bonded_account()), 0);
});
}
#[test]
fn withdraw_unbonded_errors_correctly() {
ExtBuilder::default().with_check(0).build_and_execute(|| {
// Insert the sub-pool
let sub_pools = SubPools {
no_era: Default::default(),
with_era: unbonding_pools_with_era! { 0 + 3 => UnbondPool { points: 10, balance: 10 }},
};
SubPoolsStorage::<Runtime>::insert(1, sub_pools.clone());
assert_noop!(
Pools::withdraw_unbonded(RuntimeOrigin::signed(11), 11, 0),
Error::<Runtime>::PoolMemberNotFound
);
let mut member = PoolMember { pool_id: 1, points: 10, ..Default::default() };
PoolMembers::<Runtime>::insert(11, member.clone());
// Simulate calling `unbond`
member.unbonding_eras = member_unbonding_eras!(3 + 0 => 10);
PoolMembers::<Runtime>::insert(11, member.clone());
// We are still in the bonding duration
assert_noop!(
Pools::withdraw_unbonded(RuntimeOrigin::signed(11), 11, 0),
Error::<Runtime>::CannotWithdrawAny
);
// If we error the member does not get removed
assert_eq!(PoolMembers::<Runtime>::get(&11), Some(member));
// and the sub pools do not get updated.
assert_eq!(SubPoolsStorage::<Runtime>::get(1).unwrap(), sub_pools)
});
}
#[test]
fn withdraw_unbonded_kick() {
ExtBuilder::default()
.add_members(vec![(100, 100), (200, 200)])
.build_and_execute(|| {
// Given
assert_ok!(Pools::fully_unbond(RuntimeOrigin::signed(100), 100));
assert_ok!(Pools::fully_unbond(RuntimeOrigin::signed(200), 200));
assert_eq!(
BondedPool::<Runtime>::get(1).unwrap(),
BondedPool {
id: 1,
inner: BondedPoolInner {
points: 10,
state: PoolState::Open,
member_counter: 3,
roles: DEFAULT_ROLES
}
}
);
CurrentEra::set(StakingMock::bonding_duration());
// Cannot kick when pool is open
assert_noop!(
Pools::withdraw_unbonded(RuntimeOrigin::signed(902), 100, 0),
Error::<Runtime>::NotKickerOrDestroying
);
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: 100, pool_id: 1, bonded: 100, joined: true },
Event::Bonded { member: 200, pool_id: 1, bonded: 200, joined: true },
Event::Unbonded {
member: 100,
pool_id: 1,
points: 100,
balance: 100,
era: 3
},
Event::Unbonded {
member: 200,
pool_id: 1,
points: 200,
balance: 200,
era: 3
}
]
);
// Given
unsafe_set_state(1, PoolState::Blocked);
// Cannot kick as a nominator
assert_noop!(
Pools::withdraw_unbonded(RuntimeOrigin::signed(901), 100, 0),
Error::<Runtime>::NotKickerOrDestroying
);
// Can kick as root
assert_ok!(Pools::withdraw_unbonded(RuntimeOrigin::signed(900), 100, 0));
// Can kick as state toggler
assert_ok!(Pools::withdraw_unbonded(RuntimeOrigin::signed(900), 200, 0));
assert_eq!(Balances::free_balance(100), 100 + 100);
assert_eq!(Balances::free_balance(200), 200 + 200);
assert!(!PoolMembers::<Runtime>::contains_key(100));
assert!(!PoolMembers::<Runtime>::contains_key(200));
assert_eq!(SubPoolsStorage::<Runtime>::get(1).unwrap(), Default::default());
assert_eq!(
pool_events_since_last_call(),
vec![
Event::Withdrawn { member: 100, pool_id: 1, points: 100, balance: 100 },
Event::MemberRemoved { pool_id: 1, member: 100 },
Event::Withdrawn { member: 200, pool_id: 1, points: 200, balance: 200 },
Event::MemberRemoved { pool_id: 1, member: 200 }
]
);
});
}
#[test]
fn withdraw_unbonded_destroying_permissionless() {
ExtBuilder::default().add_members(vec![(100, 100)]).build_and_execute(|| {
// Given
assert_ok!(Pools::fully_unbond(RuntimeOrigin::signed(100), 100));
assert_eq!(
BondedPool::<Runtime>::get(1).unwrap(),
BondedPool {
id: 1,
inner: BondedPoolInner {
points: 10,
state: PoolState::Open,
member_counter: 2,
roles: DEFAULT_ROLES,
}
}
);
CurrentEra::set(StakingMock::bonding_duration());
assert_eq!(Balances::free_balance(100), 100);
// Cannot permissionlessly withdraw
assert_noop!(
Pools::fully_unbond(RuntimeOrigin::signed(420), 100),
Error::<Runtime>::NotKickerOrDestroying
);
// Given
unsafe_set_state(1, PoolState::Destroying);
// Can permissionlesly withdraw a member that is not the depositor
assert_ok!(Pools::withdraw_unbonded(RuntimeOrigin::signed(420), 100, 0));
assert_eq!(SubPoolsStorage::<Runtime>::get(1).unwrap(), Default::default(),);
assert_eq!(Balances::free_balance(100), 100 + 100);
assert!(!PoolMembers::<Runtime>::contains_key(100));
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: 100, pool_id: 1, bonded: 100, joined: true },
Event::Unbonded { member: 100, pool_id: 1, points: 100, balance: 100, era: 3 },
Event::Withdrawn { member: 100, pool_id: 1, points: 100, balance: 100 },
Event::MemberRemoved { pool_id: 1, member: 100 }
]
);
});
}
#[test]
fn partial_withdraw_unbonded_depositor() {
ExtBuilder::default().ed(1).build_and_execute(|| {
assert_ok!(Pools::bond_extra(RuntimeOrigin::signed(10), BondExtra::FreeBalance(10)));
unsafe_set_state(1, PoolState::Destroying);
// given
assert_ok!(Pools::unbond(RuntimeOrigin::signed(10), 10, 6));
CurrentEra::set(1);
assert_ok!(Pools::unbond(RuntimeOrigin::signed(10), 10, 1));
assert_eq!(
PoolMembers::<Runtime>::get(10).unwrap().unbonding_eras,
member_unbonding_eras!(3 => 6, 4 => 1)
);
assert_eq!(
SubPoolsStorage::<Runtime>::get(1).unwrap(),
SubPools {
no_era: Default::default(),
with_era: unbonding_pools_with_era! {
3 => UnbondPool { points: 6, balance: 6 },
4 => UnbondPool { points: 1, balance: 1 }
}
}
);
assert_eq!(PoolMembers::<Runtime>::get(10).unwrap().active_points(), 13);
assert_eq!(PoolMembers::<Runtime>::get(10).unwrap().unbonding_points(), 7);
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: 10, pool_id: 1, bonded: 10, joined: false },
Event::Unbonded { member: 10, pool_id: 1, points: 6, balance: 6, era: 3 },
Event::Unbonded { member: 10, pool_id: 1, points: 1, balance: 1, era: 4 }
]
);
// when
CurrentEra::set(2);
assert_noop!(
Pools::withdraw_unbonded(RuntimeOrigin::signed(10), 10, 0),
Error::<Runtime>::CannotWithdrawAny
);
// when
CurrentEra::set(3);
assert_ok!(Pools::withdraw_unbonded(RuntimeOrigin::signed(10), 10, 0));
// then
assert_eq!(
PoolMembers::<Runtime>::get(10).unwrap().unbonding_eras,
member_unbonding_eras!(4 => 1)
);
assert_eq!(
SubPoolsStorage::<Runtime>::get(1).unwrap(),
SubPools {
no_era: Default::default(),
with_era: unbonding_pools_with_era! {
4 => UnbondPool { points: 1, balance: 1 }
}
}
);
assert_eq!(
pool_events_since_last_call(),
vec![Event::Withdrawn { member: 10, pool_id: 1, points: 6, balance: 6 }]
);
// when
CurrentEra::set(4);
assert_ok!(Pools::withdraw_unbonded(RuntimeOrigin::signed(10), 10, 0));
// then
assert_eq!(
PoolMembers::<Runtime>::get(10).unwrap().unbonding_eras,
member_unbonding_eras!()
);
assert_eq!(SubPoolsStorage::<Runtime>::get(1).unwrap(), Default::default());
assert_eq!(
pool_events_since_last_call(),
vec![Event::Withdrawn { member: 10, pool_id: 1, points: 1, balance: 1 },]
);
// when repeating:
assert_noop!(
Pools::withdraw_unbonded(RuntimeOrigin::signed(10), 10, 0),
Error::<Runtime>::CannotWithdrawAny
);
});
}
#[test]
fn partial_withdraw_unbonded_non_depositor() {
ExtBuilder::default().add_members(vec![(11, 10)]).build_and_execute(|| {
// given
assert_ok!(Pools::unbond(RuntimeOrigin::signed(11), 11, 6));
CurrentEra::set(1);
assert_ok!(Pools::unbond(RuntimeOrigin::signed(11), 11, 1));
assert_eq!(
PoolMembers::<Runtime>::get(11).unwrap().unbonding_eras,
member_unbonding_eras!(3 => 6, 4 => 1)
);
assert_eq!(
SubPoolsStorage::<Runtime>::get(1).unwrap(),
SubPools {
no_era: Default::default(),
with_era: unbonding_pools_with_era! {
3 => UnbondPool { points: 6, balance: 6 },
4 => UnbondPool { points: 1, balance: 1 }
}
}
);
assert_eq!(PoolMembers::<Runtime>::get(11).unwrap().active_points(), 3);
assert_eq!(PoolMembers::<Runtime>::get(11).unwrap().unbonding_points(), 7);
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: 10, joined: true },
Event::Unbonded { member: 11, pool_id: 1, points: 6, balance: 6, era: 3 },
Event::Unbonded { member: 11, pool_id: 1, points: 1, balance: 1, era: 4 }
]
);
// when
CurrentEra::set(2);
assert_noop!(
Pools::withdraw_unbonded(RuntimeOrigin::signed(11), 11, 0),
Error::<Runtime>::CannotWithdrawAny
);
// when
CurrentEra::set(3);
assert_ok!(Pools::withdraw_unbonded(RuntimeOrigin::signed(11), 11, 0));
// then
assert_eq!(
PoolMembers::<Runtime>::get(11).unwrap().unbonding_eras,
member_unbonding_eras!(4 => 1)
);
assert_eq!(
SubPoolsStorage::<Runtime>::get(1).unwrap(),
SubPools {
no_era: Default::default(),
with_era: unbonding_pools_with_era! {
4 => UnbondPool { points: 1, balance: 1 }
}
}
);
assert_eq!(
pool_events_since_last_call(),
vec![Event::Withdrawn { member: 11, pool_id: 1, points: 6, balance: 6 }]
);
// when
CurrentEra::set(4);
assert_ok!(Pools::withdraw_unbonded(RuntimeOrigin::signed(11), 11, 0));
// then
assert_eq!(
PoolMembers::<Runtime>::get(11).unwrap().unbonding_eras,
member_unbonding_eras!()
);
assert_eq!(SubPoolsStorage::<Runtime>::get(1).unwrap(), Default::default());
assert_eq!(
pool_events_since_last_call(),
vec![Event::Withdrawn { member: 11, pool_id: 1, points: 1, balance: 1 }]
);
// when repeating:
assert_noop!(
Pools::withdraw_unbonded(RuntimeOrigin::signed(11), 11, 0),
Error::<Runtime>::CannotWithdrawAny
);
});
}
#[test]
fn full_multi_step_withdrawing_non_depositor() {
ExtBuilder::default().add_members(vec![(100, 100)]).build_and_execute(|| {
// given
assert_ok!(Pools::unbond(RuntimeOrigin::signed(100), 100, 75));
assert_eq!(
PoolMembers::<Runtime>::get(100).unwrap().unbonding_eras,
member_unbonding_eras!(3 => 75)
);
// progress one era and unbond the leftover.
CurrentEra::set(1);
assert_ok!(Pools::unbond(RuntimeOrigin::signed(100), 100, 25));
assert_eq!(
PoolMembers::<Runtime>::get(100).unwrap().unbonding_eras,
member_unbonding_eras!(3 => 75, 4 => 25)
);
assert_noop!(
Pools::withdraw_unbonded(RuntimeOrigin::signed(100), 100, 0),
Error::<Runtime>::CannotWithdrawAny
);
// now the 75 should be free.
CurrentEra::set(3);
assert_ok!(Pools::withdraw_unbonded(RuntimeOrigin::signed(100), 100, 0));
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: 100, pool_id: 1, bonded: 100, joined: true },
Event::Unbonded { member: 100, pool_id: 1, points: 75, balance: 75, era: 3 },
Event::Unbonded { member: 100, pool_id: 1, points: 25, balance: 25, era: 4 },
Event::Withdrawn { member: 100, pool_id: 1, points: 75, balance: 75 },
]
);
assert_eq!(
PoolMembers::<Runtime>::get(100).unwrap().unbonding_eras,
member_unbonding_eras!(4 => 25)
);
// the 25 should be free now, and the member removed.
CurrentEra::set(4);
assert_ok!(Pools::withdraw_unbonded(RuntimeOrigin::signed(100), 100, 0));
assert_eq!(
pool_events_since_last_call(),
vec![
Event::Withdrawn { member: 100, pool_id: 1, points: 25, balance: 25 },
Event::MemberRemoved { pool_id: 1, member: 100 }
]
);
})
}
#[test]
fn out_of_sync_unbonding_chunks() {
// the unbonding_eras in pool member are always fixed to the era at which they are unlocked,
// but the actual unbonding pools get pruned and might get combined in the no_era pool.
// Pools are only merged when one unbonds, so we unbond a little bit on every era to
// simulate this.
ExtBuilder::default()
.add_members(vec![(20, 100), (30, 100)])
.build_and_execute(|| {
System::reset_events();
// when
assert_ok!(Pools::unbond(RuntimeOrigin::signed(20), 20, 5));
assert_ok!(Pools::unbond(RuntimeOrigin::signed(30), 30, 5));
// then member-local unbonding is pretty much in sync with the global pools.
assert_eq!(
PoolMembers::<Runtime>::get(20).unwrap().unbonding_eras,
member_unbonding_eras!(3 => 5)
);
assert_eq!(
PoolMembers::<Runtime>::get(30).unwrap().unbonding_eras,
member_unbonding_eras!(3 => 5)
);
assert_eq!(
SubPoolsStorage::<Runtime>::get(1).unwrap(),
SubPools {
no_era: Default::default(),
with_era: unbonding_pools_with_era! {
3 => UnbondPool { points: 10, balance: 10 }
}
}
);
assert_eq!(
pool_events_since_last_call(),
vec![
Event::Unbonded { member: 20, pool_id: 1, points: 5, balance: 5, era: 3 },
Event::Unbonded { member: 30, pool_id: 1, points: 5, balance: 5, era: 3 },
]
);
// when
CurrentEra::set(1);
assert_ok!(Pools::unbond(RuntimeOrigin::signed(20), 20, 5));
// then still member-local unbonding is pretty much in sync with the global pools.
assert_eq!(
PoolMembers::<Runtime>::get(20).unwrap().unbonding_eras,
member_unbonding_eras!(3 => 5, 4 => 5)
);
assert_eq!(
SubPoolsStorage::<Runtime>::get(1).unwrap(),
SubPools {
no_era: Default::default(),
with_era: unbonding_pools_with_era! {
3 => UnbondPool { points: 10, balance: 10 },
4 => UnbondPool { points: 5, balance: 5 }
}
}
);
assert_eq!(
pool_events_since_last_call(),
vec![Event::Unbonded { member: 20, pool_id: 1, points: 5, balance: 5, era: 4 }]
);
// when
CurrentEra::set(2);
assert_ok!(Pools::unbond(RuntimeOrigin::signed(20), 20, 5));
// then still member-local unbonding is pretty much in sync with the global pools.
assert_eq!(
PoolMembers::<Runtime>::get(20).unwrap().unbonding_eras,
member_unbonding_eras!(3 => 5, 4 => 5, 5 => 5)
);
assert_eq!(
SubPoolsStorage::<Runtime>::get(1).unwrap(),
SubPools {
no_era: Default::default(),
with_era: unbonding_pools_with_era! {
3 => UnbondPool { points: 10, balance: 10 },
4 => UnbondPool { points: 5, balance: 5 },
5 => UnbondPool { points: 5, balance: 5 }
}
}
);
assert_eq!(
pool_events_since_last_call(),
vec![Event::Unbonded { member: 20, pool_id: 1, points: 5, balance: 5, era: 5 }]
);
// when
CurrentEra::set(5);
assert_ok!(Pools::unbond(RuntimeOrigin::signed(20), 20, 5));
// then
assert_eq!(
PoolMembers::<Runtime>::get(20).unwrap().unbonding_eras,
member_unbonding_eras!(3 => 5, 4 => 5, 5 => 5, 8 => 5)
);
assert_eq!(
SubPoolsStorage::<Runtime>::get(1).unwrap(),
SubPools {
// era 3 is merged into no_era.
no_era: UnbondPool { points: 10, balance: 10 },
with_era: unbonding_pools_with_era! {
4 => UnbondPool { points: 5, balance: 5 },
5 => UnbondPool { points: 5, balance: 5 },
8 => UnbondPool { points: 5, balance: 5 }
}
}
);
assert_eq!(
pool_events_since_last_call(),
vec![Event::Unbonded { member: 20, pool_id: 1, points: 5, balance: 5, era: 8 }]
);
// now we start withdrawing unlocked bonds.
// when
assert_ok!(Pools::withdraw_unbonded(RuntimeOrigin::signed(20), 20, 0));
// then
assert_eq!(
PoolMembers::<Runtime>::get(20).unwrap().unbonding_eras,
member_unbonding_eras!(8 => 5)
);
assert_eq!(
SubPoolsStorage::<Runtime>::get(1).unwrap(),
SubPools {
// era 3 is merged into no_era.
no_era: UnbondPool { points: 5, balance: 5 },
with_era: unbonding_pools_with_era! {
8 => UnbondPool { points: 5, balance: 5 }
}
}
);
assert_eq!(
pool_events_since_last_call(),
vec![Event::Withdrawn { member: 20, pool_id: 1, points: 15, balance: 15 }]
);
// when
assert_ok!(Pools::withdraw_unbonded(RuntimeOrigin::signed(30), 30, 0));
// then
assert_eq!(
PoolMembers::<Runtime>::get(30).unwrap().unbonding_eras,
member_unbonding_eras!()
);
assert_eq!(
SubPoolsStorage::<Runtime>::get(1).unwrap(),
SubPools {
// era 3 is merged into no_era.
no_era: Default::default(),
with_era: unbonding_pools_with_era! {
8 => UnbondPool { points: 5, balance: 5 }
}
}
);
assert_eq!(
pool_events_since_last_call(),
vec![Event::Withdrawn { member: 30, pool_id: 1, points: 5, balance: 5 }]
);
})
}
#[test]
fn full_multi_step_withdrawing_depositor() {
ExtBuilder::default().ed(1).build_and_execute(|| {
// depositor now has 20, they can unbond to 10.
assert_eq!(Pools::depositor_min_bond(), 10);
assert_ok!(Pools::bond_extra(RuntimeOrigin::signed(10), BondExtra::FreeBalance(10)));
// now they can.
assert_ok!(Pools::unbond(RuntimeOrigin::signed(10), 10, 7));
// progress one era and unbond the leftover.
CurrentEra::set(1);
assert_ok!(Pools::unbond(RuntimeOrigin::signed(10), 10, 3));
assert_eq!(
PoolMembers::<Runtime>::get(10).unwrap().unbonding_eras,
member_unbonding_eras!(3 => 7, 4 => 3)
);
// they can't unbond to a value below 10 other than 0..
assert_noop!(
Pools::unbond(RuntimeOrigin::signed(10), 10, 5),
Error::<Runtime>::MinimumBondNotMet
);
// but not even full, because they pool is not yet destroying.
assert_noop!(
Pools::unbond(RuntimeOrigin::signed(10), 10, 10),
Error::<Runtime>::MinimumBondNotMet
);
// but now they can.
unsafe_set_state(1, PoolState::Destroying);
assert_noop!(
Pools::unbond(RuntimeOrigin::signed(10), 10, 5),
Error::<Runtime>::MinimumBondNotMet
);
assert_ok!(Pools::unbond(RuntimeOrigin::signed(10), 10, 10));
// now the 7 should be free.
CurrentEra::set(3);
assert_ok!(Pools::withdraw_unbonded(RuntimeOrigin::signed(10), 10, 0));
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: 10, pool_id: 1, bonded: 10, joined: false },
Event::Unbonded { member: 10, pool_id: 1, balance: 7, points: 7, era: 3 },
Event::Unbonded { member: 10, pool_id: 1, balance: 3, points: 3, era: 4 },
Event::Unbonded { member: 10, pool_id: 1, balance: 10, points: 10, era: 4 },
Event::Withdrawn { member: 10, pool_id: 1, balance: 7, points: 7 }
]
);
assert_eq!(
PoolMembers::<Runtime>::get(10).unwrap().unbonding_eras,
member_unbonding_eras!(4 => 13)
);
// the 13 should be free now, and the member removed.
CurrentEra::set(4);
assert_ok!(Pools::withdraw_unbonded(RuntimeOrigin::signed(10), 10, 0));
assert_eq!(
pool_events_since_last_call(),
vec![
Event::Withdrawn { member: 10, pool_id: 1, points: 13, balance: 13 },
Event::MemberRemoved { pool_id: 1, member: 10 },
Event::Destroyed { pool_id: 1 },
]
);
assert!(!Metadata::<T>::contains_key(1));
})
}
}
mod create {
use super::*;
#[test]
fn create_works() {
ExtBuilder::default().build_and_execute(|| {
// next pool id is 2.
let next_pool_stash = Pools::create_bonded_account(2);
let ed = Balances::minimum_balance();
assert!(!BondedPools::<Runtime>::contains_key(2));
assert!(!RewardPools::<Runtime>::contains_key(2));
assert!(!PoolMembers::<Runtime>::contains_key(11));
assert_eq!(StakingMock::active_stake(&next_pool_stash), None);
Balances::make_free_balance_be(&11, StakingMock::minimum_bond() + ed);
assert_ok!(Pools::create(
RuntimeOrigin::signed(11),
StakingMock::minimum_bond(),
123,
456,
789
));
assert_eq!(Balances::free_balance(&11), 0);
assert_eq!(
PoolMembers::<Runtime>::get(11).unwrap(),
PoolMember {
pool_id: 2,
points: StakingMock::minimum_bond(),
..Default::default()
}
);
assert_eq!(
BondedPool::<Runtime>::get(2).unwrap(),
BondedPool {
id: 2,
inner: BondedPoolInner {
points: StakingMock::minimum_bond(),
member_counter: 1,
state: PoolState::Open,
roles: PoolRoles {
depositor: 11,
root: Some(123),
nominator: Some(456),
state_toggler: Some(789)
}
}
}
);
assert_eq!(
StakingMock::active_stake(&next_pool_stash).unwrap(),
StakingMock::minimum_bond()
);
assert_eq!(
RewardPools::<Runtime>::get(2).unwrap(),
RewardPool { ..Default::default() }
);
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::Created { depositor: 11, pool_id: 2 },
Event::Bonded { member: 11, pool_id: 2, bonded: 10, joined: true }
]
);
});
}
#[test]
fn create_errors_correctly() {
ExtBuilder::default().with_check(0).build_and_execute(|| {
assert_noop!(
Pools::create(RuntimeOrigin::signed(10), 420, 123, 456, 789),
Error::<Runtime>::AccountBelongsToOtherPool
);
// Given
assert_eq!(MinCreateBond::<Runtime>::get(), 2);
assert_eq!(StakingMock::minimum_bond(), 10);
// Then
assert_noop!(
Pools::create(RuntimeOrigin::signed(11), 9, 123, 456, 789),
Error::<Runtime>::MinimumBondNotMet
);
// Given
MinCreateBond::<Runtime>::put(20);
// Then
assert_noop!(
Pools::create(RuntimeOrigin::signed(11), 19, 123, 456, 789),
Error::<Runtime>::MinimumBondNotMet
);
// Given
BondedPool::<Runtime> {
id: 2,
inner: BondedPoolInner {
state: PoolState::Open,
points: 10,
member_counter: 1,
roles: DEFAULT_ROLES,
},
}
.put();
assert_eq!(MaxPools::<Runtime>::get(), Some(2));
assert_eq!(BondedPools::<Runtime>::count(), 2);
// Then
assert_noop!(
Pools::create(RuntimeOrigin::signed(11), 20, 123, 456, 789),
Error::<Runtime>::MaxPools
);
// Given
assert_eq!(PoolMembers::<Runtime>::count(), 1);
MaxPools::<Runtime>::put(3);
MaxPoolMembers::<Runtime>::put(1);
Balances::make_free_balance_be(&11, 5 + 20);
// Then
let create = RuntimeCall::Pools(crate::Call::<Runtime>::create {
amount: 20,
root: 11,
nominator: 11,
state_toggler: 11,
});
assert_noop!(
create.dispatch(RuntimeOrigin::signed(11)),
Error::<Runtime>::MaxPoolMembers
);
});
}
}
mod nominate {
use super::*;
#[test]
fn nominate_works() {
ExtBuilder::default().build_and_execute(|| {
// Depositor can't nominate
assert_noop!(
Pools::nominate(RuntimeOrigin::signed(10), 1, vec![21]),
Error::<Runtime>::NotNominator
);
// State toggler can't nominate
assert_noop!(
Pools::nominate(RuntimeOrigin::signed(902), 1, vec![21]),
Error::<Runtime>::NotNominator
);
// Root can nominate
assert_ok!(Pools::nominate(RuntimeOrigin::signed(900), 1, vec![21]));
assert_eq!(Nominations::get().unwrap(), vec![21]);
// Nominator can nominate
assert_ok!(Pools::nominate(RuntimeOrigin::signed(901), 1, vec![31]));
assert_eq!(Nominations::get().unwrap(), vec![31]);
// Can't nominate for a pool that doesn't exist
assert_noop!(
Pools::nominate(RuntimeOrigin::signed(902), 123, vec![21]),
Error::<Runtime>::PoolNotFound
);
});
}
}
mod set_state {
use super::*;
#[test]
fn set_state_works() {
ExtBuilder::default().build_and_execute(|| {
// Given
assert_ok!(BondedPool::<Runtime>::get(1).unwrap().ok_to_be_open(0));
// Only the root and state toggler can change the state when the pool is ok to be open.
assert_noop!(
Pools::set_state(RuntimeOrigin::signed(10), 1, PoolState::Blocked),
Error::<Runtime>::CanNotChangeState
);
assert_noop!(
Pools::set_state(RuntimeOrigin::signed(901), 1, PoolState::Blocked),
Error::<Runtime>::CanNotChangeState
);
// Root can change state
assert_ok!(Pools::set_state(RuntimeOrigin::signed(900), 1, PoolState::Blocked));
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::StateChanged { pool_id: 1, new_state: PoolState::Blocked }
]
);
assert_eq!(BondedPool::<Runtime>::get(1).unwrap().state, PoolState::Blocked);
// State toggler can change state
assert_ok!(Pools::set_state(RuntimeOrigin::signed(902), 1, PoolState::Destroying));
assert_eq!(BondedPool::<Runtime>::get(1).unwrap().state, PoolState::Destroying);
// If the pool is destroying, then no one can set state
assert_noop!(
Pools::set_state(RuntimeOrigin::signed(900), 1, PoolState::Blocked),
Error::<Runtime>::CanNotChangeState
);
assert_noop!(
Pools::set_state(RuntimeOrigin::signed(902), 1, PoolState::Blocked),
Error::<Runtime>::CanNotChangeState
);
// If the pool is not ok to be open, then anyone can set it to destroying
// Given
unsafe_set_state(1, PoolState::Open);
let mut bonded_pool = BondedPool::<Runtime>::get(1).unwrap();
bonded_pool.points = 100;
bonded_pool.put();
// When
assert_ok!(Pools::set_state(RuntimeOrigin::signed(11), 1, PoolState::Destroying));
// Then
assert_eq!(BondedPool::<Runtime>::get(1).unwrap().state, PoolState::Destroying);
// Given
Balances::make_free_balance_be(&default_bonded_account(), Balance::max_value() / 10);
unsafe_set_state(1, PoolState::Open);
// When
assert_ok!(Pools::set_state(RuntimeOrigin::signed(11), 1, PoolState::Destroying));
// Then
assert_eq!(BondedPool::<Runtime>::get(1).unwrap().state, PoolState::Destroying);
// If the pool is not ok to be open, it cannot be permissionlessly set to a state that
// isn't destroying
unsafe_set_state(1, PoolState::Open);
assert_noop!(
Pools::set_state(RuntimeOrigin::signed(11), 1, PoolState::Blocked),
Error::<Runtime>::CanNotChangeState
);
assert_eq!(
pool_events_since_last_call(),
vec![
Event::StateChanged { pool_id: 1, new_state: PoolState::Destroying },
Event::StateChanged { pool_id: 1, new_state: PoolState::Destroying },
Event::StateChanged { pool_id: 1, new_state: PoolState::Destroying }
]
);
});
}
}
mod set_metadata {
use super::*;
#[test]
fn set_metadata_works() {
ExtBuilder::default().build_and_execute(|| {
// Root can set metadata
assert_ok!(Pools::set_metadata(RuntimeOrigin::signed(900), 1, vec![1, 1]));
assert_eq!(Metadata::<Runtime>::get(1), vec![1, 1]);
// State toggler can set metadata
assert_ok!(Pools::set_metadata(RuntimeOrigin::signed(902), 1, vec![2, 2]));
assert_eq!(Metadata::<Runtime>::get(1), vec![2, 2]);
// Depositor can't set metadata
assert_noop!(
Pools::set_metadata(RuntimeOrigin::signed(10), 1, vec![3, 3]),
Error::<Runtime>::DoesNotHavePermission
);
// Nominator can't set metadata
assert_noop!(
Pools::set_metadata(RuntimeOrigin::signed(901), 1, vec![3, 3]),
Error::<Runtime>::DoesNotHavePermission
);
// Metadata cannot be longer than `MaxMetadataLen`
assert_noop!(
Pools::set_metadata(RuntimeOrigin::signed(900), 1, vec![1, 1, 1]),
Error::<Runtime>::MetadataExceedsMaxLen
);
});
}
}
mod set_configs {
use super::*;
#[test]
fn set_configs_works() {
ExtBuilder::default().build_and_execute(|| {
// Setting works
assert_ok!(Pools::set_configs(
RuntimeOrigin::root(),
ConfigOp::Set(1 as Balance),
ConfigOp::Set(2 as Balance),
ConfigOp::Set(3u32),
ConfigOp::Set(4u32),
ConfigOp::Set(5u32),
));
assert_eq!(MinJoinBond::<Runtime>::get(), 1);
assert_eq!(MinCreateBond::<Runtime>::get(), 2);
assert_eq!(MaxPools::<Runtime>::get(), Some(3));
assert_eq!(MaxPoolMembers::<Runtime>::get(), Some(4));
assert_eq!(MaxPoolMembersPerPool::<Runtime>::get(), Some(5));
// Noop does nothing
assert_storage_noop!(assert_ok!(Pools::set_configs(
RuntimeOrigin::root(),
ConfigOp::Noop,
ConfigOp::Noop,
ConfigOp::Noop,
ConfigOp::Noop,
ConfigOp::Noop,
)));
// Removing works
assert_ok!(Pools::set_configs(
RuntimeOrigin::root(),
ConfigOp::Remove,
ConfigOp::Remove,
ConfigOp::Remove,
ConfigOp::Remove,
ConfigOp::Remove,
));
assert_eq!(MinJoinBond::<Runtime>::get(), 0);
assert_eq!(MinCreateBond::<Runtime>::get(), 0);
assert_eq!(MaxPools::<Runtime>::get(), None);
assert_eq!(MaxPoolMembers::<Runtime>::get(), None);
assert_eq!(MaxPoolMembersPerPool::<Runtime>::get(), None);
});
}
}
mod bond_extra {
use super::*;
use crate::Event;
#[test]
fn bond_extra_from_free_balance_creator() {
ExtBuilder::default().build_and_execute(|| {
// 10 is the owner and a member in pool 1, give them some more funds.
Balances::make_free_balance_be(&10, 100);
// given
assert_eq!(PoolMembers::<Runtime>::get(10).unwrap().points, 10);
assert_eq!(BondedPools::<Runtime>::get(1).unwrap().points, 10);
assert_eq!(Balances::free_balance(10), 100);
// when
assert_ok!(Pools::bond_extra(RuntimeOrigin::signed(10), BondExtra::FreeBalance(10)));
// then
assert_eq!(Balances::free_balance(10), 90);
assert_eq!(PoolMembers::<Runtime>::get(10).unwrap().points, 20);
assert_eq!(BondedPools::<Runtime>::get(1).unwrap().points, 20);
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: 10, pool_id: 1, bonded: 10, joined: false }
]
);
// when
assert_ok!(Pools::bond_extra(RuntimeOrigin::signed(10), BondExtra::FreeBalance(20)));
// then
assert_eq!(Balances::free_balance(10), 70);
assert_eq!(PoolMembers::<Runtime>::get(10).unwrap().points, 40);
assert_eq!(BondedPools::<Runtime>::get(1).unwrap().points, 40);
assert_eq!(
pool_events_since_last_call(),
vec![Event::Bonded { member: 10, pool_id: 1, bonded: 20, joined: false }]
);
})
}
#[test]
fn bond_extra_from_rewards_creator() {
ExtBuilder::default().build_and_execute(|| {
// put some money in the reward account, all of which will belong to 10 as the only
// member of the pool.
Balances::make_free_balance_be(&default_reward_account(), 7);
// ... if which only 2 is claimable to make sure the reward account does not die.
let claimable_reward = 7 - ExistentialDeposit::get();
// given
assert_eq!(PoolMembers::<Runtime>::get(10).unwrap().points, 10);
assert_eq!(BondedPools::<Runtime>::get(1).unwrap().points, 10);
assert_eq!(Balances::free_balance(10), 35);
// when
assert_ok!(Pools::bond_extra(RuntimeOrigin::signed(10), BondExtra::Rewards));
// then
assert_eq!(Balances::free_balance(10), 35);
assert_eq!(PoolMembers::<Runtime>::get(10).unwrap().points, 10 + claimable_reward);
assert_eq!(BondedPools::<Runtime>::get(1).unwrap().points, 10 + claimable_reward);
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::PaidOut { member: 10, pool_id: 1, payout: claimable_reward },
Event::Bonded {
member: 10,
pool_id: 1,
bonded: claimable_reward,
joined: false
}
]
);
})
}
#[test]
fn bond_extra_from_rewards_joiner() {
ExtBuilder::default().add_members(vec![(20, 20)]).build_and_execute(|| {
// put some money in the reward account, all of which will belong to 10 as the only
// member of the pool.
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);
// when
assert_ok!(Pools::bond_extra(RuntimeOrigin::signed(10), BondExtra::Rewards));
// then
assert_eq!(Balances::free_balance(10), 35);
// 10's share of the reward is 1/3, since they gave 10/30 of the total shares.
assert_eq!(PoolMembers::<Runtime>::get(10).unwrap().points, 10 + 1);
assert_eq!(BondedPools::<Runtime>::get(1).unwrap().points, 30 + 1);
// when
assert_ok!(Pools::bond_extra(RuntimeOrigin::signed(20), BondExtra::Rewards));
// 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);
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: 20, pool_id: 1, bonded: 20, joined: true },
Event::PaidOut { member: 10, pool_id: 1, payout: 1 },
Event::Bonded { member: 10, pool_id: 1, bonded: 1, joined: false },
Event::PaidOut { member: 20, pool_id: 1, payout: 2 },
Event::Bonded { member: 20, pool_id: 1, bonded: 2, joined: false }
]
);
})
}
}
mod update_roles {
use super::*;
#[test]
fn update_roles_works() {
ExtBuilder::default().build_and_execute(|| {
assert_eq!(
BondedPools::<Runtime>::get(1).unwrap().roles,
PoolRoles {
depositor: 10,
root: Some(900),
nominator: Some(901),
state_toggler: Some(902)
},
);
// non-existent pools
assert_noop!(
Pools::update_roles(
RuntimeOrigin::signed(1),
2,
ConfigOp::Set(5),
ConfigOp::Set(6),
ConfigOp::Set(7)
),
Error::<Runtime>::PoolNotFound,
);
// depositor cannot change roles.
assert_noop!(
Pools::update_roles(
RuntimeOrigin::signed(1),
1,
ConfigOp::Set(5),
ConfigOp::Set(6),
ConfigOp::Set(7)
),
Error::<Runtime>::DoesNotHavePermission,
);
// nominator cannot change roles.
assert_noop!(
Pools::update_roles(
RuntimeOrigin::signed(901),
1,
ConfigOp::Set(5),
ConfigOp::Set(6),
ConfigOp::Set(7)
),
Error::<Runtime>::DoesNotHavePermission,
);
// state-toggler
assert_noop!(
Pools::update_roles(
RuntimeOrigin::signed(902),
1,
ConfigOp::Set(5),
ConfigOp::Set(6),
ConfigOp::Set(7)
),
Error::<Runtime>::DoesNotHavePermission,
);
// but root can
assert_ok!(Pools::update_roles(
RuntimeOrigin::signed(900),
1,
ConfigOp::Set(5),
ConfigOp::Set(6),
ConfigOp::Set(7)
));
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::RolesUpdated {
root: Some(5),
state_toggler: Some(7),
nominator: Some(6)
}
]
);
assert_eq!(
BondedPools::<Runtime>::get(1).unwrap().roles,
PoolRoles {
depositor: 10,
root: Some(5),
nominator: Some(6),
state_toggler: Some(7)
},
);
// also root origin can
assert_ok!(Pools::update_roles(
RuntimeOrigin::root(),
1,
ConfigOp::Set(1),
ConfigOp::Set(2),
ConfigOp::Set(3)
));
assert_eq!(
pool_events_since_last_call(),
vec![Event::RolesUpdated {
root: Some(1),
state_toggler: Some(3),
nominator: Some(2)
}]
);
assert_eq!(
BondedPools::<Runtime>::get(1).unwrap().roles,
PoolRoles {
depositor: 10,
root: Some(1),
nominator: Some(2),
state_toggler: Some(3)
},
);
// Noop works
assert_ok!(Pools::update_roles(
RuntimeOrigin::root(),
1,
ConfigOp::Set(11),
ConfigOp::Noop,
ConfigOp::Noop
));
assert_eq!(
pool_events_since_last_call(),
vec![Event::RolesUpdated {
root: Some(11),
state_toggler: Some(3),
nominator: Some(2)
}]
);
assert_eq!(
BondedPools::<Runtime>::get(1).unwrap().roles,
PoolRoles {
depositor: 10,
root: Some(11),
nominator: Some(2),
state_toggler: Some(3)
},
);
// Remove works
assert_ok!(Pools::update_roles(
RuntimeOrigin::root(),
1,
ConfigOp::Set(69),
ConfigOp::Remove,
ConfigOp::Remove
));
assert_eq!(
pool_events_since_last_call(),
vec![Event::RolesUpdated { root: Some(69), state_toggler: None, nominator: None }]
);
assert_eq!(
BondedPools::<Runtime>::get(1).unwrap().roles,
PoolRoles { depositor: 10, root: Some(69), nominator: None, state_toggler: None },
);
})
}
}
mod reward_counter_precision {
use sp_runtime::FixedU128;
use super::*;
const DOT: Balance = 10u128.pow(10u32);
const POLKADOT_TOTAL_ISSUANCE_GENESIS: Balance = DOT * 10u128.pow(9u32);
const fn inflation(years: u128) -> u128 {
let mut i = 0;
let mut start = POLKADOT_TOTAL_ISSUANCE_GENESIS;
while i < years {
start = start + start / 10;
i += 1
}
start
}
fn default_pool_reward_counter() -> FixedU128 {
RewardPools::<T>::get(1)
.unwrap()
.current_reward_counter(1, BondedPools::<T>::get(1).unwrap().points)
.unwrap()
}
fn pending_rewards(of: AccountId) -> Option<BalanceOf<T>> {
let member = PoolMembers::<T>::get(of).unwrap();
assert_eq!(member.pool_id, 1);
let rc = default_pool_reward_counter();
member.pending_rewards(rc).ok()
}
#[test]
fn smallest_claimable_reward() {
// create a pool that has all of the polkadot issuance in 50 years.
let pool_bond = inflation(50);
ExtBuilder::default().ed(DOT).min_bond(pool_bond).build_and_execute(|| {
assert_eq!(
pool_events_since_last_call(),
vec![
Event::Created { depositor: 10, pool_id: 1 },
Event::Bonded {
member: 10,
pool_id: 1,
bonded: 1173908528796953165005,
joined: true,
}
]
);
// the smallest reward that this pool can handle is
let expected_smallest_reward = inflation(50) / 10u128.pow(18);
// tad bit less. cannot be paid out.
assert_ok!(Balances::mutate_account(&default_reward_account(), |a| a.free +=
expected_smallest_reward - 1));
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(10)));
assert_eq!(pool_events_since_last_call(), vec![]);
// revert it.
assert_ok!(Balances::mutate_account(&default_reward_account(), |a| a.free -=
expected_smallest_reward - 1));
// tad bit more. can be claimed.
assert_ok!(Balances::mutate_account(&default_reward_account(), |a| a.free +=
expected_smallest_reward + 1));
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(10)));
assert_eq!(
pool_events_since_last_call(),
vec![Event::PaidOut { member: 10, pool_id: 1, payout: 1173 }]
);
})
}
#[test]
fn reward_counter_calc_wont_fail_in_normal_polkadot_future() {
// create a pool that has roughly half of the polkadot issuance in 10 years.
let pool_bond = inflation(10) / 2;
ExtBuilder::default().ed(DOT).min_bond(pool_bond).build_and_execute(|| {
assert_eq!(
pool_events_since_last_call(),
vec![
Event::Created { depositor: 10, pool_id: 1 },
Event::Bonded {
member: 10,
pool_id: 1,
bonded: 12_968_712_300_500_000_000,
joined: true,
}
]
);
// in 10 years, the total claimed rewards are large values as well. assuming that a pool
// is earning all of the inflation per year (which is really unrealistic, but worse
// case), that will be:
let pool_total_earnings_10_years = inflation(10) - POLKADOT_TOTAL_ISSUANCE_GENESIS;
assert_ok!(Balances::mutate_account(&default_reward_account(), |a| a.free +=
pool_total_earnings_10_years));
// some whale now joins with the other half ot the total issuance. This will bloat all
// the calculation regarding current reward counter.
Balances::make_free_balance_be(&20, pool_bond * 2);
assert_ok!(Pools::join(RuntimeOrigin::signed(20), pool_bond, 1));
assert_eq!(
pool_events_since_last_call(),
vec![Event::Bonded {
member: 20,
pool_id: 1,
bonded: 12_968_712_300_500_000_000,
joined: true
}]
);
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(10)));
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(20)));
assert_eq!(
pool_events_since_last_call(),
vec![Event::PaidOut { member: 10, pool_id: 1, payout: 15937424600999999996 }]
);
// now let a small member join with 10 DOTs.
Balances::make_free_balance_be(&30, 20 * DOT);
assert_ok!(Pools::join(RuntimeOrigin::signed(30), 10 * DOT, 1));
// and give a reasonably small reward to the pool.
assert_ok!(Balances::mutate_account(&default_reward_account(), |a| a.free += DOT));
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(30)));
assert_eq!(
pool_events_since_last_call(),
vec![
Event::Bonded { member: 30, pool_id: 1, bonded: 100000000000, joined: true },
// quite small, but working fine.
Event::PaidOut { member: 30, pool_id: 1, payout: 38 }
]
);
})
}
#[test]
fn reward_counter_update_can_fail_if_pool_is_highly_slashed() {
// create a pool that has roughly half of the polkadot issuance in 10 years.
let pool_bond = inflation(10) / 2;
ExtBuilder::default().ed(DOT).min_bond(pool_bond).build_and_execute(|| {
assert_eq!(
pool_events_since_last_call(),
vec![
Event::Created { depositor: 10, pool_id: 1 },
Event::Bonded {
member: 10,
pool_id: 1,
bonded: 12_968_712_300_500_000_000,
joined: true,
}
]
);
// slash this pool by 99% of that.
StakingMock::set_bonded_balance(default_bonded_account(), DOT + pool_bond / 100);
// some whale now joins with the other half ot the total issuance. This will trigger an
// overflow. This test is actually a bit too lenient because all the reward counters are
// set to zero. In other tests that we want to assert a scenario won't fail, we should
// also set the reward counters to some large value.
Balances::make_free_balance_be(&20, pool_bond * 2);
assert_err!(
Pools::join(RuntimeOrigin::signed(20), pool_bond, 1),
Error::<T>::OverflowRisk
);
})
}
#[test]
fn if_small_member_waits_long_enough_they_will_earn_rewards() {
// create a pool that has a quarter of the current polkadot issuance
ExtBuilder::default()
.ed(DOT)
.min_bond(POLKADOT_TOTAL_ISSUANCE_GENESIS / 4)
.build_and_execute(|| {
assert_eq!(
pool_events_since_last_call(),
vec![
Event::Created { depositor: 10, pool_id: 1 },
Event::Bonded {
member: 10,
pool_id: 1,
bonded: 2500000000000000000,
joined: true,
}
]
);
// and have a tiny fish join the pool as well..
Balances::make_free_balance_be(&20, 20 * DOT);
assert_ok!(Pools::join(RuntimeOrigin::signed(20), 10 * DOT, 1));
// earn some small rewards
assert_ok!(
Balances::mutate_account(&default_reward_account(), |a| a.free += DOT / 1000)
);
// no point in claiming for 20 (nonetheless, it should be harmless)
assert!(pending_rewards(20).unwrap().is_zero());
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(10)));
assert_eq!(
pool_events_since_last_call(),
vec![
Event::Bonded {
member: 20,
pool_id: 1,
bonded: 100000000000,
joined: true
},
Event::PaidOut { member: 10, pool_id: 1, payout: 9999997 }
]
);
// earn some small more, still nothing can be claimed for 20, but 10 claims their
// share.
assert_ok!(
Balances::mutate_account(&default_reward_account(), |a| a.free += DOT / 1000)
);
assert!(pending_rewards(20).unwrap().is_zero());
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(10)));
assert_eq!(
pool_events_since_last_call(),
vec![Event::PaidOut { member: 10, pool_id: 1, payout: 10000000 }]
);
// earn some more rewards, this time 20 can also claim.
assert_ok!(
Balances::mutate_account(&default_reward_account(), |a| a.free += DOT / 1000)
);
assert_eq!(pending_rewards(20).unwrap(), 1);
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(10)));
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(20)));
assert_eq!(
pool_events_since_last_call(),
vec![
Event::PaidOut { member: 10, pool_id: 1, payout: 10000000 },
Event::PaidOut { member: 20, pool_id: 1, payout: 1 }
]
);
});
}
#[test]
fn zero_reward_claim_does_not_update_reward_counter() {
// create a pool that has a quarter of the current polkadot issuance
ExtBuilder::default()
.ed(DOT)
.min_bond(POLKADOT_TOTAL_ISSUANCE_GENESIS / 4)
.build_and_execute(|| {
assert_eq!(
pool_events_since_last_call(),
vec![
Event::Created { depositor: 10, pool_id: 1 },
Event::Bonded {
member: 10,
pool_id: 1,
bonded: 2500000000000000000,
joined: true,
}
]
);
// and have a tiny fish join the pool as well..
Balances::make_free_balance_be(&20, 20 * DOT);
assert_ok!(Pools::join(RuntimeOrigin::signed(20), 10 * DOT, 1));
// earn some small rewards
assert_ok!(
Balances::mutate_account(&default_reward_account(), |a| a.free += DOT / 1000)
);
// if 20 claims now, their reward counter should stay the same, so that they have a
// chance of claiming this if they let it accumulate. Also see
// `if_small_member_waits_long_enough_they_will_earn_rewards`
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(10)));
assert_ok!(Pools::claim_payout(RuntimeOrigin::signed(20)));
assert_eq!(
pool_events_since_last_call(),
vec![
Event::Bonded {
member: 20,
pool_id: 1,
bonded: 100000000000,
joined: true
},
Event::PaidOut { member: 10, pool_id: 1, payout: 9999997 }
]
);
let current_reward_counter = default_pool_reward_counter();
// has been updated, because they actually claimed something.
assert_eq!(
PoolMembers::<T>::get(10).unwrap().last_recorded_reward_counter,
current_reward_counter
);
// has not be updated, even though the claim transaction went through okay.
assert_eq!(
PoolMembers::<T>::get(20).unwrap().last_recorded_reward_counter,
Default::default()
);
});
}
}
// NOTE: run this with debug_assertions, but in release mode.
#[cfg(feature = "fuzz-test")]
mod fuzz_test {
use super::*;
use crate::pallet::{Call as PoolsCall, Event as PoolsEvents};
use frame_support::traits::UnfilteredDispatchable;
use rand::{seq::SliceRandom, thread_rng, Rng};
use sp_runtime::{assert_eq_error_rate, Perquintill};
const ERA: BlockNumber = 1000;
const MAX_ED_MULTIPLE: Balance = 10_000;
const MIN_ED_MULTIPLE: Balance = 10;
// not quite elegant, just to make it available in random_signed_origin.
const REWARD_AGENT_ACCOUNT: AccountId = 42;
/// Grab random accounts, either known ones, or new ones.
fn random_signed_origin<R: Rng>(rng: &mut R) -> (RuntimeOrigin, AccountId) {
let count = PoolMembers::<T>::count();
if rng.gen::<bool>() && count > 0 {
// take an existing account.
let skip = rng.gen_range(0..count as usize);
// this is tricky: the account might be our reward agent, which we never want to be
// randomly chosen here. Try another one, or, if it is only our agent, return a random
// one nonetheless.
let candidate = PoolMembers::<T>::iter_keys().skip(skip).take(1).next().unwrap();
let acc =
if candidate == REWARD_AGENT_ACCOUNT { rng.gen::<AccountId>() } else { candidate };
(RuntimeOrigin::signed(acc), acc)
} else {
// create a new account
let acc = rng.gen::<AccountId>();
(RuntimeOrigin::signed(acc), acc)
}
}
fn random_ed_multiple<R: Rng>(rng: &mut R) -> Balance {
let multiple = rng.gen_range(MIN_ED_MULTIPLE..MAX_ED_MULTIPLE);
ExistentialDeposit::get() * multiple
}
fn fund_account<R: Rng>(rng: &mut R, account: &AccountId) {
let target_amount = random_ed_multiple(rng);
if let Some(top_up) = target_amount.checked_sub(Balances::free_balance(account)) {
let _ = Balances::deposit_creating(account, top_up);
}
assert!(Balances::free_balance(account) >= target_amount);
}
fn random_existing_pool<R: Rng>(mut rng: &mut R) -> Option<PoolId> {
BondedPools::<T>::iter_keys().collect::<Vec<_>>().choose(&mut rng).map(|x| *x)
}
fn random_call<R: Rng>(mut rng: &mut R) -> (crate::pallet::Call<T>, RuntimeOrigin) {
let op = rng.gen::<usize>();
let mut op_count =
<crate::pallet::Call<T> as frame_support::dispatch::GetCallName>::get_call_names()
.len();
// Exclude set_state, set_metadata, set_configs, update_roles and chill.
op_count -= 5;
match op % op_count {
0 => {
// join
let pool_id = random_existing_pool(&mut rng).unwrap_or_default();
let (origin, who) = random_signed_origin(&mut rng);
fund_account(&mut rng, &who);
let amount = random_ed_multiple(&mut rng);
(PoolsCall::<T>::join { amount, pool_id }, origin)
},
1 => {
// bond_extra
let (origin, who) = random_signed_origin(&mut rng);
let extra = if rng.gen::<bool>() {
BondExtra::Rewards
} else {
fund_account(&mut rng, &who);
let amount = random_ed_multiple(&mut rng);
BondExtra::FreeBalance(amount)
};
(PoolsCall::<T>::bond_extra { extra }, origin)
},
2 => {
// claim_payout
let (origin, _) = random_signed_origin(&mut rng);
(PoolsCall::<T>::claim_payout {}, origin)
},
3 => {
// unbond
let (origin, who) = random_signed_origin(&mut rng);
let amount = random_ed_multiple(&mut rng);
(PoolsCall::<T>::unbond { member_account: who, unbonding_points: amount }, origin)
},
4 => {
// pool_withdraw_unbonded
let pool_id = random_existing_pool(&mut rng).unwrap_or_default();
let (origin, _) = random_signed_origin(&mut rng);
(PoolsCall::<T>::pool_withdraw_unbonded { pool_id, num_slashing_spans: 0 }, origin)
},
5 => {
// withdraw_unbonded
let (origin, who) = random_signed_origin(&mut rng);
(
PoolsCall::<T>::withdraw_unbonded {
member_account: who,
num_slashing_spans: 0,
},
origin,
)
},
6 => {
// create
let (origin, who) = random_signed_origin(&mut rng);
let amount = random_ed_multiple(&mut rng);
fund_account(&mut rng, &who);
let root = who.clone();
let state_toggler = who.clone();
let nominator = who.clone();
(PoolsCall::<T>::create { amount, root, state_toggler, nominator }, origin)
},
7 => {
// nominate
let (origin, _) = random_signed_origin(&mut rng);
let pool_id = random_existing_pool(&mut rng).unwrap_or_default();
let validators = Default::default();
(PoolsCall::<T>::nominate { pool_id, validators }, origin)
},
_ => unreachable!(),
}
}
#[derive(Default)]
struct RewardAgent {
who: AccountId,
pool_id: Option<PoolId>,
expected_reward: Balance,
}
// TODO: inject some slashes into the game.
impl RewardAgent {
fn new(who: AccountId) -> Self {
Self { who, ..Default::default() }
}
fn join(&mut self) {
if self.pool_id.is_some() {
return
}
let pool_id = LastPoolId::<T>::get();
let amount = 10 * ExistentialDeposit::get();
let origin = RuntimeOrigin::signed(self.who);
let _ = Balances::deposit_creating(&self.who, 10 * amount);
self.pool_id = Some(pool_id);
log::info!(target: "reward-agent", "🤖 reward agent joining in {} with {}", pool_id, amount);
assert_ok!(PoolsCall::join::<T> { amount, pool_id }.dispatch_bypass_filter(origin));
}
fn claim_payout(&mut self) {
// 10 era later, we claim our payout. We expect our income to be roughly what we
// calculated.
if !PoolMembers::<T>::contains_key(&self.who) {
log!(warn, "reward agent is not in the pool yet, cannot claim");
return
}
let pre = Balances::free_balance(&42);
let origin = RuntimeOrigin::signed(42);
assert_ok!(PoolsCall::<T>::claim_payout {}.dispatch_bypass_filter(origin));
let post = Balances::free_balance(&42);
let income = post - pre;
log::info!(
target: "reward-agent", "🤖 CLAIM: actual: {}, expected: {}",
income,
self.expected_reward,
);
assert_eq_error_rate!(income, self.expected_reward, 10);
self.expected_reward = 0;
}
}
#[test]
fn fuzz_test() {
let mut reward_agent = RewardAgent::new(42);
sp_tracing::try_init_simple();
// NOTE: use this to get predictable (non)randomness:
// use::{rngs::SmallRng, SeedableRng};
// let mut rng = SmallRng::from_seed([0u8; 32]);
let mut rng = thread_rng();
let mut ext = sp_io::TestExternalities::new_empty();
// NOTE: sadly events don't fulfill the requirements of hashmap or btreemap.
let mut events_histogram = Vec::<(PoolsEvents<T>, u32)>::default();
let mut iteration = 0 as BlockNumber;
let mut ok = 0;
let mut err = 0;
ext.execute_with(|| {
MaxPoolMembers::<T>::set(Some(10_000));
MaxPoolMembersPerPool::<T>::set(Some(1000));
MaxPools::<T>::set(Some(1_000));
MinCreateBond::<T>::set(10 * ExistentialDeposit::get());
MinJoinBond::<T>::set(5 * ExistentialDeposit::get());
System::set_block_number(1);
});
ExistentialDeposit::set(10u128.pow(12u32));
BondingDuration::set(8);
loop {
ext.execute_with(|| {
iteration += 1;
let (call, origin) = random_call(&mut rng);
let outcome = call.clone().dispatch_bypass_filter(origin.clone());
match outcome {
Ok(_) => ok += 1,
Err(_) => err += 1,
};
log!(
debug,
"iteration {}, call {:?}, origin {:?}, outcome: {:?}, so far {} ok {} err",
iteration,
call,
origin,
outcome,
ok,
err,
);
// possibly join the reward_agent
if iteration > ERA / 2 && BondedPools::<T>::count() > 0 {
reward_agent.join();
}
// and possibly roughly every 4 era, trigger payout for the agent. Doing this more
// frequent is also harmless.
if rng.gen_range(0..(4 * ERA)) == 0 {
reward_agent.claim_payout();
}
// execute sanity checks at a fixed interval, possibly on every block.
if iteration %
(std::env::var("SANITY_CHECK_INTERVAL")
.ok()
.and_then(|x| x.parse::<u64>().ok()))
.unwrap_or(1) == 0
{
log!(info, "running sanity checks at {}", iteration);
Pools::do_try_state(u8::MAX).unwrap();
}
// collect and reset events.
System::events()
.into_iter()
.map(|r| r.event)
.filter_map(
|e| if let mock::Event::Pools(inner) = e { Some(inner) } else { None },
)
.for_each(|e| {
if let Some((_, c)) = events_histogram
.iter_mut()
.find(|(x, _)| std::mem::discriminant(x) == std::mem::discriminant(&e))
{
*c += 1;
} else {
events_histogram.push((e, 1))
}
});
System::reset_events();
// trigger an era change, and check the status of the reward agent.
if iteration % ERA == 0 {
CurrentEra::mutate(|c| *c += 1);
BondedPools::<T>::iter().for_each(|(id, _)| {
let amount = random_ed_multiple(&mut rng);
let _ =
Balances::deposit_creating(&Pools::create_reward_account(id), amount);
// if we just paid out the reward agent, let's calculate how much we expect
// our reward agent to have earned.
if reward_agent.pool_id.map_or(false, |mid| mid == id) {
let all_points = BondedPool::<T>::get(id).map(|p| p.points).unwrap();
let member_points =
PoolMembers::<T>::get(reward_agent.who).map(|m| m.points).unwrap();
let agent_share = Perquintill::from_rational(member_points, all_points);
log::info!(
target: "reward-agent",
"🤖 REWARD = amount = {:?}, ratio: {:?}, share {:?}",
amount,
agent_share,
agent_share * amount,
);
reward_agent.expected_reward += agent_share * amount;
}
});
log!(
info,
"iteration {}, {} pools, {} members, {} ok {} err, events = {:?}",
iteration,
BondedPools::<T>::count(),
PoolMembers::<T>::count(),
ok,
err,
events_histogram
.iter()
.map(|(x, c)| (
format!("{:?}", x)
.split(" ")
.map(|x| x.to_string())
.collect::<Vec<_>>()
.first()
.cloned()
.unwrap(),
c,
))
.collect::<Vec<_>>(),
);
}
});
}
}
}