Merge Subkey into sc-cli

Cargo.toml

@@ -180,6 +180,7 @@ members = [
 	"utils/build-script-utils",
 	"utils/fork-tree",
 	"utils/frame/benchmarking-cli",
+	"utils/frame/frame-utilities-cli",
 	"utils/frame/rpc/support",
 	"utils/frame/rpc/system",
 	"utils/wasm-builder",

bin/node-template/node/src/cli.rs

@@ -1,5 +1,5 @@
-use sc_cli::{RunCmd, Subcommand};
 use structopt::StructOpt;
+use sc_cli::{RunCmd, Subcommand};
 
 #[derive(Debug, StructOpt)]
 pub struct Cli {

bin/node-template/node/src/command.rs

@@ -66,8 +66,8 @@ impl SubstrateCli for Cli {
 pub fn run() -> sc_cli::Result<()> {
 	let cli = Cli::from_args();
 
-	match &cli.subcommand {
-		Some(subcommand) => {
+	match cli.subcommand {
+		Some(ref subcommand) => {
 			let runner = cli.create_runner(subcommand)?;
 			runner.run_subcommand(subcommand, |config| {
 				let PartialComponents { client, backend, task_manager, import_queue, .. }

bin/node/cli/Cargo.toml

@@ -131,6 +131,7 @@ structopt = { version = "0.3.8", optional = true }
 node-inspect = { version = "0.8.0-rc5", optional = true, path = "../inspect" }
 frame-benchmarking-cli = { version = "2.0.0-rc5", optional = true, path = "../../../utils/frame/benchmarking-cli" }
 substrate-build-script-utils = { version = "2.0.0-rc5", optional = true, path = "../../../utils/build-script-utils" }
+substrate-frame-cli = { version = "2.0.0-rc5", optional = true, path = "../../../utils/frame/frame-utilities-cli" }
 
 [build-dependencies.sc-cli]
 version = "0.8.0-rc5"
@@ -150,6 +151,7 @@ cli = [
 	"node-inspect",
 	"sc-cli",
 	"frame-benchmarking-cli",
+	"substrate-frame-cli",
 	"sc-service/db",
 	"structopt",
 	"substrate-build-script-utils",

bin/node/cli/src/cli.rs

@@ -16,7 +16,7 @@
 // You should have received a copy of the GNU General Public License
 // along with this program. If not, see <https://www.gnu.org/licenses/>.
 
-use sc_cli::RunCmd;
+use sc_cli::{RunCmd, KeySubcommand, SignCmd, VanityCmd, VerifyCmd};
 use structopt::StructOpt;
 
 /// An overarching CLI command definition.
@@ -37,6 +37,9 @@ pub enum Subcommand {
 	#[structopt(flatten)]
 	Base(sc_cli::Subcommand),
 
+	/// Key management cli utilities
+	Key(KeySubcommand),
+
 	/// The custom inspect subcommmand for decoding blocks and extrinsics.
 	#[structopt(
 		name = "inspect",
@@ -47,4 +50,13 @@ pub enum Subcommand {
 	/// The custom benchmark subcommmand benchmarking runtime pallets.
 	#[structopt(name = "benchmark", about = "Benchmark runtime pallets.")]
 	Benchmark(frame_benchmarking_cli::BenchmarkCmd),
+
+	/// Verify a signature for a message, provided on STDIN, with a given (public or secret) key.
+	Verify(VerifyCmd),
+
+	/// Generate a seed that provides a vanity address.
+	Vanity(VanityCmd),
+
+	/// Sign a message, with a given (secret) key.
+	Sign(SignCmd),
 }

bin/node/cli/src/command.rs

@@ -93,6 +93,10 @@ pub fn run() -> Result<()> {
 				Ok(())
 			}
 		}
+		Some(Subcommand::Key(cmd)) => cmd.run(),
+		Some(Subcommand::Sign(cmd)) => cmd.run(),
+		Some(Subcommand::Verify(cmd)) => cmd.run(),
+		Some(Subcommand::Vanity(cmd)) => cmd.run(),
 		Some(Subcommand::Base(subcommand)) => {
 			let runner = cli.create_runner(subcommand)?;
 			runner.run_subcommand(subcommand, |config| {

bin/node/runtime/src/lib.rs

@@ -83,6 +83,7 @@ use impls::{CurrencyToVoteHandler, Author};
 /// Constant values used within the runtime.
 pub mod constants;
 use constants::{time::*, currency::*};
+use sp_runtime::generic::Era;
 
 /// Weights for pallets used in the runtime.
 mod weights;
@@ -654,16 +655,17 @@ parameter_types! {
 	pub const StakingUnsignedPriority: TransactionPriority = TransactionPriority::max_value() / 2;
 }
 
-
-impl<LocalCall> frame_system::offchain::CreateSignedTransaction<LocalCall> for Runtime where
-	Call: From<LocalCall>,
+impl<LocalCall> frame_system::offchain::CreateSignedTransaction<LocalCall> for Runtime
+	where
+		Call: From<LocalCall>,
 {
 	fn create_transaction<C: frame_system::offchain::AppCrypto<Self::Public, Self::Signature>>(
 		call: Call,
 		public: <Signature as traits::Verify>::Signer,
 		account: AccountId,
 		nonce: Index,
 	) -> Option<(Call, <UncheckedExtrinsic as traits::Extrinsic>::SignaturePayload)> {
+		let tip = 0;
 		// take the biggest period possible.
 		let period = BlockHashCount::get()
 			.checked_next_power_of_two()
@@ -674,22 +676,25 @@ impl<LocalCall> frame_system::offchain::CreateSignedTransaction<LocalCall> for R
 			// The `System::block_number` is initialized with `n+1`,
 			// so the actual block number is `n`.
 			.saturating_sub(1);
-		let tip = 0;
-		let extra: SignedExtra = (
+		let era = Era::mortal(period, current_block);
+		let extra = (
 			frame_system::CheckSpecVersion::<Runtime>::new(),
 			frame_system::CheckTxVersion::<Runtime>::new(),
 			frame_system::CheckGenesis::<Runtime>::new(),
-			frame_system::CheckEra::<Runtime>::from(generic::Era::mortal(period, current_block)),
+			frame_system::CheckEra::<Runtime>::from(era),
 			frame_system::CheckNonce::<Runtime>::from(nonce),
 			frame_system::CheckWeight::<Runtime>::new(),
 			pallet_transaction_payment::ChargeTransactionPayment::<Runtime>::from(tip),
 		);
-		let raw_payload = SignedPayload::new(call, extra).map_err(|e| {
-			debug::warn!("Unable to create signed payload: {:?}", e);
-		}).ok()?;
-		let signature = raw_payload.using_encoded(|payload| {
-			C::sign(payload, public)
-		})?;
+		let raw_payload = SignedPayload::new(call, extra)
+			.map_err(|e| {
+				debug::warn!("Unable to create signed payload: {:?}", e);
+			})
+			.ok()?;
+		let signature = raw_payload
+			.using_encoded(|payload| {
+				C::sign(payload, public)
+			})?;
 		let address = Indices::unlookup(account);
 		let (call, extra, _) = raw_payload.deconstruct();
 		Some((call, (address, signature.into(), extra)))

bin/utils/subkey/Cargo.toml

@@ -7,34 +7,21 @@ license = "GPL-3.0-or-later WITH Classpath-exception-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 
+[[bin]]
+path = "src/main.rs"
+name = "subkey"
+
 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
 
 [dependencies]
-futures = "0.1.29"
-sp-core = { version = "2.0.0-rc5", path = "../../../primitives/core" }
 node-runtime = { version = "2.0.0-rc5", path = "../../node/runtime" }
 node-primitives = { version = "2.0.0-rc5", path = "../../node/primitives" }
-sp-runtime = { version = "2.0.0-rc5", path = "../../../primitives/runtime" }
-rand = "0.7.2"
-clap = "2.33.0"
-tiny-bip39 = "0.7"
-substrate-bip39 = "0.4.1"
-hex = "0.4.0"
-hex-literal = "0.2.1"
-codec = { package = "parity-scale-codec", version = "1.3.4" }
+sc-cli = { version = "0.8.0-rc5", path = "../../../client/cli" }
+substrate-frame-cli = { version = "2.0.0-rc5", path = "../../../utils/frame/frame-utilities-cli" }
+structopt = "0.3.14"
 frame-system = { version = "2.0.0-rc5", path = "../../../frame/system" }
-pallet-balances = { version = "2.0.0-rc5", path = "../../../frame/balances" }
-pallet-transaction-payment = { version = "2.0.0-rc5", path = "../../../frame/transaction-payment" }
-pallet-grandpa = { version = "2.0.0-rc5", path = "../../../frame/grandpa" }
-rpassword = "4.0.1"
-itertools = "0.8.2"
-derive_more = { version = "0.99.2" }
-sc-rpc = { version = "2.0.0-rc5", path = "../../../client/rpc" }
-jsonrpc-core-client = { version = "14.2.0", features = ["http"] }
-hyper = "0.12.35"
-libp2p = { version = "0.23.0", default-features = false }
-serde_json = "1.0"
+sp-core = { version = "2.0.0-rc5", path = "../../../primitives/core" }
 
 [features]
 bench = []

bin/utils/subkey/README.adoc

@@ -31,7 +31,7 @@ OUTPUT:
 `subkey` expects a message to come in on STDIN, one way to sign a message would look like this:
 
 ```bash
-echo -n <msg> | subkey sign <seed,mnemonic>
+echo -n <msg> | subkey sign --suri <seed,mnemonic>
 
 OUTPUT:
 a69da4a6ccbf81dbbbfad235fa12cf8528c18012b991ae89214de8d20d29c1280576ced6eb38b7406d1b7e03231df6dd4a5257546ddad13259356e1c3adfb509
@@ -72,7 +72,7 @@ Will output a signed and encoded `UncheckedMortalCompactExtrinsic` as hex.
 === Inspecting a module ID
 
 ```bash
-subkey --network kusama moduleid "py/trsry"
+subkey module-id "py/trsry" --network kusama
 
 OUTPUT:
 Public Key URI `F3opxRbN5ZbjJNU511Kj2TLuzFcDq9BGduA9TgiECafpg29` is account:

bin/utils/subkey/src/lib.rs

@@ -0,0 +1,81 @@
+// This file is part of Substrate.
+
+// Copyright (C) 2018-2020 Parity Technologies (UK) Ltd.
+// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0
+
+// This program 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.
+
+// This program 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 this program. If not, see <https://www.gnu.org/licenses/>.
+
+use structopt::StructOpt;
+use sc_cli::{
+	Error, VanityCmd, SignCmd, VerifyCmd, InsertCmd,
+	GenerateNodeKeyCmd, GenerateCmd, InspectCmd, InspectNodeKeyCmd
+};
+use substrate_frame_cli::ModuleIdCmd;
+use sp_core::crypto::Ss58Codec;
+
+#[derive(Debug, StructOpt)]
+#[structopt(
+	name = "subkey",
+	author = "Parity Team <admin@parity.io>",
+	about = "Utility for generating and restoring with Substrate keys",
+)]
+pub enum Subkey {
+	/// Generate a random node libp2p key, save it to file and print its peer ID
+	GenerateNodeKey(GenerateNodeKeyCmd),
+
+	/// Generate a random account
+	Generate(GenerateCmd),
+
+	/// Gets a public key and a SS58 address from the provided Secret URI
+	InspectKey(InspectCmd),
+
+	/// Print the peer ID corresponding to the node key in the given file
+	InspectNodeKey(InspectNodeKeyCmd),
+
+	/// Insert a key to the keystore of a node.
+	Insert(InsertCmd),
+
+	/// Inspect a module ID address
+	ModuleId(ModuleIdCmd),
+
+	/// Sign a message, with a given (secret) key.
+	Sign(SignCmd),
+
+	/// Generate a seed that provides a vanity address.
+	Vanity(VanityCmd),
+
+	/// Verify a signature for a message, provided on STDIN, with a given (public or secret) key.
+	Verify(VerifyCmd),
+}
+
+/// Run the subkey command, given the apropriate runtime.
+pub fn run<R>() -> Result<(), Error>
+	where
+		R: frame_system::Trait,
+		R::AccountId: Ss58Codec
+{
+	match Subkey::from_args() {
+		Subkey::GenerateNodeKey(cmd) => cmd.run()?,
+		Subkey::Generate(cmd) => cmd.run()?,
+		Subkey::InspectKey(cmd) => cmd.run()?,
+		Subkey::InspectNodeKey(cmd) => cmd.run()?,
+		Subkey::Insert(cmd) => cmd.run()?,
+		Subkey::ModuleId(cmd) => cmd.run::<R>()?,
+		Subkey::Vanity(cmd) => cmd.run()?,
+		Subkey::Verify(cmd) => cmd.run()?,
+		Subkey::Sign(cmd) => cmd.run()?,
+	};
+
+	Ok(())
+}