Inspection extension to node CLI (paritytech#4697)

* Initial inspect. * WiP * Add parsing tests. * Finalize CLI. * Update to latest substrate. * Remove unused imports. * Support ImportParams as well, to get the right pruning setting. * Mention in docs that hash is no 0x. * Move bytes above extrinsics. * Switch to fill helper from sc_cli. * Remove overwrite. * Fix error. * Fix error message. * Remove extra allow. * init_config
niklaslong · Feb 18, 2020 · d9952dd · d9952dd
1 parent c1a03a6
commit d9952dd
Show file tree

Hide file tree

Showing 11 changed files with 517 additions and 11 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/bin/node/cli/Cargo.toml b/bin/node/cli/Cargo.toml
@@ -90,6 +90,7 @@ node-executor = { version = "2.0.0", path = "../executor" }
 # CLI-specific dependencies
 sc-cli = { version = "0.8.0", optional = true, path = "../../../client/cli" }
 node-transaction-factory = { version = "0.8.0", optional = true, path = "../transaction-factory" }
+node-inspect = { version = "0.8.0", optional = true, path = "../inspect" }
 
 # WASM-specific dependencies
 wasm-bindgen = { version = "0.2.57", optional = true }
@@ -110,6 +111,7 @@ nix = "0.17"
 build-script-utils = { version = "2.0.0", package = "substrate-build-script-utils", path = "../../../utils/build-script-utils" }
 structopt = { version = "0.3.8", optional = true }
 node-transaction-factory = { version = "0.8.0", optional = true, path = "../transaction-factory" }
+node-inspect = { version = "0.8.0", optional = true, path = "../inspect" }
 
 [build-dependencies.sc-cli]
 version = "0.8.0"
@@ -129,12 +131,13 @@ browser = [
 	"wasm-bindgen-futures",
 ]
 cli = [
-	"sc-cli",
+	"node-executor/wasmi-errno",
+	"node-inspect",
 	"node-transaction-factory",
+	"sc-cli",
 	"sc-service/rocksdb",
-	"node-executor/wasmi-errno",
-	"vergen",
 	"structopt",
+	"vergen",
 ]
 wasmtime = [
 	"cli",

diff --git a/bin/node/cli/src/cli.rs b/bin/node/cli/src/cli.rs
@@ -17,26 +17,26 @@
 use sc_cli::{SharedParams, ImportParams, RunCmd};
 use structopt::StructOpt;
 
-#[allow(missing_docs)]
+/// An overarching CLI command definition.
 #[derive(Clone, Debug, StructOpt)]
 #[structopt(settings = &[
 	structopt::clap::AppSettings::GlobalVersion,
 	structopt::clap::AppSettings::ArgsNegateSubcommands,
 	structopt::clap::AppSettings::SubcommandsNegateReqs,
 ])]
 pub struct Cli {
-	#[allow(missing_docs)]
+	/// Possible subcommand with parameters.
 	#[structopt(subcommand)]
 	pub subcommand: Option<Subcommand>,
 	#[allow(missing_docs)]
 	#[structopt(flatten)]
 	pub run: RunCmd,
 }
 
-#[allow(missing_docs)]
+/// Possible subcommands of the main binary.
 #[derive(Clone, Debug, StructOpt)]
 pub enum Subcommand {
-	#[allow(missing_docs)]
+	/// A set of base subcommands handled by `sc_cli`.
 	#[structopt(flatten)]
 	Base(sc_cli::Subcommand),
 	/// The custom factory subcommmand for manufacturing transactions.
@@ -46,6 +46,13 @@ pub enum Subcommand {
 		Only supported for development or local testnet."
 	)]
 	Factory(FactoryCmd),
+
+	/// The custom inspect subcommmand for decoding blocks and extrinsics.
+	#[structopt(
+		name = "inspect",
+		about = "Decode given block or extrinsic using current native runtime."
+	)]
+	Inspect(node_inspect::cli::InspectCmd),
 }
 
 /// The `factory` command used to generate transactions.

diff --git a/bin/node/cli/src/command.rs b/bin/node/cli/src/command.rs
@@ -39,6 +39,16 @@ where
 			load_spec,
 			&version,
 		),
+		Some(Subcommand::Inspect(cmd)) => {
+			cmd.init(&mut config, load_spec, &version)?;
+
+			let client = sc_service::new_full_client::<
+				node_runtime::Block,node_runtime::RuntimeApi, node_executor::Executor, _, _,
+			>(&config)?;
+			let inspect = node_inspect::Inspector::<node_runtime::Block>::new(client);
+
+			cmd.run(inspect)
+		},
 		Some(Subcommand::Factory(cli_args)) => {
 			sc_cli::init(&cli_args.shared_params, &version)?;
 			sc_cli::init_config(&mut config, &cli_args.shared_params, &version, load_spec)?;

diff --git a/bin/node/cli/src/lib.rs b/bin/node/cli/src/lib.rs
@@ -27,7 +27,6 @@
 //! hasn't been tested.
 
 #![warn(missing_docs)]
-#![warn(unused_extern_crates)]
 
 pub mod chain_spec;
 

diff --git a/bin/node/inspect/Cargo.toml b/bin/node/inspect/Cargo.toml
@@ -0,0 +1,17 @@
+[package]
+name = "node-inspect"
+version = "0.8.0"
+authors = ["Parity Technologies <[email protected]>"]
+edition = "2018"
+
+[dependencies]
+codec = { package = "parity-scale-codec", version = "1.0.0" }
+derive_more = "0.99"
+log = "0.4.8"
+sc-cli = { version = "0.8.0", path = "../../../client/cli" }
+sc-client-api = { version = "2.0.0", path = "../../../client/api" }
+sc-service = { version = "0.8", default-features = false, path = "../../../client/service" }
+sp-blockchain = { version = "2.0.0", path = "../../../primitives/blockchain" }
+sp-core = { version = "2.0.0", path = "../../../primitives/core" }
+sp-runtime = { version = "2.0.0", path = "../../../primitives/runtime" }
+structopt = "0.3.8"