Feat/lp v2 gateway queue

Cargo.toml

@@ -23,6 +23,7 @@ members = [
   "pallets/liquidity-pools-gateway",
   "pallets/liquidity-pools-gateway/axelar-gateway-precompile",
   "pallets/liquidity-pools-gateway/routers",
+  "pallets/liquidity-pools-gateway/queue",
   "pallets/liquidity-rewards",
   "pallets/loans",
   "pallets/oracle-feed",
@@ -236,6 +237,7 @@ pallet-investments = { path = "pallets/investments", default-features = false }
 pallet-keystore = { path = "pallets/keystore", default-features = false }
 pallet-liquidity-pools = { path = "pallets/liquidity-pools", default-features = false }
 pallet-liquidity-pools-gateway = { path = "pallets/liquidity-pools-gateway", default-features = false }
+pallet-liquidity-pools-gateway-queue = { path = "pallets/liquidity-pools-gateway/queue", default-features = false }
 pallet-liquidity-rewards = { path = "pallets/liquidity-rewards", default-features = false }
 pallet-loans = { path = "pallets/loans", default-features = false }
 pallet-oracle-feed = { path = "pallets/oracle-feed", default-features = false }

README.md

@@ -54,6 +54,8 @@ On top of the [Substrate FRAME](https://docs.substrate.io/reference/frame-pallet
 - [**liquidity-pools**](https://github.com/centrifuge/centrifuge-chain/tree/main/pallets/liquidity-pools) ([docs](https://reference.centrifuge.io/pallet_liquidity_pools/index.html)): Provides the toolset to enable foreign investments on foreign domains.
 
 - [**liquidity-pools-gateway**](https://github.com/centrifuge/centrifuge-chain/tree/main/pallets/liquidity-pools-gateway) ([docs](https://reference.centrifuge.io/pallet_liquidity_pools_gateway/index.html)): The main handler of incoming and outgoing Liquidity Pools messages.
+- 
+- [**liquidity-pools-gateway-queue**](https://github.com/centrifuge/centrifuge-chain/tree/main/pallets/liquidity-pools-gateway/queue) ([docs](https://reference.centrifuge.io/pallet_liquidity_pools_gateway_queue/index.html)): The queue used by the Liquidity Pools Gateway for processing inbound/outbound messages.
 
 - [**liquidity-pools-gateway-routers**](https://github.com/centrifuge/centrifuge-chain/tree/main/pallets/liquidity-pools-gateway/routers) ([docs](https://reference.centrifuge.io/liquidity_pools_gateway_routers/index.html)): This crate contains the `DomainRouters` used by the Liquidity Pools Gateway pallet.
 

libs/mocks/src/lib.rs

@@ -8,6 +8,8 @@ pub mod foreign_investment;
 pub mod foreign_investment_hooks;
 pub mod investment;
 pub mod liquidity_pools;
+pub mod liquidity_pools_gateway;
+pub mod liquidity_pools_gateway_queue;
 pub mod liquidity_pools_gateway_routers;
 pub mod outbound_queue;
 pub mod pay_fee;
@@ -27,6 +29,8 @@ pub use data::pallet as pallet_mock_data;
 pub use fees::pallet as pallet_mock_fees;
 pub use investment::pallet as pallet_mock_investment;
 pub use liquidity_pools::pallet as pallet_mock_liquidity_pools;
+pub use liquidity_pools_gateway::pallet as pallet_mock_liquidity_pools_gateway;
+pub use liquidity_pools_gateway_queue::pallet as pallet_mock_liquidity_pools_gateway_queue;
 pub use liquidity_pools_gateway_routers::{pallet as pallet_mock_routers, RouterMock};
 pub use pay_fee::pallet as pallet_mock_pay_fee;
 pub use permissions::pallet as pallet_mock_permissions;

libs/mocks/src/liquidity_pools_gateway.rs

@@ -0,0 +1,31 @@
+#[frame_support::pallet(dev_mode)]
+pub mod pallet {
+	use cfg_traits::liquidity_pools::MessageProcessor;
+	use frame_support::pallet_prelude::*;
+	use mock_builder::{execute_call, register_call};
+
+	#[pallet::config]
+	pub trait Config: frame_system::Config {
+		type Message;
+	}
+
+	#[pallet::pallet]
+	pub struct Pallet<T>(_);
+
+	#[pallet::storage]
+	type CallIds<T: Config> = StorageMap<_, _, String, mock_builder::CallId>;
+
+	impl<T: Config> Pallet<T> {
+		pub fn mock_process(f: impl Fn(T::Message) -> DispatchResultWithPostInfo + 'static) {
+			register_call!(move |msg| f(msg));
+		}
+	}
+
+	impl<T: Config> MessageProcessor for Pallet<T> {
+		type Message = T::Message;
+
+		fn process(msg: Self::Message) -> DispatchResultWithPostInfo {
+			execute_call!(msg)
+		}
+	}
+}

libs/mocks/src/liquidity_pools_gateway_queue.rs

@@ -0,0 +1,31 @@
+#[frame_support::pallet(dev_mode)]
+pub mod pallet {
+	use cfg_traits::liquidity_pools::MessageQueue;
+	use frame_support::pallet_prelude::*;
+	use mock_builder::{execute_call, register_call};
+
+	#[pallet::config]
+	pub trait Config: frame_system::Config {
+		type Message;
+	}
+
+	#[pallet::pallet]
+	pub struct Pallet<T>(_);
+
+	#[pallet::storage]
+	type CallIds<T: Config> = StorageMap<_, _, String, mock_builder::CallId>;
+
+	impl<T: Config> Pallet<T> {
+		pub fn mock_submit(f: impl Fn(T::Message) -> DispatchResult + 'static) {
+			register_call!(move |msg| f(msg));
+		}
+	}
+
+	impl<T: Config> MessageQueue for Pallet<T> {
+		type Message = T::Message;
+
+		fn submit(msg: Self::Message) -> DispatchResult {
+			execute_call!(msg)
+		}
+	}
+}

libs/primitives/src/lib.rs

@@ -158,6 +158,9 @@ pub mod types {
 
 	/// The type for outbound LP message nonces.
 	pub type OutboundMessageNonce = u64;
+
+	/// The type for LP gateway message nonces.
+	pub type LPGatewayQueueMessageNonce = u64;
 }
 
 /// Common constants for all runtimes

libs/traits/src/liquidity_pools.rs

@@ -88,3 +88,20 @@ pub trait InboundQueue {
 	/// Submit a message to the inbound queue.
 	fn submit(sender: Self::Sender, msg: Self::Message) -> DispatchResult;
 }
+
+/// The trait required for queueing messages.
+pub trait MessageQueue {
+	/// The message type.
+	type Message;
+
+	/// Submit a message to the queue.
+	fn submit(msg: Self::Message) -> DispatchResult;
+}
+
+pub trait MessageProcessor {
+	/// The message type.
+	type Message;
+
+	/// Process a message.
+	fn process(msg: Self::Message) -> DispatchResultWithPostInfo;
+}

pallets/liquidity-pools-gateway/queue/Cargo.toml

@@ -0,0 +1,61 @@
+[package]
+authors = ["Centrifuge <admin@centrifuge.io>"]
+description = "Centrifuge Liquidity Pools Gateway Queue Pallet"
+edition = "2021"
+license = "LGPL-3.0"
+name = "pallet-liquidity-pools-gateway-queue"
+repository = "https://github.com/centrifuge/centrifuge-chain"
+version = "0.0.1"
+
+[package.metadata.docs.rs]
+targets = ["x86_64-unknown-linux-gnu"]
+
+[dependencies]
+parity-scale-codec = { workspace = true }
+scale-info = { workspace = true }
+
+frame-benchmarking = { workspace = true, optional = true }
+frame-support = { workspace = true }
+frame-system = { workspace = true }
+sp-core = { workspace = true }
+sp-runtime = { workspace = true }
+sp-std = { workspace = true }
+sp-arithmetic = { workspace = true }
+
+cfg-traits = { workspace = true }
+
+[dev-dependencies]
+cfg-mocks = { workspace = true, default-features = true }
+cfg-primitives = { workspace = true, default-features = true }
+
+pallet-balances = { workspace = true, default-features = true }
+
+sp-core = { workspace = true, default-features = true }
+sp-io = { workspace = true, default-features = true }
+
+[features]
+default = ["std"]
+std = [
+    "parity-scale-codec/std",
+    "scale-info/std",
+    "frame-support/std",
+    "frame-system/std",
+    "sp-runtime/std",
+    "sp-std/std",
+    "sp-arithmetic/std",
+    "frame-benchmarking/std",
+    "cfg-primitives/std",
+]
+runtime-benchmarks = [
+    "frame-benchmarking/runtime-benchmarks",
+    "frame-support/runtime-benchmarks",
+    "frame-system/runtime-benchmarks",
+    "sp-runtime/runtime-benchmarks",
+    "cfg-primitives/runtime-benchmarks",
+]
+try-runtime = [
+    "frame-support/try-runtime",
+    "frame-system/try-runtime",
+    "sp-runtime/try-runtime",
+    "cfg-primitives/try-runtime",
+]

pallets/liquidity-pools-gateway/queue/src/benchmarking.rs

@@ -0,0 +1,65 @@
+// Copyright 2024 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 cfg_traits::liquidity_pools::test_util::Message as LPTestMessage;
+use frame_benchmarking::{account, impl_benchmark_test_suite, v2::*};
+use frame_system::RawOrigin;
+use parity_scale_codec::EncodeLike;
+
+use super::*;
+
+#[benchmarks(
+	where
+		T: Config<Message = LPTestMessage>,
+		T::AccountId: EncodeLike<<T as frame_system::Config>::AccountId>,
+)]
+mod benchmarks {
+	use super::*;
+
+	#[benchmark]
+	fn process_message() -> Result<(), BenchmarkError> {
+		let caller: T::AccountId = account("acc_0", 0, 0);
+		let message = LPTestMessage {};
+		let nonce = T::MessageNonce::one();
+
+		MessageQueue::<T>::insert(nonce, message.clone());
+
+		#[cfg(test)]
+		mock::mock_lp_gateway_process_success(message);
+
+		#[extrinsic_call]
+		process_message(RawOrigin::Signed(caller), nonce);
+
+		Ok(())
+	}
+
+	#[benchmark]
+	fn process_failed_message() -> Result<(), BenchmarkError> {
+		let caller: T::AccountId = account("acc_0", 0, 0);
+		let message = LPTestMessage {};
+		let error = DispatchError::Unavailable;
+		let nonce = T::MessageNonce::one();
+
+		FailedMessageQueue::<T>::insert(nonce, (message.clone(), error));
+
+		#[cfg(test)]
+		mock::mock_lp_gateway_process_success(message);
+
+		#[extrinsic_call]
+		process_failed_message(RawOrigin::Signed(caller), nonce);
+
+		Ok(())
+	}
+
+	impl_benchmark_test_suite!(Pallet, crate::mock::new_test_ext(), crate::mock::Runtime);
+}