git.delta.rocks / unique-network / refs/commits / b3ce401d8166

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, RuntimeId, RuntimeIdentification, ServiceId, ServiceIdentification},37	cli::{Cli, RelayChainCli, Subcommand},38	service::{new_partial, start_node, start_dev_node},39};4041#[cfg(feature = "unique-runtime")]42use crate::service::UniqueRuntimeExecutor;4344#[cfg(feature = "quartz-runtime")]45use crate::service::QuartzRuntimeExecutor;4647use crate::service::OpalRuntimeExecutor;4849use codec::Encode;50use cumulus_primitives_core::ParaId;51use cumulus_client_cli::generate_genesis_block;52use std::{future::Future, pin::Pin};53use log::info;54use sc_cli::{55	ChainSpec, CliConfiguration, DefaultConfigurationValues, ImportParams, KeystoreParams,56	NetworkParams, Result, RuntimeVersion, SharedParams, SubstrateCli,57};58use sc_service::{59	config::{BasePath, PrometheusConfig},60};61use sp_core::hexdisplay::HexDisplay;62use sp_runtime::traits::{AccountIdConversion, Block as BlockT};63use std::{net::SocketAddr, time::Duration};6465use up_common::types::opaque::Block;6667macro_rules! no_runtime_err {68	($chain_name:expr) => {69		format!(70			"No runtime valid runtime was found for chain {}",71			$chain_name72		)73	};74}7576fn load_spec(id: &str) -> std::result::Result<Box<dyn sc_service::ChainSpec>, String> {77	Ok(match id {78		"dev" => Box::new(chain_spec::development_config()),79		"" | "local" => Box::new(chain_spec::local_testnet_config()),80		path => {81			let path = std::path::PathBuf::from(path);82			let chain_spec = Box::new(chain_spec::OpalChainSpec::from_json_file(path.clone())?)83				as Box<dyn sc_service::ChainSpec>;8485			match chain_spec.runtime_id() {86				#[cfg(feature = "unique-runtime")]87				RuntimeId::Unique => Box::new(chain_spec::UniqueChainSpec::from_json_file(path)?),8889				#[cfg(feature = "quartz-runtime")]90				RuntimeId::Quartz => Box::new(chain_spec::QuartzChainSpec::from_json_file(path)?),9192				RuntimeId::Opal => chain_spec,93				RuntimeId::Unknown(chain) => return Err(no_runtime_err!(chain)),94			}95		}96	})97}9899impl SubstrateCli for Cli {100	// TODO use args101	fn impl_name() -> String {102		format!("{} Node", Self::node_name())103	}104105	fn impl_version() -> String {106		env!("SUBSTRATE_CLI_IMPL_VERSION").into()107	}108	// TODO use args109	fn description() -> String {110		format!(111			"{} Node\n\nThe command-line arguments provided first will be \112		passed to the parachain node, while the arguments provided after -- will be passed \113		to the relaychain node.\n\n\114		{} [parachain-args] -- [relaychain-args]",115			Self::node_name(),116			Self::executable_name()117		)118	}119120	fn author() -> String {121		env!("CARGO_PKG_AUTHORS").into()122	}123124	//TODO use args125	fn support_url() -> String {126		"support@unique.network".into()127	}128129	fn copyright_start_year() -> i32 {130		2019131	}132133	fn load_spec(&self, id: &str) -> std::result::Result<Box<dyn sc_service::ChainSpec>, String> {134		load_spec(id)135	}136137	fn native_runtime_version(chain_spec: &Box<dyn ChainSpec>) -> &'static RuntimeVersion {138		match chain_spec.runtime_id() {139			#[cfg(feature = "unique-runtime")]140			RuntimeId::Unique => &unique_runtime::VERSION,141142			#[cfg(feature = "quartz-runtime")]143			RuntimeId::Quartz => &quartz_runtime::VERSION,144145			RuntimeId::Opal => &opal_runtime::VERSION,146			RuntimeId::Unknown(chain) => panic!("{}", no_runtime_err!(chain)),147		}148	}149}150151impl SubstrateCli for RelayChainCli {152	// TODO use args153	fn impl_name() -> String {154		format!("{} Node", Cli::node_name())155	}156157	fn impl_version() -> String {158		env!("SUBSTRATE_CLI_IMPL_VERSION").into()159	}160	// TODO use args161	fn description() -> String {162		format!(163			"{} Node\n\nThe command-line arguments provided first will be \164			passed to the parachain node, while the arguments provided after -- will be passed \165			to the relaychain node.\n\n\166			parachain-collator [parachain-args] -- [relaychain-args]",167			Cli::node_name()168		)169	}170171	fn author() -> String {172		env!("CARGO_PKG_AUTHORS").into()173	}174	// TODO use args175	fn support_url() -> String {176		"support@unique.network".into()177	}178179	fn copyright_start_year() -> i32 {180		2019181	}182183	fn load_spec(&self, id: &str) -> std::result::Result<Box<dyn sc_service::ChainSpec>, String> {184		polkadot_cli::Cli::from_iter([RelayChainCli::executable_name()].iter()).load_spec(id)185	}186187	fn native_runtime_version(chain_spec: &Box<dyn ChainSpec>) -> &'static RuntimeVersion {188		polkadot_cli::Cli::native_runtime_version(chain_spec)189	}190}191192macro_rules! async_run_with_runtime {193	(194		$runtime_api:path, $executor:path,195		$runner:ident, $components:ident, $cli:ident, $cmd:ident, $config:ident,196		$( $code:tt )*197	) => {198		$runner.async_run(|$config| {199			let $components = new_partial::<200				$runtime_api, $executor, _201			>(202				&$config,203				crate::service::parachain_build_import_queue,204			)?;205			let task_manager = $components.task_manager;206207			{ $( $code )* }.map(|v| (v, task_manager))208		})209	};210}211212macro_rules! construct_async_run {213	(|$components:ident, $cli:ident, $cmd:ident, $config:ident| $( $code:tt )* ) => {{214		let runner = $cli.create_runner($cmd)?;215216		match runner.config().chain_spec.runtime_id() {217			#[cfg(feature = "unique-runtime")]218			RuntimeId::Unique => async_run_with_runtime!(219				unique_runtime::RuntimeApi, UniqueRuntimeExecutor,220				runner, $components, $cli, $cmd, $config, $( $code )*221			),222223			#[cfg(feature = "quartz-runtime")]224			RuntimeId::Quartz => async_run_with_runtime!(225				quartz_runtime::RuntimeApi, QuartzRuntimeExecutor,226				runner, $components, $cli, $cmd, $config, $( $code )*227			),228229			RuntimeId::Opal => async_run_with_runtime!(230				opal_runtime::RuntimeApi, OpalRuntimeExecutor,231				runner, $components, $cli, $cmd, $config, $( $code )*232			),233234			RuntimeId::Unknown(chain) => Err(no_runtime_err!(chain).into())235		}236	}}237}238239macro_rules! sync_run_with_runtime {240	(241		$runtime_api:path, $executor:path,242		$runner:ident, $components:ident, $cli:ident, $cmd:ident, $config:ident,243		$( $code:tt )*244	) => {245		$runner.sync_run(|$config| {246			$( $code )*247		})248	};249}250251macro_rules! construct_sync_run {252	(|$components:ident, $cli:ident, $cmd:ident, $config:ident| $( $code:tt )* ) => {{253		let runner = $cli.create_runner($cmd)?;254255		match runner.config().chain_spec.runtime_id() {256			#[cfg(feature = "unique-runtime")]257			RuntimeId::Unique => sync_run_with_runtime!(258				unique_runtime::RuntimeApi, UniqueRuntimeExecutor,259				runner, $components, $cli, $cmd, $config, $( $code )*260			),261262			#[cfg(feature = "quartz-runtime")]263			RuntimeId::Quartz => sync_run_with_runtime!(264				quartz_runtime::RuntimeApi, QuartzRuntimeExecutor,265				runner, $components, $cli, $cmd, $config, $( $code )*266			),267268			RuntimeId::Opal => sync_run_with_runtime!(269				opal_runtime::RuntimeApi, OpalRuntimeExecutor,270				runner, $components, $cli, $cmd, $config, $( $code )*271			),272273			RuntimeId::Unknown(chain) => Err(no_runtime_err!(chain).into())274		}275	}}276}277278macro_rules! start_node_using_chain_runtime {279	($start_node_fn:ident($config:expr $(, $($args:expr),+)?) $($code:tt)*) => {280		match $config.chain_spec.runtime_id() {281			#[cfg(feature = "unique-runtime")]282			RuntimeId::Unique => $start_node_fn::<283				unique_runtime::Runtime,284				unique_runtime::RuntimeApi,285				UniqueRuntimeExecutor,286			>($config $(, $($args),+)?) $($code)*,287288			#[cfg(feature = "quartz-runtime")]289			RuntimeId::Quartz => $start_node_fn::<290				quartz_runtime::Runtime,291				quartz_runtime::RuntimeApi,292				QuartzRuntimeExecutor,293			>($config $(, $($args),+)?) $($code)*,294295			RuntimeId::Opal => $start_node_fn::<296				opal_runtime::Runtime,297				opal_runtime::RuntimeApi,298				OpalRuntimeExecutor,299			>($config $(, $($args),+)?) $($code)*,300301			RuntimeId::Unknown(chain) => Err(no_runtime_err!(chain).into()),302		}303	};304}305306/// Parse command line arguments into service configuration.307pub fn run() -> Result<()> {308	let cli = Cli::from_args();309310	match &cli.subcommand {311		Some(Subcommand::BuildSpec(cmd)) => {312			let runner = cli.create_runner(cmd)?;313			runner.sync_run(|config| cmd.run(config.chain_spec, config.network))314		}315		Some(Subcommand::CheckBlock(cmd)) => {316			construct_async_run!(|components, cli, cmd, config| {317				Ok(cmd.run(components.client, components.import_queue))318			})319		}320		Some(Subcommand::ExportBlocks(cmd)) => {321			construct_async_run!(|components, cli, cmd, config| {322				Ok(cmd.run(components.client, config.database))323			})324		}325		Some(Subcommand::ExportState(cmd)) => {326			construct_async_run!(|components, cli, cmd, config| {327				Ok(cmd.run(components.client, config.chain_spec))328			})329		}330		Some(Subcommand::ImportBlocks(cmd)) => {331			construct_async_run!(|components, cli, cmd, config| {332				Ok(cmd.run(components.client, components.import_queue))333			})334		}335		Some(Subcommand::PurgeChain(cmd)) => {336			let runner = cli.create_runner(cmd)?;337338			runner.sync_run(|config| {339				let polkadot_cli = RelayChainCli::new(340					&config,341					[RelayChainCli::executable_name()]342						.iter()343						.chain(cli.relaychain_args.iter()),344				);345346				let polkadot_config = SubstrateCli::create_configuration(347					&polkadot_cli,348					&polkadot_cli,349					config.tokio_handle.clone(),350				)351				.map_err(|err| format!("Relay chain argument error: {}", err))?;352353				cmd.run(config, polkadot_config)354			})355		}356		Some(Subcommand::Revert(cmd)) => construct_async_run!(|components, cli, cmd, config| {357			Ok(cmd.run(components.client, components.backend, None))358		}),359		Some(Subcommand::ExportGenesisState(cmd)) => {360			construct_sync_run!(|components, cli, cmd, _config| {361				let spec = cli.load_spec(&cmd.shared_params.chain.clone().unwrap_or_default())?;362				let state_version = Cli::native_runtime_version(&spec).state_version();363				cmd.run::<Block>(&*spec, state_version)364			})365		}366		Some(Subcommand::ExportGenesisWasm(cmd)) => {367			construct_sync_run!(|components, cli, cmd, _config| {368				let spec = cli.load_spec(&cmd.shared_params.chain.clone().unwrap_or_default())?;369				cmd.run(&*spec)370			})371		}372		#[cfg(feature = "runtime-benchmarks")]373		Some(Subcommand::Benchmark(cmd)) => {374			use frame_benchmarking_cli::{BenchmarkCmd, SUBSTRATE_REFERENCE_HARDWARE};375			let runner = cli.create_runner(cmd)?;376			// Switch on the concrete benchmark sub-command-377			match cmd {378				BenchmarkCmd::Pallet(cmd) => {379					runner.sync_run(|config| cmd.run::<Block, DefaultRuntimeExecutor>(config))380				}381				BenchmarkCmd::Block(cmd) => runner.sync_run(|config| {382					let partials = new_partial::<383						default_runtime::RuntimeApi,384						DefaultRuntimeExecutor,385						_,386					>(&config, crate::service::parachain_build_import_queue)?;387					cmd.run(partials.client)388				}),389				BenchmarkCmd::Storage(cmd) => runner.sync_run(|config| {390					let partials = new_partial::<391						default_runtime::RuntimeApi,392						DefaultRuntimeExecutor,393						_,394					>(&config, crate::service::parachain_build_import_queue)?;395					let db = partials.backend.expose_db();396					let storage = partials.backend.expose_storage();397398					cmd.run(config, partials.client.clone(), db, storage)399				}),400				BenchmarkCmd::Machine(cmd) => {401					runner.sync_run(|config| cmd.run(&config, SUBSTRATE_REFERENCE_HARDWARE.clone()))402				}403				BenchmarkCmd::Overhead(_) | BenchmarkCmd::Extrinsic(_) => {404					Err("Unsupported benchmarking command".into())405				}406			}407		}408		Some(Subcommand::TryRuntime(cmd)) => {409			if cfg!(feature = "try-runtime") {410				let runner = cli.create_runner(cmd)?;411412				// grab the task manager.413				let registry = &runner414					.config()415					.prometheus_config416					.as_ref()417					.map(|cfg| &cfg.registry);418				let task_manager =419					sc_service::TaskManager::new(runner.config().tokio_handle.clone(), *registry)420						.map_err(|e| format!("Error: {:?}", e))?;421422				runner.async_run(|config| -> Result<(Pin<Box<dyn Future<Output = _>>>, _)> {423					Ok((424						match config.chain_spec.runtime_id() {425							#[cfg(feature = "unique-runtime")]426							RuntimeId::Unique => Box::pin(cmd.run::<Block, UniqueRuntimeExecutor>(config)),427428							#[cfg(feature = "quartz-runtime")]429							RuntimeId::Quartz => Box::pin(cmd.run::<Block, QuartzRuntimeExecutor>(config)),430431							RuntimeId::Opal => {432								Box::pin(cmd.run::<Block, OpalRuntimeExecutor>(config))433							}434							RuntimeId::Unknown(chain) => return Err(no_runtime_err!(chain).into()),435						},436						task_manager,437					))438				})439			} else {440				Err("Try-runtime must be enabled by `--features try-runtime`.".into())441			}442		}443		None => {444			let runner = cli.create_runner(&cli.run.normalize())?;445			let collator_options = cli.run.collator_options();446447			runner.run_node_until_exit(|config| async move {448				let hwbench = if !cli.no_hardware_benchmarks {449					config.database.path().map(|database_path| {450						let _ = std::fs::create_dir_all(&database_path);451						sc_sysinfo::gather_hwbench(Some(database_path))452					})453				} else {454					None455				};456457				let extensions = chain_spec::Extensions::try_get(&*config.chain_spec);458459				let service_id = config.chain_spec.service_id();460				let relay_chain_id = extensions.map(|e| e.relay_chain.clone());461				let is_dev_service = matches![service_id, ServiceId::Dev]462					|| relay_chain_id == Some("dev-service".into());463464				if is_dev_service {465					info!("Running Dev service");466467					let autoseal_interval = Duration::from_millis(cli.idle_autoseal_interval);468469					let mut config = config;470					if config.state_pruning == None {471						config.state_pruning = Some(sc_service::PruningMode::ArchiveAll);472					}473474					return start_node_using_chain_runtime! {475						start_dev_node(config, autoseal_interval).map_err(Into::into)476					};477				};478479				let para_id = extensions480					.map(|e| e.para_id)481					.ok_or("Could not find parachain ID in chain-spec.")?;482483				let polkadot_cli = RelayChainCli::new(484					&config,485					[RelayChainCli::executable_name()]486						.iter()487						.chain(cli.relaychain_args.iter()),488				);489490				let para_id = ParaId::from(para_id);491492				let parachain_account = AccountIdConversion::<polkadot_primitives::v2::AccountId>::into_account_truncating(&para_id);493494				let state_version =495					RelayChainCli::native_runtime_version(&config.chain_spec).state_version();496				let block: Block = generate_genesis_block(&*config.chain_spec, state_version)497					.map_err(|e| format!("{:?}", e))?;498				let genesis_state = format!("0x{:?}", HexDisplay::from(&block.header().encode()));499				let genesis_hash = format!("0x{:?}", HexDisplay::from(&block.header().hash().0));500501				let polkadot_config = SubstrateCli::create_configuration(502					&polkadot_cli,503					&polkadot_cli,504					config.tokio_handle.clone(),505				)506				.map_err(|err| format!("Relay chain argument error: {}", err))?;507508				info!("Parachain id: {:?}", para_id);509				info!("Parachain Account: {}", parachain_account);510				info!("Parachain genesis state: {}", genesis_state);511				info!("Parachain genesis hash: {}", genesis_hash);512				info!(513					"Is collating: {}",514					if config.role.is_authority() {515						"yes"516					} else {517						"no"518					}519				);520521				start_node_using_chain_runtime! {522					start_node(config, polkadot_config, collator_options, para_id, hwbench)523						.await524						.map(|r| r.0)525						.map_err(Into::into)526				}527			})528		}529	}530}531532impl DefaultConfigurationValues for RelayChainCli {533	fn p2p_listen_port() -> u16 {534		30334535	}536537	fn rpc_ws_listen_port() -> u16 {538		9945539	}540541	fn rpc_http_listen_port() -> u16 {542		9934543	}544545	fn prometheus_listen_port() -> u16 {546		9616547	}548}549550impl CliConfiguration<Self> for RelayChainCli {551	fn shared_params(&self) -> &SharedParams {552		self.base.base.shared_params()553	}554555	fn import_params(&self) -> Option<&ImportParams> {556		self.base.base.import_params()557	}558559	fn network_params(&self) -> Option<&NetworkParams> {560		self.base.base.network_params()561	}562563	fn keystore_params(&self) -> Option<&KeystoreParams> {564		self.base.base.keystore_params()565	}566567	fn base_path(&self) -> Result<Option<BasePath>> {568		Ok(self569			.shared_params()570			.base_path()?571			.or_else(|| self.base_path.clone().map(Into::into)))572	}573574	fn rpc_http(&self, default_listen_port: u16) -> Result<Option<SocketAddr>> {575		self.base.base.rpc_http(default_listen_port)576	}577578	fn rpc_ipc(&self) -> Result<Option<String>> {579		self.base.base.rpc_ipc()580	}581582	fn rpc_ws(&self, default_listen_port: u16) -> Result<Option<SocketAddr>> {583		self.base.base.rpc_ws(default_listen_port)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_ws_max_connections(&self) -> Result<Option<usize>> {629		self.base.base.rpc_ws_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}