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

Add Event to Pallet Asset-Tx-Payment #11690

Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
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
1 change: 1 addition & 0 deletions bin/node/runtime/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -457,6 +457,7 @@ impl pallet_transaction_payment::Config for Runtime {
}

impl pallet_asset_tx_payment::Config for Runtime {
type Event = Event;
type Fungibles = Assets;
type OnChargeAssetTransaction = pallet_asset_tx_payment::FungiblesAdapter<
pallet_assets::BalanceToAssetBalance<Balances, Runtime, ConvertInto>,
Expand Down
27 changes: 25 additions & 2 deletions frame/transaction-payment/asset-tx-payment/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,8 @@ pub mod pallet {

#[pallet::config]
pub trait Config: frame_system::Config + pallet_transaction_payment::Config {
/// The overarching event type.
type Event: From<Event<Self>> + IsType<<Self as frame_system::Config>::Event>;
/// The fungibles instance used to pay for transactions in assets.
type Fungibles: Balanced<Self::AccountId>;
/// The actual transaction charging logic that charges the fees.
Expand All @@ -122,6 +124,19 @@ pub mod pallet {
#[pallet::pallet]
#[pallet::generate_store(pub(super) trait Store)]
pub struct Pallet<T>(_);

#[pallet::event]
#[pallet::generate_deposit(pub(super) fn deposit_event)]
pub enum Event<T: Config> {
/// A transaction fee `actual_fee`, of which `tip` was added to the minimum inclusion fee,
/// has been paid by `who` in an asset `asset_id`.
AssetTxFeePaid {
who: T::AccountId,
actual_fee: BalanceOf<T>,
tip: BalanceOf<T>,
asset_id: Option<ChargeAssetIdOf<T>>,
},
}
}

/// Require the transactor pay for themselves and maybe include a tip to gain additional priority
Expand Down Expand Up @@ -213,6 +228,8 @@ where
Self::AccountId,
// imbalance resulting from withdrawing the fee
InitialPayment<T>,
// asset_id for the transaction payment
Option<ChargeAssetIdOf<T>>,
Comment on lines +231 to +232
Copy link
Member

Choose a reason for hiding this comment

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

I am very confused why this PR is introducing this.

It makes sense, but it should have existed already. There is no way that adding an event should require adding more data into a signed extension

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I add this inorder to get 'asset_id' ,otherwise need to add parameter 'self' into the interface 'post_dispatch' in my humble opinion. Maybe there is a other better solution.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hi , @shawntabrizi What do you think about this now? Would you like to share your solution ? 😃

Copy link
Member

Choose a reason for hiding this comment

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

@shawntabrizi that is not adding any new data to the signed extension. The only thing this is doing is that it adds a new return value to pre_dispatch that is then passed to post_dispatch

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Right, @bkchr you explain it more clearly . 👍

);

fn additional_signed(&self) -> sp_std::result::Result<(), TransactionValidityError> {
Expand Down Expand Up @@ -240,7 +257,7 @@ where
len: usize,
) -> Result<Self::Pre, TransactionValidityError> {
let (_fee, initial_payment) = self.withdraw_fee(who, call, info, len)?;
Ok((self.tip, who.clone(), initial_payment))
Ok((self.tip, who.clone(), initial_payment, self.asset_id))
}

fn post_dispatch(
Expand All @@ -250,7 +267,7 @@ where
len: usize,
result: &DispatchResult,
) -> Result<(), TransactionValidityError> {
if let Some((tip, who, initial_payment)) = pre {
if let Some((tip, who, initial_payment, asset_id)) = pre {
match initial_payment {
InitialPayment::Native(already_withdrawn) => {
pallet_transaction_payment::ChargeTransactionPayment::<T>::post_dispatch(
Expand All @@ -273,6 +290,12 @@ where
tip.into(),
already_withdrawn.into(),
)?;
Pallet::<T>::deposit_event(Event::<T>::AssetTxFeePaid {
who,
actual_fee,
tip,
asset_id,
});
},
InitialPayment::Nothing => {
// `actual_fee` should be zero here for any signed extrinsic. It would be
Expand Down
5 changes: 3 additions & 2 deletions frame/transaction-payment/asset-tx-payment/src/tests.rs
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ frame_support::construct_runtime!(
TransactionPayment: pallet_transaction_payment::{Pallet, Storage, Event<T>},
Assets: pallet_assets::{Pallet, Call, Storage, Event<T>},
Authorship: pallet_authorship::{Pallet, Call, Storage},
AssetTxPayment: pallet_asset_tx_payment::{Pallet},
AssetTxPayment: pallet_asset_tx_payment::{Pallet, Event<T>},
}
);

Expand Down Expand Up @@ -198,6 +198,7 @@ impl HandleCredit<AccountId, Assets> for CreditToBlockAuthor {
}

impl Config for Runtime {
type Event = Event;
type Fungibles = Assets;
type OnChargeAssetTransaction = FungiblesAdapter<
pallet_assets::BalanceToAssetBalance<Balances, Runtime, ConvertInto>,
Expand Down Expand Up @@ -663,7 +664,7 @@ fn post_dispatch_fee_is_zero_if_pre_dispatch_fee_is_zero() {
.unwrap();
// `Pays::No` implies no pre-dispatch fees
assert_eq!(Assets::balance(asset_id, caller), balance);
let (_tip, _who, initial_payment) = &pre;
let (_tip, _who, initial_payment, _asset_id) = &pre;
let not_paying = match initial_payment {
&InitialPayment::Nothing => true,
_ => false,
Expand Down