// Copyright 2019-2021 Parity Technologies (UK) Ltd. // This file is part of Cumulus. // Cumulus 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. // Cumulus 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 Cumulus. If not, see . use crate::{ chain_spec, cli::{Cli, RelayChainCli, Subcommand}, service::{ new_partial, Block, ShellRuntimeExecutor, StatemineRuntimeExecutor, StatemintRuntimeExecutor, WestmintRuntimeExecutor, }, }; use codec::Encode; use cumulus_client_service::genesis::generate_genesis_block; use cumulus_primitives_core::ParaId; use frame_benchmarking_cli::{BenchmarkCmd, SUBSTRATE_REFERENCE_HARDWARE}; use log::info; use parachains_common::{AuraId, StatemintAuraId}; use polkadot_parachain::primitives::AccountIdConversion; use sc_cli::{ ChainSpec, CliConfiguration, DefaultConfigurationValues, ImportParams, KeystoreParams, NetworkParams, Result, RuntimeVersion, SharedParams, SubstrateCli, }; use sc_service::{ config::{BasePath, PrometheusConfig}, TaskManager, }; use sp_core::hexdisplay::HexDisplay; use sp_runtime::traits::Block as BlockT; use std::{io::Write, net::SocketAddr}; trait IdentifyChain { fn is_shell(&self) -> bool; fn is_seedling(&self) -> bool; fn is_statemint(&self) -> bool; fn is_statemine(&self) -> bool; fn is_westmint(&self) -> bool; fn is_canvas_kusama(&self) -> bool; } impl IdentifyChain for dyn sc_service::ChainSpec { fn is_shell(&self) -> bool { self.id().starts_with("shell") } fn is_seedling(&self) -> bool { self.id().starts_with("seedling") } fn is_statemint(&self) -> bool { self.id().starts_with("statemint") } fn is_statemine(&self) -> bool { self.id().starts_with("statemine") } fn is_westmint(&self) -> bool { self.id().starts_with("westmint") } fn is_canvas_kusama(&self) -> bool { // we use the same runtime on rococo and kusama self.id().starts_with("canvas-kusama") || self.id().starts_with("canvas-rococo") } } impl IdentifyChain for T { fn is_shell(&self) -> bool { ::is_shell(self) } fn is_seedling(&self) -> bool { ::is_seedling(self) } fn is_statemint(&self) -> bool { ::is_statemint(self) } fn is_statemine(&self) -> bool { ::is_statemine(self) } fn is_westmint(&self) -> bool { ::is_westmint(self) } fn is_canvas_kusama(&self) -> bool { ::is_canvas_kusama(self) } } fn load_spec(id: &str) -> std::result::Result, String> { Ok(match id { "staging" => Box::new(chain_spec::staging_test_net()), "tick" => Box::new(chain_spec::ChainSpec::from_json_bytes( &include_bytes!("../res/tick.json")[..], )?), "trick" => Box::new(chain_spec::ChainSpec::from_json_bytes( &include_bytes!("../res/trick.json")[..], )?), "track" => Box::new(chain_spec::ChainSpec::from_json_bytes( &include_bytes!("../res/track.json")[..], )?), "shell" => Box::new(chain_spec::get_shell_chain_spec()), // -- Statemint "seedling" => Box::new(chain_spec::get_seedling_chain_spec()), "statemint-dev" => Box::new(chain_spec::statemint_development_config()), "statemint-local" => Box::new(chain_spec::statemint_local_config()), // the chain spec as used for generating the upgrade genesis values "statemint-genesis" => Box::new(chain_spec::statemint_config()), // the shell-based chain spec as used for syncing "statemint" => Box::new(chain_spec::ChainSpec::from_json_bytes( &include_bytes!("../res/statemint.json")[..], )?), // -- Statemine "statemine-dev" => Box::new(chain_spec::statemine_development_config()), "statemine-local" => Box::new(chain_spec::statemine_local_config()), // the chain spec as used for generating the upgrade genesis values "statemine-genesis" => Box::new(chain_spec::statemine_config()), // the shell-based chain spec as used for syncing "statemine" => Box::new(chain_spec::ChainSpec::from_json_bytes( &include_bytes!("../res/statemine.json")[..], )?), // -- Westmint "westmint-dev" => Box::new(chain_spec::westmint_development_config()), "westmint-local" => Box::new(chain_spec::westmint_local_config()), // the chain spec as used for generating the upgrade genesis values "westmint-genesis" => Box::new(chain_spec::westmint_config()), // the shell-based chain spec as used for syncing "westmint" => Box::new(chain_spec::ChainSpec::from_json_bytes( &include_bytes!("../res/westmint.json")[..], )?), // -- Canvas on Rococo "canvas-rococo-dev" => Box::new(chain_spec::canvas_rococo_development_config()), "canvas-rococo-local" => Box::new(chain_spec::canvas_rococo_local_config()), "canvas-rococo-genesis" => Box::new(chain_spec::canvas_rococo_config()), "canvas-rococo" => Box::new(chain_spec::ChainSpec::from_json_bytes( &include_bytes!("../res/canvas-rococo.json")[..], )?), // -- Fallback (generic chainspec) "" => Box::new(chain_spec::get_chain_spec()), // -- Loading a specific spec from disk path => { let chain_spec = chain_spec::ChainSpec::from_json_file(path.into())?; if chain_spec.is_statemint() { Box::new(chain_spec::StatemintChainSpec::from_json_file(path.into())?) } else if chain_spec.is_statemine() { Box::new(chain_spec::StatemineChainSpec::from_json_file(path.into())?) } else if chain_spec.is_westmint() { Box::new(chain_spec::WestmintChainSpec::from_json_file(path.into())?) } else if chain_spec.is_shell() { Box::new(chain_spec::ShellChainSpec::from_json_file(path.into())?) } else if chain_spec.is_seedling() { Box::new(chain_spec::SeedlingChainSpec::from_json_file(path.into())?) } else if chain_spec.is_canvas_kusama() { Box::new(chain_spec::CanvasKusamaChainSpec::from_json_file(path.into())?) } else { Box::new(chain_spec) } }, }) } impl SubstrateCli for Cli { fn impl_name() -> String { "Polkadot collator".into() } fn impl_version() -> String { env!("SUBSTRATE_CLI_IMPL_VERSION").into() } fn description() -> String { format!( "Polkadot collator\n\nThe command-line arguments provided first will be \ passed to the parachain node, while the arguments provided after -- will be passed \ to the relaychain node.\n\n\ {} [parachain-args] -- [relaychain-args]", Self::executable_name() ) } fn author() -> String { env!("CARGO_PKG_AUTHORS").into() } fn support_url() -> String { "https://github.com/paritytech/cumulus/issues/new".into() } fn copyright_start_year() -> i32 { 2017 } fn load_spec(&self, id: &str) -> std::result::Result, String> { load_spec(id) } fn native_runtime_version(chain_spec: &Box) -> &'static RuntimeVersion { if chain_spec.is_statemint() { &statemint_runtime::VERSION } else if chain_spec.is_statemine() { &statemine_runtime::VERSION } else if chain_spec.is_westmint() { &westmint_runtime::VERSION } else if chain_spec.is_shell() { &shell_runtime::VERSION } else if chain_spec.is_seedling() { &seedling_runtime::VERSION } else if chain_spec.is_canvas_kusama() { &canvas_kusama_runtime::VERSION } else { &rococo_parachain_runtime::VERSION } } } impl SubstrateCli for RelayChainCli { fn impl_name() -> String { "Polkadot collator".into() } fn impl_version() -> String { env!("SUBSTRATE_CLI_IMPL_VERSION").into() } fn description() -> String { format!( "Polkadot collator\n\nThe command-line arguments provided first will be \ passed to the parachain node, while the arguments provided after -- will be passed \ to the relay chain node.\n\n\ {} [parachain-args] -- [relay_chain-args]", Self::executable_name() ) } fn author() -> String { env!("CARGO_PKG_AUTHORS").into() } fn support_url() -> String { "https://github.com/paritytech/cumulus/issues/new".into() } fn copyright_start_year() -> i32 { 2017 } fn load_spec(&self, id: &str) -> std::result::Result, String> { polkadot_cli::Cli::from_iter([RelayChainCli::executable_name().to_string()].iter()) .load_spec(id) } fn native_runtime_version(chain_spec: &Box) -> &'static RuntimeVersion { polkadot_cli::Cli::native_runtime_version(chain_spec) } } fn extract_genesis_wasm(chain_spec: &Box) -> Result> { let mut storage = chain_spec.build_storage()?; storage .top .remove(sp_core::storage::well_known_keys::CODE) .ok_or_else(|| "Could not find wasm file in genesis state!".into()) } /// Creates partial components for the runtimes that are supported by the benchmarks. macro_rules! construct_benchmark_partials { ($config:expr, |$partials:ident| $code:expr) => { if $config.chain_spec.is_statemine() { let $partials = new_partial::( &$config, crate::service::statemint_build_import_queue::<_, AuraId>, )?; $code } else if $config.chain_spec.is_westmint() { let $partials = new_partial::( &$config, crate::service::statemint_build_import_queue::<_, AuraId>, )?; $code } else if $config.chain_spec.is_statemint() { let $partials = new_partial::( &$config, crate::service::statemint_build_import_queue::<_, StatemintAuraId>, )?; $code } else { Err("The chain is not supported".into()) } }; } macro_rules! construct_async_run { (|$components:ident, $cli:ident, $cmd:ident, $config:ident| $( $code:tt )* ) => {{ let runner = $cli.create_runner($cmd)?; if runner.config().chain_spec.is_westmint() { runner.async_run(|$config| { let $components = new_partial::( &$config, crate::service::statemint_build_import_queue::<_, AuraId>, )?; let task_manager = $components.task_manager; { $( $code )* }.map(|v| (v, task_manager)) }) } else if runner.config().chain_spec.is_statemine() { runner.async_run(|$config| { let $components = new_partial::( &$config, crate::service::statemint_build_import_queue::<_, AuraId>, )?; let task_manager = $components.task_manager; { $( $code )* }.map(|v| (v, task_manager)) }) } else if runner.config().chain_spec.is_statemint() { runner.async_run(|$config| { let $components = new_partial::( &$config, crate::service::statemint_build_import_queue::<_, StatemintAuraId>, )?; let task_manager = $components.task_manager; { $( $code )* }.map(|v| (v, task_manager)) }) } else if runner.config().chain_spec.is_shell() { runner.async_run(|$config| { let $components = new_partial::( &$config, crate::service::shell_build_import_queue, )?; let task_manager = $components.task_manager; { $( $code )* }.map(|v| (v, task_manager)) }) } else if runner.config().chain_spec.is_seedling() { runner.async_run(|$config| { let $components = new_partial::( &$config, crate::service::shell_build_import_queue, )?; let task_manager = $components.task_manager; { $( $code )* }.map(|v| (v, task_manager)) }) } else if runner.config().chain_spec.is_canvas_kusama() { runner.async_run(|$config| { let $components = new_partial::( &$config, crate::service::canvas_kusama_build_import_queue, )?; let task_manager = $components.task_manager; { $( $code )* }.map(|v| (v, task_manager)) }) } else { runner.async_run(|$config| { let $components = new_partial::< rococo_parachain_runtime::RuntimeApi, _ >( &$config, crate::service::rococo_parachain_build_import_queue, )?; let task_manager = $components.task_manager; { $( $code )* }.map(|v| (v, task_manager)) }) } }} } /// Parse command line arguments into service configuration. pub fn run() -> Result<()> { let cli = Cli::from_args(); match &cli.subcommand { Some(Subcommand::BuildSpec(cmd)) => { let runner = cli.create_runner(cmd)?; runner.sync_run(|config| cmd.run(config.chain_spec, config.network)) }, Some(Subcommand::CheckBlock(cmd)) => { construct_async_run!(|components, cli, cmd, config| { Ok(cmd.run(components.client, components.import_queue)) }) }, Some(Subcommand::ExportBlocks(cmd)) => { construct_async_run!(|components, cli, cmd, config| { Ok(cmd.run(components.client, config.database)) }) }, Some(Subcommand::ExportState(cmd)) => { construct_async_run!(|components, cli, cmd, config| { Ok(cmd.run(components.client, config.chain_spec)) }) }, Some(Subcommand::ImportBlocks(cmd)) => { construct_async_run!(|components, cli, cmd, config| { Ok(cmd.run(components.client, components.import_queue)) }) }, Some(Subcommand::PurgeChain(cmd)) => { let runner = cli.create_runner(cmd)?; runner.sync_run(|config| { let polkadot_cli = RelayChainCli::new( &config, [RelayChainCli::executable_name().to_string()] .iter() .chain(cli.relaychain_args.iter()), ); let polkadot_config = SubstrateCli::create_configuration( &polkadot_cli, &polkadot_cli, config.tokio_handle.clone(), ) .map_err(|err| format!("Relay chain argument error: {}", err))?; cmd.run(config, polkadot_config) }) }, Some(Subcommand::Revert(cmd)) => construct_async_run!(|components, cli, cmd, config| { Ok(cmd.run(components.client, components.backend, None)) }), Some(Subcommand::ExportGenesisState(params)) => { let mut builder = sc_cli::LoggerBuilder::new(""); builder.with_profiling(sc_tracing::TracingReceiver::Log, ""); let _ = builder.init(); let spec = load_spec(¶ms.chain.clone().unwrap_or_default())?; let state_version = Cli::native_runtime_version(&spec).state_version(); let block: crate::service::Block = generate_genesis_block(&spec, state_version)?; let raw_header = block.header().encode(); let output_buf = if params.raw { raw_header } else { format!("0x{:?}", HexDisplay::from(&block.header().encode())).into_bytes() }; if let Some(output) = ¶ms.output { std::fs::write(output, output_buf)?; } else { std::io::stdout().write_all(&output_buf)?; } Ok(()) }, Some(Subcommand::ExportGenesisWasm(params)) => { let mut builder = sc_cli::LoggerBuilder::new(""); builder.with_profiling(sc_tracing::TracingReceiver::Log, ""); let _ = builder.init(); let raw_wasm_blob = extract_genesis_wasm(&cli.load_spec(¶ms.chain.clone().unwrap_or_default())?)?; let output_buf = if params.raw { raw_wasm_blob } else { format!("0x{:?}", HexDisplay::from(&raw_wasm_blob)).into_bytes() }; if let Some(output) = ¶ms.output { std::fs::write(output, output_buf)?; } else { std::io::stdout().write_all(&output_buf)?; } Ok(()) }, Some(Subcommand::Benchmark(cmd)) => { let runner = cli.create_runner(cmd)?; // Switch on the concrete benchmark sub-command- match cmd { BenchmarkCmd::Pallet(cmd) => if cfg!(feature = "runtime-benchmarks") { runner.sync_run(|config| { if config.chain_spec.is_statemine() { cmd.run::(config) } else if config.chain_spec.is_westmint() { cmd.run::(config) } else if config.chain_spec.is_statemint() { cmd.run::(config) } else { Err("Chain doesn't support benchmarking".into()) } }) } else { Err("Benchmarking wasn't enabled when building the node. \ You can enable it with `--features runtime-benchmarks`." .into()) }, BenchmarkCmd::Block(cmd) => runner.sync_run(|config| { construct_benchmark_partials!(config, |partials| cmd.run(partials.client)) }), BenchmarkCmd::Storage(cmd) => runner.sync_run(|config| { construct_benchmark_partials!(config, |partials| { let db = partials.backend.expose_db(); let storage = partials.backend.expose_storage(); cmd.run(config, partials.client.clone(), db, storage) }) }), BenchmarkCmd::Overhead(_) => Err("Unsupported benchmarking command".into()), BenchmarkCmd::Machine(cmd) => runner.sync_run(|config| cmd.run(&config, SUBSTRATE_REFERENCE_HARDWARE.clone())), } }, Some(Subcommand::TryRuntime(cmd)) => { if cfg!(feature = "try-runtime") { // grab the task manager. let runner = cli.create_runner(cmd)?; 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| format!("Error: {:?}", e))?; if runner.config().chain_spec.is_statemine() { runner.async_run(|config| { Ok((cmd.run::(config), task_manager)) }) } else if runner.config().chain_spec.is_westmint() { runner.async_run(|config| { Ok((cmd.run::(config), task_manager)) }) } else if runner.config().chain_spec.is_statemint() { runner.async_run(|config| { Ok((cmd.run::(config), task_manager)) }) } else if runner.config().chain_spec.is_shell() { runner.async_run(|config| { Ok((cmd.run::(config), task_manager)) }) } else { Err("Chain doesn't support try-runtime".into()) } } else { Err("Try-runtime must be enabled by `--features try-runtime`.".into()) } }, Some(Subcommand::Key(cmd)) => Ok(cmd.run(&cli)?), None => { let runner = cli.create_runner(&cli.run.normalize())?; let collator_options = cli.run.collator_options(); runner.run_node_until_exit(|config| async move { let hwbench = if !cli.no_hardware_benchmarks { config.database.path().map(|database_path| { let _ = std::fs::create_dir_all(&database_path); sc_sysinfo::gather_hwbench(Some(database_path)) }) } else { None }; let para_id = chain_spec::Extensions::try_get(&*config.chain_spec) .map(|e| e.para_id) .ok_or_else(|| "Could not find parachain extension in chain-spec.")?; let polkadot_cli = RelayChainCli::new( &config, [RelayChainCli::executable_name().to_string()] .iter() .chain(cli.relaychain_args.iter()), ); let id = ParaId::from(para_id); let parachain_account = AccountIdConversion::::into_account(&id); let state_version = RelayChainCli::native_runtime_version(&config.chain_spec).state_version(); let block: crate::service::Block = generate_genesis_block(&config.chain_spec, state_version) .map_err(|e| format!("{:?}", e))?; let genesis_state = format!("0x{:?}", HexDisplay::from(&block.header().encode())); let tokio_handle = config.tokio_handle.clone(); let polkadot_config = SubstrateCli::create_configuration(&polkadot_cli, &polkadot_cli, tokio_handle) .map_err(|err| format!("Relay chain argument error: {}", err))?; info!("Parachain id: {:?}", id); info!("Parachain Account: {}", parachain_account); info!("Parachain genesis state: {}", genesis_state); info!("Is collating: {}", if config.role.is_authority() { "yes" } else { "no" }); if config.chain_spec.is_statemint() { crate::service::start_statemint_node::< statemint_runtime::RuntimeApi, StatemintAuraId, >(config, polkadot_config, collator_options, id, hwbench) .await .map(|r| r.0) .map_err(Into::into) } else if config.chain_spec.is_statemine() { crate::service::start_statemint_node::( config, polkadot_config, collator_options, id, hwbench, ) .await .map(|r| r.0) .map_err(Into::into) } else if config.chain_spec.is_westmint() { crate::service::start_statemint_node::( config, polkadot_config, collator_options, id, hwbench, ) .await .map(|r| r.0) .map_err(Into::into) } else if config.chain_spec.is_shell() { crate::service::start_shell_node::( config, polkadot_config, collator_options, id, hwbench, ) .await .map(|r| r.0) .map_err(Into::into) } else if config.chain_spec.is_seedling() { crate::service::start_shell_node::( config, polkadot_config, collator_options, id, hwbench, ) .await .map(|r| r.0) .map_err(Into::into) } else if config.chain_spec.is_canvas_kusama() { crate::service::start_canvas_kusama_node( config, polkadot_config, collator_options, id, hwbench, ) .await .map(|r| r.0) .map_err(Into::into) } else { crate::service::start_rococo_parachain_node( config, polkadot_config, collator_options, id, hwbench, ) .await .map(|r| r.0) .map_err(Into::into) } }) }, } } impl DefaultConfigurationValues for RelayChainCli { fn p2p_listen_port() -> u16 { 30334 } fn rpc_ws_listen_port() -> u16 { 9945 } fn rpc_http_listen_port() -> u16 { 9934 } fn prometheus_listen_port() -> u16 { 9616 } } impl CliConfiguration for RelayChainCli { fn shared_params(&self) -> &SharedParams { self.base.base.shared_params() } fn import_params(&self) -> Option<&ImportParams> { self.base.base.import_params() } fn network_params(&self) -> Option<&NetworkParams> { self.base.base.network_params() } fn keystore_params(&self) -> Option<&KeystoreParams> { self.base.base.keystore_params() } fn base_path(&self) -> Result> { Ok(self .shared_params() .base_path() .or_else(|| self.base_path.clone().map(Into::into))) } fn rpc_http(&self, default_listen_port: u16) -> Result> { self.base.base.rpc_http(default_listen_port) } fn rpc_ipc(&self) -> Result> { self.base.base.rpc_ipc() } fn rpc_ws(&self, default_listen_port: u16) -> Result> { self.base.base.rpc_ws(default_listen_port) } fn prometheus_config( &self, default_listen_port: u16, chain_spec: &Box, ) -> Result> { self.base.base.prometheus_config(default_listen_port, chain_spec) } fn init( &self, _support_url: &String, _impl_version: &String, _logger_hook: F, _config: &sc_service::Configuration, ) -> Result<()> where F: FnOnce(&mut sc_cli::LoggerBuilder, &sc_service::Configuration), { unreachable!("PolkadotCli is never initialized; qed"); } fn chain_id(&self, is_dev: bool) -> Result { let chain_id = self.base.base.chain_id(is_dev)?; Ok(if chain_id.is_empty() { self.chain_id.clone().unwrap_or_default() } else { chain_id }) } fn role(&self, is_dev: bool) -> Result { self.base.base.role(is_dev) } fn transaction_pool(&self) -> Result { self.base.base.transaction_pool() } fn state_cache_child_ratio(&self) -> Result> { self.base.base.state_cache_child_ratio() } fn rpc_methods(&self) -> Result { self.base.base.rpc_methods() } fn rpc_ws_max_connections(&self) -> Result> { self.base.base.rpc_ws_max_connections() } fn rpc_cors(&self, is_dev: bool) -> Result>> { self.base.base.rpc_cors(is_dev) } fn default_heap_pages(&self) -> Result> { self.base.base.default_heap_pages() } fn force_authoring(&self) -> Result { self.base.base.force_authoring() } fn disable_grandpa(&self) -> Result { self.base.base.disable_grandpa() } fn max_runtime_instances(&self) -> Result> { self.base.base.max_runtime_instances() } fn announce_block(&self) -> Result { self.base.base.announce_block() } fn telemetry_endpoints( &self, chain_spec: &Box, ) -> Result> { self.base.base.telemetry_endpoints(chain_spec) } fn node_name(&self) -> Result { self.base.base.node_name() } }