add tokens benchmarks

Author: zjb0807

tokens/Cargo.toml

@@ -13,6 +13,7 @@ log = { workspace = true }
 scale-info = { workspace = true }
 serde = { workspace = true, optional = true }
 
+frame-benchmarking = { workspace = true, optional = true }
 frame-support = { workspace = true }
 frame-system = { workspace = true }
 sp-arithmetic = { workspace = true }
@@ -31,6 +32,7 @@ sp-staking = { workspace = true, features = ["std"] }
 [features]
 default = [ "std" ]
 std = [
+	"frame-benchmarking?/std",
 	"frame-support/std",
 	"frame-system/std",
 	"log/std",
@@ -43,9 +45,11 @@ std = [
 	"sp-std/std",
 ]
 runtime-benchmarks = [
+	"frame-benchmarking/runtime-benchmarks",
 	"frame-support/runtime-benchmarks",
 	"frame-system/runtime-benchmarks",
 	"sp-runtime/runtime-benchmarks",
+	"pallet-treasury/runtime-benchmarks",
 ]
 try-runtime = [
 	"frame-support/try-runtime",

tokens/src/benchmarking.rs

@@ -0,0 +1,146 @@
+pub use crate::*;
+
+use frame_benchmarking::v2::*;
+use frame_support::assert_ok;
+use frame_system::RawOrigin;
+use sp_runtime::traits::SaturatedConversion;
+
+/// Helper trait for benchmarking.
+pub trait BenchmarkHelper<CurrencyId> {
+	/// Returns a currency id to be used for benchmarking.
+	fn get_currency_id() -> Option<CurrencyId>;
+}
+
+impl<CurrencyId> BenchmarkHelper<CurrencyId> for () {
+	fn get_currency_id() -> Option<CurrencyId> {
+		None
+	}
+}
+
+const AMOUNT: u32 = 1_000_000_000;
+
+#[benchmarks]
+mod benchmarks {
+	use super::*;
+
+	#[benchmark]
+	fn transfer() {
+		let from: T::AccountId = account("from", 0, 0);
+		let amount: T::Balance = AMOUNT.into();
+
+		let currency_id: T::CurrencyId = T::BenchmarkHelper::get_currency_id().unwrap();
+
+		assert_ok!(<Pallet::<T> as MultiCurrencyExtended<_>>::update_balance(
+			currency_id,
+			&from,
+			amount.saturated_into()
+		));
+
+		let to: T::AccountId = account("to", 0, 0);
+		let to_lookup = <T as frame_system::Config>::Lookup::unlookup(to.clone());
+
+		#[extrinsic_call]
+		_(RawOrigin::Signed(from), to_lookup, currency_id, amount);
+
+		assert_eq!(Pallet::<T>::total_balance(currency_id, &to), amount);
+	}
+
+	#[benchmark]
+	fn transfer_all() {
+		let from: T::AccountId = account("from", 0, 0);
+		let amount: T::Balance = AMOUNT.into();
+
+		let currency_id: T::CurrencyId = T::BenchmarkHelper::get_currency_id().unwrap();
+
+		assert_ok!(<Pallet::<T> as MultiCurrencyExtended<_>>::update_balance(
+			currency_id,
+			&from,
+			amount.saturated_into()
+		));
+
+		let to: T::AccountId = account("to", 0, 0);
+		let to_lookup = <T as frame_system::Config>::Lookup::unlookup(to.clone());
+
+		#[extrinsic_call]
+		_(RawOrigin::Signed(from.clone()), to_lookup, currency_id, false);
+
+		assert_eq!(
+			<Pallet::<T> as MultiCurrency<_>>::total_balance(currency_id, &from),
+			0u32.into()
+		);
+	}
+
+	#[benchmark]
+	fn transfer_keep_alive() {
+		let from: T::AccountId = account("from", 0, 0);
+		let amount: T::Balance = AMOUNT.into();
+
+		let currency_id: T::CurrencyId = T::BenchmarkHelper::get_currency_id().unwrap();
+
+		assert_ok!(<Pallet::<T> as MultiCurrencyExtended<_>>::update_balance(
+			currency_id,
+			&from,
+			amount.saturating_mul(2u32.into()).saturated_into()
+		));
+
+		let to: T::AccountId = account("to", 0, 0);
+		let to_lookup = <T as frame_system::Config>::Lookup::unlookup(to.clone());
+
+		#[extrinsic_call]
+		_(RawOrigin::Signed(from), to_lookup, currency_id, amount);
+
+		assert_eq!(
+			<Pallet::<T> as MultiCurrency<_>>::total_balance(currency_id, &to),
+			amount
+		);
+	}
+
+	#[benchmark]
+	fn force_transfer() {
+		let from: T::AccountId = account("from", 0, 0);
+		let from_lookup = <T as frame_system::Config>::Lookup::unlookup(from.clone());
+		let amount: T::Balance = AMOUNT.into();
+
+		let currency_id: T::CurrencyId = T::BenchmarkHelper::get_currency_id().unwrap();
+
+		assert_ok!(<Pallet::<T> as MultiCurrencyExtended<_>>::update_balance(
+			currency_id,
+			&from,
+			amount.saturated_into()
+		));
+
+		let to: T::AccountId = account("to", 0, 0);
+		let to_lookup = <T as frame_system::Config>::Lookup::unlookup(to.clone());
+
+		#[extrinsic_call]
+		_(RawOrigin::Root, from_lookup, to_lookup, currency_id, amount);
+
+		assert_eq!(
+			<Pallet::<T> as MultiCurrency<_>>::total_balance(currency_id, &to),
+			amount
+		);
+	}
+
+	#[benchmark]
+	fn set_balance() {
+		let who: T::AccountId = account("who", 0, 0);
+		let who_lookup = <T as frame_system::Config>::Lookup::unlookup(who.clone());
+		let amount: T::Balance = AMOUNT.into();
+
+		let currency_id: T::CurrencyId = T::BenchmarkHelper::get_currency_id().unwrap();
+
+		#[extrinsic_call]
+		_(RawOrigin::Root, who_lookup, currency_id, amount, amount);
+
+		assert_eq!(
+			<Pallet::<T> as MultiCurrency<_>>::total_balance(currency_id, &who),
+			amount.saturating_mul(2u32.into())
+		);
+	}
+
+	impl_benchmark_test_suite! {
+		Pallet,
+		crate::mock::ExtBuilder::default().build(),
+		crate::mock::Runtime,
+	}
+}

tokens/src/lib.rs

@@ -71,6 +71,8 @@ use orml_traits::{
 	MultiReservableCurrency, NamedMultiReservableCurrency,
 };
 
+#[cfg(feature = "runtime-benchmarks")]
+mod benchmarking;
 mod imbalances;
 mod impls;
 mod mock;
@@ -82,6 +84,8 @@ mod tests_multicurrency;
 
 mod weights;
 
+#[cfg(feature = "runtime-benchmarks")]
+pub use benchmarking::BenchmarkHelper;
 pub use impls::*;
 pub use weights::WeightInfo;
 
@@ -226,6 +230,10 @@ pub mod module {
 		// The whitelist of accounts that will not be reaped even if its total
 		// is zero or below ED.
 		type DustRemovalWhitelist: Contains<Self::AccountId>;
+
+		/// The benchmarks need a way to create asset ids from u32s.
+		#[cfg(feature = "runtime-benchmarks")]
+		type BenchmarkHelper: BenchmarkHelper<Self::CurrencyId>;
 	}
 
 	#[pallet::error]

tokens/src/mock.rs

@@ -375,6 +375,15 @@ where
 	type OnKilledTokenAccount = TrackKilledAccounts<T>;
 }
 
+#[cfg(feature = "runtime-benchmarks")]
+pub struct MockBenchmarkHelper;
+#[cfg(feature = "runtime-benchmarks")]
+impl BenchmarkHelper<CurrencyId> for MockBenchmarkHelper {
+	fn get_currency_id() -> Option<CurrencyId> {
+		Some(DOT)
+	}
+}
+
 impl Config for Runtime {
 	type Balance = Balance;
 	type Amount = i64;
@@ -386,6 +395,8 @@ impl Config for Runtime {
 	type MaxReserves = ConstU32<2>;
 	type ReserveIdentifier = ReserveIdentifier;
 	type DustRemovalWhitelist = MockDustRemovalWhitelist;
+	#[cfg(feature = "runtime-benchmarks")]
+	type BenchmarkHelper = MockBenchmarkHelper;
 }
 pub type TreasuryCurrencyAdapter = <Runtime as pallet_treasury::Config>::Currency;