// Copyright 2017-2020 Parity Technologies (UK) Ltd.
// This file is part of Substrate.
// Substrate 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.
// Substrate 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 Substrate. If not, see .
use crate::{Service, NetworkStatus, NetworkState, error::Error, DEFAULT_PROTOCOL_ID, MallocSizeOfWasm};
use crate::{TaskManagerBuilder, start_rpc_servers, build_network_future, TransactionPoolAdapter};
use crate::status_sinks;
use crate::config::{Configuration, DatabaseConfig, KeystoreConfig, PrometheusConfig};
use sc_client_api::{
self,
BlockchainEvents,
backend::RemoteBackend, light::RemoteBlockchain,
execution_extensions::ExtensionsFactory,
};
use sc_client::Client;
use sc_chain_spec::{RuntimeGenesis, Extension};
use sp_consensus::import_queue::ImportQueue;
use futures::{
Future, FutureExt, StreamExt,
channel::mpsc,
future::ready,
};
use sc_keystore::{Store as Keystore};
use log::{info, warn, error};
use sc_network::config::{FinalityProofProvider, OnDemand, BoxFinalityProofRequestBuilder};
use sc_network::{NetworkService, NetworkStateInfo};
use parking_lot::{Mutex, RwLock};
use sp_runtime::generic::BlockId;
use sp_runtime::traits::{
Block as BlockT, NumberFor, SaturatedConversion, HashFor, UniqueSaturatedInto,
};
use sp_api::ProvideRuntimeApi;
use sc_executor::{NativeExecutor, NativeExecutionDispatch};
use std::{
io::{Read, Write, Seek},
marker::PhantomData, sync::Arc, pin::Pin
};
use wasm_timer::SystemTime;
use sysinfo::{get_current_pid, ProcessExt, System, SystemExt};
use sc_telemetry::{telemetry, SUBSTRATE_INFO};
use sp_transaction_pool::{MaintainedTransactionPool, ChainEvent};
use sp_blockchain;
use prometheus_endpoint::{register, Gauge, U64, F64, Registry, PrometheusError, Opts, GaugeVec};
struct ServiceMetrics {
block_height_number: GaugeVec,
ready_transactions_number: Gauge,
memory_usage_bytes: Gauge,
cpu_usage_percentage: Gauge,
network_per_sec_bytes: GaugeVec,
node_roles: Gauge,
}
impl ServiceMetrics {
fn register(registry: &Registry) -> Result {
Ok(Self {
block_height_number: register(GaugeVec::new(
Opts::new("block_height_number", "Height of the chain"),
&["status"]
)?, registry)?,
ready_transactions_number: register(Gauge::new(
"ready_transactions_number", "Number of transactions in the ready queue",
)?, registry)?,
memory_usage_bytes: register(Gauge::new(
"memory_usage_bytes", "Node memory usage",
)?, registry)?,
cpu_usage_percentage: register(Gauge::new(
"cpu_usage_percentage", "Node CPU usage",
)?, registry)?,
network_per_sec_bytes: register(GaugeVec::new(
Opts::new("network_per_sec_bytes", "Networking bytes per second"),
&["direction"]
)?, registry)?,
node_roles: register(Gauge::new(
"node_roles", "The roles the node is running as",
)?, registry)?,
})
}
}
pub type BackgroundTask = Pin + Send>>;
/// Aggregator for the components required to build a service.
///
/// # Usage
///
/// Call [`ServiceBuilder::new_full`] or [`ServiceBuilder::new_light`], then call the various
/// `with_` methods to add the required components that you built yourself:
///
/// - [`with_select_chain`](ServiceBuilder::with_select_chain)
/// - [`with_import_queue`](ServiceBuilder::with_import_queue)
/// - [`with_finality_proof_provider`](ServiceBuilder::with_finality_proof_provider)
/// - [`with_transaction_pool`](ServiceBuilder::with_transaction_pool)
///
/// After this is done, call [`build`](ServiceBuilder::build) to construct the service.
///
/// The order in which the `with_*` methods are called doesn't matter, as the correct binding of
/// generics is done when you call `build`.
///
pub struct ServiceBuilder
{
config: Configuration,
pub (crate) client: Arc,
backend: Arc,
tasks_builder: TaskManagerBuilder,
keystore: Arc>,
fetcher: Option,
select_chain: Option,
pub (crate) import_queue: TImpQu,
finality_proof_request_builder: Option,
finality_proof_provider: Option,
transaction_pool: Arc,
rpc_extensions: TRpc,
remote_backend: Option>>,
marker: PhantomData<(TBl, TRtApi)>,
background_tasks: Vec<(&'static str, BackgroundTask)>,
}
/// Full client type.
pub type TFullClient = Client<
TFullBackend,
TFullCallExecutor,
TBl,
TRtApi,
>;
/// Full client backend type.
pub type TFullBackend = sc_client_db::Backend;
/// Full client call executor type.
pub type TFullCallExecutor = sc_client::LocalCallExecutor<
sc_client_db::Backend,
NativeExecutor,
>;
/// Light client type.
pub type TLightClient = Client<
TLightBackend,
TLightCallExecutor,
TBl,
TRtApi,
>;
/// Light client backend type.
pub type TLightBackend = sc_client::light::backend::Backend<
sc_client_db::light::LightStorage,
HashFor,
>;
/// Light call executor type.
pub type TLightCallExecutor = sc_client::light::call_executor::GenesisCallExecutor<
sc_client::light::backend::Backend<
sc_client_db::light::LightStorage,
HashFor
>,
sc_client::LocalCallExecutor<
sc_client::light::backend::Backend<
sc_client_db::light::LightStorage,
HashFor
>,
NativeExecutor
>,
>;
type TFullParts = (
TFullClient,
Arc>,
Arc>,
TaskManagerBuilder,
);
/// Creates a new full client for the given config.
pub fn new_full_client(
config: &Configuration,
) -> Result, Error> where
TBl: BlockT,
TExecDisp: NativeExecutionDispatch + 'static,
TGen: sp_runtime::BuildStorage + serde::Serialize + for<'de> serde::Deserialize<'de>,
TCSExt: Extension,
{
new_full_parts(config).map(|parts| parts.0)
}
fn new_full_parts(
config: &Configuration,
) -> Result, Error> where
TBl: BlockT,
TExecDisp: NativeExecutionDispatch + 'static,
TGen: sp_runtime::BuildStorage + serde::Serialize + for<'de> serde::Deserialize<'de>,
TCSExt: Extension,
{
let keystore = match &config.keystore {
KeystoreConfig::Path { path, password } => Keystore::open(
path.clone(),
password.clone()
)?,
KeystoreConfig::InMemory => Keystore::new_in_memory(),
KeystoreConfig::None => return Err("No keystore config provided!".into()),
};
let tasks_builder = TaskManagerBuilder::new();
let executor = NativeExecutor::::new(
config.wasm_method,
config.default_heap_pages,
);
let chain_spec = config.expect_chain_spec();
let fork_blocks = chain_spec
.extensions()
.get::>()
.cloned()
.unwrap_or_default();
let bad_blocks = chain_spec
.extensions()
.get::>()
.cloned()
.unwrap_or_default();
let (client, backend) = {
let db_config = sc_client_db::DatabaseSettings {
state_cache_size: config.state_cache_size,
state_cache_child_ratio:
config.state_cache_child_ratio.map(|v| (v, 100)),
pruning: config.pruning.clone(),
source: match config.expect_database() {
DatabaseConfig::Path { path, cache_size } =>
sc_client_db::DatabaseSettingsSrc::Path {
path: path.clone(),
cache_size: cache_size.clone().map(|u| u as usize),
},
DatabaseConfig::Custom(db) =>
sc_client_db::DatabaseSettingsSrc::Custom(db.clone()),
},
};
let extensions = sc_client_api::execution_extensions::ExecutionExtensions::new(
config.execution_strategies.clone(),
Some(keystore.clone()),
);
sc_client_db::new_client(
db_config,
executor,
config.expect_chain_spec(),
fork_blocks,
bad_blocks,
extensions,
config.prometheus_config.as_ref().map(|config| config.registry.clone()),
)?
};
Ok((client, backend, keystore, tasks_builder))
}
impl ServiceBuilder<(), (), TGen, TCSExt, (), (), (), (), (), (), (), (), ()>
where TGen: RuntimeGenesis, TCSExt: Extension {
/// Start the service builder with a configuration.
pub fn new_full(
config: Configuration
) -> Result,
Arc>,
(),
(),
BoxFinalityProofRequestBuilder,
Arc>,
(),
(),
TFullBackend,
>, Error> {
let (client, backend, keystore, tasks_builder) = new_full_parts(&config)?;
let client = Arc::new(client);
Ok(ServiceBuilder {
config,
client,
backend,
keystore,
tasks_builder,
fetcher: None,
select_chain: None,
import_queue: (),
finality_proof_request_builder: None,
finality_proof_provider: None,
transaction_pool: Arc::new(()),
rpc_extensions: Default::default(),
remote_backend: None,
background_tasks: Default::default(),
marker: PhantomData,
})
}
/// Start the service builder with a configuration.
pub fn new_light(
config: Configuration
) -> Result,
Arc>,
(),
(),
BoxFinalityProofRequestBuilder,
Arc>,
(),
(),
TLightBackend,
>, Error> {
let tasks_builder = TaskManagerBuilder::new();
let keystore = match &config.keystore {
KeystoreConfig::Path { path, password } => Keystore::open(
path.clone(),
password.clone()
)?,
KeystoreConfig::InMemory => Keystore::new_in_memory(),
KeystoreConfig::None => return Err("No keystore config provided!".into()),
};
let executor = NativeExecutor::::new(
config.wasm_method,
config.default_heap_pages,
);
let db_storage = {
let db_settings = sc_client_db::DatabaseSettings {
state_cache_size: config.state_cache_size,
state_cache_child_ratio:
config.state_cache_child_ratio.map(|v| (v, 100)),
pruning: config.pruning.clone(),
source: match config.expect_database() {
DatabaseConfig::Path { path, cache_size } =>
sc_client_db::DatabaseSettingsSrc::Path {
path: path.clone(),
cache_size: cache_size.clone().map(|u| u as usize),
},
DatabaseConfig::Custom(db) =>
sc_client_db::DatabaseSettingsSrc::Custom(db.clone()),
},
};
sc_client_db::light::LightStorage::new(db_settings)?
};
let light_blockchain = sc_client::light::new_light_blockchain(db_storage);
let fetch_checker = Arc::new(
sc_client::light::new_fetch_checker::<_, TBl, _>(
light_blockchain.clone(),
executor.clone(),
),
);
let fetcher = Arc::new(sc_network::config::OnDemand::new(fetch_checker));
let backend = sc_client::light::new_light_backend(light_blockchain);
let remote_blockchain = backend.remote_blockchain();
let client = Arc::new(sc_client::light::new_light(
backend.clone(),
config.expect_chain_spec(),
executor,
config.prometheus_config.as_ref().map(|config| config.registry.clone()),
)?);
Ok(ServiceBuilder {
config,
client,
backend,
tasks_builder,
keystore,
fetcher: Some(fetcher.clone()),
select_chain: None,
import_queue: (),
finality_proof_request_builder: None,
finality_proof_provider: None,
transaction_pool: Arc::new(()),
rpc_extensions: Default::default(),
remote_backend: Some(remote_blockchain),
background_tasks: Default::default(),
marker: PhantomData,
})
}
}
impl
ServiceBuilder {
/// Returns a reference to the client that was stored in this builder.
pub fn client(&self) -> &Arc {
&self.client
}
/// Returns a reference to the backend that was used in this builder.
pub fn backend(&self) -> &Arc {
&self.backend
}
/// Returns a reference to the select-chain that was stored in this builder.
pub fn select_chain(&self) -> Option<&TSc> {
self.select_chain.as_ref()
}
/// Returns a reference to the keystore
pub fn keystore(&self) -> Arc> {
self.keystore.clone()
}
/// Returns a reference to the transaction pool stored in this builder
pub fn pool(&self) -> Arc {
self.transaction_pool.clone()
}
/// Returns a reference to the fetcher, only available if builder
/// was created with `new_light`.
pub fn fetcher(&self) -> Option
where TFchr: Clone
{
self.fetcher.clone()
}
/// Returns a reference to the remote_backend, only available if builder
/// was created with `new_light`.
pub fn remote_backend(&self) -> Option>> {
self.remote_backend.clone()
}
/// Defines which head-of-chain strategy to use.
pub fn with_opt_select_chain(
self,
select_chain_builder: impl FnOnce(
&Configuration, &Arc
) -> Result