Added doc and fixed warnings

Author: cecton

client/cli-derive/src/lib.rs

@@ -16,8 +16,6 @@
 
 //! Configuration trait for a CLI based on substrate
 
-extern crate proc_macro;
-
 mod spec_factory;
 mod substrate_cli_params;
 

client/cli/src/commands/build_spec_cmd.rs

@@ -14,16 +14,14 @@
 // You should have received a copy of the GNU General Public License
 // along with Substrate.  If not, see <http://www.gnu.org/licenses/>.
 
-use log::info;
-use sc_network::config::build_multiaddr;
-use sc_service::{ChainSpec, ChainSpecExtension, Configuration, RuntimeGenesis};
-use structopt::StructOpt;
-
 use crate::error;
 use crate::params::NodeKeyParams;
 use crate::params::SharedParams;
-use crate::SubstrateCLI;
 use crate::{substrate_cli_params, CliConfiguration};
+use log::info;
+use sc_network::config::build_multiaddr;
+use sc_service::{ChainSpecExtension, Configuration, RuntimeGenesis};
+use structopt::StructOpt;
 
 /// The `build-spec` command used to build a specification.
 #[derive(Debug, StructOpt, Clone)]

client/cli/src/commands/check_block_cmd.rs

@@ -15,7 +15,7 @@
 // along with Substrate.  If not, see <http://www.gnu.org/licenses/>.
 
 use sc_service::{
-	ChainSpec, ChainSpecExtension, Configuration, Roles, RuntimeGenesis, ServiceBuilderCommand,
+	ChainSpecExtension, Configuration, RuntimeGenesis, ServiceBuilderCommand,
 };
 use sp_runtime::generic::BlockId;
 use sp_runtime::traits::{Block as BlockT, Header as HeaderT};

client/cli/src/commands/export_blocks_cmd.rs

@@ -19,8 +19,8 @@ use crate::params::{BlockNumber, PruningParams, SharedParams};
 use crate::{substrate_cli_params, CliConfiguration};
 use log::info;
 use sc_service::{
-	config::DatabaseConfig, ChainSpec, ChainSpecExtension, Configuration, PruningMode, Roles,
-	RuntimeGenesis, ServiceBuilderCommand,
+	config::DatabaseConfig, ChainSpecExtension, Configuration, RuntimeGenesis,
+	ServiceBuilderCommand,
 };
 use sp_runtime::traits::{Block as BlockT, Header as HeaderT};
 use std::fmt::Debug;

client/cli/src/commands/import_blocks_cmd.rs

@@ -19,7 +19,7 @@ use crate::params::ImportParams;
 use crate::params::SharedParams;
 use crate::{substrate_cli_params, CliConfiguration};
 use sc_service::{
-	ChainSpec, ChainSpecExtension, Configuration, Roles, RuntimeGenesis, ServiceBuilderCommand,
+	ChainSpecExtension, Configuration, RuntimeGenesis, ServiceBuilderCommand,
 };
 use sp_runtime::traits::{Block as BlockT, Header as HeaderT};
 use std::fmt::Debug;

client/cli/src/commands/mod.rs

@@ -33,21 +33,15 @@ use crate::params::SharedParams;
 use crate::CliConfiguration;
 use crate::Result;
 use crate::SubstrateCLI;
-use app_dirs::{AppDataType, AppInfo};
-use core::future::Future;
-use core::pin::Pin;
 use sc_client_api::execution_extensions::ExecutionStrategies;
 use sc_network::config::NodeKeyConfig;
 use sc_service::{
-	config::DatabaseConfig, config::KeystoreConfig, config::NetworkConfiguration,
-	config::WasmExecutionMethod, ChainSpec, ChainSpecExtension, Configuration, PruningMode, Roles,
-	RuntimeGenesis, ServiceBuilderCommand,
+	config::DatabaseConfig, config::WasmExecutionMethod, ChainSpec, ChainSpecExtension, PruningMode,
+	Roles, RuntimeGenesis,
 };
 use sc_tracing::TracingReceiver;
-use sp_runtime::traits::{Block as BlockT, Header as HeaderT};
 use std::fmt::Debug;
 use std::path::PathBuf;
-use std::sync::Arc;
 use structopt::StructOpt;
 
 /// All core commands that are provided by default.

client/cli/src/commands/purge_chain_cmd.rs

@@ -18,7 +18,7 @@ use crate::error;
 use crate::params::SharedParams;
 use crate::{substrate_cli_params, CliConfiguration};
 use sc_service::{
-	config::DatabaseConfig, ChainSpec, ChainSpecExtension, Configuration, RuntimeGenesis,
+	config::DatabaseConfig, ChainSpecExtension, Configuration, RuntimeGenesis,
 };
 use std::fmt::Debug;
 use std::fs;

client/cli/src/commands/revert_cmd.rs

@@ -15,7 +15,7 @@
 // along with Substrate.  If not, see <http://www.gnu.org/licenses/>.
 
 use sc_service::{
-	ChainSpec, ChainSpecExtension, Configuration, Roles, RuntimeGenesis, ServiceBuilderCommand,
+	ChainSpecExtension, Configuration, RuntimeGenesis, ServiceBuilderCommand,
 };
 use sp_runtime::traits::{Block as BlockT, Header as HeaderT};
 use std::fmt::Debug;

client/cli/src/commands/runcmd.rs

@@ -21,26 +21,11 @@ use crate::params::NetworkConfigurationParams;
 use crate::params::SharedParams;
 use crate::params::TransactionPoolParams;
 use crate::substrate_cli_params;
-use crate::{CliConfiguration, SubstrateCLI};
+use crate::CliConfiguration;
 use regex::Regex;
-use sc_client_api::execution_extensions::ExecutionStrategies;
-use sc_network::config::NodeKeyConfig;
-use sc_service::{
-	config::{
-		DatabaseConfig, KeystoreConfig, NetworkConfiguration, TransactionPoolOptions,
-		WasmExecutionMethod,
-	},
-	AbstractService, ChainSpec, ChainSpecExtension, Configuration, PruningMode, Roles,
-	RuntimeGenesis,
-};
+use sc_service::{config::TransactionPoolOptions, ChainSpec, Roles};
 use sc_telemetry::TelemetryEndpoints;
-use sc_tracing::TracingReceiver;
-use std::fs;
-use std::future::Future;
 use std::net::SocketAddr;
-use std::path::PathBuf;
-use std::pin::Pin;
-use std::sync::Arc;
 use structopt::{clap::arg_enum, StructOpt};
 
 arg_enum! {
@@ -242,6 +227,7 @@ pub struct RunCmd {
 	#[structopt(long = "force-authoring")]
 	pub force_authoring: bool,
 
+	#[allow(missing_docs)]
 	#[structopt(flatten)]
 	pub keystore_params: KeystoreParams,
 }

client/cli/src/config.rs

@@ -38,21 +38,27 @@ pub(crate) const NODE_NAME_MAX_LENGTH: usize = 32;
 /// default sub directory to store network config
 pub(crate) const DEFAULT_NETWORK_CONFIG_PATH: &'static str = "network";
 
+/// A trait that allows converting an object to a Configuration
 pub trait CliConfiguration: Sized {
+	/// Get the base path of the configuration (if any)
 	fn get_base_path(&self) -> Result<Option<&PathBuf>>;
 
+	/// Returns `true` if the node is for development or not
 	fn get_is_dev(&self) -> Result<bool> {
 		Ok(false)
 	}
 
+	/// Get the roles
 	fn get_roles(&self, _is_dev: bool) -> Result<Roles> {
 		Ok(Roles::FULL)
 	}
 
+	/// Get the transaction pool options
 	fn get_transaction_pool(&self) -> Result<TransactionPoolOptions> {
 		Ok(Default::default())
 	}
 
+	/// Get the network configuration
 	fn get_network_config<G, E>(
 		&self,
 		_chain_spec: &ChainSpec<G, E>,
@@ -74,117 +80,143 @@ pub trait CliConfiguration: Sized {
 		))
 	}
 
+	/// Get the keystore configuration
 	fn get_keystore_config(&self, _base_path: &PathBuf) -> Result<KeystoreConfig> {
 		Ok(KeystoreConfig::InMemory)
 	}
 
+	/// Get the database cache size (None for default)
 	fn get_database_cache_size(&self) -> Result<Option<usize>> {
 		Ok(Default::default())
 	}
 
+	/// Get the database configuration
 	fn get_database_config(
 		&self,
 		base_path: &PathBuf,
 		cache_size: Option<usize>,
 	) -> Result<DatabaseConfig>;
 
+	/// Get the state cache size
 	fn get_state_cache_size(&self) -> Result<usize> {
 		Ok(Default::default())
 	}
 
+	/// Get the state cache child ratio (if any)
 	fn get_state_cache_child_ratio(&self) -> Result<Option<usize>> {
 		Ok(Default::default())
 	}
 
+	/// Get the pruning mode
 	fn get_pruning(&self, _is_dev: bool, _roles: Roles) -> Result<PruningMode> {
 		Ok(Default::default())
 	}
 
+	/// Get the chain spec
 	fn get_chain_spec<C: SubstrateCLI<G, E>, G, E>(&self) -> Result<ChainSpec<G, E>>
 	where
 		G: RuntimeGenesis,
 		E: ChainSpecExtension;
 
+	/// Get the name of the node
 	fn get_node_name(&self) -> Result<String> {
 		Ok(generate_node_name())
 	}
 
+	/// Get the WASM execution method
 	fn get_wasm_method(&self) -> Result<WasmExecutionMethod> {
 		Ok(Default::default())
 	}
 
+	/// Get the execution strategies
 	fn get_execution_strategies(&self, _is_dev: bool) -> Result<ExecutionStrategies> {
 		Ok(Default::default())
 	}
 
+	/// Get the RPC HTTP address (`None` if disabled)
 	fn get_rpc_http(&self) -> Result<Option<SocketAddr>> {
 		Ok(Default::default())
 	}
 
+	/// Get the RPC websocket address (`None` if disabled)
 	fn get_rpc_ws(&self) -> Result<Option<SocketAddr>> {
 		Ok(Default::default())
 	}
 
+	/// Get the RPC websockets maximum connections (`None` if unlimited)
 	fn get_rpc_ws_max_connections(&self) -> Result<Option<usize>> {
 		Ok(Default::default())
 	}
 
+	/// Get the RPC cors (`None` if disabled)
 	fn get_rpc_cors(&self, _is_dev: bool) -> Result<Option<Vec<String>>> {
 		Ok(Some(Vec::new()))
 	}
 
+	/// Get the prometheus port (`None` if disabled)
 	fn get_prometheus_port(&self) -> Result<Option<SocketAddr>> {
 		Ok(Default::default())
 	}
 
+	/// Get the telemetry endpoints (if any)
 	fn get_telemetry_endpoints<G, E>(
 		&self,
 		chain_spec: &ChainSpec<G, E>,
 	) -> Result<Option<TelemetryEndpoints>> {
 		Ok(chain_spec.telemetry_endpoints().clone())
 	}
 
+	/// Get the telemetry external transport
 	fn get_telemetry_external_transport(&self) -> Result<Option<ExtTransport>> {
 		Ok(Default::default())
 	}
 
+	/// Get the default value for heap pages
 	fn get_default_heap_pages(&self) -> Result<Option<u64>> {
 		Ok(Default::default())
 	}
 
+	/// Returns `Ok(true)` if offchain worker should be used
 	fn get_offchain_worker(&self, _roles: Roles) -> Result<bool> {
 		Ok(Default::default())
 	}
 
-	/// set sentry mode (i.e. act as an authority but **never** actively participate)
+	/// Get sentry mode (i.e. act as an authority but **never** actively participate)
 	fn get_sentry_mode(&self) -> Result<bool> {
 		Ok(Default::default())
 	}
 
+	/// Returns `Ok(true)` if authoring should be forced
 	fn get_force_authoring(&self) -> Result<bool> {
 		Ok(Default::default())
 	}
 
+	/// Returns `Ok(true)` if grandpa should be disabled
 	fn get_disable_grandpa(&self) -> Result<bool> {
 		Ok(Default::default())
 	}
 
+	/// Get the development key seed from the current object
 	fn get_dev_key_seed(&self, _is_dev: bool) -> Result<Option<String>> {
 		Ok(Default::default())
 	}
 
+	/// Get the tracing targets from the current object (if any)
 	fn get_tracing_targets(&self) -> Result<Option<String>> {
 		Ok(Default::default())
 	}
 
+	/// Get the TracingReceiver value from the current object
 	fn get_tracing_receiver(&self) -> Result<sc_tracing::TracingReceiver> {
 		Ok(Default::default())
 	}
 
+	/// Get the node key from the current object
 	fn get_node_key(&self, _net_config_dir: &PathBuf) -> Result<NodeKeyConfig> {
 		Ok(Default::default())
 	}
 
+	/// Create a Configuration object from the current object
 	fn create_configuration<C: SubstrateCLI<G, E>, G, E>(
 		&self,
 		task_executor: Arc<dyn Fn(Pin<Box<dyn Future<Output = ()> + Send>>) + Send + Sync>,