Introduce XcmFeesToAccount fee manager

cumulus/pallets/xcmp-queue/Cargo.toml

@@ -18,9 +18,10 @@ sp-runtime = { path = "../../../substrate/primitives/runtime", default-features
 sp-std = { path = "../../../substrate/primitives/std", default-features = false}
 
 # Polkadot
-polkadot-runtime-common = { path = "../../../polkadot/runtime/common", default-features = false}
-xcm = { package = "staging-xcm", path = "../../../polkadot/xcm", default-features = false}
-xcm-executor = { package = "staging-xcm-executor", path = "../../../polkadot/xcm/xcm-executor", default-features = false}
+polkadot-runtime-common = { path = "../../../polkadot/runtime/common", default-features = false }
+polkadot-runtime-parachains = { path = "../../../polkadot/runtime/parachains", default-features = false }
+xcm = { package = "staging-xcm", path = "../../../polkadot/xcm", default-features = false }
+xcm-executor = { package = "staging-xcm-executor", path = "../../../polkadot/xcm/xcm-executor", default-features = false }
 
 # Cumulus
 cumulus-primitives-core = { path = "../../primitives/core", default-features = false }
@@ -50,6 +51,7 @@ std = [
 	"frame-system/std",
 	"log/std",
 	"polkadot-runtime-common/std",
+	"polkadot-runtime-parachains/std",
 	"scale-info/std",
 	"sp-io/std",
 	"sp-runtime/std",
@@ -65,6 +67,7 @@ runtime-benchmarks = [
 	"frame-system/runtime-benchmarks",
 	"pallet-balances/runtime-benchmarks",
 	"polkadot-runtime-common/runtime-benchmarks",
+	"polkadot-runtime-parachains/runtime-benchmarks",
 	"sp-runtime/runtime-benchmarks",
 	"xcm-builder/runtime-benchmarks",
 	"xcm-executor/runtime-benchmarks",
@@ -75,5 +78,6 @@ try-runtime = [
 	"frame-system/try-runtime",
 	"pallet-balances/try-runtime",
 	"polkadot-runtime-common/try-runtime",
+	"polkadot-runtime-parachains/try-runtime",
 	"sp-runtime/try-runtime",
 ]

cumulus/pallets/xcmp-queue/src/lib.rs

@@ -48,12 +48,13 @@ use frame_support::{
 	weights::{constants::WEIGHT_REF_TIME_PER_MILLIS, Weight},
 };
 use polkadot_runtime_common::xcm_sender::PriceForParachainDelivery;
+use polkadot_runtime_parachains::FeeTracker;
 use rand_chacha::{
 	rand_core::{RngCore, SeedableRng},
 	ChaChaRng,
 };
 use scale_info::TypeInfo;
-use sp_runtime::RuntimeDebug;
+use sp_runtime::{FixedU128, RuntimeDebug, Saturating};
 use sp_std::{convert::TryFrom, prelude::*};
 use xcm::{latest::prelude::*, VersionedXcm, WrapVersion, MAX_XCM_DECODE_DEPTH};
 use xcm_executor::traits::ConvertOrigin;
@@ -65,6 +66,8 @@ pub type OverweightIndex = u64;
 
 const LOG_TARGET: &str = "xcmp_queue";
 const DEFAULT_POV_SIZE: u64 = 64 * 1024; // 64 KB
+const EXPONENTIAL_FEE_BASE: FixedU128 = FixedU128::from_rational(105, 100); // 1.05
+const MESSAGE_SIZE_FEE_BASE: FixedU128 = FixedU128::from_rational(1, 1000); // 0.001
 
 // Maximum amount of messages to process per block. This is a temporary measure until we properly
 // account for proof size weights.
@@ -75,7 +78,7 @@ const MAX_OVERWEIGHT_MESSAGES: u32 = 1000;
 #[frame_support::pallet]
 pub mod pallet {
 	use super::*;
-	use frame_support::pallet_prelude::*;
+	use frame_support::{pallet_prelude::*, Twox64Concat};
 	use frame_system::pallet_prelude::*;
 
 	#[pallet::pallet]
@@ -372,6 +375,17 @@ pub mod pallet {
 	/// Whether or not the XCMP queue is suspended from executing incoming XCMs or not.
 	#[pallet::storage]
 	pub(super) type QueueSuspended<T: Config> = StorageValue<_, bool, ValueQuery>;
+
+	/// Initialization value for the DeliveryFee factor.
+	#[pallet::type_value]
+	pub fn InitialFactor() -> FixedU128 {
+		FixedU128::from_u32(1)
+	}
+
+	/// The factor to multiply the base delivery fee by.
+	#[pallet::storage]
+	pub(super) type DeliveryFeeFactor<T: Config> =
+		StorageMap<_, Twox64Concat, ParaId, FixedU128, ValueQuery, InitialFactor>;
 }
 
 #[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Encode, Decode, RuntimeDebug, TypeInfo)]
@@ -655,6 +669,7 @@ impl<T: Config> Pallet<T> {
 		messages_processed: &mut u8,
 		max_weight: Weight,
 		max_individual_weight: Weight,
+		should_decrement_fee_factor: bool,
 	) -> (Weight, bool) {
 		let data = <InboundXcmpMessages<T>>::get(sender, sent_at);
 		let mut last_remaining_fragments;
@@ -719,6 +734,10 @@ impl<T: Config> Pallet<T> {
 						debug_assert!(false, "Invalid incoming XCMP message data");
 						remaining_fragments = &b""[..];
 					}
+
+					if should_decrement_fee_factor {
+						Self::decrement_fee_factor(sender);
+					}
 				}
 			},
 			XcmpMessageFormat::ConcatenatedEncodedBlob => {
@@ -814,6 +833,7 @@ impl<T: Config> Pallet<T> {
 
 		let QueueConfigData {
 			resume_threshold,
+			suspend_threshold,
 			threshold_weight,
 			weight_restrict_decay,
 			xcmp_max_individual_weight,
@@ -872,12 +892,15 @@ impl<T: Config> Pallet<T> {
 			} else {
 				// Process up to one block's worth for now.
 				let weight_remaining = weight_available.saturating_sub(weight_used);
+				let should_decrement_fee_factor =
+					(status[index].message_metadata.len() as u32) <= suspend_threshold;
 				let (weight_processed, is_empty) = Self::process_xcmp_message(
 					sender,
 					status[index].message_metadata[0],
 					&mut messages_processed,
 					weight_remaining,
 					xcmp_max_individual_weight,
+					should_decrement_fee_factor,
 				);
 				if is_empty {
 					status[index].message_metadata.remove(0);
@@ -947,6 +970,28 @@ impl<T: Config> Pallet<T> {
 			}
 		});
 	}
+
+	/// Raise the delivery fee factor by a multiplicative factor and stores the resulting value.
+	///
+	/// Returns the new delivery fee factor after the increment.
+	pub(crate) fn increment_fee_factor(para: ParaId, message_size_factor: FixedU128) -> FixedU128 {
+		<DeliveryFeeFactor<T>>::mutate(para, |f| {
+			*f = f.saturating_mul(EXPONENTIAL_FEE_BASE + message_size_factor);
+			*f
+		})
+	}
+
+	/// Reduce the delivery fee factor by a multiplicative factor and stores the resulting value.
+	///
+	/// Does not reduce the fee factor below the initial value, which is currently set as 1.
+	///
+	/// Returns the new delivery fee factor after the decrement.
+	pub(crate) fn decrement_fee_factor(para: ParaId) -> FixedU128 {
+		<DeliveryFeeFactor<T>>::mutate(para, |f| {
+			*f = InitialFactor::get().max(*f / EXPONENTIAL_FEE_BASE);
+			*f
+		})
+	}
 }
 
 impl<T: Config> XcmpMessageHandler for Pallet<T> {
@@ -984,9 +1029,8 @@ impl<T: Config> XcmpMessageHandler for Pallet<T> {
 				// Record the fact we received it.
 				match status.binary_search_by_key(&sender, |item| item.sender) {
 					Ok(i) => {
-						let count = status[i].message_metadata.len();
-						if count as u32 >= suspend_threshold && status[i].state == InboundState::Ok
-						{
+						let count = status[i].message_metadata.len() as u32;
+						if count >= suspend_threshold && status[i].state == InboundState::Ok {
 							status[i].state = InboundState::Suspended;
 							let r = Self::send_signal(sender, ChannelSignal::Suspend);
 							if r.is_err() {
@@ -995,14 +1039,21 @@ impl<T: Config> XcmpMessageHandler for Pallet<T> {
 								);
 							}
 						}
-						if (count as u32) < drop_threshold {
+						if count < drop_threshold {
 							status[i].message_metadata.push((sent_at, format));
 						} else {
 							debug_assert!(
 								false,
 								"XCMP channel queue full. Silently dropping message"
 							);
 						}
+						// Update the delivery fee factor, if applicable.
+						if count > suspend_threshold {
+							let message_size_factor =
+								FixedU128::from_u32(data_ref.len().saturating_div(1024) as u32)
+									.saturating_mul(MESSAGE_SIZE_FEE_BASE);
+							Self::increment_fee_factor(sender, message_size_factor);
+						}
 					},
 					Err(_) => status.push(InboundChannelDetails {
 						sender,
@@ -1178,3 +1229,9 @@ impl<T: Config> SendXcm for Pallet<T> {
 		}
 	}
 }
+
+impl<T: Config> FeeTracker for Pallet<T> {
+	fn get_fee_factor(para: ParaId) -> FixedU128 {
+		<DeliveryFeeFactor<T>>::get(para)
+	}
+}

cumulus/pallets/xcmp-queue/src/tests.rs

@@ -49,6 +49,7 @@ fn bad_message_is_handled() {
 			&mut 0,
 			Weight::from_parts(10_000_000_000, 0),
 			Weight::from_parts(10_000_000_000, 0),
+			true,
 		);
 	});
 }
@@ -73,6 +74,7 @@ fn handle_blob_message() {
 			&mut 0,
 			Weight::from_parts(10_000_000_000, 0),
 			Weight::from_parts(10_000_000_000, 0),
+			true,
 		);
 	});
 }
@@ -91,6 +93,7 @@ fn handle_invalid_data() {
 			&mut 0,
 			Weight::from_parts(10_000_000_000, 0),
 			Weight::from_parts(10_000_000_000, 0),
+			true,
 		);
 	});
 }

cumulus/parachains/common/Cargo.toml

@@ -43,6 +43,7 @@ xcm-executor = { package = "staging-xcm-executor", path = "../../../polkadot/xcm
 pallet-collator-selection = { path = "../../pallets/collator-selection", default-features = false }
 cumulus-primitives-core = { path = "../../primitives/core", default-features = false }
 cumulus-primitives-utility = { path = "../../primitives/utility", default-features = false }
+parachain-info = { path = "../pallets/parachain-info", default-features = false }
 
 [dev-dependencies]
 pallet-authorship = { path = "../../../substrate/frame/authorship", default-features = false}
@@ -65,6 +66,7 @@ std = [
 	"pallet-authorship/std",
 	"pallet-balances/std",
 	"pallet-collator-selection/std",
+	"parachain-info/std",
 	"polkadot-core-primitives/std",
 	"polkadot-primitives/std",
 	"polkadot-runtime-constants/std",

cumulus/parachains/common/src/kusama.rs

@@ -27,8 +27,8 @@ pub mod consensus {
 
 /// Constants relating to KSM.
 pub mod currency {
-	use kusama_runtime_constants as constants;
 	use polkadot_core_primitives::Balance;
+	use rococo_runtime_constants as constants;
 
 	/// The existential deposit. Set to 1/10 of its parent Relay Chain.
 	pub const EXISTENTIAL_DEPOSIT: Balance = constants::currency::EXISTENTIAL_DEPOSIT / 10;