From f8ce439f76903a3cfc098565a97cb726d89f24a6 Mon Sep 17 00:00:00 2001
From: l0r1s <contact@lorismoulin.com>
Date: Mon, 3 Jul 2023 16:13:28 +0100
Subject: [PATCH] feat: added docs for Network config and builder
---
crates/configuration/src/network.rs | 30 +++++++++++++++++------------
1 file changed, 18 insertions(+), 12 deletions(-)
diff --git a/crates/configuration/src/network.rs b/crates/configuration/src/network.rs
index 1bb0223..7897475 100644
--- a/crates/configuration/src/network.rs
+++ b/crates/configuration/src/network.rs
@@ -11,34 +11,31 @@ use crate::{
/// A network configuration, composed of a relaychain, parachains and HRMP channels.
#[derive(Debug, Clone, PartialEq)]
pub struct NetworkConfig {
- // The global settings applied to the network.
global_settings: GlobalSettings,
-
- /// Relaychain configuration.
relaychain: Option<RelaychainConfig>,
-
- /// Parachains configurations.
parachains: Vec<ParachainConfig>,
-
- /// HRMP channels configurations.
hrmp_channels: Vec<HrmpChannelConfig>,
}
impl NetworkConfig {
+ /// The global settings of the network.
pub fn global_settings(&self) -> &GlobalSettings {
&self.global_settings
}
+ /// The relaychain of the network.
pub fn relaychain(&self) -> &RelaychainConfig {
self.relaychain
.as_ref()
.expect("typestate should ensure the relaychain isn't None at this point, this is a bug please report it: https://github.com/paritytech/zombienet-sdk/issues")
}
+ /// The parachains of the network.
pub fn parachains(&self) -> Vec<&ParachainConfig> {
self.parachains.iter().collect::<Vec<_>>()
}
+ /// The HRMP channels of the network.
pub fn hrmp_channels(&self) -> Vec<&HrmpChannelConfig> {
self.hrmp_channels.iter().collect::<Vec<_>>()
}
@@ -49,6 +46,7 @@ states! {
WithRelaychain
}
+/// A network configuration builder, used to build a `NetworkConfig` declaratively with fields validation.
#[derive(Debug)]
pub struct NetworkConfigBuilder<State> {
config: NetworkConfig,
@@ -88,6 +86,7 @@ impl NetworkConfigBuilder<Initial> {
Self::default()
}
+ /// Set the relaychain using a nested ```RelaychainConfigBuilder```.
pub fn with_relaychain(
self,
f: fn(
@@ -108,6 +107,7 @@ impl NetworkConfigBuilder<Initial> {
}
impl NetworkConfigBuilder<WithRelaychain> {
+ /// Set the global settings using a nested ```GlobalSettingsBuilder```.
pub fn with_global_settings(
self,
f: fn(GlobalSettingsBuilder) -> GlobalSettingsBuilder,
@@ -124,6 +124,7 @@ impl NetworkConfigBuilder<WithRelaychain> {
}
}
+ /// Add a parachain using a nested ```ParachainConfigBuilder```.
pub fn with_parachain(
self,
f: fn(
@@ -142,6 +143,7 @@ impl NetworkConfigBuilder<WithRelaychain> {
}
}
+ /// Add a HRMP channel using a nested ```HrmpChannelConfigBuilder```.
pub fn with_hrmp_channel(
self,
f: fn(
@@ -159,6 +161,7 @@ impl NetworkConfigBuilder<WithRelaychain> {
)
}
+ /// Seal the builder and returns a `NetworkConfig` if there are no validation errors, else returns errors.
pub fn build(self) -> Result<NetworkConfig, Vec<anyhow::Error>> {
if !self.errors.is_empty() {
return Err(self.errors);
@@ -239,7 +242,10 @@ mod tests {
assert_eq!(node.command().unwrap().as_str(), "command");
assert!(node.is_validator());
assert_eq!(
- network_config.relaychain().random_minators_count().unwrap(),
+ network_config
+ .relaychain()
+ .random_nominators_count()
+ .unwrap(),
10
);
@@ -385,8 +391,8 @@ mod tests {
.validator(true)
})
})
- .with_parachain(|parachain1| {
- parachain1
+ .with_parachain(|parachain| {
+ parachain
.with_id(1000)
.with_chain("myparachain1")
.with_initial_balance(100_000)
@@ -397,8 +403,8 @@ mod tests {
.validator(true)
})
})
- .with_parachain(|parachain2| {
- parachain2
+ .with_parachain(|parachain| {
+ parachain
.with_id(2000)
.with_chain("myparachain2")
.with_initial_balance(100_000)
--
GitLab