feat: pop up chain spec cmd (#699)

* feat: upgrade to latest zombienet-sdk version

* feat: cd into network's parachain directory

* feat: add --raw variant to chain spec

* fix: undo feature imports

* fix: cd logic

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* test: cd_into_chain_base_dir function

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: moliholy

Cargo.lock

@@ -76,8 +76,8 @@ symlink = { version = "0.1", default-features = false }
 serde_json = { version = "1.0", default-features = false, features = ["preserve_order"] }
 serde = { version = "1.0", default-features = false, features = ["derive"] }
 srtool-lib = { version = "0.13.2", default-features = false }
-zombienet-configuration = { version = "0.3.1", default-features = false }
-zombienet-sdk = { version = "0.3.1", default-features = false }
+zombienet-configuration = { version = "0.4.1", default-features = false }
+zombienet-sdk = { version = "0.4.1", default-features = false }
 git2_credentials = "0.13.0"
 cumulus-client-cli = { version = "0.22.0", default-features = false }
 

Cargo.toml

@@ -4,7 +4,7 @@ use crate::{DynamicPayload, Error, call};
 use scale::{Decode, Encode};
 use sp_core::twox_128;
 use subxt::{
-	OnlineClient, PolkadotConfig,
+	OnlineClient,
 	config::BlockHash,
 	dynamic::{self, Value},
 	events::StaticEvent,
@@ -16,10 +16,10 @@ use subxt::{
 /// # Arguments
 /// * `client` - Client for the network which state is to be modified.
 /// * `para_ids` - List of ids to build the keys that will be mutated.
-pub async fn clear_dmpq(
-	client: OnlineClient<PolkadotConfig>,
-	para_ids: &[u32],
-) -> Result<impl BlockHash, Error> {
+pub async fn clear_dmpq(endpoint: &str, para_ids: &[u32]) -> Result<impl BlockHash, Error> {
+	let client = OnlineClient::<subxt::PolkadotConfig>::from_url(endpoint)
+		.await
+		.map_err(|e| Error::SubXtError(e.into()))?;
 	// Wait for blocks to be produced.
 	let mut sub = client
 		.blocks()

crates/pop-chains/src/relay.rs

@@ -348,7 +348,7 @@ impl NetworkConfiguration {
 			.collect();
 
 		let mut builder = NetworkConfigBuilder::new().with_relaychain(|builder| {
-			let mut builder = builder.with_chain(relay_chain.chain()).with_node(|builder| {
+			let mut builder = builder.with_chain(relay_chain.chain()).with_validator(|builder| {
 				let mut builder = builder
 					.with_name(validators.first().expect("at least two validators defined above"));
 				if let Some(port) = port {
@@ -358,7 +358,7 @@ impl NetworkConfiguration {
 			});
 
 			for validator in validators.iter().skip(1) {
-				builder = builder.with_node(|builder| builder.with_name(validator))
+				builder = builder.with_validator(|builder| builder.with_name(validator))
 			}
 			builder
 		});
@@ -469,6 +469,12 @@ impl NetworkConfiguration {
 				if let Some(location) = source.chain_spec_path() {
 					builder = builder.with_chain_spec_path(location.clone());
 				}
+				if let Some(chain_spec_command_output_path) =
+					source.chain_spec_command_output_path()
+				{
+					builder =
+						builder.with_chain_spec_command_output_path(chain_spec_command_output_path);
+				}
 				// Configure chain spec generator
 				if let Some(command) = chain_spec_generator {
 					builder = builder.with_chain_spec_command(command);
@@ -482,12 +488,12 @@ impl NetworkConfiguration {
 				}
 
 				// Add nodes from source
-				let mut builder = builder.with_node(|builder| {
+				let mut builder = builder.with_validator(|builder| {
 					let source = nodes.first().expect("expected at least one node");
 					Self::build_node_from_source(builder, source, binary_path.as_str())
 				});
 				for source in nodes.iter().skip(1) {
-					builder = builder.with_node(|builder| {
+					builder = builder.with_validator(|builder| {
 						Self::build_node_from_source(builder, source, binary_path.as_str())
 					});
 				}
@@ -546,6 +552,12 @@ impl NetworkConfiguration {
 				if source.chain_spec_command_is_local() {
 					builder = builder.chain_spec_command_is_local(true);
 				}
+				if let Some(chain_spec_command_output_path) =
+					source.chain_spec_command_output_path()
+				{
+					builder =
+						builder.with_chain_spec_command_output_path(chain_spec_command_output_path)
+				}
 				if let Some(location) = source.chain_spec_path() {
 					builder = builder.with_chain_spec_path(location.clone());
 				}
@@ -942,7 +954,7 @@ chain = "paseo-local"
 			let cache = PathBuf::from(temp_dir.path());
 			let config = NetworkConfigBuilder::new()
 				.with_relaychain(|b| {
-					b.with_chain("paseo-local").with_node(|b| b.with_name("alice"))
+					b.with_chain("paseo-local").with_validator(|b| b.with_name("alice"))
 				})
 				.build()
 				.unwrap();
@@ -1119,7 +1131,7 @@ command = "polkadot"
 			let config = NetworkConfigBuilder::new()
 				.with_relaychain(|b| {
 					b.with_chain("paseo-local")
-						.with_node(|b| b.with_name("alice").with_command("polkadot"))
+						.with_validator(|b| b.with_name("alice").with_command("polkadot"))
 				})
 				.build()
 				.unwrap();
@@ -1218,9 +1230,9 @@ command = "polkadot-stable2503"
 			let config = NetworkConfigBuilder::new()
 				.with_relaychain(|b| {
 					b.with_chain("paseo-local")
-						.with_node(|b| b.with_name("alice").with_command("polkadot"))
-						.with_node(|b| b.with_name("bob").with_command("polkadot"))
-						.with_node(|b| b.with_name("charlie").with_command("p0lk4d0t"))
+						.with_validator(|b| b.with_name("alice").with_command("polkadot"))
+						.with_validator(|b| b.with_name("bob").with_command("polkadot"))
+						.with_validator(|b| b.with_name("charlie").with_command("p0lk4d0t"))
 				})
 				.build()
 				.unwrap();
@@ -1927,7 +1939,7 @@ chain = "paseo-local"
 		fn initializing_from_network_config_works() -> Result<(), Error> {
 			let network_config = NetworkConfigBuilder::new()
 				.with_relaychain(|b| {
-					b.with_chain("paseo-local").with_node(|b| b.with_name("alice"))
+					b.with_chain("paseo-local").with_validator(|b| b.with_name("alice"))
 				})
 				.build()
 				.unwrap();
@@ -2160,6 +2172,7 @@ rpc_port = 9944
 					r#"[settings]
 timeout = 1000
 node_spawn_timeout = 300
+tear_down_on_failure = true
 
 [relaychain]
 chain = "paseo-local"
@@ -2197,7 +2210,6 @@ balance = 2000000000000
 
 [[parachains.collators]]
 name = "asset-hub-2"
-command = "{1}"
 validator = true
 invulnerable = true
 bootnode = false
@@ -2341,6 +2353,7 @@ command = "polkadot-parachain"
 					r#"[settings]
 timeout = 1000
 node_spawn_timeout = 300
+tear_down_on_failure = true
 
 [relaychain]
 chain = "paseo-local"
@@ -2483,6 +2496,7 @@ max_message_size = 8000
 					r#"[settings]
 timeout = 1000
 node_spawn_timeout = 300
+tear_down_on_failure = true
 
 [relaychain]
 chain = "paseo-local"
@@ -2619,6 +2633,7 @@ name = "asset-hub"
 					r#"[settings]
 timeout = 1000
 node_spawn_timeout = 300
+tear_down_on_failure = true
 
 [relaychain]
 chain = "paseo-local"
@@ -2736,6 +2751,7 @@ balances = [["5Ec4AhPKXY9B4ayGshkz2wFMh7N8gP7XKfAvtt1cigpG9FkJ", 420000000000]]
 					r#"[settings]
 timeout = 1000
 node_spawn_timeout = 300
+tear_down_on_failure = true
 
 [relaychain]
 chain = "paseo-local"

crates/pop-chains/src/up/mod.rs

@@ -207,6 +207,9 @@ pub struct BuildSpecCommand {
 	/// based on `runtime`.
 	#[clap(long, requires = "deterministic")]
 	pub package: Option<String>,
+	/// Generate a raw chain specification.
+	#[arg(long)]
+	pub(crate) raw: bool,
 }
 
 impl BuildSpecCommand {
@@ -258,6 +261,7 @@ impl BuildSpecCommand {
 			package,
 			runtime_dir,
 			is_relay,
+			raw,
 			..
 		} = self;
 
@@ -508,6 +512,7 @@ impl BuildSpecCommand {
 			package,
 			runtime_dir,
 			use_existing_plain_spec: !prompt,
+			raw,
 		})
 	}
 }
@@ -518,7 +523,7 @@ pub struct GenesisArtifacts {
 	/// Path to the plain text chain specification file.
 	pub chain_spec: PathBuf,
 	/// Path to the raw chain specification file.
-	pub raw_chain_spec: PathBuf,
+	pub raw_chain_spec: Option<PathBuf>,
 	/// Optional path to the genesis state file.
 	pub genesis_state_file: Option<CodePathBuf>,
 	/// Optional path to the genesis code file.
@@ -570,6 +575,7 @@ pub(crate) struct BuildSpec {
 	package: String,
 	runtime_dir: Option<PathBuf>,
 	use_existing_plain_spec: bool,
+	raw: bool,
 }
 
 impl BuildSpec {
@@ -652,54 +658,66 @@ impl BuildSpec {
 			));
 		}
 
-		// Generate raw spec.
-		spinner.set_message("Generating raw chain specification...");
-		let spec_name = self
-			.output_file
-			.file_name()
-			.and_then(|s| s.to_str())
-			.unwrap_or(DEFAULT_SPEC_NAME)
-			.trim_end_matches(".json");
-		let raw_spec_name = format!("{spec_name}-raw.json");
-		let raw_chain_spec = builder.generate_raw_chain_spec(&self.output_file, &raw_spec_name)?;
-		generated_files.push(format!(
-			"Raw chain specification file generated at: {}",
-			raw_chain_spec.display()
-		));
+		let (raw_chain_spec, genesis_code_file, genesis_state_file) = if self.raw ||
+			self.genesis_code ||
+			self.genesis_state
+		{
+			// Generate raw spec.
+			spinner.set_message("Generating raw chain specification...");
+			let spec_name = self
+				.output_file
+				.file_name()
+				.and_then(|s| s.to_str())
+				.unwrap_or(DEFAULT_SPEC_NAME)
+				.trim_end_matches(".json");
+			let raw_spec_name = format!("{spec_name}-raw.json");
+			let raw_chain_spec =
+				builder.generate_raw_chain_spec(&self.output_file, &raw_spec_name)?;
+			generated_files.push(format!(
+				"Raw chain specification file generated at: {}",
+				raw_chain_spec.display()
+			));
 
-		if is_runtime_build {
-			// The runtime version of the raw chain spec does not include certain parameters, like
-			// the relay chain, so we have to overwrite them again.
-			self.customize(&raw_chain_spec)?;
-		}
+			if is_runtime_build {
+				// The runtime version of the raw chain spec does not include certain parameters,
+				// like the relay chain, so we have to overwrite them again.
+				self.customize(&raw_chain_spec)?;
+			}
 
-		// Generate genesis artifacts.
-		let genesis_code_file = if self.genesis_code {
-			spinner.set_message("Generating genesis code...");
-			let wasm_file = builder.export_wasm_file(&raw_chain_spec, "genesis-code.wasm")?;
-			generated_files
-				.push(format!("WebAssembly runtime file exported at: {}", wasm_file.display()));
-			Some(wasm_file)
-		} else {
-			None
-		};
-		let genesis_state_file = if self.genesis_state {
-			spinner.set_message("Generating genesis state...");
-			let binary_path = match builder {
-				ChainSpecBuilder::Runtime { .. } =>
-					source_polkadot_omni_node_binary(cli, &spinner, &crate::cache()?, true).await?,
-				ChainSpecBuilder::Node { .. } => builder.artifact_path()?,
+			// Generate genesis artifacts.
+			let genesis_code_file = if self.genesis_code {
+				spinner.set_message("Generating genesis code...");
+				let wasm_file = builder.export_wasm_file(&raw_chain_spec, "genesis-code.wasm")?;
+				generated_files
+					.push(format!("WebAssembly runtime file exported at: {}", wasm_file.display()));
+				Some(wasm_file)
+			} else {
+				None
 			};
-			let genesis_state_file = generate_genesis_state_file_with_node(
-				&binary_path,
-				&raw_chain_spec,
-				"genesis-state",
-			)?;
-			generated_files
-				.push(format!("Genesis State file exported at: {}", genesis_state_file.display()));
-			Some(genesis_state_file)
+			let genesis_state_file = if self.genesis_state {
+				spinner.set_message("Generating genesis state...");
+				let binary_path = match builder {
+					ChainSpecBuilder::Runtime { .. } =>
+						source_polkadot_omni_node_binary(cli, &spinner, &crate::cache()?, true)
+							.await?,
+					ChainSpecBuilder::Node { .. } => builder.artifact_path()?,
+				};
+				let genesis_state_file = generate_genesis_state_file_with_node(
+					&binary_path,
+					&raw_chain_spec,
+					"genesis-state",
+				)?;
+				generated_files.push(format!(
+					"Genesis State file exported at: {}",
+					genesis_state_file.display()
+				));
+				Some(genesis_state_file)
+			} else {
+				None
+			};
+			(Some(raw_chain_spec), genesis_code_file, genesis_state_file)
 		} else {
-			None
+			(None, None, None)
 		};
 
 		spinner.stop("Chain specification built successfully.");
@@ -786,15 +804,16 @@ fn prepare_output_path(output_path: impl AsRef<Path>) -> anyhow::Result<PathBuf>
 		.and_then(|ext| ext.to_str())
 		.map(|ext| ext.eq_ignore_ascii_case("json"))
 		.unwrap_or(false);
+	let is_dir = output_path.is_dir();
 
-	if !is_json_file {
-		// Treat as directory.
+	if is_dir || (!output_path.exists() && !is_json_file) {
+		// Treat as directory (existing or to-be-created)
 		if !output_path.exists() {
 			create_dir_all(&output_path)?;
 		}
 		output_path.push(DEFAULT_SPEC_NAME);
 	} else {
-		// Treat as file.
+		// Treat as file; ensure parent dir exists
 		if let Some(parent_dir) = output_path.parent() &&
 			!parent_dir.exists()
 		{
@@ -834,6 +853,7 @@ mod tests {
 		let runtime_dir = PathBuf::from("./new-runtime-dir");
 		let path = PathBuf::from("./");
 		let properties = "tokenSymbol=UNIT,decimals=12,isEthereum=false";
+		let raw = true;
 
 		let mut flags_used = false;
 		for (build_spec_cmd, chain) in [
@@ -862,6 +882,7 @@ mod tests {
 					deterministic: Some(deterministic),
 					package: Some(package.to_string()),
 					runtime_dir: Some(runtime_dir.clone()),
+					raw,
 				},
 				Some("local".to_string()),
 			),
@@ -888,6 +909,7 @@ mod tests {
 					deterministic: Some(deterministic),
 					package: Some(package.to_string()),
 					runtime_dir: Some(runtime_dir.clone()),
+					raw,
 				},
 				Some("local".to_string()),
 			),
@@ -1031,6 +1053,7 @@ mod tests {
 					deterministic: None,
 					package: Some(package.to_string()),
 					runtime_dir: Some(runtime_dir.clone()),
+					raw: true,
 				},
 				// All flags used. Relay
 				BuildSpecCommand {
@@ -1054,6 +1077,7 @@ mod tests {
 					deterministic: None,
 					package: Some(package.to_string()),
 					runtime_dir: Some(runtime_dir.clone()),
+					raw: true,
 				},
 			] {
 				let mut cli = MockCli::new().expect_confirm(