Skip to content
This repository was archived by the owner on Nov 15, 2023. It is now read-only.

Add era to Unbonded event #11770

Merged
merged 5 commits into from
Jul 25, 2022
Merged

Add era to Unbonded event #11770

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
270bb94
Add era to `Unbonded` event
hirschenberger Jul 4, 2022
807d85c
Fix missing tests
hirschenberger Jul 4, 2022
2605dae
Merge remote-tracking branch 'origin/master' into issue_11749
hirschenberger Jul 25, 2022
8fa5cc3
Add comment for `era` field in `Unbonded` struct.
hirschenberger Jul 25, 2022
0b80484
Merge remote-tracking branch 'origin/master' into issue_11749
Jul 25, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions frame/nomination-pools/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1288,6 +1288,7 @@ pub mod pallet {
pool_id: PoolId,
balance: BalanceOf<T>,
points: BalanceOf<T>,
era: EraIndex,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update the docs to say what is era please? is it the era in which we unbonded, or the one in which we will be unlocked?

},
/// A member has withdrawn from their pool.
///
Expand Down Expand Up @@ -1610,6 +1611,7 @@ pub mod pallet {
pool_id: member.pool_id,
points: points_unbonded,
balance: unbonding_balance,
era: unbond_era,
});

// Now that we know everything has worked write the items to storage.
Expand Down
115 changes: 78 additions & 37 deletions frame/nomination-pools/src/tests.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -982,7 +982,7 @@ mod claim_payout {
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 }
Event::Unbonded { member: 11, pool_id: 1, points: 11, balance: 11, era: 3 }
]
);
});
Expand Down Expand Up @@ -1624,7 +1624,7 @@ mod unbond {
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 }
Event::Unbonded { member: 40, pool_id: 1, points: 6, balance: 6, era: 3 }
]
);

Expand Down Expand Up @@ -1666,7 +1666,13 @@ mod unbond {
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 }
Event::Unbonded {
member: 550,
pool_id: 1,
points: 92,
balance: 92,
era: 3
}
]
);

Expand Down Expand Up @@ -1704,7 +1710,7 @@ mod unbond {
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 }
Event::Unbonded { member: 10, pool_id: 1, points: 2, balance: 2, era: 6 }
]
);
});
Expand Down Expand Up @@ -1750,7 +1756,7 @@ mod unbond {
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 }
Event::Unbonded { member: 10, pool_id: 1, points: 10, balance: 10, era: 9 }
]
);
});
Expand Down Expand Up @@ -1785,7 +1791,13 @@ mod unbond {
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 },
Event::Unbonded {
member: 100,
pool_id: 1,
points: 100,
balance: 100,
era: 3
},
]
);

Expand All @@ -1794,7 +1806,13 @@ mod unbond {

assert_eq!(
pool_events_since_last_call(),
vec![Event::Unbonded { member: 200, pool_id: 1, points: 200, balance: 200 }]
vec![Event::Unbonded {
member: 200,
pool_id: 1,
points: 200,
balance: 200,
era: 3
}]
);

assert_eq!(
Expand Down Expand Up @@ -1862,7 +1880,7 @@ mod unbond {
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 }
Event::Unbonded { member: 100, pool_id: 1, points: 100, balance: 100, era: 3 }
]
);

Expand Down Expand Up @@ -2002,7 +2020,7 @@ mod unbond {
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 }
Event::Unbonded { member: 10, pool_id: 1, points: 1, balance: 1, era: 3 }
]
);

Expand All @@ -2028,7 +2046,7 @@ mod unbond {
);
assert_eq!(
pool_events_since_last_call(),
vec![Event::Unbonded { member: 10, pool_id: 1, points: 5, balance: 5 }]
vec![Event::Unbonded { member: 10, pool_id: 1, points: 5, balance: 5, era: 3 }]
);

// when: casual further unbond, next era.
Expand All @@ -2055,7 +2073,7 @@ mod unbond {
);
assert_eq!(
pool_events_since_last_call(),
vec![Event::Unbonded { member: 10, pool_id: 1, points: 1, balance: 1 }]
vec![Event::Unbonded { member: 10, pool_id: 1, points: 1, balance: 1, era: 4 }]
);

// when: unbonding more than our active: error
Expand Down Expand Up @@ -2090,7 +2108,7 @@ mod unbond {
);
assert_eq!(
pool_events_since_last_call(),
vec![Event::Unbonded { member: 10, pool_id: 1, points: 3, balance: 3 }]
vec![Event::Unbonded { member: 10, pool_id: 1, points: 3, balance: 3, era: 4 }]
);
});
}
Expand Down Expand Up @@ -2134,9 +2152,9 @@ mod unbond {
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: 2, balance: 2 },
Event::Unbonded { member: 10, pool_id: 1, points: 3, balance: 3 },
Event::Unbonded { member: 10, pool_id: 1, points: 1, balance: 1 }
Event::Unbonded { member: 10, pool_id: 1, points: 2, balance: 2, era: 3 },
Event::Unbonded { member: 10, pool_id: 1, points: 3, balance: 3, era: 4 },
Event::Unbonded { member: 10, pool_id: 1, points: 1, balance: 1, era: 5 }
]
);
})
Expand Down Expand Up @@ -2167,7 +2185,7 @@ mod unbond {
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 }
Event::Unbonded { member: 10, pool_id: 1, points: 3, balance: 3, era: 3 }
]
);
});
Expand Down Expand Up @@ -2223,7 +2241,7 @@ mod unbond {
Event::Bonded { member: 10, pool_id: 1, bonded: 10, joined: true },
// exactly equal to ed, all that can be claimed.
Event::PaidOut { member: 10, pool_id: 1, payout: 5 },
Event::Unbonded { member: 10, pool_id: 1, points: 2, balance: 2 }
Event::Unbonded { member: 10, pool_id: 1, points: 2, balance: 2, era: 3 }
]
);

Expand All @@ -2239,7 +2257,7 @@ mod unbond {
vec![
// exactly equal to ed, all that can be claimed.
Event::PaidOut { member: 10, pool_id: 1, payout: 5 },
Event::Unbonded { member: 10, pool_id: 1, points: 3, balance: 3 }
Event::Unbonded { member: 10, pool_id: 1, points: 3, balance: 3, era: 4 }
]
);

Expand All @@ -2254,7 +2272,7 @@ mod unbond {
pool_events_since_last_call(),
vec![
Event::PaidOut { member: 10, pool_id: 1, payout: 5 },
Event::Unbonded { member: 10, pool_id: 1, points: 5, balance: 5 }
Event::Unbonded { member: 10, pool_id: 1, points: 5, balance: 5, era: 5 }
]
);

Expand Down Expand Up @@ -2353,16 +2371,21 @@ mod withdraw_unbonded {
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 },
Event::Unbonded { member: 40, pool_id: 1, points: 40, balance: 40 },
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!(
Expand Down Expand Up @@ -2427,7 +2450,7 @@ mod withdraw_unbonded {
assert_eq!(
pool_events_since_last_call(),
vec![
Event::Unbonded { member: 10, pool_id: 1, balance: 5, points: 5 },
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 }
Expand Down Expand Up @@ -2471,8 +2494,14 @@ mod withdraw_unbonded {
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 },
Event::Unbonded { member: 550, pool_id: 1, balance: 275, points: 275 },
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!(
Expand Down Expand Up @@ -2548,7 +2577,7 @@ mod withdraw_unbonded {
assert_eq!(
pool_events_since_last_call(),
vec![
Event::Unbonded { member: 10, pool_id: 1, points: 5, balance: 5 },
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 }
Expand Down Expand Up @@ -2662,8 +2691,20 @@ mod withdraw_unbonded {
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 },
Event::Unbonded { member: 200, pool_id: 1, points: 200, balance: 200 }
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
}
]
);

Expand Down Expand Up @@ -2740,7 +2781,7 @@ mod withdraw_unbonded {
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 },
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 }
]
Expand Down Expand Up @@ -2779,8 +2820,8 @@ mod withdraw_unbonded {
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: 6, balance: 6 },
Event::Unbonded { member: 10, pool_id: 1, points: 1, balance: 1 }
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 }
]
);

Expand Down Expand Up @@ -2866,8 +2907,8 @@ mod withdraw_unbonded {
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 },
Event::Unbonded { member: 11, pool_id: 1, points: 1, balance: 1 }
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 }
]
);

Expand Down Expand Up @@ -2956,8 +2997,8 @@ mod withdraw_unbonded {
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 },
Event::Unbonded { member: 100, pool_id: 1, points: 25, balance: 25 },
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 },
]
);
Expand Down Expand Up @@ -3007,8 +3048,8 @@ mod withdraw_unbonded {
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: 7, balance: 7 },
Event::Unbonded { member: 10, pool_id: 1, points: 3, balance: 3 },
Event::Unbonded { member: 10, pool_id: 1, points: 7, balance: 7, era: 3 },
Event::Unbonded { member: 10, pool_id: 1, points: 3, balance: 3, era: 4 },
Event::Withdrawn { member: 10, pool_id: 1, points: 7, balance: 7 }
]
);
Expand Down
20 changes: 10 additions & 10 deletions frame/nomination-pools/test-staking/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,8 +93,8 @@ fn pool_lifecycle_e2e() {
pool_events_since_last_call(),
vec![
PoolsEvent::StateChanged { pool_id: 1, new_state: PoolState::Destroying },
PoolsEvent::Unbonded { member: 20, pool_id: 1, points: 10, balance: 10 },
PoolsEvent::Unbonded { member: 21, pool_id: 1, points: 10, balance: 10 },
PoolsEvent::Unbonded { member: 20, pool_id: 1, points: 10, balance: 10, era: 3 },
PoolsEvent::Unbonded { member: 21, pool_id: 1, points: 10, balance: 10, era: 3 },
]
);

Expand Down Expand Up @@ -157,7 +157,7 @@ fn pool_lifecycle_e2e() {
);
assert_eq!(
pool_events_since_last_call(),
vec![PoolsEvent::Unbonded { member: 10, pool_id: 1, points: 50, balance: 50 }]
vec![PoolsEvent::Unbonded { member: 10, pool_id: 1, points: 50, balance: 50, era: 6 }]
);

// waiting another bonding duration:
Expand Down Expand Up @@ -235,8 +235,8 @@ fn pool_slash_e2e() {
assert_eq!(
pool_events_since_last_call(),
vec![
PoolsEvent::Unbonded { member: 10, pool_id: 1, balance: 10, points: 10 },
PoolsEvent::Unbonded { member: 20, pool_id: 1, balance: 10, points: 10 }
PoolsEvent::Unbonded { member: 10, pool_id: 1, balance: 10, points: 10, era: 4 },
PoolsEvent::Unbonded { member: 20, pool_id: 1, balance: 10, points: 10, era: 4 }
]
);

Expand All @@ -260,9 +260,9 @@ fn pool_slash_e2e() {
assert_eq!(
pool_events_since_last_call(),
vec![
PoolsEvent::Unbonded { member: 10, pool_id: 1, balance: 10, points: 10 },
PoolsEvent::Unbonded { member: 20, pool_id: 1, balance: 10, points: 10 },
PoolsEvent::Unbonded { member: 21, pool_id: 1, balance: 10, points: 10 },
PoolsEvent::Unbonded { member: 10, pool_id: 1, balance: 10, points: 10, era: 5 },
PoolsEvent::Unbonded { member: 20, pool_id: 1, balance: 10, points: 10, era: 5 },
PoolsEvent::Unbonded { member: 21, pool_id: 1, balance: 10, points: 10, era: 5 },
]
);

Expand Down Expand Up @@ -303,7 +303,7 @@ fn pool_slash_e2e() {
assert_eq!(staking_events_since_last_call(), vec![StakingEvent::Unbonded(POOL1_BONDED, 5)]);
assert_eq!(
pool_events_since_last_call(),
vec![PoolsEvent::Unbonded { member: 21, pool_id: 1, balance: 5, points: 5 }]
vec![PoolsEvent::Unbonded { member: 21, pool_id: 1, balance: 5, points: 5, era: 6 }]
);

// now we start withdrawing. we do it all at once, at era 6 where 20 and 21 are fully free.
Expand Down Expand Up @@ -340,7 +340,7 @@ fn pool_slash_e2e() {
pool_events_since_last_call(),
vec![
PoolsEvent::StateChanged { pool_id: 1, new_state: PoolState::Destroying },
PoolsEvent::Unbonded { member: 10, pool_id: 1, points: 10, balance: 10 }
PoolsEvent::Unbonded { member: 10, pool_id: 1, points: 10, balance: 10, era: 9 }
]
);

Expand Down