git.delta.rocks / unique-network / refs/commits / 1be4d6be040e

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_service::genesis::generate_genesis_block;52use std::{future::Future, pin::Pin};53use log::info;54use polkadot_parachain::primitives::AccountIdConversion;55use sc_cli::{56	ChainSpec, CliConfiguration, DefaultConfigurationValues, ImportParams, KeystoreParams,57	NetworkParams, Result, RuntimeVersion, SharedParams, SubstrateCli,58};59use sc_service::{60	config::{BasePath, PrometheusConfig},61};62use sp_core::hexdisplay::HexDisplay;63use sp_runtime::traits::Block as BlockT;64use std::{io::Write, net::SocketAddr, time::Duration};6566use unique_runtime_common::types::Block;6768macro_rules! no_runtime_err {69	($chain_name:expr) => {70		format!(71			"No runtime valid runtime was found for chain {}",72			$chain_name73		)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			let chain_spec = Box::new(chain_spec::OpalChainSpec::from_json_file(path.clone())?)84				as Box<dyn sc_service::ChainSpec>;8586			match chain_spec.runtime_id() {87				#[cfg(feature = "unique-runtime")]88				RuntimeId::Unique => Box::new(chain_spec::UniqueChainSpec::from_json_file(path)?),8990				#[cfg(feature = "quartz-runtime")]91				RuntimeId::Quartz => Box::new(chain_spec::QuartzChainSpec::from_json_file(path)?),9293				RuntimeId::Opal => chain_spec,94				RuntimeId::Unknown(chain) => return Err(no_runtime_err!(chain)),95			}96		}97	})98}99100impl SubstrateCli for Cli {101	// TODO use args102	fn impl_name() -> String {103		format!("{} Node", Self::node_name())104	}105106	fn impl_version() -> String {107		env!("SUBSTRATE_CLI_IMPL_VERSION").into()108	}109	// TODO use args110	fn description() -> String {111		format!(112			"{} Node\n\nThe command-line arguments provided first will be \113		passed to the parachain node, while the arguments provided after -- will be passed \114		to the relaychain node.\n\n\115		{} [parachain-args] -- [relaychain-args]",116			Self::node_name(),117			Self::executable_name()118		)119	}120121	fn author() -> String {122		env!("CARGO_PKG_AUTHORS").into()123	}124125	//TODO use args126	fn support_url() -> String {127		"support@unique.network".into()128	}129130	fn copyright_start_year() -> i32 {131		2019132	}133134	fn load_spec(&self, id: &str) -> std::result::Result<Box<dyn sc_service::ChainSpec>, String> {135		load_spec(id)136	}137138	fn native_runtime_version(chain_spec: &Box<dyn ChainSpec>) -> &'static RuntimeVersion {139		match chain_spec.runtime_id() {140			#[cfg(feature = "unique-runtime")]141			RuntimeId::Unique => &unique_runtime::VERSION,142143			#[cfg(feature = "quartz-runtime")]144			RuntimeId::Quartz => &quartz_runtime::VERSION,145146			RuntimeId::Opal => &opal_runtime::VERSION,147			RuntimeId::Unknown(chain) => panic!("{}", no_runtime_err!(chain)),148		}149	}150}151152impl SubstrateCli for RelayChainCli {153	// TODO use args154	fn impl_name() -> String {155		format!("{} Node", Cli::node_name())156	}157158	fn impl_version() -> String {159		env!("SUBSTRATE_CLI_IMPL_VERSION").into()160	}161	// TODO use args162	fn description() -> String {163		format!(164			"{} Node\n\nThe command-line arguments provided first will be \165			passed to the parachain node, while the arguments provided after -- will be passed \166			to the relaychain node.\n\n\167			parachain-collator [parachain-args] -- [relaychain-args]",168			Cli::node_name()169		)170	}171172	fn author() -> String {173		env!("CARGO_PKG_AUTHORS").into()174	}175	// TODO use args176	fn support_url() -> String {177		"support@unique.network".into()178	}179180	fn copyright_start_year() -> i32 {181		2019182	}183184	fn load_spec(&self, id: &str) -> std::result::Result<Box<dyn sc_service::ChainSpec>, String> {185		polkadot_cli::Cli::from_iter([RelayChainCli::executable_name()].iter()).load_spec(id)186	}187188	fn native_runtime_version(chain_spec: &Box<dyn ChainSpec>) -> &'static RuntimeVersion {189		polkadot_cli::Cli::native_runtime_version(chain_spec)190	}191}192193#[allow(clippy::borrowed_box)]194fn extract_genesis_wasm(chain_spec: &Box<dyn sc_service::ChainSpec>) -> Result<Vec<u8>> {195	let mut storage = chain_spec.build_storage()?;196197	storage198		.top199		.remove(sp_core::storage::well_known_keys::CODE)200		.ok_or_else(|| "Could not find wasm file in genesis state!".into())201}202203macro_rules! async_run_with_runtime {204	(205		$runtime_api:path, $executor:path,206		$runner:ident, $components:ident, $cli:ident, $cmd:ident, $config:ident,207		$( $code:tt )*208	) => {209		$runner.async_run(|$config| {210			let $components = new_partial::<211				$runtime_api, $executor, _212			>(213				&$config,214				crate::service::parachain_build_import_queue,215			)?;216			let task_manager = $components.task_manager;217218			{ $( $code )* }.map(|v| (v, task_manager))219		})220	};221}222223macro_rules! construct_async_run {224	(|$components:ident, $cli:ident, $cmd:ident, $config:ident| $( $code:tt )* ) => {{225		let runner = $cli.create_runner($cmd)?;226227		match runner.config().chain_spec.runtime_id() {228			#[cfg(feature = "unique-runtime")]229			RuntimeId::Unique => async_run_with_runtime!(230				unique_runtime::RuntimeApi, UniqueRuntimeExecutor,231				runner, $components, $cli, $cmd, $config, $( $code )*232			),233234			#[cfg(feature = "quartz-runtime")]235			RuntimeId::Quartz => async_run_with_runtime!(236				quartz_runtime::RuntimeApi, QuartzRuntimeExecutor,237				runner, $components, $cli, $cmd, $config, $( $code )*238			),239240			RuntimeId::Opal => async_run_with_runtime!(241				opal_runtime::RuntimeApi, OpalRuntimeExecutor,242				runner, $components, $cli, $cmd, $config, $( $code )*243			),244245			RuntimeId::Unknown(chain) => Err(no_runtime_err!(chain).into())246		}247	}}248}249250macro_rules! start_node_using_chain_runtime {251	($start_node_fn:ident($config:expr $(, $($args:expr),+)?) $($code:tt)*) => {252		match $config.chain_spec.runtime_id() {253			#[cfg(feature = "unique-runtime")]254			RuntimeId::Unique => $start_node_fn::<255				unique_runtime::Runtime,256				unique_runtime::RuntimeApi,257				UniqueRuntimeExecutor,258			>($config $(, $($args),+)?) $($code)*,259260			#[cfg(feature = "quartz-runtime")]261			RuntimeId::Quartz => $start_node_fn::<262				quartz_runtime::Runtime,263				quartz_runtime::RuntimeApi,264				QuartzRuntimeExecutor,265			>($config $(, $($args),+)?) $($code)*,266267			RuntimeId::Opal => $start_node_fn::<268				opal_runtime::Runtime,269				opal_runtime::RuntimeApi,270				OpalRuntimeExecutor,271			>($config $(, $($args),+)?) $($code)*,272273			RuntimeId::Unknown(chain) => Err(no_runtime_err!(chain).into()),274		}275	};276}277278/// Parse command line arguments into service configuration.279pub fn run() -> Result<()> {280	let cli = Cli::from_args();281282	match &cli.subcommand {283		Some(Subcommand::BuildSpec(cmd)) => {284			let runner = cli.create_runner(cmd)?;285			runner.sync_run(|config| cmd.run(config.chain_spec, config.network))286		}287		Some(Subcommand::CheckBlock(cmd)) => {288			construct_async_run!(|components, cli, cmd, config| {289				Ok(cmd.run(components.client, components.import_queue))290			})291		}292		Some(Subcommand::ExportBlocks(cmd)) => {293			construct_async_run!(|components, cli, cmd, config| {294				Ok(cmd.run(components.client, config.database))295			})296		}297		Some(Subcommand::ExportState(cmd)) => {298			construct_async_run!(|components, cli, cmd, config| {299				Ok(cmd.run(components.client, config.chain_spec))300			})301		}302		Some(Subcommand::ImportBlocks(cmd)) => {303			construct_async_run!(|components, cli, cmd, config| {304				Ok(cmd.run(components.client, components.import_queue))305			})306		}307		Some(Subcommand::PurgeChain(cmd)) => {308			let runner = cli.create_runner(cmd)?;309310			runner.sync_run(|config| {311				let polkadot_cli = RelayChainCli::new(312					&config,313					[RelayChainCli::executable_name()]314						.iter()315						.chain(cli.relaychain_args.iter()),316				);317318				let polkadot_config = SubstrateCli::create_configuration(319					&polkadot_cli,320					&polkadot_cli,321					config.tokio_handle.clone(),322				)323				.map_err(|err| format!("Relay chain argument error: {}", err))?;324325				cmd.run(config, polkadot_config)326			})327		}328		Some(Subcommand::Revert(cmd)) => construct_async_run!(|components, cli, cmd, config| {329			Ok(cmd.run(components.client, components.backend, None))330		}),331		Some(Subcommand::ExportGenesisState(params)) => {332			let mut builder = sc_cli::LoggerBuilder::new("");333			builder.with_profiling(sc_tracing::TracingReceiver::Log, "");334			let _ = builder.init();335336			let spec = load_spec(&params.chain.clone().unwrap_or_default())?;337			let state_version = Cli::native_runtime_version(&spec).state_version();338			let block: Block = generate_genesis_block(&spec, state_version)?;339			let raw_header = block.header().encode();340			let output_buf = if params.raw {341				raw_header342			} else {343				format!("0x{:?}", HexDisplay::from(&block.header().encode())).into_bytes()344			};345346			if let Some(output) = &params.output {347				std::fs::write(output, output_buf)?;348			} else {349				std::io::stdout().write_all(&output_buf)?;350			}351352			Ok(())353		}354		Some(Subcommand::ExportGenesisWasm(params)) => {355			let mut builder = sc_cli::LoggerBuilder::new("");356			builder.with_profiling(sc_tracing::TracingReceiver::Log, "");357			let _ = builder.init();358359			let raw_wasm_blob =360				extract_genesis_wasm(&cli.load_spec(&params.chain.clone().unwrap_or_default())?)?;361			let output_buf = if params.raw {362				raw_wasm_blob363			} else {364				format!("0x{:?}", HexDisplay::from(&raw_wasm_blob)).into_bytes()365			};366367			if let Some(output) = &params.output {368				std::fs::write(output, output_buf)?;369			} else {370				std::io::stdout().write_all(&output_buf)?;371			}372373			Ok(())374		}375		#[cfg(feature = "unique-runtime")]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					if cfg!(feature = "runtime-benchmarks") {383						runner.sync_run(|config| cmd.run::<Block, UniqueRuntimeExecutor>(config))384					} else {385						Err("Benchmarking wasn't enabled when building the node. \386					You can enable it with `--features runtime-benchmarks`."387							.into())388					}389				}390				BenchmarkCmd::Block(cmd) => runner.sync_run(|config| {391					let partials = new_partial::<392						unique_runtime::RuntimeApi,393						UniqueRuntimeExecutor,394						_,395					>(&config, crate::service::parachain_build_import_queue)?;396					cmd.run(partials.client)397				}),398				BenchmarkCmd::Storage(cmd) => runner.sync_run(|config| {399					let partials = new_partial::<400						unique_runtime::RuntimeApi,401						UniqueRuntimeExecutor,402						_,403					>(&config, crate::service::parachain_build_import_queue)?;404					let db = partials.backend.expose_db();405					let storage = partials.backend.expose_storage();406407					cmd.run(config, partials.client.clone(), db, storage)408				}),409				BenchmarkCmd::Machine(cmd) => {410					runner.sync_run(|config| cmd.run(&config, SUBSTRATE_REFERENCE_HARDWARE.clone()))411				}412				BenchmarkCmd::Overhead(_) => Err("Unsupported benchmarking command".into()),413			}414		}415		#[cfg(not(feature = "unique-runtime"))]416		Some(Subcommand::Benchmark(..)) => {417			Err("benchmarking is only available with unique runtime enabled".into())418		}419		Some(Subcommand::TryRuntime(cmd)) => {420			if cfg!(feature = "try-runtime") {421				let runner = cli.create_runner(cmd)?;422423				// grab the task manager.424				let registry = &runner425					.config()426					.prometheus_config427					.as_ref()428					.map(|cfg| &cfg.registry);429				let task_manager =430					sc_service::TaskManager::new(runner.config().tokio_handle.clone(), *registry)431						.map_err(|e| format!("Error: {:?}", e))?;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, UniqueRuntimeExecutor>(config)),438439							#[cfg(feature = "quartz-runtime")]440							RuntimeId::Quartz => Box::pin(cmd.run::<Block, QuartzRuntimeExecutor>(config)),441442							RuntimeId::Opal => {443								Box::pin(cmd.run::<Block, OpalRuntimeExecutor>(config))444							}445							RuntimeId::Unknown(chain) => return Err(no_runtime_err!(chain).into()),446						},447						task_manager,448					))449				})450			} else {451				Err("Try-runtime must be enabled by `--features try-runtime`.".into())452			}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 autoseal_interval = Duration::from_millis(cli.idle_autoseal_interval);479480					return start_node_using_chain_runtime! {481						start_dev_node(config, autoseal_interval).map_err(Into::into)482					};483				};484485				let para_id = extensions486					.map(|e| e.para_id)487					.ok_or("Could not find parachain ID in chain-spec.")?;488489				let polkadot_cli = RelayChainCli::new(490					&config,491					[RelayChainCli::executable_name()]492						.iter()493						.chain(cli.relaychain_args.iter()),494				);495496				let para_id = ParaId::from(para_id);497498				let parachain_account =499					AccountIdConversion::<polkadot_primitives::v2::AccountId>::into_account(500						&para_id,501					);502503				let state_version =504					RelayChainCli::native_runtime_version(&config.chain_spec).state_version();505				let block: Block = generate_genesis_block(&config.chain_spec, state_version)506					.map_err(|e| format!("{:?}", e))?;507				let genesis_state = format!("0x{:?}", HexDisplay::from(&block.header().encode()));508				let genesis_hash = format!("0x{:?}", HexDisplay::from(&block.header().hash().0));509510				let polkadot_config = SubstrateCli::create_configuration(511					&polkadot_cli,512					&polkadot_cli,513					config.tokio_handle.clone(),514				)515				.map_err(|err| format!("Relay chain argument error: {}", err))?;516517				info!("Parachain id: {:?}", para_id);518				info!("Parachain Account: {}", parachain_account);519				info!("Parachain genesis state: {}", genesis_state);520				info!("Parachain genesis hash: {}", genesis_hash);521				info!(522					"Is collating: {}",523					if config.role.is_authority() {524						"yes"525					} else {526						"no"527					}528				);529530				start_node_using_chain_runtime! {531					start_node(config, polkadot_config, collator_options, para_id, hwbench)532						.await533						.map(|r| r.0)534						.map_err(Into::into)535				}536			})537		}538	}539}540541impl DefaultConfigurationValues for RelayChainCli {542	fn p2p_listen_port() -> u16 {543		30334544	}545546	fn rpc_ws_listen_port() -> u16 {547		9945548	}549550	fn rpc_http_listen_port() -> u16 {551		9934552	}553554	fn prometheus_listen_port() -> u16 {555		9616556	}557}558559impl CliConfiguration<Self> for RelayChainCli {560	fn shared_params(&self) -> &SharedParams {561		self.base.base.shared_params()562	}563564	fn import_params(&self) -> Option<&ImportParams> {565		self.base.base.import_params()566	}567568	fn network_params(&self) -> Option<&NetworkParams> {569		self.base.base.network_params()570	}571572	fn keystore_params(&self) -> Option<&KeystoreParams> {573		self.base.base.keystore_params()574	}575576	fn base_path(&self) -> Result<Option<BasePath>> {577		Ok(self578			.shared_params()579			.base_path()580			.or_else(|| self.base_path.clone().map(Into::into)))581	}582583	fn rpc_http(&self, default_listen_port: u16) -> Result<Option<SocketAddr>> {584		self.base.base.rpc_http(default_listen_port)585	}586587	fn rpc_ipc(&self) -> Result<Option<String>> {588		self.base.base.rpc_ipc()589	}590591	fn rpc_ws(&self, default_listen_port: u16) -> Result<Option<SocketAddr>> {592		self.base.base.rpc_ws(default_listen_port)593	}594595	fn prometheus_config(596		&self,597		default_listen_port: u16,598		chain_spec: &Box<dyn ChainSpec>,599	) -> Result<Option<PrometheusConfig>> {600		self.base601			.base602			.prometheus_config(default_listen_port, chain_spec)603	}604605	fn init<F>(606		&self,607		_support_url: &String,608		_impl_version: &String,609		_logger_hook: F,610		_config: &sc_service::Configuration,611	) -> Result<()> {612		unreachable!("PolkadotCli is never initialized; qed");613	}614615	fn chain_id(&self, is_dev: bool) -> Result<String> {616		let chain_id = self.base.base.chain_id(is_dev)?;617618		Ok(if chain_id.is_empty() {619			self.chain_id.clone().unwrap_or_default()620		} else {621			chain_id622		})623	}624625	fn role(&self, is_dev: bool) -> Result<sc_service::Role> {626		self.base.base.role(is_dev)627	}628629	fn transaction_pool(&self) -> Result<sc_service::config::TransactionPoolOptions> {630		self.base.base.transaction_pool()631	}632633	fn state_cache_child_ratio(&self) -> Result<Option<usize>> {634		self.base.base.state_cache_child_ratio()635	}636637	fn rpc_methods(&self) -> Result<sc_service::config::RpcMethods> {638		self.base.base.rpc_methods()639	}640641	fn rpc_ws_max_connections(&self) -> Result<Option<usize>> {642		self.base.base.rpc_ws_max_connections()643	}644645	fn rpc_cors(&self, is_dev: bool) -> Result<Option<Vec<String>>> {646		self.base.base.rpc_cors(is_dev)647	}648649	fn default_heap_pages(&self) -> Result<Option<u64>> {650		self.base.base.default_heap_pages()651	}652653	fn force_authoring(&self) -> Result<bool> {654		self.base.base.force_authoring()655	}656657	fn disable_grandpa(&self) -> Result<bool> {658		self.base.base.disable_grandpa()659	}660661	fn max_runtime_instances(&self) -> Result<Option<usize>> {662		self.base.base.max_runtime_instances()663	}664665	fn announce_block(&self) -> Result<bool> {666		self.base.base.announce_block()667	}668669	fn telemetry_endpoints(670		&self,671		chain_spec: &Box<dyn ChainSpec>,672	) -> Result<Option<sc_telemetry::TelemetryEndpoints>> {673		self.base.base.telemetry_endpoints(chain_spec)674	}675}