1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350
// 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 <https://www.gnu.org/licenses/>.
//! Service configuration.
pub use jsonrpsee::server::BatchRequestConfig as RpcBatchRequestConfig;
use prometheus_endpoint::Registry;
use sc_chain_spec::ChainSpec;
pub use sc_client_db::{BlocksPruning, Database, DatabaseSource, PruningMode};
pub use sc_executor::{WasmExecutionMethod, WasmtimeInstantiationStrategy};
pub use sc_network::{
config::{
MultiaddrWithPeerId, NetworkConfiguration, NodeKeyConfig, NonDefaultSetConfig, ProtocolId,
Role, SetConfig, SyncMode, TransportConfig,
},
request_responses::{
IncomingRequest, OutgoingResponse, ProtocolConfig as RequestResponseConfig,
},
Multiaddr,
};
pub use sc_rpc_server::{
IpNetwork, RpcEndpoint, RpcMethods, SubscriptionIdProvider as RpcSubscriptionIdProvider,
};
pub use sc_telemetry::TelemetryEndpoints;
pub use sc_transaction_pool::TransactionPoolOptions;
use sp_core::crypto::SecretString;
use std::{
io, iter,
net::SocketAddr,
num::NonZeroU32,
path::{Path, PathBuf},
};
use tempfile::TempDir;
/// Service configuration.
#[derive(Debug)]
pub struct Configuration {
/// Implementation name
pub impl_name: String,
/// Implementation version (see sc-cli to see an example of format)
pub impl_version: String,
/// Node role.
pub role: Role,
/// Handle to the tokio runtime. Will be used to spawn futures by the task manager.
pub tokio_handle: tokio::runtime::Handle,
/// Extrinsic pool configuration.
pub transaction_pool: TransactionPoolOptions,
/// Network configuration.
pub network: NetworkConfiguration,
/// Configuration for the keystore.
pub keystore: KeystoreConfig,
/// Configuration for the database.
pub database: DatabaseSource,
/// Maximum size of internal trie cache in bytes.
///
/// If `None` is given the cache is disabled.
pub trie_cache_maximum_size: Option<usize>,
/// State pruning settings.
pub state_pruning: Option<PruningMode>,
/// Number of blocks to keep in the db.
///
/// NOTE: only finalized blocks are subject for removal!
pub blocks_pruning: BlocksPruning,
/// Chain configuration.
pub chain_spec: Box<dyn ChainSpec>,
/// Runtime executor configuration.
pub executor: ExecutorConfiguration,
/// Directory where local WASM runtimes live. These runtimes take precedence
/// over on-chain runtimes when the spec version matches. Set to `None` to
/// disable overrides (default).
pub wasm_runtime_overrides: Option<PathBuf>,
/// RPC configuration.
pub rpc: RpcConfiguration,
/// Prometheus endpoint configuration. `None` if disabled.
pub prometheus_config: Option<PrometheusConfig>,
/// Telemetry service URL. `None` if disabled.
pub telemetry_endpoints: Option<TelemetryEndpoints>,
/// Should offchain workers be executed.
pub offchain_worker: OffchainWorkerConfig,
/// Enable authoring even when offline.
pub force_authoring: bool,
/// Disable GRANDPA when running in validator mode
pub disable_grandpa: bool,
/// Development key seed.
///
/// When running in development mode, the seed will be used to generate authority keys by the
/// keystore.
///
/// Should only be set when `node` is running development mode.
pub dev_key_seed: Option<String>,
/// Tracing targets
pub tracing_targets: Option<String>,
/// Tracing receiver
pub tracing_receiver: sc_tracing::TracingReceiver,
/// Announce block automatically after they have been imported
pub announce_block: bool,
/// Data path root for the configured chain.
pub data_path: PathBuf,
/// Base path of the configuration. This is shared between chains.
pub base_path: BasePath,
}
/// Type for tasks spawned by the executor.
#[derive(PartialEq)]
pub enum TaskType {
/// Regular non-blocking futures. Polling the task is expected to be a lightweight operation.
Async,
/// The task might perform a lot of expensive CPU operations and/or call `thread::sleep`.
Blocking,
}
/// Configuration of the client keystore.
#[derive(Debug, Clone)]
pub enum KeystoreConfig {
/// Keystore at a path on-disk. Recommended for native nodes.
Path {
/// The path of the keystore.
path: PathBuf,
/// Node keystore's password.
password: Option<SecretString>,
},
/// In-memory keystore. Recommended for in-browser nodes.
InMemory,
}
impl KeystoreConfig {
/// Returns the path for the keystore.
pub fn path(&self) -> Option<&Path> {
match self {
Self::Path { path, .. } => Some(path),
Self::InMemory => None,
}
}
}
/// Configuration of the database of the client.
#[derive(Debug, Clone, Default)]
pub struct OffchainWorkerConfig {
/// If this is allowed.
pub enabled: bool,
/// allow writes from the runtime to the offchain worker database.
pub indexing_enabled: bool,
}
/// Configuration of the Prometheus endpoint.
#[derive(Debug, Clone)]
pub struct PrometheusConfig {
/// Port to use.
pub port: SocketAddr,
/// A metrics registry to use. Useful for setting the metric prefix.
pub registry: Registry,
}
impl PrometheusConfig {
/// Create a new config using the default registry.
pub fn new_with_default_registry(port: SocketAddr, chain_id: String) -> Self {
let param = iter::once((String::from("chain"), chain_id)).collect();
Self {
port,
registry: Registry::new_custom(None, Some(param))
.expect("this can only fail if the prefix is empty"),
}
}
}
impl Configuration {
/// Returns a string displaying the node role.
pub fn display_role(&self) -> String {
self.role.to_string()
}
/// Returns the prometheus metrics registry, if available.
pub fn prometheus_registry(&self) -> Option<&Registry> {
self.prometheus_config.as_ref().map(|config| &config.registry)
}
/// Returns the network protocol id from the chain spec, or the default.
pub fn protocol_id(&self) -> ProtocolId {
let protocol_id_full = match self.chain_spec.protocol_id() {
Some(pid) => pid,
None => {
log::warn!(
"Using default protocol ID {:?} because none is configured in the \
chain specs",
crate::DEFAULT_PROTOCOL_ID
);
crate::DEFAULT_PROTOCOL_ID
},
};
ProtocolId::from(protocol_id_full)
}
/// Returns true if the genesis state writing will be skipped while initializing the genesis
/// block.
pub fn no_genesis(&self) -> bool {
matches!(self.network.sync_mode, SyncMode::LightState { .. } | SyncMode::Warp { .. })
}
/// Returns the database config for creating the backend.
pub fn db_config(&self) -> sc_client_db::DatabaseSettings {
sc_client_db::DatabaseSettings {
trie_cache_maximum_size: self.trie_cache_maximum_size,
state_pruning: self.state_pruning.clone(),
source: self.database.clone(),
blocks_pruning: self.blocks_pruning,
}
}
}
#[static_init::dynamic(drop, lazy)]
static mut BASE_PATH_TEMP: Option<TempDir> = None;
/// The base path that is used for everything that needs to be written on disk to run a node.
#[derive(Clone, Debug)]
pub struct BasePath {
path: PathBuf,
}
impl BasePath {
/// Create a `BasePath` instance using a temporary directory prefixed with "substrate" and use
/// it as base path.
///
/// Note: The temporary directory will be created automatically and deleted when the program
/// exits. Every call to this function will return the same path for the lifetime of the
/// program.
pub fn new_temp_dir() -> io::Result<BasePath> {
let mut temp = BASE_PATH_TEMP.write();
match &*temp {
Some(p) => Ok(Self::new(p.path())),
None => {
let temp_dir = tempfile::Builder::new().prefix("substrate").tempdir()?;
let path = PathBuf::from(temp_dir.path());
*temp = Some(temp_dir);
Ok(Self::new(path))
},
}
}
/// Create a `BasePath` instance based on an existing path on disk.
///
/// Note: this function will not ensure that the directory exist nor create the directory. It
/// will also not delete the directory when the instance is dropped.
pub fn new<P: Into<PathBuf>>(path: P) -> BasePath {
Self { path: path.into() }
}
/// Create a base path from values describing the project.
pub fn from_project(qualifier: &str, organization: &str, application: &str) -> BasePath {
BasePath::new(
directories::ProjectDirs::from(qualifier, organization, application)
.expect("app directories exist on all supported platforms; qed")
.data_local_dir(),
)
}
/// Retrieve the base path.
pub fn path(&self) -> &Path {
&self.path
}
/// Returns the configuration directory inside this base path.
///
/// The path looks like `$base_path/chains/$chain_id`
pub fn config_dir(&self, chain_id: &str) -> PathBuf {
self.path().join("chains").join(chain_id)
}
}
impl From<PathBuf> for BasePath {
fn from(path: PathBuf) -> Self {
BasePath::new(path)
}
}
/// RPC configuration.
#[derive(Debug)]
pub struct RpcConfiguration {
/// JSON-RPC server endpoints.
pub addr: Option<Vec<RpcEndpoint>>,
/// Maximum number of connections for JSON-RPC server.
pub max_connections: u32,
/// CORS settings for HTTP & WS servers. `None` if all origins are allowed.
pub cors: Option<Vec<String>>,
/// RPC methods to expose (by default only a safe subset or all of them).
pub methods: RpcMethods,
/// Maximum payload of a rpc request
pub max_request_size: u32,
/// Maximum payload of a rpc response.
pub max_response_size: u32,
/// Custom JSON-RPC subscription ID provider.
///
/// Default: [`crate::RandomStringSubscriptionId`].
pub id_provider: Option<Box<dyn RpcSubscriptionIdProvider>>,
/// Maximum allowed subscriptions per rpc connection
pub max_subs_per_conn: u32,
/// JSON-RPC server default port.
pub port: u16,
/// The number of messages the JSON-RPC server is allowed to keep in memory.
pub message_buffer_capacity: u32,
/// JSON-RPC server batch config.
pub batch_config: RpcBatchRequestConfig,
/// RPC rate limit per minute.
pub rate_limit: Option<NonZeroU32>,
/// RPC rate limit whitelisted ip addresses.
pub rate_limit_whitelisted_ips: Vec<IpNetwork>,
/// RPC rate limit trust proxy headers.
pub rate_limit_trust_proxy_headers: bool,
}
/// Runtime executor configuration.
#[derive(Debug, Clone)]
pub struct ExecutorConfiguration {
/// Wasm execution method.
pub wasm_method: WasmExecutionMethod,
/// The size of the instances cache.
///
/// The default value is 8.
pub max_runtime_instances: usize,
/// The default number of 64KB pages to allocate for Wasm execution
pub default_heap_pages: Option<u64>,
/// Maximum number of different runtime versions that can be cached.
pub runtime_cache_size: u8,
}
impl Default for ExecutorConfiguration {
fn default() -> Self {
Self {
wasm_method: WasmExecutionMethod::default(),
max_runtime_instances: 8,
default_heap_pages: None,
runtime_cache_size: 2,
}
}
}