feat: benchmark foreign investments worst case

libs/traits/src/benchmarking.rs

@@ -67,6 +67,7 @@ pub trait ForeignInvestmentBenchmarkHelper {
 	type Balance;
 	type CurrencyId;
 	type InvestmentId;
+	type SetupInfo;
 
 	/// Perform necessary setup to enable an investor to invest with or redeem
 	/// into a foreign currency.
@@ -78,13 +79,7 @@ pub trait ForeignInvestmentBenchmarkHelper {
 	///  * The foreign currency id
 	///  * A trading account which can bidirectionally fulfill swap orders for
 	///    the (foreign, pool) currency pair
-	fn bench_prepare_foreign_investments_setup() -> (
-		Self::AccountId,
-		Self::InvestmentId,
-		Self::CurrencyId,
-		Self::CurrencyId,
-		Self::AccountId,
-	);
+	fn bench_prepare_foreign_investments_setup() -> Self::SetupInfo;
 
 	/// Perform necessary setup to prepare for the worst benchmark case by
 	/// calling just a single subsequent function.

libs/types/src/investments.rs

@@ -263,3 +263,20 @@ pub struct ExecutedForeignCollect<Balance, Currency> {
 	///   pool currency)
 	pub amount_remaining: Balance,
 }
+
+/// A representation of information helpful when doing a foreign investment
+/// benchmark setup.
+#[cfg(feature = "runtime-benchmarks")]
+pub struct BenchForeignInvestmentSetupInfo<AccountId, InvestmentId, CurrencyId> {
+	/// The substrate investor address
+	pub investor: AccountId,
+	/// The investment id
+	pub investment_id: InvestmentId,
+	/// The pool currency which eventually will be invested
+	pub pool_currency: CurrencyId,
+	/// The foreign currency which shall be invested and thus swapped into pool
+	/// currency beforehand
+	pub foreign_currency: CurrencyId,
+	/// Bidirectionally funded to fulfill token swap orders
+	pub funded_trader: AccountId,
+}

pallets/foreign-investments/src/impls/benchmark_utils.rs

@@ -1,4 +1,4 @@
-// Copyright 2021 Centrifuge Foundation (centrifuge.io).
+// Copyright 2023 Centrifuge Foundation (centrifuge.io).
 // This file is part of Centrifuge Chain project.
 
 // Centrifuge is free software: you can redistribute it and/or modify
@@ -20,6 +20,7 @@ use cfg_traits::{
 };
 use cfg_types::{
 	fixed_point::Ratio,
+	investments::BenchForeignInvestmentSetupInfo,
 	orders::{FulfillmentWithPrice, TotalOrder},
 	tokens::CurrencyId,
 };
@@ -60,20 +61,15 @@ where
 	type Balance = T::Balance;
 	type CurrencyId = T::CurrencyId;
 	type InvestmentId = T::InvestmentId;
+	type SetupInfo = BenchForeignInvestmentSetupInfo<T::AccountId, T::InvestmentId, T::CurrencyId>;
 
-	fn bench_prepare_foreign_investments_setup() -> (
-		T::AccountId,
-		T::InvestmentId,
-		T::CurrencyId,
-		T::CurrencyId,
-		T::AccountId,
-	) {
+	fn bench_prepare_foreign_investments_setup() -> Self::SetupInfo {
 		let pool_id = Default::default();
 		let pool_admin: T::AccountId = frame_benchmarking::account("pool_admin", 0, 0);
 		<T::PoolInspect as PoolBenchmarkHelper>::bench_create_pool(pool_id, &pool_admin);
 
 		// Add bidirectional trading pair and fund both accounts
-		let (investor, trader) =
+		let (investor, funded_trader) =
 			<T::TokenSwaps as OrderBookBenchmarkHelper>::bench_setup_trading_pair(
 				CURRENCY_POOL.into(),
 				CURRENCY_FOREIGN.into(),
@@ -100,13 +96,13 @@ where
 		let investment_id =
 			<T::PoolInspect as InvestmentIdBenchmarkHelper>::bench_default_investment_id(pool_id);
 
-		(
+		Self::SetupInfo {
 			investor,
 			investment_id,
-			CURRENCY_POOL.into(),
-			CURRENCY_FOREIGN.into(),
-			trader,
-		)
+			pool_currency: CURRENCY_POOL.into(),
+			foreign_currency: CURRENCY_FOREIGN.into(),
+			funded_trader,
+		}
 	}
 
 	fn bench_prep_foreign_investments_worst_case(

pallets/foreign-investments/src/impls/mod.rs

@@ -1252,9 +1252,3 @@ impl<T: Config> Pallet<T> {
 		)
 	}
 }
-
-// #[cfg(feature = "runtime-benchmarks")]
-// impl<T: Config> cfg_traits::benchmarking::ForeignInvestmentBenchmarkHelper
-// for Pallet<T> {
-
-// }

pallets/liquidity-pools-gateway/src/lib.rs

@@ -322,7 +322,7 @@ pub mod pallet {
 		}
 
 		/// Process an incoming message.
-		#[pallet::weight(0)]
+		#[pallet::weight(T::WeightInfo::process_msg())]
 		#[pallet::call_index(5)]
 		pub fn process_msg(
 			origin: OriginFor<T>,

pallets/liquidity-pools/src/benchmarking.rs

@@ -15,14 +15,15 @@ use cfg_traits::{
 	benchmarking::ForeignInvestmentBenchmarkHelper,
 	investments::{ForeignInvestment, TrancheCurrency},
 };
+use cfg_types::investments::BenchForeignInvestmentSetupInfo;
 use frame_benchmarking::v2::*;
 
 use super::*;
 use crate::Pallet;
 
 #[benchmarks(
     where
-        T::ForeignInvestment: ForeignInvestmentBenchmarkHelper<AccountId = T::AccountId, Balance = T::Balance, CurrencyId = T::CurrencyId, InvestmentId = T::TrancheCurrency>,
+        T::ForeignInvestment: ForeignInvestmentBenchmarkHelper<AccountId = T::AccountId, Balance = T::Balance, CurrencyId = T::CurrencyId, InvestmentId = T::TrancheCurrency, SetupInfo = BenchForeignInvestmentSetupInfo<T::AccountId, T::TrancheCurrency, T::CurrencyId>>,
         T::Balance: From<u128>,
         T::AccountId: From<[u8; 32]> + Into<[u8; 32]>,
 )]
@@ -31,7 +32,7 @@ mod benchmarks {
 
 	#[benchmark]
 	fn inbound_collect_redeem() {
-		let (investor, investment_id, pool_currency, foreign_currency, _) = <T::ForeignInvestment as ForeignInvestmentBenchmarkHelper>::bench_prepare_foreign_investments_setup();
+		let BenchForeignInvestmentSetupInfo { investor, investment_id, pool_currency, foreign_currency, .. } = <T::ForeignInvestment as ForeignInvestmentBenchmarkHelper>::bench_prepare_foreign_investments_setup();
 
 		// Fund investor with foreign currency and tranche tokens
 		T::Tokens::mint_into(

pallets/liquidity-pools/src/defensive_weights.rs

@@ -0,0 +1,95 @@
+// Copyright 2023 Centrifuge Foundation (centrifuge.io).
+// This file is part of 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.
+use frame_support::weights::{constants::RocksDbWeight, Weight};
+
+pub trait WeightInfo {
+	fn add_pool() -> Weight;
+	fn add_tranche() -> Weight;
+	fn update_token_price() -> Weight;
+	fn update_member() -> Weight;
+	fn transfer() -> Weight;
+	fn set_domain_router() -> Weight;
+}
+
+// NOTE: We use temporary weights here. `execute_epoch` is by far our heaviest
+//       extrinsic. N denotes the number of tranches. 4 is quite heavy and
+//       should be enough.
+const N: u64 = 4;
+
+impl WeightInfo for () {
+	fn set_domain_router() -> Weight {
+		// TODO: BENCHMARK AND USE REAL WEIGHTS
+		Weight::from_parts(78_019_565, 19974)
+			.saturating_add(Weight::from_ref_time(38_884_782).saturating_mul(N))
+			.saturating_add(RocksDbWeight::get().reads(8))
+			.saturating_add(RocksDbWeight::get().reads((7_u64).saturating_mul(N)))
+			.saturating_add(RocksDbWeight::get().writes(8))
+			.saturating_add(RocksDbWeight::get().writes((6_u64).saturating_mul(N)))
+			.saturating_add(Weight::from_proof_size(17774).saturating_mul(N))
+	}
+
+	fn add_pool() -> Weight {
+		// TODO: BENCHMARK AND USE REAL WEIGHTS
+		Weight::from_parts(78_019_565, 19974)
+			.saturating_add(Weight::from_ref_time(38_884_782).saturating_mul(N))
+			.saturating_add(RocksDbWeight::get().reads(8))
+			.saturating_add(RocksDbWeight::get().reads((7_u64).saturating_mul(N)))
+			.saturating_add(RocksDbWeight::get().writes(8))
+			.saturating_add(RocksDbWeight::get().writes((6_u64).saturating_mul(N)))
+			.saturating_add(Weight::from_proof_size(17774).saturating_mul(N))
+	}
+
+	fn add_tranche() -> Weight {
+		// TODO: BENCHMARK AND USE REAL WEIGHTS
+		Weight::from_parts(78_019_565, 19974)
+			.saturating_add(Weight::from_ref_time(38_884_782).saturating_mul(N))
+			.saturating_add(RocksDbWeight::get().reads(8))
+			.saturating_add(RocksDbWeight::get().reads((7_u64).saturating_mul(N)))
+			.saturating_add(RocksDbWeight::get().writes(8))
+			.saturating_add(RocksDbWeight::get().writes((6_u64).saturating_mul(N)))
+			.saturating_add(Weight::from_proof_size(17774).saturating_mul(N))
+	}
+
+	fn update_token_price() -> Weight {
+		// TODO: BENCHMARK AND USE REAL WEIGHTS
+		Weight::from_parts(78_019_565, 19974)
+			.saturating_add(Weight::from_ref_time(38_884_782).saturating_mul(N))
+			.saturating_add(RocksDbWeight::get().reads(8))
+			.saturating_add(RocksDbWeight::get().reads((7_u64).saturating_mul(N)))
+			.saturating_add(RocksDbWeight::get().writes(8))
+			.saturating_add(RocksDbWeight::get().writes((6_u64).saturating_mul(N)))
+			.saturating_add(Weight::from_proof_size(17774).saturating_mul(N))
+	}
+
+	fn update_member() -> Weight {
+		// TODO: BENCHMARK AND USE REAL WEIGHTS
+		Weight::from_parts(78_019_565, 19974)
+			.saturating_add(Weight::from_ref_time(38_884_782).saturating_mul(N))
+			.saturating_add(RocksDbWeight::get().reads(8))
+			.saturating_add(RocksDbWeight::get().reads((7_u64).saturating_mul(N)))
+			.saturating_add(RocksDbWeight::get().writes(8))
+			.saturating_add(RocksDbWeight::get().writes((6_u64).saturating_mul(N)))
+			.saturating_add(Weight::from_proof_size(17774).saturating_mul(N))
+	}
+
+	fn transfer() -> Weight {
+		// TODO: BENCHMARK AND USE REAL WEIGHTS
+		Weight::from_parts(78_019_565, 19974)
+			.saturating_add(Weight::from_ref_time(38_884_782).saturating_mul(N))
+			.saturating_add(RocksDbWeight::get().reads(8))
+			.saturating_add(RocksDbWeight::get().reads((7_u64).saturating_mul(N)))
+			.saturating_add(RocksDbWeight::get().writes(8))
+			.saturating_add(RocksDbWeight::get().writes((6_u64).saturating_mul(N)))
+			.saturating_add(Weight::from_proof_size(17774).saturating_mul(N))
+	}
+}

pallets/liquidity-pools/src/lib.rs

@@ -69,7 +69,9 @@ use xcm::{
 	VersionedMultiLocation,
 };
 
-pub mod weights;
+// NOTE: Should be replaced with generated weights in the future. For now, let's
+// be defensive.
+pub mod defensive_weights;
 
 mod message;
 pub use message::*;
@@ -129,7 +131,7 @@ pub mod pallet {
 	use xcm::latest::MultiLocation;
 
 	use super::*;
-	use crate::weights::WeightInfo;
+	use crate::defensive_weights::WeightInfo;
 
 	#[pallet::pallet]
 	#[pallet::generate_store(pub (super) trait Store)]