// This file is part of Substrate. // Copyright (C) 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 . use crate::arg_enums::TracingReceiver; use clap::Args; use sc_service::config::BasePath; use std::path::PathBuf; /// Shared parameters used by all `CoreParams`. #[derive(Debug, Clone, Args)] pub struct SharedParams { /// 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). #[arg(long, value_name = "CHAIN_SPEC")] pub chain: Option, /// Specify the development chain. /// /// This flag sets `--chain=dev`, `--force-authoring`, `--rpc-cors=all`, /// `--alice`, and `--tmp` flags, unless explicitly overridden. /// It also disables local peer discovery (see --no-mdns and --discover-local) #[arg(long, conflicts_with_all = &["chain"])] pub dev: bool, /// Specify custom base path. #[arg(long, short = 'd', value_name = "PATH")] pub base_path: Option, /// Sets a custom logging filter (syntax: `=`). /// /// Log levels (least to most verbose) are `error`, `warn`, `info`, `debug`, and `trace`. /// /// By default, all targets log `info`. The global log level can be set with `-l`. /// /// Multiple `=` entries can be specified and separated by a comma. /// /// *Example*: `--log error,sync=debug,grandpa=warn`. /// Sets Global log level to `error`, sets `sync` target to debug and grandpa target to `warn`. #[arg(short = 'l', long, value_name = "LOG_PATTERN", num_args = 1..)] pub log: Vec, /// Enable detailed log output. /// /// Includes displaying the log target, log level and thread name. /// /// This is automatically enabled when something is logged with any higher level than `info`. #[arg(long)] pub detailed_log_output: bool, /// Disable log color output. #[arg(long)] pub disable_log_color: bool, /// Enable feature to dynamically update and reload the log filter. /// /// Be aware that enabling this feature can lead to a performance decrease up to factor six or /// more. Depending on the global logging level the performance decrease changes. /// /// The `system_addLogFilter` and `system_resetLogFilter` RPCs will have no effect with this /// option not being set. #[arg(long)] pub enable_log_reloading: bool, /// Sets a custom profiling filter. /// /// Syntax is the same as for logging (`--log`). #[arg(long, value_name = "TARGETS")] pub tracing_targets: Option, /// Receiver to process tracing messages. #[arg(long, value_name = "RECEIVER", value_enum, ignore_case = true, default_value_t = TracingReceiver::Log)] pub tracing_receiver: TracingReceiver, } impl SharedParams { /// Specify custom base path. pub fn base_path(&self) -> Result, crate::Error> { match &self.base_path { Some(r) => Ok(Some(r.clone().into())), // If `dev` is enabled, we use the temp base path. None if self.is_dev() => Ok(Some(BasePath::new_temp_dir()?)), None => Ok(None), } } /// Specify the development chain. pub fn is_dev(&self) -> bool { self.dev } /// Get the chain spec for the parameters provided pub fn chain_id(&self, is_dev: bool) -> String { match self.chain { Some(ref chain) => chain.clone(), None => if is_dev { "dev".into() } else { "".into() }, } } /// Get the filters for the logging pub fn log_filters(&self) -> &[String] { &self.log } /// Should the detailed log output be enabled. pub fn detailed_log_output(&self) -> bool { self.detailed_log_output } /// Should the log color output be disabled? pub fn disable_log_color(&self) -> bool { self.disable_log_color } /// Is log reloading enabled pub fn enable_log_reloading(&self) -> bool { self.enable_log_reloading } /// Receiver to process tracing messages. pub fn tracing_receiver(&self) -> sc_service::TracingReceiver { self.tracing_receiver.into() } /// Comma separated list of targets for tracing. pub fn tracing_targets(&self) -> Option { self.tracing_targets.clone() } }