, Error> {
- let p = utils::pair_from_suri::(uri, pass)?;
- Ok(p.public().as_ref().to_vec())
-}
diff --git a/client/cli/src/commands/insert_key.rs b/client/cli/src/commands/insert_key.rs
new file mode 100644
index 0000000000000000000000000000000000000000..90588f96d20b03bd683612d9d72b7cbddb2baf41
--- /dev/null
+++ b/client/cli/src/commands/insert_key.rs
@@ -0,0 +1,173 @@
+// This file is part of Substrate.
+
+// Copyright (C) 2020-2021 Parity Technologies (UK) Ltd.
+// SPDX-License-Identifier: Apache-2.0
+
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+//! Implementation of the `insert` subcommand
+
+use crate::{
+ Error, KeystoreParams, CryptoSchemeFlag, SharedParams, utils, with_crypto_scheme,
+ SubstrateCli,
+};
+use std::{sync::Arc, convert::TryFrom};
+use structopt::StructOpt;
+use sp_core::{crypto::KeyTypeId, crypto::SecretString};
+use sp_keystore::{SyncCryptoStorePtr, SyncCryptoStore};
+use sc_keystore::LocalKeystore;
+use sc_service::config::{KeystoreConfig, BasePath};
+
+/// The `insert` command
+#[derive(Debug, StructOpt)]
+#[structopt(
+ name = "insert",
+ about = "Insert a key to the keystore of a node."
+)]
+pub struct InsertKeyCmd {
+ /// The secret key URI.
+ /// If the value is a file, the file content is used as URI.
+ /// If not given, you will be prompted for the URI.
+ #[structopt(long)]
+ suri: Option,
+
+ /// Key type, examples: "gran", or "imon"
+ #[structopt(long)]
+ key_type: String,
+
+ #[allow(missing_docs)]
+ #[structopt(flatten)]
+ pub shared_params: SharedParams,
+
+ #[allow(missing_docs)]
+ #[structopt(flatten)]
+ pub keystore_params: KeystoreParams,
+
+ #[allow(missing_docs)]
+ #[structopt(flatten)]
+ pub crypto_scheme: CryptoSchemeFlag,
+}
+
+impl InsertKeyCmd {
+ /// Run the command
+ pub fn run(&self, cli: &C) -> Result<(), Error> {
+ let suri = utils::read_uri(self.suri.as_ref())?;
+ let base_path = self.shared_params
+ .base_path()
+ .unwrap_or_else(|| BasePath::from_project("", "", &C::executable_name()));
+ let chain_id = self.shared_params.chain_id(self.shared_params.is_dev());
+ let chain_spec = cli.load_spec(&chain_id)?;
+ let config_dir = base_path.config_dir(chain_spec.id());
+
+ let (keystore, public) = match self.keystore_params.keystore_config(&config_dir)? {
+ (_, KeystoreConfig::Path { path, password }) => {
+ let public = with_crypto_scheme!(
+ self.crypto_scheme.scheme,
+ to_vec(&suri, password.clone())
+ )?;
+ let keystore: SyncCryptoStorePtr = Arc::new(LocalKeystore::open(path, password)?);
+ (keystore, public)
+ },
+ _ => unreachable!("keystore_config always returns path and password; qed")
+ };
+
+ let key_type = KeyTypeId::try_from(self.key_type.as_str()).map_err(|_| Error::KeyTypeInvalid)?;
+
+ SyncCryptoStore::insert_unknown(&*keystore, key_type, &suri, &public[..])
+ .map_err(|_| Error::KeyStoreOperation)?;
+
+ Ok(())
+ }
+}
+
+fn to_vec(uri: &str, pass: Option) -> Result, Error> {
+ let p = utils::pair_from_suri::(uri, pass)?;
+ Ok(p.public().as_ref().to_vec())
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+ use structopt::StructOpt;
+ use tempfile::TempDir;
+ use sp_core::{sr25519::Pair, Pair as _, Public};
+ use sc_service::{ChainSpec, GenericChainSpec, ChainType, NoExtension};
+
+ struct Cli;
+
+ impl SubstrateCli for Cli {
+ fn impl_name() -> String {
+ "test".into()
+ }
+
+ fn impl_version() -> String {
+ "2.0".into()
+ }
+
+ fn description() -> String {
+ "test".into()
+ }
+
+ fn support_url() -> String {
+ "test.test".into()
+ }
+
+ fn copyright_start_year() -> i32 {
+ 2020
+ }
+
+ fn author() -> String {
+ "test".into()
+ }
+
+ fn native_runtime_version(_: &Box) -> &'static sp_version::RuntimeVersion {
+ unimplemented!("Not required in tests")
+ }
+
+ fn load_spec(&self, _: &str) -> std::result::Result, String> {
+ Ok(
+ Box::new(
+ GenericChainSpec::from_genesis(
+ "test",
+ "test_id",
+ ChainType::Development,
+ || unimplemented!("Not required in tests"),
+ Vec::new(),
+ None,
+ None,
+ None,
+ NoExtension::None,
+ ),
+ ),
+ )
+ }
+ }
+
+ #[test]
+ fn insert_with_custom_base_path() {
+ let path = TempDir::new().unwrap();
+ let path_str = format!("{}", path.path().display());
+ let (key, uri, _) = Pair::generate_with_phrase(None);
+
+ let inspect = InsertKeyCmd::from_iter(
+ &["insert-key", "-d", &path_str, "--key-type", "test", "--suri", &uri],
+ );
+ assert!(inspect.run(&Cli).is_ok());
+
+ let keystore = LocalKeystore::open(
+ path.path().join("chains").join("test_id").join("keystore"),
+ None,
+ ).unwrap();
+ assert!(keystore.has_keys(&[(key.public().to_raw_vec(), KeyTypeId(*b"test"))]));
+ }
+}
diff --git a/client/cli/src/commands/inspect_key.rs b/client/cli/src/commands/inspect_key.rs
index fb3a7ef4f3b4413856ac738abc639d98f10378bc..2642eee88adcdd944b7b3a160417a99841eb433a 100644
--- a/client/cli/src/commands/inspect_key.rs
+++ b/client/cli/src/commands/inspect_key.rs
@@ -1,6 +1,6 @@
// This file is part of Substrate.
-// Copyright (C) 2020 Parity Technologies (UK) Ltd.
+// Copyright (C) 2020-2021 Parity Technologies (UK) Ltd.
// SPDX-License-Identifier: Apache-2.0
// Licensed under the Apache License, Version 2.0 (the "License");
diff --git a/client/cli/src/commands/inspect_node_key.rs b/client/cli/src/commands/inspect_node_key.rs
index be0b88589d5e9dfd2cc84d0a543ba2ccb4cd836f..4db32aefb5fbb51f1cb8e3719f8900e54dc8b275 100644
--- a/client/cli/src/commands/inspect_node_key.rs
+++ b/client/cli/src/commands/inspect_node_key.rs
@@ -1,6 +1,6 @@
// This file is part of Substrate.
-// Copyright (C) 2020 Parity Technologies (UK) Ltd.
+// Copyright (C) 2020-2021 Parity Technologies (UK) Ltd.
// SPDX-License-Identifier: Apache-2.0
// Licensed under the Apache License, Version 2.0 (the "License");
diff --git a/client/cli/src/commands/key.rs b/client/cli/src/commands/key.rs
index e5bce08145cb8bd482b1b150b81be8e3b2a1b5e2..546454159718d6da5f76de6029dd612e6fa14020 100644
--- a/client/cli/src/commands/key.rs
+++ b/client/cli/src/commands/key.rs
@@ -1,6 +1,6 @@
// This file is part of Substrate.
-// Copyright (C) 2020 Parity Technologies (UK) Ltd.
+// Copyright (C) 2020-2021 Parity Technologies (UK) Ltd.
// SPDX-License-Identifier: Apache-2.0
// Licensed under the Apache License, Version 2.0 (the "License");
@@ -17,11 +17,11 @@
//! Key related CLI utilities
-use crate::Error;
+use crate::{Error, SubstrateCli};
use structopt::StructOpt;
use super::{
- insert::InsertCmd,
+ insert_key::InsertKeyCmd,
inspect_key::InspectKeyCmd,
generate::GenerateCmd,
inspect_node_key::InspectNodeKeyCmd,
@@ -45,17 +45,17 @@ pub enum KeySubcommand {
InspectNodeKey(InspectNodeKeyCmd),
/// Insert a key to the keystore of a node.
- Insert(InsertCmd),
+ Insert(InsertKeyCmd),
}
impl KeySubcommand {
/// run the key subcommands
- pub fn run(&self) -> Result<(), Error> {
+ pub fn run(&self, cli: &C) -> Result<(), Error> {
match self {
KeySubcommand::GenerateNodeKey(cmd) => cmd.run(),
KeySubcommand::Generate(cmd) => cmd.run(),
KeySubcommand::InspectKey(cmd) => cmd.run(),
- KeySubcommand::Insert(cmd) => cmd.run(),
+ KeySubcommand::Insert(cmd) => cmd.run(cli),
KeySubcommand::InspectNodeKey(cmd) => cmd.run(),
}
}
diff --git a/client/cli/src/commands/mod.rs b/client/cli/src/commands/mod.rs
index 9867f61cd277fc626144d5ba8d3aedbe73032c3e..8c0d6acd6a51159bc6ec83fe275895ff44a34a51 100644
--- a/client/cli/src/commands/mod.rs
+++ b/client/cli/src/commands/mod.rs
@@ -1,6 +1,6 @@
// This file is part of Substrate.
-// Copyright (C) 2018-2020 Parity Technologies (UK) Ltd.
+// Copyright (C) 2018-2021 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
@@ -28,7 +28,7 @@ mod revert_cmd;
mod run_cmd;
mod generate_node_key;
mod generate;
-mod insert;
+mod insert_key;
mod inspect_node_key;
mod inspect_key;
mod key;
@@ -43,7 +43,7 @@ pub use self::{
purge_chain_cmd::PurgeChainCmd,
sign::SignCmd,
generate::GenerateCmd,
- insert::InsertCmd,
+ insert_key::InsertKeyCmd,
inspect_key::InspectKeyCmd,
generate_node_key::GenerateNodeKeyCmd,
inspect_node_key::InspectNodeKeyCmd,
diff --git a/client/cli/src/commands/purge_chain_cmd.rs b/client/cli/src/commands/purge_chain_cmd.rs
index 9c9c6e91fb2416c56e8a6e9a3894a8a7aeb31c10..1902d92e6345ad166c557e21012097040a2ab71c 100644
--- a/client/cli/src/commands/purge_chain_cmd.rs
+++ b/client/cli/src/commands/purge_chain_cmd.rs
@@ -1,6 +1,6 @@
// This file is part of Substrate.
-// Copyright (C) 2018-2020 Parity Technologies (UK) Ltd.
+// Copyright (C) 2018-2021 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
diff --git a/client/cli/src/commands/revert_cmd.rs b/client/cli/src/commands/revert_cmd.rs
index b2e3c1bf8e2b674e4313253aa6abd2431701d587..2745ce2c652417b53bbadb90ace51e2cf9d207fd 100644
--- a/client/cli/src/commands/revert_cmd.rs
+++ b/client/cli/src/commands/revert_cmd.rs
@@ -1,6 +1,6 @@
// This file is part of Substrate.
-// Copyright (C) 2018-2020 Parity Technologies (UK) Ltd.
+// Copyright (C) 2018-2021 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
diff --git a/client/cli/src/commands/run_cmd.rs b/client/cli/src/commands/run_cmd.rs
index 019b760e5b4aefc394b01fb29e29ece2ee1956e8..bbb8d6f68d7f97e162efbac1b201a2d49e069407 100644
--- a/client/cli/src/commands/run_cmd.rs
+++ b/client/cli/src/commands/run_cmd.rs
@@ -1,6 +1,6 @@
// This file is part of Substrate.
-// Copyright (C) 2018-2020 Parity Technologies (UK) Ltd.
+// Copyright (C) 2018-2021 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
@@ -75,7 +75,8 @@ pub struct RunCmd {
/// Listen to all RPC interfaces.
///
/// Default is local. Note: not all RPC methods are safe to be exposed publicly. Use an RPC proxy
- /// server to filter out dangerous methods. More details: https://github.com/paritytech/substrate/wiki/Public-RPC.
+ /// server to filter out dangerous methods. More details:
+ /// .
/// Use `--unsafe-rpc-external` to suppress the warning if you understand the risks.
#[structopt(long = "rpc-external")]
pub rpc_external: bool,
@@ -105,7 +106,7 @@ pub struct RunCmd {
/// Listen to all Websocket interfaces.
///
/// Default is local. Note: not all RPC methods are safe to be exposed publicly. Use an RPC proxy
- /// server to filter out dangerous methods. More details: https://github.com/paritytech/substrate/wiki/Public-RPC.
+ /// server to filter out dangerous methods. More details: .
/// Use `--unsafe-ws-external` to suppress the warning if you understand the risks.
#[structopt(long = "ws-external")]
pub ws_external: bool,
@@ -142,7 +143,7 @@ pub struct RunCmd {
///
/// A comma-separated list of origins (protocol://domain or special `null`
/// value). Value of `all` will disable origin validation. Default is to
- /// allow localhost and https://polkadot.js.org origins. When running in
+ /// allow localhost and origins. When running in
/// --dev mode the default is to allow all origins.
#[structopt(long = "rpc-cors", value_name = "ORIGINS", parse(try_from_str = parse_cors))]
pub rpc_cors: Option,
diff --git a/client/cli/src/commands/sign.rs b/client/cli/src/commands/sign.rs
index 605fd5b12313f0c75fee8eef4951fafe9ee9f680..a39e14697b9956bf577c601b72969e265ba9184f 100644
--- a/client/cli/src/commands/sign.rs
+++ b/client/cli/src/commands/sign.rs
@@ -1,6 +1,6 @@
// This file is part of Substrate.
-// Copyright (C) 2018-2020 Parity Technologies (UK) Ltd.
+// Copyright (C) 2018-2021 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
diff --git a/client/cli/src/commands/utils.rs b/client/cli/src/commands/utils.rs
index 6e48d04e1328bda8ca234dd3e4bec2f2d1263f9b..1bbff392eca435b902729f725a912ee65c69d012 100644
--- a/client/cli/src/commands/utils.rs
+++ b/client/cli/src/commands/utils.rs
@@ -1,6 +1,6 @@
// This file is part of Substrate.
-// Copyright (C) 2019-2020 Parity Technologies (UK) Ltd.
+// Copyright (C) 2019-2021 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
@@ -57,7 +57,7 @@ pub fn read_uri(uri: Option<&String>) -> error::Result {
/// 2. Try to construct the `Pair` while using `uri` as input for [`sp_core::Pair::from_string_with_seed`].
///
/// 3. Try to construct the `Pair::Public` while using `uri` as input for
-/// [`sp_core::Pair::Public::from_string_with_version`].
+/// [`sp_core::crypto::Ss58Codec::from_string_with_version`].
pub fn print_from_uri(
uri: &str,
password: Option,
diff --git a/client/cli/src/commands/vanity.rs b/client/cli/src/commands/vanity.rs
index 33b9025c13fbc2e8e3c82a20205ba97ac7a74c5b..da47e8bb26cc870b1eea88048894b3cd2efeef47 100644
--- a/client/cli/src/commands/vanity.rs
+++ b/client/cli/src/commands/vanity.rs
@@ -1,6 +1,6 @@
// This file is part of Substrate.
-// Copyright (C) 2018-2020 Parity Technologies (UK) Ltd.
+// Copyright (C) 2018-2021 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
diff --git a/client/cli/src/commands/verify.rs b/client/cli/src/commands/verify.rs
index 15abc04002f4c891d9be4f655e6915c6b7d28780..f5bd5a06060c6add64815e52d656de5f7d5038f8 100644
--- a/client/cli/src/commands/verify.rs
+++ b/client/cli/src/commands/verify.rs
@@ -1,6 +1,6 @@
// This file is part of Substrate.
-// Copyright (C) 2019-2020 Parity Technologies (UK) Ltd.
+// Copyright (C) 2019-2021 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
diff --git a/client/cli/src/config.rs b/client/cli/src/config.rs
index ab7a335c1ce646a0b14fafbe25f25c0c688d4b15..017d2b421683fd2357b03daacb9cc77a63ffa486 100644
--- a/client/cli/src/config.rs
+++ b/client/cli/src/config.rs
@@ -1,6 +1,6 @@
// This file is part of Substrate.
-// Copyright (C) 2020 Parity Technologies (UK) Ltd.
+// Copyright (C) 2020-2021 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
@@ -22,7 +22,7 @@ use crate::arg_enums::Database;
use crate::error::Result;
use crate::{
init_logger, DatabaseParams, ImportParams, KeystoreParams, NetworkParams, NodeKeyParams,
- OffchainWorkerParams, PruningParams, SharedParams, SubstrateCli,
+ OffchainWorkerParams, PruningParams, SharedParams, SubstrateCli, InitLoggerParams,
};
use log::warn;
use names::{Generator, Name};
@@ -47,7 +47,7 @@ const RECOMMENDED_OPEN_FILE_DESCRIPTOR_LIMIT: u64 = 10_000;
/// Default configuration values used by Substrate
///
-/// These values will be used by [`CliConfiguritation`] to set
+/// These values will be used by [`CliConfiguration`] to set
/// default values for e.g. the listen port or the RPC port.
pub trait DefaultConfigurationValues {
/// The port Substrate should listen on for p2p connections.
@@ -186,12 +186,12 @@ pub trait CliConfiguration: Sized {
/// Get the keystore configuration.
///
- /// Bu default this is retrieved from `KeystoreParams` if it is available. Otherwise it uses
+ /// By default this is retrieved from `KeystoreParams` if it is available. Otherwise it uses
/// `KeystoreConfig::InMemory`.
- fn keystore_config(&self, base_path: &PathBuf) -> Result {
+ fn keystore_config(&self, config_dir: &PathBuf) -> Result<(Option, KeystoreConfig)> {
self.keystore_params()
- .map(|x| x.keystore_config(base_path))
- .unwrap_or(Ok(KeystoreConfig::InMemory))
+ .map(|x| x.keystore_config(config_dir))
+ .unwrap_or_else(|| Ok((None, KeystoreConfig::InMemory)))
}
/// Get the database cache size.
@@ -408,22 +408,18 @@ pub trait CliConfiguration: Sized {
/// Get the tracing targets from the current object (if any)
///
- /// By default this is retrieved from `ImportParams` if it is available. Otherwise its
+ /// By default this is retrieved from [`SharedParams`] if it is available. Otherwise its
/// `None`.
fn tracing_targets(&self) -> Result> {
- Ok(self.import_params()
- .map(|x| x.tracing_targets())
- .unwrap_or_else(|| Default::default()))
+ Ok(self.shared_params().tracing_targets())
}
/// Get the TracingReceiver value from the current object
///
- /// By default this is retrieved from `ImportParams` if it is available. Otherwise its
+ /// By default this is retrieved from [`SharedParams`] if it is available. Otherwise its
/// `TracingReceiver::default()`.
fn tracing_receiver(&self) -> Result {
- Ok(self.import_params()
- .map(|x| x.tracing_receiver())
- .unwrap_or_default())
+ Ok(self.shared_params().tracing_receiver())
}
/// Get the node key from the current object
@@ -458,15 +454,11 @@ pub trait CliConfiguration: Sized {
) -> Result {
let is_dev = self.is_dev()?;
let chain_id = self.chain_id(is_dev)?;
- let chain_spec = cli.load_spec(chain_id.as_str())?;
+ let chain_spec = cli.load_spec(&chain_id)?;
let base_path = self
.base_path()?
.unwrap_or_else(|| BasePath::from_project("", "", &C::executable_name()));
- let config_dir = base_path
- .path()
- .to_path_buf()
- .join("chains")
- .join(chain_spec.id());
+ let config_dir = base_path.config_dir(chain_spec.id());
let net_config_dir = config_dir.join(DEFAULT_NETWORK_CONFIG_PATH);
let client_id = C::client_id();
let database_cache_size = self.database_cache_size()?.unwrap_or(128);
@@ -475,6 +467,7 @@ pub trait CliConfiguration: Sized {
let role = self.role(is_dev)?;
let max_runtime_instances = self.max_runtime_instances()?.unwrap_or(8);
let is_validator = role.is_network_authority();
+ let (keystore_remote, keystore) = self.keystore_config(&config_dir)?;
let unsafe_pruning = self
.import_params()
@@ -495,7 +488,8 @@ pub trait CliConfiguration: Sized {
node_key,
DCV::p2p_listen_port(),
)?,
- keystore: self.keystore_config(&config_dir)?,
+ keystore_remote,
+ keystore,
database: self.database_config(&config_dir, database_cache_size, database)?,
state_cache_size: self.state_cache_size()?,
state_cache_child_ratio: self.state_cache_child_ratio()?,
@@ -519,6 +513,7 @@ pub trait CliConfiguration: Sized {
dev_key_seed: self.dev_key_seed(is_dev)?,
tracing_targets: self.tracing_targets()?,
tracing_receiver: self.tracing_receiver()?,
+ disable_log_reloading: self.is_log_filter_reloading_disabled()?,
chain_spec,
max_runtime_instances,
announce_block: self.announce_block()?,
@@ -538,6 +533,16 @@ pub trait CliConfiguration: Sized {
Ok(self.shared_params().log_filters().join(","))
}
+ /// Is log reloading disabled (enabled by default)
+ fn is_log_filter_reloading_disabled(&self) -> Result {
+ Ok(self.shared_params().is_log_filter_reloading_disabled())
+ }
+
+ /// Should the log color output be disabled?
+ fn disable_log_color(&self) -> Result {
+ Ok(self.shared_params().disable_log_color())
+ }
+
/// Initialize substrate. This must be done only once per process.
///
/// This method:
@@ -549,12 +554,18 @@ pub trait CliConfiguration: Sized {
let logger_pattern = self.log_filters()?;
let tracing_receiver = self.tracing_receiver()?;
let tracing_targets = self.tracing_targets()?;
+ let disable_log_reloading = self.is_log_filter_reloading_disabled()?;
+ let disable_log_color = self.disable_log_color()?;
sp_panic_handler::set(&C::support_url(), &C::impl_version());
- if let Err(e) = init_logger(&logger_pattern, tracing_receiver, tracing_targets) {
- log::warn!("💬 Problem initializing global logging framework: {:}", e)
- }
+ init_logger(InitLoggerParams {
+ pattern: logger_pattern,
+ tracing_receiver,
+ tracing_targets,
+ disable_log_reloading,
+ disable_log_color,
+ })?;
if let Some(new_limit) = fdlimit::raise_fd_limit() {
if new_limit < RECOMMENDED_OPEN_FILE_DESCRIPTOR_LIMIT {
diff --git a/client/cli/src/error.rs b/client/cli/src/error.rs
index 36c963f3e8c97e72e9d27486f0664db354a6b5ce..75867e2f76b280992b43ee1485515f739abee3df 100644
--- a/client/cli/src/error.rs
+++ b/client/cli/src/error.rs
@@ -1,6 +1,6 @@
// This file is part of Substrate.
-// Copyright (C) 2017-2020 Parity Technologies (UK) Ltd.
+// Copyright (C) 2017-2021 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
@@ -25,35 +25,32 @@ pub type Result = std::result::Result;
/// Error type for the CLI.
#[derive(Debug, thiserror::Error)]
+#[allow(missing_docs)]
pub enum Error {
- /// Io error
#[error(transparent)]
Io(#[from] std::io::Error),
- /// Cli error
+
#[error(transparent)]
Cli(#[from] structopt::clap::Error),
- /// Service error
+
#[error(transparent)]
Service(#[from] sc_service::Error),
- /// Client error
+
#[error(transparent)]
Client(#[from] sp_blockchain::Error),
- /// scale codec error
+
#[error(transparent)]
Codec(#[from] parity_scale_codec::Error),
- /// Input error
+
#[error("Invalid input: {0}")]
Input(String),
- /// Invalid listen multiaddress
+
#[error("Invalid listen multiaddress")]
InvalidListenMultiaddress,
- /// Application specific error chain sequence forwarder.
- #[error(transparent)]
- Application(#[from] Box),
- /// URI error.
+
#[error("Invalid URI; expecting either a secret URI or a public URI.")]
InvalidUri(crypto::PublicError),
- /// Signature length mismatch.
+
#[error("Signature has an invalid length. Read {read} bytes, expected {expected} bytes")]
SignatureInvalidLength {
/// Amount of signature bytes read.
@@ -61,28 +58,25 @@ pub enum Error {
/// Expected number of signature bytes.
expected: usize,
},
- /// Missing base path argument.
- #[error("The base path is missing, please provide one")]
- MissingBasePath,
- /// Unknown key type specifier or missing key type specifier.
+
#[error("Unknown key type, must be a known 4-character sequence")]
KeyTypeInvalid,
- /// Signature verification failed.
+
#[error("Signature verification failed")]
SignatureInvalid,
- /// Storing a given key failed.
+
#[error("Key store operation failed")]
KeyStoreOperation,
- /// An issue with the underlying key storage was encountered.
+
#[error("Key storage issue encountered")]
KeyStorage(#[from] sc_keystore::Error),
- /// Bytes are not decodable when interpreted as hexadecimal string.
- #[error("Invalid hex base data")]
+
+ #[error("Invalid hexadecimal string data")]
HexDataConversion(#[from] hex::FromHexError),
- /// Shortcut type to specify types on the fly, discouraged.
- #[deprecated = "Use `Forwarded` with an error type instead."]
- #[error("Other: {0}")]
- Other(String),
+
+ /// Application specific error chain sequence forwarder.
+ #[error(transparent)]
+ Application(#[from] Box),
}
impl std::convert::From<&str> for Error {
@@ -93,7 +87,7 @@ impl std::convert::From<&str> for Error {
impl std::convert::From for Error {
fn from(s: String) -> Error {
- Error::Input(s.to_string())
+ Error::Input(s)
}
}
diff --git a/client/cli/src/lib.rs b/client/cli/src/lib.rs
index c25693dc418b12afeb1d34196822ff94467ecbb1..1402e5e7ae44c64d3e92f8a9c30da49311c78b41 100644
--- a/client/cli/src/lib.rs
+++ b/client/cli/src/lib.rs
@@ -1,6 +1,6 @@
// This file is part of Substrate.
-// Copyright (C) 2017-2020 Parity Technologies (UK) Ltd.
+// Copyright (C) 2017-2021 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
@@ -27,7 +27,6 @@ pub mod arg_enums;
mod commands;
mod config;
mod error;
-mod logging;
mod params;
mod runner;
@@ -47,13 +46,18 @@ use structopt::{
clap::{self, AppSettings},
StructOpt,
};
-#[doc(hidden)]
-pub use tracing;
use tracing_subscriber::{
- filter::Directive, fmt::time::ChronoLocal, layer::SubscriberExt, FmtSubscriber, Layer,
+ fmt::time::ChronoLocal,
+ EnvFilter,
+ FmtSubscriber,
+ Layer,
+ layer::SubscriberExt,
};
+pub use sc_tracing::logging;
pub use logging::PREFIX_LOG_SPAN;
+#[doc(hidden)]
+pub use tracing;
/// Substrate client CLI
///
@@ -108,10 +112,7 @@ pub trait SubstrateCli: Sized {
///
/// Gets the struct from the command line arguments. Print the
/// error message and quit the program in case of failure.
- fn from_args() -> Self
- where
- Self: StructOpt + Sized,
- {
+ fn from_args() -> Self where Self: StructOpt + Sized {
::from_iter(&mut std::env::args_os())
}
@@ -236,54 +237,80 @@ pub trait SubstrateCli: Sized {
fn native_runtime_version(chain_spec: &Box) -> &'static RuntimeVersion;
}
+/// The parameters for [`init_logger`].
+#[derive(Default)]
+pub struct InitLoggerParams {
+ /// A comma seperated list of logging patterns.
+ ///
+ /// E.g.: `test-crate=debug`
+ pub pattern: String,
+ /// The tracing receiver.
+ pub tracing_receiver: sc_tracing::TracingReceiver,
+ /// Optional comma seperated list of tracing targets.
+ pub tracing_targets: Option,
+ /// Should log reloading be disabled?
+ pub disable_log_reloading: bool,
+ /// Should the log color output be disabled?
+ pub disable_log_color: bool,
+}
+
/// Initialize the global logger
///
/// This sets various global logging and tracing instances and thus may only be called once.
pub fn init_logger(
- pattern: &str,
- tracing_receiver: sc_tracing::TracingReceiver,
- profiling_targets: Option,
+ InitLoggerParams {
+ pattern,
+ tracing_receiver,
+ tracing_targets,
+ disable_log_reloading,
+ disable_log_color,
+ }: InitLoggerParams,
) -> std::result::Result<(), String> {
- fn parse_directives(dirs: impl AsRef) -> Vec {
- dirs.as_ref()
- .split(',')
- .filter_map(|s| s.parse().ok())
- .collect()
+ use sc_tracing::parse_default_directive;
+
+ // Accept all valid directives and print invalid ones
+ fn parse_user_directives(
+ mut env_filter: EnvFilter,
+ dirs: &str,
+ ) -> std::result::Result {
+ for dir in dirs.split(',') {
+ env_filter = env_filter.add_directive(parse_default_directive(&dir)?);
+ }
+ Ok(env_filter)
}
- if let Err(e) = tracing_log::LogTracer::init() {
- return Err(format!(
- "Registering Substrate logger failed: {:}!", e
- ))
- }
+ tracing_log::LogTracer::init()
+ .map_err(|e| format!("Registering Substrate logger failed: {:}!", e))?;
- let mut env_filter = tracing_subscriber::EnvFilter::default()
+ // Initialize filter - ensure to use `parse_default_directive` for any defaults to persist
+ // after log filter reloading by RPC
+ let mut env_filter = EnvFilter::default()
+ // Enable info
+ .add_directive(parse_default_directive("info")
+ .expect("provided directive is valid"))
// Disable info logging by default for some modules.
- .add_directive("ws=off".parse().expect("provided directive is valid"))
- .add_directive("yamux=off".parse().expect("provided directive is valid"))
- .add_directive("cranelift_codegen=off".parse().expect("provided directive is valid"))
+ .add_directive(parse_default_directive("ws=off")
+ .expect("provided directive is valid"))
+ .add_directive(parse_default_directive("yamux=off")
+ .expect("provided directive is valid"))
+ .add_directive(parse_default_directive("cranelift_codegen=off")
+ .expect("provided directive is valid"))
// Set warn logging by default for some modules.
- .add_directive("cranelift_wasm=warn".parse().expect("provided directive is valid"))
- .add_directive("hyper=warn".parse().expect("provided directive is valid"))
- // Enable info for others.
- .add_directive(tracing_subscriber::filter::LevelFilter::INFO.into());
+ .add_directive(parse_default_directive("cranelift_wasm=warn")
+ .expect("provided directive is valid"))
+ .add_directive(parse_default_directive("hyper=warn")
+ .expect("provided directive is valid"));
if let Ok(lvl) = std::env::var("RUST_LOG") {
if lvl != "" {
- // We're not sure if log or tracing is available at this moment, so silently ignore the
- // parse error.
- for directive in parse_directives(lvl) {
- env_filter = env_filter.add_directive(directive);
- }
+ env_filter = parse_user_directives(env_filter, &lvl)?;
}
}
if pattern != "" {
// We're not sure if log or tracing is available at this moment, so silently ignore the
// parse error.
- for directive in parse_directives(pattern) {
- env_filter = env_filter.add_directive(directive);
- }
+ env_filter = parse_user_directives(env_filter, &pattern)?;
}
// If we're only logging `INFO` entries then we'll use a simplified logging format.
@@ -293,44 +320,61 @@ pub fn init_logger(
};
// Always log the special target `sc_tracing`, overrides global level.
+ // Required because profiling traces are emitted via `sc_tracing`
// NOTE: this must be done after we check the `max_level_hint` otherwise
// it is always raised to `TRACE`.
env_filter = env_filter.add_directive(
- "sc_tracing=trace"
- .parse()
- .expect("provided directive is valid"),
+ parse_default_directive("sc_tracing=trace").expect("provided directive is valid")
);
// Make sure to include profiling targets in the filter
- if let Some(profiling_targets) = profiling_targets.clone() {
- for directive in parse_directives(profiling_targets) {
- env_filter = env_filter.add_directive(directive);
- }
+ if let Some(tracing_targets) = tracing_targets.clone() {
+ env_filter = parse_user_directives(env_filter, &tracing_targets)?;
}
- let isatty = atty::is(atty::Stream::Stderr);
- let enable_color = isatty;
+ let enable_color = atty::is(atty::Stream::Stderr) && !disable_log_color;
let timer = ChronoLocal::with_format(if simple {
"%Y-%m-%d %H:%M:%S".to_string()
} else {
"%Y-%m-%d %H:%M:%S%.3f".to_string()
});
- let subscriber = FmtSubscriber::builder()
+ let subscriber_builder = FmtSubscriber::builder()
.with_env_filter(env_filter)
- .with_writer(std::io::stderr)
+ .with_writer(std::io::stderr as _)
.event_format(logging::EventFormat {
timer,
- ansi: enable_color,
+ enable_color,
display_target: !simple,
display_level: !simple,
display_thread_name: !simple,
- })
- .finish().with(logging::NodeNameLayer);
+ });
+ if disable_log_reloading {
+ let subscriber = subscriber_builder
+ .finish()
+ .with(logging::NodeNameLayer);
+ initialize_tracing(subscriber, tracing_receiver, tracing_targets)
+ } else {
+ let subscriber_builder = subscriber_builder.with_filter_reloading();
+ let handle = subscriber_builder.reload_handle();
+ sc_tracing::set_reload_handle(handle);
+ let subscriber = subscriber_builder
+ .finish()
+ .with(logging::NodeNameLayer);
+ initialize_tracing(subscriber, tracing_receiver, tracing_targets)
+ }
+}
+fn initialize_tracing(
+ subscriber: S,
+ tracing_receiver: sc_tracing::TracingReceiver,
+ profiling_targets: Option,
+) -> std::result::Result<(), String>
+where
+ S: tracing::Subscriber + Send + Sync + 'static,
+{
if let Some(profiling_targets) = profiling_targets {
let profiling = sc_tracing::ProfilingLayer::new(tracing_receiver, &profiling_targets);
-
if let Err(e) = tracing::subscriber::set_global_default(subscriber.with(profiling)) {
return Err(format!(
"Registering Substrate tracing subscriber failed: {:}!", e
@@ -339,7 +383,7 @@ pub fn init_logger(
} else {
if let Err(e) = tracing::subscriber::set_global_default(subscriber) {
return Err(format!(
- "Registering Substrate tracing subscriber failed: {:}!", e
+ "Registering Substrate tracing subscriber failed: {:}!", e
))
}
}
@@ -356,7 +400,9 @@ mod tests {
#[test]
fn test_logger_filters() {
let test_pattern = "afg=debug,sync=trace,client=warn,telemetry,something-with-dash=error";
- init_logger(&test_pattern, Default::default(), Default::default()).unwrap();
+ init_logger(
+ InitLoggerParams { pattern: test_pattern.into(), ..Default::default() },
+ ).unwrap();
tracing::dispatcher::get_default(|dispatcher| {
let test_filter = |target, level| {
@@ -415,7 +461,9 @@ mod tests {
fn log_something_with_dash_target_name() {
if env::var("ENABLE_LOGGING").is_ok() {
let test_pattern = "test-target=info";
- init_logger(&test_pattern, Default::default(), Default::default()).unwrap();
+ init_logger(
+ InitLoggerParams { pattern: test_pattern.into(), ..Default::default() },
+ ).unwrap();
log::info!(target: "test-target", "{}", EXPECTED_LOG_MESSAGE);
}
@@ -451,7 +499,9 @@ mod tests {
fn prefix_in_log_lines_entrypoint() {
if env::var("ENABLE_LOGGING").is_ok() {
let test_pattern = "test-target=info";
- init_logger(&test_pattern, Default::default(), Default::default()).unwrap();
+ init_logger(
+ InitLoggerParams { pattern: test_pattern.into(), ..Default::default() },
+ ).unwrap();
prefix_in_log_lines_process();
}
}
@@ -460,4 +510,35 @@ mod tests {
fn prefix_in_log_lines_process() {
log::info!("{}", EXPECTED_LOG_MESSAGE);
}
+
+ /// This is no actual test, it will be used by the `do_not_write_with_colors_on_tty` test.
+ /// The given test will call the test executable to only execute this test that
+ /// will only print a log line with some colors in it.
+ #[test]
+ fn do_not_write_with_colors_on_tty_entrypoint() {
+ if env::var("ENABLE_LOGGING").is_ok() {
+ init_logger(InitLoggerParams::default()).unwrap();
+ log::info!("{}", ansi_term::Colour::Yellow.paint(EXPECTED_LOG_MESSAGE));
+ }
+ }
+
+ #[test]
+ fn do_not_write_with_colors_on_tty() {
+ let re = regex::Regex::new(&format!(
+ r"^\d{{4}}-\d{{2}}-\d{{2}} \d{{2}}:\d{{2}}:\d{{2}} {}$",
+ EXPECTED_LOG_MESSAGE,
+ )).unwrap();
+ let executable = env::current_exe().unwrap();
+ let output = Command::new(executable)
+ .env("ENABLE_LOGGING", "1")
+ .args(&["--nocapture", "do_not_write_with_colors_on_tty_entrypoint"])
+ .output()
+ .unwrap();
+
+ let output = String::from_utf8(output.stderr).unwrap();
+ assert!(
+ re.is_match(output.trim()),
+ format!("Expected:\n{}\nGot:\n{}", re, output),
+ );
+ }
}
diff --git a/client/cli/src/params/database_params.rs b/client/cli/src/params/database_params.rs
index 24b23f6076a02302071c76a6da614c8e5c11e6a0..21529f65a56b0b76f6557d31a89e2adb66b4053f 100644
--- a/client/cli/src/params/database_params.rs
+++ b/client/cli/src/params/database_params.rs
@@ -1,6 +1,6 @@
// This file is part of Substrate.
-// Copyright (C) 2018-2020 Parity Technologies (UK) Ltd.
+// Copyright (C) 2018-2021 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
diff --git a/client/cli/src/params/import_params.rs b/client/cli/src/params/import_params.rs
index 1efd4383432fb51a82674cd06b5944fcf219013f..7409dbf79dc0f7b1db5d08bc343ec1e4fbe0c5a5 100644
--- a/client/cli/src/params/import_params.rs
+++ b/client/cli/src/params/import_params.rs
@@ -1,6 +1,6 @@
// This file is part of Substrate.
-// Copyright (C) 2018-2020 Parity Technologies (UK) Ltd.
+// Copyright (C) 2018-2021 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
@@ -17,7 +17,7 @@
// along with this program. If not, see .
use crate::arg_enums::{
- ExecutionStrategy, TracingReceiver, WasmExecutionMethod, DEFAULT_EXECUTION_BLOCK_CONSTRUCTION,
+ ExecutionStrategy, WasmExecutionMethod, DEFAULT_EXECUTION_BLOCK_CONSTRUCTION,
DEFAULT_EXECUTION_IMPORT_BLOCK, DEFAULT_EXECUTION_IMPORT_BLOCK_VALIDATOR,
DEFAULT_EXECUTION_OFFCHAIN_WORKER, DEFAULT_EXECUTION_OTHER, DEFAULT_EXECUTION_SYNCING,
};
@@ -73,32 +73,9 @@ pub struct ImportParams {
default_value = "67108864"
)]
pub state_cache_size: usize,
-
- /// Comma separated list of targets for tracing.
- #[structopt(long = "tracing-targets", value_name = "TARGETS")]
- pub tracing_targets: Option,
-
- /// Receiver to process tracing messages.
- #[structopt(
- long = "tracing-receiver",
- value_name = "RECEIVER",
- possible_values = &TracingReceiver::variants(),
- case_insensitive = true,
- default_value = "Log"
- )]
- pub tracing_receiver: TracingReceiver,
}
impl ImportParams {
- /// Receiver to process tracing messages.
- pub fn tracing_receiver(&self) -> sc_service::TracingReceiver {
- self.tracing_receiver.clone().into()
- }
-
- /// Comma separated list of targets for tracing.
- pub fn tracing_targets(&self) -> Option {
- self.tracing_targets.clone()
- }
/// Specify the state cache size.
pub fn state_cache_size(&self) -> usize {
diff --git a/client/cli/src/params/keystore_params.rs b/client/cli/src/params/keystore_params.rs
index 3c04d63144595680394e00fecd4a699ed446a304..d75cdebc5a56839db2a9104a12da7fc8f346825e 100644
--- a/client/cli/src/params/keystore_params.rs
+++ b/client/cli/src/params/keystore_params.rs
@@ -1,6 +1,6 @@
// This file is part of Substrate.
-// Copyright (C) 2018-2020 Parity Technologies (UK) Ltd.
+// Copyright (C) 2018-2021 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
@@ -18,12 +18,10 @@
use crate::error::Result;
use sc_service::config::KeystoreConfig;
-use std::fs;
-use std::path::PathBuf;
+use std::{fs, path::{PathBuf, Path}};
use structopt::StructOpt;
use crate::error;
-use sp_core::crypto::{SecretString, Zeroize};
-use std::str::FromStr;
+use sp_core::crypto::SecretString;
/// default sub directory for the key store
const DEFAULT_KEYSTORE_CONFIG_PATH: &'static str = "keystore";
@@ -31,6 +29,10 @@ const DEFAULT_KEYSTORE_CONFIG_PATH: &'static str = "keystore";
/// Parameters of the keystore
#[derive(Debug, StructOpt)]
pub struct KeystoreParams {
+ /// Specify custom URIs to connect to for keystore-services
+ #[structopt(long = "keystore-uri")]
+ pub keystore_uri: Option,
+
/// Specify custom keystore path.
#[structopt(long = "keystore-path", value_name = "PATH", parse(from_os_str))]
pub keystore_path: Option,
@@ -62,31 +64,26 @@ pub struct KeystoreParams {
/// Parse a sercret string, returning a displayable error.
pub fn secret_string_from_str(s: &str) -> std::result::Result {
- Ok(std::str::FromStr::from_str(s)
- .map_err(|_e| "Could not get SecretString".to_string())?)
+ std::str::FromStr::from_str(s).map_err(|_| "Could not get SecretString".to_string())
}
impl KeystoreParams {
/// Get the keystore configuration for the parameters
- pub fn keystore_config(&self, base_path: &PathBuf) -> Result {
+ ///
+ /// Returns a vector of remote-urls and the local Keystore configuration
+ pub fn keystore_config(&self, config_dir: &Path) -> Result<(Option, KeystoreConfig)> {
let password = if self.password_interactive {
#[cfg(not(target_os = "unknown"))]
{
- let mut password = input_keystore_password()?;
- let secret = std::str::FromStr::from_str(password.as_str())
- .map_err(|()| "Error reading password")?;
- password.zeroize();
- Some(secret)
+ let password = input_keystore_password()?;
+ Some(SecretString::new(password))
}
#[cfg(target_os = "unknown")]
None
} else if let Some(ref file) = self.password_filename {
- let mut password = fs::read_to_string(file)
+ let password = fs::read_to_string(file)
.map_err(|e| format!("{}", e))?;
- let secret = std::str::FromStr::from_str(password.as_str())
- .map_err(|()| "Error reading password")?;
- password.zeroize();
- Some(secret)
+ Some(SecretString::new(password))
} else {
self.password.clone()
};
@@ -94,9 +91,9 @@ impl KeystoreParams {
let path = self
.keystore_path
.clone()
- .unwrap_or_else(|| base_path.join(DEFAULT_KEYSTORE_CONFIG_PATH));
+ .unwrap_or_else(|| config_dir.join(DEFAULT_KEYSTORE_CONFIG_PATH));
- Ok(KeystoreConfig::Path { path, password })
+ Ok((self.keystore_uri.clone(), KeystoreConfig::Path { path, password }))
}
/// helper method to fetch password from `KeyParams` or read from stdin
@@ -104,10 +101,8 @@ impl KeystoreParams {
let (password_interactive, password) = (self.password_interactive, self.password.clone());
let pass = if password_interactive {
- let mut password = rpassword::read_password_from_tty(Some("Key password: "))?;
- let pass = Some(FromStr::from_str(&password).map_err(|()| "Error reading password")?);
- password.zeroize();
- pass
+ let password = rpassword::read_password_from_tty(Some("Key password: "))?;
+ Some(SecretString::new(password))
} else {
password
};
diff --git a/client/cli/src/params/mod.rs b/client/cli/src/params/mod.rs
index 93467bc8ec63778e95d116b57cf8b6dc92c12636..8308b123f71f3c5e83fa709cf4ddbc9d910df132 100644
--- a/client/cli/src/params/mod.rs
+++ b/client/cli/src/params/mod.rs
@@ -1,6 +1,6 @@
// This file is part of Substrate.
-// Copyright (C) 2020 Parity Technologies (UK) Ltd.
+// Copyright (C) 2020-2021 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
diff --git a/client/cli/src/params/network_params.rs b/client/cli/src/params/network_params.rs
index 209742f54e9b8c573f10e2f94e27f7b8ba696ecb..2040bd9bc78ed9c45550c69ec8e61d7c380d6be9 100644
--- a/client/cli/src/params/network_params.rs
+++ b/client/cli/src/params/network_params.rs
@@ -1,6 +1,6 @@
// This file is part of Substrate.
-// Copyright (C) 2018-2020 Parity Technologies (UK) Ltd.
+// Copyright (C) 2018-2021 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
@@ -21,7 +21,7 @@ use sc_network::{
config::{NetworkConfiguration, NodeKeyConfig, NonReservedPeerMode, TransportConfig},
multiaddr::Protocol,
};
-use sc_service::{ChainSpec, config::{Multiaddr, MultiaddrWithPeerId}};
+use sc_service::{ChainSpec, ChainType, config::{Multiaddr, MultiaddrWithPeerId}};
use std::path::PathBuf;
use structopt::StructOpt;
@@ -94,7 +94,8 @@ pub struct NetworkParams {
/// Enable peer discovery on local networks.
///
- /// By default this option is true for `--dev` and false otherwise.
+ /// By default this option is `true` for `--dev` or when the chain type is `Local`/`Development`
+ /// and false otherwise.
#[structopt(long)]
pub discover_local: bool,
@@ -139,6 +140,13 @@ impl NetworkParams {
let mut boot_nodes = chain_spec.boot_nodes().to_vec();
boot_nodes.extend(self.bootnodes.clone());
+ let chain_type = chain_spec.chain_type();
+ // Activate if the user explicitly requested local discovery, `--dev` is given or the
+ // chain type is `Local`/`Development`
+ let allow_non_globals_in_dht = self.discover_local
+ || is_dev
+ || matches!(chain_type, ChainType::Local | ChainType::Development);
+
NetworkConfiguration {
boot_nodes,
net_config_path,
@@ -163,7 +171,7 @@ impl NetworkParams {
wasm_external_transport: None,
},
max_parallel_downloads: self.max_parallel_downloads,
- allow_non_globals_in_dht: self.discover_local || is_dev,
+ allow_non_globals_in_dht,
kademlia_disjoint_query_paths: self.kademlia_disjoint_query_paths,
}
}
diff --git a/client/cli/src/params/node_key_params.rs b/client/cli/src/params/node_key_params.rs
index 875411fbfb62000d3e8c5bfc00cce52d3082fa04..d43c87804dd3ba1404e5a3753effa5e3a63e8b09 100644
--- a/client/cli/src/params/node_key_params.rs
+++ b/client/cli/src/params/node_key_params.rs
@@ -1,6 +1,6 @@
// This file is part of Substrate.
-// Copyright (C) 2017-2020 Parity Technologies (UK) Ltd.
+// Copyright (C) 2017-2021 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
diff --git a/client/cli/src/params/offchain_worker_params.rs b/client/cli/src/params/offchain_worker_params.rs
index f8d48edc4729d5f97e4f389fe78dd3cd794423b9..ef39a1ed41be26bb8f94e5391fbcff1d62006f7f 100644
--- a/client/cli/src/params/offchain_worker_params.rs
+++ b/client/cli/src/params/offchain_worker_params.rs
@@ -1,6 +1,6 @@
// This file is part of Substrate.
-// Copyright (C) 2020 Parity Technologies (UK) Ltd.
+// Copyright (C) 2020-2021 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
diff --git a/client/cli/src/params/pruning_params.rs b/client/cli/src/params/pruning_params.rs
index 7db808e6d8f2f8e249ff0e057a05297bfcf92a72..80118cafd8769b40c2dc4204b8b4b9de9bb9dbcf 100644
--- a/client/cli/src/params/pruning_params.rs
+++ b/client/cli/src/params/pruning_params.rs
@@ -1,6 +1,6 @@
// This file is part of Substrate.
-// Copyright (C) 2020 Parity Technologies (UK) Ltd.
+// Copyright (C) 2020-2021 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
diff --git a/client/cli/src/params/shared_params.rs b/client/cli/src/params/shared_params.rs
index ad9ab04070563ac5c7ea5939688f410a3257f232..45ce41846bf120319e3b2952ae112340938b3ac4 100644
--- a/client/cli/src/params/shared_params.rs
+++ b/client/cli/src/params/shared_params.rs
@@ -1,6 +1,6 @@
// This file is part of Substrate.
-// Copyright (C) 2018-2020 Parity Technologies (UK) Ltd.
+// Copyright (C) 2018-2021 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
@@ -19,11 +19,15 @@
use sc_service::config::BasePath;
use std::path::PathBuf;
use structopt::StructOpt;
+use crate::arg_enums::TracingReceiver;
/// Shared parameters used by all `CoreParams`.
#[derive(Debug, StructOpt)]
pub struct SharedParams {
- /// Specify the chain specification (one of dev, local, or staging).
+ /// Specify the chain specification.
+ ///
+ /// It can be one of the predefined ones (dev, local, or staging) or it can be a path to a file with
+ /// the chainspec (such as one exported by the `build-spec` subcommand).
#[structopt(long, value_name = "CHAIN_SPEC")]
pub chain: Option,
@@ -41,6 +45,32 @@ pub struct SharedParams {
/// By default, all targets log `info`. The global log level can be set with -l.
#[structopt(short = "l", long, value_name = "LOG_PATTERN")]
pub log: Vec,
+
+ /// Disable log color output.
+ #[structopt(long)]
+ pub disable_log_color: bool,
+
+ /// Disable feature to dynamically update and reload the log filter.
+ ///
+ /// By default this feature is enabled, however it leads to a small performance decrease.
+ /// The `system_addLogFilter` and `system_resetLogFilter` RPCs will have no effect with this
+ /// option set.
+ #[structopt(long = "disable-log-reloading")]
+ pub disable_log_reloading: bool,
+
+ /// Sets a custom profiling filter. Syntax is the same as for logging: =
+ #[structopt(long = "tracing-targets", value_name = "TARGETS")]
+ pub tracing_targets: Option,
+
+ /// Receiver to process tracing messages.
+ #[structopt(
+ long = "tracing-receiver",
+ value_name = "RECEIVER",
+ possible_values = &TracingReceiver::variants(),
+ case_insensitive = true,
+ default_value = "Log"
+ )]
+ pub tracing_receiver: TracingReceiver,
}
impl SharedParams {
@@ -72,4 +102,24 @@ impl SharedParams {
pub fn log_filters(&self) -> &[String] {
&self.log
}
+
+ /// Should the log color output be disabled?
+ pub fn disable_log_color(&self) -> bool {
+ self.disable_log_color
+ }
+
+ /// Is log reloading disabled
+ pub fn is_log_filter_reloading_disabled(&self) -> bool {
+ self.disable_log_reloading
+ }
+
+ /// Receiver to process tracing messages.
+ pub fn tracing_receiver(&self) -> sc_service::TracingReceiver {
+ self.tracing_receiver.clone().into()
+ }
+
+ /// Comma separated list of targets for tracing.
+ pub fn tracing_targets(&self) -> Option {
+ self.tracing_targets.clone()
+ }
}
diff --git a/client/cli/src/params/transaction_pool_params.rs b/client/cli/src/params/transaction_pool_params.rs
index 3ad278426922ec99ccc42e192cbda9db1d04207b..bf0ed53e531c9745dcd8351b9edebd0a55808997 100644
--- a/client/cli/src/params/transaction_pool_params.rs
+++ b/client/cli/src/params/transaction_pool_params.rs
@@ -1,6 +1,6 @@
// This file is part of Substrate.
-// Copyright (C) 2018-2020 Parity Technologies (UK) Ltd.
+// Copyright (C) 2018-2021 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
diff --git a/client/cli/src/runner.rs b/client/cli/src/runner.rs
index e6d35282ada2b491cacbe2b9a112b5cba82bd968..9836471fb9fa2ddd413aeb2c76d7df677a2d8ca3 100644
--- a/client/cli/src/runner.rs
+++ b/client/cli/src/runner.rs
@@ -1,6 +1,6 @@
// This file is part of Substrate.
-// Copyright (C) 2020 Parity Technologies (UK) Ltd.
+// Copyright (C) 2020-2021 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
diff --git a/client/consensus/aura/Cargo.toml b/client/consensus/aura/Cargo.toml
index ccc4d515a8e1104ebbd058abeec0595e6ba6be21..c240fa4cb4da698953f69f9ff7244fe6b3cee84a 100644
--- a/client/consensus/aura/Cargo.toml
+++ b/client/consensus/aura/Cargo.toml
@@ -16,7 +16,7 @@ targets = ["x86_64-unknown-linux-gnu"]
sp-application-crypto = { version = "2.0.0", path = "../../../primitives/application-crypto" }
sp-consensus-aura = { version = "0.8.0", path = "../../../primitives/consensus/aura" }
sp-block-builder = { version = "2.0.0", path = "../../../primitives/block-builder" }
-sc-block-builder = { version = "0.8.0", path = "../../../client/block-builder" }
+sc-block-builder = { version = "0.8.0", path = "../../block-builder" }
sc-client-api = { version = "2.0.0", path = "../../api" }
codec = { package = "parity-scale-codec", version = "1.3.4" }
sp-consensus = { version = "0.8.0", path = "../../../primitives/consensus/common" }
diff --git a/client/consensus/aura/src/digests.rs b/client/consensus/aura/src/digests.rs
index 3332e4c6a6dff99f2ee9ad367031fde15a33ada6..fec412b62d1eaf3b38f696a12510fdeeab31832f 100644
--- a/client/consensus/aura/src/digests.rs
+++ b/client/consensus/aura/src/digests.rs
@@ -1,6 +1,6 @@
// This file is part of Substrate.
-// Copyright (C) 2018-2020 Parity Technologies (UK) Ltd.
+// Copyright (C) 2018-2021 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
diff --git a/client/consensus/aura/src/lib.rs b/client/consensus/aura/src/lib.rs
index 5013c1813b685e3deb0af88a5070ad46d4ed4cb6..60aad59e8f971a85f53bbe330a91bebdbe3e658b 100644
--- a/client/consensus/aura/src/lib.rs
+++ b/client/consensus/aura/src/lib.rs
@@ -1,6 +1,6 @@
// This file is part of Substrate.
-// Copyright (C) 2018-2020 Parity Technologies (UK) Ltd.
+// Copyright (C) 2018-2021 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
@@ -47,7 +47,7 @@ use sp_consensus::{
BlockOrigin, Error as ConsensusError, SelectChain, SlotData, BlockCheckParams, ImportResult
};
use sp_consensus::import_queue::{
- Verifier, BasicQueue, DefaultImportQueue, BoxJustificationImport, BoxFinalityProofImport,
+ Verifier, BasicQueue, DefaultImportQueue, BoxJustificationImport,
};
use sc_client_api::{backend::AuxStore, BlockOf};
use sp_blockchain::{
@@ -59,7 +59,7 @@ use sp_core::crypto::Public;
use sp_application_crypto::{AppKey, AppPublic};
use sp_runtime::{
generic::{BlockId, OpaqueDigestItemId},
- Justification,
+ traits::NumberFor, Justification,
};
use sp_runtime::traits::{Block as BlockT, Header, DigestItemFor, Zero, Member};
use sp_api::ProvideRuntimeApi;
@@ -73,6 +73,7 @@ use sc_telemetry::{telemetry, CONSENSUS_TRACE, CONSENSUS_DEBUG, CONSENSUS_INFO};
use sc_consensus_slots::{
CheckedHeader, SlotInfo, SlotCompatible, StorageChanges, check_equivocation,
+ BackoffAuthoringBlocksStrategy,
};
use sp_api::ApiExt;
@@ -138,7 +139,7 @@ impl SlotCompatible for AuraSlotCompatible {
}
/// Start the aura worker. The returned future should be run in a futures executor.
-pub fn start_aura(
+pub fn start_aura(
slot_duration: SlotDuration,
client: Arc,
select_chain: SC,
@@ -147,11 +148,12 @@ pub fn start_aura(
sync_oracle: SO,
inherent_data_providers: InherentDataProviders,
force_authoring: bool,
+ backoff_authoring_blocks: Option,
keystore: SyncCryptoStorePtr,
can_author_with: CAW,
) -> Result, sp_consensus::Error> where
B: BlockT,
- C: ProvideRuntimeApi + BlockOf + ProvideCache + AuxStore + Send + Sync,
+ C: ProvideRuntimeApi + BlockOf + ProvideCache + AuxStore + HeaderBackend + Send + Sync,
C::Api: AuraApi>,
SC: SelectChain,
E: Environment + Send + Sync + 'static,
@@ -163,6 +165,7 @@ pub fn start_aura(
Error: std::error::Error + Send + From + 'static,
SO: SyncOracle + Send + Sync + Clone,
CAW: CanAuthorWith + Send,
+ BS: BackoffAuthoringBlocksStrategy> + Send + 'static,
{
let worker = AuraWorker {
client,
@@ -171,6 +174,7 @@ pub fn start_aura(
keystore,
sync_oracle: sync_oracle.clone(),
force_authoring,
+ backoff_authoring_blocks,
_key_type: PhantomData::,
};
register_aura_inherent_data_provider(
@@ -188,20 +192,22 @@ pub fn start_aura(
))
}
-struct AuraWorker