git.delta.rocks / unique-network / refs/commits / 885f1d23d20d

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 = "runtime-benchmarks")]46use crate::chain_spec::default_runtime;47#[cfg(feature = "runtime-benchmarks")]48use crate::service::DefaultRuntimeExecutor;49#[cfg(feature = "quartz-runtime")]50use crate::service::QuartzRuntimeExecutor;51#[cfg(feature = "unique-runtime")]52use crate::service::UniqueRuntimeExecutor;53use crate::{54	chain_spec::{self, RuntimeIdentification, ServiceId, ServiceIdentification},55	cli::{Cli, RelayChainCli, Subcommand},56	service::{new_partial, start_dev_node, start_node, OpalRuntimeExecutor},57};5859macro_rules! no_runtime_err {60	($runtime_id:expr) => {61		format!(62			"No runtime valid runtime was found for chain {:#?}",63			$runtime_id64		)65	};66}6768fn load_spec(id: &str) -> std::result::Result<Box<dyn sc_service::ChainSpec>, String> {69	Ok(match id {70		"dev" => Box::new(chain_spec::development_config()),71		"" | "local" => Box::new(chain_spec::local_testnet_config()),72		path => {73			let path = std::path::PathBuf::from(path);74			#[allow(clippy::redundant_clone)]75			let chain_spec = Box::new(chain_spec::OpalChainSpec::from_json_file(path.clone())?)76				as Box<dyn sc_service::ChainSpec>;7778			match chain_spec.runtime_id() {79				#[cfg(feature = "unique-runtime")]80				RuntimeId::Unique => Box::new(chain_spec::UniqueChainSpec::from_json_file(path)?),8182				#[cfg(feature = "quartz-runtime")]83				RuntimeId::Quartz => Box::new(chain_spec::QuartzChainSpec::from_json_file(path)?),8485				RuntimeId::Opal => chain_spec,86				runtime_id => return Err(no_runtime_err!(runtime_id)),87			}88		}89	})90}9192impl SubstrateCli for Cli {93	// TODO use args94	fn impl_name() -> String {95		format!("{} Node", Self::node_name())96	}9798	fn impl_version() -> String {99		env!("SUBSTRATE_CLI_IMPL_VERSION").into()100	}101	// TODO use args102	fn description() -> String {103		format!(104			"{} Node\n\nThe command-line arguments provided first will be \105		passed to the parachain node, while the arguments provided after -- will be passed \106		to the relaychain node.\n\n\107		{} [parachain-args] -- [relaychain-args]",108			Self::node_name(),109			Self::executable_name()110		)111	}112113	fn author() -> String {114		env!("CARGO_PKG_AUTHORS").into()115	}116117	//TODO use args118	fn support_url() -> String {119		"support@unique.network".into()120	}121122	fn copyright_start_year() -> i32 {123		2019124	}125126	fn load_spec(&self, id: &str) -> std::result::Result<Box<dyn sc_service::ChainSpec>, String> {127		load_spec(id)128	}129}130131impl SubstrateCli for RelayChainCli {132	// TODO use args133	fn impl_name() -> String {134		format!("{} Node", Cli::node_name())135	}136137	fn impl_version() -> String {138		env!("SUBSTRATE_CLI_IMPL_VERSION").into()139	}140	// TODO use args141	fn description() -> String {142		format!(143			"{} Node\n\nThe command-line arguments provided first will be \144			passed to the parachain node, while the arguments provided after -- will be passed \145			to the relaychain node.\n\n\146			parachain-collator [parachain-args] -- [relaychain-args]",147			Cli::node_name()148		)149	}150151	fn author() -> String {152		env!("CARGO_PKG_AUTHORS").into()153	}154	// TODO use args155	fn support_url() -> String {156		"support@unique.network".into()157	}158159	fn copyright_start_year() -> i32 {160		2019161	}162163	fn load_spec(&self, id: &str) -> std::result::Result<Box<dyn sc_service::ChainSpec>, String> {164		polkadot_cli::Cli::from_iter([RelayChainCli::executable_name()].iter()).load_spec(id)165	}166}167168macro_rules! async_run_with_runtime {169	(170		$runtime:path, $runtime_api:path, $executor:path,171		$runner:ident, $components:ident, $cli:ident, $cmd:ident, $config:ident,172		$( $code:tt )*173	) => {174		$runner.async_run(|$config| {175			let $components = new_partial::<176				$runtime, $runtime_api, $executor, _177			>(178				&$config,179				crate::service::parachain_build_import_queue::<$runtime, _, _>,180			)?;181			let task_manager = $components.task_manager;182183			{ $( $code )* }.map(|v| (v, task_manager))184		})185	};186}187188macro_rules! construct_async_run {189	(|$components:ident, $cli:ident, $cmd:ident, $config:ident| $( $code:tt )* ) => {{190		let runner = $cli.create_runner($cmd)?;191192		match runner.config().chain_spec.runtime_id() {193			#[cfg(feature = "unique-runtime")]194			RuntimeId::Unique => async_run_with_runtime!(195				unique_runtime::Runtime, unique_runtime::RuntimeApi, UniqueRuntimeExecutor,196				runner, $components, $cli, $cmd, $config, $( $code )*197			),198199			#[cfg(feature = "quartz-runtime")]200			RuntimeId::Quartz => async_run_with_runtime!(201				quartz_runtime::Runtime, quartz_runtime::RuntimeApi, QuartzRuntimeExecutor,202				runner, $components, $cli, $cmd, $config, $( $code )*203			),204205			RuntimeId::Opal => async_run_with_runtime!(206				opal_runtime::Runtime, opal_runtime::RuntimeApi, OpalRuntimeExecutor,207				runner, $components, $cli, $cmd, $config, $( $code )*208			),209210			runtime_id => Err(no_runtime_err!(runtime_id).into())211		}212	}}213}214215macro_rules! sync_run_with_runtime {216	(217		$runtime:path, $runtime_api:path, $executor:path,218		$runner:ident, $components:ident, $cli:ident, $cmd:ident, $config:ident,219		$( $code:tt )*220	) => {221		$runner.sync_run(|$config| {222			let $components = new_partial::<223				$runtime, $runtime_api, $executor, _224			>(225				&$config,226				crate::service::parachain_build_import_queue::<$runtime, _, _>,227			)?;228229			$( $code )*230		})231	};232}233234macro_rules! construct_sync_run {235	(|$components:ident, $cli:ident, $cmd:ident, $config:ident| $( $code:tt )* ) => {{236		let runner = $cli.create_runner($cmd)?;237238		match runner.config().chain_spec.runtime_id() {239			#[cfg(feature = "unique-runtime")]240			RuntimeId::Unique => sync_run_with_runtime!(241				unique_runtime::Runtime, unique_runtime::RuntimeApi, UniqueRuntimeExecutor,242				runner, $components, $cli, $cmd, $config, $( $code )*243			),244245			#[cfg(feature = "quartz-runtime")]246			RuntimeId::Quartz => sync_run_with_runtime!(247				quartz_runtime::Runtime, quartz_runtime::RuntimeApi, QuartzRuntimeExecutor,248				runner, $components, $cli, $cmd, $config, $( $code )*249			),250251			RuntimeId::Opal => sync_run_with_runtime!(252				opal_runtime::Runtime, opal_runtime::RuntimeApi, OpalRuntimeExecutor,253				runner, $components, $cli, $cmd, $config, $( $code )*254			),255256			runtime_id => Err(no_runtime_err!(runtime_id).into())257		}258	}}259}260261macro_rules! start_node_using_chain_runtime {262	($start_node_fn:ident($config:expr $(, $($args:expr),+)?) $($code:tt)*) => {263		match $config.chain_spec.runtime_id() {264			#[cfg(feature = "unique-runtime")]265			RuntimeId::Unique => $start_node_fn::<266				unique_runtime::Runtime,267				unique_runtime::RuntimeApi,268				UniqueRuntimeExecutor,269			>($config $(, $($args),+)?) $($code)*,270271			#[cfg(feature = "quartz-runtime")]272			RuntimeId::Quartz => $start_node_fn::<273				quartz_runtime::Runtime,274				quartz_runtime::RuntimeApi,275				QuartzRuntimeExecutor,276			>($config $(, $($args),+)?) $($code)*,277278			RuntimeId::Opal => $start_node_fn::<279				opal_runtime::Runtime,280				opal_runtime::RuntimeApi,281				OpalRuntimeExecutor,282			>($config $(, $($args),+)?) $($code)*,283284			runtime_id => Err(no_runtime_err!(runtime_id).into()),285		}286	};287}288289/// Parse command line arguments into service configuration.290pub fn run() -> Result<()> {291	let cli = Cli::from_args();292293	match &cli.subcommand {294		Some(Subcommand::Key(cmd)) => cmd.run(&cli),295		Some(Subcommand::BuildSpec(cmd)) => {296			let runner = cli.create_runner(cmd)?;297			runner.sync_run(|config| cmd.run(config.chain_spec, config.network))298		}299		Some(Subcommand::CheckBlock(cmd)) => {300			construct_async_run!(|components, cli, cmd, config| {301				Ok(cmd.run(components.client, components.import_queue))302			})303		}304		Some(Subcommand::ExportBlocks(cmd)) => {305			construct_async_run!(|components, cli, cmd, config| {306				Ok(cmd.run(components.client, config.database))307			})308		}309		Some(Subcommand::ExportState(cmd)) => {310			construct_async_run!(|components, cli, cmd, config| {311				Ok(cmd.run(components.client, config.chain_spec))312			})313		}314		Some(Subcommand::ImportBlocks(cmd)) => {315			construct_async_run!(|components, cli, cmd, config| {316				Ok(cmd.run(components.client, components.import_queue))317			})318		}319		Some(Subcommand::PurgeChain(cmd)) => {320			let runner = cli.create_runner(cmd)?;321322			runner.sync_run(|config| {323				let polkadot_cli = RelayChainCli::new(324					&config,325					[RelayChainCli::executable_name()]326						.iter()327						.chain(cli.relaychain_args.iter()),328				);329330				let polkadot_config = SubstrateCli::create_configuration(331					&polkadot_cli,332					&polkadot_cli,333					config.tokio_handle.clone(),334				)335				.map_err(|err| format!("Relay chain argument error: {err}"))?;336337				cmd.run(config, polkadot_config)338			})339		}340		Some(Subcommand::Revert(cmd)) => construct_async_run!(|components, cli, cmd, config| {341			Ok(cmd.run(components.client, components.backend, None))342		}),343		Some(Subcommand::ExportGenesisState(cmd)) => {344			construct_sync_run!(|components, cli, cmd, _config| {345				let spec = cli.load_spec(&cmd.shared_params.chain.clone().unwrap_or_default())?;346				cmd.run(&*spec, &*components.client)347			})348		}349		Some(Subcommand::ExportGenesisWasm(cmd)) => {350			construct_sync_run!(|_components, cli, cmd, _config| {351				let spec = cli.load_spec(&cmd.shared_params.chain.clone().unwrap_or_default())?;352				cmd.run(&*spec)353			})354		}355		#[cfg(feature = "runtime-benchmarks")]356		Some(Subcommand::Benchmark(cmd)) => {357			use frame_benchmarking_cli::{BenchmarkCmd, SUBSTRATE_REFERENCE_HARDWARE};358			let runner = cli.create_runner(cmd)?;359			// Switch on the concrete benchmark sub-command-360			match cmd {361				BenchmarkCmd::Pallet(cmd) => {362					runner.sync_run(|config| cmd.run::<Block, DefaultRuntimeExecutor>(config))363				}364				BenchmarkCmd::Block(cmd) => runner.sync_run(|config| {365					let partials = new_partial::<366						default_runtime::RuntimeApi,367						DefaultRuntimeExecutor,368						_,369					>(&config, crate::service::parachain_build_import_queue)?;370					cmd.run(partials.client)371				}),372				BenchmarkCmd::Storage(cmd) => runner.sync_run(|config| {373					let partials = new_partial::<374						default_runtime::RuntimeApi,375						DefaultRuntimeExecutor,376						_,377					>(&config, crate::service::parachain_build_import_queue)?;378					let db = partials.backend.expose_db();379					let storage = partials.backend.expose_storage();380381					cmd.run(config, partials.client.clone(), db, storage)382				}),383				BenchmarkCmd::Machine(cmd) => {384					runner.sync_run(|config| cmd.run(&config, SUBSTRATE_REFERENCE_HARDWARE.clone()))385				}386				BenchmarkCmd::Overhead(_) | BenchmarkCmd::Extrinsic(_) => {387					Err("Unsupported benchmarking command".into())388				}389			}390		}391		#[cfg(feature = "try-runtime")]392		Some(Subcommand::TryRuntime(cmd)) => {393			use std::{future::Future, pin::Pin};394395			use sc_executor::{sp_wasm_interface::ExtendedHostFunctions, NativeExecutionDispatch};396			use try_runtime_cli::block_building_info::timestamp_with_aura_info;397398			let runner = cli.create_runner(cmd)?;399400			// grab the task manager.401			let registry = &runner402				.config()403				.prometheus_config404				.as_ref()405				.map(|cfg| &cfg.registry);406			let task_manager =407				sc_service::TaskManager::new(runner.config().tokio_handle.clone(), *registry)408					.map_err(|e| format!("Error: {e:?}"))?;409			let info_provider = Some(timestamp_with_aura_info(12000));410411			runner.async_run(|config| -> Result<(Pin<Box<dyn Future<Output = _>>>, _)> {412				Ok((413					match config.chain_spec.runtime_id() {414						#[cfg(feature = "unique-runtime")]415						RuntimeId::Unique => Box::pin(cmd.run::<Block, ExtendedHostFunctions<416							sp_io::SubstrateHostFunctions,417							<UniqueRuntimeExecutor as NativeExecutionDispatch>::ExtendHostFunctions,418						>, _>(info_provider)),419420						#[cfg(feature = "quartz-runtime")]421						RuntimeId::Quartz => Box::pin(cmd.run::<Block, ExtendedHostFunctions<422							sp_io::SubstrateHostFunctions,423							<QuartzRuntimeExecutor as NativeExecutionDispatch>::ExtendHostFunctions,424						>, _>(info_provider)),425426						RuntimeId::Opal => Box::pin(cmd.run::<Block, ExtendedHostFunctions<427							sp_io::SubstrateHostFunctions,428							<OpalRuntimeExecutor as NativeExecutionDispatch>::ExtendHostFunctions,429						>, _>(info_provider)),430						runtime_id => return Err(no_runtime_err!(runtime_id).into()),431					},432					task_manager,433				))434			})435		}436		#[cfg(not(feature = "try-runtime"))]437		Some(Subcommand::TryRuntime) => {438			Err("Try-runtime must be enabled by `--features try-runtime`.".into())439		}440		None => {441			let runner = cli.create_runner(&cli.run.normalize())?;442			let collator_options = cli.run.collator_options();443444			runner.run_node_until_exit(|config| async move {445				let hwbench = if !cli.no_hardware_benchmarks {446					config.database.path().map(|database_path| {447						let _ = std::fs::create_dir_all(database_path);448						sc_sysinfo::gather_hwbench(Some(database_path))449					})450				} else {451					None452				};453454				let extensions = chain_spec::Extensions::try_get(&*config.chain_spec);455456				let service_id = config.chain_spec.service_id();457				let relay_chain_id = extensions.map(|e| e.relay_chain.clone());458				let is_dev_service = matches![service_id, ServiceId::Dev]459					|| relay_chain_id == Some("dev-service".into());460461				if is_dev_service {462					info!("Running Dev service");463464					let mut config = config;465466					config.state_pruning = Some(sc_service::PruningMode::ArchiveAll);467468					return start_node_using_chain_runtime! {469						start_dev_node(config, cli.idle_autoseal_interval, cli.autoseal_finalization_delay, cli.disable_autoseal_on_tx).map_err(Into::into)470					};471				};472473				let para_id = extensions474					.map(|e| e.para_id)475					.ok_or("Could not find parachain ID in chain-spec.")?;476477				let polkadot_cli = RelayChainCli::new(478					&config,479					[RelayChainCli::executable_name()]480						.iter()481						.chain(cli.relaychain_args.iter()),482				);483484				let para_id = ParaId::from(para_id);485486				let parachain_account =487					AccountIdConversion::<polkadot_primitives::AccountId>::into_account_truncating(488						&para_id,489					);490491				let polkadot_config = SubstrateCli::create_configuration(492					&polkadot_cli,493					&polkadot_cli,494					config.tokio_handle.clone(),495				)496				.map_err(|err| format!("Relay chain argument error: {err}"))?;497498				info!("Parachain id: {:?}", para_id);499				info!("Parachain Account: {}", parachain_account);500				info!(501					"Is collating: {}",502					if config.role.is_authority() {503						"yes"504					} else {505						"no"506					}507				);508509				start_node_using_chain_runtime! {510					start_node(config, polkadot_config, collator_options, para_id, hwbench)511						.await512						.map(|r| r.0)513						.map_err(Into::into)514				}515			})516		}517	}518}519520impl DefaultConfigurationValues for RelayChainCli {521	fn p2p_listen_port() -> u16 {522		30334523	}524525	fn rpc_listen_port() -> u16 {526		9945527	}528529	fn prometheus_listen_port() -> u16 {530		9616531	}532}533534impl CliConfiguration<Self> for RelayChainCli {535	fn shared_params(&self) -> &SharedParams {536		self.base.base.shared_params()537	}538539	fn import_params(&self) -> Option<&ImportParams> {540		self.base.base.import_params()541	}542543	fn network_params(&self) -> Option<&NetworkParams> {544		self.base.base.network_params()545	}546547	fn keystore_params(&self) -> Option<&KeystoreParams> {548		self.base.base.keystore_params()549	}550551	fn base_path(&self) -> Result<Option<BasePath>> {552		Ok(self553			.shared_params()554			.base_path()?555			.or_else(|| Some(self.base_path.clone().into())))556	}557558	fn prometheus_config(559		&self,560		default_listen_port: u16,561		chain_spec: &Box<dyn ChainSpec>,562	) -> Result<Option<PrometheusConfig>> {563		self.base564			.base565			.prometheus_config(default_listen_port, chain_spec)566	}567568	fn init<F>(569		&self,570		_support_url: &String,571		_impl_version: &String,572		_logger_hook: F,573		_config: &sc_service::Configuration,574	) -> Result<()> {575		unreachable!("PolkadotCli is never initialized; qed");576	}577578	fn chain_id(&self, is_dev: bool) -> Result<String> {579		let chain_id = self.base.base.chain_id(is_dev)?;580581		Ok(if chain_id.is_empty() {582			self.chain_id.clone().unwrap_or_default()583		} else {584			chain_id585		})586	}587588	fn role(&self, is_dev: bool) -> Result<sc_service::Role> {589		self.base.base.role(is_dev)590	}591592	fn transaction_pool(&self, is_dev: bool) -> Result<sc_service::config::TransactionPoolOptions> {593		self.base.base.transaction_pool(is_dev)594	}595596	fn rpc_methods(&self) -> Result<sc_service::config::RpcMethods> {597		self.base.base.rpc_methods()598	}599600	fn rpc_max_connections(&self) -> Result<u32> {601		self.base.base.rpc_max_connections()602	}603604	fn rpc_cors(&self, is_dev: bool) -> Result<Option<Vec<String>>> {605		self.base.base.rpc_cors(is_dev)606	}607608	fn default_heap_pages(&self) -> Result<Option<u64>> {609		self.base.base.default_heap_pages()610	}611612	fn force_authoring(&self) -> Result<bool> {613		self.base.base.force_authoring()614	}615616	fn disable_grandpa(&self) -> Result<bool> {617		self.base.base.disable_grandpa()618	}619620	fn max_runtime_instances(&self) -> Result<Option<usize>> {621		self.base.base.max_runtime_instances()622	}623624	fn announce_block(&self) -> Result<bool> {625		self.base.base.announce_block()626	}627628	fn telemetry_endpoints(629		&self,630		chain_spec: &Box<dyn ChainSpec>,631	) -> Result<Option<sc_telemetry::TelemetryEndpoints>> {632		self.base.base.telemetry_endpoints(chain_spec)633	}634}