Rename ExportGenesisStateCommand to ExportGenesisHeadCommand and make it respect custom genesis block builders

cumulus/client/cli/Cargo.toml

@@ -18,3 +18,4 @@ sc-chain-spec = { path = "../../../substrate/client/chain-spec" }
 sc-service = { path = "../../../substrate/client/service" }
 sp-core = { path = "../../../substrate/primitives/core" }
 sp-runtime = { path = "../../../substrate/primitives/runtime" }
+sp-blockchain = { path = "../../../substrate/primitives/blockchain" }

cumulus/client/cli/src/lib.rs

@@ -23,20 +23,18 @@ use std::{
 	io::{self, Write},
 	net::SocketAddr,
 	path::PathBuf,
+	sync::Arc,
 };
 
 use codec::Encode;
 use sc_chain_spec::ChainSpec;
-use sc_client_api::ExecutorProvider;
+use sc_client_api::HeaderBackend;
 use sc_service::{
 	config::{PrometheusConfig, TelemetryEndpoints},
 	BasePath, TransactionPoolOptions,
 };
 use sp_core::hexdisplay::HexDisplay;
-use sp_runtime::{
-	traits::{Block as BlockT, Hash as HashT, Header as HeaderT, Zero},
-	StateVersion,
-};
+use sp_runtime::traits::{Block as BlockT, Zero};
 use url::Url;
 
 /// The `purge-chain` command used to remove the whole chain: the parachain and the relay chain.
@@ -129,9 +127,9 @@ impl sc_cli::CliConfiguration for PurgeChainCmd {
 	}
 }
 
-/// Command for exporting the genesis state of the parachain
+/// Command for exporting the genesis head data of the parachain
 #[derive(Debug, clap::Parser)]
-pub struct ExportGenesisStateCommand {
+pub struct ExportGenesisHeadCommand {
 	/// Output file name or stdout if unspecified.
 	#[arg()]
 	pub output: Option<PathBuf>,
@@ -145,24 +143,29 @@ pub struct ExportGenesisStateCommand {
 	pub shared_params: sc_cli::SharedParams,
 }
 
-impl ExportGenesisStateCommand {
-	/// Run the export-genesis-state command
-	pub fn run<Block: BlockT>(
-		&self,
-		chain_spec: &dyn ChainSpec,
-		client: &impl ExecutorProvider<Block>,
-	) -> sc_cli::Result<()> {
-		let state_version = sc_chain_spec::resolve_state_version_from_wasm(
-			&chain_spec.build_storage()?,
-			client.executor(),
-		)?;
-
-		let block: Block = generate_genesis_block(chain_spec, state_version)?;
-		let raw_header = block.header().encode();
+impl ExportGenesisHeadCommand {
+	/// Run the export-genesis-head command
+	pub fn run<B, C>(&self, client: Arc<C>) -> sc_cli::Result<()>
+	where
+		B: BlockT,
+		C: HeaderBackend<B> + 'static,
+	{
+		let genesis_hash = client.hash(Zero::zero())?.ok_or(sc_cli::Error::Client(
+			sp_blockchain::Error::Backend(
+				"Failed to lookup genesis block hash when exporting genesis head data.".into(),
+			),
+		))?;
+		let genesis_header = client.header(genesis_hash)?.ok_or(sc_cli::Error::Client(
+			sp_blockchain::Error::Backend(
+				"Failed to lookup genesis header by hash when exporting genesis head data.".into(),
+			),
+		))?;
+
+		let raw_header = genesis_header.encode();
 		let output_buf = if self.raw {
 			raw_header
 		} else {
-			format!("0x{:?}", HexDisplay::from(&block.header().encode())).into_bytes()
+			format!("0x{:?}", HexDisplay::from(&genesis_header.encode())).into_bytes()
 		};
 
 		if let Some(output) = &self.output {
@@ -175,43 +178,7 @@ impl ExportGenesisStateCommand {
 	}
 }
 
-/// Generate the genesis block from a given ChainSpec.
-pub fn generate_genesis_block<Block: BlockT>(
-	chain_spec: &dyn ChainSpec,
-	genesis_state_version: StateVersion,
-) -> Result<Block, String> {
-	let storage = chain_spec.build_storage()?;
-
-	let child_roots = storage.children_default.iter().map(|(sk, child_content)| {
-		let state_root = <<<Block as BlockT>::Header as HeaderT>::Hashing as HashT>::trie_root(
-			child_content.data.clone().into_iter().collect(),
-			genesis_state_version,
-		);
-		(sk.clone(), state_root.encode())
-	});
-	let state_root = <<<Block as BlockT>::Header as HeaderT>::Hashing as HashT>::trie_root(
-		storage.top.clone().into_iter().chain(child_roots).collect(),
-		genesis_state_version,
-	);
-
-	let extrinsics_root = <<<Block as BlockT>::Header as HeaderT>::Hashing as HashT>::trie_root(
-		Vec::new(),
-		genesis_state_version,
-	);
-
-	Ok(Block::new(
-		<<Block as BlockT>::Header as HeaderT>::new(
-			Zero::zero(),
-			extrinsics_root,
-			state_root,
-			Default::default(),
-			Default::default(),
-		),
-		Default::default(),
-	))
-}
-
-impl sc_cli::CliConfiguration for ExportGenesisStateCommand {
+impl sc_cli::CliConfiguration for ExportGenesisHeadCommand {
 	fn shared_params(&self) -> &sc_cli::SharedParams {
 		&self.shared_params
 	}

cumulus/parachain-template/node/src/cli.rs

@@ -24,8 +24,11 @@ pub enum Subcommand {
 	/// Remove the whole chain.
 	PurgeChain(cumulus_client_cli::PurgeChainCmd),
 
-	/// Export the genesis state of the parachain.
-	ExportGenesisState(cumulus_client_cli::ExportGenesisStateCommand),
+	/// Export the genesis head data of the parachain.
+	/// Head data is the encoded block header.
+	/// This is the same as the old, poorly named, ExportGenesisState command.
+	#[command(alias = "export-genesis-state")]
+	ExportGenesisHead(cumulus_client_cli::ExportGenesisHeadCommand),
 
 	/// Export the genesis wasm of the parachain.
 	ExportGenesisWasm(cumulus_client_cli::ExportGenesisWasmCommand),

cumulus/parachain-template/node/src/command.rs

@@ -162,12 +162,12 @@ pub fn run() -> Result<()> {
 				cmd.run(config, polkadot_config)
 			})
 		},
-		Some(Subcommand::ExportGenesisState(cmd)) => {
+		Some(Subcommand::ExportGenesisHead(cmd)) => {
 			let runner = cli.create_runner(cmd)?;
 			runner.sync_run(|config| {
 				let partials = new_partial(&config)?;
 
-				cmd.run(&*config.chain_spec, &*partials.client)
+				cmd.run(partials.client)
 			})
 		},
 		Some(Subcommand::ExportGenesisWasm(cmd)) => {

cumulus/polkadot-parachain/src/cli.rs

@@ -45,7 +45,8 @@ pub enum Subcommand {
 	PurgeChain(cumulus_client_cli::PurgeChainCmd),
 
 	/// Export the genesis state of the parachain.
-	ExportGenesisState(cumulus_client_cli::ExportGenesisStateCommand),
+	#[command(alias = "export-genesis-state")]
+	ExportGenesisHead(cumulus_client_cli::ExportGenesisHeadCommand),
 
 	/// Export the genesis wasm of the parachain.
 	ExportGenesisWasm(cumulus_client_cli::ExportGenesisWasmCommand),

cumulus/polkadot-parachain/src/command.rs

@@ -530,10 +530,10 @@ pub fn run() -> Result<()> {
 				cmd.run(config, polkadot_config)
 			})
 		},
-		Some(Subcommand::ExportGenesisState(cmd)) => {
+		Some(Subcommand::ExportGenesisHead(cmd)) => {
 			let runner = cli.create_runner(cmd)?;
 			runner.sync_run(|config| {
-				construct_partials!(config, |partials| cmd.run(&*config.chain_spec, &*partials.client))
+				construct_partials!(config, |partials| cmd.run(partials.client))
 			})
 		},
 		Some(Subcommand::ExportGenesisWasm(cmd)) => {

cumulus/test/service/src/cli.rs

@@ -60,23 +60,23 @@ pub enum Subcommand {
 	BuildSpec(sc_cli::BuildSpecCmd),
 
 	/// Export the genesis state of the parachain.
-	ExportGenesisState(ExportGenesisStateCommand),
+	ExportGenesisState(ExportGenesisHeadCommand),
 
 	/// Export the genesis wasm of the parachain.
 	ExportGenesisWasm(ExportGenesisWasmCommand),
 }
 
 #[derive(Debug, clap::Parser)]
 #[group(skip)]
-pub struct ExportGenesisStateCommand {
+pub struct ExportGenesisHeadCommand {
 	#[arg(default_value_t = 2000u32)]
 	pub parachain_id: u32,
 
 	#[command(flatten)]
-	pub base: cumulus_client_cli::ExportGenesisStateCommand,
+	pub base: cumulus_client_cli::ExportGenesisHeadCommand,
 }
 
-impl CliConfiguration for ExportGenesisStateCommand {
+impl CliConfiguration for ExportGenesisHeadCommand {
 	fn shared_params(&self) -> &SharedParams {
 		&self.base.shared_params
 	}

cumulus/test/service/src/genesis.rs

@@ -15,11 +15,50 @@
 // along with Cumulus.  If not, see <http://www.gnu.org/licenses/>.
 
 use codec::Encode;
-use cumulus_client_cli::generate_genesis_block;
 use cumulus_primitives_core::ParaId;
 use cumulus_test_runtime::Block;
 use polkadot_primitives::HeadData;
-use sp_runtime::traits::Block as BlockT;
+use sc_chain_spec::ChainSpec;
+use sp_runtime::{
+	traits::{Block as BlockT, Hash as HashT, Header as HeaderT, Zero},
+	StateVersion,
+};
+
+/// Generate a simple test genesis block from a given ChainSpec.
+pub fn generate_genesis_block<Block: BlockT>(
+	chain_spec: &dyn ChainSpec,
+	genesis_state_version: StateVersion,
+) -> Result<Block, String> {
+	let storage = chain_spec.build_storage()?;
+
+	let child_roots = storage.children_default.iter().map(|(sk, child_content)| {
+		let state_root = <<<Block as BlockT>::Header as HeaderT>::Hashing as HashT>::trie_root(
+			child_content.data.clone().into_iter().collect(),
+			genesis_state_version,
+		);
+		(sk.clone(), state_root.encode())
+	});
+	let state_root = <<<Block as BlockT>::Header as HeaderT>::Hashing as HashT>::trie_root(
+		storage.top.clone().into_iter().chain(child_roots).collect(),
+		genesis_state_version,
+	);
+
+	let extrinsics_root = <<<Block as BlockT>::Header as HeaderT>::Hashing as HashT>::trie_root(
+		Vec::new(),
+		genesis_state_version,
+	);
+
+	Ok(Block::new(
+		<<Block as BlockT>::Header as HeaderT>::new(
+			Zero::zero(),
+			extrinsics_root,
+			state_root,
+			Default::default(),
+			Default::default(),
+		),
+		Default::default(),
+	))
+}
 
 /// Returns the initial head data for a parachain ID.
 pub fn initial_head_data(para_id: ParaId) -> HeadData {

cumulus/test/service/src/lib.rs

@@ -22,7 +22,9 @@
 pub mod bench_utils;
 
 pub mod chain_spec;
-mod genesis;
+
+/// Utilities for creating test genesis block and head data
+pub mod genesis;
 
 use runtime::AccountId;
 use sc_executor::{HeapAllocStrategy, WasmExecutor, DEFAULT_HEAP_ALLOC_STRATEGY};

cumulus/test/service/src/main.rs

@@ -19,9 +19,8 @@ mod cli;
 use std::{io::Write, sync::Arc};
 
 use cli::{RelayChainCli, Subcommand, TestCollatorCli};
-use cumulus_client_cli::generate_genesis_block;
 use cumulus_primitives_core::{relay_chain::CollatorPair, ParaId};
-use cumulus_test_service::AnnounceBlockFn;
+use cumulus_test_service::{genesis::generate_genesis_block, AnnounceBlockFn};
 use polkadot_service::runtime_traits::AccountIdConversion;
 use sc_cli::{CliConfiguration, SubstrateCli};
 use sp_core::{hexdisplay::HexDisplay, Encode, Pair};
@@ -51,7 +50,12 @@ fn main() -> Result<(), sc_cli::Error> {
 
 			let spec =
 				cli.load_spec(&params.base.shared_params.chain.clone().unwrap_or_default())?;
-			let state_version = cumulus_test_service::runtime::VERSION.state_version();
+			let wasm_executor: WasmExecutor<sp_io::SubstrateHostFunctions> =
+				WasmExecutor::builder().build();
+			let state_version = sc_chain_spec::resolve_state_version_from_wasm(
+				&spec.build_storage()?,
+				&wasm_executor,
+			)?;
 
 			let block: parachains_common::Block = generate_genesis_block(&*spec, state_version)?;
 			let raw_header = block.header().encode();

polkadot/parachain/test-parachains/adder/collator/src/cli.rs

@@ -24,16 +24,16 @@ use sc_cli::SubstrateCli;
 pub enum Subcommand {
 	/// Export the genesis state of the parachain.
 	#[command(name = "export-genesis-state")]
-	ExportGenesisState(ExportGenesisStateCommand),
+	ExportGenesisState(ExportGenesisHeadCommand),
 
 	/// Export the genesis wasm of the parachain.
 	#[command(name = "export-genesis-wasm")]
 	ExportGenesisWasm(ExportGenesisWasmCommand),
 }
 
-/// Command for exporting the genesis state of the parachain
+/// Command for exporting the genesis head data of the parachain
 #[derive(Debug, Parser)]
-pub struct ExportGenesisStateCommand {}
+pub struct ExportGenesisHeadCommand {}
 
 /// Command for exporting the genesis wasm file.
 #[derive(Debug, Parser)]

polkadot/parachain/test-parachains/undying/collator/src/cli.rs

@@ -25,16 +25,16 @@ use std::path::PathBuf;
 pub enum Subcommand {
 	/// Export the genesis state of the parachain.
 	#[command(name = "export-genesis-state")]
-	ExportGenesisState(ExportGenesisStateCommand),
+	ExportGenesisState(ExportGenesisHeadCommand),
 
 	/// Export the genesis wasm of the parachain.
 	#[command(name = "export-genesis-wasm")]
 	ExportGenesisWasm(ExportGenesisWasmCommand),
 }
 
-/// Command for exporting the genesis state of the parachain
+/// Command for exporting the genesis head data of the parachain
 #[derive(Debug, Parser)]
-pub struct ExportGenesisStateCommand {
+pub struct ExportGenesisHeadCommand {
 	/// Output file name or stdout if unspecified.
 	#[arg()]
 	pub output: Option<PathBuf>,