sc_cli/
config.rs

1// This file is part of Substrate.
2
3// Copyright (C) Parity Technologies (UK) Ltd.
4// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0
5
6// This program is free software: you can redistribute it and/or modify
7// it under the terms of the GNU General Public License as published by
8// the Free Software Foundation, either version 3 of the License, or
9// (at your option) any later version.
10
11// This program is distributed in the hope that it will be useful,
12// but WITHOUT ANY WARRANTY; without even the implied warranty of
13// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14// GNU General Public License for more details.
15
16// You should have received a copy of the GNU General Public License
17// along with this program. If not, see <https://www.gnu.org/licenses/>.
18
19//! Configuration trait for a CLI based on substrate
20
21use crate::{
22	arg_enums::Database, error::Result, DatabaseParams, ImportParams, KeystoreParams,
23	NetworkParams, NodeKeyParams, OffchainWorkerParams, PruningParams, RpcEndpoint, SharedParams,
24	SubstrateCli,
25};
26use log::warn;
27use names::{Generator, Name};
28use sc_service::{
29	config::{
30		BasePath, Configuration, DatabaseSource, ExecutorConfiguration, IpNetwork, KeystoreConfig,
31		NetworkConfiguration, NodeKeyConfig, OffchainWorkerConfig, PrometheusConfig, PruningMode,
32		Role, RpcBatchRequestConfig, RpcConfiguration, RpcMethods, TelemetryEndpoints,
33		TransactionPoolOptions, WasmExecutionMethod,
34	},
35	BlocksPruning, ChainSpec, TracingReceiver,
36};
37use sc_tracing::logging::LoggerBuilder;
38use std::{num::NonZeroU32, path::PathBuf};
39
40/// The maximum number of characters for a node name.
41pub(crate) const NODE_NAME_MAX_LENGTH: usize = 64;
42
43/// Default sub directory to store network config.
44pub(crate) const DEFAULT_NETWORK_CONFIG_PATH: &str = "network";
45
46/// The recommended open file descriptor limit to be configured for the process.
47const RECOMMENDED_OPEN_FILE_DESCRIPTOR_LIMIT: u64 = 10_000;
48
49/// The default port.
50pub const RPC_DEFAULT_PORT: u16 = 9944;
51/// The default max number of subscriptions per connection.
52pub const RPC_DEFAULT_MAX_SUBS_PER_CONN: u32 = 1024;
53/// The default max request size in MB.
54pub const RPC_DEFAULT_MAX_REQUEST_SIZE_MB: u32 = 15;
55/// The default max response size in MB.
56pub const RPC_DEFAULT_MAX_RESPONSE_SIZE_MB: u32 = 15;
57/// The default concurrent connection limit.
58pub const RPC_DEFAULT_MAX_CONNECTIONS: u32 = 100;
59/// The default number of messages the RPC server
60/// is allowed to keep in memory per connection.
61pub const RPC_DEFAULT_MESSAGE_CAPACITY_PER_CONN: u32 = 64;
62
63/// Default configuration values used by Substrate
64///
65/// These values will be used by [`CliConfiguration`] to set
66/// default values for e.g. the listen port or the RPC port.
67pub trait DefaultConfigurationValues {
68	/// The port Substrate should listen on for p2p connections.
69	///
70	/// By default this is `30333`.
71	fn p2p_listen_port() -> u16 {
72		30333
73	}
74
75	/// The port Substrate should listen on for JSON-RPC connections.
76	///
77	/// By default this is `9944`.
78	fn rpc_listen_port() -> u16 {
79		RPC_DEFAULT_PORT
80	}
81
82	/// The port Substrate should listen on for prometheus connections.
83	///
84	/// By default this is `9615`.
85	fn prometheus_listen_port() -> u16 {
86		9615
87	}
88}
89
90impl DefaultConfigurationValues for () {}
91
92/// A trait that allows converting an object to a Configuration
93pub trait CliConfiguration<DCV: DefaultConfigurationValues = ()>: Sized {
94	/// Get the SharedParams for this object
95	fn shared_params(&self) -> &SharedParams;
96
97	/// Get the ImportParams for this object
98	fn import_params(&self) -> Option<&ImportParams> {
99		None
100	}
101
102	/// Get the PruningParams for this object
103	fn pruning_params(&self) -> Option<&PruningParams> {
104		self.import_params().map(|x| &x.pruning_params)
105	}
106
107	/// Get the KeystoreParams for this object
108	fn keystore_params(&self) -> Option<&KeystoreParams> {
109		None
110	}
111
112	/// Get the NetworkParams for this object
113	fn network_params(&self) -> Option<&NetworkParams> {
114		None
115	}
116
117	/// Get a reference to `OffchainWorkerParams` for this object.
118	fn offchain_worker_params(&self) -> Option<&OffchainWorkerParams> {
119		None
120	}
121
122	/// Get the NodeKeyParams for this object
123	fn node_key_params(&self) -> Option<&NodeKeyParams> {
124		self.network_params().map(|x| &x.node_key_params)
125	}
126
127	/// Get the DatabaseParams for this object
128	fn database_params(&self) -> Option<&DatabaseParams> {
129		self.import_params().map(|x| &x.database_params)
130	}
131
132	/// Get the base path of the configuration (if any)
133	///
134	/// By default this is retrieved from `SharedParams`.
135	fn base_path(&self) -> Result<Option<BasePath>> {
136		self.shared_params().base_path()
137	}
138
139	/// Returns `true` if the node is for development or not
140	///
141	/// By default this is retrieved from `SharedParams`.
142	fn is_dev(&self) -> Result<bool> {
143		Ok(self.shared_params().is_dev())
144	}
145
146	/// Gets the role
147	///
148	/// By default this is `Role::Full`.
149	fn role(&self, _is_dev: bool) -> Result<Role> {
150		Ok(Role::Full)
151	}
152
153	/// Get the transaction pool options
154	///
155	/// By default this is `TransactionPoolOptions::default()`.
156	fn transaction_pool(&self, _is_dev: bool) -> Result<TransactionPoolOptions> {
157		Ok(Default::default())
158	}
159
160	/// Get the network configuration
161	///
162	/// By default this is retrieved from `NetworkParams` if it is available otherwise it creates
163	/// a default `NetworkConfiguration` based on `node_name`, `client_id`, `node_key` and
164	/// `net_config_dir`.
165	fn network_config(
166		&self,
167		chain_spec: &Box<dyn ChainSpec>,
168		is_dev: bool,
169		is_validator: bool,
170		net_config_dir: PathBuf,
171		client_id: &str,
172		node_name: &str,
173		node_key: NodeKeyConfig,
174		default_listen_port: u16,
175	) -> Result<NetworkConfiguration> {
176		let network_config = if let Some(network_params) = self.network_params() {
177			network_params.network_config(
178				chain_spec,
179				is_dev,
180				is_validator,
181				Some(net_config_dir),
182				client_id,
183				node_name,
184				node_key,
185				default_listen_port,
186			)
187		} else {
188			NetworkConfiguration::new(node_name, client_id, node_key, Some(net_config_dir))
189		};
190
191		// TODO: Return error here in the next release:
192		// https://github.com/paritytech/polkadot-sdk/issues/5266
193		// if is_validator && network_config.public_addresses.is_empty() {}
194
195		Ok(network_config)
196	}
197
198	/// Get the keystore configuration.
199	///
200	/// By default this is retrieved from `KeystoreParams` if it is available. Otherwise it uses
201	/// `KeystoreConfig::InMemory`.
202	fn keystore_config(&self, config_dir: &PathBuf) -> Result<KeystoreConfig> {
203		self.keystore_params()
204			.map(|x| x.keystore_config(config_dir))
205			.unwrap_or_else(|| Ok(KeystoreConfig::InMemory))
206	}
207
208	/// Get the database cache size.
209	///
210	/// By default this is retrieved from `DatabaseParams` if it is available. Otherwise its `None`.
211	fn database_cache_size(&self) -> Result<Option<usize>> {
212		Ok(self.database_params().map(|x| x.database_cache_size()).unwrap_or_default())
213	}
214
215	/// Get the database backend variant.
216	///
217	/// By default this is retrieved from `DatabaseParams` if it is available. Otherwise its `None`.
218	fn database(&self) -> Result<Option<Database>> {
219		Ok(self.database_params().and_then(|x| x.database()))
220	}
221
222	/// Get the database configuration object for the parameters provided
223	fn database_config(
224		&self,
225		base_path: &PathBuf,
226		cache_size: usize,
227		database: Database,
228	) -> Result<DatabaseSource> {
229		let role_dir = "full";
230		let rocksdb_path = base_path.join("db").join(role_dir);
231		let paritydb_path = base_path.join("paritydb").join(role_dir);
232		Ok(match database {
233			#[cfg(feature = "rocksdb")]
234			Database::RocksDb => DatabaseSource::RocksDb { path: rocksdb_path, cache_size },
235			Database::ParityDb => DatabaseSource::ParityDb { path: paritydb_path },
236			Database::ParityDbDeprecated => {
237				eprintln!(
238					"WARNING: \"paritydb-experimental\" database setting is deprecated and will be removed in future releases. \
239				Please update your setup to use the new value: \"paritydb\"."
240				);
241				DatabaseSource::ParityDb { path: paritydb_path }
242			},
243			Database::Auto => DatabaseSource::Auto { paritydb_path, rocksdb_path, cache_size },
244		})
245	}
246
247	/// Get the trie cache maximum size.
248	///
249	/// By default this is retrieved from `ImportParams` if it is available. Otherwise its `0`.
250	/// If `None` is returned the trie cache is disabled.
251	fn trie_cache_maximum_size(&self) -> Result<Option<usize>> {
252		Ok(self.import_params().map(|x| x.trie_cache_maximum_size()).unwrap_or_default())
253	}
254
255	/// Get the state pruning mode.
256	///
257	/// By default this is retrieved from `PruningMode` if it is available. Otherwise its
258	/// `PruningMode::default()`.
259	fn state_pruning(&self) -> Result<Option<PruningMode>> {
260		self.pruning_params()
261			.map(|x| x.state_pruning())
262			.unwrap_or_else(|| Ok(Default::default()))
263	}
264
265	/// Get the block pruning mode.
266	///
267	/// By default this is retrieved from `block_pruning` if it is available. Otherwise its
268	/// `BlocksPruning::KeepFinalized`.
269	fn blocks_pruning(&self) -> Result<BlocksPruning> {
270		self.pruning_params()
271			.map(|x| x.blocks_pruning())
272			.unwrap_or_else(|| Ok(BlocksPruning::KeepFinalized))
273	}
274
275	/// Get the chain ID (string).
276	///
277	/// By default this is retrieved from `SharedParams`.
278	fn chain_id(&self, is_dev: bool) -> Result<String> {
279		Ok(self.shared_params().chain_id(is_dev))
280	}
281
282	/// Get the name of the node.
283	///
284	/// By default a random name is generated.
285	fn node_name(&self) -> Result<String> {
286		Ok(generate_node_name())
287	}
288
289	/// Get the WASM execution method.
290	///
291	/// By default this is retrieved from `ImportParams` if it is available. Otherwise its
292	/// `WasmExecutionMethod::default()`.
293	fn wasm_method(&self) -> Result<WasmExecutionMethod> {
294		Ok(self.import_params().map(|x| x.wasm_method()).unwrap_or_default())
295	}
296
297	/// Get the path where WASM overrides live.
298	///
299	/// By default this is `None`.
300	fn wasm_runtime_overrides(&self) -> Option<PathBuf> {
301		self.import_params().map(|x| x.wasm_runtime_overrides()).unwrap_or_default()
302	}
303
304	/// Get the RPC address.
305	fn rpc_addr(&self, _default_listen_port: u16) -> Result<Option<Vec<RpcEndpoint>>> {
306		Ok(None)
307	}
308
309	/// Returns the RPC method set to expose.
310	///
311	/// By default this is `RpcMethods::Auto` (unsafe RPCs are denied iff
312	/// `rpc_external` returns true, respectively).
313	fn rpc_methods(&self) -> Result<RpcMethods> {
314		Ok(Default::default())
315	}
316
317	/// Get the maximum number of RPC server connections.
318	fn rpc_max_connections(&self) -> Result<u32> {
319		Ok(RPC_DEFAULT_MAX_CONNECTIONS)
320	}
321
322	/// Get the RPC cors (`None` if disabled)
323	///
324	/// By default this is `Some(Vec::new())`.
325	fn rpc_cors(&self, _is_dev: bool) -> Result<Option<Vec<String>>> {
326		Ok(Some(Vec::new()))
327	}
328
329	/// Get maximum RPC request payload size.
330	fn rpc_max_request_size(&self) -> Result<u32> {
331		Ok(RPC_DEFAULT_MAX_REQUEST_SIZE_MB)
332	}
333
334	/// Get maximum RPC response payload size.
335	fn rpc_max_response_size(&self) -> Result<u32> {
336		Ok(RPC_DEFAULT_MAX_RESPONSE_SIZE_MB)
337	}
338
339	/// Get maximum number of subscriptions per connection.
340	fn rpc_max_subscriptions_per_connection(&self) -> Result<u32> {
341		Ok(RPC_DEFAULT_MAX_SUBS_PER_CONN)
342	}
343
344	/// The number of messages the RPC server is allowed to keep in memory per connection.
345	fn rpc_buffer_capacity_per_connection(&self) -> Result<u32> {
346		Ok(RPC_DEFAULT_MESSAGE_CAPACITY_PER_CONN)
347	}
348
349	/// RPC server batch request configuration.
350	fn rpc_batch_config(&self) -> Result<RpcBatchRequestConfig> {
351		Ok(RpcBatchRequestConfig::Unlimited)
352	}
353
354	/// RPC rate limit configuration.
355	fn rpc_rate_limit(&self) -> Result<Option<NonZeroU32>> {
356		Ok(None)
357	}
358
359	/// RPC rate limit whitelisted ip addresses.
360	fn rpc_rate_limit_whitelisted_ips(&self) -> Result<Vec<IpNetwork>> {
361		Ok(vec![])
362	}
363
364	/// RPC rate limit trust proxy headers.
365	fn rpc_rate_limit_trust_proxy_headers(&self) -> Result<bool> {
366		Ok(false)
367	}
368
369	/// Get the prometheus configuration (`None` if disabled)
370	///
371	/// By default this is `None`.
372	fn prometheus_config(
373		&self,
374		_default_listen_port: u16,
375		_chain_spec: &Box<dyn ChainSpec>,
376	) -> Result<Option<PrometheusConfig>> {
377		Ok(None)
378	}
379
380	/// Get the telemetry endpoints (if any)
381	///
382	/// By default this is retrieved from the chain spec loaded by `load_spec`.
383	fn telemetry_endpoints(
384		&self,
385		chain_spec: &Box<dyn ChainSpec>,
386	) -> Result<Option<TelemetryEndpoints>> {
387		Ok(chain_spec.telemetry_endpoints().clone())
388	}
389
390	/// Get the default value for heap pages
391	///
392	/// By default this is `None`.
393	fn default_heap_pages(&self) -> Result<Option<u64>> {
394		Ok(None)
395	}
396
397	/// Returns an offchain worker config wrapped in `Ok(_)`
398	///
399	/// By default offchain workers are disabled.
400	fn offchain_worker(&self, role: &Role) -> Result<OffchainWorkerConfig> {
401		self.offchain_worker_params()
402			.map(|x| x.offchain_worker(role))
403			.unwrap_or_else(|| Ok(OffchainWorkerConfig::default()))
404	}
405
406	/// Returns `Ok(true)` if authoring should be forced
407	///
408	/// By default this is `false`.
409	fn force_authoring(&self) -> Result<bool> {
410		Ok(Default::default())
411	}
412
413	/// Returns `Ok(true)` if grandpa should be disabled
414	///
415	/// By default this is `false`.
416	fn disable_grandpa(&self) -> Result<bool> {
417		Ok(Default::default())
418	}
419
420	/// Get the development key seed from the current object
421	///
422	/// By default this is `None`.
423	fn dev_key_seed(&self, _is_dev: bool) -> Result<Option<String>> {
424		Ok(Default::default())
425	}
426
427	/// Get the tracing targets from the current object (if any)
428	///
429	/// By default this is retrieved from [`SharedParams`] if it is available. Otherwise its
430	/// `None`.
431	fn tracing_targets(&self) -> Result<Option<String>> {
432		Ok(self.shared_params().tracing_targets())
433	}
434
435	/// Get the TracingReceiver value from the current object
436	///
437	/// By default this is retrieved from [`SharedParams`] if it is available. Otherwise its
438	/// `TracingReceiver::default()`.
439	fn tracing_receiver(&self) -> Result<TracingReceiver> {
440		Ok(self.shared_params().tracing_receiver())
441	}
442
443	/// Get the node key from the current object
444	///
445	/// By default this is retrieved from `NodeKeyParams` if it is available. Otherwise its
446	/// `NodeKeyConfig::default()`.
447	fn node_key(&self, net_config_dir: &PathBuf) -> Result<NodeKeyConfig> {
448		let is_dev = self.is_dev()?;
449		let role = self.role(is_dev)?;
450		self.node_key_params()
451			.map(|x| x.node_key(net_config_dir, role, is_dev))
452			.unwrap_or_else(|| Ok(Default::default()))
453	}
454
455	/// Get maximum runtime instances
456	///
457	/// By default this is `None`.
458	fn max_runtime_instances(&self) -> Result<Option<usize>> {
459		Ok(Default::default())
460	}
461
462	/// Get maximum different runtimes in cache
463	///
464	/// By default this is `2`.
465	fn runtime_cache_size(&self) -> Result<u8> {
466		Ok(2)
467	}
468
469	/// Activate or not the automatic announcing of blocks after import
470	///
471	/// By default this is `false`.
472	fn announce_block(&self) -> Result<bool> {
473		Ok(true)
474	}
475
476	/// Create a Configuration object from the current object
477	fn create_configuration<C: SubstrateCli>(
478		&self,
479		cli: &C,
480		tokio_handle: tokio::runtime::Handle,
481	) -> Result<Configuration> {
482		let is_dev = self.is_dev()?;
483		let chain_id = self.chain_id(is_dev)?;
484		let chain_spec = cli.load_spec(&chain_id)?;
485		let base_path = base_path_or_default(self.base_path()?, &C::executable_name());
486		let config_dir = build_config_dir(&base_path, chain_spec.id());
487		let net_config_dir = build_net_config_dir(&config_dir);
488		let client_id = C::client_id();
489		let database_cache_size = self.database_cache_size()?.unwrap_or(1024);
490		let database = self.database()?.unwrap_or(
491			#[cfg(feature = "rocksdb")]
492			{
493				Database::RocksDb
494			},
495			#[cfg(not(feature = "rocksdb"))]
496			{
497				Database::ParityDb
498			},
499		);
500		let node_key = self.node_key(&net_config_dir)?;
501		let role = self.role(is_dev)?;
502		let max_runtime_instances = self.max_runtime_instances()?.unwrap_or(8);
503		let is_validator = role.is_authority();
504		let keystore = self.keystore_config(&config_dir)?;
505		let telemetry_endpoints = self.telemetry_endpoints(&chain_spec)?;
506		let runtime_cache_size = self.runtime_cache_size()?;
507
508		let rpc_addrs: Option<Vec<sc_service::config::RpcEndpoint>> = self
509			.rpc_addr(DCV::rpc_listen_port())?
510			.map(|addrs| addrs.into_iter().map(Into::into).collect());
511
512		Ok(Configuration {
513			impl_name: C::impl_name(),
514			impl_version: C::impl_version(),
515			tokio_handle,
516			transaction_pool: self.transaction_pool(is_dev)?,
517			network: self.network_config(
518				&chain_spec,
519				is_dev,
520				is_validator,
521				net_config_dir,
522				client_id.as_str(),
523				self.node_name()?.as_str(),
524				node_key,
525				DCV::p2p_listen_port(),
526			)?,
527			keystore,
528			database: self.database_config(&config_dir, database_cache_size, database)?,
529			data_path: config_dir,
530			trie_cache_maximum_size: self.trie_cache_maximum_size()?,
531			state_pruning: self.state_pruning()?,
532			blocks_pruning: self.blocks_pruning()?,
533			executor: ExecutorConfiguration {
534				wasm_method: self.wasm_method()?,
535				default_heap_pages: self.default_heap_pages()?,
536				max_runtime_instances,
537				runtime_cache_size,
538			},
539			wasm_runtime_overrides: self.wasm_runtime_overrides(),
540			rpc: RpcConfiguration {
541				addr: rpc_addrs,
542				methods: self.rpc_methods()?,
543				max_connections: self.rpc_max_connections()?,
544				cors: self.rpc_cors(is_dev)?,
545				max_request_size: self.rpc_max_request_size()?,
546				max_response_size: self.rpc_max_response_size()?,
547				id_provider: None,
548				max_subs_per_conn: self.rpc_max_subscriptions_per_connection()?,
549				port: DCV::rpc_listen_port(),
550				message_buffer_capacity: self.rpc_buffer_capacity_per_connection()?,
551				batch_config: self.rpc_batch_config()?,
552				rate_limit: self.rpc_rate_limit()?,
553				rate_limit_whitelisted_ips: self.rpc_rate_limit_whitelisted_ips()?,
554				rate_limit_trust_proxy_headers: self.rpc_rate_limit_trust_proxy_headers()?,
555			},
556			prometheus_config: self
557				.prometheus_config(DCV::prometheus_listen_port(), &chain_spec)?,
558			telemetry_endpoints,
559			offchain_worker: self.offchain_worker(&role)?,
560			force_authoring: self.force_authoring()?,
561			disable_grandpa: self.disable_grandpa()?,
562			dev_key_seed: self.dev_key_seed(is_dev)?,
563			tracing_targets: self.tracing_targets()?,
564			tracing_receiver: self.tracing_receiver()?,
565			chain_spec,
566			announce_block: self.announce_block()?,
567			role,
568			base_path,
569		})
570	}
571
572	/// Get the filters for the logging.
573	///
574	/// This should be a list of comma-separated values.
575	/// Example: `foo=trace,bar=debug,baz=info`
576	///
577	/// By default this is retrieved from `SharedParams`.
578	fn log_filters(&self) -> Result<String> {
579		Ok(self.shared_params().log_filters().join(","))
580	}
581
582	/// Should the detailed log output be enabled.
583	fn detailed_log_output(&self) -> Result<bool> {
584		Ok(self.shared_params().detailed_log_output())
585	}
586
587	/// Is log reloading enabled?
588	fn enable_log_reloading(&self) -> Result<bool> {
589		Ok(self.shared_params().enable_log_reloading())
590	}
591
592	/// Should the log color output be disabled?
593	fn disable_log_color(&self) -> Result<bool> {
594		Ok(self.shared_params().disable_log_color())
595	}
596
597	/// Initialize substrate. This must be done only once per process.
598	///
599	/// This method:
600	///
601	/// 1. Sets the panic handler
602	/// 2. Optionally customize logger/profiling
603	/// 2. Initializes the logger
604	/// 3. Raises the FD limit
605	///
606	/// The `logger_hook` closure is executed before the logger is constructed
607	/// and initialized. It is useful for setting up a custom profiler.
608	///
609	/// Example:
610	/// ```
611	/// use sc_tracing::{SpanDatum, TraceEvent};
612	/// struct TestProfiler;
613	///
614	/// impl sc_tracing::TraceHandler for TestProfiler {
615	///  	fn handle_span(&self, sd: &SpanDatum) {}
616	/// 		fn handle_event(&self, _event: &TraceEvent) {}
617	/// };
618	///
619	/// fn logger_hook() -> impl FnOnce(&mut sc_cli::LoggerBuilder, &sc_service::Configuration) -> () {
620	/// 	|logger_builder, config| {
621	/// 			logger_builder.with_custom_profiling(Box::new(TestProfiler{}));
622	/// 	}
623	/// }
624	/// ```
625	fn init<F>(&self, support_url: &String, impl_version: &String, logger_hook: F) -> Result<()>
626	where
627		F: FnOnce(&mut LoggerBuilder),
628	{
629		sp_panic_handler::set(support_url, impl_version);
630
631		let mut logger = LoggerBuilder::new(self.log_filters()?);
632		logger
633			.with_log_reloading(self.enable_log_reloading()?)
634			.with_detailed_output(self.detailed_log_output()?);
635
636		if let Some(tracing_targets) = self.tracing_targets()? {
637			let tracing_receiver = self.tracing_receiver()?;
638			logger.with_profiling(tracing_receiver, tracing_targets);
639		}
640
641		if self.disable_log_color()? {
642			logger.with_colors(false);
643		}
644
645		// Call hook for custom profiling setup.
646		logger_hook(&mut logger);
647
648		logger.init()?;
649
650		match fdlimit::raise_fd_limit() {
651			Ok(fdlimit::Outcome::LimitRaised { to, .. }) =>
652				if to < RECOMMENDED_OPEN_FILE_DESCRIPTOR_LIMIT {
653					warn!(
654						"Low open file descriptor limit configured for the process. \
655						Current value: {:?}, recommended value: {:?}.",
656						to, RECOMMENDED_OPEN_FILE_DESCRIPTOR_LIMIT,
657					);
658				},
659			Ok(fdlimit::Outcome::Unsupported) => {
660				// Unsupported platform (non-Linux)
661			},
662			Err(error) => {
663				warn!(
664					"Failed to configure file descriptor limit for the process: \
665					{}, recommended value: {:?}.",
666					error, RECOMMENDED_OPEN_FILE_DESCRIPTOR_LIMIT,
667				);
668			},
669		}
670
671		Ok(())
672	}
673}
674
675/// Generate a valid random name for the node
676pub fn generate_node_name() -> String {
677	loop {
678		let node_name = Generator::with_naming(Name::Numbered)
679			.next()
680			.expect("RNG is available on all supported platforms; qed");
681		let count = node_name.chars().count();
682
683		if count < NODE_NAME_MAX_LENGTH {
684			return node_name
685		}
686	}
687}
688
689/// Returns the value of `base_path` or the default_path if it is None
690pub(crate) fn base_path_or_default(
691	base_path: Option<BasePath>,
692	executable_name: &String,
693) -> BasePath {
694	base_path.unwrap_or_else(|| BasePath::from_project("", "", executable_name))
695}
696
697/// Returns the default path for configuration  directory based on the chain_spec
698pub(crate) fn build_config_dir(base_path: &BasePath, chain_spec_id: &str) -> PathBuf {
699	base_path.config_dir(chain_spec_id)
700}
701
702/// Returns the default path for the network configuration inside the configuration dir
703pub(crate) fn build_net_config_dir(config_dir: &PathBuf) -> PathBuf {
704	config_dir.join(DEFAULT_NETWORK_CONFIG_PATH)
705}
706
707/// Returns the default path for the network directory starting from the provided base_path
708/// or from the default base_path.
709pub(crate) fn build_network_key_dir_or_default(
710	base_path: Option<BasePath>,
711	chain_spec_id: &str,
712	executable_name: &String,
713) -> PathBuf {
714	let config_dir =
715		build_config_dir(&base_path_or_default(base_path, executable_name), chain_spec_id);
716	build_net_config_dir(&config_dir)
717}
sc_cli/config.rs

sc_cli/
config.rs
