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

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::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			let chain_spec = Box::new(chain_spec::OpalChainSpec::from_json_file(path.clone())?)87				as Box<dyn sc_service::ChainSpec>;8889			match chain_spec.runtime_id() {90				#[cfg(feature = "unique-runtime")]91				RuntimeId::Unique => Box::new(chain_spec::UniqueChainSpec::from_json_file(path)?),9293				#[cfg(feature = "quartz-runtime")]94				RuntimeId::Quartz => Box::new(chain_spec::QuartzChainSpec::from_json_file(path)?),9596				RuntimeId::Opal => chain_spec,97				runtime_id => return Err(no_runtime_err!(runtime_id)),98			}99		}100	})101}102103impl SubstrateCli for Cli {104	// TODO use args105	fn impl_name() -> String {106		format!("{} Node", Self::node_name())107	}108109	fn impl_version() -> String {110		env!("SUBSTRATE_CLI_IMPL_VERSION").into()111	}112	// TODO use args113	fn description() -> String {114		format!(115			"{} Node\n\nThe command-line arguments provided first will be \116		passed to the parachain node, while the arguments provided after -- will be passed \117		to the relaychain node.\n\n\118		{} [parachain-args] -- [relaychain-args]",119			Self::node_name(),120			Self::executable_name()121		)122	}123124	fn author() -> String {125		env!("CARGO_PKG_AUTHORS").into()126	}127128	//TODO use args129	fn support_url() -> String {130		"support@unique.network".into()131	}132133	fn copyright_start_year() -> i32 {134		2019135	}136137	fn load_spec(&self, id: &str) -> std::result::Result<Box<dyn sc_service::ChainSpec>, String> {138		load_spec(id)139	}140141	fn native_runtime_version(chain_spec: &Box<dyn ChainSpec>) -> &'static RuntimeVersion {142		match chain_spec.runtime_id() {143			#[cfg(feature = "unique-runtime")]144			RuntimeId::Unique => &unique_runtime::VERSION,145146			#[cfg(feature = "quartz-runtime")]147			RuntimeId::Quartz => &quartz_runtime::VERSION,148149			RuntimeId::Opal => &opal_runtime::VERSION,150			runtime_id => panic!("{}", no_runtime_err!(runtime_id)),151		}152	}153}154155impl SubstrateCli for RelayChainCli {156	// TODO use args157	fn impl_name() -> String {158		format!("{} Node", Cli::node_name())159	}160161	fn impl_version() -> String {162		env!("SUBSTRATE_CLI_IMPL_VERSION").into()163	}164	// TODO use args165	fn description() -> String {166		format!(167			"{} Node\n\nThe command-line arguments provided first will be \168			passed to the parachain node, while the arguments provided after -- will be passed \169			to the relaychain node.\n\n\170			parachain-collator [parachain-args] -- [relaychain-args]",171			Cli::node_name()172		)173	}174175	fn author() -> String {176		env!("CARGO_PKG_AUTHORS").into()177	}178	// TODO use args179	fn support_url() -> String {180		"support@unique.network".into()181	}182183	fn copyright_start_year() -> i32 {184		2019185	}186187	fn load_spec(&self, id: &str) -> std::result::Result<Box<dyn sc_service::ChainSpec>, String> {188		polkadot_cli::Cli::from_iter([RelayChainCli::executable_name()].iter()).load_spec(id)189	}190191	fn native_runtime_version(chain_spec: &Box<dyn ChainSpec>) -> &'static RuntimeVersion {192		polkadot_cli::Cli::native_runtime_version(chain_spec)193	}194}195196macro_rules! async_run_with_runtime {197	(198		$runtime_api:path, $executor:path,199		$runner:ident, $components:ident, $cli:ident, $cmd:ident, $config:ident,200		$( $code:tt )*201	) => {202		$runner.async_run(|$config| {203			let $components = new_partial::<204				$runtime_api, $executor, _205			>(206				&$config,207				crate::service::parachain_build_import_queue,208			)?;209			let task_manager = $components.task_manager;210211			{ $( $code )* }.map(|v| (v, task_manager))212		})213	};214}215216macro_rules! construct_async_run {217	(|$components:ident, $cli:ident, $cmd:ident, $config:ident| $( $code:tt )* ) => {{218		let runner = $cli.create_runner($cmd)?;219220		match runner.config().chain_spec.runtime_id() {221			#[cfg(feature = "unique-runtime")]222			RuntimeId::Unique => async_run_with_runtime!(223				unique_runtime::RuntimeApi, UniqueRuntimeExecutor,224				runner, $components, $cli, $cmd, $config, $( $code )*225			),226227			#[cfg(feature = "quartz-runtime")]228			RuntimeId::Quartz => async_run_with_runtime!(229				quartz_runtime::RuntimeApi, QuartzRuntimeExecutor,230				runner, $components, $cli, $cmd, $config, $( $code )*231			),232233			RuntimeId::Opal => async_run_with_runtime!(234				opal_runtime::RuntimeApi, OpalRuntimeExecutor,235				runner, $components, $cli, $cmd, $config, $( $code )*236			),237238			runtime_id => Err(no_runtime_err!(runtime_id).into())239		}240	}}241}242243macro_rules! sync_run_with_runtime {244	(245		$runtime_api:path, $executor:path,246		$runner:ident, $components:ident, $cli:ident, $cmd:ident, $config:ident,247		$( $code:tt )*248	) => {249		$runner.sync_run(|$config| {250			$( $code )*251		})252	};253}254255macro_rules! construct_sync_run {256	(|$components:ident, $cli:ident, $cmd:ident, $config:ident| $( $code:tt )* ) => {{257		let runner = $cli.create_runner($cmd)?;258259		match runner.config().chain_spec.runtime_id() {260			#[cfg(feature = "unique-runtime")]261			RuntimeId::Unique => sync_run_with_runtime!(262				unique_runtime::RuntimeApi, UniqueRuntimeExecutor,263				runner, $components, $cli, $cmd, $config, $( $code )*264			),265266			#[cfg(feature = "quartz-runtime")]267			RuntimeId::Quartz => sync_run_with_runtime!(268				quartz_runtime::RuntimeApi, QuartzRuntimeExecutor,269				runner, $components, $cli, $cmd, $config, $( $code )*270			),271272			RuntimeId::Opal => sync_run_with_runtime!(273				opal_runtime::RuntimeApi, OpalRuntimeExecutor,274				runner, $components, $cli, $cmd, $config, $( $code )*275			),276277			runtime_id => Err(no_runtime_err!(runtime_id).into())278		}279	}}280}281282macro_rules! start_node_using_chain_runtime {283	($start_node_fn:ident($config:expr $(, $($args:expr),+)?) $($code:tt)*) => {284		match $config.chain_spec.runtime_id() {285			#[cfg(feature = "unique-runtime")]286			RuntimeId::Unique => $start_node_fn::<287				unique_runtime::Runtime,288				unique_runtime::RuntimeApi,289				UniqueRuntimeExecutor,290			>($config $(, $($args),+)?) $($code)*,291292			#[cfg(feature = "quartz-runtime")]293			RuntimeId::Quartz => $start_node_fn::<294				quartz_runtime::Runtime,295				quartz_runtime::RuntimeApi,296				QuartzRuntimeExecutor,297			>($config $(, $($args),+)?) $($code)*,298299			RuntimeId::Opal => $start_node_fn::<300				opal_runtime::Runtime,301				opal_runtime::RuntimeApi,302				OpalRuntimeExecutor,303			>($config $(, $($args),+)?) $($code)*,304305			runtime_id => Err(no_runtime_err!(runtime_id).into()),306		}307	};308}309310/// Parse command line arguments into service configuration.311pub fn run() -> Result<()> {312	let cli = Cli::from_args();313314	match &cli.subcommand {315		Some(Subcommand::BuildSpec(cmd)) => {316			let runner = cli.create_runner(cmd)?;317			runner.sync_run(|config| cmd.run(config.chain_spec, config.network))318		}319		Some(Subcommand::CheckBlock(cmd)) => {320			construct_async_run!(|components, cli, cmd, config| {321				Ok(cmd.run(components.client, components.import_queue))322			})323		}324		Some(Subcommand::ExportBlocks(cmd)) => {325			construct_async_run!(|components, cli, cmd, config| {326				Ok(cmd.run(components.client, config.database))327			})328		}329		Some(Subcommand::ExportState(cmd)) => {330			construct_async_run!(|components, cli, cmd, config| {331				Ok(cmd.run(components.client, config.chain_spec))332			})333		}334		Some(Subcommand::ImportBlocks(cmd)) => {335			construct_async_run!(|components, cli, cmd, config| {336				Ok(cmd.run(components.client, components.import_queue))337			})338		}339		Some(Subcommand::PurgeChain(cmd)) => {340			let runner = cli.create_runner(cmd)?;341342			runner.sync_run(|config| {343				let polkadot_cli = RelayChainCli::new(344					&config,345					[RelayChainCli::executable_name()]346						.iter()347						.chain(cli.relaychain_args.iter()),348				);349350				let polkadot_config = SubstrateCli::create_configuration(351					&polkadot_cli,352					&polkadot_cli,353					config.tokio_handle.clone(),354				)355				.map_err(|err| format!("Relay chain argument error: {}", err))?;356357				cmd.run(config, polkadot_config)358			})359		}360		Some(Subcommand::Revert(cmd)) => construct_async_run!(|components, cli, cmd, config| {361			Ok(cmd.run(components.client, components.backend, None))362		}),363		Some(Subcommand::ExportGenesisState(cmd)) => {364			construct_sync_run!(|components, cli, cmd, _config| {365				let spec = cli.load_spec(&cmd.shared_params.chain.clone().unwrap_or_default())?;366				let state_version = Cli::native_runtime_version(&spec).state_version();367				cmd.run::<Block>(&*spec, state_version)368			})369		}370		Some(Subcommand::ExportGenesisWasm(cmd)) => {371			construct_sync_run!(|components, cli, cmd, _config| {372				let spec = cli.load_spec(&cmd.shared_params.chain.clone().unwrap_or_default())?;373				cmd.run(&*spec)374			})375		}376		#[cfg(feature = "runtime-benchmarks")]377		Some(Subcommand::Benchmark(cmd)) => {378			use frame_benchmarking_cli::{BenchmarkCmd, SUBSTRATE_REFERENCE_HARDWARE};379			let runner = cli.create_runner(cmd)?;380			// Switch on the concrete benchmark sub-command-381			match cmd {382				BenchmarkCmd::Pallet(cmd) => {383					runner.sync_run(|config| cmd.run::<Block, DefaultRuntimeExecutor>(config))384				}385				BenchmarkCmd::Block(cmd) => runner.sync_run(|config| {386					let partials = new_partial::<387						default_runtime::RuntimeApi,388						DefaultRuntimeExecutor,389						_,390					>(&config, crate::service::parachain_build_import_queue)?;391					cmd.run(partials.client)392				}),393				BenchmarkCmd::Storage(cmd) => runner.sync_run(|config| {394					let partials = new_partial::<395						default_runtime::RuntimeApi,396						DefaultRuntimeExecutor,397						_,398					>(&config, crate::service::parachain_build_import_queue)?;399					let db = partials.backend.expose_db();400					let storage = partials.backend.expose_storage();401402					cmd.run(config, partials.client.clone(), db, storage)403				}),404				BenchmarkCmd::Machine(cmd) => {405					runner.sync_run(|config| cmd.run(&config, SUBSTRATE_REFERENCE_HARDWARE.clone()))406				}407				BenchmarkCmd::Overhead(_) | BenchmarkCmd::Extrinsic(_) => {408					Err("Unsupported benchmarking command".into())409				}410			}411		}412		#[cfg(feature = "try-runtime")]413		Some(Subcommand::TryRuntime(cmd)) => {414			use std::{future::Future, pin::Pin};415			use sc_executor::{sp_wasm_interface::ExtendedHostFunctions, NativeExecutionDispatch};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))?;428429			runner.async_run(|config| -> Result<(Pin<Box<dyn Future<Output = _>>>, _)> {430				Ok((431					match config.chain_spec.runtime_id() {432						#[cfg(feature = "unique-runtime")]433						RuntimeId::Unique => Box::pin(cmd.run::<Block, ExtendedHostFunctions<434							sp_io::SubstrateHostFunctions,435							<UniqueRuntimeExecutor as NativeExecutionDispatch>::ExtendHostFunctions,436						>>()),437438						#[cfg(feature = "quartz-runtime")]439						RuntimeId::Quartz => Box::pin(cmd.run::<Block, ExtendedHostFunctions<440							sp_io::SubstrateHostFunctions,441							<QuartzRuntimeExecutor as NativeExecutionDispatch>::ExtendHostFunctions,442						>>()),443444						RuntimeId::Opal => Box::pin(cmd.run::<Block, ExtendedHostFunctions<445							sp_io::SubstrateHostFunctions,446							<OpalRuntimeExecutor as NativeExecutionDispatch>::ExtendHostFunctions,447						>>()),448						runtime_id => return Err(no_runtime_err!(runtime_id).into()),449					},450					task_manager,451				))452			})453		}454		#[cfg(not(feature = "try-runtime"))]455		Some(Subcommand::TryRuntime) => {456			Err("Try-runtime must be enabled by `--features try-runtime`.".into())457		}458		None => {459			let runner = cli.create_runner(&cli.run.normalize())?;460			let collator_options = cli.run.collator_options();461462			runner.run_node_until_exit(|config| async move {463				let hwbench = if !cli.no_hardware_benchmarks {464					config.database.path().map(|database_path| {465						let _ = std::fs::create_dir_all(&database_path);466						sc_sysinfo::gather_hwbench(Some(database_path))467					})468				} else {469					None470				};471472				let extensions = chain_spec::Extensions::try_get(&*config.chain_spec);473474				let service_id = config.chain_spec.service_id();475				let relay_chain_id = extensions.map(|e| e.relay_chain.clone());476				let is_dev_service = matches![service_id, ServiceId::Dev]477					|| relay_chain_id == Some("dev-service".into());478479				if is_dev_service {480					info!("Running Dev service");481482					let autoseal_interval = Duration::from_millis(cli.idle_autoseal_interval);483484					let mut config = config;485486					config.state_pruning = Some(sc_service::PruningMode::ArchiveAll);487488					return start_node_using_chain_runtime! {489						start_dev_node(config, autoseal_interval).map_err(Into::into)490					};491				};492493				let para_id = extensions494					.map(|e| e.para_id)495					.ok_or("Could not find parachain ID in chain-spec.")?;496497				let polkadot_cli = RelayChainCli::new(498					&config,499					[RelayChainCli::executable_name()]500						.iter()501						.chain(cli.relaychain_args.iter()),502				);503504				let para_id = ParaId::from(para_id);505506				let parachain_account = AccountIdConversion::<polkadot_primitives::v2::AccountId>::into_account_truncating(&para_id);507508				let state_version =509					RelayChainCli::native_runtime_version(&config.chain_spec).state_version();510				let block: Block = generate_genesis_block(&*config.chain_spec, state_version)511					.map_err(|e| format!("{:?}", e))?;512				let genesis_state = format!("0x{:?}", HexDisplay::from(&block.header().encode()));513				let genesis_hash = format!("0x{:?}", HexDisplay::from(&block.header().hash().0));514515				let polkadot_config = SubstrateCli::create_configuration(516					&polkadot_cli,517					&polkadot_cli,518					config.tokio_handle.clone(),519				)520				.map_err(|err| format!("Relay chain argument error: {}", err))?;521522				info!("Parachain id: {:?}", para_id);523				info!("Parachain Account: {}", parachain_account);524				info!("Parachain genesis state: {}", genesis_state);525				info!("Parachain genesis hash: {}", genesis_hash);526				info!(527					"Is collating: {}",528					if config.role.is_authority() {529						"yes"530					} else {531						"no"532					}533				);534535				start_node_using_chain_runtime! {536					start_node(config, polkadot_config, collator_options, para_id, hwbench)537						.await538						.map(|r| r.0)539						.map_err(Into::into)540				}541			})542		}543	}544}545546impl DefaultConfigurationValues for RelayChainCli {547	fn p2p_listen_port() -> u16 {548		30334549	}550551	fn rpc_ws_listen_port() -> u16 {552		9945553	}554555	fn rpc_http_listen_port() -> u16 {556		9934557	}558559	fn prometheus_listen_port() -> u16 {560		9616561	}562}563564impl CliConfiguration<Self> for RelayChainCli {565	fn shared_params(&self) -> &SharedParams {566		self.base.base.shared_params()567	}568569	fn import_params(&self) -> Option<&ImportParams> {570		self.base.base.import_params()571	}572573	fn network_params(&self) -> Option<&NetworkParams> {574		self.base.base.network_params()575	}576577	fn keystore_params(&self) -> Option<&KeystoreParams> {578		self.base.base.keystore_params()579	}580581	fn base_path(&self) -> Result<Option<BasePath>> {582		Ok(self583			.shared_params()584			.base_path()?585			.or_else(|| self.base_path.clone().map(Into::into)))586	}587588	fn rpc_http(&self, default_listen_port: u16) -> Result<Option<SocketAddr>> {589		self.base.base.rpc_http(default_listen_port)590	}591592	fn rpc_ipc(&self) -> Result<Option<String>> {593		self.base.base.rpc_ipc()594	}595596	fn rpc_ws(&self, default_listen_port: u16) -> Result<Option<SocketAddr>> {597		self.base.base.rpc_ws(default_listen_port)598	}599600	fn prometheus_config(601		&self,602		default_listen_port: u16,603		chain_spec: &Box<dyn ChainSpec>,604	) -> Result<Option<PrometheusConfig>> {605		self.base606			.base607			.prometheus_config(default_listen_port, chain_spec)608	}609610	fn init<F>(611		&self,612		_support_url: &String,613		_impl_version: &String,614		_logger_hook: F,615		_config: &sc_service::Configuration,616	) -> Result<()> {617		unreachable!("PolkadotCli is never initialized; qed");618	}619620	fn chain_id(&self, is_dev: bool) -> Result<String> {621		let chain_id = self.base.base.chain_id(is_dev)?;622623		Ok(if chain_id.is_empty() {624			self.chain_id.clone().unwrap_or_default()625		} else {626			chain_id627		})628	}629630	fn role(&self, is_dev: bool) -> Result<sc_service::Role> {631		self.base.base.role(is_dev)632	}633634	fn transaction_pool(&self, is_dev: bool) -> Result<sc_service::config::TransactionPoolOptions> {635		self.base.base.transaction_pool(is_dev)636	}637638	fn rpc_methods(&self) -> Result<sc_service::config::RpcMethods> {639		self.base.base.rpc_methods()640	}641642	fn rpc_ws_max_connections(&self) -> Result<Option<usize>> {643		self.base.base.rpc_ws_max_connections()644	}645646	fn rpc_cors(&self, is_dev: bool) -> Result<Option<Vec<String>>> {647		self.base.base.rpc_cors(is_dev)648	}649650	fn default_heap_pages(&self) -> Result<Option<u64>> {651		self.base.base.default_heap_pages()652	}653654	fn force_authoring(&self) -> Result<bool> {655		self.base.base.force_authoring()656	}657658	fn disable_grandpa(&self) -> Result<bool> {659		self.base.base.disable_grandpa()660	}661662	fn max_runtime_instances(&self) -> Result<Option<usize>> {663		self.base.base.max_runtime_instances()664	}665666	fn announce_block(&self) -> Result<bool> {667		self.base.base.announce_block()668	}669670	fn telemetry_endpoints(671		&self,672		chain_spec: &Box<dyn ChainSpec>,673	) -> Result<Option<sc_telemetry::TelemetryEndpoints>> {674		self.base.base.telemetry_endpoints(chain_spec)675	}676}