From 78c24ec9e24ea04b2f8513b53a8d1246ff6b35ed Mon Sep 17 00:00:00 2001
From: gupnik <nikhilgupta.iitk@gmail.com>
Date: Fri, 31 May 2024 07:39:12 +0530
Subject: [PATCH] Adds ability to specify chain type in chain-spec-builder
(#4542)
Currently, `chain-spec-builder` only creates a spec with `Live` chain
type. This PR adds the ability to specify it while keeping the same
default.
---------
Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com>
---
Cargo.lock | 1 +
prdoc/pr_4542.prdoc | 13 +++++++++++++
substrate/bin/utils/chain-spec-builder/Cargo.toml | 2 +-
substrate/bin/utils/chain-spec-builder/src/lib.rs | 9 +++++++--
substrate/client/chain-spec/Cargo.toml | 1 +
substrate/client/chain-spec/src/lib.rs | 2 ++
6 files changed, 25 insertions(+), 3 deletions(-)
create mode 100644 prdoc/pr_4542.prdoc
diff --git a/Cargo.lock b/Cargo.lock
index 781dba880cb..e50baf6e668 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -16709,6 +16709,7 @@ name = "sc-chain-spec"
version = "28.0.0"
dependencies = [
"array-bytes",
+ "clap 4.5.3",
"docify",
"log",
"memmap2 0.9.3",
diff --git a/prdoc/pr_4542.prdoc b/prdoc/pr_4542.prdoc
new file mode 100644
index 00000000000..faaf9dc2c28
--- /dev/null
+++ b/prdoc/pr_4542.prdoc
@@ -0,0 +1,13 @@
+title: "Adds ability to specify chain type in chain-spec-builder"
+
+doc:
+ - audience: Node Operator
+ description: |
+ Currently, `chain-spec-builder` only creates a spec with Live chain type. This PR adds the
+ ability to specify it while keeping the same default.
+
+crates:
+ - name: staging-chain-spec-builder
+ bump: patch
+ - name: sc-chain-spec
+ bump: patch
diff --git a/substrate/bin/utils/chain-spec-builder/Cargo.toml b/substrate/bin/utils/chain-spec-builder/Cargo.toml
index cc9aa402fd1..de06bbb3fff 100644
--- a/substrate/bin/utils/chain-spec-builder/Cargo.toml
+++ b/substrate/bin/utils/chain-spec-builder/Cargo.toml
@@ -26,6 +26,6 @@ crate-type = ["rlib"]
[dependencies]
clap = { version = "4.5.3", features = ["derive"] }
log = { workspace = true, default-features = true }
-sc-chain-spec = { path = "../../../client/chain-spec" }
+sc-chain-spec = { path = "../../../client/chain-spec", features = ["clap"] }
serde_json = { workspace = true, default-features = true }
sp-tracing = { path = "../../../primitives/tracing" }
diff --git a/substrate/bin/utils/chain-spec-builder/src/lib.rs b/substrate/bin/utils/chain-spec-builder/src/lib.rs
index 167704d3633..0f7c003fc8c 100644
--- a/substrate/bin/utils/chain-spec-builder/src/lib.rs
+++ b/substrate/bin/utils/chain-spec-builder/src/lib.rs
@@ -120,7 +120,7 @@
use std::{fs, path::PathBuf};
use clap::{Parser, Subcommand};
-use sc_chain_spec::{GenericChainSpec, GenesisConfigBuilderRuntimeCaller};
+use sc_chain_spec::{ChainType, GenericChainSpec, GenesisConfigBuilderRuntimeCaller};
use serde_json::Value;
/// A utility to easily create a chain spec definition.
@@ -154,6 +154,9 @@ pub struct CreateCmd {
/// The chain id.
#[arg(long, short = 'i', default_value = "custom")]
chain_id: String,
+ /// The chain type.
+ #[arg(value_enum, short = 't', default_value = "live")]
+ chain_type: ChainType,
/// The path to runtime wasm blob.
#[arg(long, short)]
runtime_wasm_path: PathBuf,
@@ -261,10 +264,12 @@ pub fn generate_chain_spec_for_runtime(cmd: &CreateCmd) -> Result<String, String
let code = fs::read(cmd.runtime_wasm_path.as_path())
.map_err(|e| format!("wasm blob shall be readable {e}"))?;
+ let chain_type = &cmd.chain_type;
+
let builder = GenericChainSpec::<()>::builder(&code[..], Default::default())
.with_name(&cmd.chain_name[..])
.with_id(&cmd.chain_id[..])
- .with_chain_type(sc_chain_spec::ChainType::Live);
+ .with_chain_type(chain_type.clone());
let builder = match cmd.action {
GenesisBuildAction::NamedPreset(NamedPresetCmd { ref preset_name }) =>
diff --git a/substrate/client/chain-spec/Cargo.toml b/substrate/client/chain-spec/Cargo.toml
index 9028a2c49ee..5b411b642a0 100644
--- a/substrate/client/chain-spec/Cargo.toml
+++ b/substrate/client/chain-spec/Cargo.toml
@@ -16,6 +16,7 @@ workspace = true
targets = ["x86_64-unknown-linux-gnu"]
[dependencies]
+clap = { version = "4.5.3", features = ["derive"], optional = true }
codec = { package = "parity-scale-codec", version = "3.6.12", default-features = false, features = ["derive"] }
memmap2 = "0.9.3"
serde = { features = ["derive"], workspace = true, default-features = true }
diff --git a/substrate/client/chain-spec/src/lib.rs b/substrate/client/chain-spec/src/lib.rs
index 066a0ab9e2a..653c3c618b7 100644
--- a/substrate/client/chain-spec/src/lib.rs
+++ b/substrate/client/chain-spec/src/lib.rs
@@ -352,6 +352,7 @@ use sp_runtime::BuildStorage;
/// This can be used by tools to determine the type of a chain for displaying
/// additional information or enabling additional features.
#[derive(serde::Serialize, serde::Deserialize, Debug, PartialEq, Clone)]
+#[cfg_attr(feature = "clap", derive(clap::ValueEnum))]
pub enum ChainType {
/// A development chain that runs mainly on one node.
Development,
@@ -360,6 +361,7 @@ pub enum ChainType {
/// A live chain.
Live,
/// Some custom chain type.
+ #[cfg_attr(feature = "clap", clap(skip))]
Custom(String),
}
--
GitLab