// Copyright 2017-2020 Parity Technologies (UK) Ltd. // This file is part of Polkadot. // Polkadot 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. // Polkadot 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 Polkadot. If not, see . use crate::cli::{Cli, Subcommand}; use frame_benchmarking_cli::{BenchmarkCmd, ExtrinsicFactory, SUBSTRATE_REFERENCE_HARDWARE}; use futures::future::TryFutureExt; use log::info; use polkadot_client::benchmarking::{ benchmark_inherent_data, ExistentialDepositProvider, RemarkBuilder, TransferKeepAliveBuilder, }; use sc_cli::{RuntimeVersion, SubstrateCli}; use service::{self, HeaderBackend, IdentifyVariant}; use sp_core::crypto::Ss58AddressFormatRegistry; use sp_keyring::Sr25519Keyring; use std::net::ToSocketAddrs; pub use crate::{error::Error, service::BlockId}; pub use polkadot_performance_test::PerfCheckError; impl From for Error { fn from(s: String) -> Self { Self::Other(s) } } type Result = std::result::Result; fn get_exec_name() -> Option { std::env::current_exe() .ok() .and_then(|pb| pb.file_name().map(|s| s.to_os_string())) .and_then(|s| s.into_string().ok()) } impl SubstrateCli for Cli { fn impl_name() -> String { "Parity Polkadot".into() } fn impl_version() -> String { env!("SUBSTRATE_CLI_IMPL_VERSION").into() } fn description() -> String { env!("CARGO_PKG_DESCRIPTION").into() } fn author() -> String { env!("CARGO_PKG_AUTHORS").into() } fn support_url() -> String { "https://github.com/paritytech/polkadot/issues/new".into() } fn copyright_start_year() -> i32 { 2017 } fn executable_name() -> String { "polkadot".into() } fn load_spec(&self, id: &str) -> std::result::Result, String> { let id = if id == "" { let n = get_exec_name().unwrap_or_default(); ["polkadot", "kusama", "westend", "rococo", "versi"] .iter() .cloned() .find(|&chain| n.starts_with(chain)) .unwrap_or("polkadot") } else { id }; Ok(match id { "kusama" => Box::new(service::chain_spec::kusama_config()?), #[cfg(feature = "kusama-native")] "kusama-dev" => Box::new(service::chain_spec::kusama_development_config()?), #[cfg(feature = "kusama-native")] "kusama-local" => Box::new(service::chain_spec::kusama_local_testnet_config()?), #[cfg(feature = "kusama-native")] "kusama-staging" => Box::new(service::chain_spec::kusama_staging_testnet_config()?), #[cfg(not(feature = "kusama-native"))] name if name.starts_with("kusama-") && !name.ends_with(".json") => Err(format!("`{}` only supported with `kusama-native` feature enabled.", name))?, "polkadot" => Box::new(service::chain_spec::polkadot_config()?), #[cfg(feature = "polkadot-native")] "polkadot-dev" | "dev" => Box::new(service::chain_spec::polkadot_development_config()?), #[cfg(feature = "polkadot-native")] "polkadot-local" => Box::new(service::chain_spec::polkadot_local_testnet_config()?), #[cfg(feature = "polkadot-native")] "polkadot-staging" => Box::new(service::chain_spec::polkadot_staging_testnet_config()?), "rococo" => Box::new(service::chain_spec::rococo_config()?), #[cfg(feature = "rococo-native")] "rococo-dev" => Box::new(service::chain_spec::rococo_development_config()?), #[cfg(feature = "rococo-native")] "rococo-local" => Box::new(service::chain_spec::rococo_local_testnet_config()?), #[cfg(feature = "rococo-native")] "rococo-staging" => Box::new(service::chain_spec::rococo_staging_testnet_config()?), #[cfg(not(feature = "rococo-native"))] name if name.starts_with("rococo-") && !name.ends_with(".json") => Err(format!("`{}` only supported with `rococo-native` feature enabled.", name))?, "westend" => Box::new(service::chain_spec::westend_config()?), #[cfg(feature = "westend-native")] "westend-dev" => Box::new(service::chain_spec::westend_development_config()?), #[cfg(feature = "westend-native")] "westend-local" => Box::new(service::chain_spec::westend_local_testnet_config()?), #[cfg(feature = "westend-native")] "westend-staging" => Box::new(service::chain_spec::westend_staging_testnet_config()?), #[cfg(not(feature = "westend-native"))] name if name.starts_with("westend-") && !name.ends_with(".json") => Err(format!("`{}` only supported with `westend-native` feature enabled.", name))?, "wococo" => Box::new(service::chain_spec::wococo_config()?), #[cfg(feature = "rococo-native")] "wococo-dev" => Box::new(service::chain_spec::wococo_development_config()?), #[cfg(feature = "rococo-native")] "wococo-local" => Box::new(service::chain_spec::wococo_local_testnet_config()?), #[cfg(not(feature = "rococo-native"))] name if name.starts_with("wococo-") => Err(format!("`{}` only supported with `rococo-native` feature enabled.", name))?, #[cfg(feature = "rococo-native")] "versi-dev" => Box::new(service::chain_spec::versi_development_config()?), #[cfg(feature = "rococo-native")] "versi-local" => Box::new(service::chain_spec::versi_local_testnet_config()?), #[cfg(feature = "rococo-native")] "versi-staging" => Box::new(service::chain_spec::versi_staging_testnet_config()?), #[cfg(not(feature = "rococo-native"))] name if name.starts_with("versi-") => Err(format!("`{}` only supported with `rococo-native` feature enabled.", name))?, path => { let path = std::path::PathBuf::from(path); let chain_spec = Box::new(service::PolkadotChainSpec::from_json_file(path.clone())?) as Box; // When `force_*` is given or the file name starts with the name of one of the known chains, // we use the chain spec for the specific chain. if self.run.force_rococo || chain_spec.is_rococo() || chain_spec.is_wococo() || chain_spec.is_versi() { Box::new(service::RococoChainSpec::from_json_file(path)?) } else if self.run.force_kusama || chain_spec.is_kusama() { Box::new(service::KusamaChainSpec::from_json_file(path)?) } else if self.run.force_westend || chain_spec.is_westend() { Box::new(service::WestendChainSpec::from_json_file(path)?) } else { chain_spec } }, }) } fn native_runtime_version(spec: &Box) -> &'static RuntimeVersion { #[cfg(feature = "kusama-native")] if spec.is_kusama() { return &service::kusama_runtime::VERSION } #[cfg(feature = "westend-native")] if spec.is_westend() { return &service::westend_runtime::VERSION } #[cfg(feature = "rococo-native")] if spec.is_rococo() || spec.is_wococo() || spec.is_versi() { return &service::rococo_runtime::VERSION } #[cfg(not(all( feature = "rococo-native", feature = "westend-native", feature = "kusama-native" )))] let _ = spec; #[cfg(feature = "polkadot-native")] { return &service::polkadot_runtime::VERSION } #[cfg(not(feature = "polkadot-native"))] panic!("No runtime feature (polkadot, kusama, westend, rococo) is enabled") } } fn set_default_ss58_version(spec: &Box) { let ss58_version = if spec.is_kusama() { Ss58AddressFormatRegistry::KusamaAccount } else if spec.is_westend() { Ss58AddressFormatRegistry::SubstrateAccount } else { Ss58AddressFormatRegistry::PolkadotAccount } .into(); sp_core::crypto::set_default_ss58_version(ss58_version); } const DEV_ONLY_ERROR_PATTERN: &'static str = "can only use subcommand with --chain [polkadot-dev, kusama-dev, westend-dev, rococo-dev, wococo-dev], got "; fn ensure_dev(spec: &Box) -> std::result::Result<(), String> { if spec.is_dev() { Ok(()) } else { Err(format!("{}{}", DEV_ONLY_ERROR_PATTERN, spec.id())) } } /// Unwraps a [`polkadot_client::Client`] into the concrete runtime client. macro_rules! unwrap_client { ( $client:ident, $code:expr ) => { match $client.as_ref() { #[cfg(feature = "polkadot-native")] polkadot_client::Client::Polkadot($client) => $code, #[cfg(feature = "westend-native")] polkadot_client::Client::Westend($client) => $code, #[cfg(feature = "kusama-native")] polkadot_client::Client::Kusama($client) => $code, #[cfg(feature = "rococo-native")] polkadot_client::Client::Rococo($client) => $code, #[allow(unreachable_patterns)] _ => Err(Error::CommandNotImplemented), } }; } /// Runs performance checks. /// Should only be used in release build since the check would take too much time otherwise. fn host_perf_check() -> Result<()> { #[cfg(not(build_type = "release"))] { return Err(PerfCheckError::WrongBuildType.into()) } #[cfg(build_type = "release")] { #[cfg(not(feature = "hostperfcheck"))] { return Err(PerfCheckError::FeatureNotEnabled { feature: "hostperfcheck" }.into()) } #[cfg(feature = "hostperfcheck")] { crate::host_perf_check::host_perf_check()?; return Ok(()) } } } /// Launch a node, accepting arguments just like a regular node, /// accepts an alternative overseer generator, to adjust behavior /// for integration tests as needed. /// `malus_finality_delay` restrict finality votes of this node /// to be at most `best_block - malus_finality_delay` height. #[cfg(feature = "malus")] pub fn run_node( run: Cli, overseer_gen: impl service::OverseerGen, malus_finality_delay: Option, ) -> Result<()> { run_node_inner(run, overseer_gen, malus_finality_delay, |_logger_builder, _config| {}) } fn run_node_inner( cli: Cli, overseer_gen: impl service::OverseerGen, maybe_malus_finality_delay: Option, logger_hook: F, ) -> Result<()> where F: FnOnce(&mut sc_cli::LoggerBuilder, &sc_service::Configuration), { let runner = cli .create_runner_with_logger_hook::(&cli.run.base, logger_hook) .map_err(Error::from)?; let chain_spec = &runner.config().chain_spec; // Disallow BEEFY on production networks. if cli.run.beefy && (chain_spec.is_polkadot() || chain_spec.is_kusama() || chain_spec.is_westend()) { return Err(Error::Other("BEEFY disallowed on production networks".to_string())) } set_default_ss58_version(chain_spec); let grandpa_pause = if cli.run.grandpa_pause.is_empty() { None } else { Some((cli.run.grandpa_pause[0], cli.run.grandpa_pause[1])) }; if chain_spec.is_kusama() { info!("----------------------------"); info!("This chain is not in any way"); info!(" endorsed by the "); info!(" KUSAMA FOUNDATION "); info!("----------------------------"); } let jaeger_agent = if let Some(ref jaeger_agent) = cli.run.jaeger_agent { Some( jaeger_agent .to_socket_addrs() .map_err(Error::AddressResolutionFailure)? .next() .ok_or_else(|| Error::AddressResolutionMissing)?, ) } else { None }; runner.run_node_until_exit(move |config| async move { let hwbench = (!cli.run.no_hardware_benchmarks) .then_some(config.database.path().map(|database_path| { let _ = std::fs::create_dir_all(&database_path); sc_sysinfo::gather_hwbench(Some(database_path)) })) .flatten(); service::build_full( config, service::IsCollator::No, grandpa_pause, cli.run.beefy, jaeger_agent, None, false, overseer_gen, cli.run.overseer_channel_capacity_override, maybe_malus_finality_delay, hwbench, ) .map(|full| full.task_manager) .map_err(Into::into) }) } /// Parses polkadot specific CLI arguments and run the service. pub fn run() -> Result<()> { let cli: Cli = Cli::from_args(); #[cfg(feature = "pyroscope")] let mut pyroscope_agent_maybe = if let Some(ref agent_addr) = cli.run.pyroscope_server { let address = agent_addr .to_socket_addrs() .map_err(Error::AddressResolutionFailure)? .next() .ok_or_else(|| Error::AddressResolutionMissing)?; // The pyroscope agent requires a `http://` prefix, so we just do that. let mut agent = pyro::PyroscopeAgent::builder( "http://".to_owned() + address.to_string().as_str(), "polkadot".to_owned(), ) .sample_rate(113) .build()?; agent.start(); Some(agent) } else { None }; #[cfg(not(feature = "pyroscope"))] if cli.run.pyroscope_server.is_some() { return Err(Error::PyroscopeNotCompiledIn) } match &cli.subcommand { None => run_node_inner( cli, service::RealOverseerGen, None, polkadot_node_metrics::logger_hook(), ), Some(Subcommand::BuildSpec(cmd)) => { let runner = cli.create_runner(cmd)?; Ok(runner.sync_run(|config| cmd.run(config.chain_spec, config.network))?) }, Some(Subcommand::CheckBlock(cmd)) => { let runner = cli.create_runner(cmd).map_err(Error::SubstrateCli)?; let chain_spec = &runner.config().chain_spec; set_default_ss58_version(chain_spec); runner.async_run(|mut config| { let (client, _, import_queue, task_manager) = service::new_chain_ops(&mut config, None)?; Ok((cmd.run(client, import_queue).map_err(Error::SubstrateCli), task_manager)) }) }, Some(Subcommand::ExportBlocks(cmd)) => { let runner = cli.create_runner(cmd)?; let chain_spec = &runner.config().chain_spec; set_default_ss58_version(chain_spec); Ok(runner.async_run(|mut config| { let (client, _, _, task_manager) = service::new_chain_ops(&mut config, None).map_err(Error::PolkadotService)?; Ok((cmd.run(client, config.database).map_err(Error::SubstrateCli), task_manager)) })?) }, Some(Subcommand::ExportState(cmd)) => { let runner = cli.create_runner(cmd)?; let chain_spec = &runner.config().chain_spec; set_default_ss58_version(chain_spec); Ok(runner.async_run(|mut config| { let (client, _, _, task_manager) = service::new_chain_ops(&mut config, None)?; Ok((cmd.run(client, config.chain_spec).map_err(Error::SubstrateCli), task_manager)) })?) }, Some(Subcommand::ImportBlocks(cmd)) => { let runner = cli.create_runner(cmd)?; let chain_spec = &runner.config().chain_spec; set_default_ss58_version(chain_spec); Ok(runner.async_run(|mut config| { let (client, _, import_queue, task_manager) = service::new_chain_ops(&mut config, None)?; Ok((cmd.run(client, import_queue).map_err(Error::SubstrateCli), task_manager)) })?) }, Some(Subcommand::PurgeChain(cmd)) => { let runner = cli.create_runner(cmd)?; Ok(runner.sync_run(|config| cmd.run(config.database))?) }, Some(Subcommand::Revert(cmd)) => { let runner = cli.create_runner(cmd)?; let chain_spec = &runner.config().chain_spec; set_default_ss58_version(chain_spec); Ok(runner.async_run(|mut config| { let (client, backend, _, task_manager) = service::new_chain_ops(&mut config, None)?; let aux_revert = Box::new(|client, backend, blocks| { service::revert_backend(client, backend, blocks, config).map_err(|err| { match err { service::Error::Blockchain(err) => err.into(), // Generic application-specific error. err => sc_cli::Error::Application(err.into()), } }) }); Ok(( cmd.run(client, backend, Some(aux_revert)).map_err(Error::SubstrateCli), task_manager, )) })?) }, Some(Subcommand::PvfPrepareWorker(cmd)) => { let mut builder = sc_cli::LoggerBuilder::new(""); builder.with_colors(false); let _ = builder.init(); #[cfg(target_os = "android")] { return Err(sc_cli::Error::Input( "PVF preparation workers are not supported under this platform".into(), ) .into()) } #[cfg(not(target_os = "android"))] { polkadot_node_core_pvf::prepare_worker_entrypoint(&cmd.socket_path); Ok(()) } }, Some(Subcommand::PvfExecuteWorker(cmd)) => { let mut builder = sc_cli::LoggerBuilder::new(""); builder.with_colors(false); let _ = builder.init(); #[cfg(target_os = "android")] { return Err(sc_cli::Error::Input( "PVF execution workers are not supported under this platform".into(), ) .into()) } #[cfg(not(target_os = "android"))] { polkadot_node_core_pvf::execute_worker_entrypoint(&cmd.socket_path); Ok(()) } }, Some(Subcommand::Benchmark(cmd)) => { let runner = cli.create_runner(cmd)?; let chain_spec = &runner.config().chain_spec; match cmd { #[cfg(not(feature = "runtime-benchmarks"))] BenchmarkCmd::Storage(_) => return Err(sc_cli::Error::Input( "Compile with --features=runtime-benchmarks \ to enable storage benchmarks." .into(), ) .into()), #[cfg(feature = "runtime-benchmarks")] BenchmarkCmd::Storage(cmd) => runner.sync_run(|mut config| { let (client, backend, _, _) = service::new_chain_ops(&mut config, None)?; let db = backend.expose_db(); let storage = backend.expose_storage(); unwrap_client!( client, cmd.run(config, client.clone(), db, storage).map_err(Error::SubstrateCli) ) }), BenchmarkCmd::Block(cmd) => runner.sync_run(|mut config| { let (client, _, _, _) = service::new_chain_ops(&mut config, None)?; unwrap_client!(client, cmd.run(client.clone()).map_err(Error::SubstrateCli)) }), // These commands are very similar and can be handled in nearly the same way. BenchmarkCmd::Extrinsic(_) | BenchmarkCmd::Overhead(_) => { ensure_dev(chain_spec).map_err(Error::Other)?; runner.sync_run(|mut config| { let (client, _, _, _) = service::new_chain_ops(&mut config, None)?; let header = client.header(client.info().genesis_hash).unwrap().unwrap(); let inherent_data = benchmark_inherent_data(header) .map_err(|e| format!("generating inherent data: {:?}", e))?; let remark_builder = RemarkBuilder::new(client.clone()); match cmd { BenchmarkCmd::Extrinsic(cmd) => { let tka_builder = TransferKeepAliveBuilder::new( client.clone(), Sr25519Keyring::Alice.to_account_id(), client.existential_deposit(), ); let ext_factory = ExtrinsicFactory(vec![ Box::new(remark_builder), Box::new(tka_builder), ]); unwrap_client!( client, cmd.run( client.clone(), inherent_data, Vec::new(), &ext_factory ) .map_err(Error::SubstrateCli) ) }, BenchmarkCmd::Overhead(cmd) => unwrap_client!( client, cmd.run( config, client.clone(), inherent_data, Vec::new(), &remark_builder ) .map_err(Error::SubstrateCli) ), _ => unreachable!("Ensured by the outside match; qed"), } }) }, BenchmarkCmd::Pallet(cmd) => { set_default_ss58_version(chain_spec); ensure_dev(chain_spec).map_err(Error::Other)?; #[cfg(feature = "kusama-native")] if chain_spec.is_kusama() { return runner.sync_run(|config| { cmd.run::(config) .map_err(|e| Error::SubstrateCli(e)) }) } #[cfg(feature = "westend-native")] if chain_spec.is_westend() { return runner.sync_run(|config| { cmd.run::(config) .map_err(|e| Error::SubstrateCli(e)) }) } // else we assume it is polkadot. #[cfg(feature = "polkadot-native")] { return runner.sync_run(|config| { cmd.run::(config) .map_err(|e| Error::SubstrateCli(e)) }) } #[cfg(not(feature = "polkadot-native"))] #[allow(unreachable_code)] Err(service::Error::NoRuntime.into()) }, BenchmarkCmd::Machine(cmd) => runner.sync_run(|config| { cmd.run(&config, SUBSTRATE_REFERENCE_HARDWARE.clone()) .map_err(Error::SubstrateCli) }), // NOTE: this allows the Polkadot client to leniently implement // new benchmark commands. #[allow(unreachable_patterns)] _ => Err(Error::CommandNotImplemented), } }, Some(Subcommand::HostPerfCheck) => { let mut builder = sc_cli::LoggerBuilder::new(""); builder.with_colors(true); builder.init()?; host_perf_check() }, Some(Subcommand::Key(cmd)) => Ok(cmd.run(&cli)?), #[cfg(feature = "try-runtime")] Some(Subcommand::TryRuntime(cmd)) => { use sc_executor::{sp_wasm_interface::ExtendedHostFunctions, NativeExecutionDispatch}; let runner = cli.create_runner(cmd)?; let chain_spec = &runner.config().chain_spec; set_default_ss58_version(chain_spec); type HostFunctionsOf = ExtendedHostFunctions< sp_io::SubstrateHostFunctions, ::ExtendHostFunctions, >; use sc_service::TaskManager; let registry = &runner.config().prometheus_config.as_ref().map(|cfg| &cfg.registry); let task_manager = TaskManager::new(runner.config().tokio_handle.clone(), *registry) .map_err(|e| Error::SubstrateService(sc_service::Error::Prometheus(e)))?; ensure_dev(chain_spec).map_err(Error::Other)?; #[cfg(feature = "kusama-native")] if chain_spec.is_kusama() { return runner.async_run(|_| { Ok(( cmd.run::>( ) .map_err(Error::SubstrateCli), task_manager, )) }) } #[cfg(feature = "westend-native")] if chain_spec.is_westend() { return runner.async_run(|_| { Ok(( cmd.run::>( ) .map_err(Error::SubstrateCli), task_manager, )) }) } // else we assume it is polkadot. #[cfg(feature = "polkadot-native")] { return runner.async_run(|_| { Ok(( cmd.run::>( ) .map_err(Error::SubstrateCli), task_manager, )) }) } #[cfg(not(feature = "polkadot-native"))] panic!("No runtime feature (polkadot, kusama, westend, rococo) is enabled") }, #[cfg(not(feature = "try-runtime"))] Some(Subcommand::TryRuntime) => Err(Error::Other( "TryRuntime wasn't enabled when building the node. \ You can enable it with `--features try-runtime`." .into(), ) .into()), Some(Subcommand::ChainInfo(cmd)) => { let runner = cli.create_runner(cmd)?; Ok(runner.sync_run(|config| cmd.run::(&config))?) }, }?; #[cfg(feature = "pyroscope")] if let Some(mut pyroscope_agent) = pyroscope_agent_maybe.take() { pyroscope_agent.stop(); } Ok(()) }