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
+28 -28
View File
@@ -155,7 +155,7 @@ benchmarks_instance_pallet! {
T::Currency::make_free_balance_be(&caller, DepositBalanceOf::<T, I>::max_value());
}: _(SystemOrigin::Signed(caller.clone()), Default::default(), caller_lookup, 1u32.into())
verify {
assert_last_event::<T, I>(Event::Created(Default::default(), caller.clone(), caller).into());
assert_last_event::<T, I>(Event::Created { asset_id: Default::default(), creator: caller.clone(), owner: caller }.into());
}
force_create {
@@ -163,7 +163,7 @@ benchmarks_instance_pallet! {
let caller_lookup = T::Lookup::unlookup(caller.clone());
}: _(SystemOrigin::Root, Default::default(), caller_lookup, true, 1u32.into())
verify {
assert_last_event::<T, I>(Event::ForceCreated(Default::default(), caller).into());
assert_last_event::<T, I>(Event::ForceCreated { asset_id: Default::default(), owner: caller }.into());
}
destroy {
@@ -177,7 +177,7 @@ benchmarks_instance_pallet! {
let witness = Asset::<T, I>::get(T::AssetId::default()).unwrap().destroy_witness();
}: _(SystemOrigin::Signed(caller), Default::default(), witness)
verify {
assert_last_event::<T, I>(Event::Destroyed(Default::default()).into());
assert_last_event::<T, I>(Event::Destroyed { asset_id: Default::default() }.into());
}
mint {
@@ -185,7 +185,7 @@ benchmarks_instance_pallet! {
let amount = T::Balance::from(100u32);
}: _(SystemOrigin::Signed(caller.clone()), Default::default(), caller_lookup, amount)
verify {
assert_last_event::<T, I>(Event::Issued(Default::default(), caller, amount).into());
assert_last_event::<T, I>(Event::Issued { asset_id: Default::default(), owner: caller, total_supply: amount }.into());
}
burn {
@@ -193,7 +193,7 @@ benchmarks_instance_pallet! {
let (caller, caller_lookup) = create_default_minted_asset::<T, I>(true, amount);
}: _(SystemOrigin::Signed(caller.clone()), Default::default(), caller_lookup, amount)
verify {
assert_last_event::<T, I>(Event::Burned(Default::default(), caller, amount).into());
assert_last_event::<T, I>(Event::Burned { asset_id: Default::default(), owner: caller, balance: amount }.into());
}
transfer {
@@ -203,7 +203,7 @@ benchmarks_instance_pallet! {
let target_lookup = T::Lookup::unlookup(target.clone());
}: _(SystemOrigin::Signed(caller.clone()), Default::default(), target_lookup, amount)
verify {
assert_last_event::<T, I>(Event::Transferred(Default::default(), caller, target, amount).into());
assert_last_event::<T, I>(Event::Transferred { asset_id: Default::default(), from: caller, to: target, amount }.into());
}
transfer_keep_alive {
@@ -215,7 +215,7 @@ benchmarks_instance_pallet! {
}: _(SystemOrigin::Signed(caller.clone()), Default::default(), target_lookup, amount)
verify {
assert!(frame_system::Pallet::<T>::account_exists(&caller));
assert_last_event::<T, I>(Event::Transferred(Default::default(), caller, target, amount).into());
assert_last_event::<T, I>(Event::Transferred { asset_id: Default::default(), from: caller, to: target, amount }.into());
}
force_transfer {
@@ -226,7 +226,7 @@ benchmarks_instance_pallet! {
}: _(SystemOrigin::Signed(caller.clone()), Default::default(), caller_lookup, target_lookup, amount)
verify {
assert_last_event::<T, I>(
Event::Transferred(Default::default(), caller, target, amount).into()
Event::Transferred { asset_id: Default::default(), from: caller, to: target, amount }.into()
);
}
@@ -234,7 +234,7 @@ benchmarks_instance_pallet! {
let (caller, caller_lookup) = create_default_minted_asset::<T, I>(true, 100u32.into());
}: _(SystemOrigin::Signed(caller.clone()), Default::default(), caller_lookup)
verify {
assert_last_event::<T, I>(Event::Frozen(Default::default(), caller).into());
assert_last_event::<T, I>(Event::Frozen { asset_id: Default::default(), who: caller }.into());
}
thaw {
@@ -246,14 +246,14 @@ benchmarks_instance_pallet! {
)?;
}: _(SystemOrigin::Signed(caller.clone()), Default::default(), caller_lookup)
verify {
assert_last_event::<T, I>(Event::Thawed(Default::default(), caller).into());
assert_last_event::<T, I>(Event::Thawed { asset_id: Default::default(), who: caller }.into());
}
freeze_asset {
let (caller, caller_lookup) = create_default_minted_asset::<T, I>(true, 100u32.into());
}: _(SystemOrigin::Signed(caller.clone()), Default::default())
verify {
assert_last_event::<T, I>(Event::AssetFrozen(Default::default()).into());
assert_last_event::<T, I>(Event::AssetFrozen { asset_id: Default::default() }.into());
}
thaw_asset {
@@ -264,7 +264,7 @@ benchmarks_instance_pallet! {
)?;
}: _(SystemOrigin::Signed(caller.clone()), Default::default())
verify {
assert_last_event::<T, I>(Event::AssetThawed(Default::default()).into());
assert_last_event::<T, I>(Event::AssetThawed { asset_id: Default::default() }.into());
}
transfer_ownership {
@@ -273,7 +273,7 @@ benchmarks_instance_pallet! {
let target_lookup = T::Lookup::unlookup(target.clone());
}: _(SystemOrigin::Signed(caller), Default::default(), target_lookup)
verify {
assert_last_event::<T, I>(Event::OwnerChanged(Default::default(), target).into());
assert_last_event::<T, I>(Event::OwnerChanged { asset_id: Default::default(), owner: target }.into());
}
set_team {
@@ -283,12 +283,12 @@ benchmarks_instance_pallet! {
let target2 = T::Lookup::unlookup(account("target", 2, SEED));
}: _(SystemOrigin::Signed(caller), Default::default(), target0.clone(), target1.clone(), target2.clone())
verify {
assert_last_event::<T, I>(Event::TeamChanged(
Default::default(),
account("target", 0, SEED),
account("target", 1, SEED),
account("target", 2, SEED),
).into());
assert_last_event::<T, I>(Event::TeamChanged {
asset_id: Default::default(),
issuer: account("target", 0, SEED),
admin: account("target", 1, SEED),
freezer: account("target", 2, SEED),
}.into());
}
set_metadata {
@@ -304,7 +304,7 @@ benchmarks_instance_pallet! {
}: _(SystemOrigin::Signed(caller), Default::default(), name.clone(), symbol.clone(), decimals)
verify {
let id = Default::default();
assert_last_event::<T, I>(Event::MetadataSet(id, name, symbol, decimals, false).into());
assert_last_event::<T, I>(Event::MetadataSet { asset_id: id, name, symbol, decimals, is_frozen: false }.into());
}
clear_metadata {
@@ -315,7 +315,7 @@ benchmarks_instance_pallet! {
Assets::<T, I>::set_metadata(origin, Default::default(), dummy.clone(), dummy, 12)?;
}: _(SystemOrigin::Signed(caller), Default::default())
verify {
assert_last_event::<T, I>(Event::MetadataCleared(Default::default()).into());
assert_last_event::<T, I>(Event::MetadataCleared { asset_id: Default::default() }.into());
}
force_set_metadata {
@@ -339,7 +339,7 @@ benchmarks_instance_pallet! {
}: { call.dispatch_bypass_filter(origin)? }
verify {
let id = Default::default();
assert_last_event::<T, I>(Event::MetadataSet(id, name, symbol, decimals, false).into());
assert_last_event::<T, I>(Event::MetadataSet { asset_id: id, name, symbol, decimals, is_frozen: false }.into());
}
force_clear_metadata {
@@ -353,7 +353,7 @@ benchmarks_instance_pallet! {
let call = Call::<T, I>::force_clear_metadata { id: Default::default() };
}: { call.dispatch_bypass_filter(origin)? }
verify {
assert_last_event::<T, I>(Event::MetadataCleared(Default::default()).into());
assert_last_event::<T, I>(Event::MetadataCleared { asset_id: Default::default() }.into());
}
force_asset_status {
@@ -372,7 +372,7 @@ benchmarks_instance_pallet! {
};
}: { call.dispatch_bypass_filter(origin)? }
verify {
assert_last_event::<T, I>(Event::AssetStatusChanged(Default::default()).into());
assert_last_event::<T, I>(Event::AssetStatusChanged { asset_id: Default::default() }.into());
}
approve_transfer {
@@ -385,7 +385,7 @@ benchmarks_instance_pallet! {
let amount = 100u32.into();
}: _(SystemOrigin::Signed(caller.clone()), id, delegate_lookup, amount)
verify {
assert_last_event::<T, I>(Event::ApprovedTransfer(id, caller, delegate, amount).into());
assert_last_event::<T, I>(Event::ApprovedTransfer { asset_id: id, source: caller, delegate, amount }.into());
}
transfer_approved {
@@ -405,7 +405,7 @@ benchmarks_instance_pallet! {
}: _(SystemOrigin::Signed(delegate.clone()), id, owner_lookup, dest_lookup, amount)
verify {
assert!(T::Currency::reserved_balance(&owner).is_zero());
assert_event::<T, I>(Event::Transferred(id, owner, dest, amount).into());
assert_event::<T, I>(Event::Transferred { asset_id: id, from: owner, to: dest, amount }.into());
}
cancel_approval {
@@ -420,7 +420,7 @@ benchmarks_instance_pallet! {
Assets::<T, I>::approve_transfer(origin, id, delegate_lookup.clone(), amount)?;
}: _(SystemOrigin::Signed(caller.clone()), id, delegate_lookup)
verify {
assert_last_event::<T, I>(Event::ApprovalCancelled(id, caller, delegate).into());
assert_last_event::<T, I>(Event::ApprovalCancelled { asset_id: id, owner: caller, delegate }.into());
}
force_cancel_approval {
@@ -435,7 +435,7 @@ benchmarks_instance_pallet! {
Assets::<T, I>::approve_transfer(origin, id, delegate_lookup.clone(), amount)?;
}: _(SystemOrigin::Signed(caller.clone()), id, caller_lookup, delegate_lookup)
verify {
assert_last_event::<T, I>(Event::ApprovalCancelled(id, caller, delegate).into());
assert_last_event::<T, I>(Event::ApprovalCancelled { asset_id: id, owner: caller, delegate }.into());
}
impl_benchmark_test_suite!(Assets, crate::mock::new_test_ext(), crate::mock::Test)
+33 -8
View File
@@ -275,7 +275,11 @@ impl<T: Config<I>, I: 'static> Pallet<T, I> {
details.supply = details.supply.saturating_add(amount);
Ok(())
})?;
Self::deposit_event(Event::Issued(id, beneficiary.clone(), amount));
Self::deposit_event(Event::Issued {
asset_id: id,
owner: beneficiary.clone(),
total_supply: amount,
});
Ok(())
}
@@ -342,7 +346,7 @@ impl<T: Config<I>, I: 'static> Pallet<T, I> {
Ok(())
})?;
Self::deposit_event(Event::Burned(id, target.clone(), actual));
Self::deposit_event(Event::Burned { asset_id: id, owner: target.clone(), balance: actual });
Ok(actual)
}
@@ -415,7 +419,12 @@ impl<T: Config<I>, I: 'static> Pallet<T, I> {
) -> Result<T::Balance, DispatchError> {
// Early exist if no-op.
if amount.is_zero() {
Self::deposit_event(Event::Transferred(id, source.clone(), dest.clone(), amount));
Self::deposit_event(Event::Transferred {
asset_id: id,
from: source.clone(),
to: dest.clone(),
amount,
});
return Ok(amount)
}
@@ -476,7 +485,12 @@ impl<T: Config<I>, I: 'static> Pallet<T, I> {
Ok(())
})?;
Self::deposit_event(Event::Transferred(id, source.clone(), dest.clone(), credit));
Self::deposit_event(Event::Transferred {
asset_id: id,
from: source.clone(),
to: dest.clone(),
amount: credit,
});
Ok(credit)
}
@@ -514,7 +528,7 @@ impl<T: Config<I>, I: 'static> Pallet<T, I> {
is_frozen: false,
},
);
Self::deposit_event(Event::ForceCreated(id, owner));
Self::deposit_event(Event::ForceCreated { asset_id: id, owner });
Ok(())
}
@@ -554,7 +568,7 @@ impl<T: Config<I>, I: 'static> Pallet<T, I> {
for ((owner, _), approval) in Approvals::<T, I>::drain_prefix((&id,)) {
T::Currency::unreserve(&owner, approval.deposit);
}
Self::deposit_event(Event::Destroyed(id));
Self::deposit_event(Event::Destroyed { asset_id: id });
Ok(DestroyWitness {
accounts: details.accounts,
@@ -599,7 +613,12 @@ impl<T: Config<I>, I: 'static> Pallet<T, I> {
},
)?;
Asset::<T, I>::insert(id, d);
Self::deposit_event(Event::ApprovedTransfer(id, owner.clone(), delegate.clone(), amount));
Self::deposit_event(Event::ApprovedTransfer {
asset_id: id,
source: owner.clone(),
delegate: delegate.clone(),
amount,
});
Ok(())
}
@@ -683,7 +702,13 @@ impl<T: Config<I>, I: 'static> Pallet<T, I> {
is_frozen: false,
});
Self::deposit_event(Event::MetadataSet(id, name, symbol, decimals, false));
Self::deposit_event(Event::MetadataSet {
asset_id: id,
name,
symbol,
decimals,
is_frozen: false,
});
Ok(())
})
}
+77 -48
View File
@@ -379,47 +379,70 @@ pub mod pallet {
#[pallet::event]
#[pallet::generate_deposit(pub(super) fn deposit_event)]
pub enum Event<T: Config<I>, I: 'static = ()> {
/// Some asset class was created. \[asset_id, creator, owner\]
Created(T::AssetId, T::AccountId, T::AccountId),
/// Some assets were issued. \[asset_id, owner, total_supply\]
Issued(T::AssetId, T::AccountId, T::Balance),
/// Some assets were transferred. \[asset_id, from, to, amount\]
Transferred(T::AssetId, T::AccountId, T::AccountId, T::Balance),
/// Some assets were destroyed. \[asset_id, owner, balance\]
Burned(T::AssetId, T::AccountId, T::Balance),
/// The management team changed \[asset_id, issuer, admin, freezer\]
TeamChanged(T::AssetId, T::AccountId, T::AccountId, T::AccountId),
/// The owner changed \[asset_id, owner\]
OwnerChanged(T::AssetId, T::AccountId),
/// Some account `who` was frozen. \[asset_id, who\]
Frozen(T::AssetId, T::AccountId),
/// Some account `who` was thawed. \[asset_id, who\]
Thawed(T::AssetId, T::AccountId),
/// Some asset `asset_id` was frozen. \[asset_id\]
AssetFrozen(T::AssetId),
/// Some asset `asset_id` was thawed. \[asset_id\]
AssetThawed(T::AssetId),
/// Some asset class was created.
Created { asset_id: T::AssetId, creator: T::AccountId, owner: T::AccountId },
/// Some assets were issued.
Issued { asset_id: T::AssetId, owner: T::AccountId, total_supply: T::Balance },
/// Some assets were transferred.
Transferred {
asset_id: T::AssetId,
from: T::AccountId,
to: T::AccountId,
amount: T::Balance,
},
/// Some assets were destroyed.
Burned { asset_id: T::AssetId, owner: T::AccountId, balance: T::Balance },
/// The management team changed.
TeamChanged {
asset_id: T::AssetId,
issuer: T::AccountId,
admin: T::AccountId,
freezer: T::AccountId,
},
/// The owner changed.
OwnerChanged { asset_id: T::AssetId, owner: T::AccountId },
/// Some account `who` was frozen.
Frozen { asset_id: T::AssetId, who: T::AccountId },
/// Some account `who` was thawed.
Thawed { asset_id: T::AssetId, who: T::AccountId },
/// Some asset `asset_id` was frozen.
AssetFrozen { asset_id: T::AssetId },
/// Some asset `asset_id` was thawed.
AssetThawed { asset_id: T::AssetId },
/// An asset class was destroyed.
Destroyed(T::AssetId),
/// Some asset class was force-created. \[asset_id, owner\]
ForceCreated(T::AssetId, T::AccountId),
/// New metadata has been set for an asset. \[asset_id, name, symbol, decimals, is_frozen\]
MetadataSet(T::AssetId, Vec<u8>, Vec<u8>, u8, bool),
/// Metadata has been cleared for an asset. \[asset_id\]
MetadataCleared(T::AssetId),
Destroyed { asset_id: T::AssetId },
/// Some asset class was force-created.
ForceCreated { asset_id: T::AssetId, owner: T::AccountId },
/// New metadata has been set for an asset.
MetadataSet {
asset_id: T::AssetId,
name: Vec<u8>,
symbol: Vec<u8>,
decimals: u8,
is_frozen: bool,
},
/// Metadata has been cleared for an asset.
MetadataCleared { asset_id: T::AssetId },
/// (Additional) funds have been approved for transfer to a destination account.
/// \[asset_id, source, delegate, amount\]
ApprovedTransfer(T::AssetId, T::AccountId, T::AccountId, T::Balance),
ApprovedTransfer {
asset_id: T::AssetId,
source: T::AccountId,
delegate: T::AccountId,
amount: T::Balance,
},
/// An approval for account `delegate` was cancelled by `owner`.
/// \[id, owner, delegate\]
ApprovalCancelled(T::AssetId, T::AccountId, T::AccountId),
ApprovalCancelled { asset_id: T::AssetId, owner: T::AccountId, delegate: T::AccountId },
/// An `amount` was transferred in its entirety from `owner` to `destination` by
/// the approved `delegate`.
/// \[id, owner, delegate, destination\]
TransferredApproved(T::AssetId, T::AccountId, T::AccountId, T::AccountId, T::Balance),
TransferredApproved {
asset_id: T::AssetId,
owner: T::AccountId,
delegate: T::AccountId,
destination: T::AccountId,
amount: T::Balance,
},
/// An asset has had its attributes changed by the `Force` origin.
/// \[id\]
AssetStatusChanged(T::AssetId),
AssetStatusChanged { asset_id: T::AssetId },
}
#[pallet::error]
@@ -505,7 +528,7 @@ pub mod pallet {
is_frozen: false,
},
);
Self::deposit_event(Event::Created(id, owner, admin));
Self::deposit_event(Event::Created { asset_id: id, creator: owner, owner: admin });
Ok(())
}
@@ -761,7 +784,7 @@ pub mod pallet {
Account::<T, I>::mutate(id, &who, |a| a.is_frozen = true);
Self::deposit_event(Event::<T, I>::Frozen(id, who));
Self::deposit_event(Event::<T, I>::Frozen { asset_id: id, who });
Ok(())
}
@@ -790,7 +813,7 @@ pub mod pallet {
Account::<T, I>::mutate(id, &who, |a| a.is_frozen = false);
Self::deposit_event(Event::<T, I>::Thawed(id, who));
Self::deposit_event(Event::<T, I>::Thawed { asset_id: id, who });
Ok(())
}
@@ -816,7 +839,7 @@ pub mod pallet {
d.is_frozen = true;
Self::deposit_event(Event::<T, I>::AssetFrozen(id));
Self::deposit_event(Event::<T, I>::AssetFrozen { asset_id: id });
Ok(())
})
}
@@ -843,7 +866,7 @@ pub mod pallet {
d.is_frozen = false;
Self::deposit_event(Event::<T, I>::AssetThawed(id));
Self::deposit_event(Event::<T, I>::AssetThawed { asset_id: id });
Ok(())
})
}
@@ -882,7 +905,7 @@ pub mod pallet {
details.owner = owner.clone();
Self::deposit_event(Event::OwnerChanged(id, owner));
Self::deposit_event(Event::OwnerChanged { asset_id: id, owner });
Ok(())
})
}
@@ -920,7 +943,7 @@ pub mod pallet {
details.admin = admin.clone();
details.freezer = freezer.clone();
Self::deposit_event(Event::TeamChanged(id, issuer, admin, freezer));
Self::deposit_event(Event::TeamChanged { asset_id: id, issuer, admin, freezer });
Ok(())
})
}
@@ -977,7 +1000,7 @@ pub mod pallet {
Metadata::<T, I>::try_mutate_exists(id, |metadata| {
let deposit = metadata.take().ok_or(Error::<T, I>::Unknown)?.deposit;
T::Currency::unreserve(&d.owner, deposit);
Self::deposit_event(Event::MetadataCleared(id));
Self::deposit_event(Event::MetadataCleared { asset_id: id });
Ok(())
})
}
@@ -1024,7 +1047,13 @@ pub mod pallet {
is_frozen,
});
Self::deposit_event(Event::MetadataSet(id, name, symbol, decimals, is_frozen));
Self::deposit_event(Event::MetadataSet {
asset_id: id,
name,
symbol,
decimals,
is_frozen,
});
Ok(())
})
}
@@ -1051,7 +1080,7 @@ pub mod pallet {
Metadata::<T, I>::try_mutate_exists(id, |metadata| {
let deposit = metadata.take().ok_or(Error::<T, I>::Unknown)?.deposit;
T::Currency::unreserve(&d.owner, deposit);
Self::deposit_event(Event::MetadataCleared(id));
Self::deposit_event(Event::MetadataCleared { asset_id: id });
Ok(())
})
}
@@ -1103,7 +1132,7 @@ pub mod pallet {
asset.is_frozen = is_frozen;
*maybe_asset = Some(asset);
Self::deposit_event(Event::AssetStatusChanged(id));
Self::deposit_event(Event::AssetStatusChanged { asset_id: id });
Ok(())
})
}
@@ -1169,7 +1198,7 @@ pub mod pallet {
d.approvals.saturating_dec();
Asset::<T, I>::insert(id, d);
Self::deposit_event(Event::ApprovalCancelled(id, owner, delegate));
Self::deposit_event(Event::ApprovalCancelled { asset_id: id, owner, delegate });
Ok(())
}
@@ -1211,7 +1240,7 @@ pub mod pallet {
d.approvals.saturating_dec();
Asset::<T, I>::insert(id, d);
Self::deposit_event(Event::ApprovalCancelled(id, owner, delegate));
Self::deposit_event(Event::ApprovalCancelled { asset_id: id, owner, delegate });
Ok(())
}
+6 -1
View File
@@ -500,7 +500,12 @@ fn transferring_less_than_one_unit_is_fine() {
assert_ok!(Assets::mint(Origin::signed(1), 0, 1, 100));
assert_eq!(Assets::balance(0, 1), 100);
assert_ok!(Assets::transfer(Origin::signed(1), 0, 2, 0));
System::assert_last_event(mock::Event::Assets(crate::Event::Transferred(0, 1, 2, 0)));
System::assert_last_event(mock::Event::Assets(crate::Event::Transferred {
asset_id: 0,
from: 1,
to: 2,
amount: 0,
}));
});
}