// 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 .
//! 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_cases::bridges_prelude::*, test_data};
use asset_test_utils::BasicParachainRuntime;
use bp_messages::{
target_chain::{DispatchMessage, DispatchMessageData, MessageDispatch},
LaneId, MessageKey, MessagesOperatingMode, OutboundLaneData,
};
use bp_runtime::BasicOperatingMode;
use bridge_runtime_common::messages_xcm_extension::{
XcmAsPlainPayload, XcmBlobMessageDispatchResult,
};
use codec::Encode;
use frame_support::{
assert_ok,
dispatch::GetDispatchInfo,
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, RuntimeCallOf,
SlotDurations, XcmReceivedFrom,
};
use sp_runtime::{traits::Zero, AccountId32};
use xcm::{latest::prelude::*, AlwaysLatest};
use xcm_builder::DispatchBlobError;
use xcm_executor::{
traits::{TransactAsset, WeightBounds},
XcmExecutor,
};
/// Common bridges exports.
pub(crate) mod bridges_prelude {
pub use pallet_bridge_grandpa::{Call as BridgeGrandpaCall, Config as BridgeGrandpaConfig};
pub use pallet_bridge_messages::{Call as BridgeMessagesCall, Config as BridgeMessagesConfig};
pub use pallet_bridge_parachains::{
Call as BridgeParachainsCall, Config as BridgeParachainsConfig, RelayBlockHash,
RelayBlockNumber,
};
}
// Re-export test_case from assets
pub use asset_test_utils::include_teleports_for_native_asset_works;
pub type RuntimeHelper =
parachains_runtimes_test_utils::RuntimeHelper;
// Re-export test_case from `parachains-runtimes-test-utils`
pub use parachains_runtimes_test_utils::test_cases::{
change_storage_constant_by_governance_works, set_storage_keys_by_governance_works,
};
/// Prepare default runtime storage and run test within this context.
pub fn run_test(
collator_session_key: CollatorSessionKeys,
runtime_para_id: u32,
balances: Vec<(Runtime::AccountId, Runtime::Balance)>,
test: impl FnOnce() -> T,
) -> T
where
Runtime: BasicParachainRuntime,
{
ExtBuilder::::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(
collator_session_key: CollatorSessionKeys,
runtime_para_id: u32,
) where
Runtime: BasicParachainRuntime + BridgeGrandpaConfig,
GrandpaPalletInstance: 'static,
RuntimeCallOf:
GetDispatchInfo + From>,
{
run_test::(collator_session_key, runtime_para_id, vec![], || {
// check mode before
assert_eq!(
pallet_bridge_grandpa::PalletOperatingMode::::try_get(),
Err(())
);
// prepare the `initialize` call
let initialize_call = RuntimeCallOf::::from(BridgeGrandpaCall::<
Runtime,
GrandpaPalletInstance,
>::initialize {
init_data: test_data::initialization_data::(12345),
});
// execute XCM with Transacts to `initialize bridge` as governance does
assert_ok!(RuntimeHelper::::execute_as_governance(
initialize_call.encode(),
initialize_call.get_dispatch_info().weight,
)
.ensure_complete());
// check mode after
assert_eq!(
pallet_bridge_grandpa::PalletOperatingMode::::try_get(),
Ok(BasicOperatingMode::Normal)
);
})
}
/// Test-case makes sure that `Runtime` can change bridge GRANDPA pallet operating mode via
/// governance-like call.
pub fn change_bridge_grandpa_pallet_mode_by_governance_works(
collator_session_key: CollatorSessionKeys,
runtime_para_id: u32,
) where
Runtime: BasicParachainRuntime + BridgeGrandpaConfig,
GrandpaPalletInstance: 'static,
RuntimeCallOf:
GetDispatchInfo + From>,
{
run_test::(collator_session_key, runtime_para_id, vec![], || {
let dispatch_set_operating_mode_call = |old_mode, new_mode| {
// check old mode
assert_eq!(
pallet_bridge_grandpa::PalletOperatingMode::::get(),
old_mode,
);
// prepare the `set_operating_mode` call
let set_operating_mode_call = ::RuntimeCall::from(
pallet_bridge_grandpa::Call::::set_operating_mode {
operating_mode: new_mode,
},
);
// execute XCM with Transacts to `initialize bridge` as governance does
assert_ok!(RuntimeHelper::::execute_as_governance(
set_operating_mode_call.encode(),
set_operating_mode_call.get_dispatch_info().weight,
)
.ensure_complete());
// check mode after
assert_eq!(
pallet_bridge_grandpa::PalletOperatingMode::::try_get(),
Ok(new_mode)
);
};
// check mode before
assert_eq!(
pallet_bridge_grandpa::PalletOperatingMode::::try_get(),
Err(())
);
dispatch_set_operating_mode_call(BasicOperatingMode::Normal, BasicOperatingMode::Halted);
dispatch_set_operating_mode_call(BasicOperatingMode::Halted, BasicOperatingMode::Normal);
});
}
/// Test-case makes sure that `Runtime` can change bridge parachains pallet operating mode via
/// governance-like call.
pub fn change_bridge_parachains_pallet_mode_by_governance_works(
collator_session_key: CollatorSessionKeys,
runtime_para_id: u32,
) where
Runtime: BasicParachainRuntime + BridgeParachainsConfig,
ParachainsPalletInstance: 'static,
RuntimeCallOf:
GetDispatchInfo + From>,
{
run_test::(collator_session_key, runtime_para_id, vec![], || {
let dispatch_set_operating_mode_call = |old_mode, new_mode| {
// check old mode
assert_eq!(
pallet_bridge_parachains::PalletOperatingMode::::get(),
old_mode,
);
// prepare the `set_operating_mode` call
let set_operating_mode_call =
RuntimeCallOf::::from(pallet_bridge_parachains::Call::<
Runtime,
ParachainsPalletInstance,
>::set_operating_mode {
operating_mode: new_mode,
});
// execute XCM with Transacts to `initialize bridge` as governance does
assert_ok!(RuntimeHelper::::execute_as_governance(
set_operating_mode_call.encode(),
set_operating_mode_call.get_dispatch_info().weight,
)
.ensure_complete());
// check mode after
assert_eq!(
pallet_bridge_parachains::PalletOperatingMode::::try_get(),
Ok(new_mode)
);
};
// check mode before
assert_eq!(
pallet_bridge_parachains::PalletOperatingMode::::try_get(),
Err(())
);
dispatch_set_operating_mode_call(BasicOperatingMode::Normal, BasicOperatingMode::Halted);
dispatch_set_operating_mode_call(BasicOperatingMode::Halted, BasicOperatingMode::Normal);
});
}
/// Test-case makes sure that `Runtime` can change bridge messaging pallet operating mode via
/// governance-like call.
pub fn change_bridge_messages_pallet_mode_by_governance_works(
collator_session_key: CollatorSessionKeys,
runtime_para_id: u32,
) where
Runtime: BasicParachainRuntime + BridgeMessagesConfig,
MessagesPalletInstance: 'static,
RuntimeCallOf:
GetDispatchInfo + From>,
{
run_test::(collator_session_key, runtime_para_id, vec![], || {
let dispatch_set_operating_mode_call = |old_mode, new_mode| {
// check old mode
assert_eq!(
pallet_bridge_messages::PalletOperatingMode::::get(
),
old_mode,
);
// encode `set_operating_mode` call
let set_operating_mode_call = RuntimeCallOf::::from(BridgeMessagesCall::<
Runtime,
MessagesPalletInstance,
>::set_operating_mode {
operating_mode: new_mode,
});
// execute XCM with Transacts to `initialize bridge` as governance does
assert_ok!(RuntimeHelper::::execute_as_governance(
set_operating_mode_call.encode(),
set_operating_mode_call.get_dispatch_info().weight,
)
.ensure_complete());
// check mode after
assert_eq!(
pallet_bridge_messages::PalletOperatingMode::::try_get(),
Ok(new_mode)
);
};
// check mode before
assert_eq!(
pallet_bridge_messages::PalletOperatingMode::::try_get(
),
Err(())
);
dispatch_set_operating_mode_call(
MessagesOperatingMode::Basic(BasicOperatingMode::Normal),
MessagesOperatingMode::RejectingOutboundMessages,
);
dispatch_set_operating_mode_call(
MessagesOperatingMode::RejectingOutboundMessages,
MessagesOperatingMode::Basic(BasicOperatingMode::Halted),
);
dispatch_set_operating_mode_call(
MessagesOperatingMode::Basic(BasicOperatingMode::Halted),
MessagesOperatingMode::Basic(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_para_id: u32,
sibling_parachain_id: u32,
unwrap_pallet_bridge_messages_event: Box<
dyn Fn(Vec) -> Option>,
>,
export_message_instruction: fn() -> Instruction,
expected_lane_id: LaneId,
existential_deposit: Option,
maybe_paid_export_message: Option,
prepare_configuration: impl Fn(),
) where
Runtime: BasicParachainRuntime + BridgeMessagesConfig,
XcmConfig: xcm_executor::Config,
MessagesPalletInstance: 'static,
{
assert_ne!(runtime_para_id, sibling_parachain_id);
let sibling_parachain_location = Location::new(1, [Parachain(sibling_parachain_id)]);
run_test::(collator_session_key, runtime_para_id, vec![], || {
prepare_configuration();
// check queue before
assert_eq!(
pallet_bridge_messages::OutboundLanes::::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(Assets::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 mut hash = xcm.using_encoded(sp_io::hashing::blake2_256);
assert_ok!(XcmExecutor::::prepare_and_execute(
sibling_parachain_location,
xcm,
&mut hash,
RuntimeHelper::::xcm_max_weight(XcmReceivedFrom::Sibling),
Weight::zero(),
)
.ensure_complete());
// check queue after
assert_eq!(
pallet_bridge_messages::OutboundLanes::::try_get(
expected_lane_id
),
Ok(OutboundLaneData {
oldest_unpruned_nonce: 1,
latest_received_nonce: 0,
latest_generated_nonce: 1,
})
);
// check events
let mut events = >::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,
slot_durations: SlotDurations,
runtime_para_id: u32,
sibling_parachain_id: u32,
unwrap_cumulus_pallet_parachain_system_event: Box<
dyn Fn(Vec) -> Option>,
>,
unwrap_cumulus_pallet_xcmp_queue_event: Box<
dyn Fn(Vec) -> Option>,
>,
expected_lane_id: LaneId,
prepare_configuration: impl Fn(),
) where
Runtime: BasicParachainRuntime
+ cumulus_pallet_xcmp_queue::Config
+ BridgeMessagesConfig,
AllPalletsWithoutSystem:
OnInitialize> + OnFinalize>,
AccountIdOf: From
+ Into<<::RuntimeOrigin as OriginTrait>::AccountId>,
XcmConfig: xcm_executor::Config,
MessagesPalletInstance: 'static,
HrmpChannelOpener: frame_support::inherent::ProvideInherent<
Call = cumulus_pallet_parachain_system::Call,
>,
RuntimeNetwork: Get,
BridgedNetwork: Get,
NetworkDistanceAsParentCount: Get,
{
struct NetworkWithParentCount(core::marker::PhantomData<(N, C)>);
impl, C: Get> Get for NetworkWithParentCount {
fn get() -> Location {
Location::new(C::get(), [GlobalConsensus(N::get())])
}
}
assert_ne!(runtime_para_id, sibling_parachain_id);
run_test::(collator_session_key, runtime_para_id, vec![], || {
prepare_configuration();
let mut alice = [0u8; 32];
alice[0] = 1;
let included_head = RuntimeHelper::::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,
AlwaysLatest,
>((RuntimeNetwork::get(), Here));
let result =
<>::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 = >::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,
AlwaysLatest,
>((RuntimeNetwork::get(), [Parachain(sibling_parachain_id)].into()));
// 2.1. WITHOUT opened hrmp channel -> RoutingError
let result =
<>::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!(
>::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_para_id.into(),
sibling_parachain_id.into(),
included_head,
&alice,
&slot_durations,
);
let result =
<>::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 = >::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: From + Into,
{
// data here are not relevant for weighing
let mut xcm = Xcm(vec![
WithdrawAsset(Assets::from(vec![Asset {
id: AssetId(Location::new(1, [])),
fun: Fungible(34333299),
}])),
BuyExecution {
fees: Asset { id: AssetId(Location::new(1, [])), fun: Fungible(34333299) },
weight_limit: Unlimited,
},
ExportMessage {
network: Polkadot,
destination: [Parachain(1000)].into(),
xcm: Xcm(vec![
ReserveAssetDeposited(Assets::from(vec![Asset {
id: AssetId(Location::new(2, [GlobalConsensus(Kusama)])),
fun: Fungible(1000000000000),
}])),
ClearOrigin,
BuyExecution {
fees: Asset {
id: AssetId(Location::new(2, [GlobalConsensus(Kusama)])),
fun: Fungible(1000000000000),
},
weight_limit: Unlimited,
},
DepositAsset {
assets: Wild(AllCounted(1)),
beneficiary: Location::new(
0,
[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: Location::new(1, [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::::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()
}