// Copyright (C) Parity Technologies (UK) Ltd. // This file is part of Pezcumulus. // SPDX-License-Identifier: Apache-2.0 // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. use crate::{ cli::{Cli, RelayChainCli, Subcommand}, common::{ chain_spec::LoadSpec, runtime::{ AuraConsensusId, Consensus, Runtime, RuntimeResolver as RuntimeResolverT, RuntimeResolver, }, spec::DynNodeSpec, types::Block, NodeBlock, NodeExtraArgs, }, extra_subcommand::DefaultExtraSubcommands, fake_runtime_api, runtime::BlockNumber, }; use clap::{CommandFactory, FromArgMatches}; #[cfg(feature = "runtime-benchmarks")] use cumulus_client_service::storage_proof_size::HostFunctions as ReclaimHostFunctions; use pezframe_benchmarking_cli::{BenchmarkCmd, BIZINIKIWI_REFERENCE_HARDWARE}; use log::info; use pezsc_cli::{Result, BizinikiwiCli}; #[cfg(feature = "runtime-benchmarks")] use pezsp_runtime::traits::HashingFor; /// Structure that can be used in order to provide customizers for different functionalities of the /// node binary that is being built using this library. pub struct RunConfig { /// A custom chain spec loader. pub chain_spec_loader: Box, /// A custom runtime resolver. pub runtime_resolver: Box, } impl RunConfig { /// Creates a new `RunConfig` instance. pub fn new( runtime_resolver: Box, chain_spec_loader: Box, ) -> Self { RunConfig { runtime_resolver, chain_spec_loader } } } pub fn new_aura_node_spec( aura_id: AuraConsensusId, extra_args: &NodeExtraArgs, ) -> Box where Block: NodeBlock, { match aura_id { AuraConsensusId::Sr25519 => crate::nodes::aura::new_aura_node_spec::< Block, fake_runtime_api::aura_sr25519::RuntimeApi, pezsp_consensus_aura::sr25519::AuthorityId, >(extra_args), AuraConsensusId::Ed25519 => crate::nodes::aura::new_aura_node_spec::< Block, fake_runtime_api::aura_ed25519::RuntimeApi, pezsp_consensus_aura::ed25519::AuthorityId, >(extra_args), } } fn new_node_spec( config: &pezsc_service::Configuration, runtime_resolver: &Box, extra_args: &NodeExtraArgs, ) -> std::result::Result, pezsc_cli::Error> { let runtime = runtime_resolver.runtime(config.chain_spec.as_ref())?; Ok(match runtime { Runtime::Omni(block_number, consensus) => match (block_number, consensus) { (BlockNumber::U32, Consensus::Aura(aura_id)) => new_aura_node_spec::>(aura_id, extra_args), (BlockNumber::U64, Consensus::Aura(aura_id)) => new_aura_node_spec::>(aura_id, extra_args), }, }) } /// Parse command line arguments into service configuration. pub fn run(cmd_config: RunConfig) -> Result<()> { run_with_custom_cli::(cmd_config) } /// Parse command‑line arguments into service configuration and inject an /// optional extra sub‑command. /// /// `run_with_custom_cli` builds the base CLI for the node binary, then asks the /// `Extra` type for an optional extra sub‑command. /// /// When the user actually invokes that extra sub‑command, /// `Extra::from_arg_matches` returns a parsed value which is immediately passed /// to `extra.handle(&cfg)` and the process exits. Otherwise control falls /// through to the normal node‑startup / utility sub‑command match. /// /// # Type Parameters /// * `CliConfig` – customization trait supplying user‑facing info (name, description, version) for /// the binary. /// * `Extra` – an implementation of `ExtraSubcommand`. Use *`NoExtraSubcommand`* if the binary /// should not expose any extra subcommands. pub fn run_with_custom_cli(cmd_config: RunConfig) -> Result<()> where CliConfig: crate::cli::CliConfig, ExtraSubcommand: crate::extra_subcommand::ExtraSubcommand, { let cli_command = Cli::::command(); let cli_command = ExtraSubcommand::augment_subcommands(cli_command); let cli_command = Cli::::setup_command(cli_command); // Get matches for all CLI, including extra args. let matches = cli_command.get_matches(); // Parse only the part corresponding to the extra args. if let Ok(extra) = ExtraSubcommand::from_arg_matches(&matches) { // Handle the extra, and return - subcommands are self contained, // no need to handle the rest of the CLI or node running. extra.handle(&cmd_config)?; return Ok(()); } // If matching on the extra subcommands fails, match on the rest of the node CLI as usual. let mut cli = Cli::::from_arg_matches(&matches).map_err(|e| pezsc_cli::Error::Cli(e.into()))?; cli.chain_spec_loader = Some(cmd_config.chain_spec_loader); #[allow(deprecated)] match &cli.subcommand { Some(Subcommand::BuildSpec(cmd)) => { let runner = cli.create_runner(cmd)?; runner.sync_run(|config| cmd.run(config.chain_spec, config.network)) }, Some(Subcommand::CheckBlock(cmd)) => { let runner = cli.create_runner(cmd)?; runner.async_run(|config| { let node = new_node_spec(&config, &cmd_config.runtime_resolver, &cli.node_extra_args())?; node.prepare_check_block_cmd(config, cmd) }) }, Some(Subcommand::ExportBlocks(cmd)) => { let runner = cli.create_runner(cmd)?; runner.async_run(|config| { let node = new_node_spec(&config, &cmd_config.runtime_resolver, &cli.node_extra_args())?; node.prepare_export_blocks_cmd(config, cmd) }) }, Some(Subcommand::ExportState(cmd)) => { let runner = cli.create_runner(cmd)?; runner.async_run(|config| { let node = new_node_spec(&config, &cmd_config.runtime_resolver, &cli.node_extra_args())?; node.prepare_export_state_cmd(config, cmd) }) }, Some(Subcommand::ImportBlocks(cmd)) => { let runner = cli.create_runner(cmd)?; runner.async_run(|config| { let node = new_node_spec(&config, &cmd_config.runtime_resolver, &cli.node_extra_args())?; node.prepare_import_blocks_cmd(config, cmd) }) }, Some(Subcommand::Revert(cmd)) => { let runner = cli.create_runner(cmd)?; runner.async_run(|config| { let node = new_node_spec(&config, &cmd_config.runtime_resolver, &cli.node_extra_args())?; node.prepare_revert_cmd(config, cmd) }) }, Some(Subcommand::ChainSpecBuilder(cmd)) => cmd.run().map_err(|err| pezsc_cli::Error::Application(err.into())), Some(Subcommand::PurgeChain(cmd)) => { let runner = cli.create_runner(cmd)?; let pezkuwi_cli = RelayChainCli::::new(runner.config(), cli.relay_chain_args.iter()); runner.sync_run(|config| { let pezkuwi_config = BizinikiwiCli::create_configuration( &pezkuwi_cli, &pezkuwi_cli, config.tokio_handle.clone(), ) .map_err(|err| format!("Relay chain argument error: {}", err))?; cmd.run(config, pezkuwi_config) }) }, Some(Subcommand::ExportGenesisHead(cmd)) => { let runner = cli.create_runner(cmd)?; runner.sync_run(|config| { let node = new_node_spec(&config, &cmd_config.runtime_resolver, &cli.node_extra_args())?; node.run_export_genesis_head_cmd(config, cmd) }) }, Some(Subcommand::ExportGenesisWasm(cmd)) => { let runner = cli.create_runner(cmd)?; runner.sync_run(|_config| { let spec = cli.load_spec(&cmd.shared_params.chain.clone().unwrap_or_default())?; cmd.run(&*spec) }) }, Some(Subcommand::Benchmark(cmd)) => { // Switch on the concrete benchmark sub-command- match cmd { #[cfg(feature = "runtime-benchmarks")] BenchmarkCmd::Pallet(cmd) => { let chain = cmd .shared_params .chain .as_ref() .map(|chain| cli.load_spec(&chain)) .transpose()?; cmd.run_with_spec::>, ReclaimHostFunctions>(chain) }, BenchmarkCmd::Block(cmd) => { // The command needs the full node configuration because it uses the node // client and the database source, which in its turn has a dependency on the // chain spec, given via the `--chain` flag. let runner = cli.create_runner(cmd)?; runner.sync_run(|config| { let node = new_node_spec( &config, &cmd_config.runtime_resolver, &cli.node_extra_args(), )?; node.run_benchmark_block_cmd(config, cmd) }) }, #[cfg(feature = "runtime-benchmarks")] BenchmarkCmd::Storage(cmd) => { // The command needs the full node configuration because it uses the node // client and the database API, storage and shared_trie_cache. It requires // the `--chain` flag to be passed. let runner = cli.create_runner(cmd)?; runner.sync_run(|config| { let node = new_node_spec( &config, &cmd_config.runtime_resolver, &cli.node_extra_args(), )?; node.run_benchmark_storage_cmd(config, cmd) }) }, BenchmarkCmd::Machine(cmd) => { // The command needs the full node configuration, and implicitly a chain // spec to be passed, even if it doesn't use it directly. The `--chain` flag is // relevant in determining the database path, which is used for the disk // benchmark. // // TODO: change `machine` subcommand to take instead a disk path we want to // benchmark?. let runner = cli.create_runner(cmd)?; runner.sync_run(|config| cmd.run(&config, BIZINIKIWI_REFERENCE_HARDWARE.clone())) }, #[allow(unreachable_patterns)] _ => Err("Benchmarking sub-command unsupported or compilation feature missing. \ Make sure to compile omni-node with --features=runtime-benchmarks \ to enable all supported benchmarks." .into()), } }, Some(Subcommand::Key(cmd)) => Ok(cmd.run(&cli)?), None => { let runner = cli.create_runner(&cli.run.normalize())?; let pezkuwi_cli = RelayChainCli::::new(runner.config(), cli.relay_chain_args.iter()); let collator_options = cli.run.collator_options(); if cli.experimental_use_slot_based { log::warn!( "Deprecated: The flag --experimental-use-slot-based is no longer \ supported. Please use --authoring slot-based instead. This feature will be removed \ after May 2025." ); } runner.run_node_until_exit(|config| async move { let node_spec = new_node_spec(&config, &cmd_config.runtime_resolver, &cli.node_extra_args())?; if let Some(dev_mode) = cli.dev_mode() { return node_spec.start_dev_node(config, dev_mode).map_err(Into::into); } // If Statemint (Statemine, Westmint, Rockmine) DB exists and we're using the // asset-hub chain spec, then rename the base path to the new chain ID. In the case // that both file paths exist, the node will exit, as the user must decide (by // deleting one path) the information that they want to use as their DB. let old_name = match config.chain_spec.id() { "asset-hub-pezkuwi" => Some("statemint"), "asset-hub-kusama" => Some("statemine"), "asset-hub-zagros" => Some("westmint"), "asset-hub-pezkuwichain" => Some("rockmine"), _ => None, }; if let Some(old_name) = old_name { let new_path = config.base_path.config_dir(config.chain_spec.id()); let old_path = config.base_path.config_dir(old_name); if old_path.exists() && new_path.exists() { return Err(format!( "Found legacy {} path {} and new Asset Hub path {}. \ Delete one path such that only one exists.", old_name, old_path.display(), new_path.display() ) .into()); } if old_path.exists() { std::fs::rename(old_path.clone(), new_path.clone())?; info!( "{} was renamed to Asset Hub. The filepath with associated data on disk \ has been renamed from {} to {}.", old_name, old_path.display(), new_path.display() ); } } let hwbench = (!cli.no_hardware_benchmarks) .then(|| { config.database.path().map(|database_path| { let _ = std::fs::create_dir_all(database_path); pezsc_sysinfo::gather_hwbench( Some(database_path), &BIZINIKIWI_REFERENCE_HARDWARE, ) }) }) .flatten(); let tokio_handle = config.tokio_handle.clone(); let pezkuwi_config = BizinikiwiCli::create_configuration(&pezkuwi_cli, &pezkuwi_cli, tokio_handle) .map_err(|err| format!("Relay chain argument error: {}", err))?; info!("✍️ Is collating: {}", if config.role.is_authority() { "yes" } else { "no" }); node_spec .start_node( config, pezkuwi_config, collator_options, hwbench, cli.node_extra_args(), ) .await .map_err(Into::into) }) }, } }