Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion polkadot/xcm/pallet-xcm/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -972,18 +972,32 @@ pub mod pallet {
pub _config: core::marker::PhantomData<T>,
/// The default version to encode outgoing XCM messages with.
pub safe_xcm_version: Option<XcmVersion>,
/// The default versioned locations to support at genesis.
pub supported_version: Vec<(Location, XcmVersion)>,
}

impl<T: Config> Default for GenesisConfig<T> {
fn default() -> Self {
Self { safe_xcm_version: Some(XCM_VERSION), _config: Default::default() }
Self {
_config: Default::default(),
safe_xcm_version: Some(XCM_VERSION),
supported_version: Vec::new(),
}
}
}

#[pallet::genesis_build]
impl<T: Config> BuildGenesisConfig for GenesisConfig<T> {
fn build(&self) {
SafeXcmVersion::<T>::set(self.safe_xcm_version);
// Set versioned locations to support at genesis.
self.supported_version.iter().for_each(|(location, version)| {
SupportedVersion::<T>::insert(
XCM_VERSION,
LatestVersionedLocation(location),
version,
);
});
}
}

Expand Down
4 changes: 3 additions & 1 deletion polkadot/xcm/pallet-xcm/src/mock.rs
Original file line number Diff line number Diff line change
Expand Up @@ -750,20 +750,22 @@ pub(crate) fn new_test_ext_with_balances(
balances,
// By default set actual latest XCM version
Some(XCM_VERSION),
vec![],
)
}

pub(crate) fn new_test_ext_with_balances_and_xcm_version(
balances: Vec<(AccountId, Balance)>,
safe_xcm_version: Option<XcmVersion>,
supported_version: Vec<(Location, XcmVersion)>,
) -> sp_io::TestExternalities {
let mut t = frame_system::GenesisConfig::<Test>::default().build_storage().unwrap();

pallet_balances::GenesisConfig::<Test> { balances, ..Default::default() }
.assimilate_storage(&mut t)
.unwrap();

pallet_xcm::GenesisConfig::<Test> { safe_xcm_version, ..Default::default() }
pallet_xcm::GenesisConfig::<Test> { safe_xcm_version, supported_version, ..Default::default() }
.assimilate_storage(&mut t)
.unwrap();

Expand Down
273 changes: 145 additions & 128 deletions polkadot/xcm/pallet-xcm/src/tests/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1046,79 +1046,81 @@ fn subscription_side_upgrades_work_without_notify() {

#[test]
fn subscriber_side_subscription_works() {
new_test_ext_with_balances_and_xcm_version(vec![], Some(XCM_VERSION)).execute_with(|| {
let remote: Location = Parachain(1000).into();
assert_ok!(XcmPallet::force_subscribe_version_notify(
RuntimeOrigin::root(),
Box::new(remote.clone().into()),
));
assert_eq!(XcmPallet::get_version_for(&remote), None);
take_sent_xcm();
new_test_ext_with_balances_and_xcm_version(vec![], Some(XCM_VERSION), vec![]).execute_with(
|| {
let remote: Location = Parachain(1000).into();
assert_ok!(XcmPallet::force_subscribe_version_notify(
RuntimeOrigin::root(),
Box::new(remote.clone().into()),
));
assert_eq!(XcmPallet::get_version_for(&remote), None);
take_sent_xcm();

// Assume subscription target is working ok.
// Assume subscription target is working ok.

let weight = BaseXcmWeight::get();
let message = Xcm(vec![
// Remote supports XCM v3
QueryResponse {
query_id: 0,
max_weight: Weight::zero(),
response: Response::Version(3),
querier: None,
},
]);
let mut hash = fake_message_hash(&message);
let r = XcmExecutor::<XcmConfig>::prepare_and_execute(
remote.clone(),
message,
&mut hash,
weight,
Weight::zero(),
);
assert_eq!(r, Outcome::Complete { used: weight });
assert_eq!(take_sent_xcm(), vec![]);
assert_eq!(XcmPallet::get_version_for(&remote), Some(3));
let weight = BaseXcmWeight::get();
let message = Xcm(vec![
// Remote supports XCM v3
QueryResponse {
query_id: 0,
max_weight: Weight::zero(),
response: Response::Version(3),
querier: None,
},
]);
let mut hash = fake_message_hash(&message);
let r = XcmExecutor::<XcmConfig>::prepare_and_execute(
remote.clone(),
message,
&mut hash,
weight,
Weight::zero(),
);
assert_eq!(r, Outcome::Complete { used: weight });
assert_eq!(take_sent_xcm(), vec![]);
assert_eq!(XcmPallet::get_version_for(&remote), Some(3));

// This message will be sent as v3.
let v4_msg = xcm::v4::Xcm::<()>(vec![xcm::v4::Instruction::Trap(0)]);
assert_eq!(
XcmPallet::wrap_version(&remote, v4_msg.clone()),
Ok(VersionedXcm::V3(xcm::v3::Xcm(vec![xcm::v3::Instruction::Trap(0)])))
);
// This message will be sent as v3.
let v4_msg = xcm::v4::Xcm::<()>(vec![xcm::v4::Instruction::Trap(0)]);
assert_eq!(
XcmPallet::wrap_version(&remote, v4_msg.clone()),
Ok(VersionedXcm::V3(xcm::v3::Xcm(vec![xcm::v3::Instruction::Trap(0)])))
);

let message = Xcm(vec![
// Remote upgraded to XCM v4
QueryResponse {
query_id: 0,
max_weight: Weight::zero(),
response: Response::Version(4),
querier: None,
},
]);
let mut hash = fake_message_hash(&message);
let r = XcmExecutor::<XcmConfig>::prepare_and_execute(
remote.clone(),
message,
&mut hash,
weight,
Weight::zero(),
);
assert_eq!(r, Outcome::Complete { used: weight });
assert_eq!(take_sent_xcm(), vec![]);
assert_eq!(XcmPallet::get_version_for(&remote), Some(4));
let message = Xcm(vec![
// Remote upgraded to XCM v4
QueryResponse {
query_id: 0,
max_weight: Weight::zero(),
response: Response::Version(4),
querier: None,
},
]);
let mut hash = fake_message_hash(&message);
let r = XcmExecutor::<XcmConfig>::prepare_and_execute(
remote.clone(),
message,
&mut hash,
weight,
Weight::zero(),
);
assert_eq!(r, Outcome::Complete { used: weight });
assert_eq!(take_sent_xcm(), vec![]);
assert_eq!(XcmPallet::get_version_for(&remote), Some(4));

// This message is now sent as v4.
assert_eq!(
XcmPallet::wrap_version(&remote, v4_msg.clone()),
Ok(VersionedXcm::from(v4_msg))
);
});
// This message is now sent as v4.
assert_eq!(
XcmPallet::wrap_version(&remote, v4_msg.clone()),
Ok(VersionedXcm::from(v4_msg))
);
},
);
}

/// We should auto-subscribe when we don't know the remote's version.
#[test]
fn auto_subscription_works() {
new_test_ext_with_balances_and_xcm_version(vec![], None).execute_with(|| {
new_test_ext_with_balances_and_xcm_version(vec![], None, vec![]).execute_with(|| {
let remote_v3: Location = Parachain(1000).into();
let remote_v4: Location = Parachain(1001).into();

Expand Down Expand Up @@ -1310,77 +1312,92 @@ fn subscription_side_upgrades_work_with_multistage_notify() {

#[test]
fn get_and_wrap_version_works() {
new_test_ext_with_balances_and_xcm_version(vec![], None).execute_with(|| {
let remote_a: Location = Parachain(1000).into();
let remote_b: Location = Parachain(1001).into();
let remote_c: Location = Parachain(1002).into();

// no `safe_xcm_version` version at `GenesisConfig`
assert_eq!(XcmPallet::get_version_for(&remote_a), None);
assert_eq!(XcmPallet::get_version_for(&remote_b), None);
assert_eq!(XcmPallet::get_version_for(&remote_c), None);
assert_eq!(VersionDiscoveryQueue::<Test>::get().into_inner(), vec![]);

// set default XCM version (a.k.a. `safe_xcm_version`)
assert_ok!(XcmPallet::force_default_xcm_version(RuntimeOrigin::root(), Some(1)));
assert_eq!(XcmPallet::get_version_for(&remote_a), None);
assert_eq!(XcmPallet::get_version_for(&remote_b), None);
assert_eq!(XcmPallet::get_version_for(&remote_c), None);
assert_eq!(VersionDiscoveryQueue::<Test>::get().into_inner(), vec![]);

// set XCM version only for `remote_a`
assert_ok!(XcmPallet::force_xcm_version(
RuntimeOrigin::root(),
Box::new(remote_a.clone()),
XCM_VERSION
));
assert_eq!(XcmPallet::get_version_for(&remote_a), Some(XCM_VERSION));
assert_eq!(XcmPallet::get_version_for(&remote_b), None);
assert_eq!(XcmPallet::get_version_for(&remote_c), None);
assert_eq!(VersionDiscoveryQueue::<Test>::get().into_inner(), vec![]);
let remote_a: Location = Parachain(1000).into();
let remote_b: Location = Parachain(1001).into();
let remote_c: Location = Parachain(1002).into();
let remote_d: Location = Parachain(1003).into();

new_test_ext_with_balances_and_xcm_version(vec![], None, vec![(remote_d.clone(), XCM_VERSION)])
.execute_with(|| {
// Versioned XCM location for `remote_d` was set in the genesis state
assert_eq!(XcmPallet::get_version_for(&remote_d), Some(XCM_VERSION));

// no `safe_xcm_version` version at `GenesisConfig`
assert_eq!(XcmPallet::get_version_for(&remote_a), None);
assert_eq!(XcmPallet::get_version_for(&remote_b), None);
assert_eq!(XcmPallet::get_version_for(&remote_c), None);
assert_eq!(XcmPallet::get_version_for(&remote_d), Some(XCM_VERSION));
assert_eq!(VersionDiscoveryQueue::<Test>::get().into_inner(), vec![]);

// set default XCM version (a.k.a. `safe_xcm_version`)
assert_ok!(XcmPallet::force_default_xcm_version(RuntimeOrigin::root(), Some(1)));
assert_eq!(XcmPallet::get_version_for(&remote_a), None);
assert_eq!(XcmPallet::get_version_for(&remote_b), None);
assert_eq!(XcmPallet::get_version_for(&remote_c), None);
assert_eq!(XcmPallet::get_version_for(&remote_d), Some(XCM_VERSION));
assert_eq!(VersionDiscoveryQueue::<Test>::get().into_inner(), vec![]);

// set XCM version only for `remote_a`
assert_ok!(XcmPallet::force_xcm_version(
RuntimeOrigin::root(),
Box::new(remote_a.clone()),
XCM_VERSION
));
assert_eq!(XcmPallet::get_version_for(&remote_a), Some(XCM_VERSION));
assert_eq!(XcmPallet::get_version_for(&remote_b), None);
assert_eq!(XcmPallet::get_version_for(&remote_c), None);
assert_eq!(XcmPallet::get_version_for(&remote_d), Some(XCM_VERSION));
assert_eq!(VersionDiscoveryQueue::<Test>::get().into_inner(), vec![]);

let xcm = Xcm::<()>::default();
let xcm = Xcm::<()>::default();

// wrap version - works because remote_a has `XCM_VERSION`
assert_eq!(
XcmPallet::wrap_version(&remote_a, xcm.clone()),
Ok(VersionedXcm::from(xcm.clone()))
);
// does not work because remote_b has unknown version and default is set to 1, and
// `XCM_VERSION` cannot be wrapped to the `1`
assert_eq!(XcmPallet::wrap_version(&remote_b, xcm.clone()), Err(()));
assert_eq!(
VersionDiscoveryQueue::<Test>::get().into_inner(),
vec![(remote_b.clone().into(), 1)]
);
// wrap version - works because remote_a has `XCM_VERSION`
assert_eq!(
XcmPallet::wrap_version(&remote_a, xcm.clone()),
Ok(VersionedXcm::from(xcm.clone()))
);
// does not work because remote_b has unknown version and default is set to 1, and
// `XCM_VERSION` cannot be wrapped to the `1`
assert_eq!(XcmPallet::wrap_version(&remote_b, xcm.clone()), Err(()));
assert_eq!(
VersionDiscoveryQueue::<Test>::get().into_inner(),
vec![(remote_b.clone().into(), 1)]
);

// set default to the `XCM_VERSION`
assert_ok!(XcmPallet::force_default_xcm_version(RuntimeOrigin::root(), Some(XCM_VERSION)));
assert_eq!(XcmPallet::get_version_for(&remote_b), None);
assert_eq!(XcmPallet::get_version_for(&remote_c), None);
// set default to the `XCM_VERSION`
assert_ok!(XcmPallet::force_default_xcm_version(
RuntimeOrigin::root(),
Some(XCM_VERSION)
));
assert_eq!(XcmPallet::get_version_for(&remote_b), None);
assert_eq!(XcmPallet::get_version_for(&remote_c), None);
assert_eq!(XcmPallet::get_version_for(&remote_d), Some(XCM_VERSION));

// now works, because default is `XCM_VERSION`
assert_eq!(
XcmPallet::wrap_version(&remote_b, xcm.clone()),
Ok(VersionedXcm::from(xcm.clone()))
);
assert_eq!(
VersionDiscoveryQueue::<Test>::get().into_inner(),
vec![(remote_b.clone().into(), 2)]
);
// now works, because default is `XCM_VERSION`
assert_eq!(
XcmPallet::wrap_version(&remote_b, xcm.clone()),
Ok(VersionedXcm::from(xcm.clone()))
);
assert_eq!(
VersionDiscoveryQueue::<Test>::get().into_inner(),
vec![(remote_b.clone().into(), 2)]
);

// change remote_c to `1`
assert_ok!(XcmPallet::force_xcm_version(
RuntimeOrigin::root(),
Box::new(remote_c.clone()),
1
));
// change remote_c to `1`
assert_ok!(XcmPallet::force_xcm_version(
RuntimeOrigin::root(),
Box::new(remote_c.clone()),
1
));

// does not work because remote_c has `1` and default is `XCM_VERSION` which cannot be
// wrapped to the `1`
assert_eq!(XcmPallet::wrap_version(&remote_c, xcm.clone()), Err(()));
assert_eq!(VersionDiscoveryQueue::<Test>::get().into_inner(), vec![(remote_b.into(), 2)]);
})
// does not work because remote_c has `1` and default is `XCM_VERSION` which cannot be
// wrapped to the `1`
assert_eq!(XcmPallet::wrap_version(&remote_c, xcm.clone()), Err(()));
assert_eq!(
VersionDiscoveryQueue::<Test>::get().into_inner(),
vec![(remote_b.into(), 2)]
);
})
}

#[test]
Expand Down
8 changes: 8 additions & 0 deletions prdoc/pr_9225.prdoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
title: 'Add supported_version to pallet-xcm genesis config'
doc:
- audience: Runtime Dev
description: |-
Adds a `supported_version` field to the pallet-xcm genesis config, which allows specifying versioned locations at genesis.
crates:
- name: pallet-xcm
bump: major
Loading