Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor Develop -> Interoperabiity -> Testing and Debugging #339

Merged
merged 4 commits into from
Feb 5, 2025

Conversation

0xLucca
Copy link
Collaborator

@0xLucca 0xLucca commented Jan 29, 2025

Refactor XCM Testing and Debugging page and remove XCM Simulator

@0xLucca 0xLucca requested a review from a team as a code owner January 29, 2025 14:11
@0xLucca 0xLucca added B0 - Needs Review Pull request is ready for review C1 - Medium Medium priority task A2 - Maintenance Minor Pull request contains minor updates to an existing page (i.e., modifying parameters, steps, etc.) labels Jan 29, 2025
@0xLucca 0xLucca requested a review from nhussein11 January 29, 2025 14:11
develop/interoperability/test-and-debug.md Outdated Show resolved Hide resolved
develop/interoperability/test-and-debug.md Outdated Show resolved Hide resolved
develop/interoperability/test-and-debug.md Outdated Show resolved Hide resolved
develop/interoperability/test-and-debug.md Show resolved Hide resolved
@@ -9,22 +9,36 @@ description: Learn how to test and debug cross-chain communication via the XCM S

Cross-Consensus Messaging (XCM) is a core feature of the Polkadot ecosystem, enabling communication between parachains, relay chains, and system chains. To ensure the reliability of XCM-powered blockchains, thorough testing and debugging are essential before production deployment.

This article explores two indispensable tools for XCM testing, the [XCM Simulator](#xcm-simulator) and the [XCM Emulator](#xcm-emulator), to help developers onboard and test their solutions effectively.
This guide focuses on the XCM Emulator, a tool designed to help developers onboard and test their solutions effectively. For additional XCM testing capabilities, you can also use [Chopsticks](/tutorials/polkadot-sdk/testing/fork-live-chains/#xcm-testing){target=\_blank}.
Copy link
Contributor

Choose a reason for hiding this comment

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

I would point them first to chopsticks for testing and debugging and tell them how to do both.
I would mention how to use setupNetworks from @acala-network/chopsticks-testing to write automatic tests like in https://github.com/franciscoaguirre/dot-reserve-change/blob/2b678660aa9c5c10c51ec7c58cd872dd224d067b/setup.ts#L31.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This is really useful and the way to go. For the context of this PR, it is better to update the XCM emulator docs and create an issue to add chopsticks xcm testing docs later. We already have some documentation on Chopsticks, so we need to reorganize the informational architecture to include these changes seamlessly.

Once we have the IA done, we can iterate over this again

develop/interoperability/test-and-debug.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@nhussein11 nhussein11 left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link
Collaborator

@eshaben eshaben left a comment

Choose a reason for hiding this comment

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

Sweet. From a formatting standpoint, it looks good, just one minor thing!

develop/interoperability/test-and-debug.md Outdated Show resolved Hide resolved
@0xLucca 0xLucca requested a review from eshaben February 4, 2025 11:36
Copy link
Collaborator

@eshaben eshaben left a comment

Choose a reason for hiding this comment

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

LGTM

@0xLucca 0xLucca added B1 - Ready to Merge Pull request is ready to be merged and removed B0 - Needs Review Pull request is ready for review labels Feb 4, 2025
@eshaben eshaben merged commit 7f64f2a into master Feb 5, 2025
1 check passed
@eshaben eshaben deleted the 0xlucca/refactor-xcm-debugging branch February 5, 2025 01:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A2 - Maintenance Minor Pull request contains minor updates to an existing page (i.e., modifying parameters, steps, etc.) B1 - Ready to Merge Pull request is ready to be merged C1 - Medium Medium priority task
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants