Skip to content

Commit

Permalink
style: 🎨 remove unneeded generics in pallet events (#340)
Browse files Browse the repository at this point in the history 
* style: 🎨 remove unneeded generics in pallet events

* style: 🎨 run cargo fmt
  • Loading branch information
@TDemeco
TDemeco authored Jan 28, 2025
1 parent b54ab9f commit c1a61e5
Show file tree
Hide file tree
Showing 9 changed files with 218 additions and 247 deletions.
91 changes: 42 additions & 49 deletions pallets/payment-streams/src/benchmarking.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ mod benchmarks {
/*********** Post-benchmark checks: ***********/
// Verify the fixed-rate payment stream creation event was emitted.
let expected_event =
<T as pallet::Config>::RuntimeEvent::from(Event::<T>::FixedRatePaymentStreamCreated {
<T as pallet::Config>::RuntimeEvent::from(Event::FixedRatePaymentStreamCreated {
user_account: user_account.clone(),
provider_id,
rate: rate.into(),
Expand Down Expand Up @@ -273,18 +273,17 @@ mod benchmarks {
let amount_charged: BalanceOf<T> = initial_rate_as_balance
+ (amount_provided_as_balance * CurrentPricePerGigaUnitPerTick::<T>::get()
/ GIGAUNIT.into());
let charge_event =
<T as pallet::Config>::RuntimeEvent::from(Event::<T>::PaymentStreamCharged {
user_account: user_account.clone(),
provider_id,
amount: amount_charged,
last_tick_charged: frame_system::Pallet::<T>::block_number(),
charged_at_tick: frame_system::Pallet::<T>::block_number(),
});
let charge_event = <T as pallet::Config>::RuntimeEvent::from(Event::PaymentStreamCharged {
user_account: user_account.clone(),
provider_id,
amount: amount_charged,
last_tick_charged: frame_system::Pallet::<T>::block_number(),
charged_at_tick: frame_system::Pallet::<T>::block_number(),
});
frame_system::Pallet::<T>::assert_has_event(charge_event.into());
// Verify the fixed-rate payment stream update event was emitted.
let expected_event =
<T as pallet::Config>::RuntimeEvent::from(Event::<T>::FixedRatePaymentStreamUpdated {
<T as pallet::Config>::RuntimeEvent::from(Event::FixedRatePaymentStreamUpdated {
user_account: user_account.clone(),
provider_id,
new_rate: new_rate.into(),
Expand Down Expand Up @@ -347,18 +346,17 @@ mod benchmarks {

/*********** Post-benchmark checks: ***********/
// Verify that the charge event was emitted.
let charge_event =
<T as pallet::Config>::RuntimeEvent::from(Event::<T>::PaymentStreamCharged {
user_account: user_account.clone(),
provider_id,
amount: rate.into(),
last_tick_charged: frame_system::Pallet::<T>::block_number(),
charged_at_tick: frame_system::Pallet::<T>::block_number(),
});
let charge_event = <T as pallet::Config>::RuntimeEvent::from(Event::PaymentStreamCharged {
user_account: user_account.clone(),
provider_id,
amount: rate.into(),
last_tick_charged: frame_system::Pallet::<T>::block_number(),
charged_at_tick: frame_system::Pallet::<T>::block_number(),
});
frame_system::Pallet::<T>::assert_has_event(charge_event.into());
// Verify the fixed-rate payment stream deletion event was emitted.
let expected_event =
<T as pallet::Config>::RuntimeEvent::from(Event::<T>::FixedRatePaymentStreamDeleted {
<T as pallet::Config>::RuntimeEvent::from(Event::FixedRatePaymentStreamDeleted {
user_account: user_account.clone(),
provider_id,
});
Expand Down Expand Up @@ -403,13 +401,12 @@ mod benchmarks {

/*********** Post-benchmark checks: ***********/
// Verify the dynamic-rate payment stream creation event was emitted.
let expected_event = <T as pallet::Config>::RuntimeEvent::from(
Event::<T>::DynamicRatePaymentStreamCreated {
let expected_event =
<T as pallet::Config>::RuntimeEvent::from(Event::DynamicRatePaymentStreamCreated {
user_account: user_account.clone(),
provider_id,
amount_provided: amount_provided.into(),
},
);
});
frame_system::Pallet::<T>::assert_last_event(expected_event.into());

// Verify that the newly created payment stream exists in storage
Expand Down Expand Up @@ -587,23 +584,21 @@ mod benchmarks {
let amount_charged: BalanceOf<T> = rate_as_balance
+ (amount_provided_as_balance * CurrentPricePerGigaUnitPerTick::<T>::get()
/ GIGAUNIT.into());
let charge_event =
<T as pallet::Config>::RuntimeEvent::from(Event::<T>::PaymentStreamCharged {
user_account: user_account.clone(),
provider_id,
amount: amount_charged,
last_tick_charged: frame_system::Pallet::<T>::block_number(),
charged_at_tick: frame_system::Pallet::<T>::block_number(),
});
let charge_event = <T as pallet::Config>::RuntimeEvent::from(Event::PaymentStreamCharged {
user_account: user_account.clone(),
provider_id,
amount: amount_charged,
last_tick_charged: frame_system::Pallet::<T>::block_number(),
charged_at_tick: frame_system::Pallet::<T>::block_number(),
});
frame_system::Pallet::<T>::assert_has_event(charge_event.into());

// Verify the dynamic-rate payment stream deletion event was emitted.
let expected_event = <T as pallet::Config>::RuntimeEvent::from(
Event::<T>::DynamicRatePaymentStreamDeleted {
let expected_event =
<T as pallet::Config>::RuntimeEvent::from(Event::DynamicRatePaymentStreamDeleted {
user_account: user_account.clone(),
provider_id,
},
);
});
frame_system::Pallet::<T>::assert_last_event(expected_event.into());

// Verify that the newly created payment stream was correctly deleted
Expand Down Expand Up @@ -676,14 +671,13 @@ mod benchmarks {
let amount_charged: BalanceOf<T> = rate_as_balance
+ (amount_provided_as_balance * CurrentPricePerGigaUnitPerTick::<T>::get()
/ GIGAUNIT.into());
let charge_event =
<T as pallet::Config>::RuntimeEvent::from(Event::<T>::PaymentStreamCharged {
user_account: user_account.clone(),
provider_id,
amount: amount_charged,
last_tick_charged: frame_system::Pallet::<T>::block_number(),
charged_at_tick: frame_system::Pallet::<T>::block_number(),
});
let charge_event = <T as pallet::Config>::RuntimeEvent::from(Event::PaymentStreamCharged {
user_account: user_account.clone(),
provider_id,
amount: amount_charged,
last_tick_charged: frame_system::Pallet::<T>::block_number(),
charged_at_tick: frame_system::Pallet::<T>::block_number(),
});
frame_system::Pallet::<T>::assert_has_event(charge_event.into());

Ok(())
Expand Down Expand Up @@ -766,7 +760,7 @@ mod benchmarks {
/ GIGAUNIT.into());
for user_account in user_accounts.iter() {
let charge_event =
<T as pallet::Config>::RuntimeEvent::from(Event::<T>::PaymentStreamCharged {
<T as pallet::Config>::RuntimeEvent::from(Event::PaymentStreamCharged {
user_account: user_account.clone(),
provider_id,
amount: amount_charged,
Expand Down Expand Up @@ -876,7 +870,7 @@ mod benchmarks {
/*********** Post-benchmark checks: ***********/
// Verify that the user paid all debts event was emitted for the user
let user_paid_debts_event =
<T as pallet::Config>::RuntimeEvent::from(Event::<T>::UserPaidAllDebts {
<T as pallet::Config>::RuntimeEvent::from(Event::UserPaidAllDebts {
who: user_account.clone(),
});
frame_system::Pallet::<T>::assert_has_event(user_paid_debts_event.into());
Expand Down Expand Up @@ -919,10 +913,9 @@ mod benchmarks {
assert!(!UsersWithoutFunds::<T>::contains_key(user_account.clone()));

// Verify that the `UserSolvent` event was emitted
let user_solvent_event =
<T as pallet::Config>::RuntimeEvent::from(Event::<T>::UserSolvent {
who: user_account.clone(),
});
let user_solvent_event = <T as pallet::Config>::RuntimeEvent::from(Event::UserSolvent {
who: user_account.clone(),
});
frame_system::Pallet::<T>::assert_has_event(user_solvent_event.into());

Ok(())
Expand Down
22 changes: 11 additions & 11 deletions pallets/payment-streams/src/lib.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -466,7 +466,7 @@ pub mod pallet {
Self::do_create_fixed_rate_payment_stream(&provider_id, &user_account, rate)?;

// Emit the corresponding event
Self::deposit_event(Event::<T>::FixedRatePaymentStreamCreated {
Self::deposit_event(Event::FixedRatePaymentStreamCreated {
user_account,
provider_id: provider_id,
rate,
Expand Down Expand Up @@ -507,7 +507,7 @@ pub mod pallet {
Self::do_update_fixed_rate_payment_stream(&provider_id, &user_account, new_rate)?;

// Emit the corresponding event
Self::deposit_event(Event::<T>::FixedRatePaymentStreamUpdated {
Self::deposit_event(Event::FixedRatePaymentStreamUpdated {
user_account,
provider_id: provider_id,
new_rate,
Expand Down Expand Up @@ -546,7 +546,7 @@ pub mod pallet {
Self::do_delete_fixed_rate_payment_stream(&provider_id, &user_account)?;

// Emit the corresponding event
Self::deposit_event(Event::<T>::FixedRatePaymentStreamDeleted {
Self::deposit_event(Event::FixedRatePaymentStreamDeleted {
user_account,
provider_id: provider_id,
});
Expand Down Expand Up @@ -592,7 +592,7 @@ pub mod pallet {
)?;

// Emit the corresponding event
Self::deposit_event(Event::<T>::DynamicRatePaymentStreamCreated {
Self::deposit_event(Event::DynamicRatePaymentStreamCreated {
user_account,
provider_id: provider_id,
amount_provided,
Expand Down Expand Up @@ -637,7 +637,7 @@ pub mod pallet {
)?;

// Emit the corresponding event
Self::deposit_event(Event::<T>::DynamicRatePaymentStreamUpdated {
Self::deposit_event(Event::DynamicRatePaymentStreamUpdated {
user_account,
provider_id,
new_amount_provided,
Expand Down Expand Up @@ -676,7 +676,7 @@ pub mod pallet {
Self::do_delete_dynamic_rate_payment_stream(&provider_id, &user_account)?;

// Emit the corresponding event
Self::deposit_event(Event::<T>::DynamicRatePaymentStreamDeleted {
Self::deposit_event(Event::DynamicRatePaymentStreamDeleted {
user_account,
provider_id,
});
Expand Down Expand Up @@ -735,7 +735,7 @@ pub mod pallet {
let charged_at_tick = Self::get_current_tick();

// Emit the corresponding event (we always emit it even if the charged amount was 0)
Self::deposit_event(Event::<T>::PaymentStreamCharged {
Self::deposit_event(Event::PaymentStreamCharged {
user_account,
provider_id: provider_id,
amount: amount_charged,
Expand Down Expand Up @@ -798,7 +798,7 @@ pub mod pallet {
let charged_at_tick = Self::get_current_tick();

// Emit the corresponding event (we always emit it even if the charged amount was 0)
Self::deposit_event(Event::<T>::UsersCharged {
Self::deposit_event(Event::UsersCharged {
user_accounts,
provider_id,
charged_at_tick,
Expand Down Expand Up @@ -843,9 +843,9 @@ pub mod pallet {

// Emit the corresponding event
if fully_paid {
Self::deposit_event(Event::<T>::UserPaidAllDebts { who: user_account });
Self::deposit_event(Event::UserPaidAllDebts { who: user_account });
} else {
Self::deposit_event(Event::<T>::UserPaidSomeDebts { who: user_account });
Self::deposit_event(Event::UserPaidSomeDebts { who: user_account });
}

// Return a successful DispatchResultWithPostInfo
Expand Down Expand Up @@ -876,7 +876,7 @@ pub mod pallet {
Self::do_clear_insolvent_flag(&user_account)?;

// Emit the corresponding event
Self::deposit_event(Event::<T>::UserSolvent { who: user_account });
Self::deposit_event(Event::UserSolvent { who: user_account });

// Return a successful DispatchResultWithPostInfo
Ok(().into())
Expand Down
30 changes: 15 additions & 15 deletions pallets/payment-streams/src/utils.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ where
let charged_at_tick = Self::get_current_tick();

// We emit a payment charged event only if the user had to pay before the payment stream could be updated
Self::deposit_event(Event::<T>::PaymentStreamCharged {
Self::deposit_event(Event::PaymentStreamCharged {
user_account: user_account.clone(),
provider_id: *provider_id,
amount: amount_charged,
Expand Down Expand Up @@ -262,7 +262,7 @@ where
let charged_at_tick = Self::get_current_tick();

// We emit a payment charged event only if the user had to pay before being able to delete the payment stream
Self::deposit_event(Event::<T>::PaymentStreamCharged {
Self::deposit_event(Event::PaymentStreamCharged {
user_account: user_account.clone(),
provider_id: *provider_id,
amount: amount_charged,
Expand Down Expand Up @@ -465,7 +465,7 @@ where
let charged_at_tick = Self::get_current_tick();

// We emit a payment charged event only if the user had to pay before the payment stream could be updated
Self::deposit_event(Event::<T>::PaymentStreamCharged {
Self::deposit_event(Event::PaymentStreamCharged {
user_account: user_account.clone(),
provider_id: *provider_id,
amount: amount_charged,
Expand Down Expand Up @@ -530,7 +530,7 @@ where
let charged_at_tick = Self::get_current_tick();

// We emit a payment charged event only if the user had to pay before being able to delete the payment stream
Self::deposit_event(Event::<T>::PaymentStreamCharged {
Self::deposit_event(Event::PaymentStreamCharged {
user_account: user_account.clone(),
provider_id: *provider_id,
amount: amount_charged,
Expand Down Expand Up @@ -948,7 +948,7 @@ where
Self::do_charge_payment_streams(provider_id, user_account)?;

if amount_charged > Zero::zero() {
Self::deposit_event(Event::<T>::PaymentStreamCharged {
Self::deposit_event(Event::PaymentStreamCharged {
user_account: user_account.clone(),
provider_id: *provider_id,
amount: amount_charged,
Expand Down Expand Up @@ -1213,7 +1213,7 @@ where
// If it's not greater (which should never happen) nor equal, it has to be exactly one less than the tick to process. If it's not,
// there's an inconsistency in the tick processing and we emit an event to signal it.
else if last_processed_tick != tick_to_process.saturating_sub(One::one()) {
Self::deposit_event(Event::<T>::InconsistentTickProcessing {
Self::deposit_event(Event::InconsistentTickProcessing {
last_processed_tick,
tick_to_process,
});
Expand Down Expand Up @@ -1241,7 +1241,7 @@ where
provider_info.last_chargeable_tick = n;
provider_info.price_index = accumulated_price_index;
});
Self::deposit_event(Event::<T>::LastChargeableInfoUpdated {
Self::deposit_event(Event::LastChargeableInfoUpdated {
provider_id: *provider_id,
last_chargeable_tick: n,
last_chargeable_price_index: accumulated_price_index,
Expand Down Expand Up @@ -1466,12 +1466,12 @@ where
// pay it for the user using the payment streams' deposits.
if !UsersWithoutFunds::<T>::contains_key(user_account) {
UsersWithoutFunds::<T>::insert(user_account, frame_system::Pallet::<T>::block_number());
Self::deposit_event(Event::<T>::UserWithoutFunds {
Self::deposit_event(Event::UserWithoutFunds {
who: user_account.clone(),
});
}
if user_payment_streams_count == 0 {
Self::deposit_event(Event::<T>::UserPaidAllDebts {
Self::deposit_event(Event::UserPaidAllDebts {
who: user_account.clone(),
});
}
Expand All @@ -1498,7 +1498,7 @@ impl<T: pallet::Config> PaymentStreamsInterface for pallet::Pallet<T> {
Self::do_create_fixed_rate_payment_stream(provider_id, user_account, rate)?;

// Emit the corresponding event
Self::deposit_event(Event::<T>::FixedRatePaymentStreamCreated {
Self::deposit_event(Event::FixedRatePaymentStreamCreated {
user_account: user_account.clone(),
provider_id: *provider_id,
rate,
Expand All @@ -1517,7 +1517,7 @@ impl<T: pallet::Config> PaymentStreamsInterface for pallet::Pallet<T> {
Self::do_update_fixed_rate_payment_stream(provider_id, user_account, new_rate)?;

// Emit the corresponding event
Self::deposit_event(Event::<T>::FixedRatePaymentStreamUpdated {
Self::deposit_event(Event::FixedRatePaymentStreamUpdated {
user_account: user_account.clone(),
provider_id: *provider_id,
new_rate,
Expand All @@ -1535,7 +1535,7 @@ impl<T: pallet::Config> PaymentStreamsInterface for pallet::Pallet<T> {
Self::do_delete_fixed_rate_payment_stream(provider_id, user_account)?;

// Emit the corresponding event
Self::deposit_event(Event::<T>::FixedRatePaymentStreamDeleted {
Self::deposit_event(Event::FixedRatePaymentStreamDeleted {
user_account: user_account.clone(),
provider_id: *provider_id,
});
Expand Down Expand Up @@ -1575,7 +1575,7 @@ impl<T: pallet::Config> PaymentStreamsInterface for pallet::Pallet<T> {
Self::do_create_dynamic_rate_payment_stream(provider_id, user_account, *amount_provided)?;

// Emit the corresponding event
Self::deposit_event(Event::<T>::DynamicRatePaymentStreamCreated {
Self::deposit_event(Event::DynamicRatePaymentStreamCreated {
user_account: user_account.clone(),
provider_id: *provider_id,
amount_provided: *amount_provided,
Expand All @@ -1598,7 +1598,7 @@ impl<T: pallet::Config> PaymentStreamsInterface for pallet::Pallet<T> {
)?;

// Emit the corresponding event
Self::deposit_event(Event::<T>::DynamicRatePaymentStreamUpdated {
Self::deposit_event(Event::DynamicRatePaymentStreamUpdated {
user_account: user_account.clone(),
provider_id: *provider_id,
new_amount_provided: *new_amount_provided,
Expand All @@ -1616,7 +1616,7 @@ impl<T: pallet::Config> PaymentStreamsInterface for pallet::Pallet<T> {
Self::do_delete_dynamic_rate_payment_stream(&provider_id, &user_account)?;

// Emit the corresponding event
Self::deposit_event(Event::<T>::DynamicRatePaymentStreamDeleted {
Self::deposit_event(Event::DynamicRatePaymentStreamDeleted {
user_account: user_account.clone(),
provider_id: *provider_id,
});
Expand Down
Loading

0 comments on commit c1a61e5

Please sign in to comment.