From 65ad654ac727a123c9638c205ca020212fbb8fd8 Mon Sep 17 00:00:00 2001 From: chungquantin <56880684+chungquantin@users.noreply.github.com> Date: Fri, 13 Sep 2024 21:45:34 +0700 Subject: [PATCH] refactor: api event naming conventions --- pallets/api/src/fungibles/mod.rs | 42 +++++++++++++++++++----------- pallets/api/src/fungibles/tests.rs | 26 +++++++++--------- 2 files changed, 40 insertions(+), 28 deletions(-) diff --git a/pallets/api/src/fungibles/mod.rs b/pallets/api/src/fungibles/mod.rs index e38a8980..58f78747 100644 --- a/pallets/api/src/fungibles/mod.rs +++ b/pallets/api/src/fungibles/mod.rs @@ -134,7 +134,7 @@ pub mod pallet { #[pallet::generate_deposit(pub(super) fn deposit_event)] pub enum Event { /// Event emitted when allowance by `owner` to `spender` changes. - Approval { + Approved { /// The token. token: TokenIdOf, /// The owner providing the allowance. @@ -145,7 +145,7 @@ pub mod pallet { value: BalanceOf, }, /// Event emitted when a token transfer occurs. - Transfer { + Transferred { /// The token. token: TokenIdOf, /// The source of the transfer. `None` when minting. @@ -156,7 +156,7 @@ pub mod pallet { value: BalanceOf, }, /// Event emitted when a token is created. - Create { + Created { /// The token identifier. id: TokenIdOf, /// The creator of the token. @@ -189,7 +189,12 @@ pub mod pallet { T::Lookup::unlookup(to.clone()), value, )?; - Self::deposit_event(Event::Transfer { token, from: Some(from), to: Some(to), value }); + Self::deposit_event(Event::Transferred { + token, + from: Some(from), + to: Some(to), + value, + }); Ok(()) } @@ -217,7 +222,12 @@ pub mod pallet { T::Lookup::unlookup(to.clone()), value, )?; - Self::deposit_event(Event::Transfer { token, from: Some(from), to: Some(to), value }); + Self::deposit_event(Event::Transferred { + token, + from: Some(from), + to: Some(to), + value, + }); Ok(()) } @@ -278,7 +288,7 @@ pub mod pallet { } }, }; - Self::deposit_event(Event::Approval { token, owner, spender, value }); + Self::deposit_event(Event::Approved { token, owner, spender, value }); Ok(Some(weight).into()) } @@ -306,7 +316,7 @@ pub mod pallet { ) .map_err(|e| e.with_weight(AssetsWeightInfoOf::::approve_transfer()))?; let value = AssetsOf::::allowance(token.clone(), &owner, &spender); - Self::deposit_event(Event::Approval { token, owner, spender, value }); + Self::deposit_event(Event::Approved { token, owner, spender, value }); Ok(().into()) } @@ -352,7 +362,7 @@ pub mod pallet { )?; WeightOf::::approve(1, 1) }; - Self::deposit_event(Event::Approval { token, owner, spender, value: new_allowance }); + Self::deposit_event(Event::Approved { token, owner, spender, value: new_allowance }); Ok(Some(weight).into()) } @@ -377,7 +387,7 @@ pub mod pallet { T::Lookup::unlookup(admin.clone()), min_balance, )?; - Self::deposit_event(Event::Create { id, creator, admin }); + Self::deposit_event(Event::Created { id, creator, admin }); Ok(()) } @@ -445,7 +455,7 @@ pub mod pallet { T::Lookup::unlookup(account.clone()), value, )?; - Self::deposit_event(Event::Transfer { token, from: None, to: Some(account), value }); + Self::deposit_event(Event::Transferred { token, from: None, to: Some(account), value }); Ok(()) } @@ -469,7 +479,7 @@ pub mod pallet { T::Lookup::unlookup(account.clone()), value, )?; - Self::deposit_event(Event::Transfer { token, from: Some(account), to: None, value }); + Self::deposit_event(Event::Transferred { token, from: Some(account), to: None, value }); Ok(()) } } @@ -498,10 +508,12 @@ pub mod pallet { use Read::*; match request { TotalSupply(token) => ReadResult::TotalSupply(AssetsOf::::total_supply(token)), - BalanceOf { token, owner } => - ReadResult::BalanceOf(AssetsOf::::balance(token, owner)), - Allowance { token, owner, spender } => - ReadResult::Allowance(AssetsOf::::allowance(token, &owner, &spender)), + BalanceOf { token, owner } => { + ReadResult::BalanceOf(AssetsOf::::balance(token, owner)) + }, + Allowance { token, owner, spender } => { + ReadResult::Allowance(AssetsOf::::allowance(token, &owner, &spender)) + }, TokenName(token) => ReadResult::TokenName( as MetadataInspect< AccountIdOf, >>::name(token)), diff --git a/pallets/api/src/fungibles/tests.rs b/pallets/api/src/fungibles/tests.rs index 747785c1..1467446b 100644 --- a/pallets/api/src/fungibles/tests.rs +++ b/pallets/api/src/fungibles/tests.rs @@ -89,7 +89,7 @@ fn transfer_works() { let balance_after_transfer = Assets::balance(token, &to); assert_eq!(balance_after_transfer, balance_before_transfer + value); System::assert_last_event( - Event::Transfer { token, from: Some(from), to: Some(to), value }.into(), + Event::Transferred { token, from: Some(from), to: Some(to), value }.into(), ); }); } @@ -123,7 +123,7 @@ fn transfer_from_works() { assert_eq!(to_balance_after_transfer, to_balance_before_transfer + value); assert_eq!(from_balance_after_transfer, from_balance_before_transfer - value); System::assert_last_event( - Event::Transfer { token, from: Some(from), to: Some(to), value }.into(), + Event::Transferred { token, from: Some(from), to: Some(to), value }.into(), ); }); } @@ -195,7 +195,7 @@ mod approve { Ok(Some(WeightInfo::approve(1, 0)).into()) ); assert_eq!(Assets::allowance(token, &owner, &spender), value); - System::assert_last_event(Event::Approval { token, owner, spender, value }.into()); + System::assert_last_event(Event::Approved { token, owner, spender, value }.into()); // Approves a value to spend that is lower than the current allowance. assert_eq!( Fungibles::approve(signed(owner), token, spender, value / 2), @@ -203,7 +203,7 @@ mod approve { ); assert_eq!(Assets::allowance(token, &owner, &spender), value / 2); System::assert_last_event( - Event::Approval { token, owner, spender, value: value / 2 }.into(), + Event::Approved { token, owner, spender, value: value / 2 }.into(), ); // Approves a value to spend that is equal to the current allowance. assert_eq!( @@ -212,7 +212,7 @@ mod approve { ); assert_eq!(Assets::allowance(token, &owner, &spender), value / 2); System::assert_last_event( - Event::Approval { token, owner, spender, value: value / 2 }.into(), + Event::Approved { token, owner, spender, value: value / 2 }.into(), ); // Sets allowance to zero. assert_eq!( @@ -220,7 +220,7 @@ mod approve { Ok(Some(WeightInfo::approve(0, 1)).into()) ); assert_eq!(Assets::allowance(token, &owner, &spender), 0); - System::assert_last_event(Event::Approval { token, owner, spender, value: 0 }.into()); + System::assert_last_event(Event::Approved { token, owner, spender, value: 0 }.into()); }); } } @@ -248,12 +248,12 @@ fn increase_allowance_works() { assert_eq!(0, Assets::allowance(token, &owner, &spender)); assert_ok!(Fungibles::increase_allowance(signed(owner), token, spender, value)); assert_eq!(Assets::allowance(token, &owner, &spender), value); - System::assert_last_event(Event::Approval { token, owner, spender, value }.into()); + System::assert_last_event(Event::Approved { token, owner, spender, value }.into()); // Additive. assert_ok!(Fungibles::increase_allowance(signed(owner), token, spender, value)); assert_eq!(Assets::allowance(token, &owner, &spender), value * 2); System::assert_last_event( - Event::Approval { token, owner, spender, value: value * 2 }.into(), + Event::Approved { token, owner, spender, value: value * 2 }.into(), ); }); } @@ -293,7 +293,7 @@ fn decrease_allowance_works() { ); assert_eq!(Assets::allowance(token, &owner, &spender), value / 2); System::assert_last_event( - Event::Approval { token, owner, spender, value: value / 2 }.into(), + Event::Approved { token, owner, spender, value: value / 2 }.into(), ); // Saturating if current allowance is decreased more than the owner balance. assert_eq!( @@ -301,7 +301,7 @@ fn decrease_allowance_works() { Ok(Some(WeightInfo::approve(0, 1)).into()) ); assert_eq!(Assets::allowance(token, &owner, &spender), 0); - System::assert_last_event(Event::Approval { token, owner, spender, value: 0 }.into()); + System::assert_last_event(Event::Approved { token, owner, spender, value: 0 }.into()); }); } @@ -318,7 +318,7 @@ fn create_works() { assert!(!Assets::asset_exists(id)); assert_ok!(Fungibles::create(signed(creator), id, admin, 100)); assert!(Assets::asset_exists(id)); - System::assert_last_event(Event::Create { id, creator, admin }.into()); + System::assert_last_event(Event::Created { id, creator, admin }.into()); // Check error works for `Assets::create()`. assert_noop!(Fungibles::create(signed(creator), id, admin, 100), AssetsError::InUse); }); @@ -402,7 +402,7 @@ fn mint_works() { let balance_after_mint = Assets::balance(token, &to); assert_eq!(balance_after_mint, balance_before_mint + value); System::assert_last_event( - Event::Transfer { token, from: None, to: Some(to), value }.into(), + Event::Transferred { token, from: None, to: Some(to), value }.into(), ); }); } @@ -426,7 +426,7 @@ fn burn_works() { let balance_after_burn = Assets::balance(token, &from); assert_eq!(balance_after_burn, balance_before_burn - value); System::assert_last_event( - Event::Transfer { token, from: Some(from), to: None, value }.into(), + Event::Transferred { token, from: Some(from), to: None, value }.into(), ); }); }