From a9887c53a7f113a3746ca461a49adc83cd152e50 Mon Sep 17 00:00:00 2001
From: Jimmy Chu <jimmychu0807@gmail.com>
Date: Thu, 9 Nov 2023 18:36:01 +0800
Subject: [PATCH] Adding comments on params passing in
 `ChainSpec::from_genesis()`

---
 docs/on-src/node/src/chain_spec.rs.md | 16 ++++++++--------
 node/src/chain_spec.rs                | 20 ++++++++++++++++++--
 2 files changed, 26 insertions(+), 10 deletions(-)

diff --git a/docs/on-src/node/src/chain_spec.rs.md b/docs/on-src/node/src/chain_spec.rs.md
index e80c0af9..0e2a4bf4 100644
--- a/docs/on-src/node/src/chain_spec.rs.md
+++ b/docs/on-src/node/src/chain_spec.rs.md
@@ -5,18 +5,18 @@ Refer to [mermaid doc: Flowchart](https://mermaid.js.org/syntax/flowchart.html)
 ```mermaid
 flowchart LR
   %% main
-  testnet_genesis("testnet_genesis()") --> main_genesis("cess_main_genesis()") --> main("cess_main()")
+  testnet_genesis("testnet_genesis()") --> main_genesis("cess_main_genesis()") --> main("cess_main()") --> initial_testnet(["id: `cess-initial-testnet`"])
 
   %% testnet
-  testnet_genesis --> testnet_config_genesis("cess_testnet_config_genesis()") --> testnet_generate_config("cess_testnet_generate_config()")
+  testnet_genesis --> testnet_config_genesis("cess_testnet_config_genesis()") --> testnet_generate_config("cess_testnet_generate_config()") --> initial_devnet(["id: `cess-initial-devnet`"])
 
-  %% local testnet
-  testnet_genesis --> local_testnet_genesis("local_testnet_genesis()") --> local_testnet_config("local_testnet_config()")
+  %% local
+  testnet_genesis --> local_testnet_genesis("local_testnet_genesis()") --> local_testnet_config("local_testnet_config()") --> local(["id: `local`"])
 
-  %% development
-  testnet_genesis --> development_config_genesis("development_config_genesis()") --> development_config("development_config()")
+  %% dev
+  testnet_genesis --> development_config_genesis("development_config_genesis()") --> development_config("development_config()") --> dev(["id: `dev`"])
 
   %% Reading from chainspec file
-  chainSpec("Read from chainSpec") --> testnet_config("cess_testnet_config()")
-  chainSpec --> develop_config("cess_develop_config()")
+  chainSpec("Read from chainSpec") --> testnet_config("cess_testnet_config()") --> cess_testnet(["id: `cess-testnet`"])
+  chainSpec --> develop_config("cess_develop_config()") --> cess_devnet(["id: `cess-devnet`"])
 ```
diff --git a/node/src/chain_spec.rs b/node/src/chain_spec.rs
index 6a14a313..c270013c 100644
--- a/node/src/chain_spec.rs
+++ b/node/src/chain_spec.rs
@@ -346,7 +346,9 @@ pub fn cess_develop_config() -> ChainSpec {
 pub fn cess_testnet_generate_config() -> ChainSpec {
 	let boot_nodes = vec![];
 	ChainSpec::from_genesis(
+		// Name
 		"cess-devnet",
+		// ID
 		"cess-devnet",
 		ChainType::Live,
 		cess_testnet_config_genesis,
@@ -357,6 +359,7 @@ pub fn cess_testnet_generate_config() -> ChainSpec {
 		),
 		Some("TCESS"),
 		None,
+		// Properties
 		Some(
 			serde_json::from_str(
 				"{\"tokenDecimals\": 12, \"tokenSymbol\": \"TCESS\", \"SS58Prefix\": 11330}",
@@ -370,17 +373,24 @@ pub fn cess_testnet_generate_config() -> ChainSpec {
 pub fn cess_main() -> ChainSpec {
 	let boot_nodes = vec![];
 	ChainSpec::from_genesis(
+		// Name
 		"cess-testnet",
+		// ID
 		"cess-testnet",
 		ChainType::Live,
 		cess_main_genesis,
+		// Bootnodes
 		boot_nodes,
+		// Telemetry
 		Some(
 			TelemetryEndpoints::new(vec![(STAGING_TELEMETRY_URL.to_string(), 0)])
 				.expect("Staging telemetry url is valid; qed"),
 		),
+		// Protocol ID
 		Some("TCESS"),
+		// Fork ID
 		None,
+		// Properties
 		Some(
 			serde_json::from_str(
 				"{\"tokenDecimals\": 12, \"tokenSymbol\": \"TCESS\", \"SS58Prefix\": 11330}",
@@ -413,10 +423,16 @@ pub fn development_config() -> ChainSpec {
 		// Telemetry
 		None,
 		// Protocol ID
+		Some("TCESS"),
+		// Fork ID
 		None,
 		// Properties
-		None,
-		None,
+		Some(
+			serde_json::from_str(
+				"{\"tokenDecimals\": 12, \"tokenSymbol\": \"TCESS\", \"SS58Prefix\": 11330}",
+			)
+				.expect("Provided valid json map"),
+		),
 		// Extensions
 		Default::default(),
 	)