feat: orderbook bench helper

libs/mocks/src/pools.rs

@@ -23,6 +23,7 @@ pub mod pallet {
 		type Balance;
 		type BalanceRatio;
 		type CurrencyId;
+		type TrancheCurrency;
 	}
 
 	#[pallet::pallet]
@@ -66,12 +67,18 @@ pub mod pallet {
 			register_call!(move |(a, b, c)| f(a, b, c));
 		}
 
-		pub fn mock_benchmark_create_pool(f: impl Fn(T::PoolId, &T::AccountId) + 'static) {
+		pub fn mock_bench_create_pool(f: impl Fn(T::PoolId, &T::AccountId) + 'static) {
 			register_call!(move |(a, b)| f(a, b));
 		}
 
-		pub fn mock_benchmark_give_ausd(f: impl Fn(&T::AccountId, T::Balance) + 'static) {
-			register_call!(move |(a, b)| f(a, b));
+		pub fn mock_bench_investor_setup(
+			f: impl Fn(T::PoolId, T::AccountId, T::Balance) + 'static,
+		) {
+			register_call!(move |(a, b, c)| f(a, b, c));
+		}
+
+		pub fn mock_bench_default_investment_id(f: impl Fn(T::TrancheCurrency) + 'static) {
+			register_call!(f);
 		}
 	}
 
@@ -124,17 +131,27 @@ pub mod pallet {
 	}
 
 	#[cfg(feature = "runtime-benchmarks")]
-	impl<T: Config> cfg_traits::PoolBenchmarkHelper for Pallet<T> {
+	impl<T: Config> cfg_traits::benchmarking::PoolBenchmarkHelper for Pallet<T> {
 		type AccountId = T::AccountId;
 		type Balance = T::Balance;
 		type PoolId = T::PoolId;
 
-		fn benchmark_create_pool(a: Self::PoolId, b: &Self::AccountId) {
+		fn bench_create_pool(a: Self::PoolId, b: &Self::AccountId) {
 			execute_call!((a, b))
 		}
 
-		fn benchmark_give_ausd(a: &Self::AccountId, b: Self::Balance) {
-			execute_call!((a, b))
+		fn bench_investor_setup(a: Self::PoolId, b: Self::AccountId, c: Self::Balance) {
+			execute_call!((a, b, c))
+		}
+	}
+
+	#[cfg(feature = "runtime-benchmarks")]
+	impl<T: Config> cfg_traits::benchmarking::InvestmentIdBenchmarkHelper for Pallet<T> {
+		type InvestmentId = T::TrancheCurrency;
+		type PoolId = T::PoolId;
+
+		fn bench_default_investment_id(a: Self::PoolId) -> Self::InvestmentId {
+			execute_call!(a)
 		}
 	}
 }

libs/traits/src/benchmarking.rs

@@ -0,0 +1,60 @@
+// Copyright 2023 Centrifuge Foundation (centrifuge.io).
+//
+// This file is part of the Centrifuge chain project.
+// Centrifuge is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version (see http://www.gnu.org/licenses).
+// Centrifuge is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+/// Benchmark utility to create pools
+pub trait PoolBenchmarkHelper {
+	type PoolId;
+	type AccountId;
+	type Balance;
+
+	/// Create a pool for the given the pool id and the admin.
+	fn bench_create_pool(pool_id: Self::PoolId, admin: &Self::AccountId);
+
+	/// Prepare user to be able to invest, i.e. fund with pool currency and give
+	/// permissions.
+	fn bench_investor_setup(
+		pool_id: Self::PoolId,
+		account: Self::AccountId,
+		balance: Self::Balance,
+	);
+}
+
+/// Benchmark utility to expose investment identifiers
+pub trait InvestmentIdBenchmarkHelper {
+	type PoolId;
+	type InvestmentId;
+
+	/// Return the default investment id for the given pool.
+	fn bench_default_investment_id(pool_id: Self::PoolId) -> Self::InvestmentId;
+}
+
+/// Benchmark utility for adding currency trading pairs
+pub trait OrderBookBenchmarkHelper {
+	type AccountId;
+	type Balance;
+	type CurrencyId;
+	type OrderIdNonce;
+
+	/// Adds the corresponding trading pair, creates trader accounts and mints
+	/// appropriate amounts of balance into these
+	fn bench_setup_trading_pair(
+		asset_in: Self::CurrencyId,
+		asset_out: Self::CurrencyId,
+		amount_in: Self::Balance,
+		amount_out: Self::Balance,
+		decimals_in: u32,
+		decimals_out: u32,
+	) -> (Self::AccountId, Self::AccountId);
+
+	/// Fulfills the given swap order from the trader account
+	fn bench_fill_order_full(trader: Self::AccountId, order_id: Self::OrderIdNonce);
+}

libs/traits/src/lib.rs

@@ -49,6 +49,10 @@ pub mod liquidity_pools;
 /// Traits related to rewards.
 pub mod rewards;
 
+#[cfg(feature = "runtime-benchmarks")]
+/// Traits related to benchmarking tooling.
+pub mod benchmarking;
+
 /// A trait used for loosely coupling the claim pallet with a reward mechanism.
 ///
 /// ## Overview
@@ -128,8 +132,10 @@ pub trait PoolInspect<AccountId, CurrencyId> {
 	type TrancheId;
 	type Moment;
 
-	/// check if the pool exists
+	/// Check if the pool exists
 	fn pool_exists(pool_id: Self::PoolId) -> bool;
+
+	/// Check if the tranche exists for the given pool
 	fn tranche_exists(pool_id: Self::PoolId, tranche_id: Self::TrancheId) -> bool;
 
 	/// Get the account used for the given `pool_id`.
@@ -257,20 +263,6 @@ pub trait PoolWriteOffPolicyMutate<PoolId> {
 	fn worst_case_policy() -> Self::Policy;
 }
 
-/// Utility to benchmark pools easily
-#[cfg(feature = "runtime-benchmarks")]
-pub trait PoolBenchmarkHelper {
-	type PoolId;
-	type AccountId;
-	type Balance;
-
-	/// Create a benchmark pool giving the id and the admin.
-	fn benchmark_create_pool(pool_id: Self::PoolId, admin: &Self::AccountId);
-
-	/// Give AUSD to the account
-	fn benchmark_give_ausd(account: &Self::AccountId, balance: Self::Balance);
-}
-
 /// A trait that can be used to retrieve the current price for a currency
 pub struct CurrencyPair<CurrencyId> {
 	pub base: CurrencyId,

pallets/loans/src/benchmarking.rs

@@ -13,10 +13,11 @@
 
 use cfg_primitives::CFG;
 use cfg_traits::{
+	benchmarking::PoolBenchmarkHelper,
 	changes::ChangeGuard,
 	data::DataRegistry,
 	interest::{CompoundingSchedule, InterestAccrual, InterestRate},
-	Permissions, PoolBenchmarkHelper, PoolWriteOffPolicyMutate,
+	Permissions, PoolWriteOffPolicyMutate,
 };
 use cfg_types::{
 	adjustments::Adjustment,
@@ -77,8 +78,8 @@ fn config_mocks() {
 	MockPools::mock_account_for(|_| 0);
 	MockPools::mock_withdraw(|_, _, _| Ok(()));
 	MockPools::mock_deposit(|_, _, _| Ok(()));
-	MockPools::mock_benchmark_create_pool(|_, _| {});
-	MockPools::mock_benchmark_give_ausd(|_, _| {});
+	MockPools::mock_bench_create_pool(|_, _| {});
+	MockPools::mock_bench_investor_setup(|_, _, _| {});
 	MockPrices::mock_feed_value(|_, _, _| Ok(()));
 	MockPrices::mock_register_id(|_, _| Ok(()));
 	MockPrices::mock_collection(|_| MockDataCollection::new(|_| Ok(Default::default())));
@@ -107,7 +108,7 @@ where
 		let pool_id = Default::default();
 
 		let pool_admin = account("pool_admin", 0, 0);
-		T::Pool::benchmark_create_pool(pool_id, &pool_admin);
+		T::Pool::bench_create_pool(pool_id, &pool_admin);
 
 		let loan_admin = account("loan_admin", 0, 0);
 		T::Permissions::add(
@@ -118,7 +119,7 @@ where
 		.unwrap();
 
 		let borrower = account::<T::AccountId>("borrower", 0, 0);
-		T::Pool::benchmark_give_ausd(&borrower, (FUNDS * CFG).into());
+		T::Pool::bench_investor_setup(pool_id, borrower.clone(), (FUNDS * CFG).into());
 		T::NonFungible::create_collection(&COLLECION_ID.into(), &borrower, &borrower).unwrap();
 		T::Permissions::add(
 			PermissionScope::Pool(pool_id),

pallets/loans/src/tests/mock.rs

@@ -17,7 +17,7 @@ use cfg_mocks::{
 	pallet_mock_change_guard, pallet_mock_data, pallet_mock_permissions, pallet_mock_pools,
 };
 use cfg_primitives::Moment;
-use cfg_types::permissions::PermissionScope;
+use cfg_types::{permissions::PermissionScope, tokens::TrancheCurrency};
 use codec::{Decode, Encode, MaxEncodedLen};
 use frame_support::traits::{
 	tokens::nonfungibles::{Create, Mutate},
@@ -199,6 +199,7 @@ impl pallet_mock_pools::Config for Runtime {
 	type BalanceRatio = Quantity;
 	type CurrencyId = CurrencyId;
 	type PoolId = PoolId;
+	type TrancheCurrency = TrancheCurrency;
 	type TrancheId = TrancheId;
 }