Storage migration for pallet-xcm SafeXcmVersion constant #2422

mattheworris · 2025-05-29T21:38:40Z

This pull request introduces several changes to support bridging functionality. Key updates include adding new features for bridging pallets, extending Makefile targets for bridging-related builds and checks, and updating documentation and configuration files to reflect these additions.

Discussion

Implemented pallet_xcm::on_runtime_upgrade and tests to correctly set SafeXcmVersion.
Introduced new Makefile targets for bridging builds, checks, and runtime migrations (build-bridging-westend, check-bridging, try-runtime-check-migrations-westend-testnet, etc.).

Closes #2401

Testing

Unit tests will check the storage migrations.

Run make start-bridging-westend-local in a terminal.
In another terminal, run make try-rumtime-check-migrations-local (pre and post checks) or make try-runtime-check-migrations-none-local (checks=none).

Checklist

## Summary - add SAFE_XCM_VERSION constant for bridging - migrate pallet-xcm SafeXcmVersion during runtime upgrade - add tests for pre and post upgrade - bump spec_version

mattheworris · 2025-05-29T21:40:51Z

AGENTS.md

This file is useful for testing with OpenAI's Codex, which is enabled as a research preview.

mattheworris · 2025-05-29T21:42:09Z

Makefile

@@ -373,6 +373,14 @@ check-try-runtime-installed:
 try-runtime-create-snapshot-paseo-testnet: check-try-runtime-installed
 	try-runtime create-snapshot --uri wss://0.rpc.testnet.amplica.io:443 testnet-paseo-all-pallets.state

+try-runtime-create-snapshot-westend-testnet: check-try-runtime-installed


If we change the RPC to not include the API key, then we can remove this check. Otherwise, being cautious and not checking in API keys.

mattheworris · 2025-05-29T21:48:42Z

runtime/common/src/constants.rs

+
+// --- XCM Version ---
+#[cfg(feature = "frequency-bridging")]
+pub mod xcm_version {
+	/// The default XCM version considered safe for the network.
+	/// This is not the latest version, but the one that is considered stable and safe to use.
+	/// It is used to ensure that the network can handle XCM messages without issues.
+	pub const SAFE_XCM_VERSION: u32 = 4;
+}


This can probably be moved to an xcm commmon or other, but don't want to step on other refactoring coming in soon.

mattheworris · 2025-05-29T21:51:58Z

runtime/frequency/src/xcm/tests/mock.rs

@@ -17,6 +17,7 @@
 //! Mock runtime for tests.
 //! Implements both runtime APIs for fee estimation and getting the messages for transfers.

+use common_runtime::weights::rocksdb_weights::constants::RocksDbWeight;


Updating for migration tests, which were returning 0 weight in all cases.

mattheworris · 2025-05-29T21:55:11Z

runtime/frequency/src/migration_tests.rs

@@ -0,0 +1,93 @@
+use super::*;
+use crate::xcm::tests::mock::{new_test_ext_with_balances, TestRuntime};


This mock runtime is enough to test storage migration for the SafeXcmVersion constant.

codecov · 2025-05-29T22:18:55Z

Codecov Report

All modified and coverable lines are covered by tests ✅

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

…ture

Copilot

Pull Request Overview

Adds a storage migration to initialize the XCM pallet’s SafeXcmVersion and wires it into the runtime, along with tests and updated build targets for bridging.

Implements SetSafeXcmVersion migration and accompanying pre_upgrade/post_upgrade tests.
Introduces a new SAFE_XCM_VERSION constant and bumps the runtime spec versions.
Extends the Makefile with bridging and try-runtime targets, and adjusts startup scripts and test module visibility.

Reviewed Changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
scripts/init.sh	Removed the `--dev` flag when starting `frequency` for bridging
runtime/frequency/src/xcm/tests/mod.rs	Made the `mock` module public so it can be reused in new tests
runtime/frequency/src/xcm/tests/mock.rs	Added `RocksDbWeight` import and set `DbWeight` for `TestRuntime`
runtime/frequency/src/migration_tests.rs	New try-runtime migration tests for `SafeXcmVersion`
runtime/frequency/src/lib.rs	Added `SetSafeXcmVersion` migration, updated `Executive`, bumped spec versions
runtime/common/src/constants.rs	Defined `SAFE_XCM_VERSION` constant under `frequency-bridging`
Makefile	Added bridging/try-runtime targets and `--blocktime` flags
AGENTS.md	New contributor guidelines document

Comments suppressed due to low confidence (1)

scripts/init.sh:189

The --dev flag was removed, which may change the chain spec used by the node startup—re-add --dev (or the intended --chain argument) to ensure the local development environment is launched correctly.

./target/debug/frequency \

Copilot · 2025-05-30T17:53:09Z

runtime/frequency/src/xcm/tests/mock.rs

@@ -17,6 +17,7 @@
 //! Mock runtime for tests.
 //! Implements both runtime APIs for fee estimation and getting the messages for transfers.

+use common_runtime::weights::rocksdb_weights::constants::RocksDbWeight;


[nitpick] Importing and using production RocksDbWeight in tests may tie test behavior to real database weights; consider defining a lightweight or stub weight implementation to keep tests deterministic and performant.

Copilot · 2025-05-30T17:53:09Z

Makefile

+		echo "Example: ONFINALITY_APIKEY=your-api-key-here make try-runtime-check-migrations-westend-testnet"; \
+		exit 1; \
+	fi
+	try-runtime create-snapshot --uri wss://node-7330371704012918784.nv.onfinality.io/ws?apikey=$(ONFINALITY_APIKEY) testnet-paseo-all-pallets.state


The snapshot filename testnet-paseo-all-pallets.state appears to be for the Paseo network, not Westend; update it to the appropriate Westend state filename or URI to avoid confusion and ensure correct snapshot usage.

Suggested change

try-runtime create-snapshot --uri wss://node-7330371704012918784.nv.onfinality.io/ws?apikey=$(ONFINALITY_APIKEY) testnet-paseo-all-pallets.state

try-runtime create-snapshot --uri wss://node-7330371704012918784.nv.onfinality.io/ws?apikey=$(ONFINALITY_APIKEY) westend-testnet-all-pallets.state

enddynayn

👍 great!

…chain/frequency into 2401-bridge-storage-migration-needed-for-any-xcm-related-pallet-constants

mattheworris added 4 commits May 27, 2025 16:52

feat: add agent guidelines for contributing to the project

4799abb

fix: correct e2e test command in agent guidelines

67a8195

fix: update testing instructions for setup and build process

a84832c

Add safe xcm version migration (#2418)

23fe781

## Summary - add SAFE_XCM_VERSION constant for bridging - migrate pallet-xcm SafeXcmVersion during runtime upgrade - add tests for pre and post upgrade - bump spec_version

mattheworris self-assigned this May 29, 2025

mattheworris added this to the Bridge milestone May 29, 2025

mattheworris commented May 29, 2025

View reviewed changes

AGENTS.md Outdated

Copy link

Collaborator Author

mattheworris May 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file is useful for testing with OpenAI's Codex, which is enabled as a research preview.

mattheworris commented May 29, 2025

View reviewed changes

mattheworris added 2 commits May 29, 2025 16:01

fix: update migration tests

53de125

fix: replace XCM_VERSION with SAFE_XCM_VERSION in migration tests

7d99c7f

mattheworris added 2 commits May 30, 2025 08:24

fix: format/linter; Makefile updates for try-runtime

baf3fbc

fix: update .gitignore and migration tests for frequency-bridging fea…

d00ba6c

…ture

github-actions bot added metadata-changed Metadata has changed since the latest full release metadata-version-not-incremented Metadata has changed since the latest full release, but the version has not been incremented labels May 30, 2025

fix: spec bump

caf456c

github-actions bot removed metadata-changed Metadata has changed since the latest full release metadata-version-not-incremented Metadata has changed since the latest full release, but the version has not been incremented labels May 30, 2025

mattheworris requested review from enddynayn and Copilot May 30, 2025 17:51

mattheworris marked this pull request as ready for review May 30, 2025 17:51

mattheworris requested a review from wilwade as a code owner May 30, 2025 17:51

Copilot AI reviewed May 30, 2025

View reviewed changes

github-actions bot added the metadata-changed Metadata has changed since the latest full release label May 30, 2025

enddynayn approved these changes May 30, 2025

View reviewed changes

mattheworris added 2 commits June 2, 2025 08:03

Merge branch 'feat/eth-bridging-development' of github.com:frequency-…

dffbf3b

…chain/frequency into 2401-bridge-storage-migration-needed-for-any-xcm-related-pallet-constants

fix: update rust-analyzer configuration to ensure proper sandboxing

46a9483

github-actions bot removed the metadata-changed Metadata has changed since the latest full release label Jun 2, 2025

mattheworris merged commit be6fce7 into feat/eth-bridging-development Jun 2, 2025
15 of 20 checks passed

mattheworris deleted the 2401-bridge-storage-migration-needed-for-any-xcm-related-pallet-constants branch June 2, 2025 14:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Storage migration for pallet-xcm SafeXcmVersion constant #2422

Storage migration for pallet-xcm SafeXcmVersion constant #2422

Uh oh!

mattheworris commented May 29, 2025 •

edited

Loading

Uh oh!

mattheworris May 29, 2025

Uh oh!

mattheworris May 29, 2025

Uh oh!

mattheworris May 29, 2025

Uh oh!

mattheworris May 29, 2025

Uh oh!

mattheworris May 29, 2025

Uh oh!

codecov bot commented May 29, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI May 30, 2025

Uh oh!

Copilot AI May 30, 2025

Uh oh!

enddynayn left a comment

Uh oh!

Uh oh!

Uh oh!

		@@ -0,0 +1,93 @@
		use super::*;
		use crate::xcm::tests::mock::{new_test_ext_with_balances, TestRuntime};

	try-runtime create-snapshot --uri wss://node-7330371704012918784.nv.onfinality.io/ws?apikey=$(ONFINALITY_APIKEY) testnet-paseo-all-pallets.state
	try-runtime create-snapshot --uri wss://node-7330371704012918784.nv.onfinality.io/ws?apikey=$(ONFINALITY_APIKEY) westend-testnet-all-pallets.state

Storage migration for pallet-xcm SafeXcmVersion constant #2422

Storage migration for pallet-xcm SafeXcmVersion constant #2422

Uh oh!

Conversation

mattheworris commented May 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Discussion

Testing

Checklist

Uh oh!

mattheworris May 29, 2025

Choose a reason for hiding this comment

Uh oh!

mattheworris May 29, 2025

Choose a reason for hiding this comment

Uh oh!

mattheworris May 29, 2025

Choose a reason for hiding this comment

Uh oh!

mattheworris May 29, 2025

Choose a reason for hiding this comment

Uh oh!

mattheworris May 29, 2025

Choose a reason for hiding this comment

Uh oh!

codecov bot commented May 29, 2025

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI May 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI May 30, 2025

Choose a reason for hiding this comment

Uh oh!

enddynayn left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

mattheworris commented May 29, 2025 •

edited

Loading