cumulus-pallet-xcmp-queue 0.26.0

// Copyright (C) Parity Technologies (UK) Ltd.
// SPDX-License-Identifier: Apache-2.0

// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// 	http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use crate::{pallet, OutboundState};
use cumulus_primitives_core::ParaId;
use xcm::latest::prelude::*;

/// Adapter implementation for `bp_xcm_bridge_hub_router::XcmChannelStatusProvider` which checks
/// both `OutboundXcmpStatus` and `InboundXcmpStatus` for defined `Location` if any of those is
/// suspended.
pub struct InAndOutXcmpChannelStatusProvider<Runtime>(core::marker::PhantomData<Runtime>);
impl<Runtime: crate::Config> bp_xcm_bridge_hub_router::XcmChannelStatusProvider
	for InAndOutXcmpChannelStatusProvider<Runtime>
{
	fn is_congested(with: &Location) -> bool {
		// handle congestion only for a sibling parachain locations.
		let sibling_para_id: ParaId = match with.unpack() {
			(_, [Parachain(para_id)]) => (*para_id).into(),
			_ => return false,
		};

		// if the inbound channel with recipient is suspended, it means that we are unable to
		// receive congestion reports from the `with` location. So we assume the pipeline is
		// congested too.
		if pallet::Pallet::<Runtime>::is_inbound_channel_suspended(sibling_para_id) {
			return true;
		}

		// if the outbound channel with recipient is suspended, it means that one of further
		// queues (e.g. bridge queue between two bridge hubs) is overloaded, so we shall
		// take larger fee for our outbound messages
		OutXcmpChannelStatusProvider::<Runtime>::is_congested(with)
	}
}

/// Adapter implementation for `bp_xcm_bridge::ChannelStatusProvider` and/or
/// `bp_xcm_bridge_hub_router::XcmChannelStatusProvider` which checks only `OutboundXcmpStatus`
/// for defined `Location` if is suspended.
pub struct OutXcmpChannelStatusProvider<Runtime>(core::marker::PhantomData<Runtime>);
impl<Runtime: crate::Config> OutXcmpChannelStatusProvider<Runtime> {
	fn is_congested(with: &Location) -> bool {
		// handle congestion only for a sibling parachain locations.
		let sibling_para_id: ParaId = match with.unpack() {
			(_, [Parachain(para_id)]) => (*para_id).into(),
			_ => return false,
		};

		// let's find the channel's state with the sibling parachain,
		let Some((outbound_state, queued_pages)) =
			pallet::Pallet::<Runtime>::outbound_channel_state(sibling_para_id)
		else {
			return false;
		};
		// suspended channel => it is congested
		if outbound_state == OutboundState::Suspended {
			return true;
		}

		// It takes some time for target parachain to suspend inbound channel with the target BH and
		// during that we will keep accepting new message delivery transactions. Let's also reject
		// new deliveries if there are too many "pages" (concatenated XCM messages) in the target BH
		// -> target parachain queue.

		// If the outbound channel has at least `N` pages enqueued, let's assume it is congested.
		// Normally, the chain with a few opened HRMP channels, will "send" pages at every block.
		// Having `N` pages means that for last `N` blocks we either have not sent any messages,
		// or have sent signals.

		const MAX_QUEUED_PAGES_BEFORE_DEACTIVATION: u16 = 4;
		if queued_pages > MAX_QUEUED_PAGES_BEFORE_DEACTIVATION {
			return true;
		}

		false
	}
}

impl<Runtime: crate::Config> bp_xcm_bridge_hub_router::XcmChannelStatusProvider
	for OutXcmpChannelStatusProvider<Runtime>
{
	fn is_congested(with: &Location) -> bool {
		Self::is_congested(with)
	}
}

#[cfg(feature = "runtime-benchmarks")]
pub fn suspend_channel_for_benchmarks<T: crate::Config>(target: ParaId) {
	pallet::Pallet::<T>::suspend_channel(target)
}