Add field names to pallet Event variants (#9993)

* convert pallet-assets events to struct types

* updated events of a couple pallets

* updated pallet event field names

* update pallet event field names

* updated events in test files

* cargo fmt

* minorfixes

* fix assertion error

* minor fix

* formatting fix

* fmt
This commit is contained in:
David Salami
2021-11-16 02:56:00 +01:00
committed by GitHub
parent fb3c7326c2
commit 120894fdb7
48 changed files with 1181 additions and 681 deletions
+37 -26
View File
@@ -425,7 +425,7 @@ pub mod pallet {
Renouncing::Member => {
let _ = Self::remove_and_replace_member(&who, false)
.map_err(|_| Error::<T>::InvalidRenouncing)?;
Self::deposit_event(Event::Renounced(who));
Self::deposit_event(Event::Renounced { candidate: who });
},
Renouncing::RunnerUp => {
<RunnersUp<T>>::try_mutate::<_, Error<T>, _>(|runners_up| {
@@ -437,7 +437,7 @@ pub mod pallet {
let SeatHolder { deposit, .. } = runners_up.remove(index);
let _remainder = T::Currency::unreserve(&who, deposit);
debug_assert!(_remainder.is_zero());
Self::deposit_event(Event::Renounced(who));
Self::deposit_event(Event::Renounced { candidate: who });
Ok(())
})?;
},
@@ -450,7 +450,7 @@ pub mod pallet {
let (_removed, deposit) = candidates.remove(index);
let _remainder = T::Currency::unreserve(&who, deposit);
debug_assert!(_remainder.is_zero());
Self::deposit_event(Event::Renounced(who));
Self::deposit_event(Event::Renounced { candidate: who });
Ok(())
})?;
},
@@ -496,7 +496,7 @@ pub mod pallet {
let had_replacement = Self::remove_and_replace_member(&who, true)?;
debug_assert_eq!(has_replacement, had_replacement);
Self::deposit_event(Event::MemberKicked(who.clone()));
Self::deposit_event(Event::MemberKicked { member: who.clone() });
if !had_replacement {
Self::do_phragmen();
@@ -534,29 +534,32 @@ pub mod pallet {
#[pallet::event]
#[pallet::generate_deposit(pub(super) fn deposit_event)]
pub enum Event<T: Config> {
/// A new term with \[new_members\]. This indicates that enough candidates existed to run
/// A new term with new_members. This indicates that enough candidates existed to run
/// the election, not that enough have has been elected. The inner value must be examined
/// for this purpose. A `NewTerm(\[\])` indicates that some candidates got their bond
/// slashed and none were elected, whilst `EmptyTerm` means that no candidates existed to
/// begin with.
NewTerm(Vec<(<T as frame_system::Config>::AccountId, BalanceOf<T>)>),
NewTerm { new_members: Vec<(<T as frame_system::Config>::AccountId, BalanceOf<T>)> },
/// No (or not enough) candidates existed for this round. This is different from
/// `NewTerm(\[\])`. See the description of `NewTerm`.
EmptyTerm,
/// Internal error happened while trying to perform election.
ElectionError,
/// A \[member\] has been removed. This should always be followed by either `NewTerm` or
/// A member has been removed. This should always be followed by either `NewTerm` or
/// `EmptyTerm`.
MemberKicked(<T as frame_system::Config>::AccountId),
MemberKicked { member: <T as frame_system::Config>::AccountId },
/// Someone has renounced their candidacy.
Renounced(<T as frame_system::Config>::AccountId),
/// A \[candidate\] was slashed by \[amount\] due to failing to obtain a seat as member or
Renounced { candidate: <T as frame_system::Config>::AccountId },
/// A candidate was slashed by amount due to failing to obtain a seat as member or
/// runner-up.
///
/// Note that old members and runners-up are also candidates.
CandidateSlashed(<T as frame_system::Config>::AccountId, BalanceOf<T>),
/// A \[seat holder\] was slashed by \[amount\] by being forcefully removed from the set.
SeatHolderSlashed(<T as frame_system::Config>::AccountId, BalanceOf<T>),
CandidateSlashed { candidate: <T as frame_system::Config>::AccountId, amount: BalanceOf<T> },
/// A seat holder was slashed by amount by being forcefully removed from the set.
SeatHolderSlashed {
seat_holder: <T as frame_system::Config>::AccountId,
amount: BalanceOf<T>,
},
}
#[deprecated(note = "use `Event` instead")]
@@ -748,7 +751,10 @@ impl<T: Config> Pallet<T> {
let (imbalance, _remainder) = T::Currency::slash_reserved(who, removed.deposit);
debug_assert!(_remainder.is_zero());
T::LoserCandidate::on_unbalanced(imbalance);
Self::deposit_event(Event::SeatHolderSlashed(who.clone(), removed.deposit));
Self::deposit_event(Event::SeatHolderSlashed {
seat_holder: who.clone(),
amount: removed.deposit,
});
} else {
T::Currency::unreserve(who, removed.deposit);
}
@@ -1001,7 +1007,10 @@ impl<T: Config> Pallet<T> {
{
let (imbalance, _) = T::Currency::slash_reserved(c, *d);
T::LoserCandidate::on_unbalanced(imbalance);
Self::deposit_event(Event::CandidateSlashed(c.clone(), *d));
Self::deposit_event(Event::CandidateSlashed {
candidate: c.clone(),
amount: *d,
});
}
});
@@ -1041,7 +1050,7 @@ impl<T: Config> Pallet<T> {
// clean candidates.
<Candidates<T>>::kill();
Self::deposit_event(Event::NewTerm(new_members_sorted_by_id));
Self::deposit_event(Event::NewTerm { new_members: new_members_sorted_by_id });
<ElectionRounds<T>>::mutate(|v| *v += 1);
})
.map_err(|e| {
@@ -2147,10 +2156,9 @@ mod tests {
System::set_block_number(5);
Elections::on_initialize(System::block_number());
System::assert_last_event(Event::Elections(super::Event::NewTerm(vec![
(4, 40),
(5, 50),
])));
System::assert_last_event(Event::Elections(super::Event::NewTerm {
new_members: vec![(4, 40), (5, 50)],
}));
assert_eq!(members_and_stake(), vec![(4, 40), (5, 50)]);
assert_eq!(runners_up_and_stake(), vec![]);
@@ -2161,7 +2169,9 @@ mod tests {
System::set_block_number(10);
Elections::on_initialize(System::block_number());
System::assert_last_event(Event::Elections(super::Event::NewTerm(vec![])));
System::assert_last_event(Event::Elections(super::Event::NewTerm {
new_members: vec![],
}));
// outgoing have lost their bond.
assert_eq!(balances(&4), (37, 0));
@@ -2231,7 +2241,9 @@ mod tests {
assert_eq!(Elections::election_rounds(), 1);
assert!(members_ids().is_empty());
System::assert_last_event(Event::Elections(super::Event::NewTerm(vec![])));
System::assert_last_event(Event::Elections(super::Event::NewTerm {
new_members: vec![],
}));
});
}
@@ -2583,10 +2595,9 @@ mod tests {
// 5 is an outgoing loser. will also get slashed.
assert_eq!(balances(&5), (45, 2));
System::assert_has_event(Event::Elections(super::Event::NewTerm(vec![
(4, 40),
(5, 50),
])));
System::assert_has_event(Event::Elections(super::Event::NewTerm {
new_members: vec![(4, 40), (5, 50)],
}));
})
}