git.delta.rocks / unique-network / refs/commits / 8da8a842a17a

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, time::Duration};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_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		format!("{} Node", Self::node_name())103	}104105	fn impl_version() -> String {106		env!("SUBSTRATE_CLI_IMPL_VERSION").into()107	}108	// TODO use args109	fn description() -> String {110		format!(111			"{} 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::node_name(),116			Self::executable_name()117		)118	}119120	fn author() -> String {121		env!("CARGO_PKG_AUTHORS").into()122	}123124	//TODO use args125	fn support_url() -> String {126		"support@unique.network".into()127	}128129	fn copyright_start_year() -> i32 {130		2019131	}132133	fn load_spec(&self, id: &str) -> std::result::Result<Box<dyn sc_service::ChainSpec>, String> {134		load_spec(id)135	}136137	fn native_runtime_version(chain_spec: &Box<dyn ChainSpec>) -> &'static RuntimeVersion {138		match chain_spec.runtime_id() {139			#[cfg(feature = "unique-runtime")]140			RuntimeId::Unique => &unique_runtime::VERSION,141142			#[cfg(feature = "quartz-runtime")]143			RuntimeId::Quartz => &quartz_runtime::VERSION,144145			RuntimeId::Opal => &opal_runtime::VERSION,146			RuntimeId::Unknown(chain) => panic!("{}", no_runtime_err!(chain)),147		}148	}149}150151impl SubstrateCli for RelayChainCli {152	// TODO use args153	fn impl_name() -> String {154		format!("{} Node", Cli::node_name())155	}156157	fn impl_version() -> String {158		env!("SUBSTRATE_CLI_IMPL_VERSION").into()159	}160	// TODO use args161	fn description() -> String {162		format!(163			"{} Node\n\nThe command-line arguments provided first will be \164			passed to the parachain node, while the arguments provided after -- will be passed \165			to the relaychain node.\n\n\166			parachain-collator [parachain-args] -- [relaychain-args]",167			Cli::node_name()168		)169	}170171	fn author() -> String {172		env!("CARGO_PKG_AUTHORS").into()173	}174	// TODO use args175	fn support_url() -> String {176		"support@unique.network".into()177	}178179	fn copyright_start_year() -> i32 {180		2019181	}182183	fn load_spec(&self, id: &str) -> std::result::Result<Box<dyn sc_service::ChainSpec>, String> {184		polkadot_cli::Cli::from_iter([RelayChainCli::executable_name()].iter()).load_spec(id)185	}186187	fn native_runtime_version(chain_spec: &Box<dyn ChainSpec>) -> &'static RuntimeVersion {188		polkadot_cli::Cli::native_runtime_version(chain_spec)189	}190}191192#[allow(clippy::borrowed_box)]193fn extract_genesis_wasm(chain_spec: &Box<dyn sc_service::ChainSpec>) -> Result<Vec<u8>> {194	let mut storage = chain_spec.build_storage()?;195196	storage197		.top198		.remove(sp_core::storage::well_known_keys::CODE)199		.ok_or_else(|| "Could not find wasm file in genesis state!".into())200}201202macro_rules! async_run_with_runtime {203	(204		$runtime_api:path, $executor:path,205		$runner:ident, $components:ident, $cli:ident, $cmd:ident, $config:ident,206		$( $code:tt )*207	) => {208		$runner.async_run(|$config| {209			let $components = new_partial::<210				$runtime_api, $executor, _211			>(212				&$config,213				crate::service::parachain_build_import_queue,214			)?;215			let task_manager = $components.task_manager;216217			{ $( $code )* }.map(|v| (v, task_manager))218		})219	};220}221222macro_rules! construct_async_run {223	(|$components:ident, $cli:ident, $cmd:ident, $config:ident| $( $code:tt )* ) => {{224		let runner = $cli.create_runner($cmd)?;225226		match runner.config().chain_spec.runtime_id() {227			#[cfg(feature = "unique-runtime")]228			RuntimeId::Unique => async_run_with_runtime!(229				unique_runtime::RuntimeApi, UniqueRuntimeExecutor,230				runner, $components, $cli, $cmd, $config, $( $code )*231			),232233			#[cfg(feature = "quartz-runtime")]234			RuntimeId::Quartz => async_run_with_runtime!(235				quartz_runtime::RuntimeApi, QuartzRuntimeExecutor,236				runner, $components, $cli, $cmd, $config, $( $code )*237			),238239			RuntimeId::Opal => async_run_with_runtime!(240				opal_runtime::RuntimeApi, OpalRuntimeExecutor,241				runner, $components, $cli, $cmd, $config, $( $code )*242			),243244			RuntimeId::Unknown(chain) => Err(no_runtime_err!(chain).into())245		}246	}}247}248249macro_rules! start_node_using_chain_runtime {250	($start_node_fn:ident($config:expr $(, $($args:expr),+)?) $($code:tt)*) => {251		match $config.chain_spec.runtime_id() {252			#[cfg(feature = "unique-runtime")]253			RuntimeId::Unique => $start_node_fn::<254				unique_runtime::Runtime,255				unique_runtime::RuntimeApi,256				UniqueRuntimeExecutor,257			>($config $(, $($args),+)?) $($code)*,258259			#[cfg(feature = "quartz-runtime")]260			RuntimeId::Quartz => $start_node_fn::<261				quartz_runtime::Runtime,262				quartz_runtime::RuntimeApi,263				QuartzRuntimeExecutor,264			>($config $(, $($args),+)?) $($code)*,265266			RuntimeId::Opal => $start_node_fn::<267				opal_runtime::Runtime,268				opal_runtime::RuntimeApi,269				OpalRuntimeExecutor,270			>($config $(, $($args),+)?) $($code)*,271272			RuntimeId::Unknown(chain) => Err(no_runtime_err!(chain).into()),273		}274	};275}276277/// Parse command line arguments into service configuration.278pub fn run() -> Result<()> {279	let cli = Cli::from_args();280281	match &cli.subcommand {282		Some(Subcommand::BuildSpec(cmd)) => {283			let runner = cli.create_runner(cmd)?;284			runner.sync_run(|config| cmd.run(config.chain_spec, config.network))285		}286		Some(Subcommand::CheckBlock(cmd)) => {287			construct_async_run!(|components, cli, cmd, config| {288				Ok(cmd.run(components.client, components.import_queue))289			})290		}291		Some(Subcommand::ExportBlocks(cmd)) => {292			construct_async_run!(|components, cli, cmd, config| {293				Ok(cmd.run(components.client, config.database))294			})295		}296		Some(Subcommand::ExportState(cmd)) => {297			construct_async_run!(|components, cli, cmd, config| {298				Ok(cmd.run(components.client, config.chain_spec))299			})300		}301		Some(Subcommand::ImportBlocks(cmd)) => {302			construct_async_run!(|components, cli, cmd, config| {303				Ok(cmd.run(components.client, components.import_queue))304			})305		}306		Some(Subcommand::PurgeChain(cmd)) => {307			let runner = cli.create_runner(cmd)?;308309			runner.sync_run(|config| {310				let polkadot_cli = RelayChainCli::new(311					&config,312					[RelayChainCli::executable_name()]313						.iter()314						.chain(cli.relaychain_args.iter()),315				);316317				let polkadot_config = SubstrateCli::create_configuration(318					&polkadot_cli,319					&polkadot_cli,320					config.tokio_handle.clone(),321				)322				.map_err(|err| format!("Relay chain argument error: {}", err))?;323324				cmd.run(config, polkadot_config)325			})326		}327		Some(Subcommand::Revert(cmd)) => construct_async_run!(|components, cli, cmd, config| {328			Ok(cmd.run(components.client, components.backend, None))329		}),330		Some(Subcommand::ExportGenesisState(params)) => {331			let mut builder = sc_cli::LoggerBuilder::new("");332			builder.with_profiling(sc_tracing::TracingReceiver::Log, "");333			let _ = builder.init();334335			let spec = load_spec(&params.chain.clone().unwrap_or_default())?;336			let state_version = Cli::native_runtime_version(&spec).state_version();337			let block: Block = generate_genesis_block(&spec, state_version)?;338			let raw_header = block.header().encode();339			let output_buf = if params.raw {340				raw_header341			} else {342				format!("0x{:?}", HexDisplay::from(&block.header().encode())).into_bytes()343			};344345			if let Some(output) = &params.output {346				std::fs::write(output, output_buf)?;347			} else {348				std::io::stdout().write_all(&output_buf)?;349			}350351			Ok(())352		}353		Some(Subcommand::ExportGenesisWasm(params)) => {354			let mut builder = sc_cli::LoggerBuilder::new("");355			builder.with_profiling(sc_tracing::TracingReceiver::Log, "");356			let _ = builder.init();357358			let raw_wasm_blob =359				extract_genesis_wasm(&cli.load_spec(&params.chain.clone().unwrap_or_default())?)?;360			let output_buf = if params.raw {361				raw_wasm_blob362			} else {363				format!("0x{:?}", HexDisplay::from(&raw_wasm_blob)).into_bytes()364			};365366			if let Some(output) = &params.output {367				std::fs::write(output, output_buf)?;368			} else {369				std::io::stdout().write_all(&output_buf)?;370			}371372			Ok(())373		}374		#[cfg(feature = "unique-runtime")]375		Some(Subcommand::Benchmark(cmd)) => {376			use frame_benchmarking_cli::BenchmarkCmd;377			let runner = cli.create_runner(cmd)?;378			// Switch on the concrete benchmark sub-command-379			match cmd {380				BenchmarkCmd::Pallet(cmd) => {381					if cfg!(feature = "runtime-benchmarks") {382						runner.sync_run(|config| cmd.run::<Block, UniqueRuntimeExecutor>(config))383					} else {384						Err("Benchmarking wasn't enabled when building the node. \385					You can enable it with `--features runtime-benchmarks`."386							.into())387					}388				}389				BenchmarkCmd::Block(cmd) => runner.sync_run(|config| {390					let partials = new_partial::<391						unique_runtime::RuntimeApi,392						UniqueRuntimeExecutor,393						_,394					>(&config, crate::service::parachain_build_import_queue)?;395					cmd.run(partials.client)396				}),397				BenchmarkCmd::Storage(cmd) => runner.sync_run(|config| {398					let partials = new_partial::<399						unique_runtime::RuntimeApi,400						UniqueRuntimeExecutor,401						_,402					>(&config, crate::service::parachain_build_import_queue)?;403					let db = partials.backend.expose_db();404					let storage = partials.backend.expose_storage();405406					cmd.run(config, partials.client.clone(), db, storage)407				}),408				BenchmarkCmd::Machine(cmd) => runner.sync_run(|config| cmd.run(&config)),409				BenchmarkCmd::Overhead(_) => Err("Unsupported benchmarking command".into()),410			}411		}412		#[cfg(not(feature = "unique-runtime"))]413		Some(Subcommand::Benchmark(..)) => {414			Err("benchmarking is only available with unique runtime enabled".into())415		}416		None => {417			let runner = cli.create_runner(&cli.run.normalize())?;418			let collator_options = cli.run.collator_options();419420			runner.run_node_until_exit(|config| async move {421				let extensions = chain_spec::Extensions::try_get(&*config.chain_spec);422423				let service_id = config.chain_spec.service_id();424				let relay_chain_id = extensions.map(|e| e.relay_chain.clone());425				let is_dev_service = matches![service_id, ServiceId::Dev]426					|| relay_chain_id == Some("dev-service".into());427428				if is_dev_service {429					info!("Running Dev service");430431					let autoseal_interval = Duration::from_millis(cli.idle_autoseal_interval);432433					return start_node_using_chain_runtime! {434						start_dev_node(config, autoseal_interval).map_err(Into::into)435					};436				};437438				let para_id = extensions439					.map(|e| e.para_id)440					.ok_or("Could not find parachain ID in chain-spec.")?;441442				let polkadot_cli = RelayChainCli::new(443					&config,444					[RelayChainCli::executable_name()]445						.iter()446						.chain(cli.relaychain_args.iter()),447				);448449				let para_id = ParaId::from(para_id);450451				let parachain_account =452					AccountIdConversion::<polkadot_primitives::v2::AccountId>::into_account(453						&para_id,454					);455456				let state_version =457					RelayChainCli::native_runtime_version(&config.chain_spec).state_version();458				let block: Block = generate_genesis_block(&config.chain_spec, state_version)459					.map_err(|e| format!("{:?}", e))?;460				let genesis_state = format!("0x{:?}", HexDisplay::from(&block.header().encode()));461				let genesis_hash = format!("0x{:?}", HexDisplay::from(&block.header().hash().0));462463				let polkadot_config = SubstrateCli::create_configuration(464					&polkadot_cli,465					&polkadot_cli,466					config.tokio_handle.clone(),467				)468				.map_err(|err| format!("Relay chain argument error: {}", err))?;469470				info!("Parachain id: {:?}", para_id);471				info!("Parachain Account: {}", parachain_account);472				info!("Parachain genesis state: {}", genesis_state);473				info!("Parachain genesis hash: {}", genesis_hash);474				info!(475					"Is collating: {}",476					if config.role.is_authority() {477						"yes"478					} else {479						"no"480					}481				);482483				start_node_using_chain_runtime! {484					start_node(config, polkadot_config, collator_options, para_id)485						.await486						.map(|r| r.0)487						.map_err(Into::into)488				}489			})490		}491	}492}493494impl DefaultConfigurationValues for RelayChainCli {495	fn p2p_listen_port() -> u16 {496		30334497	}498499	fn rpc_ws_listen_port() -> u16 {500		9945501	}502503	fn rpc_http_listen_port() -> u16 {504		9934505	}506507	fn prometheus_listen_port() -> u16 {508		9616509	}510}511512impl CliConfiguration<Self> for RelayChainCli {513	fn shared_params(&self) -> &SharedParams {514		self.base.base.shared_params()515	}516517	fn import_params(&self) -> Option<&ImportParams> {518		self.base.base.import_params()519	}520521	fn network_params(&self) -> Option<&NetworkParams> {522		self.base.base.network_params()523	}524525	fn keystore_params(&self) -> Option<&KeystoreParams> {526		self.base.base.keystore_params()527	}528529	fn base_path(&self) -> Result<Option<BasePath>> {530		Ok(self531			.shared_params()532			.base_path()533			.or_else(|| self.base_path.clone().map(Into::into)))534	}535536	fn rpc_http(&self, default_listen_port: u16) -> Result<Option<SocketAddr>> {537		self.base.base.rpc_http(default_listen_port)538	}539540	fn rpc_ipc(&self) -> Result<Option<String>> {541		self.base.base.rpc_ipc()542	}543544	fn rpc_ws(&self, default_listen_port: u16) -> Result<Option<SocketAddr>> {545		self.base.base.rpc_ws(default_listen_port)546	}547548	fn prometheus_config(549		&self,550		default_listen_port: u16,551		chain_spec: &Box<dyn ChainSpec>,552	) -> Result<Option<PrometheusConfig>> {553		self.base554			.base555			.prometheus_config(default_listen_port, chain_spec)556	}557558	fn init<F>(559		&self,560		_support_url: &String,561		_impl_version: &String,562		_logger_hook: F,563		_config: &sc_service::Configuration,564	) -> Result<()> {565		unreachable!("PolkadotCli is never initialized; qed");566	}567568	fn chain_id(&self, is_dev: bool) -> Result<String> {569		let chain_id = self.base.base.chain_id(is_dev)?;570571		Ok(if chain_id.is_empty() {572			self.chain_id.clone().unwrap_or_default()573		} else {574			chain_id575		})576	}577578	fn role(&self, is_dev: bool) -> Result<sc_service::Role> {579		self.base.base.role(is_dev)580	}581582	fn transaction_pool(&self) -> Result<sc_service::config::TransactionPoolOptions> {583		self.base.base.transaction_pool()584	}585586	fn state_cache_child_ratio(&self) -> Result<Option<usize>> {587		self.base.base.state_cache_child_ratio()588	}589590	fn rpc_methods(&self) -> Result<sc_service::config::RpcMethods> {591		self.base.base.rpc_methods()592	}593594	fn rpc_ws_max_connections(&self) -> Result<Option<usize>> {595		self.base.base.rpc_ws_max_connections()596	}597598	fn rpc_cors(&self, is_dev: bool) -> Result<Option<Vec<String>>> {599		self.base.base.rpc_cors(is_dev)600	}601602	fn default_heap_pages(&self) -> Result<Option<u64>> {603		self.base.base.default_heap_pages()604	}605606	fn force_authoring(&self) -> Result<bool> {607		self.base.base.force_authoring()608	}609610	fn disable_grandpa(&self) -> Result<bool> {611		self.base.base.disable_grandpa()612	}613614	fn max_runtime_instances(&self) -> Result<Option<usize>> {615		self.base.base.max_runtime_instances()616	}617618	fn announce_block(&self) -> Result<bool> {619		self.base.base.announce_block()620	}621622	fn telemetry_endpoints(623		&self,624		chain_spec: &Box<dyn ChainSpec>,625	) -> Result<Option<sc_telemetry::TelemetryEndpoints>> {626		self.base.base.telemetry_endpoints(chain_spec)627	}628}