Skip to content

Commit

Permalink
refactor: api event naming conventions
Browse files Browse the repository at this point in the history
  • Loading branch information
chungquantin committed Sep 13, 2024
1 parent 497b2f7 commit 65ad654
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 28 deletions.
42 changes: 27 additions & 15 deletions pallets/api/src/fungibles/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ pub mod pallet {
#[pallet::generate_deposit(pub(super) fn deposit_event)]
pub enum Event<T: Config> {
/// Event emitted when allowance by `owner` to `spender` changes.
Approval {
Approved {
/// The token.
token: TokenIdOf<T>,
/// The owner providing the allowance.
Expand All @@ -145,7 +145,7 @@ pub mod pallet {
value: BalanceOf<T>,
},
/// Event emitted when a token transfer occurs.
Transfer {
Transferred {
/// The token.
token: TokenIdOf<T>,
/// The source of the transfer. `None` when minting.
Expand All @@ -156,7 +156,7 @@ pub mod pallet {
value: BalanceOf<T>,
},
/// Event emitted when a token is created.
Create {
Created {
/// The token identifier.
id: TokenIdOf<T>,
/// The creator of the token.
Expand Down Expand Up @@ -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(())
}

Expand Down Expand Up @@ -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(())
}

Expand Down Expand Up @@ -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())
}

Expand Down Expand Up @@ -306,7 +316,7 @@ pub mod pallet {
)
.map_err(|e| e.with_weight(AssetsWeightInfoOf::<T>::approve_transfer()))?;
let value = AssetsOf::<T>::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())
}

Expand Down Expand Up @@ -352,7 +362,7 @@ pub mod pallet {
)?;
WeightOf::<T>::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())
}

Expand All @@ -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(())
}

Expand Down Expand Up @@ -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(())
}

Expand All @@ -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(())
}
}
Expand Down Expand Up @@ -498,10 +508,12 @@ pub mod pallet {
use Read::*;
match request {
TotalSupply(token) => ReadResult::TotalSupply(AssetsOf::<T>::total_supply(token)),
BalanceOf { token, owner } =>
ReadResult::BalanceOf(AssetsOf::<T>::balance(token, owner)),
Allowance { token, owner, spender } =>
ReadResult::Allowance(AssetsOf::<T>::allowance(token, &owner, &spender)),
BalanceOf { token, owner } => {
ReadResult::BalanceOf(AssetsOf::<T>::balance(token, owner))
},
Allowance { token, owner, spender } => {
ReadResult::Allowance(AssetsOf::<T>::allowance(token, &owner, &spender))
},
TokenName(token) => ReadResult::TokenName(<AssetsOf<T> as MetadataInspect<
AccountIdOf<T>,
>>::name(token)),
Expand Down
26 changes: 13 additions & 13 deletions pallets/api/src/fungibles/tests.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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(),
);
});
}
Expand Down Expand Up @@ -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(),
);
});
}
Expand Down Expand Up @@ -195,15 +195,15 @@ 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),
Ok(Some(WeightInfo::approve(1, 1)).into())
);
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!(
Expand All @@ -212,15 +212,15 @@ 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!(
Fungibles::approve(signed(owner), token, spender, 0),
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());
});
}
}
Expand Down Expand Up @@ -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(),
);
});
}
Expand Down Expand Up @@ -293,15 +293,15 @@ 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!(
Fungibles::decrease_allowance(signed(owner), token, spender, value),
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());
});
}

Expand All @@ -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);
});
Expand Down Expand Up @@ -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(),
);
});
}
Expand All @@ -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(),
);
});
}
Expand Down

0 comments on commit 65ad654

Please sign in to comment.