git.delta.rocks / unique-network / refs/commits / 6616dda5f558

1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// This file is part of Unique Network.34// Unique Network is free software: you can redistribute it and/or modify5// it under the terms of the GNU General Public License as published by6// the Free Software Foundation, either version 3 of the License, or7// (at your option) any later version.89// Unique Network is distributed in the hope that it will be useful,10// but WITHOUT ANY WARRANTY; without even the implied warranty of11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the12// GNU General Public License for more details.1314// You should have received a copy of the GNU General Public License15// along with Unique Network. If not, see <http://www.gnu.org/licenses/>.1617// Original license18// This file is part of Substrate.1920// Copyright (C) 2017-2021 Parity Technologies (UK) Ltd.21// SPDX-License-Identifier: Apache-2.02223// Licensed under the Apache License, Version 2.0 (the "License");24// you may not use this file except in compliance with the License.25// You may obtain a copy of the License at26//27// 	http://www.apache.org/licenses/LICENSE-2.028//29// Unless required by applicable law or agreed to in writing, software30// distributed under the License is distributed on an "AS IS" BASIS,31// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.32// See the License for the specific language governing permissions and33// limitations under the License.3435use cumulus_primitives_core::ParaId;36use log::info;37use sc_cli::{38	ChainSpec, CliConfiguration, DefaultConfigurationValues, ImportParams, KeystoreParams,39	NetworkParams, Result, SharedParams, SubstrateCli,40};41use sc_service::config::{BasePath, PrometheusConfig};42use sp_runtime::traits::AccountIdConversion;43use up_common::types::opaque::RuntimeId;4445#[cfg(feature = "quartz-runtime")]46use crate::service::QuartzRuntimeExecutor;47#[cfg(feature = "unique-runtime")]48use crate::service::UniqueRuntimeExecutor;49use crate::{50	chain_spec::{self, RuntimeIdentification, ServiceId, ServiceIdentification},51	cli::{Cli, RelayChainCli, Subcommand},52	service::{53		new_partial, start_dev_node, start_node, OpalRuntimeExecutor, ParachainHostFunctions,54	},55};5657macro_rules! no_runtime_err {58	($runtime_id:expr) => {59		format!(60			"No runtime valid runtime was found for chain {:#?}",61			$runtime_id62		)63	};64}6566fn load_spec(id: &str) -> std::result::Result<Box<dyn sc_service::ChainSpec>, String> {67	Ok(match id {68		"dev" => Box::new(chain_spec::development_config()),69		"" | "local" => Box::new(chain_spec::local_testnet_config()),70		path => {71			let path = std::path::PathBuf::from(path);72			#[allow(clippy::redundant_clone)]73			let chain_spec = Box::new(chain_spec::OpalChainSpec::from_json_file(path.clone())?)74				as Box<dyn sc_service::ChainSpec>;7576			match chain_spec.runtime_id() {77				#[cfg(feature = "unique-runtime")]78				RuntimeId::Unique => Box::new(chain_spec::UniqueChainSpec::from_json_file(path)?),7980				#[cfg(feature = "quartz-runtime")]81				RuntimeId::Quartz => Box::new(chain_spec::QuartzChainSpec::from_json_file(path)?),8283				RuntimeId::Opal => chain_spec,84				runtime_id => return Err(no_runtime_err!(runtime_id)),85			}86		}87	})88}8990impl SubstrateCli for Cli {91	// TODO use args92	fn impl_name() -> String {93		format!("{} Node", Self::node_name())94	}9596	fn impl_version() -> String {97		env!("SUBSTRATE_CLI_IMPL_VERSION").into()98	}99	// TODO use args100	fn description() -> String {101		format!(102			"{} Node\n\nThe command-line arguments provided first will be \103		passed to the parachain node, while the arguments provided after -- will be passed \104		to the relaychain node.\n\n\105		{} [parachain-args] -- [relaychain-args]",106			Self::node_name(),107			Self::executable_name()108		)109	}110111	fn author() -> String {112		env!("CARGO_PKG_AUTHORS").into()113	}114115	//TODO use args116	fn support_url() -> String {117		"support@unique.network".into()118	}119120	fn copyright_start_year() -> i32 {121		2019122	}123124	fn load_spec(&self, id: &str) -> std::result::Result<Box<dyn sc_service::ChainSpec>, String> {125		load_spec(id)126	}127}128129impl SubstrateCli for RelayChainCli {130	// TODO use args131	fn impl_name() -> String {132		format!("{} Node", Cli::node_name())133	}134135	fn impl_version() -> String {136		env!("SUBSTRATE_CLI_IMPL_VERSION").into()137	}138	// TODO use args139	fn description() -> String {140		format!(141			"{} Node\n\nThe command-line arguments provided first will be \142			passed to the parachain node, while the arguments provided after -- will be passed \143			to the relaychain node.\n\n\144			parachain-collator [parachain-args] -- [relaychain-args]",145			Cli::node_name()146		)147	}148149	fn author() -> String {150		env!("CARGO_PKG_AUTHORS").into()151	}152	// TODO use args153	fn support_url() -> String {154		"support@unique.network".into()155	}156157	fn copyright_start_year() -> i32 {158		2019159	}160161	fn load_spec(&self, id: &str) -> std::result::Result<Box<dyn sc_service::ChainSpec>, String> {162		polkadot_cli::Cli::from_iter([RelayChainCli::executable_name()].iter()).load_spec(id)163	}164}165166macro_rules! async_run_with_runtime {167	(168		$runtime:path, $runtime_api:path, $executor:path,169		$runner:ident, $components:ident, $cli:ident, $cmd:ident, $config:ident,170		$( $code:tt )*171	) => {172		$runner.async_run(|$config| {173			let $components = new_partial::<174				$runtime, $runtime_api, $executor, _175			>(176				&$config,177				crate::service::parachain_build_import_queue::<$runtime, _, _>,178			)?;179			let task_manager = $components.task_manager;180181			{ $( $code )* }.map(|v| (v, task_manager))182		})183	};184}185186macro_rules! construct_async_run {187	(|$components:ident, $cli:ident, $cmd:ident, $config:ident| $( $code:tt )* ) => {{188		let runner = $cli.create_runner($cmd)?;189190		match runner.config().chain_spec.runtime_id() {191			#[cfg(feature = "unique-runtime")]192			RuntimeId::Unique => async_run_with_runtime!(193				unique_runtime::Runtime, unique_runtime::RuntimeApi, UniqueRuntimeExecutor,194				runner, $components, $cli, $cmd, $config, $( $code )*195			),196197			#[cfg(feature = "quartz-runtime")]198			RuntimeId::Quartz => async_run_with_runtime!(199				quartz_runtime::Runtime, quartz_runtime::RuntimeApi, QuartzRuntimeExecutor,200				runner, $components, $cli, $cmd, $config, $( $code )*201			),202203			RuntimeId::Opal => async_run_with_runtime!(204				opal_runtime::Runtime, opal_runtime::RuntimeApi, OpalRuntimeExecutor,205				runner, $components, $cli, $cmd, $config, $( $code )*206			),207208			runtime_id => Err(no_runtime_err!(runtime_id).into())209		}210	}}211}212213macro_rules! sync_run_with_runtime {214	(215		$runtime:path, $runtime_api:path, $executor:path,216		$runner:ident, $components:ident, $cli:ident, $cmd:ident, $config:ident,217		$( $code:tt )*218	) => {219		$runner.sync_run(|$config| {220			let $components = new_partial::<221				$runtime, $runtime_api, $executor, _222			>(223				&$config,224				crate::service::parachain_build_import_queue::<$runtime, _, _>,225			)?;226227			$( $code )*228		})229	};230}231232macro_rules! construct_sync_run {233	(|$components:ident, $cli:ident, $cmd:ident, $config:ident| $( $code:tt )* ) => {{234		let runner = $cli.create_runner($cmd)?;235236		match runner.config().chain_spec.runtime_id() {237			#[cfg(feature = "unique-runtime")]238			RuntimeId::Unique => sync_run_with_runtime!(239				unique_runtime::Runtime, unique_runtime::RuntimeApi, UniqueRuntimeExecutor,240				runner, $components, $cli, $cmd, $config, $( $code )*241			),242243			#[cfg(feature = "quartz-runtime")]244			RuntimeId::Quartz => sync_run_with_runtime!(245				quartz_runtime::Runtime, quartz_runtime::RuntimeApi, QuartzRuntimeExecutor,246				runner, $components, $cli, $cmd, $config, $( $code )*247			),248249			RuntimeId::Opal => sync_run_with_runtime!(250				opal_runtime::Runtime, opal_runtime::RuntimeApi, OpalRuntimeExecutor,251				runner, $components, $cli, $cmd, $config, $( $code )*252			),253254			runtime_id => Err(no_runtime_err!(runtime_id).into())255		}256	}}257}258259macro_rules! start_node_using_chain_runtime {260	($start_node_fn:ident($config:expr $(, $($args:expr),+)?) $($code:tt)*) => {261		match $config.chain_spec.runtime_id() {262			#[cfg(feature = "unique-runtime")]263			RuntimeId::Unique => $start_node_fn::<264				unique_runtime::Runtime,265				unique_runtime::RuntimeApi,266				UniqueRuntimeExecutor,267			>($config $(, $($args),+)?) $($code)*,268269			#[cfg(feature = "quartz-runtime")]270			RuntimeId::Quartz => $start_node_fn::<271				quartz_runtime::Runtime,272				quartz_runtime::RuntimeApi,273				QuartzRuntimeExecutor,274			>($config $(, $($args),+)?) $($code)*,275276			RuntimeId::Opal => $start_node_fn::<277				opal_runtime::Runtime,278				opal_runtime::RuntimeApi,279				OpalRuntimeExecutor,280			>($config $(, $($args),+)?) $($code)*,281282			runtime_id => Err(no_runtime_err!(runtime_id).into()),283		}284	};285}286287/// Parse command line arguments into service configuration.288pub fn run() -> Result<()> {289	let cli = Cli::from_args();290291	match &cli.subcommand {292		Some(Subcommand::Key(cmd)) => cmd.run(&cli),293		Some(Subcommand::BuildSpec(cmd)) => {294			let runner = cli.create_runner(cmd)?;295			runner.sync_run(|config| cmd.run(config.chain_spec, config.network))296		}297		Some(Subcommand::CheckBlock(cmd)) => {298			construct_async_run!(|components, cli, cmd, config| {299				Ok(cmd.run(components.client, components.import_queue))300			})301		}302		Some(Subcommand::ExportBlocks(cmd)) => {303			construct_async_run!(|components, cli, cmd, config| {304				Ok(cmd.run(components.client, config.database))305			})306		}307		Some(Subcommand::ExportState(cmd)) => {308			construct_async_run!(|components, cli, cmd, config| {309				Ok(cmd.run(components.client, config.chain_spec))310			})311		}312		Some(Subcommand::ImportBlocks(cmd)) => {313			construct_async_run!(|components, cli, cmd, config| {314				Ok(cmd.run(components.client, components.import_queue))315			})316		}317		Some(Subcommand::PurgeChain(cmd)) => {318			let runner = cli.create_runner(cmd)?;319320			runner.sync_run(|config| {321				let polkadot_cli = RelayChainCli::new(322					&config,323					[RelayChainCli::executable_name()]324						.iter()325						.chain(cli.relaychain_args.iter()),326				);327328				let polkadot_config = SubstrateCli::create_configuration(329					&polkadot_cli,330					&polkadot_cli,331					config.tokio_handle.clone(),332				)333				.map_err(|err| format!("Relay chain argument error: {err}"))?;334335				cmd.run(config, polkadot_config)336			})337		}338		Some(Subcommand::Revert(cmd)) => construct_async_run!(|components, cli, cmd, config| {339			Ok(cmd.run(components.client, components.backend, None))340		}),341		Some(Subcommand::ExportGenesisState(cmd)) => {342			construct_sync_run!(|components, cli, cmd, _config| cmd.run(components.client))343		}344		Some(Subcommand::ExportGenesisWasm(cmd)) => {345			construct_sync_run!(|_components, cli, cmd, _config| {346				let spec = cli.load_spec(&cmd.shared_params.chain.clone().unwrap_or_default())?;347				cmd.run(&*spec)348			})349		}350		#[cfg(feature = "runtime-benchmarks")]351		Some(Subcommand::Benchmark(cmd)) => {352			use frame_benchmarking_cli::{BenchmarkCmd, SUBSTRATE_REFERENCE_HARDWARE};353			use polkadot_cli::Block;354355			let runner = cli.create_runner(cmd)?;356			// Switch on the concrete benchmark sub-command-357			match cmd {358				BenchmarkCmd::Pallet(cmd) => {359					runner.sync_run(|config| cmd.run::<Block, ParachainHostFunctions>(config))360				}361				BenchmarkCmd::Block(cmd) => runner.sync_run(|config| {362					let partials = new_partial::<363						opal_runtime::Runtime,364						opal_runtime::RuntimeApi,365						OpalRuntimeExecutor,366						_,367					>(368						&config,369						crate::service::parachain_build_import_queue::<opal_runtime::Runtime, _, _>,370					)?;371					cmd.run(partials.client)372				}),373				BenchmarkCmd::Storage(cmd) => runner.sync_run(|config| {374					let partials = new_partial::<375						opal_runtime::Runtime,376						opal_runtime::RuntimeApi,377						OpalRuntimeExecutor,378						_,379					>(380						&config,381						crate::service::parachain_build_import_queue::<opal_runtime::Runtime, _, _>,382					)?;383					let db = partials.backend.expose_db();384					let storage = partials.backend.expose_storage();385386					cmd.run(config, partials.client.clone(), db, storage)387				}),388				BenchmarkCmd::Machine(cmd) => {389					runner.sync_run(|config| cmd.run(&config, SUBSTRATE_REFERENCE_HARDWARE.clone()))390				}391				BenchmarkCmd::Overhead(_) | BenchmarkCmd::Extrinsic(_) => {392					Err("Unsupported benchmarking command".into())393				}394			}395		}396		#[cfg(feature = "try-runtime")]397		// embedded try-runtime cli will be removed soon.398		#[allow(deprecated)]399		Some(Subcommand::TryRuntime(cmd)) => {400			use std::{future::Future, pin::Pin};401402			use polkadot_cli::Block;403			use sc_executor::{sp_wasm_interface::ExtendedHostFunctions, NativeExecutionDispatch};404			use try_runtime_cli::block_building_info::timestamp_with_aura_info;405406			let runner = cli.create_runner(cmd)?;407408			// grab the task manager.409			let registry = &runner410				.config()411				.prometheus_config412				.as_ref()413				.map(|cfg| &cfg.registry);414			let task_manager =415				sc_service::TaskManager::new(runner.config().tokio_handle.clone(), *registry)416					.map_err(|e| format!("Error: {e:?}"))?;417			let info_provider = Some(timestamp_with_aura_info(12000));418419			runner.async_run(|config| -> Result<(Pin<Box<dyn Future<Output = _>>>, _)> {420				Ok((421					match config.chain_spec.runtime_id() {422						#[cfg(feature = "unique-runtime")]423						RuntimeId::Unique => Box::pin(424							cmd425								.run::<Block, <UniqueRuntimeExecutor as NativeExecutionDispatch>::ExtendHostFunctions, _>(426								info_provider,427							),428						),429430						#[cfg(feature = "quartz-runtime")]431						RuntimeId::Quartz => Box::pin(432							cmd433								.run::<Block, <QuartzRuntimeExecutor as NativeExecutionDispatch>::ExtendHostFunctions, _>(434								info_provider,435							),436						),437438						RuntimeId::Opal => Box::pin(439							cmd440								.run::<Block, <OpalRuntimeExecutor as NativeExecutionDispatch>::ExtendHostFunctions, _>(441								info_provider,442							),443						),444						runtime_id => return Err(no_runtime_err!(runtime_id).into()),445					},446					task_manager,447				))448			})449		}450		#[cfg(not(feature = "try-runtime"))]451		Some(Subcommand::TryRuntime) => {452			Err("Try-runtime must be enabled by `--features try-runtime`.".into())453		}454		None => {455			let runner = cli.create_runner(&cli.run.normalize())?;456			let collator_options = cli.run.collator_options();457458			runner.run_node_until_exit(|config| async move {459				let hwbench = if !cli.no_hardware_benchmarks {460					config.database.path().map(|database_path| {461						let _ = std::fs::create_dir_all(database_path);462						sc_sysinfo::gather_hwbench(Some(database_path))463					})464				} else {465					None466				};467468				let extensions = chain_spec::Extensions::try_get(&*config.chain_spec);469470				let service_id = config.chain_spec.service_id();471				let relay_chain_id = extensions.map(|e| e.relay_chain.clone());472				let is_dev_service = matches![service_id, ServiceId::Dev]473					|| relay_chain_id == Some("dev-service".into());474475				if is_dev_service {476					info!("Running Dev service");477478					let mut config = config;479480					config.state_pruning = Some(sc_service::PruningMode::ArchiveAll);481482					return start_node_using_chain_runtime! {483						start_dev_node(config, cli.idle_autoseal_interval, cli.autoseal_finalization_delay, cli.disable_autoseal_on_tx).map_err(Into::into)484					};485				};486487				let para_id = extensions488					.map(|e| e.para_id)489					.ok_or("Could not find parachain ID in chain-spec.")?;490491				let polkadot_cli = RelayChainCli::new(492					&config,493					[RelayChainCli::executable_name()]494						.iter()495						.chain(cli.relaychain_args.iter()),496				);497498				let para_id = ParaId::from(para_id);499500				let parachain_account =501					AccountIdConversion::<polkadot_primitives::AccountId>::into_account_truncating(502						&para_id,503					);504505				let polkadot_config = SubstrateCli::create_configuration(506					&polkadot_cli,507					&polkadot_cli,508					config.tokio_handle.clone(),509				)510				.map_err(|err| format!("Relay chain argument error: {err}"))?;511512				info!("Parachain id: {:?}", para_id);513				info!("Parachain Account: {}", parachain_account);514				info!(515					"Is collating: {}",516					if config.role.is_authority() {517						"yes"518					} else {519						"no"520					}521				);522523				start_node_using_chain_runtime! {524					start_node(config, polkadot_config, collator_options, para_id, hwbench)525						.await526						.map(|r| r.0)527						.map_err(Into::into)528				}529			})530		}531	}532}533534impl DefaultConfigurationValues for RelayChainCli {535	fn p2p_listen_port() -> u16 {536		30334537	}538539	fn rpc_listen_port() -> u16 {540		9945541	}542543	fn prometheus_listen_port() -> u16 {544		9616545	}546}547548impl CliConfiguration<Self> for RelayChainCli {549	fn shared_params(&self) -> &SharedParams {550		self.base.base.shared_params()551	}552553	fn import_params(&self) -> Option<&ImportParams> {554		self.base.base.import_params()555	}556557	fn network_params(&self) -> Option<&NetworkParams> {558		self.base.base.network_params()559	}560561	fn keystore_params(&self) -> Option<&KeystoreParams> {562		self.base.base.keystore_params()563	}564565	fn base_path(&self) -> Result<Option<BasePath>> {566		Ok(self567			.shared_params()568			.base_path()?569			.or_else(|| Some(self.base_path.clone().into())))570	}571572	fn prometheus_config(573		&self,574		default_listen_port: u16,575		chain_spec: &Box<dyn ChainSpec>,576	) -> Result<Option<PrometheusConfig>> {577		self.base578			.base579			.prometheus_config(default_listen_port, chain_spec)580	}581582	fn init<F>(583		&self,584		_support_url: &String,585		_impl_version: &String,586		_logger_hook: F,587		_config: &sc_service::Configuration,588	) -> Result<()> {589		unreachable!("PolkadotCli is never initialized; qed");590	}591592	fn chain_id(&self, is_dev: bool) -> Result<String> {593		let chain_id = self.base.base.chain_id(is_dev)?;594595		Ok(if chain_id.is_empty() {596			self.chain_id.clone().unwrap_or_default()597		} else {598			chain_id599		})600	}601602	fn role(&self, is_dev: bool) -> Result<sc_service::Role> {603		self.base.base.role(is_dev)604	}605606	fn transaction_pool(&self, is_dev: bool) -> Result<sc_service::config::TransactionPoolOptions> {607		self.base.base.transaction_pool(is_dev)608	}609610	fn rpc_methods(&self) -> Result<sc_service::config::RpcMethods> {611		self.base.base.rpc_methods()612	}613614	fn rpc_max_connections(&self) -> Result<u32> {615		self.base.base.rpc_max_connections()616	}617618	fn rpc_cors(&self, is_dev: bool) -> Result<Option<Vec<String>>> {619		self.base.base.rpc_cors(is_dev)620	}621622	fn default_heap_pages(&self) -> Result<Option<u64>> {623		self.base.base.default_heap_pages()624	}625626	fn force_authoring(&self) -> Result<bool> {627		self.base.base.force_authoring()628	}629630	fn disable_grandpa(&self) -> Result<bool> {631		self.base.base.disable_grandpa()632	}633634	fn max_runtime_instances(&self) -> Result<Option<usize>> {635		self.base.base.max_runtime_instances()636	}637638	fn announce_block(&self) -> Result<bool> {639		self.base.base.announce_block()640	}641642	fn telemetry_endpoints(643		&self,644		chain_spec: &Box<dyn ChainSpec>,645	) -> Result<Option<sc_telemetry::TelemetryEndpoints>> {646		self.base.base.telemetry_endpoints(chain_spec)647	}648}