chain-spec-builder: Add support for codeSubstitutes

Cargo.toml

@@ -61,6 +61,7 @@ members = [
 	"bridges/snowbridge/primitives/router",
 	"bridges/snowbridge/runtime/runtime-common",
 	"bridges/snowbridge/runtime/test-common",
+	"cumulus/client/chain-spec-extension",
 	"cumulus/client/cli",
 	"cumulus/client/collator",
 	"cumulus/client/consensus/aura",

cumulus/client/chain-spec-extension/Cargo.toml

@@ -0,0 +1,14 @@
+[package]
+name = "cumulus-client-chain-spec-extension"
+version = "0.1.0"
+authors.workspace = true
+edition.workspace = true
+description = "Parachain chain-spec extension."
+license = "GPL-3.0-or-later WITH Classpath-exception-2.0"
+
+[lints]
+workspace = true
+
+[dependencies]
+sc-chain-spec = { path = "../../../substrate/client/chain-spec" }
+serde = { features = ["derive"], workspace = true, default-features = true }

cumulus/client/chain-spec-extension/src/lib.rs

@@ -0,0 +1,38 @@
+// Copyright (C) Parity Technologies (UK) Ltd.
+// This file is part of Cumulus.
+
+// Cumulus is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// Cumulus is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with Cumulus.  If not, see <http://www.gnu.org/licenses/>.
+
+//! Chain spec extension for parachains.
+
+use sc_chain_spec::{ChainSpec, ChainSpecExtension, ChainSpecGroup};
+use serde::{Deserialize, Serialize};
+
+/// The extensions for the [`ChainSpec`].
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, ChainSpecGroup, ChainSpecExtension)]
+pub struct Extensions {
+	/// The relay chain of the Parachain.
+	#[serde(alias = "relayChain", alias = "RelayChain")]
+	pub relay_chain: String,
+	/// The id of the Parachain.
+	#[serde(alias = "paraId", alias = "ParaId")]
+	pub para_id: u32,
+}
+
+impl Extensions {
+	/// Try to get the extension from the given `ChainSpec`.
+	pub fn try_get(chain_spec: &dyn ChainSpec) -> Option<&Self> {
+		sc_chain_spec::get_extension(chain_spec.extensions())
+	}
+}

cumulus/polkadot-parachain/Cargo.toml

@@ -112,6 +112,7 @@ cumulus-primitives-aura = { path = "../primitives/aura" }
 cumulus-primitives-core = { path = "../primitives/core" }
 cumulus-relay-chain-interface = { path = "../client/relay-chain-interface" }
 color-print = "0.3.4"
+cumulus-client-chain-spec-extension = { path = "../client/chain-spec-extension" }
 
 [build-dependencies]
 substrate-build-script-utils = { path = "../../substrate/utils/build-script-utils" }

cumulus/polkadot-parachain/src/chain_spec/mod.rs

@@ -14,9 +14,8 @@
 // You should have received a copy of the GNU General Public License
 // along with Cumulus.  If not, see <http://www.gnu.org/licenses/>.
 
+use cumulus_client_chain_spec_extension::Extensions;
 use parachains_common::{AccountId, Signature};
-use sc_chain_spec::{ChainSpecExtension, ChainSpecGroup};
-use serde::{Deserialize, Serialize};
 use sp_core::{Pair, Public};
 use sp_runtime::traits::{IdentifyAccount, Verify};
 
@@ -35,24 +34,6 @@ pub mod shell;
 /// The default XCM version to set in genesis config.
 const SAFE_XCM_VERSION: u32 = xcm::prelude::XCM_VERSION;
 
-/// Generic extensions for Parachain ChainSpecs.
-#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, ChainSpecGroup, ChainSpecExtension)]
-pub struct Extensions {
-	/// The relay chain of the Parachain.
-	#[serde(alias = "relayChain", alias = "RelayChain")]
-	pub relay_chain: String,
-	/// The id of the Parachain.
-	#[serde(alias = "paraId", alias = "ParaId")]
-	pub para_id: u32,
-}
-
-impl Extensions {
-	/// Try to get the extension from the given `ChainSpec`.
-	pub fn try_get(chain_spec: &dyn sc_service::ChainSpec) -> Option<&Self> {
-		sc_chain_spec::get_extension(chain_spec.extensions())
-	}
-}
-
 /// Generic chain spec for all polkadot-parachain runtimes
 pub type GenericChainSpec = sc_service::GenericChainSpec<Extensions>;
 

cumulus/polkadot-parachain/src/cli.rs

@@ -14,6 +14,7 @@
 // You should have received a copy of the GNU General Public License
 // along with Cumulus.  If not, see <http://www.gnu.org/licenses/>.
 
+use cumulus_client_chain_spec_extension::Extensions;
 use std::path::PathBuf;
 
 /// Sub-commands supported by the collator.
@@ -113,7 +114,7 @@ impl RelayChainCli {
 		para_config: &sc_service::Configuration,
 		relay_chain_args: impl Iterator<Item = &'a String>,
 	) -> Self {
-		let extension = crate::chain_spec::Extensions::try_get(&*para_config.chain_spec);
+		let extension = Extensions::try_get(&*para_config.chain_spec);
 		let chain_id = extension.map(|e| e.relay_chain.clone());
 		let base_path = para_config.base_path.path().join("polkadot");
 		Self {

cumulus/polkadot-parachain/src/command.rs

@@ -644,7 +644,7 @@ pub fn run() -> Result<()> {
 						sc_sysinfo::gather_hwbench(Some(database_path))
 					})).flatten();
 
-				let para_id = chain_spec::Extensions::try_get(&*config.chain_spec)
+				let para_id = cumulus_client_chain_spec_extension::Extensions::try_get(&*config.chain_spec)
 					.map(|e| e.para_id)
 					.ok_or("Could not find parachain extension in chain-spec.")?;
 

cumulus/test/service/Cargo.toml

@@ -19,7 +19,6 @@ codec = { package = "parity-scale-codec", version = "3.6.12" }
 criterion = { version = "0.5.1", features = ["async_tokio"] }
 jsonrpsee = { version = "0.22", features = ["server"] }
 rand = "0.8.5"
-serde = { features = ["derive"], workspace = true, default-features = true }
 serde_json = { workspace = true, default-features = true }
 tokio = { version = "1.32.0", features = ["macros"] }
 tracing = "0.1.37"
@@ -88,6 +87,7 @@ cumulus-test-relay-sproof-builder = { path = "../relay-sproof-builder" }
 cumulus-pallet-parachain-system = { path = "../../pallets/parachain-system", default-features = false }
 cumulus-primitives-storage-weight-reclaim = { path = "../../primitives/storage-weight-reclaim" }
 pallet-timestamp = { path = "../../../substrate/frame/timestamp" }
+cumulus-client-chain-spec-extension = { path = "../../client/chain-spec-extension" }
 
 [dev-dependencies]
 futures = "0.3.28"

cumulus/test/service/src/chain_spec.rs

@@ -16,12 +16,11 @@
 
 #![allow(missing_docs)]
 
+use cumulus_client_chain_spec_extension::Extensions;
 use cumulus_primitives_core::ParaId;
 use cumulus_test_runtime::{AccountId, Signature};
 use parachains_common::AuraId;
-use sc_chain_spec::{ChainSpecExtension, ChainSpecGroup};
 use sc_service::ChainType;
-use serde::{Deserialize, Serialize};
 use sp_core::{sr25519, Pair, Public};
 use sp_runtime::traits::{IdentifyAccount, Verify};
 
@@ -35,21 +34,6 @@ pub fn get_from_seed<TPublic: Public>(seed: &str) -> <TPublic::Pair as Pair>::Pu
 		.public()
 }
 
-/// The extensions for the [`ChainSpec`].
-#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, ChainSpecGroup, ChainSpecExtension)]
-#[serde(deny_unknown_fields)]
-pub struct Extensions {
-	/// The id of the Parachain.
-	pub para_id: u32,
-}
-
-impl Extensions {
-	/// Try to get the extension from the given `ChainSpec`.
-	pub fn try_get(chain_spec: &dyn sc_service::ChainSpec) -> Option<&Self> {
-		sc_chain_spec::get_extension(chain_spec.extensions())
-	}
-}
-
 type AccountPublic = <Signature as Verify>::Signer;
 
 /// Helper function to generate an account ID from seed.
@@ -69,7 +53,10 @@ pub fn get_chain_spec_with_extra_endowed(
 ) -> ChainSpec {
 	ChainSpec::builder(
 		cumulus_test_runtime::WASM_BINARY.expect("WASM binary was not built, please build it!"),
-		Extensions { para_id: id.unwrap_or(cumulus_test_runtime::PARACHAIN_ID.into()).into() },
+		Extensions {
+			para_id: id.unwrap_or(cumulus_test_runtime::PARACHAIN_ID.into()).into(),
+			relay_chain: "rococo-local".to_string(),
+		},
 	)
 	.with_name("Local Testnet")
 	.with_id("local_testnet")

cumulus/test/service/src/main.rs

@@ -20,7 +20,7 @@ use std::sync::Arc;
 
 use cli::{RelayChainCli, Subcommand, TestCollatorCli};
 use cumulus_primitives_core::relay_chain::CollatorPair;
-use cumulus_test_service::{chain_spec, new_partial, AnnounceBlockFn};
+use cumulus_test_service::{new_partial, AnnounceBlockFn};
 use sc_cli::{CliConfiguration, SubstrateCli};
 use sp_core::Pair;
 
@@ -77,9 +77,10 @@ fn main() -> Result<(), sc_cli::Error> {
 				SubstrateCli::create_configuration(&polkadot_cli, &polkadot_cli, tokio_handle)
 					.map_err(|err| format!("Relay chain argument error: {}", err))?;
 
-			let parachain_id = chain_spec::Extensions::try_get(&*config.chain_spec)
-				.map(|e| e.para_id)
-				.ok_or("Could not find parachain extension in chain-spec.")?;
+			let parachain_id =
+				cumulus_client_chain_spec_extension::Extensions::try_get(&*config.chain_spec)
+					.map(|e| e.para_id)
+					.ok_or("Could not find parachain extension in chain-spec.")?;
 
 			tracing::info!("Parachain id: {:?}", parachain_id);
 			tracing::info!(

prdoc/pr_4685.prdoc

@@ -0,0 +1,16 @@
+# Schema: Polkadot SDK PRDoc Schema (prdoc) v1.0.0
+# See doc at https://raw.github.com/paritytech/polkadot-sdk/master/prdoc/schema_user.json
+
+title: Chain-spec-builder supports parachain chain-specs and `codeSubstitutes`.
+
+doc:
+  - audience: Node Operator
+    description: |
+      Chain-spec-builder now supports parachain chain-specs. Parachain chain-specs have the `relay_chain` and `para_id` fields.
+      Before this change, the fields would get silently removed when using the chain-spec-builder.
+      In addition, a new subcommand `add-code-substitute` is available. It allows users to provide a runtime that should be used from a given
+      block onwards.
+
+crates:
+  - name: staging-chain-spec-builder
+    bump: minor

substrate/bin/utils/chain-spec-builder/Cargo.toml

@@ -29,3 +29,7 @@ log = { workspace = true, default-features = true }
 sc-chain-spec = { path = "../../../client/chain-spec", features = ["clap"] }
 serde_json = { workspace = true, default-features = true }
 sp-tracing = { path = "../../../primitives/tracing" }
+sp-runtime = { path = "../../../primitives/runtime" }
+sp-core = { path = "../../../primitives/core" }
+sc-service = { path = "../../../client/service", default-features = false }
+cumulus-client-chain-spec-extension = { path = "../../../../cumulus/client/chain-spec-extension" }

substrate/bin/utils/chain-spec-builder/bin/main.rs

@@ -17,16 +17,20 @@
 // along with this program. If not, see <https://www.gnu.org/licenses/>.
 
 use chain_spec_builder::{
-	generate_chain_spec_for_runtime, ChainSpecBuilder, ChainSpecBuilderCmd, ConvertToRawCmd,
-	DisplayPresetCmd, ListPresetsCmd, UpdateCodeCmd, VerifyCmd,
+	generate_chain_spec_for_runtime, AddCodeSubstituteCmd, ChainSpecBuilder, ChainSpecBuilderCmd,
+	ConvertToRawCmd, DisplayPresetCmd, ListPresetsCmd, UpdateCodeCmd, VerifyCmd,
 };
 use clap::Parser;
+use cumulus_client_chain_spec_extension::Extensions;
 use sc_chain_spec::{
-	update_code_in_json_chain_spec, GenericChainSpec, GenesisConfigBuilderRuntimeCaller,
+	set_code_substitute_in_json_chain_spec, update_code_in_json_chain_spec, GenericChainSpec,
+	GenesisConfigBuilderRuntimeCaller,
 };
 use staging_chain_spec_builder as chain_spec_builder;
 use std::fs;
 
+type ChainSpec = GenericChainSpec<Option<Extensions>, ()>;
+
 //avoid error message escaping
 fn main() {
 	match inner_main() {
@@ -50,7 +54,7 @@ fn inner_main() -> Result<(), String> {
 			ref input_chain_spec,
 			ref runtime_wasm_path,
 		}) => {
-			let chain_spec = GenericChainSpec::<()>::from_json_file(input_chain_spec.clone())?;
+			let chain_spec = ChainSpec::from_json_file(input_chain_spec.clone())?;
 
 			let mut chain_spec_json =
 				serde_json::from_str::<serde_json::Value>(&chain_spec.as_json(false)?)
@@ -65,8 +69,29 @@ fn inner_main() -> Result<(), String> {
 				.map_err(|e| format!("to pretty failed: {e}"))?;
 			fs::write(chain_spec_path, chain_spec_json).map_err(|err| err.to_string())?;
 		},
+		ChainSpecBuilderCmd::AddCodeSubstitute(AddCodeSubstituteCmd {
+			ref input_chain_spec,
+			ref runtime_wasm_path,
+			block_height,
+		}) => {
+			let chain_spec = ChainSpec::from_json_file(input_chain_spec.clone())?;
+
+			let mut chain_spec_json =
+				serde_json::from_str::<serde_json::Value>(&chain_spec.as_json(false)?)
+					.map_err(|e| format!("Conversion to json failed: {e}"))?;
+
+			set_code_substitute_in_json_chain_spec(
+				&mut chain_spec_json,
+				&fs::read(runtime_wasm_path.as_path())
+					.map_err(|e| format!("Wasm blob file could not be read: {e}"))?[..],
+				block_height,
+			);
+			let chain_spec_json = serde_json::to_string_pretty(&chain_spec_json)
+				.map_err(|e| format!("to pretty failed: {e}"))?;
+			fs::write(chain_spec_path, chain_spec_json).map_err(|err| err.to_string())?;
+		},
 		ChainSpecBuilderCmd::ConvertToRaw(ConvertToRawCmd { ref input_chain_spec }) => {
-			let chain_spec = GenericChainSpec::<()>::from_json_file(input_chain_spec.clone())?;
+			let chain_spec = ChainSpec::from_json_file(input_chain_spec.clone())?;
 
 			let chain_spec_json =
 				serde_json::from_str::<serde_json::Value>(&chain_spec.as_json(true)?)
@@ -77,7 +102,7 @@ fn inner_main() -> Result<(), String> {
 			fs::write(chain_spec_path, chain_spec_json).map_err(|err| err.to_string())?;
 		},
 		ChainSpecBuilderCmd::Verify(VerifyCmd { ref input_chain_spec }) => {
-			let chain_spec = GenericChainSpec::<()>::from_json_file(input_chain_spec.clone())?;
+			let chain_spec = ChainSpec::from_json_file(input_chain_spec.clone())?;
 			let _ = serde_json::from_str::<serde_json::Value>(&chain_spec.as_json(true)?)
 				.map_err(|e| format!("Conversion to json failed: {e}"))?;
 		},