Support for generic keys in start-node

Author: LGLO

demo/node/src/cli.rs

@@ -1,9 +1,7 @@
 use clap::command;
 use partner_chains_cli::{AURA, GRANDPA, KeyDefinition};
 use partner_chains_demo_runtime::opaque::SessionKeys;
-use partner_chains_node_commands::{
-	PartnerChainRuntime, PartnerChainsSubcommand, RuntimeTypeWrapper,
-};
+use partner_chains_node_commands::{PartnerChainRuntime, PartnerChainsSubcommand};
 use sc_cli::RunCmd;
 use sp_runtime::AccountId32;
 
@@ -18,9 +16,6 @@ pub struct Cli {
 
 #[derive(Debug, Clone)]
 pub struct WizardBindings;
-impl RuntimeTypeWrapper for WizardBindings {
-	type Runtime = partner_chains_demo_runtime::Runtime;
-}
 
 impl PartnerChainRuntime for WizardBindings {
 	type Keys = SessionKeys;

toolkit/cli/node-commands/src/lib.rs

@@ -12,7 +12,7 @@ use cli_commands::registration_signatures::RegistrationSignaturesCmd;
 use frame_support::sp_runtime::traits::NumberFor;
 use parity_scale_codec::{Decode, Encode};
 use partner_chains_cli::DefaultCmdRunContext;
-pub use partner_chains_cli::{PartnerChainRuntime, RuntimeTypeWrapper};
+pub use partner_chains_cli::PartnerChainRuntime;
 use partner_chains_smart_contracts_commands::SmartContractsCmd;
 use sc_cli::{CliConfiguration, SharedParams, SubstrateCli};
 use sc_service::TaskManager;

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

@@ -30,7 +30,7 @@ use io::*;
 pub use keystore::{AURA, CROSS_CHAIN, GRANDPA, KeyDefinition};
 use partner_chains_cardano_offchain::await_tx::FixedDelayRetries;
 pub use permissioned_candidates::ParsedPermissionedCandidatesKeys;
-pub use runtime_bindings::{PartnerChainRuntime, RuntimeTypeWrapper};
+pub use runtime_bindings::PartnerChainRuntime;
 use std::time::Duration;
 
 #[derive(Clone, Debug, clap::Parser)]
@@ -65,7 +65,7 @@ pub enum Command<T: PartnerChainRuntime + Send + Sync> {
 	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),
+	StartNode(start_node::StartNodeCmd<T>),
 	/// The first step of registering as a committee candidate. Registration is split into three steps to allow the user to use their cold keys on a cold machine.
 	Register1(register::register1::Register1Cmd),
 	/// The second step of registering as a committee candidate, using cold keys.

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

@@ -1,12 +1,6 @@
 use crate::{CreateChainSpecConfig, keystore::KeyDefinition};
 use authority_selection_inherents::MaybeFromCandidateKeys;
 
-/// Trait wrapping Substrate runtime type. Should be implemented for the runtime of the node.
-pub trait RuntimeTypeWrapper {
-	/// Substrate runtime type.
-	type Runtime;
-}
-
 /// Trait defining Partner Chain governance related types.
 pub trait PartnerChainRuntime {
 	/// User keys type

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

@@ -5,14 +5,17 @@ use crate::io::IOContext;
 use crate::keystore::*;
 use crate::{config::config_fields, *};
 use serde::Deserialize;
+use std::marker::PhantomData;
 
 #[cfg(test)]
 mod tests;
 
 #[derive(Clone, Debug, clap::Parser)]
-pub struct StartNodeCmd {
+pub struct StartNodeCmd<T: PartnerChainRuntime> {
 	#[arg(long)]
 	silent: bool,
+	#[clap(skip)]
+	_phantom: PhantomData<T>,
 }
 
 pub struct StartNodeConfig {
@@ -37,11 +40,11 @@ pub struct StartNodeChainConfig {
 	pub bootnodes: Vec<String>,
 }
 
-impl CmdRun for StartNodeCmd {
+impl<T: PartnerChainRuntime> CmdRun for StartNodeCmd<T> {
 	fn run<C: IOContext>(&self, context: &C) -> anyhow::Result<()> {
 		let config = StartNodeConfig::load(context);
 
-		if !check_keystore(&config, context)? || !check_chain_spec(context) {
+		if !check_keystore::<C, T>(&config, context)? || !check_chain_spec(context) {
 			return Ok(());
 		}
 
@@ -56,7 +59,7 @@ impl CmdRun for StartNodeCmd {
 			return Ok(());
 		}
 
-		start_node(config, chain_config, &db_connection_string, context)?;
+		start_node::<C, T>(config, chain_config, &db_connection_string, context)?;
 
 		Ok(())
 	}
@@ -117,11 +120,15 @@ fn check_chain_spec<C: IOContext>(context: &C) -> bool {
 	}
 }
 
-fn check_keystore<C: IOContext>(config: &StartNodeConfig, context: &C) -> anyhow::Result<bool> {
+fn check_keystore<C: IOContext, T: PartnerChainRuntime>(
+	config: &StartNodeConfig,
+	context: &C,
+) -> anyhow::Result<bool> {
 	let existing_keys = context.list_directory(&config.keystore_path())?.unwrap_or_default();
-	Ok(key_present(&AURA, &existing_keys, context)
-		&& key_present(&GRANDPA, &existing_keys, context)
-		&& key_present(&CROSS_CHAIN, &existing_keys, context))
+	Ok(key_present(&CROSS_CHAIN, &existing_keys, context)
+		&& T::key_definitions()
+			.iter()
+			.all(|key_def| key_present(key_def, &existing_keys, context)))
 }
 
 fn key_present<C: IOContext>(key: &KeyDefinition, existing_keys: &[String], context: &C) -> bool {
@@ -136,7 +143,7 @@ fn key_present<C: IOContext>(key: &KeyDefinition, existing_keys: &[String], cont
 	}
 }
 
-pub fn start_node<C: IOContext>(
+pub fn start_node<C: IOContext, T: PartnerChainRuntime>(
 	StartNodeConfig { substrate_node_base_path }: StartNodeConfig,
 	StartNodeChainConfig {
 		cardano:

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

@@ -1,4 +1,6 @@
-use crate::tests::{CHAIN_CONFIG_FILE_PATH, MockIO, MockIOContext, RESOURCES_CONFIG_FILE_PATH};
+use crate::tests::{
+	CHAIN_CONFIG_FILE_PATH, MockIO, MockIOContext, RESOURCES_CONFIG_FILE_PATH, runtime::MockRuntime,
+};
 
 use super::*;
 
@@ -10,9 +12,9 @@ const DB_CONNECTION_STRING: &str =
 fn keystore_path() -> String {
 	format!("{DATA_PATH}/keystore")
 }
-const GRANDPA_PREFIX: &str = "6772616e"; // "gran" in hex
+const ED25_PREFIX: &str = "65643235"; // "ed25" in hex
 const CROSS_CHAIN_PREFIX: &str = "63726368"; // "crch" in hex
-const AURA_PREFIX: &str = "61757261"; // "aura" in hex
+const SR25_PREFIX: &str = "73723235"; // "sr25" in hex
 
 fn default_config() -> StartNodeConfig {
 	StartNodeConfig { substrate_node_base_path: DATA_PATH.into() }
@@ -107,8 +109,8 @@ fn happy_path() {
 		format!(
 			"{CROSS_CHAIN_PREFIX}020a1091341fe5664bfa1782d5e04779689068c916b04cb365ec3153755684d9a1"
 		),
-		format!("{AURA_PREFIX}aura-key"),
-		format!("{GRANDPA_PREFIX}grandpa-key"),
+		format!("{SR25_PREFIX}sr25-key"),
+		format!("{ED25_PREFIX}ed25-key"),
 	];
 
 	let context = MockIOContext::new()
@@ -127,7 +129,7 @@ fn happy_path() {
 			MockIO::run_command(&default_chain_config_run_command(), "irrelevant")
 		]);
 
-	let result = StartNodeCmd { silent: false }.run(&context);
+	let result = StartNodeCmd::<MockRuntime> { silent: false, _phantom: PhantomData }.run(&context);
 
 	result.expect("should succeed");
 	verify_json!(context, RESOURCES_CONFIG_FILE_PATH, expected_final_resources_config_json());
@@ -169,15 +171,15 @@ mod check_keystore {
 	fn passes_when_all_present() {
 		let keystore_files = vec![
 			format!("{CROSS_CHAIN_PREFIX}cross-chain-key"),
-			format!("{AURA_PREFIX}aura-key"),
-			format!("{GRANDPA_PREFIX}grandpa-key"),
+			format!("{SR25_PREFIX}sr25-key"),
+			format!("{ED25_PREFIX}ed25-key"),
 		];
 		#[rustfmt::skip]
 		let context = MockIOContext::new().with_expected_io(vec![
 			MockIO::list_dir(&keystore_path(), Some(keystore_files.clone())),
 		]);
 
-		let result = check_keystore(&default_config(), &context);
+		let result = check_keystore::<MockIOContext, MockRuntime>(&default_config(), &context);
 
 		result.expect("should succeed");
 	}
@@ -186,16 +188,16 @@ mod check_keystore {
 	fn fails_when_one_is_missing() {
 		let keystore_files = vec![
 			format!("{CROSS_CHAIN_PREFIX}cross-chain-key"),
-			format!("{GRANDPA_PREFIX}grandpa-key"),
+			format!("{ED25_PREFIX}grandpa-key"),
 		];
 		let context = MockIOContext::new().with_expected_io(vec![
 			MockIO::list_dir(&keystore_path(), Some(keystore_files.clone())),
 			MockIO::eprint(
-				"⚠️ AURA key is missing from the keystore. Please run generate-keys wizard first.",
+				"⚠️ TestAuraLike key is missing from the keystore. Please run generate-keys wizard first.",
 			),
 		]);
 
-		let result = check_keystore(&default_config(), &context);
+		let result = check_keystore::<MockIOContext, MockRuntime>(&default_config(), &context);
 		let result = result.expect("should succeed");
 		assert!(!result);
 	}