Add support for versioned notification for HRMP pallet #4281

bkontur · 2024-04-25T09:11:48Z

Closes: #4003 (please see for the problem description)

TODO

add more tests covering WrapVersion corner cases (e.g. para has lower version, ...)
regenerate benchmarks runtime_parachains::hrmp (fix for Rococo is here: HRMP - set DefaultChannelSizeAndCapacityWithSystem with dynamic values according to the ActiveConfig #4332)

Questions / possible improvements

A WrapVersion implementation for pallet_xcm initiates version discovery with note_unknown_version, there is possibility to avoid this overhead in this HRMP case to create new WrapVersion adapter for pallet_xcm which would not use note_unknown_version. Is it worth to do it or not?

There's a possibility to decouple XCM functionality from the HRMP pallet, allowing any relay chain to generate its own notifications. This approach wouldn't restrict notifications solely to the XCM. However, it's uncertain whether it's worthwhile or desirable to do so? It means making HRMP pallet more generic. E.g. hiding HRMP notifications behind some trait:

 trait HrmpNotifications {

 	fn on_channel_open_request(
 		sender: ParaId,
 		proposed_max_capacity: u32,
 		proposed_max_message_size: u32) -> primitives::DownwardMessage;

 	fn on_channel_accepted(recipient: ParaId) -> primitives::DownwardMessage;

 	fn on_channel_closing(initiator: ParaId, sender: ParaId, recipient: ParaId) -> primitives::DownwardMessage;
 }

and then we could have whatever adapter, impl HrmpNotifications for VersionedXcmHrmpNotifications {...},

 impl parachains_hrmp::Config for Runtime {
 ..
 	type HrmpNotifications = VersionedXcmHrmpNotifications;
 ..
 }

…ks` covering non-lastest XCM version scenario

…rsion-4003

…nto bko-hrmp-fix-xcm-version-4003

bkontur · 2024-04-29T08:02:06Z

bot help

bkontur · 2024-04-29T08:03:19Z

bot bench polkadot-pallet --runtime=rococo --pallet=runtime_parachains::hrmp
bot bench polkadot-pallet --runtime=westend --pallet=runtime_parachains::hrmp

…=westend --target_dir=polkadot --pallet=runtime_parachains::hrmp

bkontur · 2024-04-29T08:50:45Z

bot bench polkadot-pallet --runtime=rococo --pallet=runtime_parachains::hrmp

bkontur · 2024-04-29T11:32:38Z

bot clean

…rsion-4003

bkontur · 2024-05-01T21:46:43Z

bot bench polkadot-pallet --runtime=rococo --pallet=runtime_parachains::hrmp
bot bench polkadot-pallet --runtime=westend --pallet=runtime_parachains::hrmp

command-bot · 2024-05-01T21:46:48Z

@bkontur https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/6106217 was started for your command "$PIPELINE_SCRIPTS_DIR/commands/bench/bench.sh" --subcommand=pallet --runtime=rococo --target_dir=polkadot --pallet=runtime_parachains::hrmp. 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 5-6e0df268-bf72-4b9f-b749-942009368634 to cancel this command or bot cancel to cancel all commands in this pull request.

command-bot · 2024-05-01T21:46:52Z

@bkontur https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/6106218 was started for your command "$PIPELINE_SCRIPTS_DIR/commands/bench/bench.sh" --subcommand=pallet --runtime=westend --target_dir=polkadot --pallet=runtime_parachains::hrmp. 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 6-9b096c89-e1f6-4a2c-8a68-ff505215facb to cancel this command or bot cancel to cancel all commands in this pull request.

paritytech-cicd-pr · 2024-05-01T22:07:33Z

The CI pipeline was cancelled due to failure one of the required jobs.
Job name: test-linux-stable 2/3
Logs: https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/6106085

…=rococo --target_dir=polkadot --pallet=runtime_parachains::hrmp

command-bot · 2024-05-01T22:29:27Z

@bkontur Command "$PIPELINE_SCRIPTS_DIR/commands/bench/bench.sh" --subcommand=pallet --runtime=rococo --target_dir=polkadot --pallet=runtime_parachains::hrmp has finished. Result: https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/6106217 has finished. If any artifacts were generated, you can download them from https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/6106217/artifacts/download.

…=westend --target_dir=polkadot --pallet=runtime_parachains::hrmp

command-bot · 2024-05-01T22:31:21Z

@bkontur Command "$PIPELINE_SCRIPTS_DIR/commands/bench/bench.sh" --subcommand=pallet --runtime=westend --target_dir=polkadot --pallet=runtime_parachains::hrmp has finished. Result: https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/6106218 has finished. If any artifacts were generated, you can download them from https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/6106218/artifacts/download.

polkadot/runtime/parachains/src/hrmp.rs

prdoc/pr_4281.prdoc

franciscoaguirre · 2024-05-03T08:55:06Z

prdoc/pr_4281.prdoc

+      which controls the encoding of XCM notifications related to the opening/closing of HRMP channels.
+      If your runtime does not concern itself with the XCM version used for notifications,
+      you can set it as `type VersionWrapper = ()` to always use the latest XCM.
+      If your runtime does care about the XCM version when sending to child parachains,


So if your runtime is a parachain you just put (), right?
What does it mean to concern oneself about versions? Is it allowing older versions of XCM?

So if your runtime is a parachain you just put (), right?

The HRMP pallet is dedicated to relay chain runtimes, I don't think that any parachain runtime uses this HRMP pallet.

What does it mean to concern oneself about versions? Is it allowing older versions of XCM?

The problem could arise from a higher version on the relay chain than on the receiving parachain. For example, imagine that we update Polkadot with xcm::v5, but Polimec still uses xcm::v4. Without this fix, they could lose messages because they would not be able to decode xcm::v5.

Perhaps it could be possible to replace most of the functionality related to the WrapVersion with just the SendXcm trait. In this scenario, the HRMP pallet would use type XcmSender = ChildParachainRouter, potentially simplifying things. However, this approach would introduce another layer of complexity, particularly regarding handling transport fees. Nevertheless, I think these HRMP notifications are treated as system notifications, which is why they are sent directly by dmp::Pallet::<T>::queue_downward_message.

Co-authored-by: Bastian Köcher <git@kchr.de>

…rsion-4003

Closes: paritytech#4003 (please see for the problem description) ## TODO - [x] add more tests covering `WrapVersion` corner cases (e.g. para has lower version, ...) - [x] regenerate benchmarks `runtime_parachains::hrmp` (fix for Rococo is here: paritytech#4332) ## Questions / possible improvements - [ ] A `WrapVersion` implementation for `pallet_xcm` initiates version discovery with [note_unknown_version](https://github.com/paritytech/polkadot-sdk/blob/master/polkadot/xcm/pallet-xcm/src/lib.rs#L2527C5-L2527C25), there is possibility to avoid this overhead in this HRMP case to create new `WrapVersion` adapter for `pallet_xcm` which would not use `note_unknown_version`. Is it worth to do it or not? - [ ] There's a possibility to decouple XCM functionality from the HRMP pallet, allowing any relay chain to generate its own notifications. This approach wouldn't restrict notifications solely to the XCM. However, it's uncertain whether it's worthwhile or desirable to do so? It means making HRMP pallet more generic. E.g. hiding HRMP notifications behind some trait: ``` trait HrmpNotifications { fn on_channel_open_request( sender: ParaId, proposed_max_capacity: u32, proposed_max_message_size: u32) -> primitives::DownwardMessage; fn on_channel_accepted(recipient: ParaId) -> primitives::DownwardMessage; fn on_channel_closing(initiator: ParaId, sender: ParaId, recipient: ParaId) -> primitives::DownwardMessage; } ``` and then we could have whatever adapter, `impl HrmpNotifications for VersionedXcmHrmpNotifications {...}`, ``` impl parachains_hrmp::Config for Runtime { .. type HrmpNotifications = VersionedXcmHrmpNotifications; .. } ``` --------- Co-authored-by: command-bot <> Co-authored-by: Bastian Köcher <git@kchr.de>

Add support for versioned notification for HRMP pallet

5eaae32

bkontur added the T6-XCM This PR/Issue is related to XCM. label Apr 25, 2024

bkontur self-assigned this Apr 25, 2024

bkontur added 3 commits April 25, 2024 16:09

Add WrapVersion support

6e0fc99

Set VersionWrapper for testnet relaychains

d20d2d0

doc

2487e3d

bkontur marked this pull request as ready for review April 25, 2024 14:42

bkontur added 7 commits April 25, 2024 16:43

Merge branch 'master' into bko-hrmp-fix-xcm-version-4003

1dee14d

Removed unused FirstMessageFactorPercent

7446dbe

Added hrmp_notifications_works

3e9ce22

Adding TestUsesOnlyStoredVersionWrapper for `hrmp_notifications_wor…

28d4f70

…ks` covering non-lastest XCM version scenario

Merge remote-tracking branch 'origin/master' into bko-hrmp-fix-xcm-ve…

eff2d51

…rsion-4003

Merge branch 'master' into bko-hrmp-fix-xcm-version-4003

3b316b4

Merge remote-tracking branch 'origin/bko-hrmp-fix-xcm-version-4003' i…

4b1f2fb

…nto bko-hrmp-fix-xcm-version-4003

bkontur requested a review from a team as a code owner April 29, 2024 08:01

bkontur and others added 3 commits April 29, 2024 10:13

prdoc

1e1f1a0

clippy

fa96674

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

7ee3af4

…=westend --target_dir=polkadot --pallet=runtime_parachains::hrmp

bkontur added 2 commits April 30, 2024 13:29

Merge remote-tracking branch 'origin/master' into bko-hrmp-fix-xcm-ve…

ecb8f19

…rsion-4003

Merge remote-tracking branch 'origin/master' into bko-hrmp-fix-xcm-ve…

64818e5

…rsion-4003

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

d0a55e7

…=rococo --target_dir=polkadot --pallet=runtime_parachains::hrmp

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

c30d2b3

…=westend --target_dir=polkadot --pallet=runtime_parachains::hrmp

bkchr approved these changes May 2, 2024

View reviewed changes

bkchr requested a review from franciscoaguirre May 2, 2024 20:35

bkchr reviewed May 2, 2024

View reviewed changes

prdoc/pr_4281.prdoc Outdated Show resolved Hide resolved

acatangiu approved these changes May 3, 2024

View reviewed changes

franciscoaguirre approved these changes May 3, 2024

View reviewed changes

bkontur and others added 6 commits May 6, 2024 08:39

Update polkadot/runtime/parachains/src/hrmp.rs

26db837

Co-authored-by: Bastian Köcher <git@kchr.de>

Update polkadot/runtime/parachains/src/hrmp.rs

d684ebe

Co-authored-by: Bastian Köcher <git@kchr.de>

Update polkadot/runtime/parachains/src/hrmp.rs

9cefcb9

Co-authored-by: Bastian Köcher <git@kchr.de>

Update prdoc/pr_4281.prdoc

f8e7130

Co-authored-by: Bastian Köcher <git@kchr.de>

Merge remote-tracking branch 'origin/master' into bko-hrmp-fix-xcm-ve…

00368c9

…rsion-4003

updated docs

d863756

bkontur enabled auto-merge May 6, 2024 07:30

Merge branch 'master' into bko-hrmp-fix-xcm-version-4003

837225e

bkontur added this pull request to the merge queue May 7, 2024

Merged via the queue into master with commit b709dcc May 7, 2024
144 of 147 checks passed

bkontur deleted the bko-hrmp-fix-xcm-version-4003 branch May 7, 2024 08:55

This was referenced Aug 21, 2024

Update polkadot-sdk from v1.11.0 to stable2407 moondance-labs/tanssi#659

Open

Update polkadot-sdk from v1.11.0 to stable2407 moonbeam-foundation/moonbeam#2912

Closed

This was referenced Oct 4, 2024

feat: ⏫ upgrade to Polkadot SDK v1.13.0 Moonsong-Labs/storage-hub#214

Closed

feat: ⏫ upgrade to Polkadot SDK v1.13.0 Moonsong-Labs/storage-hub#216

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for versioned notification for HRMP pallet #4281

Add support for versioned notification for HRMP pallet #4281

bkontur commented Apr 25, 2024 •

edited

Loading

bkontur commented Apr 29, 2024

bkontur commented Apr 29, 2024

bkontur commented Apr 29, 2024

bkontur commented Apr 29, 2024

bkontur commented May 1, 2024

command-bot bot commented May 1, 2024 •

edited

Loading

command-bot bot commented May 1, 2024 •

edited

Loading

paritytech-cicd-pr commented May 1, 2024

command-bot bot commented May 1, 2024

command-bot bot commented May 1, 2024

franciscoaguirre May 3, 2024

bkontur May 6, 2024

bkontur May 6, 2024

Add support for versioned notification for HRMP pallet #4281

Add support for versioned notification for HRMP pallet #4281

Conversation

bkontur commented Apr 25, 2024 • edited Loading

TODO

Questions / possible improvements

bkontur commented Apr 29, 2024

bkontur commented Apr 29, 2024

bkontur commented Apr 29, 2024

bkontur commented Apr 29, 2024

bkontur commented May 1, 2024

command-bot bot commented May 1, 2024 • edited Loading

command-bot bot commented May 1, 2024 • edited Loading

paritytech-cicd-pr commented May 1, 2024

command-bot bot commented May 1, 2024

command-bot bot commented May 1, 2024

franciscoaguirre May 3, 2024

Choose a reason for hiding this comment

bkontur May 6, 2024

Choose a reason for hiding this comment

bkontur May 6, 2024

Choose a reason for hiding this comment

bkontur commented Apr 25, 2024 •

edited

Loading

command-bot bot commented May 1, 2024 •

edited

Loading

command-bot bot commented May 1, 2024 •

edited

Loading