git.delta.rocks / unique-network / refs/commits / 22b45b5cd782

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 crate::{36	chain_spec::{self, RuntimeIdentification, ServiceId, ServiceIdentification},37	cli::{Cli, RelayChainCli, Subcommand},38	service::{new_partial, start_node, start_dev_node},39};40#[cfg(feature = "runtime-benchmarks")]41use crate::chain_spec::default_runtime;4243#[cfg(feature = "unique-runtime")]44use crate::service::UniqueRuntimeExecutor;4546#[cfg(feature = "quartz-runtime")]47use crate::service::QuartzRuntimeExecutor;4849use crate::service::OpalRuntimeExecutor;5051#[cfg(feature = "runtime-benchmarks")]52use crate::service::DefaultRuntimeExecutor;5354use codec::Encode;55use cumulus_primitives_core::ParaId;56use cumulus_client_cli::generate_genesis_block;57use log::{debug, info};58use sc_cli::{59	ChainSpec, CliConfiguration, DefaultConfigurationValues, ImportParams, KeystoreParams,60	NetworkParams, Result, RuntimeVersion, SharedParams, SubstrateCli,61};62use sc_service::config::{BasePath, PrometheusConfig};63use sp_core::hexdisplay::HexDisplay;64use sp_runtime::traits::{AccountIdConversion, Block as BlockT};6566use up_common::types::opaque::{Block, RuntimeId};6768macro_rules! no_runtime_err {69	($runtime_id:expr) => {70		format!(71			"No runtime valid runtime was found for chain {:#?}",72			$runtime_id73		)74	};75}7677fn load_spec(id: &str) -> std::result::Result<Box<dyn sc_service::ChainSpec>, String> {78	Ok(match id {79		"dev" => Box::new(chain_spec::development_config()),80		"" | "local" => Box::new(chain_spec::local_testnet_config()),81		path => {82			let path = std::path::PathBuf::from(path);83			#[allow(clippy::redundant_clone)]84			let chain_spec = Box::new(chain_spec::OpalChainSpec::from_json_file(path.clone())?)85				as Box<dyn sc_service::ChainSpec>;8687			match chain_spec.runtime_id() {88				#[cfg(feature = "unique-runtime")]89				RuntimeId::Unique => Box::new(chain_spec::UniqueChainSpec::from_json_file(path)?),9091				#[cfg(feature = "quartz-runtime")]92				RuntimeId::Quartz => Box::new(chain_spec::QuartzChainSpec::from_json_file(path)?),9394				RuntimeId::Opal => chain_spec,95				runtime_id => return Err(no_runtime_err!(runtime_id)),96			}97		}98	})99}100101impl SubstrateCli for Cli {102	// TODO use args103	fn impl_name() -> String {104		format!("{} Node", Self::node_name())105	}106107	fn impl_version() -> String {108		env!("SUBSTRATE_CLI_IMPL_VERSION").into()109	}110	// TODO use args111	fn description() -> String {112		format!(113			"{} Node\n\nThe command-line arguments provided first will be \114		passed to the parachain node, while the arguments provided after -- will be passed \115		to the relaychain node.\n\n\116		{} [parachain-args] -- [relaychain-args]",117			Self::node_name(),118			Self::executable_name()119		)120	}121122	fn author() -> String {123		env!("CARGO_PKG_AUTHORS").into()124	}125126	//TODO use args127	fn support_url() -> String {128		"support@unique.network".into()129	}130131	fn copyright_start_year() -> i32 {132		2019133	}134135	fn load_spec(&self, id: &str) -> std::result::Result<Box<dyn sc_service::ChainSpec>, String> {136		load_spec(id)137	}138139	fn native_runtime_version(chain_spec: &Box<dyn ChainSpec>) -> &'static RuntimeVersion {140		match chain_spec.runtime_id() {141			#[cfg(feature = "unique-runtime")]142			RuntimeId::Unique => &unique_runtime::VERSION,143144			#[cfg(feature = "quartz-runtime")]145			RuntimeId::Quartz => &quartz_runtime::VERSION,146147			RuntimeId::Opal => &opal_runtime::VERSION,148			runtime_id => panic!("{}", no_runtime_err!(runtime_id)),149		}150	}151}152153impl SubstrateCli for RelayChainCli {154	// TODO use args155	fn impl_name() -> String {156		format!("{} Node", Cli::node_name())157	}158159	fn impl_version() -> String {160		env!("SUBSTRATE_CLI_IMPL_VERSION").into()161	}162	// TODO use args163	fn description() -> String {164		format!(165			"{} Node\n\nThe command-line arguments provided first will be \166			passed to the parachain node, while the arguments provided after -- will be passed \167			to the relaychain node.\n\n\168			parachain-collator [parachain-args] -- [relaychain-args]",169			Cli::node_name()170		)171	}172173	fn author() -> String {174		env!("CARGO_PKG_AUTHORS").into()175	}176	// TODO use args177	fn support_url() -> String {178		"support@unique.network".into()179	}180181	fn copyright_start_year() -> i32 {182		2019183	}184185	fn load_spec(&self, id: &str) -> std::result::Result<Box<dyn sc_service::ChainSpec>, String> {186		polkadot_cli::Cli::from_iter([RelayChainCli::executable_name()].iter()).load_spec(id)187	}188189	fn native_runtime_version(chain_spec: &Box<dyn ChainSpec>) -> &'static RuntimeVersion {190		polkadot_cli::Cli::native_runtime_version(chain_spec)191	}192}193194macro_rules! async_run_with_runtime {195	(196		$runtime_api:path, $executor:path,197		$runner:ident, $components:ident, $cli:ident, $cmd:ident, $config:ident,198		$( $code:tt )*199	) => {200		$runner.async_run(|$config| {201			let $components = new_partial::<202				$runtime_api, $executor, _203			>(204				&$config,205				crate::service::parachain_build_import_queue,206			)?;207			let task_manager = $components.task_manager;208209			{ $( $code )* }.map(|v| (v, task_manager))210		})211	};212}213214macro_rules! construct_async_run {215	(|$components:ident, $cli:ident, $cmd:ident, $config:ident| $( $code:tt )* ) => {{216		let runner = $cli.create_runner($cmd)?;217218		match runner.config().chain_spec.runtime_id() {219			#[cfg(feature = "unique-runtime")]220			RuntimeId::Unique => async_run_with_runtime!(221				unique_runtime::RuntimeApi, UniqueRuntimeExecutor,222				runner, $components, $cli, $cmd, $config, $( $code )*223			),224225			#[cfg(feature = "quartz-runtime")]226			RuntimeId::Quartz => async_run_with_runtime!(227				quartz_runtime::RuntimeApi, QuartzRuntimeExecutor,228				runner, $components, $cli, $cmd, $config, $( $code )*229			),230231			RuntimeId::Opal => async_run_with_runtime!(232				opal_runtime::RuntimeApi, OpalRuntimeExecutor,233				runner, $components, $cli, $cmd, $config, $( $code )*234			),235236			runtime_id => Err(no_runtime_err!(runtime_id).into())237		}238	}}239}240241macro_rules! sync_run_with_runtime {242	(243		$runtime_api:path, $executor:path,244		$runner:ident, $components:ident, $cli:ident, $cmd:ident, $config:ident,245		$( $code:tt )*246	) => {247		$runner.sync_run(|$config| {248			$( $code )*249		})250	};251}252253macro_rules! construct_sync_run {254	(|$components:ident, $cli:ident, $cmd:ident, $config:ident| $( $code:tt )* ) => {{255		let runner = $cli.create_runner($cmd)?;256257		match runner.config().chain_spec.runtime_id() {258			#[cfg(feature = "unique-runtime")]259			RuntimeId::Unique => sync_run_with_runtime!(260				unique_runtime::RuntimeApi, UniqueRuntimeExecutor,261				runner, $components, $cli, $cmd, $config, $( $code )*262			),263264			#[cfg(feature = "quartz-runtime")]265			RuntimeId::Quartz => sync_run_with_runtime!(266				quartz_runtime::RuntimeApi, QuartzRuntimeExecutor,267				runner, $components, $cli, $cmd, $config, $( $code )*268			),269270			RuntimeId::Opal => sync_run_with_runtime!(271				opal_runtime::RuntimeApi, OpalRuntimeExecutor,272				runner, $components, $cli, $cmd, $config, $( $code )*273			),274275			runtime_id => Err(no_runtime_err!(runtime_id).into())276		}277	}}278}279280macro_rules! start_node_using_chain_runtime {281	($start_node_fn:ident($config:expr $(, $($args:expr),+)?) $($code:tt)*) => {282		match $config.chain_spec.runtime_id() {283			#[cfg(feature = "unique-runtime")]284			RuntimeId::Unique => $start_node_fn::<285				unique_runtime::Runtime,286				unique_runtime::RuntimeApi,287				UniqueRuntimeExecutor,288			>($config $(, $($args),+)?) $($code)*,289290			#[cfg(feature = "quartz-runtime")]291			RuntimeId::Quartz => $start_node_fn::<292				quartz_runtime::Runtime,293				quartz_runtime::RuntimeApi,294				QuartzRuntimeExecutor,295			>($config $(, $($args),+)?) $($code)*,296297			RuntimeId::Opal => $start_node_fn::<298				opal_runtime::Runtime,299				opal_runtime::RuntimeApi,300				OpalRuntimeExecutor,301			>($config $(, $($args),+)?) $($code)*,302303			runtime_id => Err(no_runtime_err!(runtime_id).into()),304		}305	};306}307308/// Parse command line arguments into service configuration.309pub fn run() -> Result<()> {310	let cli = Cli::from_args();311312	match &cli.subcommand {313		Some(Subcommand::Key(cmd)) => cmd.run(&cli),314		Some(Subcommand::BuildSpec(cmd)) => {315			let runner = cli.create_runner(cmd)?;316			runner.sync_run(|config| cmd.run(config.chain_spec, config.network))317		}318		Some(Subcommand::CheckBlock(cmd)) => {319			construct_async_run!(|components, cli, cmd, config| {320				Ok(cmd.run(components.client, components.import_queue))321			})322		}323		Some(Subcommand::ExportBlocks(cmd)) => {324			construct_async_run!(|components, cli, cmd, config| {325				Ok(cmd.run(components.client, config.database))326			})327		}328		Some(Subcommand::ExportState(cmd)) => {329			construct_async_run!(|components, cli, cmd, config| {330				Ok(cmd.run(components.client, config.chain_spec))331			})332		}333		Some(Subcommand::ImportBlocks(cmd)) => {334			construct_async_run!(|components, cli, cmd, config| {335				Ok(cmd.run(components.client, components.import_queue))336			})337		}338		Some(Subcommand::PurgeChain(cmd)) => {339			let runner = cli.create_runner(cmd)?;340341			runner.sync_run(|config| {342				let polkadot_cli = RelayChainCli::new(343					&config,344					[RelayChainCli::executable_name()]345						.iter()346						.chain(cli.relaychain_args.iter()),347				);348349				let polkadot_config = SubstrateCli::create_configuration(350					&polkadot_cli,351					&polkadot_cli,352					config.tokio_handle.clone(),353				)354				.map_err(|err| format!("Relay chain argument error: {err}"))?;355356				cmd.run(config, polkadot_config)357			})358		}359		Some(Subcommand::Revert(cmd)) => construct_async_run!(|components, cli, cmd, config| {360			Ok(cmd.run(components.client, components.backend, None))361		}),362		Some(Subcommand::ExportGenesisState(cmd)) => {363			construct_sync_run!(|components, cli, cmd, _config| {364				let spec = cli.load_spec(&cmd.shared_params.chain.clone().unwrap_or_default())?;365				let state_version = Cli::native_runtime_version(&spec).state_version();366				cmd.run::<Block>(&*spec, state_version)367			})368		}369		Some(Subcommand::ExportGenesisWasm(cmd)) => {370			construct_sync_run!(|components, cli, cmd, _config| {371				let spec = cli.load_spec(&cmd.shared_params.chain.clone().unwrap_or_default())?;372				cmd.run(&*spec)373			})374		}375		#[cfg(feature = "runtime-benchmarks")]376		Some(Subcommand::Benchmark(cmd)) => {377			use frame_benchmarking_cli::{BenchmarkCmd, SUBSTRATE_REFERENCE_HARDWARE};378			let runner = cli.create_runner(cmd)?;379			// Switch on the concrete benchmark sub-command-380			match cmd {381				BenchmarkCmd::Pallet(cmd) => {382					runner.sync_run(|config| cmd.run::<Block, DefaultRuntimeExecutor>(config))383				}384				BenchmarkCmd::Block(cmd) => runner.sync_run(|config| {385					let partials = new_partial::<386						default_runtime::RuntimeApi,387						DefaultRuntimeExecutor,388						_,389					>(&config, crate::service::parachain_build_import_queue)?;390					cmd.run(partials.client)391				}),392				BenchmarkCmd::Storage(cmd) => runner.sync_run(|config| {393					let partials = new_partial::<394						default_runtime::RuntimeApi,395						DefaultRuntimeExecutor,396						_,397					>(&config, crate::service::parachain_build_import_queue)?;398					let db = partials.backend.expose_db();399					let storage = partials.backend.expose_storage();400401					cmd.run(config, partials.client.clone(), db, storage)402				}),403				BenchmarkCmd::Machine(cmd) => {404					runner.sync_run(|config| cmd.run(&config, SUBSTRATE_REFERENCE_HARDWARE.clone()))405				}406				BenchmarkCmd::Overhead(_) | BenchmarkCmd::Extrinsic(_) => {407					Err("Unsupported benchmarking command".into())408				}409			}410		}411		#[cfg(feature = "try-runtime")]412		Some(Subcommand::TryRuntime(cmd)) => {413			use std::{future::Future, pin::Pin};414			use sc_executor::{sp_wasm_interface::ExtendedHostFunctions, NativeExecutionDispatch};415			use try_runtime_cli::block_building_info::timestamp_with_aura_info;416417			let runner = cli.create_runner(cmd)?;418419			// grab the task manager.420			let registry = &runner421				.config()422				.prometheus_config423				.as_ref()424				.map(|cfg| &cfg.registry);425			let task_manager =426				sc_service::TaskManager::new(runner.config().tokio_handle.clone(), *registry)427					.map_err(|e| format!("Error: {e:?}"))?;428			let info_provider = Some(timestamp_with_aura_info(12000));429430			runner.async_run(|config| -> Result<(Pin<Box<dyn Future<Output = _>>>, _)> {431				Ok((432					match config.chain_spec.runtime_id() {433						#[cfg(feature = "unique-runtime")]434						RuntimeId::Unique => Box::pin(cmd.run::<Block, ExtendedHostFunctions<435							sp_io::SubstrateHostFunctions,436							<UniqueRuntimeExecutor as NativeExecutionDispatch>::ExtendHostFunctions,437						>, _>(info_provider)),438439						#[cfg(feature = "quartz-runtime")]440						RuntimeId::Quartz => Box::pin(cmd.run::<Block, ExtendedHostFunctions<441							sp_io::SubstrateHostFunctions,442							<QuartzRuntimeExecutor as NativeExecutionDispatch>::ExtendHostFunctions,443						>, _>(info_provider)),444445						RuntimeId::Opal => Box::pin(cmd.run::<Block, ExtendedHostFunctions<446							sp_io::SubstrateHostFunctions,447							<OpalRuntimeExecutor as NativeExecutionDispatch>::ExtendHostFunctions,448						>, _>(info_provider)),449						runtime_id => return Err(no_runtime_err!(runtime_id).into()),450					},451					task_manager,452				))453			})454		}455		#[cfg(not(feature = "try-runtime"))]456		Some(Subcommand::TryRuntime) => {457			Err("Try-runtime must be enabled by `--features try-runtime`.".into())458		}459		None => {460			let runner = cli.create_runner(&cli.run.normalize())?;461			let collator_options = cli.run.collator_options();462463			runner.run_node_until_exit(|config| async move {464				let hwbench = if !cli.no_hardware_benchmarks {465					config.database.path().map(|database_path| {466						let _ = std::fs::create_dir_all(database_path);467						sc_sysinfo::gather_hwbench(Some(database_path))468					})469				} else {470					None471				};472473				let extensions = chain_spec::Extensions::try_get(&*config.chain_spec);474475				let service_id = config.chain_spec.service_id();476				let relay_chain_id = extensions.map(|e| e.relay_chain.clone());477				let is_dev_service = matches![service_id, ServiceId::Dev]478					|| relay_chain_id == Some("dev-service".into());479480				if is_dev_service {481					info!("Running Dev service");482483					let mut config = config;484485					config.state_pruning = Some(sc_service::PruningMode::ArchiveAll);486487					return start_node_using_chain_runtime! {488						start_dev_node(config, cli.idle_autoseal_interval, cli.autoseal_finalization_delay, cli.disable_autoseal_on_tx).map_err(Into::into)489					};490				};491492				let para_id = extensions493					.map(|e| e.para_id)494					.ok_or("Could not find parachain ID in chain-spec.")?;495496				let polkadot_cli = RelayChainCli::new(497					&config,498					[RelayChainCli::executable_name()]499						.iter()500						.chain(cli.relaychain_args.iter()),501				);502503				let para_id = ParaId::from(para_id);504505				let parachain_account =506					AccountIdConversion::<polkadot_primitives::AccountId>::into_account_truncating(507						&para_id,508					);509510				let state_version = Cli::native_runtime_version(&config.chain_spec).state_version();511				let block: Block = generate_genesis_block(&*config.chain_spec, state_version)512					.map_err(|e| format!("{e:?}"))?;513				let genesis_state = format!("0x{:?}", HexDisplay::from(&block.header().encode()));514				let genesis_hash = format!("0x{:?}", HexDisplay::from(&block.header().hash().0));515516				let polkadot_config = SubstrateCli::create_configuration(517					&polkadot_cli,518					&polkadot_cli,519					config.tokio_handle.clone(),520				)521				.map_err(|err| format!("Relay chain argument error: {err}"))?;522523				info!("Parachain id: {:?}", para_id);524				info!("Parachain Account: {}", parachain_account);525				info!("Parachain genesis state: {}", genesis_state);526				info!("Parachain genesis hash: {}", genesis_hash);527				debug!("Parachain genesis block: {:?}", block);528				info!(529					"Is collating: {}",530					if config.role.is_authority() {531						"yes"532					} else {533						"no"534					}535				);536537				start_node_using_chain_runtime! {538					start_node(config, polkadot_config, collator_options, para_id, hwbench)539						.await540						.map(|r| r.0)541						.map_err(Into::into)542				}543			})544		}545	}546}547548impl DefaultConfigurationValues for RelayChainCli {549	fn p2p_listen_port() -> u16 {550		30334551	}552553	fn rpc_listen_port() -> u16 {554		9945555	}556557	fn prometheus_listen_port() -> u16 {558		9616559	}560}561562impl CliConfiguration<Self> for RelayChainCli {563	fn shared_params(&self) -> &SharedParams {564		self.base.base.shared_params()565	}566567	fn import_params(&self) -> Option<&ImportParams> {568		self.base.base.import_params()569	}570571	fn network_params(&self) -> Option<&NetworkParams> {572		self.base.base.network_params()573	}574575	fn keystore_params(&self) -> Option<&KeystoreParams> {576		self.base.base.keystore_params()577	}578579	fn base_path(&self) -> Result<Option<BasePath>> {580		Ok(self581			.shared_params()582			.base_path()?583			.or_else(|| Some(self.base_path.clone().into())))584	}585586	fn prometheus_config(587		&self,588		default_listen_port: u16,589		chain_spec: &Box<dyn ChainSpec>,590	) -> Result<Option<PrometheusConfig>> {591		self.base592			.base593			.prometheus_config(default_listen_port, chain_spec)594	}595596	fn init<F>(597		&self,598		_support_url: &String,599		_impl_version: &String,600		_logger_hook: F,601		_config: &sc_service::Configuration,602	) -> Result<()> {603		unreachable!("PolkadotCli is never initialized; qed");604	}605606	fn chain_id(&self, is_dev: bool) -> Result<String> {607		let chain_id = self.base.base.chain_id(is_dev)?;608609		Ok(if chain_id.is_empty() {610			self.chain_id.clone().unwrap_or_default()611		} else {612			chain_id613		})614	}615616	fn role(&self, is_dev: bool) -> Result<sc_service::Role> {617		self.base.base.role(is_dev)618	}619620	fn transaction_pool(&self, is_dev: bool) -> Result<sc_service::config::TransactionPoolOptions> {621		self.base.base.transaction_pool(is_dev)622	}623624	fn rpc_methods(&self) -> Result<sc_service::config::RpcMethods> {625		self.base.base.rpc_methods()626	}627628	fn rpc_max_connections(&self) -> Result<u32> {629		self.base.base.rpc_max_connections()630	}631632	fn rpc_cors(&self, is_dev: bool) -> Result<Option<Vec<String>>> {633		self.base.base.rpc_cors(is_dev)634	}635636	fn default_heap_pages(&self) -> Result<Option<u64>> {637		self.base.base.default_heap_pages()638	}639640	fn force_authoring(&self) -> Result<bool> {641		self.base.base.force_authoring()642	}643644	fn disable_grandpa(&self) -> Result<bool> {645		self.base.base.disable_grandpa()646	}647648	fn max_runtime_instances(&self) -> Result<Option<usize>> {649		self.base.base.max_runtime_instances()650	}651652	fn announce_block(&self) -> Result<bool> {653		self.base.base.announce_block()654	}655656	fn telemetry_endpoints(657		&self,658		chain_spec: &Box<dyn ChainSpec>,659	) -> Result<Option<sc_telemetry::TelemetryEndpoints>> {660		self.base.base.telemetry_endpoints(chain_spec)661	}662}