Refactor XCM Simulator Example (#4220)
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>
Showing
- polkadot/xcm/xcm-simulator/example/src/lib.rs 9 additions, 520 deletionspolkadot/xcm/xcm-simulator/example/src/lib.rs
- polkadot/xcm/xcm-simulator/example/src/parachain/mock_msg_queue.rs 185 additions, 0 deletions...xcm/xcm-simulator/example/src/parachain/mock_msg_queue.rs
- polkadot/xcm/xcm-simulator/example/src/parachain/mod.rs 182 additions, 0 deletionspolkadot/xcm/xcm-simulator/example/src/parachain/mod.rs
- polkadot/xcm/xcm-simulator/example/src/parachain/xcm_config/asset_transactor.rs 39 additions, 0 deletions...ator/example/src/parachain/xcm_config/asset_transactor.rs
- polkadot/xcm/xcm-simulator/example/src/parachain/xcm_config/barrier.rs 20 additions, 0 deletions...xcm-simulator/example/src/parachain/xcm_config/barrier.rs
- polkadot/xcm/xcm-simulator/example/src/parachain/xcm_config/constants.rs 30 additions, 0 deletions...m-simulator/example/src/parachain/xcm_config/constants.rs
- polkadot/xcm/xcm-simulator/example/src/parachain/xcm_config/location_converter.rs 25 additions, 0 deletions...or/example/src/parachain/xcm_config/location_converter.rs
- polkadot/xcm/xcm-simulator/example/src/parachain/xcm_config/mod.rs 63 additions, 0 deletions...xcm/xcm-simulator/example/src/parachain/xcm_config/mod.rs
- polkadot/xcm/xcm-simulator/example/src/parachain/xcm_config/origin_converter.rs 29 additions, 0 deletions...ator/example/src/parachain/xcm_config/origin_converter.rs
- polkadot/xcm/xcm-simulator/example/src/parachain/xcm_config/reserve.rs 21 additions, 0 deletions...xcm-simulator/example/src/parachain/xcm_config/reserve.rs
- polkadot/xcm/xcm-simulator/example/src/parachain/xcm_config/teleporter.rs 27 additions, 0 deletions...-simulator/example/src/parachain/xcm_config/teleporter.rs
- polkadot/xcm/xcm-simulator/example/src/parachain/xcm_config/weigher.rs 27 additions, 0 deletions...xcm-simulator/example/src/parachain/xcm_config/weigher.rs
- polkadot/xcm/xcm-simulator/example/src/relay_chain/mod.rs 17 additions, 128 deletionspolkadot/xcm/xcm-simulator/example/src/relay_chain/mod.rs
- polkadot/xcm/xcm-simulator/example/src/relay_chain/xcm_config/asset_transactor.rs 38 additions, 0 deletions...or/example/src/relay_chain/xcm_config/asset_transactor.rs
- polkadot/xcm/xcm-simulator/example/src/relay_chain/xcm_config/barrier.rs 20 additions, 0 deletions...m-simulator/example/src/relay_chain/xcm_config/barrier.rs
- polkadot/xcm/xcm-simulator/example/src/relay_chain/xcm_config/constants.rs 31 additions, 0 deletions...simulator/example/src/relay_chain/xcm_config/constants.rs
- polkadot/xcm/xcm-simulator/example/src/relay_chain/xcm_config/location_converter.rs 25 additions, 0 deletions.../example/src/relay_chain/xcm_config/location_converter.rs
- polkadot/xcm/xcm-simulator/example/src/relay_chain/xcm_config/mod.rs 62 additions, 0 deletions...m/xcm-simulator/example/src/relay_chain/xcm_config/mod.rs
- polkadot/xcm/xcm-simulator/example/src/relay_chain/xcm_config/origin_converter.rs 34 additions, 0 deletions...or/example/src/relay_chain/xcm_config/origin_converter.rs
- polkadot/xcm/xcm-simulator/example/src/relay_chain/xcm_config/weigher.rs 27 additions, 0 deletions...m-simulator/example/src/relay_chain/xcm_config/weigher.rs
Please register or sign in to comment