Tests for BridgeHub(s) <> remote GRANDPA chain (#2692)

So far the `bridge-hub-test-utils` contained a tests set for testing BridgeHub runtime that is bridging with the remote **parachain**. But we have https://github.com/paritytech/polkadot-sdk/pull/2540 coming, which would add Rococo <> Bulletin chain bridge (where Bulletin = standalone chain that is using GRANDPA finality). Then it'll be expanded to Polkadot BH as well. So this PR adds the same set of tests to the `bridge-hub-test-utils`, but for the case when remote chain is the chain with GRANDPA finality. There's a lot of changes in this PR - I'll describe some: - I've added `BasicParachainRuntime` trait to decrease number of lines we need to add to `where` clause. Could revert, but imo it is useful; - `cumulus/parachains/runtimes/bridge-hubs/test-utils/src/test_data` is a submodule for generating test data for the test sets. `from_parachain.rs` is used in tests for the case when remote chain is a parachain, `from_grandpa_chain.rs` - for the bridges with remote GRANDPA chains. `mod.rs` has some code, shared by both types of tests; - `cumulus/parachains/runtimes/bridge-hubs/test-utils/src/test_data` is a submodule with all test cases. The `mod.rs` has tests, suitable for all cases. There's also `wth_parachain.rs` and `with_grandpa_chain.rs` with the same meaning as above; - I've merged the "core" code of two previous tests - `relayed_incoming_message_works` and `complex_relay_extrinsic_works` into one single `relayed_incoming_message_works` test. So now we are always constructing extrinsics and are dispatching them using executive module (meaning all signed extensions are also tested). New test set is used here: https://github.com/paritytech/polkadot-sdk/pull/2540. Once this PR is merged, I'll merge that other PR with master to remove duplicate changes. I'm also planning to cleanup generic constraints + remove some unnecessary assumptions about used chains in a follow-up PRs. But for now I think this PR has enough changes, so don't want to complicate it even more. --- Breaking changes for the code that have used those tests before: - the `construct_and_apply_extrinsic` callback now accepts the `RuntimeCall` instead of the `pallet_utility::Call`; - the `construct_and_apply_extrinsic` now may be called multiple times for the single test, so make sure the `frame_system::CheckNonce` is correctly constructed; - all previous tests have been moved from `bridge_hub_test_utils::test_cases` to `bridge_hub_test_utils::test_cases::from_parachain` module; - there are several changes in test arguments - please refer to https://github.com/paritytech/polkadot-sdk/compare/sv-tests-for-bridge-with-remote-grandpa-chain?expand=1#diff-79a28d4d3e1749050341c2424f00c4c139825b1a20937767f83e58b95166735c for details.
2026-05-31 04:01:02 +00:00 · 2023-12-13 12:31:12 +03:00
parent 3c5fcbe637
commit 9ecb2d3391
14 changed files with 2588 additions and 1651 deletions
@@ -0,0 +1,485 @@
+// Copyright (C) Parity Technologies (UK) Ltd.
+// This file is part of Cumulus.
+
+// Cumulus 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.
+
+// Cumulus 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.
+
+// You should have received a copy of the GNU General Public License
+// along with Cumulus.  If not, see <http://www.gnu.org/licenses/>.
+
+//! Module contains predefined test-case scenarios for `Runtime` with bridging capabilities.
+//!
+//! This file contains tests, suitable for all bridge runtimes. See `from_parachain` and
+//! `from_grandpa_chain` submodules for tests, that are specific to the bridged chain type.
+
+pub mod from_grandpa_chain;
+pub mod from_parachain;
+
+pub(crate) mod helpers;
+
+use crate::test_data;
+
+use asset_test_utils::BasicParachainRuntime;
+use bp_messages::{
+	target_chain::{DispatchMessage, DispatchMessageData, MessageDispatch},
+	LaneId, MessageKey, OutboundLaneData,
+};
+use bridge_runtime_common::messages_xcm_extension::{
+	XcmAsPlainPayload, XcmBlobMessageDispatchResult,
+};
+use codec::Encode;
+use frame_support::{
+	assert_ok,
+	traits::{Get, OnFinalize, OnInitialize, OriginTrait},
+};
+use frame_system::pallet_prelude::BlockNumberFor;
+use parachains_common::AccountId;
+use parachains_runtimes_test_utils::{
+	mock_open_hrmp_channel, AccountIdOf, BalanceOf, CollatorSessionKeys, ExtBuilder, ValidatorIdOf,
+	XcmReceivedFrom,
+};
+use sp_runtime::{traits::Zero, AccountId32};
+use xcm::{latest::prelude::*, AlwaysLatest};
+use xcm_builder::DispatchBlobError;
+use xcm_executor::{
+	traits::{TransactAsset, WeightBounds},
+	XcmExecutor,
+};
+
+// Re-export test_case from assets
+pub use asset_test_utils::include_teleports_for_native_asset_works;
+
+pub type RuntimeHelper<Runtime, AllPalletsWithoutSystem = ()> =
+	parachains_runtimes_test_utils::RuntimeHelper<Runtime, AllPalletsWithoutSystem>;
+
+// Re-export test_case from `parachains-runtimes-test-utils`
+pub use parachains_runtimes_test_utils::test_cases::change_storage_constant_by_governance_works;
+
+/// Prepare default runtime storage and run test within this context.
+pub fn run_test<Runtime, T>(
+	collator_session_key: CollatorSessionKeys<Runtime>,
+	runtime_para_id: u32,
+	balances: Vec<(Runtime::AccountId, Runtime::Balance)>,
+	test: impl FnOnce() -> T,
+) -> T
+where
+	Runtime: BasicParachainRuntime,
+	ValidatorIdOf<Runtime>: From<AccountIdOf<Runtime>>,
+{
+	ExtBuilder::<Runtime>::default()
+		.with_collators(collator_session_key.collators())
+		.with_session_keys(collator_session_key.session_keys())
+		.with_safe_xcm_version(XCM_VERSION)
+		.with_para_id(runtime_para_id.into())
+		.with_balances(balances)
+		.with_tracing()
+		.build()
+		.execute_with(|| test())
+}
+
+/// Test-case makes sure that `Runtime` can process bridging initialize via governance-like call
+pub fn initialize_bridge_by_governance_works<Runtime, GrandpaPalletInstance>(
+	collator_session_key: CollatorSessionKeys<Runtime>,
+	runtime_para_id: u32,
+	runtime_call_encode: Box<
+		dyn Fn(pallet_bridge_grandpa::Call<Runtime, GrandpaPalletInstance>) -> Vec<u8>,
+	>,
+) where
+	Runtime: BasicParachainRuntime + pallet_bridge_grandpa::Config<GrandpaPalletInstance>,
+	GrandpaPalletInstance: 'static,
+	ValidatorIdOf<Runtime>: From<AccountIdOf<Runtime>>,
+{
+	run_test::<Runtime, _>(collator_session_key, runtime_para_id, vec![], || {
+		// check mode before
+		assert_eq!(
+			pallet_bridge_grandpa::PalletOperatingMode::<Runtime, GrandpaPalletInstance>::try_get(),
+			Err(())
+		);
+
+		// encode `initialize` call
+		let initialize_call = runtime_call_encode(pallet_bridge_grandpa::Call::<
+			Runtime,
+			GrandpaPalletInstance,
+		>::initialize {
+			init_data: test_data::initialization_data::<Runtime, GrandpaPalletInstance>(12345),
+		});
+
+		// overestimate - check weight for `pallet_bridge_grandpa::Pallet::initialize()` call
+		let require_weight_at_most =
+			<Runtime as frame_system::Config>::DbWeight::get().reads_writes(7, 7);
+
+		// execute XCM with Transacts to `initialize bridge` as governance does
+		assert_ok!(RuntimeHelper::<Runtime>::execute_as_governance(
+			initialize_call,
+			require_weight_at_most
+		)
+		.ensure_complete());
+
+		// check mode after
+		assert_eq!(
+			pallet_bridge_grandpa::PalletOperatingMode::<Runtime, GrandpaPalletInstance>::try_get(),
+			Ok(bp_runtime::BasicOperatingMode::Normal)
+		);
+	})
+}
+
+/// Test-case makes sure that `Runtime` can handle xcm `ExportMessage`:
+/// Checks if received XCM messages is correctly added to the message outbound queue for delivery.
+/// For SystemParachains we expect unpaid execution.
+pub fn handle_export_message_from_system_parachain_to_outbound_queue_works<
+	Runtime,
+	XcmConfig,
+	MessagesPalletInstance,
+>(
+	collator_session_key: CollatorSessionKeys<Runtime>,
+	runtime_para_id: u32,
+	sibling_parachain_id: u32,
+	unwrap_pallet_bridge_messages_event: Box<
+		dyn Fn(Vec<u8>) -> Option<pallet_bridge_messages::Event<Runtime, MessagesPalletInstance>>,
+	>,
+	export_message_instruction: fn() -> Instruction<XcmConfig::RuntimeCall>,
+	expected_lane_id: LaneId,
+	existential_deposit: Option<MultiAsset>,
+	maybe_paid_export_message: Option<MultiAsset>,
+	prepare_configuration: impl Fn(),
+) where
+	Runtime: BasicParachainRuntime + pallet_bridge_messages::Config<MessagesPalletInstance>,
+	XcmConfig: xcm_executor::Config,
+	MessagesPalletInstance: 'static,
+	ValidatorIdOf<Runtime>: From<AccountIdOf<Runtime>>,
+{
+	assert_ne!(runtime_para_id, sibling_parachain_id);
+	let sibling_parachain_location = MultiLocation::new(1, Parachain(sibling_parachain_id));
+
+	run_test::<Runtime, _>(collator_session_key, runtime_para_id, vec![], || {
+		prepare_configuration();
+
+		// check queue before
+		assert_eq!(
+			pallet_bridge_messages::OutboundLanes::<Runtime, MessagesPalletInstance>::try_get(
+				expected_lane_id
+			),
+			Err(())
+		);
+
+		// prepare `ExportMessage`
+		let xcm = if let Some(fee) = maybe_paid_export_message {
+			// deposit ED to origin (if needed)
+			if let Some(ed) = existential_deposit {
+				XcmConfig::AssetTransactor::deposit_asset(
+					&ed,
+					&sibling_parachain_location,
+					Some(&XcmContext::with_message_id([0; 32])),
+				)
+				.expect("deposited ed");
+			}
+			// deposit fee to origin
+			XcmConfig::AssetTransactor::deposit_asset(
+				&fee,
+				&sibling_parachain_location,
+				Some(&XcmContext::with_message_id([0; 32])),
+			)
+			.expect("deposited fee");
+
+			Xcm(vec![
+				WithdrawAsset(MultiAssets::from(vec![fee.clone()])),
+				BuyExecution { fees: fee, weight_limit: Unlimited },
+				export_message_instruction(),
+			])
+		} else {
+			Xcm(vec![
+				UnpaidExecution { weight_limit: Unlimited, check_origin: None },
+				export_message_instruction(),
+			])
+		};
+
+		// execute XCM
+		let hash = xcm.using_encoded(sp_io::hashing::blake2_256);
+		assert_ok!(XcmExecutor::<XcmConfig>::execute_xcm(
+			sibling_parachain_location,
+			xcm,
+			hash,
+			RuntimeHelper::<Runtime>::xcm_max_weight(XcmReceivedFrom::Sibling),
+		)
+		.ensure_complete());
+
+		// check queue after
+		assert_eq!(
+			pallet_bridge_messages::OutboundLanes::<Runtime, MessagesPalletInstance>::try_get(
+				expected_lane_id
+			),
+			Ok(OutboundLaneData {
+				oldest_unpruned_nonce: 1,
+				latest_received_nonce: 0,
+				latest_generated_nonce: 1,
+			})
+		);
+
+		// check events
+		let mut events = <frame_system::Pallet<Runtime>>::events()
+			.into_iter()
+			.filter_map(|e| unwrap_pallet_bridge_messages_event(e.event.encode()));
+		assert!(events.any(|e| matches!(e, pallet_bridge_messages::Event::MessageAccepted { .. })));
+	})
+}
+
+/// Test-case makes sure that Runtime can route XCM messages received in inbound queue,
+/// We just test here `MessageDispatch` configuration.
+/// We expect that runtime can route messages:
+///     1. to Parent (relay chain)
+///     2. to Sibling parachain
+pub fn message_dispatch_routing_works<
+	Runtime,
+	AllPalletsWithoutSystem,
+	XcmConfig,
+	HrmpChannelOpener,
+	MessagesPalletInstance,
+	RuntimeNetwork,
+	BridgedNetwork,
+	NetworkDistanceAsParentCount,
+>(
+	collator_session_key: CollatorSessionKeys<Runtime>,
+	runtime_para_id: u32,
+	sibling_parachain_id: u32,
+	unwrap_cumulus_pallet_parachain_system_event: Box<
+		dyn Fn(Vec<u8>) -> Option<cumulus_pallet_parachain_system::Event<Runtime>>,
+	>,
+	unwrap_cumulus_pallet_xcmp_queue_event: Box<
+		dyn Fn(Vec<u8>) -> Option<cumulus_pallet_xcmp_queue::Event<Runtime>>,
+	>,
+	expected_lane_id: LaneId,
+	prepare_configuration: impl Fn(),
+) where
+	Runtime: BasicParachainRuntime
+		+ cumulus_pallet_xcmp_queue::Config
+		+ pallet_bridge_messages::Config<MessagesPalletInstance, InboundPayload = XcmAsPlainPayload>,
+	AllPalletsWithoutSystem:
+		OnInitialize<BlockNumberFor<Runtime>> + OnFinalize<BlockNumberFor<Runtime>>,
+	<Runtime as frame_system::Config>::AccountId:
+		Into<<<Runtime as frame_system::Config>::RuntimeOrigin as OriginTrait>::AccountId>,
+	XcmConfig: xcm_executor::Config,
+	MessagesPalletInstance: 'static,
+	ValidatorIdOf<Runtime>: From<AccountIdOf<Runtime>>,
+	<Runtime as frame_system::Config>::AccountId: From<AccountId32>,
+	HrmpChannelOpener: frame_support::inherent::ProvideInherent<
+		Call = cumulus_pallet_parachain_system::Call<Runtime>,
+	>,
+	RuntimeNetwork: Get<NetworkId>,
+	BridgedNetwork: Get<NetworkId>,
+	NetworkDistanceAsParentCount: Get<u8>,
+{
+	struct NetworkWithParentCount<N, C>(core::marker::PhantomData<(N, C)>);
+	impl<N: Get<NetworkId>, C: Get<u8>> Get<MultiLocation> for NetworkWithParentCount<N, C> {
+		fn get() -> MultiLocation {
+			MultiLocation { parents: C::get(), interior: X1(GlobalConsensus(N::get())) }
+		}
+	}
+
+	assert_ne!(runtime_para_id, sibling_parachain_id);
+
+	run_test::<Runtime, _>(collator_session_key, runtime_para_id, vec![], || {
+		prepare_configuration();
+
+		let mut alice = [0u8; 32];
+		alice[0] = 1;
+
+		let included_head = RuntimeHelper::<Runtime, AllPalletsWithoutSystem>::run_to_block(
+			2,
+			AccountId::from(alice).into(),
+		);
+		// 1. this message is sent from other global consensus with destination of this Runtime
+		//    relay chain (UMP)
+		let bridging_message = test_data::simulate_message_exporter_on_bridged_chain::<
+			BridgedNetwork,
+			NetworkWithParentCount<RuntimeNetwork, NetworkDistanceAsParentCount>,
+			AlwaysLatest,
+		>((RuntimeNetwork::get(), Here));
+		let result = <<Runtime as pallet_bridge_messages::Config<MessagesPalletInstance>>::MessageDispatch>::dispatch(
+			test_data::dispatch_message(expected_lane_id, 1, bridging_message)
+		);
+		assert_eq!(
+			format!("{:?}", result.dispatch_level_result),
+			format!("{:?}", XcmBlobMessageDispatchResult::Dispatched)
+		);
+
+		// check events - UpwardMessageSent
+		let mut events = <frame_system::Pallet<Runtime>>::events()
+			.into_iter()
+			.filter_map(|e| unwrap_cumulus_pallet_parachain_system_event(e.event.encode()));
+		assert!(events.any(|e| matches!(
+			e,
+			cumulus_pallet_parachain_system::Event::UpwardMessageSent { .. }
+		)));
+
+		// 2. this message is sent from other global consensus with destination of this Runtime
+		//    sibling parachain (HRMP)
+		let bridging_message = test_data::simulate_message_exporter_on_bridged_chain::<
+			BridgedNetwork,
+			NetworkWithParentCount<RuntimeNetwork, NetworkDistanceAsParentCount>,
+			AlwaysLatest,
+		>((RuntimeNetwork::get(), X1(Parachain(sibling_parachain_id))));
+
+		// 2.1. WITHOUT opened hrmp channel -> RoutingError
+		let result =
+			<<Runtime as pallet_bridge_messages::Config<MessagesPalletInstance>>::MessageDispatch>::dispatch(
+				DispatchMessage {
+					key: MessageKey { lane_id: expected_lane_id, nonce: 1 },
+					data: DispatchMessageData { payload: Ok(bridging_message.clone()) },
+				}
+			);
+		assert_eq!(
+			format!("{:?}", result.dispatch_level_result),
+			format!(
+				"{:?}",
+				XcmBlobMessageDispatchResult::NotDispatched(Some(DispatchBlobError::RoutingError))
+			)
+		);
+
+		// check events - no XcmpMessageSent
+		assert_eq!(
+			<frame_system::Pallet<Runtime>>::events()
+				.into_iter()
+				.filter_map(|e| unwrap_cumulus_pallet_xcmp_queue_event(e.event.encode()))
+				.count(),
+			0
+		);
+
+		// 2.1. WITH hrmp channel -> Ok
+		mock_open_hrmp_channel::<Runtime, HrmpChannelOpener>(
+			runtime_para_id.into(),
+			sibling_parachain_id.into(),
+			included_head,
+			&alice,
+		);
+		let result = <<Runtime as pallet_bridge_messages::Config<MessagesPalletInstance>>::MessageDispatch>::dispatch(
+			DispatchMessage {
+				key: MessageKey { lane_id: expected_lane_id, nonce: 1 },
+				data: DispatchMessageData { payload: Ok(bridging_message) },
+			}
+		);
+		assert_eq!(
+			format!("{:?}", result.dispatch_level_result),
+			format!("{:?}", XcmBlobMessageDispatchResult::Dispatched)
+		);
+
+		// check events - XcmpMessageSent
+		let mut events = <frame_system::Pallet<Runtime>>::events()
+			.into_iter()
+			.filter_map(|e| unwrap_cumulus_pallet_xcmp_queue_event(e.event.encode()));
+		assert!(
+			events.any(|e| matches!(e, cumulus_pallet_xcmp_queue::Event::XcmpMessageSent { .. }))
+		);
+	})
+}
+
+/// Estimates XCM execution fee for paid `ExportMessage` processing.
+pub fn can_calculate_weight_for_paid_export_message_with_reserve_transfer<
+	Runtime,
+	XcmConfig,
+	WeightToFee,
+>() -> u128
+where
+	Runtime: frame_system::Config + pallet_balances::Config,
+	XcmConfig: xcm_executor::Config,
+	WeightToFee: frame_support::weights::WeightToFee<Balance = BalanceOf<Runtime>>,
+	<WeightToFee as frame_support::weights::WeightToFee>::Balance: From<u128> + Into<u128>,
+{
+	// data here are not relevant for weighing
+	let mut xcm = Xcm(vec![
+		WithdrawAsset(MultiAssets::from(vec![MultiAsset {
+			id: Concrete(MultiLocation { parents: 1, interior: Here }),
+			fun: Fungible(34333299),
+		}])),
+		BuyExecution {
+			fees: MultiAsset {
+				id: Concrete(MultiLocation { parents: 1, interior: Here }),
+				fun: Fungible(34333299),
+			},
+			weight_limit: Unlimited,
+		},
+		ExportMessage {
+			network: Polkadot,
+			destination: X1(Parachain(1000)),
+			xcm: Xcm(vec![
+				ReserveAssetDeposited(MultiAssets::from(vec![MultiAsset {
+					id: Concrete(MultiLocation {
+						parents: 2,
+						interior: X1(GlobalConsensus(Kusama)),
+					}),
+					fun: Fungible(1000000000000),
+				}])),
+				ClearOrigin,
+				BuyExecution {
+					fees: MultiAsset {
+						id: Concrete(MultiLocation {
+							parents: 2,
+							interior: X1(GlobalConsensus(Kusama)),
+						}),
+						fun: Fungible(1000000000000),
+					},
+					weight_limit: Unlimited,
+				},
+				DepositAsset {
+					assets: Wild(AllCounted(1)),
+					beneficiary: MultiLocation {
+						parents: 0,
+						interior: X1(xcm::latest::prelude::AccountId32 {
+							network: None,
+							id: [
+								212, 53, 147, 199, 21, 253, 211, 28, 97, 20, 26, 189, 4, 169, 159,
+								214, 130, 44, 133, 88, 133, 76, 205, 227, 154, 86, 132, 231, 165,
+								109, 162, 125,
+							],
+						}),
+					},
+				},
+				SetTopic([
+					116, 82, 194, 132, 171, 114, 217, 165, 23, 37, 161, 177, 165, 179, 247, 114,
+					137, 101, 147, 70, 28, 157, 168, 32, 154, 63, 74, 228, 152, 180, 5, 63,
+				]),
+			]),
+		},
+		DepositAsset {
+			assets: Wild(All),
+			beneficiary: MultiLocation { parents: 1, interior: X1(Parachain(1000)) },
+		},
+		SetTopic([
+			36, 224, 250, 165, 82, 195, 67, 110, 160, 170, 140, 87, 217, 62, 201, 164, 42, 98, 219,
+			157, 124, 105, 248, 25, 131, 218, 199, 36, 109, 173, 100, 122,
+		]),
+	]);
+
+	// get weight
+	let weight = XcmConfig::Weigher::weight(&mut xcm);
+	assert_ok!(weight);
+	let weight = weight.unwrap();
+	// check if sane
+	let max_expected = Runtime::BlockWeights::get().max_block / 10;
+	assert!(
+		weight.all_lte(max_expected),
+		"calculated weight: {:?}, max_expected: {:?}",
+		weight,
+		max_expected
+	);
+
+	// check fee, should not be 0
+	let estimated_fee = WeightToFee::weight_to_fee(&weight);
+	assert!(estimated_fee > BalanceOf::<Runtime>::zero());
+
+	sp_tracing::try_init_simple();
+	log::error!(
+		target: "bridges::estimate",
+		"Estimate fee: {:?} for `ExportMessage` for runtime: {:?}",
+		estimated_fee,
+		Runtime::Version::get(),
+	);
+
+	estimated_fee.into()
+}