git.delta.rocks / unique-network / refs/commits / 941703a90a9b

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::BuildSpec(cmd)) => {317			let runner = cli.create_runner(cmd)?;318			runner.sync_run(|config| cmd.run(config.chain_spec, config.network))319		}320		Some(Subcommand::CheckBlock(cmd)) => {321			construct_async_run!(|components, cli, cmd, config| {322				Ok(cmd.run(components.client, components.import_queue))323			})324		}325		Some(Subcommand::ExportBlocks(cmd)) => {326			construct_async_run!(|components, cli, cmd, config| {327				Ok(cmd.run(components.client, config.database))328			})329		}330		Some(Subcommand::ExportState(cmd)) => {331			construct_async_run!(|components, cli, cmd, config| {332				Ok(cmd.run(components.client, config.chain_spec))333			})334		}335		Some(Subcommand::ImportBlocks(cmd)) => {336			construct_async_run!(|components, cli, cmd, config| {337				Ok(cmd.run(components.client, components.import_queue))338			})339		}340		Some(Subcommand::PurgeChain(cmd)) => {341			let runner = cli.create_runner(cmd)?;342343			runner.sync_run(|config| {344				let polkadot_cli = RelayChainCli::new(345					&config,346					[RelayChainCli::executable_name()]347						.iter()348						.chain(cli.relaychain_args.iter()),349				);350351				let polkadot_config = SubstrateCli::create_configuration(352					&polkadot_cli,353					&polkadot_cli,354					config.tokio_handle.clone(),355				)356				.map_err(|err| format!("Relay chain argument error: {err}"))?;357358				cmd.run(config, polkadot_config)359			})360		}361		Some(Subcommand::Revert(cmd)) => construct_async_run!(|components, cli, cmd, config| {362			Ok(cmd.run(components.client, components.backend, None))363		}),364		Some(Subcommand::ExportGenesisState(cmd)) => {365			construct_sync_run!(|components, cli, cmd, _config| {366				let spec = cli.load_spec(&cmd.shared_params.chain.clone().unwrap_or_default())?;367				let state_version = Cli::native_runtime_version(&spec).state_version();368				cmd.run::<Block>(&*spec, state_version)369			})370		}371		Some(Subcommand::ExportGenesisWasm(cmd)) => {372			construct_sync_run!(|components, cli, cmd, _config| {373				let spec = cli.load_spec(&cmd.shared_params.chain.clone().unwrap_or_default())?;374				cmd.run(&*spec)375			})376		}377		#[cfg(feature = "runtime-benchmarks")]378		Some(Subcommand::Benchmark(cmd)) => {379			use frame_benchmarking_cli::{BenchmarkCmd, SUBSTRATE_REFERENCE_HARDWARE};380			let runner = cli.create_runner(cmd)?;381			// Switch on the concrete benchmark sub-command-382			match cmd {383				BenchmarkCmd::Pallet(cmd) => {384					runner.sync_run(|config| cmd.run::<Block, DefaultRuntimeExecutor>(config))385				}386				BenchmarkCmd::Block(cmd) => runner.sync_run(|config| {387					let partials = new_partial::<388						default_runtime::RuntimeApi,389						DefaultRuntimeExecutor,390						_,391					>(&config, crate::service::parachain_build_import_queue)?;392					cmd.run(partials.client)393				}),394				BenchmarkCmd::Storage(cmd) => runner.sync_run(|config| {395					let partials = new_partial::<396						default_runtime::RuntimeApi,397						DefaultRuntimeExecutor,398						_,399					>(&config, crate::service::parachain_build_import_queue)?;400					let db = partials.backend.expose_db();401					let storage = partials.backend.expose_storage();402403					cmd.run(config, partials.client.clone(), db, storage)404				}),405				BenchmarkCmd::Machine(cmd) => {406					runner.sync_run(|config| cmd.run(&config, SUBSTRATE_REFERENCE_HARDWARE.clone()))407				}408				BenchmarkCmd::Overhead(_) | BenchmarkCmd::Extrinsic(_) => {409					Err("Unsupported benchmarking command".into())410				}411			}412		}413		#[cfg(feature = "try-runtime")]414		Some(Subcommand::TryRuntime(cmd)) => {415			use std::{future::Future, pin::Pin};416			use sc_executor::{sp_wasm_interface::ExtendedHostFunctions, NativeExecutionDispatch};417			use try_runtime_cli::block_building_info::timestamp_with_aura_info;418419			let runner = cli.create_runner(cmd)?;420421			// grab the task manager.422			let registry = &runner423				.config()424				.prometheus_config425				.as_ref()426				.map(|cfg| &cfg.registry);427			let task_manager =428				sc_service::TaskManager::new(runner.config().tokio_handle.clone(), *registry)429					.map_err(|e| format!("Error: {:?}", e))?;430			let info_provider = Some(timestamp_with_aura_info(12000));431432			runner.async_run(|config| -> Result<(Pin<Box<dyn Future<Output = _>>>, _)> {433				Ok((434					match config.chain_spec.runtime_id() {435						#[cfg(feature = "unique-runtime")]436						RuntimeId::Unique => Box::pin(cmd.run::<Block, ExtendedHostFunctions<437							sp_io::SubstrateHostFunctions,438							<UniqueRuntimeExecutor as NativeExecutionDispatch>::ExtendHostFunctions,439						>, _>(info_provider)),440441						#[cfg(feature = "quartz-runtime")]442						RuntimeId::Quartz => Box::pin(cmd.run::<Block, ExtendedHostFunctions<443							sp_io::SubstrateHostFunctions,444							<QuartzRuntimeExecutor as NativeExecutionDispatch>::ExtendHostFunctions,445						>, _>(info_provider)),446447						RuntimeId::Opal => Box::pin(cmd.run::<Block, ExtendedHostFunctions<448							sp_io::SubstrateHostFunctions,449							<OpalRuntimeExecutor as NativeExecutionDispatch>::ExtendHostFunctions,450						>, _>(info_provider)),451						runtime_id => return Err(no_runtime_err!(runtime_id).into()),452					},453					task_manager,454				))455			})456		}457		#[cfg(not(feature = "try-runtime"))]458		Some(Subcommand::TryRuntime) => {459			Err("Try-runtime must be enabled by `--features try-runtime`.".into())460		}461		None => {462			let runner = cli.create_runner(&cli.run.normalize())?;463			let collator_options = cli.run.collator_options();464465			runner.run_node_until_exit(|config| async move {466				let hwbench = if !cli.no_hardware_benchmarks {467					config.database.path().map(|database_path| {468						let _ = std::fs::create_dir_all(database_path);469						sc_sysinfo::gather_hwbench(Some(database_path))470					})471				} else {472					None473				};474475				let extensions = chain_spec::Extensions::try_get(&*config.chain_spec);476477				let service_id = config.chain_spec.service_id();478				let relay_chain_id = extensions.map(|e| e.relay_chain.clone());479				let is_dev_service = matches![service_id, ServiceId::Dev]480					|| relay_chain_id == Some("dev-service".into());481482				if is_dev_service {483					info!("Running Dev service");484485					let autoseal_interval = Duration::from_millis(cli.idle_autoseal_interval);486487					let mut config = config;488489					config.state_pruning = Some(sc_service::PruningMode::ArchiveAll);490491					return start_node_using_chain_runtime! {492						start_dev_node(config, autoseal_interval).map_err(Into::into)493					};494				};495496				let para_id = extensions497					.map(|e| e.para_id)498					.ok_or("Could not find parachain ID in chain-spec.")?;499500				let polkadot_cli = RelayChainCli::new(501					&config,502					[RelayChainCli::executable_name()]503						.iter()504						.chain(cli.relaychain_args.iter()),505				);506507				let para_id = ParaId::from(para_id);508509				let parachain_account =510					AccountIdConversion::<polkadot_primitives::AccountId>::into_account_truncating(511						&para_id,512					);513514				let state_version = Cli::native_runtime_version(&config.chain_spec).state_version();515				let block: Block = generate_genesis_block(&*config.chain_spec, state_version)516					.map_err(|e| format!("{e:?}"))?;517				let genesis_state = format!("0x{:?}", HexDisplay::from(&block.header().encode()));518				let genesis_hash = format!("0x{:?}", HexDisplay::from(&block.header().hash().0));519520				let polkadot_config = SubstrateCli::create_configuration(521					&polkadot_cli,522					&polkadot_cli,523					config.tokio_handle.clone(),524				)525				.map_err(|err| format!("Relay chain argument error: {err}"))?;526527				info!("Parachain id: {:?}", para_id);528				info!("Parachain Account: {}", parachain_account);529				info!("Parachain genesis state: {}", genesis_state);530				info!("Parachain genesis hash: {}", genesis_hash);531				debug!("Parachain genesis block: {:?}", block);532				info!(533					"Is collating: {}",534					config.role.is_authority().then_some("yes").unwrap_or("no")535				);536537				start_node_using_chain_runtime! {538					start_node(config, polkadot_config, collator_options, para_id, hwbench)539						.await540						.map(|r| r.0)541						.map_err(Into::into)542				}543			})544		}545	}546}547548impl DefaultConfigurationValues for RelayChainCli {549	fn p2p_listen_port() -> u16 {550		30334551	}552553	fn rpc_ws_listen_port() -> u16 {554		9945555	}556557	fn rpc_http_listen_port() -> u16 {558		9934559	}560561	fn prometheus_listen_port() -> u16 {562		9616563	}564}565566impl CliConfiguration<Self> for RelayChainCli {567	fn shared_params(&self) -> &SharedParams {568		self.base.base.shared_params()569	}570571	fn import_params(&self) -> Option<&ImportParams> {572		self.base.base.import_params()573	}574575	fn network_params(&self) -> Option<&NetworkParams> {576		self.base.base.network_params()577	}578579	fn keystore_params(&self) -> Option<&KeystoreParams> {580		self.base.base.keystore_params()581	}582583	fn base_path(&self) -> Result<Option<BasePath>> {584		Ok(self585			.shared_params()586			.base_path()?587			.or_else(|| self.base_path.clone().map(Into::into)))588	}589590	fn rpc_http(&self, default_listen_port: u16) -> Result<Option<SocketAddr>> {591		self.base.base.rpc_http(default_listen_port)592	}593594	fn rpc_ipc(&self) -> Result<Option<String>> {595		self.base.base.rpc_ipc()596	}597598	fn rpc_ws(&self, default_listen_port: u16) -> Result<Option<SocketAddr>> {599		self.base.base.rpc_ws(default_listen_port)600	}601602	fn prometheus_config(603		&self,604		default_listen_port: u16,605		chain_spec: &Box<dyn ChainSpec>,606	) -> Result<Option<PrometheusConfig>> {607		self.base608			.base609			.prometheus_config(default_listen_port, chain_spec)610	}611612	fn init<F>(613		&self,614		_support_url: &String,615		_impl_version: &String,616		_logger_hook: F,617		_config: &sc_service::Configuration,618	) -> Result<()> {619		unreachable!("PolkadotCli is never initialized; qed");620	}621622	fn chain_id(&self, is_dev: bool) -> Result<String> {623		let chain_id = self.base.base.chain_id(is_dev)?;624625		Ok(if chain_id.is_empty() {626			self.chain_id.clone().unwrap_or_default()627		} else {628			chain_id629		})630	}631632	fn role(&self, is_dev: bool) -> Result<sc_service::Role> {633		self.base.base.role(is_dev)634	}635636	fn transaction_pool(&self, is_dev: bool) -> Result<sc_service::config::TransactionPoolOptions> {637		self.base.base.transaction_pool(is_dev)638	}639640	fn rpc_methods(&self) -> Result<sc_service::config::RpcMethods> {641		self.base.base.rpc_methods()642	}643644	fn rpc_ws_max_connections(&self) -> Result<Option<usize>> {645		self.base.base.rpc_ws_max_connections()646	}647648	fn rpc_cors(&self, is_dev: bool) -> Result<Option<Vec<String>>> {649		self.base.base.rpc_cors(is_dev)650	}651652	fn default_heap_pages(&self) -> Result<Option<u64>> {653		self.base.base.default_heap_pages()654	}655656	fn force_authoring(&self) -> Result<bool> {657		self.base.base.force_authoring()658	}659660	fn disable_grandpa(&self) -> Result<bool> {661		self.base.base.disable_grandpa()662	}663664	fn max_runtime_instances(&self) -> Result<Option<usize>> {665		self.base.base.max_runtime_instances()666	}667668	fn announce_block(&self) -> Result<bool> {669		self.base.base.announce_block()670	}671672	fn telemetry_endpoints(673		&self,674		chain_spec: &Box<dyn ChainSpec>,675	) -> Result<Option<sc_telemetry::TelemetryEndpoints>> {676		self.base.base.telemetry_endpoints(chain_spec)677	}678}