feat: make setting bootnodes optional when node network key is found or not found

Author: LGLO

changelog.md

@@ -5,6 +5,7 @@ This changelog is based on [Keep A Changelog](https://keepachangelog.com/en/1.1.
 # Unreleased
 
 * Added extra constant burn fee in `pallet-address-association` to discourage attacks on pallet storage.
+* Wizards don't require `generate-keys` for `prepare-configuration`. Altered recommended order of `create-chain-spec` and `setup-main-chain-state`.
 
 ## Changed
 

dev/local-environment/configurations/wizard/governance-authority/entrypoint.sh

@@ -60,6 +60,8 @@ spawn ./partner-chains-node wizards prepare-configuration
 set timeout 180
 expect "node base path (./data)"
 send "\r"
+expect "Do you want to configure a single bootnode with"
+send "Y\r"
 expect "Your bootnode should be accessible via:"
 send "\r"
 expect "Enter bootnode TCP port (3033)"
@@ -76,7 +78,7 @@ expect "path to the payment signing key file (payment.skey)"
 send "/keys/funded_address.skey\r"
 expect "Select an UTXO to use as the genesis UTXO"
 send "\r"
-expect "Space separated keys hashes of the initial Multisig Governance Authorities (0x$GOVERNANCE_AUTHORITY)"
+expect "Enter the space separated keys hashes of the initial Multisig Governance Authorities"
 send "\r"
 expect "Initial Multisig Governance Threshold (1)"
 send "\r"
@@ -164,8 +166,7 @@ expect "Enter R, the number of registered candidates seats, as a non-negative in
 send "1\r"
 expect "path to the payment signing key file (/keys/funded_address.skey)"
 send "\r"
-expect "Done. Main chain state is set."
-expect eof
+expect "Done."
 EOF
 
 touch /shared/partner-chains-node-1.ready

docs/user-guides/chain-builder.md

@@ -12,8 +12,8 @@ Partner Chain builders are organizations that want to build their own blockchain
 3. Run the prepare-configuration wizard
     1. Set chain parameters
     2. Provide signing key
-4. Run the create-chain-spec wizard
-5. Run the setup-main-chain-state wizard
+4. Run the setup-main-chain-state wizard
+5. Run the create-chain-spec wizard
 6. Run the start-node wizard
 7. Distribute chain files to participants
 
@@ -334,19 +334,7 @@ A sample file:
 }
 ```
 
-### 4. Run the create-chain-spec wizard
-
-The wizard reads the file `pc-chain-config.json`. This file should be present and identical for every node participating in the chain.
-
-1. Start the wizard: `./partner-chains-node wizards create-chain-spec`
-
-The wizard displays the contents of `chain_parameters` and `initial_permissioned_candidates` from the `pc-chain-config.json` file. You can manually modify these values before running this wizard.
-
-The wizard creates the chain specification file `chain-spec.json` using these values.
-
-The wizard informs you of the full path to the `chain-spec.json` file. You can now distribute this file to block production committee candidates.
-
-### 5. Run the setup-main-chain-state wizard
+### 4. Run the setup-main-chain-state wizard
 
 1. Start the wizard: `./partner-chains-node wizards setup-main-chain-state`
 
@@ -365,6 +353,18 @@ The configuration of the chain is stored in the file `pc-chain-config.json`. Thi
 
 Information about the resources used by each node is stored in the file `partner-chain-cli-resources-config.json`. This file should be present for every node participating in the chain, but its contents are specific to each node.
 
+### 5. Run the create-chain-spec wizard
+
+The wizard reads the file `pc-chain-config.json`. This file should be present and identical for every node participating in the chain.
+
+1. Start the wizard: `./partner-chains-node wizards create-chain-spec`
+
+The wizard displays the contents of `chain_parameters` and `initial_permissioned_candidates` from the `pc-chain-config.json` file. You can manually modify these values before running this wizard.
+
+The wizard creates the chain specification file `chain-spec.json` using these values.
+
+The wizard informs you of the full path to the `chain-spec.json` file. You can now distribute this file to block production committee candidates.
+
 ### 6. Run the partner chain node
 
 The start-node wizard is used to start a partner chain node. Make sure that `cardano-node` is running with DB Sync running and fully synced. You will need to provide a link to a PostgreSQL server running with DB Sync as part of starting the node.

toolkit/partner-chains-cli/src/config.rs

@@ -44,7 +44,7 @@ impl<'a> ConfigFieldDefinition<'a, String> {
 		if let Some(value) = self.load_from_file_and_print(context) {
 			value
 		} else {
-			let value = context.prompt(self.name, self.default);
+			let value = context.prompt(&format!("Enter the {}", self.name), self.default);
 			self.save_to_file(&value, context);
 			value
 		}
@@ -55,8 +55,10 @@ impl<'a> ConfigFieldDefinition<'a, String> {
 		&self,
 		context: &C,
 	) -> String {
-		let value =
-			context.prompt(self.name, self.load_from_file(context).as_deref().or(self.default));
+		let value = context.prompt(
+			&format!("Enter the {}", self.name),
+			self.load_from_file(context).as_deref().or(self.default),
+		);
 		self.save_to_file(&value, context);
 		value
 	}
@@ -72,7 +74,7 @@ impl<'a, T> ConfigFieldDefinition<'a, T> {
 	{
 		let loaded_value = self.load_from_file(context).map(|v| v.to_string());
 		let default_value = loaded_value.as_deref().or(self.default);
-		let value = context.prompt(self.name, default_value);
+		let value = context.prompt(&format!("Enter the {}", self.name), default_value);
 		let parsed_value: T = value.parse()?;
 		self.save_to_file(&parsed_value, context);
 		Ok(parsed_value)
@@ -655,7 +657,7 @@ pub(crate) mod config_fields {
 	> = ConfigFieldDefinition {
 		config_file: CHAIN_CONFIG_FILE_PATH,
 		path: &["initial_governance", "authorities"],
-		name: "Space separated keys hashes of the initial Multisig Governance Authorities",
+		name: "space separated keys hashes of the initial Multisig Governance Authorities",
 		default: Some("[]"),
 		_marker: PhantomData,
 	};

toolkit/partner-chains-cli/src/create_chain_spec/mod.rs

@@ -39,7 +39,6 @@ impl<T: PartnerChainRuntime> CmdRun for CreateChainSpecCmd<T> {
 			context.print(
 				"If you are the governance authority, you can distribute it to the validators.",
 			);
-			context.print("Run 'setup-main-chain-state' command to set D-parameter and permissioned candidates on Cardano.");
 			Ok(())
 		} else {
 			context.print("Aborted.");

toolkit/partner-chains-cli/src/create_chain_spec/tests.rs

@@ -411,8 +411,5 @@ fn show_outro() -> MockIO {
 		MockIO::print(
 			"If you are the governance authority, you can distribute it to the validators.",
 		),
-		MockIO::print(
-			"Run 'setup-main-chain-state' command to set D-parameter and permissioned candidates on Cardano.",
-		),
 	])
 }

toolkit/partner-chains-cli/src/deregister/tests.rs

@@ -140,11 +140,19 @@ fn read_keys_io() -> MockIO {
 }
 
 fn read_payment_signing_key() -> MockIO {
-	MockIO::prompt("path to the payment signing key file", Some("payment.skey"), MY_PAYMEMENT_SKEY)
+	MockIO::prompt(
+		"Enter the path to the payment signing key file",
+		Some("payment.skey"),
+		MY_PAYMEMENT_SKEY,
+	)
 }
 
 fn read_cold_verification_key() -> MockIO {
-	MockIO::prompt("path to the cold verification key file", Some("cold.vkey"), MY_COLD_VKEY)
+	MockIO::prompt(
+		"Enter the path to the cold verification key file",
+		Some("cold.vkey"),
+		MY_COLD_VKEY,
+	)
 }
 
 fn test_chain_config_content() -> serde_json::Value {

toolkit/partner-chains-cli/src/generate_keys/tests.rs

@@ -39,7 +39,7 @@ pub mod scenarios {
 	}
 
 	pub fn prompt_all_config_fields() -> MockIO {
-		MockIO::prompt("node base path", Some("./data"), DATA_PATH)
+		MockIO::prompt("Enter the node base path", Some("./data"), DATA_PATH)
 	}
 
 	pub fn resources_file_content() -> serde_json::Value {

toolkit/partner-chains-cli/src/lib.rs

@@ -55,11 +55,11 @@ pub enum Command<T: PartnerChainRuntime> {
 	GenerateKeys(generate_keys::GenerateKeysCmd),
 	/// Wizard to obtain the configuration needed for the partner-chain governance authority. This configuration should be shared with chain participants and used to create the chain spec json file.
 	PrepareConfiguration(prepare_configuration::PrepareConfigurationCmd),
-	/// Wizard for creating a chain spec json file based on the chain configuration (see `prepare-configuration`).
-	CreateChainSpec(create_chain_spec::CreateChainSpecCmd<T>),
 	/// Wizard for setting D-parameter and Permissioned Candidates list on the main chain.
 	/// Uses 'chain config' obtained after running `prepare-configuration`.
 	SetupMainChainState(setup_main_chain_state::SetupMainChainStateCmd),
+	/// Wizard for creating a chain spec json file based on the chain configuration (see `prepare-configuration`).
+	CreateChainSpec(create_chain_spec::CreateChainSpecCmd<T>),
 	/// Wizard for starting a substrate node in the environment set up by `generate-keys`,
 	/// `prepare-config`, and `create-chain-spec`. It also assists in setting the `resources configuration`.
 	StartNode(start_node::StartNodeCmd),
@@ -107,8 +107,8 @@ const HELP_EXAMPLES: &str = r#"
 ║ Governance Authority:                                                          ║
 ║   1. generate-keys         : generate necessary cryptographic keys             ║
 ║   2. prepare-configuration : set up the partner chain configuration            ║
-║   3. create-chain-spec     : create the chain specification file               ║
-║   4. setup-main-chain-state: configure the main chain parameters               ║
+║   3. setup-main-chain-state: configure the main chain parameters               ║
+║   4. create-chain-spec     : create the chain specification file               ║
 ║   5. start-node            : start the validator node                          ║
 ╟────────────────────────────────────────────────────────────────────────────────╢
 ║ Registered Validator:                                                          ║

toolkit/partner-chains-cli/src/ogmios/config.rs

@@ -16,7 +16,10 @@ pub(crate) fn prompt_ogmios_configuration<C: IOContext>(
 	context: &C,
 ) -> anyhow::Result<ServiceConfig> {
 	let ogmios_protocol = OGMIOS_PROTOCOL
-		.select_options_with_default_from_file_and_save(OGMIOS_PROTOCOL.name, context)
+		.select_options_with_default_from_file_and_save(
+			&format!("Select {}", OGMIOS_PROTOCOL.name),
+			context,
+		)
 		.map_err(anyhow::Error::msg)?;
 	let ogmios_hostname = OGMIOS_HOSTNAME.prompt_with_default_from_file_and_save(context);
 	let ogmios_port = OGMIOS_PORT.prompt_with_default_from_file_parse_and_save(context)?;