Skip to content
This repository has been archived by the owner on Nov 15, 2023. It is now read-only.

Xcm-Simulator Docs #6178

Merged
merged 7 commits into from
Nov 3, 2022
Merged

Xcm-Simulator Docs #6178

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
7994803
Xcm-Simulator Docs
Szegoo Oct 22, 2022
0bb6b5d
Merge branch 'paritytech:master' into xcm-sim-docs
Szegoo Oct 22, 2022
771dbae
spelling
Szegoo Oct 22, 2022
8806630
examples
Szegoo Oct 22, 2022
7304c71
better docs
Szegoo Oct 24, 2022
9fa1bb4
Merge remote-tracking branch 'origin/master' into xcm-sim-docs
Oct 25, 2022
c3ffecb
Merge branch 'paritytech:master' into xcm-sim-docs
Szegoo Oct 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
better docs
  • Loading branch information
@Szegoo
Szegoo committed Oct 24, 2022
commit 7304c711a3934e96bb9fedfa3f7a539b4d1a9dab
59 changes: 30 additions & 29 deletions xcm/xcm-simulator/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,17 +77,17 @@ pub fn encode_xcm(message: Xcm<()>, message_kind: MessageKind) -> Vec<u8> {
}
}

/// Expects a relay chain struct as an argument and implements UMP for it. The
/// provided struct needs to have the `Runtime` and `XcmConfig` defined. Also
/// expects the `TestExternalities` to be provided in the relay chain struct.
/// The macro is implementing upward message passing(UMP) for the provided relay
/// chain struct. The struct has to provide the XCM configuration for the relay
/// chain.
///
/// ```ignore
/// decl_test_relay_chain! {
/// pub struct Relay {
/// Runtime = relay_chain::Runtime,
/// XcmConfig = relay_chain::XcmConfig,
/// new_ext = relay_ext(),
/// }
/// pub struct Relay {
/// Runtime = relay_chain::Runtime,
/// XcmConfig = relay_chain::XcmConfig,
/// new_ext = relay_ext(),
/// }
/// }
/// ```
#[macro_export]
Expand Down Expand Up @@ -122,19 +122,19 @@ macro_rules! decl_test_relay_chain {
};
}

/// Expects a parachain struct as an argument and implements`DmpMessageHandlerT`
/// and `XcmpMessageHandlerT` traits for it. The macro expects the provided struct
/// to define `Runtime`, `DmpMessageHandler` and `XcmpMessageHandler`. Also expects
/// the `TestExternalities` to be provided in the relay chain struct.
/// The macro is implementing the `XcmMessageHandlerT` and `DmpMessageHandlerT`
/// traits for the provided parachain struct. Expects the provided parachain
/// struct to define the XcmpMessageHandler and DmpMessageHandler pallets that
/// contain the message handling logic.
///
/// ```ignore
/// decl_test_parachain! {
/// pub struct ParaA {
/// Runtime = parachain::Runtime,
/// XcmpMessageHandler = parachain::MsgQueue,
/// DmpMessageHandler = parachain::MsgQueue,
/// new_ext = para_ext(),
/// }
/// pub struct ParaA {
/// Runtime = parachain::Runtime,
/// XcmpMessageHandler = parachain::MsgQueue,
/// DmpMessageHandler = parachain::MsgQueue,
/// new_ext = para_ext(),
/// }
/// }
/// ```
#[macro_export]
Expand Down Expand Up @@ -232,20 +232,21 @@ thread_local! {
= RefCell::new(VecDeque::new());
}

/// Declares a test network. Expects a network struct as an argument and
/// implements some functionality for testing and the `ParachainXcmRouter` and
/// `RelayChainXcmRouter`. The struct needs to contain the relay chain struct
/// and an indexed list of parachains that are going to be in the network.
/// Declares a test network that consists of a relay chain and multiple
/// parachains. Expects a network struct as an argument and implements testing
/// functionality, `ParachainXcmRouter` and the `RelayChainXcmRouter`. The
/// struct needs to contain the relay chain struct and an indexed list of
/// parachains that are going to be in the network.
///
/// ```ignore
/// decl_test_network! {
/// pub struct ExampleNet {
/// relay_chain = Relay,
/// parachains = vec![
/// (1, ParaA),
/// (2, ParaB),
/// ],
/// }
/// pub struct ExampleNet {
/// relay_chain = Relay,
/// parachains = vec![
/// (1, ParaA),
/// (2, ParaB),
/// ],
/// }
/// }
/// ```
#[macro_export]
Expand Down