git.delta.rocks / unique-network / refs/commits / 83605d41c907

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::{63	config::{BasePath, PrometheusConfig},64};65use sp_core::hexdisplay::HexDisplay;66use sp_runtime::traits::{AccountIdConversion, Block as BlockT};67use std::{net::SocketAddr, time::Duration};6869use up_common::types::opaque::{Block, RuntimeId};7071macro_rules! no_runtime_err {72	($runtime_id:expr) => {73		format!(74			"No runtime valid runtime was found for chain {:#?}",75			$runtime_id76		)77	};78}7980fn load_spec(id: &str) -> std::result::Result<Box<dyn sc_service::ChainSpec>, String> {81	Ok(match id {82		"dev" => Box::new(chain_spec::development_config()),83		"" | "local" => Box::new(chain_spec::local_testnet_config()),84		path => {85			let path = std::path::PathBuf::from(path);86			#[allow(clippy::redundant_clone)]87			let chain_spec = Box::new(chain_spec::OpalChainSpec::from_json_file(path.clone())?)88				as Box<dyn sc_service::ChainSpec>;8990			match chain_spec.runtime_id() {91				#[cfg(feature = "unique-runtime")]92				RuntimeId::Unique => Box::new(chain_spec::UniqueChainSpec::from_json_file(path)?),9394				#[cfg(feature = "quartz-runtime")]95				RuntimeId::Quartz => Box::new(chain_spec::QuartzChainSpec::from_json_file(path)?),9697				RuntimeId::Opal => chain_spec,98				runtime_id => return Err(no_runtime_err!(runtime_id)),99			}100		}101	})102}103104impl SubstrateCli for Cli {105	// TODO use args106	fn impl_name() -> String {107		format!("{} Node", Self::node_name())108	}109110	fn impl_version() -> String {111		env!("SUBSTRATE_CLI_IMPL_VERSION").into()112	}113	// TODO use args114	fn description() -> String {115		format!(116			"{} Node\n\nThe command-line arguments provided first will be \117		passed to the parachain node, while the arguments provided after -- will be passed \118		to the relaychain node.\n\n\119		{} [parachain-args] -- [relaychain-args]",120			Self::node_name(),121			Self::executable_name()122		)123	}124125	fn author() -> String {126		env!("CARGO_PKG_AUTHORS").into()127	}128129	//TODO use args130	fn support_url() -> String {131		"support@unique.network".into()132	}133134	fn copyright_start_year() -> i32 {135		2019136	}137138	fn load_spec(&self, id: &str) -> std::result::Result<Box<dyn sc_service::ChainSpec>, String> {139		load_spec(id)140	}141142	fn native_runtime_version(chain_spec: &Box<dyn ChainSpec>) -> &'static RuntimeVersion {143		match chain_spec.runtime_id() {144			#[cfg(feature = "unique-runtime")]145			RuntimeId::Unique => &unique_runtime::VERSION,146147			#[cfg(feature = "quartz-runtime")]148			RuntimeId::Quartz => &quartz_runtime::VERSION,149150			RuntimeId::Opal => &opal_runtime::VERSION,151			runtime_id => panic!("{}", no_runtime_err!(runtime_id)),152		}153	}154}155156impl SubstrateCli for RelayChainCli {157	// TODO use args158	fn impl_name() -> String {159		format!("{} Node", Cli::node_name())160	}161162	fn impl_version() -> String {163		env!("SUBSTRATE_CLI_IMPL_VERSION").into()164	}165	// TODO use args166	fn description() -> String {167		format!(168			"{} Node\n\nThe command-line arguments provided first will be \169			passed to the parachain node, while the arguments provided after -- will be passed \170			to the relaychain node.\n\n\171			parachain-collator [parachain-args] -- [relaychain-args]",172			Cli::node_name()173		)174	}175176	fn author() -> String {177		env!("CARGO_PKG_AUTHORS").into()178	}179	// TODO use args180	fn support_url() -> String {181		"support@unique.network".into()182	}183184	fn copyright_start_year() -> i32 {185		2019186	}187188	fn load_spec(&self, id: &str) -> std::result::Result<Box<dyn sc_service::ChainSpec>, String> {189		polkadot_cli::Cli::from_iter([RelayChainCli::executable_name()].iter()).load_spec(id)190	}191192	fn native_runtime_version(chain_spec: &Box<dyn ChainSpec>) -> &'static RuntimeVersion {193		polkadot_cli::Cli::native_runtime_version(chain_spec)194	}195}196197macro_rules! async_run_with_runtime {198	(199		$runtime_api:path, $executor:path,200		$runner:ident, $components:ident, $cli:ident, $cmd:ident, $config:ident,201		$( $code:tt )*202	) => {203		$runner.async_run(|$config| {204			let $components = new_partial::<205				$runtime_api, $executor, _206			>(207				&$config,208				crate::service::parachain_build_import_queue,209			)?;210			let task_manager = $components.task_manager;211212			{ $( $code )* }.map(|v| (v, task_manager))213		})214	};215}216217macro_rules! construct_async_run {218	(|$components:ident, $cli:ident, $cmd:ident, $config:ident| $( $code:tt )* ) => {{219		let runner = $cli.create_runner($cmd)?;220221		match runner.config().chain_spec.runtime_id() {222			#[cfg(feature = "unique-runtime")]223			RuntimeId::Unique => async_run_with_runtime!(224				unique_runtime::RuntimeApi, UniqueRuntimeExecutor,225				runner, $components, $cli, $cmd, $config, $( $code )*226			),227228			#[cfg(feature = "quartz-runtime")]229			RuntimeId::Quartz => async_run_with_runtime!(230				quartz_runtime::RuntimeApi, QuartzRuntimeExecutor,231				runner, $components, $cli, $cmd, $config, $( $code )*232			),233234			RuntimeId::Opal => async_run_with_runtime!(235				opal_runtime::RuntimeApi, OpalRuntimeExecutor,236				runner, $components, $cli, $cmd, $config, $( $code )*237			),238239			runtime_id => Err(no_runtime_err!(runtime_id).into())240		}241	}}242}243244macro_rules! sync_run_with_runtime {245	(246		$runtime_api:path, $executor:path,247		$runner:ident, $components:ident, $cli:ident, $cmd:ident, $config:ident,248		$( $code:tt )*249	) => {250		$runner.sync_run(|$config| {251			$( $code )*252		})253	};254}255256macro_rules! construct_sync_run {257	(|$components:ident, $cli:ident, $cmd:ident, $config:ident| $( $code:tt )* ) => {{258		let runner = $cli.create_runner($cmd)?;259260		match runner.config().chain_spec.runtime_id() {261			#[cfg(feature = "unique-runtime")]262			RuntimeId::Unique => sync_run_with_runtime!(263				unique_runtime::RuntimeApi, UniqueRuntimeExecutor,264				runner, $components, $cli, $cmd, $config, $( $code )*265			),266267			#[cfg(feature = "quartz-runtime")]268			RuntimeId::Quartz => sync_run_with_runtime!(269				quartz_runtime::RuntimeApi, QuartzRuntimeExecutor,270				runner, $components, $cli, $cmd, $config, $( $code )*271			),272273			RuntimeId::Opal => sync_run_with_runtime!(274				opal_runtime::RuntimeApi, OpalRuntimeExecutor,275				runner, $components, $cli, $cmd, $config, $( $code )*276			),277278			runtime_id => Err(no_runtime_err!(runtime_id).into())279		}280	}}281}282283macro_rules! start_node_using_chain_runtime {284	($start_node_fn:ident($config:expr $(, $($args:expr),+)?) $($code:tt)*) => {285		match $config.chain_spec.runtime_id() {286			#[cfg(feature = "unique-runtime")]287			RuntimeId::Unique => $start_node_fn::<288				unique_runtime::Runtime,289				unique_runtime::RuntimeApi,290				UniqueRuntimeExecutor,291			>($config $(, $($args),+)?) $($code)*,292293			#[cfg(feature = "quartz-runtime")]294			RuntimeId::Quartz => $start_node_fn::<295				quartz_runtime::Runtime,296				quartz_runtime::RuntimeApi,297				QuartzRuntimeExecutor,298			>($config $(, $($args),+)?) $($code)*,299300			RuntimeId::Opal => $start_node_fn::<301				opal_runtime::Runtime,302				opal_runtime::RuntimeApi,303				OpalRuntimeExecutor,304			>($config $(, $($args),+)?) $($code)*,305306			runtime_id => Err(no_runtime_err!(runtime_id).into()),307		}308	};309}310311/// Parse command line arguments into service configuration.312pub fn run() -> Result<()> {313	let cli = Cli::from_args();314315	match &cli.subcommand {316		Some(Subcommand::Key(cmd)) => cmd.run(&cli),317		Some(Subcommand::BuildSpec(cmd)) => {318			let runner = cli.create_runner(cmd)?;319			runner.sync_run(|config| cmd.run(config.chain_spec, config.network))320		}321		Some(Subcommand::CheckBlock(cmd)) => {322			construct_async_run!(|components, cli, cmd, config| {323				Ok(cmd.run(components.client, components.import_queue))324			})325		}326		Some(Subcommand::ExportBlocks(cmd)) => {327			construct_async_run!(|components, cli, cmd, config| {328				Ok(cmd.run(components.client, config.database))329			})330		}331		Some(Subcommand::ExportState(cmd)) => {332			construct_async_run!(|components, cli, cmd, config| {333				Ok(cmd.run(components.client, config.chain_spec))334			})335		}336		Some(Subcommand::ImportBlocks(cmd)) => {337			construct_async_run!(|components, cli, cmd, config| {338				Ok(cmd.run(components.client, components.import_queue))339			})340		}341		Some(Subcommand::PurgeChain(cmd)) => {342			let runner = cli.create_runner(cmd)?;343344			runner.sync_run(|config| {345				let polkadot_cli = RelayChainCli::new(346					&config,347					[RelayChainCli::executable_name()]348						.iter()349						.chain(cli.relaychain_args.iter()),350				);351352				let polkadot_config = SubstrateCli::create_configuration(353					&polkadot_cli,354					&polkadot_cli,355					config.tokio_handle.clone(),356				)357				.map_err(|err| format!("Relay chain argument error: {err}"))?;358359				cmd.run(config, polkadot_config)360			})361		}362		Some(Subcommand::Revert(cmd)) => construct_async_run!(|components, cli, cmd, config| {363			Ok(cmd.run(components.client, components.backend, None))364		}),365		Some(Subcommand::ExportGenesisState(cmd)) => {366			construct_sync_run!(|components, cli, cmd, _config| {367				let spec = cli.load_spec(&cmd.shared_params.chain.clone().unwrap_or_default())?;368				let state_version = Cli::native_runtime_version(&spec).state_version();369				cmd.run::<Block>(&*spec, state_version)370			})371		}372		Some(Subcommand::ExportGenesisWasm(cmd)) => {373			construct_sync_run!(|components, cli, cmd, _config| {374				let spec = cli.load_spec(&cmd.shared_params.chain.clone().unwrap_or_default())?;375				cmd.run(&*spec)376			})377		}378		#[cfg(feature = "runtime-benchmarks")]379		Some(Subcommand::Benchmark(cmd)) => {380			use frame_benchmarking_cli::{BenchmarkCmd, SUBSTRATE_REFERENCE_HARDWARE};381			let runner = cli.create_runner(cmd)?;382			// Switch on the concrete benchmark sub-command-383			match cmd {384				BenchmarkCmd::Pallet(cmd) => {385					runner.sync_run(|config| cmd.run::<Block, DefaultRuntimeExecutor>(config))386				}387				BenchmarkCmd::Block(cmd) => runner.sync_run(|config| {388					let partials = new_partial::<389						default_runtime::RuntimeApi,390						DefaultRuntimeExecutor,391						_,392					>(&config, crate::service::parachain_build_import_queue)?;393					cmd.run(partials.client)394				}),395				BenchmarkCmd::Storage(cmd) => runner.sync_run(|config| {396					let partials = new_partial::<397						default_runtime::RuntimeApi,398						DefaultRuntimeExecutor,399						_,400					>(&config, crate::service::parachain_build_import_queue)?;401					let db = partials.backend.expose_db();402					let storage = partials.backend.expose_storage();403404					cmd.run(config, partials.client.clone(), db, storage)405				}),406				BenchmarkCmd::Machine(cmd) => {407					runner.sync_run(|config| cmd.run(&config, SUBSTRATE_REFERENCE_HARDWARE.clone()))408				}409				BenchmarkCmd::Overhead(_) | BenchmarkCmd::Extrinsic(_) => {410					Err("Unsupported benchmarking command".into())411				}412			}413		}414		#[cfg(feature = "try-runtime")]415		Some(Subcommand::TryRuntime(cmd)) => {416			use std::{future::Future, pin::Pin};417			use sc_executor::{sp_wasm_interface::ExtendedHostFunctions, NativeExecutionDispatch};418			use try_runtime_cli::block_building_info::timestamp_with_aura_info;419420			let runner = cli.create_runner(cmd)?;421422			// grab the task manager.423			let registry = &runner424				.config()425				.prometheus_config426				.as_ref()427				.map(|cfg| &cfg.registry);428			let task_manager =429				sc_service::TaskManager::new(runner.config().tokio_handle.clone(), *registry)430					.map_err(|e| format!("Error: {:?}", e))?;431			let info_provider = Some(timestamp_with_aura_info(12000));432433			runner.async_run(|config| -> Result<(Pin<Box<dyn Future<Output = _>>>, _)> {434				Ok((435					match config.chain_spec.runtime_id() {436						#[cfg(feature = "unique-runtime")]437						RuntimeId::Unique => Box::pin(cmd.run::<Block, ExtendedHostFunctions<438							sp_io::SubstrateHostFunctions,439							<UniqueRuntimeExecutor as NativeExecutionDispatch>::ExtendHostFunctions,440						>, _>(info_provider)),441442						#[cfg(feature = "quartz-runtime")]443						RuntimeId::Quartz => Box::pin(cmd.run::<Block, ExtendedHostFunctions<444							sp_io::SubstrateHostFunctions,445							<QuartzRuntimeExecutor as NativeExecutionDispatch>::ExtendHostFunctions,446						>, _>(info_provider)),447448						RuntimeId::Opal => Box::pin(cmd.run::<Block, ExtendedHostFunctions<449							sp_io::SubstrateHostFunctions,450							<OpalRuntimeExecutor as NativeExecutionDispatch>::ExtendHostFunctions,451						>, _>(info_provider)),452						runtime_id => return Err(no_runtime_err!(runtime_id).into()),453					},454					task_manager,455				))456			})457		}458		#[cfg(not(feature = "try-runtime"))]459		Some(Subcommand::TryRuntime) => {460			Err("Try-runtime must be enabled by `--features try-runtime`.".into())461		}462		None => {463			let runner = cli.create_runner(&cli.run.normalize())?;464			let collator_options = cli.run.collator_options();465466			runner.run_node_until_exit(|config| async move {467				let hwbench = if !cli.no_hardware_benchmarks {468					config.database.path().map(|database_path| {469						let _ = std::fs::create_dir_all(database_path);470						sc_sysinfo::gather_hwbench(Some(database_path))471					})472				} else {473					None474				};475476				let extensions = chain_spec::Extensions::try_get(&*config.chain_spec);477478				let service_id = config.chain_spec.service_id();479				let relay_chain_id = extensions.map(|e| e.relay_chain.clone());480				let is_dev_service = matches![service_id, ServiceId::Dev]481					|| relay_chain_id == Some("dev-service".into());482483				if is_dev_service {484					info!("Running Dev service");485486					let autoseal_interval = Duration::from_millis(cli.idle_autoseal_interval);487488					let mut config = config;489490					config.state_pruning = Some(sc_service::PruningMode::ArchiveAll);491492					return start_node_using_chain_runtime! {493						start_dev_node(config, autoseal_interval).map_err(Into::into)494					};495				};496497				let para_id = extensions498					.map(|e| e.para_id)499					.ok_or("Could not find parachain ID in chain-spec.")?;500501				let polkadot_cli = RelayChainCli::new(502					&config,503					[RelayChainCli::executable_name()]504						.iter()505						.chain(cli.relaychain_args.iter()),506				);507508				let para_id = ParaId::from(para_id);509510				let parachain_account =511					AccountIdConversion::<polkadot_primitives::AccountId>::into_account_truncating(512						&para_id,513					);514515				let state_version = Cli::native_runtime_version(&config.chain_spec).state_version();516				let block: Block = generate_genesis_block(&*config.chain_spec, state_version)517					.map_err(|e| format!("{e:?}"))?;518				let genesis_state = format!("0x{:?}", HexDisplay::from(&block.header().encode()));519				let genesis_hash = format!("0x{:?}", HexDisplay::from(&block.header().hash().0));520521				let polkadot_config = SubstrateCli::create_configuration(522					&polkadot_cli,523					&polkadot_cli,524					config.tokio_handle.clone(),525				)526				.map_err(|err| format!("Relay chain argument error: {err}"))?;527528				info!("Parachain id: {:?}", para_id);529				info!("Parachain Account: {}", parachain_account);530				info!("Parachain genesis state: {}", genesis_state);531				info!("Parachain genesis hash: {}", genesis_hash);532				debug!("Parachain genesis block: {:?}", block);533				info!(534					"Is collating: {}",535					if config.role.is_authority() {536						"yes"537					} else {538						"no"539					}540				);541542				start_node_using_chain_runtime! {543					start_node(config, polkadot_config, collator_options, para_id, hwbench)544						.await545						.map(|r| r.0)546						.map_err(Into::into)547				}548			})549		}550	}551}552553impl DefaultConfigurationValues for RelayChainCli {554	fn p2p_listen_port() -> u16 {555		30334556	}557558	fn rpc_ws_listen_port() -> u16 {559		9945560	}561562	fn rpc_http_listen_port() -> u16 {563		9934564	}565566	fn prometheus_listen_port() -> u16 {567		9616568	}569}570571impl CliConfiguration<Self> for RelayChainCli {572	fn shared_params(&self) -> &SharedParams {573		self.base.base.shared_params()574	}575576	fn import_params(&self) -> Option<&ImportParams> {577		self.base.base.import_params()578	}579580	fn network_params(&self) -> Option<&NetworkParams> {581		self.base.base.network_params()582	}583584	fn keystore_params(&self) -> Option<&KeystoreParams> {585		self.base.base.keystore_params()586	}587588	fn base_path(&self) -> Result<Option<BasePath>> {589		Ok(self590			.shared_params()591			.base_path()?592			.or_else(|| self.base_path.clone().map(Into::into)))593	}594595	fn rpc_http(&self, default_listen_port: u16) -> Result<Option<SocketAddr>> {596		self.base.base.rpc_http(default_listen_port)597	}598599	fn rpc_ipc(&self) -> Result<Option<String>> {600		self.base.base.rpc_ipc()601	}602603	fn rpc_ws(&self, default_listen_port: u16) -> Result<Option<SocketAddr>> {604		self.base.base.rpc_ws(default_listen_port)605	}606607	fn prometheus_config(608		&self,609		default_listen_port: u16,610		chain_spec: &Box<dyn ChainSpec>,611	) -> Result<Option<PrometheusConfig>> {612		self.base613			.base614			.prometheus_config(default_listen_port, chain_spec)615	}616617	fn init<F>(618		&self,619		_support_url: &String,620		_impl_version: &String,621		_logger_hook: F,622		_config: &sc_service::Configuration,623	) -> Result<()> {624		unreachable!("PolkadotCli is never initialized; qed");625	}626627	fn chain_id(&self, is_dev: bool) -> Result<String> {628		let chain_id = self.base.base.chain_id(is_dev)?;629630		Ok(if chain_id.is_empty() {631			self.chain_id.clone().unwrap_or_default()632		} else {633			chain_id634		})635	}636637	fn role(&self, is_dev: bool) -> Result<sc_service::Role> {638		self.base.base.role(is_dev)639	}640641	fn transaction_pool(&self, is_dev: bool) -> Result<sc_service::config::TransactionPoolOptions> {642		self.base.base.transaction_pool(is_dev)643	}644645	fn rpc_methods(&self) -> Result<sc_service::config::RpcMethods> {646		self.base.base.rpc_methods()647	}648649	fn rpc_ws_max_connections(&self) -> Result<Option<usize>> {650		self.base.base.rpc_ws_max_connections()651	}652653	fn rpc_cors(&self, is_dev: bool) -> Result<Option<Vec<String>>> {654		self.base.base.rpc_cors(is_dev)655	}656657	fn default_heap_pages(&self) -> Result<Option<u64>> {658		self.base.base.default_heap_pages()659	}660661	fn force_authoring(&self) -> Result<bool> {662		self.base.base.force_authoring()663	}664665	fn disable_grandpa(&self) -> Result<bool> {666		self.base.base.disable_grandpa()667	}668669	fn max_runtime_instances(&self) -> Result<Option<usize>> {670		self.base.base.max_runtime_instances()671	}672673	fn announce_block(&self) -> Result<bool> {674		self.base.base.announce_block()675	}676677	fn telemetry_endpoints(678		&self,679		chain_spec: &Box<dyn ChainSpec>,680	) -> Result<Option<sc_telemetry::TelemetryEndpoints>> {681		self.base.base.telemetry_endpoints(chain_spec)682	}683}