mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-04-28 07:27:55 +00:00
Shawn Tabrizi
4875ea11ae
This PR does a "developer experience" refactor of the XCM Simulator
Example.
I was looking for existing code / documentation where developers could
better learn about working with and configuring XCM.
The XCM Simulator was a natural starting point due to the fact that it
can emulate end to end XCM scenarios, without needing to spawn multiple
real chains.
However, the XCM Simulator Example was just 3 giant files with a ton of
configurations, runtime, pallets, and tests mashed together.
This PR breaks down the XCM Simulator Example in a way that I believe is
more approachable by a new developer who is looking to navigate the
various components of the end to end example, and modify it themselves.
The basic structure is:
- xcm simulator example
- lib (tries to only use the xcm simulator macros)
- tests
- relay-chain
- mod (basic runtime that developers should be familiar with)
- xcm-config
- mod (contains the `XcmConfig` type
- various files for each custom configuration
- parachain
- mock_msg_queue (custom pallet for simulator example)
- mod (basic runtime that developers should be familiar with)
- xcm-config
- mod (contains the `XcmConfig` type
- various files for each custom configuration
I would like to add more documentation to this too, but I think this is
a first step to be accepted which will affect how documentation is added
to the example
---------
Co-authored-by: Francisco Aguirre <franciscoaguirreperez@gmail.com>
Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com>
12 lines
519 B
Plaintext
12 lines
519 B
Plaintext
# Schema: Polkadot SDK PRDoc Schema (prdoc) v1.0.0
|
|
# See doc at https://raw.githubusercontent.com/paritytech/polkadot-sdk/master/prdoc/schema_user.json
|
|
|
|
title: Refactor XCM Simulator Example
|
|
|
|
doc:
|
|
- audience: Runtime Dev
|
|
description: |
|
|
This PR refactors the XCM Simulator Example to improve developer experience when trying to read and understand the example. 3 monolithic files have been broken down into their respective components across various modules. No major logical changes were made.
|
|
|
|
crates: [ ]
|