chain spec builder: add generate mode for authority keys (#3811)

* core: use trait object for genesis constructor

* chain-spec-builder: use structopt

* chain-spec-builder: add new command to generate authority keys

* chain-spec-builder: use ? in main

* chain-spec-builder: fix stored and printed suri from seed

* chain-spec-builder: add comment about created keystore folders

* chain-spec-builder: simplify file write

Author: andresilva

Cargo.lock

@@ -20,6 +20,7 @@ use std::borrow::Cow;
 use std::collections::HashMap;
 use std::fs::File;
 use std::path::PathBuf;
+use std::rc::Rc;
 use serde::{Serialize, Deserialize};
 use primitives::storage::{StorageKey, StorageData};
 use sr_primitives::{BuildStorage, StorageOverlay, ChildrenStorageOverlay};
@@ -31,15 +32,15 @@ use tel::TelemetryEndpoints;
 enum GenesisSource<G> {
 	File(PathBuf),
 	Binary(Cow<'static, [u8]>),
-	Factory(fn() -> G),
+	Factory(Rc<dyn Fn() -> G>),
 }
 
 impl<G> Clone for GenesisSource<G> {
 	fn clone(&self) -> Self {
 		match *self {
 			GenesisSource::File(ref path) => GenesisSource::File(path.clone()),
 			GenesisSource::Binary(ref d) => GenesisSource::Binary(d.clone()),
-			GenesisSource::Factory(f) => GenesisSource::Factory(f),
+			GenesisSource::Factory(ref f) => GenesisSource::Factory(f.clone()),
 		}
 	}
 }
@@ -187,10 +188,10 @@ impl<G, E> ChainSpec<G, E> {
 	}
 
 	/// Create hardcoded spec.
-	pub fn from_genesis(
+	pub fn from_genesis<F: Fn() -> G + 'static>(
 		name: &str,
 		id: &str,
-		constructor: fn() -> G,
+		constructor: F,
 		boot_nodes: Vec<String>,
 		telemetry_endpoints: Option<TelemetryEndpoints>,
 		protocol_id: Option<&str>,
@@ -211,7 +212,7 @@ impl<G, E> ChainSpec<G, E> {
 
 		ChainSpec {
 			spec,
-			genesis: GenesisSource::Factory(constructor),
+			genesis: GenesisSource::Factory(Rc::new(constructor)),
 		}
 	}
 }

core/chain-spec/src/chain_spec.rs

@@ -5,7 +5,9 @@ authors = ["Parity Technologies <[email protected]>"]
 edition = "2018"
 
 [dependencies]
-clap = { version = "2.33.0", features = ["yaml"] }
+ansi_term = "0.12.1"
+keystore = { package = "substrate-keystore", path = "../../core/keystore" }
 node-cli = { path = "../../node/cli" }
 primitives = { package = "substrate-primitives",  path = "../../core/primitives" }
-substrate-service = { path = "../../core/service" }
+rand = "0.7.2"
+structopt = "0.3.3"

test-utils/chain-spec-builder/Cargo.toml

@@ -1,49 +1,261 @@
-use clap::{App, load_yaml};
+// Copyright 2019 Parity Technologies (UK) Ltd.
+// This file is part of Substrate.
 
+// Substrate 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.
+
+// Substrate 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 Substrate.  If not, see <http://www.gnu.org/licenses/>.
+
+use std::{fs, path::{Path, PathBuf}};
+
+use ansi_term::Style;
+use rand::{Rng, distributions::Alphanumeric, rngs::OsRng};
+use structopt::StructOpt;
+
+use keystore::{Store as Keystore};
 use node_cli::chain_spec::{self, AccountId};
-use substrate_service::chain_ops::build_spec;
+use primitives::{crypto::{Public, Ss58Codec}, traits::BareCryptoStore};
 
-fn genesis_constructor() -> chain_spec::GenesisConfig {
-	let yaml = load_yaml!("./cli.yml");
-	let matches = App::from_yaml(yaml).get_matches();
-	let authorities = matches.values_of("initial_authority_seed")
-		.unwrap()
-		.map(chain_spec::get_authority_keys_from_seed)
-		.collect();
+/// A utility to easily create a testnet chain spec definition with a given set
+/// of authorities and endowed accounts and/or generate random accounts.
+#[derive(StructOpt)]
+#[structopt(rename_all = "kebab-case")]
+enum ChainSpecBuilder {
+	/// Create a new chain spec with the given authorities, endowed and sudo
+	/// accounts.
+	New {
+		/// Authority key seed.
+		#[structopt(long, short, required = true)]
+		authority_seeds: Vec<String>,
+		/// Endowed account address (SS58 format).
+		#[structopt(long, short)]
+		endowed_accounts: Vec<String>,
+		/// Sudo account address (SS58 format).
+		#[structopt(long, short)]
+		sudo_account: String,
+		/// The path where the chain spec should be saved.
+		#[structopt(long, short, default_value = "./chain_spec.json")]
+		chain_spec_path: PathBuf,
+	},
+	/// Create a new chain spec with the given number of authorities and endowed
+	/// accounts. Random keys will be generated as required.
+	Generate {
+		/// The number of authorities.
+		#[structopt(long, short)]
+		authorities: usize,
+		/// The number of endowed accounts.
+		#[structopt(long, short, default_value = "0")]
+		endowed: usize,
+		/// The path where the chain spec should be saved.
+		#[structopt(long, short, default_value = "./chain_spec.json")]
+		chain_spec_path: PathBuf,
+		/// Path to use when saving generated keystores for each authority.
+		///
+		/// At this path, a new folder will be created for each authority's
+		/// keystore named `auth-$i` where `i` is the authority index, i.e.
+		/// `auth-0`, `auth-1`, etc.
+		#[structopt(long, short)]
+		keystore_path: Option<PathBuf>,
+	},
+}
 
-	let endowed_accounts = matches.values_of("endowed_account_seed")
-		.unwrap()
-		.map(chain_spec::get_from_seed::<AccountId>)
-		.collect();
+impl ChainSpecBuilder {
+	/// Returns the path where the chain spec should be saved.
+	fn chain_spec_path(&self) -> &Path {
+		match self {
+			ChainSpecBuilder::New { chain_spec_path, .. } =>
+				chain_spec_path.as_path(),
+			ChainSpecBuilder::Generate { chain_spec_path, .. } =>
+				chain_spec_path.as_path(),
+		}
+	}
+}
 
-	let sudo_key_seed = matches.value_of("sudo_key_seed").unwrap();
-	let sudo_key = chain_spec::get_from_seed::<AccountId>(sudo_key_seed);
+fn genesis_constructor(
+	authority_seeds: &[String],
+	endowed_accounts: &[AccountId],
+	sudo_account: &AccountId,
+) -> chain_spec::GenesisConfig {
+	let authorities = authority_seeds
+		.iter()
+		.map(AsRef::as_ref)
+		.map(chain_spec::get_authority_keys_from_seed)
+		.collect::<Vec<_>>();
 
 	let enable_println = true;
 
 	chain_spec::testnet_genesis(
 		authorities,
-		sudo_key.into(),
-		Some(endowed_accounts),
+		sudo_account.clone(),
+		Some(endowed_accounts.to_vec()),
 		enable_println,
 	)
 }
 
-fn generate_chain_spec() -> String {
+fn generate_chain_spec(
+	authority_seeds: Vec<String>,
+	endowed_accounts: Vec<String>,
+	sudo_account: String,
+) -> Result<String, String> {
+	let parse_account = |address: &String| {
+		AccountId::from_string(address)
+			.map_err(|err| format!("Failed to parse account address: {:?}", err))
+	};
+
+	let endowed_accounts = endowed_accounts
+		.iter()
+		.map(parse_account)
+		.collect::<Result<Vec<_>, String>>()?;
+
+	let sudo_account = parse_account(&sudo_account)?;
+
 	let chain_spec = chain_spec::ChainSpec::from_genesis(
 		"Custom",
 		"custom",
-		genesis_constructor,
+		move || genesis_constructor(&authority_seeds, &endowed_accounts, &sudo_account),
 		vec![],
 		None,
 		None,
 		None,
 		Default::default(),
 	);
-	build_spec(chain_spec, false).unwrap()
+
+	chain_spec.to_json(false).map_err(|err| err.to_string())
+}
+
+fn generate_authority_keys_and_store(
+	seeds: &[String],
+	keystore_path: &Path,
+) -> Result<(), String> {
+	for (n, seed) in seeds.into_iter().enumerate() {
+		let keystore = Keystore::open(
+			keystore_path.join(format!("auth-{}", n)),
+			None,
+		).map_err(|err| err.to_string())?;
+
+		let (_, _, grandpa, babe, im_online) =
+			chain_spec::get_authority_keys_from_seed(seed);
+
+		let insert_key = |key_type, public| {
+			keystore.write().insert_unknown(
+				key_type,
+				&format!("//{}", seed),
+				public,
+			).map_err(|_| format!("Failed to insert key: {}", grandpa))
+		};
+
+		insert_key(
+			primitives::crypto::key_types::BABE,
+			babe.as_slice(),
+		)?;
+
+		insert_key(
+			primitives::crypto::key_types::GRANDPA,
+			grandpa.as_slice(),
+		)?;
+
+		insert_key(
+			primitives::crypto::key_types::IM_ONLINE,
+			im_online.as_slice(),
+		)?;
+	}
+
+	Ok(())
+}
+
+fn print_seeds(
+	authority_seeds: &[String],
+	endowed_seeds: &[String],
+	sudo_seed: &str,
+) {
+	let header = Style::new().bold().underline();
+	let entry = Style::new().bold();
+
+	println!("{}", header.paint("Authority seeds"));
+
+	for (n, seed) in authority_seeds.iter().enumerate() {
+		println!("{} //{}",
+			entry.paint(format!("auth-{}:", n)),
+			seed,
+		);
+	}
+
+	println!();
+
+	if !endowed_seeds.is_empty() {
+		println!("{}", header.paint("Endowed seeds"));
+		for (n, seed) in endowed_seeds.iter().enumerate() {
+			println!("{} //{}",
+				entry.paint(format!("endowed-{}:", n)),
+				seed,
+			);
+		}
+
+		println!();
+	}
+
+	println!("{}", header.paint("Sudo seed"));
+	println!("//{}", sudo_seed);
 }
 
-fn main() {
-	let json = generate_chain_spec();
-	println!("{}", json);
+fn main() -> Result<(), String> {
+	let builder = ChainSpecBuilder::from_args();
+	let chain_spec_path = builder.chain_spec_path().to_path_buf();
+
+	let (authority_seeds, endowed_accounts, sudo_account) = match builder {
+		ChainSpecBuilder::Generate { authorities, endowed, keystore_path, .. } => {
+			let authorities = authorities.max(1);
+			let rand_str = || -> String {
+				OsRng.sample_iter(&Alphanumeric)
+					.take(32)
+					.collect()
+			};
+
+			let authority_seeds = (0..authorities).map(|_| rand_str()).collect::<Vec<_>>();
+			let endowed_seeds = (0..endowed).map(|_| rand_str()).collect::<Vec<_>>();
+			let sudo_seed = rand_str();
+
+			print_seeds(
+				&authority_seeds,
+				&endowed_seeds,
+				&sudo_seed,
+			);
+
+			if let Some(keystore_path) = keystore_path {
+				generate_authority_keys_and_store(
+					&authority_seeds,
+					&keystore_path,
+				)?;
+			}
+
+			let endowed_accounts = endowed_seeds.iter().map(|seed| {
+				chain_spec::get_from_seed::<AccountId>(seed)
+					.to_ss58check()
+			}).collect();
+
+			let sudo_account = chain_spec::get_from_seed::<AccountId>(&sudo_seed)
+				.to_ss58check();
+
+			(authority_seeds, endowed_accounts, sudo_account)
+		},
+		ChainSpecBuilder::New { authority_seeds, endowed_accounts, sudo_account, .. } => {
+			(authority_seeds, endowed_accounts, sudo_account)
+		},
+	};
+
+	let json = generate_chain_spec(
+		authority_seeds,
+		endowed_accounts,
+		sudo_account,
+	)?;
+
+	fs::write(chain_spec_path, json).map_err(|err| err.to_string())
 }