[XCMv5] Better fee mechanism by franciscoaguirre · Pull Request #5420 · paritytech/polkadot-sdk

franciscoaguirre · 2024-08-20T14:29:54Z

Implements RFC#105 which, at the time of this PR, has not been approved yet. Some aspects might be changed as a result of discussion.

TODO

…to mock

…rrier

…th PayFees

franciscoaguirre · 2024-08-27T10:10:21Z

bot bench polkadot-pallet --subcommand=xcm --runtime=westend --pallet=pallet_xcm_benchmarks::generic
bot bench polkadot-pallet --subcommand=xcm --runtime=rococo --pallet=pallet_xcm_benchmarks::generic

bot bench cumulus-assets --subcommand=xcm --runtime=asset-hub-westend --pallet=pallet_xcm_benchmarks::generic
bot bench cumulus-assets --subcommand=xcm --runtime=asset-hub-rococo --pallet=pallet_xcm_benchmarks::generic

bot bench cumulus-coretime --subcommand=xcm --runtime=coretime-westend --pallet=pallet_xcm_benchmarks::generic
bot bench cumulus-coretime --subcommand=xcm --runtime=coretime-rococo --pallet=pallet_xcm_benchmarks::generic

bot bench cumulus-bridge-hubs --subcommand=xcm --runtime=bridge-hub-rococo --pallet=pallet_xcm_benchmarks::generic
bot bench cumulus-bridge-hubs --subcommand=xcm --runtime=bridge-hub-westend --pallet=pallet_xcm_benchmarks::generic

bot bench cumulus-contracts --subcommand=xcm --pallet=pallet_xcm_benchmarks::generic

bot bench cumulus-people --subcommand=xcm --runtime=people-westend --pallet=pallet_xcm_benchmarks::generic
bot bench cumulus-people --subcommand=xcm --runtime=people-rococo --pallet=pallet_xcm_benchmarks::generic

…coco --target_dir=polkadot --pallet=pallet_xcm_benchmarks::generic

…stend --target_dir=polkadot --pallet=pallet_xcm_benchmarks::generic

…retime-westend --runtime_dir=coretime --target_dir=cumulus --pallet=pallet_xcm_benchmarks::generic

…set-hub-rococo --runtime_dir=assets --target_dir=cumulus --pallet=pallet_xcm_benchmarks::generic

…set-hub-westend --runtime_dir=assets --target_dir=cumulus --pallet=pallet_xcm_benchmarks::generic

…retime-rococo --runtime_dir=coretime --target_dir=cumulus --pallet=pallet_xcm_benchmarks::generic

…idge-hub-rococo --runtime_dir=bridge-hubs --target_dir=cumulus --pallet=pallet_xcm_benchmarks::generic

…idge-hub-westend --runtime_dir=bridge-hubs --target_dir=cumulus --pallet=pallet_xcm_benchmarks::generic

franciscoaguirre · 2024-10-07T11:12:27Z

bot fmt

command-bot · 2024-10-07T11:12:32Z

@franciscoaguirre https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/7522122 was started for your command "$PIPELINE_SCRIPTS_DIR/commands/fmt/fmt.sh". Check out https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/pipelines?page=1&scope=all&username=group_605_bot to know what else is being executed currently.

Comment bot cancel 21-9481da8a-95a0-43a6-a9ea-cf187608b520 to cancel this command or bot cancel to cancel all commands in this pull request.

command-bot · 2024-10-07T11:15:29Z

@franciscoaguirre Command "$PIPELINE_SCRIPTS_DIR/commands/fmt/fmt.sh" has finished. Result: https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/7522122 has finished. If any artifacts were generated, you can download them from https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/7522122/artifacts/download.

franciscoaguirre · 2024-10-07T11:33:45Z

bot fmt

command-bot · 2024-10-07T11:33:50Z

@franciscoaguirre https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/7522964 was started for your command "$PIPELINE_SCRIPTS_DIR/commands/fmt/fmt.sh". Check out https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/pipelines?page=1&scope=all&username=group_605_bot to know what else is being executed currently.

Comment bot cancel 22-d5f8c9e1-786c-4c35-954f-97fb8b7585d4 to cancel this command or bot cancel to cancel all commands in this pull request.

command-bot · 2024-10-07T11:34:50Z

@franciscoaguirre Command "$PIPELINE_SCRIPTS_DIR/commands/fmt/fmt.sh" has finished. Result: https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/7522964 has finished. If any artifacts were generated, you can download them from https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/7522964/artifacts/download.

When trying to pay delivery fees, check for both PayFees and BuyExecution assets and try to auto-swap either of them.

bkontur · 2024-10-15T15:19:50Z

polkadot/xcm/src/v4/mod.rs

+			PayFees { .. } => {
+				return Err(());
+			},


I think there are more new instructions coming, do we want to make this generic or case-by-case e.g.: https://github.com/paritytech/polkadot-sdk/blob/master/polkadot/xcm/src/v2/mod.rs#L1182

Suggested change

PayFees { .. } => {

return Err(());

},

i => {

log::warn!(target: "xcm::v5tov4", "`{i:?}` not supported by v4");

return Err(());

},

bkontur · 2024-10-16T10:23:12Z

polkadot/xcm/procedural/src/builder_pattern.rs

+			let maybe_builder_attr = variant.attrs.iter().find(|attr| match attr.meta {
+				Meta::List(ref list) => list.path.is_ident("builder"),
+				_ => false,
+			});
+			let builder_attr = match maybe_builder_attr {
+				Some(builder) => builder.clone(),
+				None => return Ok(None), /* It's not going to be an instruction that pays fees */
+			};
+			let Meta::List(ref list) = builder_attr.meta else { unreachable!("We checked before") };
+			let inner_ident: Ident = syn::parse2(list.tokens.clone()).map_err(|_| {
+				Error::new_spanned(
+					&builder_attr,
+					"Expected `builder(loads_holding)` or `builder(pays_fees)`",
+				)
+			})?;
+			let ident_to_match: Ident = syn::parse_quote!(pays_fees);
+			if inner_ident == ident_to_match {
+				Ok(Some(variant))
+			} else {
+				Ok(None) // Must have been `loads_holding` instead.
+			}
+		})
+		.collect::<Result<Vec<_>>>()?;


This could be deduplicated. Parsing pay_fees_variants and load_holding_variants uses exactly the same code, differing only in: syn::parse_quote!(pays_fees); vs syn::parse_quote!(loads_holding).
So it should be possible to extract it to some helper function:

let load_holding_variants = parse_variants(data_enum, syn::parse_quote!(loads_holding)); let pay_fees_variants = parse_variants(data_enum, syn::parse_quote!(pays_fees));

bkontur · 2024-10-16T10:39:38Z

polkadot/xcm/procedural/src/builder_pattern.rs

+				_ =>
+					return Err(Error::new_spanned(
+						variant,
+						"Both BuyExecution and PayFees have named fields",


I'm not fully convinced that this builder(pay_fees) assumes specific instructions like BuyExecution or PayFees and their structure. Why do we assume that these instructions can't have unnamed fields?

I suggest extracting the entire block of code that parses let load_holding_methods = load_holding_variants, and doing the following:

Turn it into a helper function parse_variant_methods (or better name).

It can nicely parse both named and unnamed fields

Add a parameter that specifies the result type (that is the only difference here), such as LoadedHolding or AnythingGoes.

This way, we could have a single helper function, like parse_variant_methods, which will make generate_builder_impl simpler and more deduplicated:

fn generate_builder_impl(..) { // We first require an instruction that load the holding register let load_holding_methods = parse_variant_methods(data_enum, syn::parse_quote!(loads_holding), LoadedHolding); ... // Some operations are allowed after the holding register is loaded let allowed_after_load_holding_methods: ... ... // Then we require fees to be paid let pay_fees_methods = parse_variant_methods(data_enum, syn::parse_quote!(pays_fees), AnythingGoes); }

@franciscoaguirre please do this in a followup PR, let's merge this one so we can work on top of the new fees mechanism

cumulus/parachains/integration-tests/emulated/common/src/macros.rs

polkadot/xcm/xcm-executor/src/lib.rs

…st` (#6092) Relates to: #5420 This PR includes some cleanup, as every time we upgrade XCM, we will need to rewrite all instances of `V5` to `V6`. --------- Co-authored-by: command-bot <>

# Context This PR aims to introduce XCMv5, for now it's in progress and will be updated over time. This branch will serve as a milestone branch for merging in all features we want to add to XCM, roughly outlined [here](polkadot-fellows/xcm-format#60). More features could be added. ## TODO - [x] Migrate foreign assets from v3 to v4 - [x] Setup v5 skeleton - [x] Remove XCMv2 - [x] #5390 - [x] #5585 - [x] #5420 - [x] #5876 - [x] #5971 - [x] #6148 - [x] #6228 Fixes #3434 Fixes #4190 Fixes #5209 Fixes #5241 Fixes #4284 --------- Signed-off-by: Adrian Catangiu <adrian@parity.io> Co-authored-by: Adrian Catangiu <adrian@parity.io> Co-authored-by: Andrii <ndk@parity.io> Co-authored-by: Branislav Kontur <bkontur@gmail.com> Co-authored-by: Joseph Zhao <65984904+programskillforverification@users.noreply.github.com> Co-authored-by: Nazar Mokrynskyi <nazar@mokrynskyi.com> Co-authored-by: Bastian Köcher <git@kchr.de> Co-authored-by: Shawn Tabrizi <shawntabrizi@gmail.com> Co-authored-by: command-bot <> Co-authored-by: GitHub Action <action@github.com> Co-authored-by: Serban Iorga <serban@parity.io>

feat(xcm): add PayFees instruction

3d7e24a

franciscoaguirre requested a review from a team as a code owner August 20, 2024 14:29

franciscoaguirre added the T6-XCM This PR/Issue is related to XCM. label Aug 20, 2024

franciscoaguirre added 7 commits August 21, 2024 18:20

chore(xcm-executor): clean up executor unit test and move everything …

0a88320

…to mock

Merge branch 'xcm-v5' into xcm-pay-fees

0b16ca5

feat(xcm-executor): tests for delivery fees and old BuyExecution

2393087

feat(xcm-executor): interaction between PayFees and RefundSurplus

b9ca9e0

fix(xcm): add builder(pays_fees) to old xcm versions

22efce5

chore(xcm-executor): unhappy tests for PayFees

49f63a4

chore(xcm-executor): test that leftover fees are also trapped

50b06d6

franciscoaguirre force-pushed the xcm-pay-fees branch from 1f82808 to 50b06d6 Compare August 26, 2024 09:00

franciscoaguirre added 10 commits August 26, 2024 19:48

chore: add made-up benchmarks to all runtimes

738a8c1

feat(xcm-builder): allow PayFees in AllowTopLevelPaidExecutionFrom ba…

995cc09

…rrier

feat(xcm-executor): use fees register in DepositReserveAsset

679c3c7

feat(xcm-emulator): add set_call method for dispatching calls

d934c64

test(asset-hub-westend-integration-tests): add xcm estimation test wi…

52f3ba1

…th PayFees

fix: fmt

900bb46

fix(xcm-executor): remove unnecessary clones

56bcd4d

chore(asset-hub-westend-integration-tests): refactor test to decl macro

c062c0c

feat(asset-hub-rococo-integration-tests): add PayFees test

94f831f

fix: fmt

3198950

command-bot added 8 commits August 27, 2024 10:53

".git/.scripts/commands/bench/bench.sh" --subcommand=xcm --runtime=ro…

6bf562b

…coco --target_dir=polkadot --pallet=pallet_xcm_benchmarks::generic

".git/.scripts/commands/bench/bench.sh" --subcommand=xcm --runtime=we…

15a5333

…stend --target_dir=polkadot --pallet=pallet_xcm_benchmarks::generic

".git/.scripts/commands/bench/bench.sh" --subcommand=xcm --runtime=co…

fb79e69

…retime-westend --runtime_dir=coretime --target_dir=cumulus --pallet=pallet_xcm_benchmarks::generic

".git/.scripts/commands/bench/bench.sh" --subcommand=xcm --runtime=as…

4c9dddc

…set-hub-rococo --runtime_dir=assets --target_dir=cumulus --pallet=pallet_xcm_benchmarks::generic

".git/.scripts/commands/bench/bench.sh" --subcommand=xcm --runtime=as…

a8d5d1d

…set-hub-westend --runtime_dir=assets --target_dir=cumulus --pallet=pallet_xcm_benchmarks::generic

".git/.scripts/commands/bench/bench.sh" --subcommand=xcm --runtime=co…

c1c95dc

…retime-rococo --runtime_dir=coretime --target_dir=cumulus --pallet=pallet_xcm_benchmarks::generic

".git/.scripts/commands/bench/bench.sh" --subcommand=xcm --runtime=br…

0c5afe3

…idge-hub-rococo --runtime_dir=bridge-hubs --target_dir=cumulus --pallet=pallet_xcm_benchmarks::generic

".git/.scripts/commands/bench/bench.sh" --subcommand=xcm --runtime=br…

338d8de

…idge-hub-westend --runtime_dir=bridge-hubs --target_dir=cumulus --pallet=pallet_xcm_benchmarks::generic

".git/.scripts/commands/fmt/fmt.sh"

f10feb0

fix: if no delivery fees are defined, xcm should still work

a9334fa

".git/.scripts/commands/fmt/fmt.sh"

adbec21

acatangiu approved these changes Oct 7, 2024

View reviewed changes

acatangiu and others added 4 commits October 7, 2024 19:03

fix auto-swap delivery fee when using PayFees (#5955)

66afb67

When trying to pay delivery fees, check for both PayFees and BuyExecution assets and try to auto-swap either of them.

fix: change some xcm licenses from Substrate to Polkadot

69dd94d

fix: change v4 to latest in benchmarks

193c2bf

chore: semver fix in prdoc

2cc969b

acatangiu mentioned this pull request Oct 14, 2024

[XCM SDK] Consolidated controllable fees #6052

Closed

5 tasks

serban300 approved these changes Oct 15, 2024

View reviewed changes

bkontur reviewed Oct 16, 2024

View reviewed changes

cumulus/parachains/integration-tests/emulated/common/src/macros.rs Outdated Show resolved Hide resolved

bkontur mentioned this pull request Oct 16, 2024

Use Versioned*::from instead of concrete V* when using xcm::latest #6092

Merged

bkontur reviewed Oct 16, 2024

View reviewed changes

polkadot/xcm/xcm-executor/src/lib.rs Show resolved Hide resolved

Use Versioned*::from instead of concrete V* when using `xcm::late…

8b49830

…st` (#6092) Relates to: #5420 This PR includes some cleanup, as every time we upgrade XCM, we will need to rewrite all instances of `V5` to `V6`. --------- Co-authored-by: command-bot <>

acatangiu merged commit d1425bb into xcm-v5 Oct 17, 2024

acatangiu deleted the xcm-pay-fees branch October 17, 2024 12:35

This was referenced Oct 17, 2024

Better delivery fees: PayFees #3434

Closed

XCM v5 #4826

Merged

acatangiu restored the xcm-pay-fees branch October 17, 2024 12:45

acatangiu deleted the xcm-pay-fees branch October 17, 2024 12:48

franciscoaguirre mentioned this pull request Jan 2, 2025

Implement new XCM fees handling mechanism in a backwards compatible way #5208

Closed

ashutoshvarma mentioned this pull request Apr 24, 2025

[Uplift] polkadot-sdk stable2412 uplift AstarNetwork/Astar#1405

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[XCMv5] Better fee mechanism#5420

[XCMv5] Better fee mechanism#5420
acatangiu merged 54 commits intoxcm-v5from
xcm-pay-fees

franciscoaguirre commented Aug 20, 2024 •

edited

Loading

Uh oh!

franciscoaguirre commented Aug 27, 2024

Uh oh!

franciscoaguirre commented Oct 7, 2024

Uh oh!

command-bot bot commented Oct 7, 2024 •

edited

Loading

Uh oh!

command-bot bot commented Oct 7, 2024

Uh oh!

franciscoaguirre commented Oct 7, 2024

Uh oh!

command-bot bot commented Oct 7, 2024 •

edited

Loading

Uh oh!

command-bot bot commented Oct 7, 2024

Uh oh!

bkontur Oct 15, 2024

Uh oh!

bkontur Oct 16, 2024

Uh oh!

bkontur Oct 16, 2024

Uh oh!

acatangiu Oct 17, 2024

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

franciscoaguirre commented Aug 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

TODO

Uh oh!

franciscoaguirre commented Aug 27, 2024

Uh oh!

franciscoaguirre commented Oct 7, 2024

Uh oh!

command-bot bot commented Oct 7, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

command-bot bot commented Oct 7, 2024

Uh oh!

franciscoaguirre commented Oct 7, 2024

Uh oh!

command-bot bot commented Oct 7, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

command-bot bot commented Oct 7, 2024

Uh oh!

bkontur Oct 15, 2024

Choose a reason for hiding this comment

Uh oh!

bkontur Oct 16, 2024

Choose a reason for hiding this comment

Uh oh!

bkontur Oct 16, 2024

Choose a reason for hiding this comment

Uh oh!

acatangiu Oct 17, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

franciscoaguirre commented Aug 20, 2024 •

edited

Loading

command-bot bot commented Oct 7, 2024 •

edited

Loading

command-bot bot commented Oct 7, 2024 •

edited

Loading