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

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::config::{BasePath, PrometheusConfig};63use sp_core::hexdisplay::HexDisplay;64use sp_runtime::traits::{AccountIdConversion, Block as BlockT};65use std::{time::Duration};6667use up_common::types::opaque::{Block, RuntimeId};6869macro_rules! no_runtime_err {70	($runtime_id:expr) => {71		format!(72			"No runtime valid runtime was found for chain {:#?}",73			$runtime_id74		)75	};76}7778fn load_spec(id: &str) -> std::result::Result<Box<dyn sc_service::ChainSpec>, String> {79	Ok(match id {80		"dev" => Box::new(chain_spec::development_config()),81		"" | "local" => Box::new(chain_spec::local_testnet_config()),82		path => {83			let path = std::path::PathBuf::from(path);84			#[allow(clippy::redundant_clone)]85			let chain_spec = Box::new(chain_spec::OpalChainSpec::from_json_file(path.clone())?)86				as Box<dyn sc_service::ChainSpec>;8788			match chain_spec.runtime_id() {89				#[cfg(feature = "unique-runtime")]90				RuntimeId::Unique => Box::new(chain_spec::UniqueChainSpec::from_json_file(path)?),9192				#[cfg(feature = "quartz-runtime")]93				RuntimeId::Quartz => Box::new(chain_spec::QuartzChainSpec::from_json_file(path)?),9495				RuntimeId::Opal => chain_spec,96				runtime_id => return Err(no_runtime_err!(runtime_id)),97			}98		}99	})100}101102impl SubstrateCli for Cli {103	// TODO use args104	fn impl_name() -> String {105		format!("{} Node", Self::node_name())106	}107108	fn impl_version() -> String {109		env!("SUBSTRATE_CLI_IMPL_VERSION").into()110	}111	// TODO use args112	fn description() -> String {113		format!(114			"{} Node\n\nThe command-line arguments provided first will be \115		passed to the parachain node, while the arguments provided after -- will be passed \116		to the relaychain node.\n\n\117		{} [parachain-args] -- [relaychain-args]",118			Self::node_name(),119			Self::executable_name()120		)121	}122123	fn author() -> String {124		env!("CARGO_PKG_AUTHORS").into()125	}126127	//TODO use args128	fn support_url() -> String {129		"support@unique.network".into()130	}131132	fn copyright_start_year() -> i32 {133		2019134	}135136	fn load_spec(&self, id: &str) -> std::result::Result<Box<dyn sc_service::ChainSpec>, String> {137		load_spec(id)138	}139140	fn native_runtime_version(chain_spec: &Box<dyn ChainSpec>) -> &'static RuntimeVersion {141		match chain_spec.runtime_id() {142			#[cfg(feature = "unique-runtime")]143			RuntimeId::Unique => &unique_runtime::VERSION,144145			#[cfg(feature = "quartz-runtime")]146			RuntimeId::Quartz => &quartz_runtime::VERSION,147148			RuntimeId::Opal => &opal_runtime::VERSION,149			runtime_id => panic!("{}", no_runtime_err!(runtime_id)),150		}151	}152}153154impl SubstrateCli for RelayChainCli {155	// TODO use args156	fn impl_name() -> String {157		format!("{} Node", Cli::node_name())158	}159160	fn impl_version() -> String {161		env!("SUBSTRATE_CLI_IMPL_VERSION").into()162	}163	// TODO use args164	fn description() -> String {165		format!(166			"{} Node\n\nThe command-line arguments provided first will be \167			passed to the parachain node, while the arguments provided after -- will be passed \168			to the relaychain node.\n\n\169			parachain-collator [parachain-args] -- [relaychain-args]",170			Cli::node_name()171		)172	}173174	fn author() -> String {175		env!("CARGO_PKG_AUTHORS").into()176	}177	// TODO use args178	fn support_url() -> String {179		"support@unique.network".into()180	}181182	fn copyright_start_year() -> i32 {183		2019184	}185186	fn load_spec(&self, id: &str) -> std::result::Result<Box<dyn sc_service::ChainSpec>, String> {187		polkadot_cli::Cli::from_iter([RelayChainCli::executable_name()].iter()).load_spec(id)188	}189190	fn native_runtime_version(chain_spec: &Box<dyn ChainSpec>) -> &'static RuntimeVersion {191		polkadot_cli::Cli::native_runtime_version(chain_spec)192	}193}194195macro_rules! async_run_with_runtime {196	(197		$runtime_api:path, $executor:path,198		$runner:ident, $components:ident, $cli:ident, $cmd:ident, $config:ident,199		$( $code:tt )*200	) => {201		$runner.async_run(|$config| {202			let $components = new_partial::<203				$runtime_api, $executor, _204			>(205				&$config,206				crate::service::parachain_build_import_queue,207			)?;208			let task_manager = $components.task_manager;209210			{ $( $code )* }.map(|v| (v, task_manager))211		})212	};213}214215macro_rules! construct_async_run {216	(|$components:ident, $cli:ident, $cmd:ident, $config:ident| $( $code:tt )* ) => {{217		let runner = $cli.create_runner($cmd)?;218219		match runner.config().chain_spec.runtime_id() {220			#[cfg(feature = "unique-runtime")]221			RuntimeId::Unique => async_run_with_runtime!(222				unique_runtime::RuntimeApi, UniqueRuntimeExecutor,223				runner, $components, $cli, $cmd, $config, $( $code )*224			),225226			#[cfg(feature = "quartz-runtime")]227			RuntimeId::Quartz => async_run_with_runtime!(228				quartz_runtime::RuntimeApi, QuartzRuntimeExecutor,229				runner, $components, $cli, $cmd, $config, $( $code )*230			),231232			RuntimeId::Opal => async_run_with_runtime!(233				opal_runtime::RuntimeApi, OpalRuntimeExecutor,234				runner, $components, $cli, $cmd, $config, $( $code )*235			),236237			runtime_id => Err(no_runtime_err!(runtime_id).into())238		}239	}}240}241242macro_rules! sync_run_with_runtime {243	(244		$runtime_api:path, $executor:path,245		$runner:ident, $components:ident, $cli:ident, $cmd:ident, $config:ident,246		$( $code:tt )*247	) => {248		$runner.sync_run(|$config| {249			$( $code )*250		})251	};252}253254macro_rules! construct_sync_run {255	(|$components:ident, $cli:ident, $cmd:ident, $config:ident| $( $code:tt )* ) => {{256		let runner = $cli.create_runner($cmd)?;257258		match runner.config().chain_spec.runtime_id() {259			#[cfg(feature = "unique-runtime")]260			RuntimeId::Unique => sync_run_with_runtime!(261				unique_runtime::RuntimeApi, UniqueRuntimeExecutor,262				runner, $components, $cli, $cmd, $config, $( $code )*263			),264265			#[cfg(feature = "quartz-runtime")]266			RuntimeId::Quartz => sync_run_with_runtime!(267				quartz_runtime::RuntimeApi, QuartzRuntimeExecutor,268				runner, $components, $cli, $cmd, $config, $( $code )*269			),270271			RuntimeId::Opal => sync_run_with_runtime!(272				opal_runtime::RuntimeApi, OpalRuntimeExecutor,273				runner, $components, $cli, $cmd, $config, $( $code )*274			),275276			runtime_id => Err(no_runtime_err!(runtime_id).into())277		}278	}}279}280281macro_rules! start_node_using_chain_runtime {282	($start_node_fn:ident($config:expr $(, $($args:expr),+)?) $($code:tt)*) => {283		match $config.chain_spec.runtime_id() {284			#[cfg(feature = "unique-runtime")]285			RuntimeId::Unique => $start_node_fn::<286				unique_runtime::Runtime,287				unique_runtime::RuntimeApi,288				UniqueRuntimeExecutor,289			>($config $(, $($args),+)?) $($code)*,290291			#[cfg(feature = "quartz-runtime")]292			RuntimeId::Quartz => $start_node_fn::<293				quartz_runtime::Runtime,294				quartz_runtime::RuntimeApi,295				QuartzRuntimeExecutor,296			>($config $(, $($args),+)?) $($code)*,297298			RuntimeId::Opal => $start_node_fn::<299				opal_runtime::Runtime,300				opal_runtime::RuntimeApi,301				OpalRuntimeExecutor,302			>($config $(, $($args),+)?) $($code)*,303304			runtime_id => Err(no_runtime_err!(runtime_id).into()),305		}306	};307}308309/// Parse command line arguments into service configuration.310pub fn run() -> Result<()> {311	let cli = Cli::from_args();312313	match &cli.subcommand {314		Some(Subcommand::Key(cmd)) => cmd.run(&cli),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};416			use try_runtime_cli::block_building_info::timestamp_with_aura_info;417418			let runner = cli.create_runner(cmd)?;419420			// grab the task manager.421			let registry = &runner422				.config()423				.prometheus_config424				.as_ref()425				.map(|cfg| &cfg.registry);426			let task_manager =427				sc_service::TaskManager::new(runner.config().tokio_handle.clone(), *registry)428					.map_err(|e| format!("Error: {e:?}"))?;429			let info_provider = Some(timestamp_with_aura_info(12000));430431			runner.async_run(|config| -> Result<(Pin<Box<dyn Future<Output = _>>>, _)> {432				Ok((433					match config.chain_spec.runtime_id() {434						#[cfg(feature = "unique-runtime")]435						RuntimeId::Unique => Box::pin(cmd.run::<Block, ExtendedHostFunctions<436							sp_io::SubstrateHostFunctions,437							<UniqueRuntimeExecutor as NativeExecutionDispatch>::ExtendHostFunctions,438						>, _>(info_provider)),439440						#[cfg(feature = "quartz-runtime")]441						RuntimeId::Quartz => Box::pin(cmd.run::<Block, ExtendedHostFunctions<442							sp_io::SubstrateHostFunctions,443							<QuartzRuntimeExecutor as NativeExecutionDispatch>::ExtendHostFunctions,444						>, _>(info_provider)),445446						RuntimeId::Opal => Box::pin(cmd.run::<Block, ExtendedHostFunctions<447							sp_io::SubstrateHostFunctions,448							<OpalRuntimeExecutor as NativeExecutionDispatch>::ExtendHostFunctions,449						>, _>(info_provider)),450						runtime_id => return Err(no_runtime_err!(runtime_id).into()),451					},452					task_manager,453				))454			})455		}456		#[cfg(not(feature = "try-runtime"))]457		Some(Subcommand::TryRuntime) => {458			Err("Try-runtime must be enabled by `--features try-runtime`.".into())459		}460		None => {461			let runner = cli.create_runner(&cli.run.normalize())?;462			let collator_options = cli.run.collator_options();463464			runner.run_node_until_exit(|config| async move {465				let hwbench = if !cli.no_hardware_benchmarks {466					config.database.path().map(|database_path| {467						let _ = std::fs::create_dir_all(database_path);468						sc_sysinfo::gather_hwbench(Some(database_path))469					})470				} else {471					None472				};473474				let extensions = chain_spec::Extensions::try_get(&*config.chain_spec);475476				let service_id = config.chain_spec.service_id();477				let relay_chain_id = extensions.map(|e| e.relay_chain.clone());478				let is_dev_service = matches![service_id, ServiceId::Dev]479					|| relay_chain_id == Some("dev-service".into());480481				if is_dev_service {482					info!("Running Dev service");483484					let autoseal_interval = Duration::from_millis(cli.idle_autoseal_interval);485486					let mut config = config;487488					config.state_pruning = Some(sc_service::PruningMode::ArchiveAll);489490					return start_node_using_chain_runtime! {491						start_dev_node(config, autoseal_interval, cli.disable_autoseal_on_tx).map_err(Into::into)492					};493				};494495				let para_id = extensions496					.map(|e| e.para_id)497					.ok_or("Could not find parachain ID in chain-spec.")?;498499				let polkadot_cli = RelayChainCli::new(500					&config,501					[RelayChainCli::executable_name()]502						.iter()503						.chain(cli.relaychain_args.iter()),504				);505506				let para_id = ParaId::from(para_id);507508				let parachain_account =509					AccountIdConversion::<polkadot_primitives::AccountId>::into_account_truncating(510						&para_id,511					);512513				let state_version = Cli::native_runtime_version(&config.chain_spec).state_version();514				let block: Block = generate_genesis_block(&*config.chain_spec, state_version)515					.map_err(|e| format!("{e:?}"))?;516				let genesis_state = format!("0x{:?}", HexDisplay::from(&block.header().encode()));517				let genesis_hash = format!("0x{:?}", HexDisplay::from(&block.header().hash().0));518519				let polkadot_config = SubstrateCli::create_configuration(520					&polkadot_cli,521					&polkadot_cli,522					config.tokio_handle.clone(),523				)524				.map_err(|err| format!("Relay chain argument error: {err}"))?;525526				info!("Parachain id: {:?}", para_id);527				info!("Parachain Account: {}", parachain_account);528				info!("Parachain genesis state: {}", genesis_state);529				info!("Parachain genesis hash: {}", genesis_hash);530				debug!("Parachain genesis block: {:?}", block);531				info!(532					"Is collating: {}",533					if config.role.is_authority() {534						"yes"535					} else {536						"no"537					}538				);539540				start_node_using_chain_runtime! {541					start_node(config, polkadot_config, collator_options, para_id, hwbench)542						.await543						.map(|r| r.0)544						.map_err(Into::into)545				}546			})547		}548	}549}550551impl DefaultConfigurationValues for RelayChainCli {552	fn p2p_listen_port() -> u16 {553		30334554	}555556	fn rpc_listen_port() -> u16 {557		9945558	}559560	fn prometheus_listen_port() -> u16 {561		9616562	}563}564565impl CliConfiguration<Self> for RelayChainCli {566	fn shared_params(&self) -> &SharedParams {567		self.base.base.shared_params()568	}569570	fn import_params(&self) -> Option<&ImportParams> {571		self.base.base.import_params()572	}573574	fn network_params(&self) -> Option<&NetworkParams> {575		self.base.base.network_params()576	}577578	fn keystore_params(&self) -> Option<&KeystoreParams> {579		self.base.base.keystore_params()580	}581582	fn base_path(&self) -> Result<Option<BasePath>> {583		Ok(self584			.shared_params()585			.base_path()?586			.or_else(|| Some(self.base_path.clone().into())))587	}588589	fn prometheus_config(590		&self,591		default_listen_port: u16,592		chain_spec: &Box<dyn ChainSpec>,593	) -> Result<Option<PrometheusConfig>> {594		self.base595			.base596			.prometheus_config(default_listen_port, chain_spec)597	}598599	fn init<F>(600		&self,601		_support_url: &String,602		_impl_version: &String,603		_logger_hook: F,604		_config: &sc_service::Configuration,605	) -> Result<()> {606		unreachable!("PolkadotCli is never initialized; qed");607	}608609	fn chain_id(&self, is_dev: bool) -> Result<String> {610		let chain_id = self.base.base.chain_id(is_dev)?;611612		Ok(if chain_id.is_empty() {613			self.chain_id.clone().unwrap_or_default()614		} else {615			chain_id616		})617	}618619	fn role(&self, is_dev: bool) -> Result<sc_service::Role> {620		self.base.base.role(is_dev)621	}622623	fn transaction_pool(&self, is_dev: bool) -> Result<sc_service::config::TransactionPoolOptions> {624		self.base.base.transaction_pool(is_dev)625	}626627	fn rpc_methods(&self) -> Result<sc_service::config::RpcMethods> {628		self.base.base.rpc_methods()629	}630631	fn rpc_max_connections(&self) -> Result<u32> {632		self.base.base.rpc_max_connections()633	}634635	fn rpc_cors(&self, is_dev: bool) -> Result<Option<Vec<String>>> {636		self.base.base.rpc_cors(is_dev)637	}638639	fn default_heap_pages(&self) -> Result<Option<u64>> {640		self.base.base.default_heap_pages()641	}642643	fn force_authoring(&self) -> Result<bool> {644		self.base.base.force_authoring()645	}646647	fn disable_grandpa(&self) -> Result<bool> {648		self.base.base.disable_grandpa()649	}650651	fn max_runtime_instances(&self) -> Result<Option<usize>> {652		self.base.base.max_runtime_instances()653	}654655	fn announce_block(&self) -> Result<bool> {656		self.base.base.announce_block()657	}658659	fn telemetry_endpoints(660		&self,661		chain_spec: &Box<dyn ChainSpec>,662	) -> Result<Option<sc_telemetry::TelemetryEndpoints>> {663		self.base.base.telemetry_endpoints(chain_spec)664	}665}