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

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 log::info;53use polkadot_parachain::primitives::AccountIdConversion;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::Block as BlockT;63use std::{io::Write, net::SocketAddr};6465use unique_runtime_common::types::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_rococo_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		"Unique Node".into()103	}104105	fn impl_version() -> String {106		env!("SUBSTRATE_CLI_IMPL_VERSION").into()107	}108	// TODO use args109	fn description() -> String {110		format!(111			"Unique 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::executable_name()116		)117	}118119	fn author() -> String {120		env!("CARGO_PKG_AUTHORS").into()121	}122123	//TODO use args124	fn support_url() -> String {125		"support@unique.network".into()126	}127128	fn copyright_start_year() -> i32 {129		2019130	}131132	fn load_spec(&self, id: &str) -> std::result::Result<Box<dyn sc_service::ChainSpec>, String> {133		load_spec(id)134	}135136	fn native_runtime_version(chain_spec: &Box<dyn ChainSpec>) -> &'static RuntimeVersion {137		match chain_spec.runtime_id() {138			#[cfg(feature = "unique-runtime")]139			RuntimeId::Unique => &unique_runtime::VERSION,140141			#[cfg(feature = "quartz-runtime")]142			RuntimeId::Quartz => &quartz_runtime::VERSION,143144			RuntimeId::Opal => &opal_runtime::VERSION,145			RuntimeId::Unknown(chain) => panic!("{}", no_runtime_err!(chain)),146		}147	}148}149150impl SubstrateCli for RelayChainCli {151	// TODO use args152	fn impl_name() -> String {153		"Unique Node".into()154	}155156	fn impl_version() -> String {157		env!("SUBSTRATE_CLI_IMPL_VERSION").into()158	}159	// TODO use args160	fn description() -> String {161		"Unique Node\n\nThe command-line arguments provided first will be \162		passed to the parachain node, while the arguments provided after -- will be passed \163		to the relaychain node.\n\n\164		parachain-collator [parachain-args] -- [relaychain-args]"165			.into()166	}167168	fn author() -> String {169		env!("CARGO_PKG_AUTHORS").into()170	}171	// TODO use args172	fn support_url() -> String {173		"support@unique.network".into()174	}175176	fn copyright_start_year() -> i32 {177		2019178	}179180	fn load_spec(&self, id: &str) -> std::result::Result<Box<dyn sc_service::ChainSpec>, String> {181		polkadot_cli::Cli::from_iter([RelayChainCli::executable_name()].iter()).load_spec(id)182	}183184	fn native_runtime_version(chain_spec: &Box<dyn ChainSpec>) -> &'static RuntimeVersion {185		polkadot_cli::Cli::native_runtime_version(chain_spec)186	}187}188189#[allow(clippy::borrowed_box)]190fn extract_genesis_wasm(chain_spec: &Box<dyn sc_service::ChainSpec>) -> Result<Vec<u8>> {191	let mut storage = chain_spec.build_storage()?;192193	storage194		.top195		.remove(sp_core::storage::well_known_keys::CODE)196		.ok_or_else(|| "Could not find wasm file in genesis state!".into())197}198199macro_rules! async_run_with_runtime {200	(201		$runtime_api:path, $executor:path,202		$runner:ident, $components:ident, $cli:ident, $cmd:ident, $config:ident,203		$( $code:tt )*204	) => {205		$runner.async_run(|$config| {206			let $components = new_partial::<207				$runtime_api, $executor, _208			>(209				&$config,210				crate::service::parachain_build_import_queue,211				ServiceId::Prod,212			)?;213			let task_manager = $components.task_manager;214215			{ $( $code )* }.map(|v| (v, task_manager))216		})217	};218}219220macro_rules! construct_async_run {221	(|$components:ident, $cli:ident, $cmd:ident, $config:ident| $( $code:tt )* ) => {{222		let runner = $cli.create_runner($cmd)?;223224		match runner.config().chain_spec.runtime_id() {225			#[cfg(feature = "unique-runtime")]226			RuntimeId::Unique => async_run_with_runtime!(227				unique_runtime::RuntimeApi, UniqueRuntimeExecutor,228				runner, $components, $cli, $cmd, $config, $( $code )*229			),230231			#[cfg(feature = "quartz-runtime")]232			RuntimeId::Quartz => async_run_with_runtime!(233				quartz_runtime::RuntimeApi, QuartzRuntimeExecutor,234				runner, $components, $cli, $cmd, $config, $( $code )*235			),236237			RuntimeId::Opal => async_run_with_runtime!(238				opal_runtime::RuntimeApi, OpalRuntimeExecutor,239				runner, $components, $cli, $cmd, $config, $( $code )*240			),241242			RuntimeId::Unknown(chain) => Err(no_runtime_err!(chain).into())243		}244	}}245}246247macro_rules! start_node_using_chain_runtime {248	($start_node_fn:ident($config:expr $(, $($args:expr),+)?) $($code:tt)*) => {249		match $config.chain_spec.runtime_id() {250			#[cfg(feature = "unique-runtime")]251			RuntimeId::Unique => $start_node_fn::<252				unique_runtime::Runtime,253				unique_runtime::RuntimeApi,254				UniqueRuntimeExecutor,255			>($config $(, $($args),+)?) $($code)*,256257			#[cfg(feature = "quartz-runtime")]258			RuntimeId::Quartz => $start_node_fn::<259				quartz_runtime::Runtime,260				quartz_runtime::RuntimeApi,261				QuartzRuntimeExecutor,262			>($config $(, $($args),+)?) $($code)*,263264			RuntimeId::Opal => $start_node_fn::<265				opal_runtime::Runtime,266				opal_runtime::RuntimeApi,267				OpalRuntimeExecutor,268			>($config $(, $($args),+)?) $($code)*,269270			RuntimeId::Unknown(chain) => Err(no_runtime_err!(chain).into()),271		}272	};273}274275/// Parse command line arguments into service configuration.276pub fn run() -> Result<()> {277	let cli = Cli::from_args();278279	match &cli.subcommand {280		Some(Subcommand::BuildSpec(cmd)) => {281			let runner = cli.create_runner(cmd)?;282			runner.sync_run(|config| cmd.run(config.chain_spec, config.network))283		}284		Some(Subcommand::CheckBlock(cmd)) => {285			construct_async_run!(|components, cli, cmd, config| {286				Ok(cmd.run(components.client, components.import_queue))287			})288		}289		Some(Subcommand::ExportBlocks(cmd)) => {290			construct_async_run!(|components, cli, cmd, config| {291				Ok(cmd.run(components.client, config.database))292			})293		}294		Some(Subcommand::ExportState(cmd)) => {295			construct_async_run!(|components, cli, cmd, config| {296				Ok(cmd.run(components.client, config.chain_spec))297			})298		}299		Some(Subcommand::ImportBlocks(cmd)) => {300			construct_async_run!(|components, cli, cmd, config| {301				Ok(cmd.run(components.client, components.import_queue))302			})303		}304		Some(Subcommand::PurgeChain(cmd)) => {305			let runner = cli.create_runner(cmd)?;306307			runner.sync_run(|config| {308				let polkadot_cli = RelayChainCli::new(309					&config,310					[RelayChainCli::executable_name()]311						.iter()312						.chain(cli.relaychain_args.iter()),313				);314315				let polkadot_config = SubstrateCli::create_configuration(316					&polkadot_cli,317					&polkadot_cli,318					config.tokio_handle.clone(),319				)320				.map_err(|err| format!("Relay chain argument error: {}", err))?;321322				cmd.run(config, polkadot_config)323			})324		}325		Some(Subcommand::Revert(cmd)) => construct_async_run!(|components, cli, cmd, config| {326			Ok(cmd.run(components.client, components.backend))327		}),328		Some(Subcommand::ExportGenesisState(params)) => {329			let mut builder = sc_cli::LoggerBuilder::new("");330			builder.with_profiling(sc_tracing::TracingReceiver::Log, "");331			let _ = builder.init();332333			let spec = load_spec(&params.chain.clone().unwrap_or_default())?;334			let state_version = Cli::native_runtime_version(&spec).state_version();335			let block: Block = generate_genesis_block(&spec, state_version)?;336			let raw_header = block.header().encode();337			let output_buf = if params.raw {338				raw_header339			} else {340				format!("0x{:?}", HexDisplay::from(&block.header().encode())).into_bytes()341			};342343			if let Some(output) = &params.output {344				std::fs::write(output, output_buf)?;345			} else {346				std::io::stdout().write_all(&output_buf)?;347			}348349			Ok(())350		}351		Some(Subcommand::ExportGenesisWasm(params)) => {352			let mut builder = sc_cli::LoggerBuilder::new("");353			builder.with_profiling(sc_tracing::TracingReceiver::Log, "");354			let _ = builder.init();355356			let raw_wasm_blob =357				extract_genesis_wasm(&cli.load_spec(&params.chain.clone().unwrap_or_default())?)?;358			let output_buf = if params.raw {359				raw_wasm_blob360			} else {361				format!("0x{:?}", HexDisplay::from(&raw_wasm_blob)).into_bytes()362			};363364			if let Some(output) = &params.output {365				std::fs::write(output, output_buf)?;366			} else {367				std::io::stdout().write_all(&output_buf)?;368			}369370			Ok(())371		}372		Some(Subcommand::Benchmark(cmd)) => {373			if cfg!(feature = "runtime-benchmarks") {374				let runner = cli.create_runner(cmd)?;375				runner.sync_run(|config| match config.chain_spec.runtime_id() {376					#[cfg(feature = "unique-runtime")]377					RuntimeId::Unique => cmd.run::<Block, UniqueRuntimeExecutor>(config),378379					#[cfg(feature = "quartz-runtime")]380					RuntimeId::Quartz => cmd.run::<Block, QuartzRuntimeExecutor>(config),381382					RuntimeId::Opal => cmd.run::<Block, OpalRuntimeExecutor>(config),383					RuntimeId::Unknown(chain) => Err(no_runtime_err!(chain).into()),384				})385			} else {386				Err("Benchmarking wasn't enabled when building the node. \387				You can enable it with `--features runtime-benchmarks`."388					.into())389			}390		}391		None => {392			let runner = cli.create_runner(&cli.run.normalize())?;393394			runner.run_node_until_exit(|config| async move {395				let extensions = chain_spec::Extensions::try_get(&*config.chain_spec);396397				let service_id = config.chain_spec.service_id();398				let relay_chain_id = extensions.map(|e| e.relay_chain.clone());399				let is_dev_service = matches![service_id, ServiceId::Dev]400					|| relay_chain_id == Some("dev-service".into());401402				if is_dev_service {403					info!("Running Dev service");404405					return start_node_using_chain_runtime! {406						start_dev_node(config).map_err(Into::into)407					};408				};409410				let para_id = extensions411					.map(|e| e.para_id)412					.ok_or("Could not find parachain ID in chain-spec.")?;413414				let polkadot_cli = RelayChainCli::new(415					&config,416					[RelayChainCli::executable_name()]417						.iter()418						.chain(cli.relaychain_args.iter()),419				);420421				let para_id = ParaId::from(para_id);422423				let parachain_account =424					AccountIdConversion::<polkadot_primitives::v0::AccountId>::into_account(425						&para_id,426					);427428				let state_version =429					RelayChainCli::native_runtime_version(&config.chain_spec).state_version();430				let block: Block = generate_genesis_block(&config.chain_spec, state_version)431					.map_err(|e| format!("{:?}", e))?;432				let genesis_state = format!("0x{:?}", HexDisplay::from(&block.header().encode()));433				let genesis_hash = format!("0x{:?}", HexDisplay::from(&block.header().hash().0));434435				let polkadot_config = SubstrateCli::create_configuration(436					&polkadot_cli,437					&polkadot_cli,438					config.tokio_handle.clone(),439				)440				.map_err(|err| format!("Relay chain argument error: {}", err))?;441442				info!("Parachain id: {:?}", para_id);443				info!("Parachain Account: {}", parachain_account);444				info!("Parachain genesis state: {}", genesis_state);445				info!("Parachain genesis hash: {}", genesis_hash);446				info!(447					"Is collating: {}",448					if config.role.is_authority() {449						"yes"450					} else {451						"no"452					}453				);454455				start_node_using_chain_runtime! {456					start_node(config, polkadot_config, para_id)457						.await458						.map(|r| r.0)459						.map_err(Into::into)460				}461			})462		}463	}464}465466impl DefaultConfigurationValues for RelayChainCli {467	fn p2p_listen_port() -> u16 {468		30334469	}470471	fn rpc_ws_listen_port() -> u16 {472		9945473	}474475	fn rpc_http_listen_port() -> u16 {476		9934477	}478479	fn prometheus_listen_port() -> u16 {480		9616481	}482}483484impl CliConfiguration<Self> for RelayChainCli {485	fn shared_params(&self) -> &SharedParams {486		self.base.base.shared_params()487	}488489	fn import_params(&self) -> Option<&ImportParams> {490		self.base.base.import_params()491	}492493	fn network_params(&self) -> Option<&NetworkParams> {494		self.base.base.network_params()495	}496497	fn keystore_params(&self) -> Option<&KeystoreParams> {498		self.base.base.keystore_params()499	}500501	fn base_path(&self) -> Result<Option<BasePath>> {502		Ok(self503			.shared_params()504			.base_path()505			.or_else(|| self.base_path.clone().map(Into::into)))506	}507508	fn rpc_http(&self, default_listen_port: u16) -> Result<Option<SocketAddr>> {509		self.base.base.rpc_http(default_listen_port)510	}511512	fn rpc_ipc(&self) -> Result<Option<String>> {513		self.base.base.rpc_ipc()514	}515516	fn rpc_ws(&self, default_listen_port: u16) -> Result<Option<SocketAddr>> {517		self.base.base.rpc_ws(default_listen_port)518	}519520	fn prometheus_config(521		&self,522		default_listen_port: u16,523		chain_spec: &Box<dyn ChainSpec>,524	) -> Result<Option<PrometheusConfig>> {525		self.base526			.base527			.prometheus_config(default_listen_port, chain_spec)528	}529530	fn init<F>(531		&self,532		_support_url: &String,533		_impl_version: &String,534		_logger_hook: F,535		_config: &sc_service::Configuration,536	) -> Result<()> {537		unreachable!("PolkadotCli is never initialized; qed");538	}539540	fn chain_id(&self, is_dev: bool) -> Result<String> {541		let chain_id = self.base.base.chain_id(is_dev)?;542543		Ok(if chain_id.is_empty() {544			self.chain_id.clone().unwrap_or_default()545		} else {546			chain_id547		})548	}549550	fn role(&self, is_dev: bool) -> Result<sc_service::Role> {551		self.base.base.role(is_dev)552	}553554	fn transaction_pool(&self) -> Result<sc_service::config::TransactionPoolOptions> {555		self.base.base.transaction_pool()556	}557558	fn state_cache_child_ratio(&self) -> Result<Option<usize>> {559		self.base.base.state_cache_child_ratio()560	}561562	fn rpc_methods(&self) -> Result<sc_service::config::RpcMethods> {563		self.base.base.rpc_methods()564	}565566	fn rpc_ws_max_connections(&self) -> Result<Option<usize>> {567		self.base.base.rpc_ws_max_connections()568	}569570	fn rpc_cors(&self, is_dev: bool) -> Result<Option<Vec<String>>> {571		self.base.base.rpc_cors(is_dev)572	}573574	fn default_heap_pages(&self) -> Result<Option<u64>> {575		self.base.base.default_heap_pages()576	}577578	fn force_authoring(&self) -> Result<bool> {579		self.base.base.force_authoring()580	}581582	fn disable_grandpa(&self) -> Result<bool> {583		self.base.base.disable_grandpa()584	}585586	fn max_runtime_instances(&self) -> Result<Option<usize>> {587		self.base.base.max_runtime_instances()588	}589590	fn announce_block(&self) -> Result<bool> {591		self.base.base.announce_block()592	}593594	fn telemetry_endpoints(595		&self,596		chain_spec: &Box<dyn ChainSpec>,597	) -> Result<Option<sc_telemetry::TelemetryEndpoints>> {598		self.base.base.telemetry_endpoints(chain_spec)599	}600}