add integration tests to xcm-builder (#3537)

* add integration tests to xcm-builder * add an integration test for reserve_transfer_assets * add query holding and teleport tests * formatting * add to barrier doc comments and fix doc tests warnings * use more realistic barrier for integration tests * improve imports * adjust base xcm weight and existential deposit to be in line with Kusama * remove AnyNetwork Co-authored-by: Amar Singh <asinghchrony@protonmail.com> * add more comments and remove unnecessary code * move mock into separate file * reduce imports * update cargo.lock * remove reserve transfer test from xcm builder integration tests * reword barrier doc comment * elaborate on QueryHolding test scenario * add an integration test for reserve based transfers from parachain to parachain * add teleport tests * fix failing teleport filter tests * Update xcm/xcm-builder/src/integration_tests.rs Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com> * Update xcm/xcm-builder/src/integration_tests.rs Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com> * Update xcm/xcm-builder/src/integration_tests.rs Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com> * Move integration tests to tests/ directory * Fix merge * Replace All wildcard with a concrete seed amount * Rename SEED_AMOUNT to REGISTER_AMOUNT * Fix compilation error * Check for teleport destination first before checking out assets * Fix unit test * Do not run tests in integration mock * Add a permissive assets filter for teleportation * Remove check for teleport location in InitiateTeleport XCM * Remove defunct test * Apply suggestions from code review Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com> * Reword comment Co-authored-by: Amar Singh <asinghchrony@protonmail.com> Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com> Co-authored-by: Keith Yeung <kungfukeith11@gmail.com>
2026-04-26 18:07:58 +00:00 · 2021-08-17 23:39:47 +02:00
parent e014e53f4a
commit 7b054850fb
9 changed files with 551 additions and 9 deletions
@@ -0,0 +1,314 @@
+// Copyright 2020 Parity Technologies (UK) Ltd.
+// This file is part of Polkadot.
+
+// Polkadot 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.
+
+// Polkadot 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 Polkadot.  If not, see <http://www.gnu.org/licenses/>.
+
+mod mock;
+
+use frame_support::weights::Weight;
+use mock::{
+	kusama_like_with_balances, AccountId, Balance, Balances, BaseXcmWeight, XcmConfig, CENTS,
+};
+use polkadot_parachain::primitives::Id as ParaId;
+use sp_runtime::traits::AccountIdConversion;
+use xcm::latest::prelude::*;
+use xcm_executor::XcmExecutor;
+
+pub const ALICE: AccountId = AccountId::new([0u8; 32]);
+pub const PARA_ID: u32 = 2000;
+pub const INITIAL_BALANCE: u128 = 100_000_000_000;
+pub const REGISTER_AMOUNT: Balance = 10 * CENTS;
+
+// Construct a `BuyExecution` order.
+fn buy_execution<C>(debt: Weight) -> Order<C> {
+	use xcm::latest::prelude::*;
+	Order::BuyExecution {
+		fees: (Here, REGISTER_AMOUNT).into(),
+		weight: 0,
+		debt,
+		halt_on_error: false,
+		orders: vec![],
+		instructions: vec![],
+	}
+}
+
+/// Scenario:
+/// A parachain transfers funds on the relaychain to another parachain's account.
+///
+/// Asserts that the parachain accounts are updated as expected.
+#[test]
+fn withdraw_and_deposit_works() {
+	let para_acc: AccountId = ParaId::from(PARA_ID).into_account();
+	let balances = vec![(ALICE, INITIAL_BALANCE), (para_acc.clone(), INITIAL_BALANCE)];
+	kusama_like_with_balances(balances).execute_with(|| {
+		let other_para_id = 3000;
+		let amount = REGISTER_AMOUNT;
+		let weight = 3 * BaseXcmWeight::get();
+		let r = XcmExecutor::<XcmConfig>::execute_xcm(
+			Parachain(PARA_ID).into(),
+			Xcm::WithdrawAsset {
+				assets: vec![(Here, amount).into()].into(),
+				effects: vec![
+					buy_execution(weight),
+					Order::DepositAsset {
+						assets: All.into(),
+						max_assets: 1,
+						beneficiary: Parachain(other_para_id).into(),
+					},
+				],
+			},
+			weight,
+		);
+		assert_eq!(r, Outcome::Complete(weight));
+		let other_para_acc: AccountId = ParaId::from(other_para_id).into_account();
+		assert_eq!(Balances::free_balance(para_acc), INITIAL_BALANCE - amount);
+		assert_eq!(Balances::free_balance(other_para_acc), amount);
+	});
+}
+
+/// Scenario:
+/// A parachain wants to be notified that a transfer worked correctly.
+/// It includes a `QueryHolding` order after the deposit to get notified on success.
+/// This somewhat abuses `QueryHolding` as an indication of execution success. It works because
+/// order execution halts on error (so no `QueryResponse` will be sent if the previous order failed).
+/// The inner response sent due to the query is not used.
+///
+/// Asserts that the balances are updated correctly and the expected XCM is sent.
+#[test]
+fn query_holding_works() {
+	use xcm::opaque::latest::prelude::*;
+	let para_acc: AccountId = ParaId::from(PARA_ID).into_account();
+	let balances = vec![(ALICE, INITIAL_BALANCE), (para_acc.clone(), INITIAL_BALANCE)];
+	kusama_like_with_balances(balances).execute_with(|| {
+		let other_para_id = 3000;
+		let amount = REGISTER_AMOUNT;
+		let query_id = 1234;
+		let weight = 4 * BaseXcmWeight::get();
+		let r = XcmExecutor::<XcmConfig>::execute_xcm(
+			Parachain(PARA_ID).into(),
+			Xcm::WithdrawAsset {
+				assets: vec![(Here, amount).into()].into(),
+				effects: vec![
+					buy_execution(weight),
+					Order::DepositAsset {
+						assets: All.into(),
+						max_assets: 1,
+						beneficiary: OnlyChild.into(), // invalid destination
+					},
+					// is not triggered becasue the deposit fails
+					Order::QueryHolding {
+						query_id,
+						dest: Parachain(PARA_ID).into(),
+						assets: All.into(),
+					},
+				],
+			},
+			weight,
+		);
+		assert_eq!(
+			r,
+			Outcome::Incomplete(
+				weight,
+				XcmError::FailedToTransactAsset("AccountIdConversionFailed")
+			)
+		);
+		// there should be no query response sent for the failed deposit
+		assert_eq!(mock::sent_xcm(), vec![]);
+		assert_eq!(Balances::free_balance(para_acc.clone()), INITIAL_BALANCE - amount);
+
+		// now do a successful transfer
+		let r = XcmExecutor::<XcmConfig>::execute_xcm(
+			Parachain(PARA_ID).into(),
+			Xcm::WithdrawAsset {
+				assets: vec![(Here, amount).into()].into(),
+				effects: vec![
+					buy_execution(weight),
+					Order::DepositAsset {
+						assets: All.into(),
+						max_assets: 1,
+						beneficiary: Parachain(other_para_id).into(),
+					},
+					// used to get a notification in case of success
+					Order::QueryHolding {
+						query_id,
+						dest: Parachain(PARA_ID).into(),
+						assets: All.into(),
+					},
+				],
+			},
+			weight,
+		);
+		assert_eq!(r, Outcome::Complete(weight));
+		let other_para_acc: AccountId = ParaId::from(other_para_id).into_account();
+		assert_eq!(Balances::free_balance(other_para_acc), amount);
+		assert_eq!(Balances::free_balance(para_acc), INITIAL_BALANCE - 2 * amount);
+		assert_eq!(
+			mock::sent_xcm(),
+			vec![(
+				Parachain(PARA_ID).into(),
+				Xcm::QueryResponse { query_id, response: Response::Assets(vec![].into()) }
+			)]
+		);
+	});
+}
+
+/// Scenario:
+/// A parachain wants to move KSM from Kusama to Statemine.
+/// The parachain sends an XCM to withdraw funds combined with a teleport to the destination.
+///
+/// This way of moving funds from a relay to a parachain will only work for trusted chains.
+/// Reserve based transfer should be used to move KSM to a community parachain.
+///
+/// Asserts that the balances are updated accordingly and the correct XCM is sent.
+#[test]
+fn teleport_to_statemine_works() {
+	use xcm::opaque::latest::prelude::*;
+	let para_acc: AccountId = ParaId::from(PARA_ID).into_account();
+	let balances = vec![(ALICE, INITIAL_BALANCE), (para_acc.clone(), INITIAL_BALANCE)];
+	kusama_like_with_balances(balances).execute_with(|| {
+		let statemine_id = 1000;
+		let other_para_id = 3000;
+		let amount = REGISTER_AMOUNT;
+		let teleport_effects = vec![
+			buy_execution(5), // unchecked mock value
+			Order::DepositAsset {
+				assets: All.into(),
+				max_assets: 1,
+				beneficiary: (1, Parachain(PARA_ID)).into(),
+			},
+		];
+		let weight = 3 * BaseXcmWeight::get();
+
+		// teleports are allowed to community chains, even in the absence of trust from their side.
+		let r = XcmExecutor::<XcmConfig>::execute_xcm(
+			Parachain(PARA_ID).into(),
+			Xcm::WithdrawAsset {
+				assets: vec![(Here, amount).into()].into(),
+				effects: vec![
+					buy_execution(weight),
+					Order::InitiateTeleport {
+						assets: All.into(),
+						dest: Parachain(other_para_id).into(),
+						effects: teleport_effects.clone(),
+					},
+				],
+			},
+			weight,
+		);
+		assert_eq!(r, Outcome::Complete(weight));
+		assert_eq!(
+			mock::sent_xcm(),
+			vec![(
+				Parachain(other_para_id).into(),
+				Xcm::ReceiveTeleportedAsset {
+					assets: vec![(Parent, amount).into()].into(),
+					effects: teleport_effects.clone(),
+				}
+			)]
+		);
+
+		// teleports are allowed from statemine to kusama.
+		let r = XcmExecutor::<XcmConfig>::execute_xcm(
+			Parachain(PARA_ID).into(),
+			Xcm::WithdrawAsset {
+				assets: vec![(Here, amount).into()].into(),
+				effects: vec![
+					buy_execution(weight),
+					Order::InitiateTeleport {
+						assets: All.into(),
+						dest: Parachain(statemine_id).into(),
+						effects: teleport_effects.clone(),
+					},
+				],
+			},
+			weight,
+		);
+		assert_eq!(r, Outcome::Complete(weight));
+		// 2 * amount because of the other teleport above
+		assert_eq!(Balances::free_balance(para_acc), INITIAL_BALANCE - 2 * amount);
+		assert_eq!(
+			mock::sent_xcm(),
+			vec![
+				(
+					Parachain(other_para_id).into(),
+					Xcm::ReceiveTeleportedAsset {
+						assets: vec![(Parent, amount).into()].into(),
+						effects: teleport_effects.clone(),
+					}
+				),
+				(
+					Parachain(statemine_id).into(),
+					Xcm::ReceiveTeleportedAsset {
+						assets: vec![(Parent, amount).into()].into(),
+						effects: teleport_effects,
+					}
+				)
+			]
+		);
+	});
+}
+
+/// Scenario:
+/// A parachain wants to move KSM from Kusama to the parachain.
+/// It withdraws funds and then deposits them into the reserve account of the destination chain.
+/// to the destination.
+///
+/// Asserts that the balances are updated accordingly and the correct XCM is sent.
+#[test]
+fn reserve_based_transfer_works() {
+	use xcm::opaque::latest::prelude::*;
+	let para_acc: AccountId = ParaId::from(PARA_ID).into_account();
+	let balances = vec![(ALICE, INITIAL_BALANCE), (para_acc.clone(), INITIAL_BALANCE)];
+	kusama_like_with_balances(balances).execute_with(|| {
+		let other_para_id = 3000;
+		let amount = REGISTER_AMOUNT;
+		let transfer_effects = vec![
+			buy_execution(5), // unchecked mock value
+			Order::DepositAsset {
+				assets: All.into(),
+				max_assets: 1,
+				beneficiary: (1, Parachain(PARA_ID)).into(),
+			},
+		];
+		let weight = 3 * BaseXcmWeight::get();
+		let r = XcmExecutor::<XcmConfig>::execute_xcm(
+			Parachain(PARA_ID).into(),
+			Xcm::WithdrawAsset {
+				assets: vec![(Here, amount).into()].into(),
+				effects: vec![
+					buy_execution(weight),
+					Order::DepositReserveAsset {
+						assets: All.into(),
+						max_assets: 1,
+						dest: Parachain(other_para_id).into(),
+						effects: transfer_effects.clone(),
+					},
+				],
+			},
+			weight,
+		);
+		assert_eq!(r, Outcome::Complete(weight));
+		assert_eq!(Balances::free_balance(para_acc), INITIAL_BALANCE - amount);
+		assert_eq!(
+			mock::sent_xcm(),
+			vec![(
+				Parachain(other_para_id).into(),
+				Xcm::ReserveAssetDeposited {
+					assets: vec![(Parent, amount).into()].into(),
+					effects: transfer_effects,
+				}
+			)]
+		);
+	});
+}