Lines
41.18 %
Functions
4.17 %
Branches
100 %
// Copyright (C) Moondance Labs Ltd.
// This file is part of Tanssi.
// Tanssi is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// Tanssi is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
// You should have received a copy of the GNU General Public License
// along with Tanssi. If not, see <http://www.gnu.org/licenses/>
//! Polkadot CLI library.
pub use polkadot_node_primitives::NODE_VERSION;
use {
clap::Parser,
sc_cli::{CliConfiguration, NodeKeyParams, SharedParams},
std::path::PathBuf,
};
#[allow(missing_docs)]
#[derive(Debug, Parser)]
pub enum Subcommand {
/// Build a chain specification.
BuildSpec(BuildSpecCmd),
/// Validate blocks.
CheckBlock(sc_cli::CheckBlockCmd),
/// Export blocks.
ExportBlocks(sc_cli::ExportBlocksCmd),
/// Export the state of a given block into a chain spec.
ExportState(sc_cli::ExportStateCmd),
/// Import blocks.
ImportBlocks(sc_cli::ImportBlocksCmd),
/// Remove the whole chain.
PurgeChain(sc_cli::PurgeChainCmd),
/// Revert the chain to a previous state.
Revert(sc_cli::RevertCmd),
/// Sub-commands concerned with benchmarking.
/// The pallet benchmarking moved to the `pallet` sub-command.
#[command(subcommand)]
Benchmark(frame_benchmarking_cli::BenchmarkCmd),
/// Key management CLI utilities
Key(sc_cli::KeySubcommand),
/// Precompile the WASM runtime into native code
PrecompileWasm(sc_cli::PrecompileWasmCmd),
/// Db meta columns information.
ChainInfo(sc_cli::ChainInfoCmd),
}
/// The `build-spec` command used to build a specification.
#[derive(Debug, Clone, clap::Parser)]
pub struct BuildSpecCmd {
/// Base cmd.
#[clap(flatten)]
pub base: sc_cli::BuildSpecCmd,
/// List of container chain chain spec paths to add to genesis.
#[arg(long)]
pub add_container_chain: Option<Vec<String>>,
/// List of container chain chain spec mocks to add to genesis.
pub mock_container_chain: Option<Vec<u32>>,
/// List of invulnerable collators to write to pallet_invulnerables genesis.
pub invulnerable: Option<Vec<String>>,
impl CliConfiguration for BuildSpecCmd {
fn shared_params(&self) -> &SharedParams {
&self.base.shared_params
fn node_key_params(&self) -> Option<&NodeKeyParams> {
Some(&self.base.node_key_params)
#[group(skip)]
pub struct RunCmd {
pub base: sc_cli::RunCmd,
/// Force using Dancelight native runtime.
#[arg(long = "force-dancelight")]
pub force_dancelight: bool,
/// Disable the BEEFY gadget.
///
/// Currently enabled by default on 'Dancelight'.
pub no_beefy: bool,
/// Allows a validator to run insecurely outside of Secure Validator Mode. Security features
/// are still enabled on a best-effort basis, but missing features are no longer required. For
/// more information see <https://github.com/w3f/polkadot-wiki/issues/4881>.
#[arg(long = "insecure-validator-i-know-what-i-do", requires = "validator")]
pub insecure_validator: bool,
/// Enable the block authoring backoff that is triggered when finality is lagging.
pub force_authoring_backoff: bool,
/// Add the destination address to the `pyroscope` agent.
/// Must be valid socket address, of format `IP:Port` (commonly `127.0.0.1:4040`).
pub pyroscope_server: Option<String>,
/// Disable automatic hardware benchmarks.
/// By default these benchmarks are automatically ran at startup and measure
/// the CPU speed, the memory bandwidth and the disk speed.
/// The results are then printed out in the logs, and also sent as part of
/// telemetry, if telemetry is enabled.
pub no_hardware_benchmarks: bool,
/// Overseer message capacity override.
/// **Dangerous!** Do not touch unless explicitly advised to.
pub overseer_channel_capacity_override: Option<usize>,
/// Path to the directory where auxiliary worker binaries reside.
/// If not specified, the main binary's directory is searched first, then
/// `/usr/lib/polkadot` is searched.
/// TESTING ONLY: if the path points to an executable rather then directory,
/// that executable is used both as preparation and execution worker.
#[arg(long, value_name = "PATH")]
pub workers_path: Option<PathBuf>,
/// Override the maximum number of pvf execute workers.
pub execute_workers_max_num: Option<usize>,
/// Override the maximum number of pvf workers that can be spawned in the pvf prepare
/// pool for tasks with the priority below critical.
pub prepare_workers_soft_max_num: Option<usize>,
/// Override the absolute number of pvf workers that can be spawned in the pvf prepare pool.
pub prepare_workers_hard_max_num: Option<usize>,
/// TESTING ONLY: disable the version check between nodes and workers.
#[arg(long, hide = true)]
pub disable_worker_version_check: bool,
/// Enable approval-voting message processing in parallel.
///**Dangerous!** This is an experimental feature and should not be used in production, unless
/// explicitly advised to.
pub enable_approval_voting_parallel: bool,
// Enable the development service
pub dev_service: bool,
/// How long finalized data should be kept in the availability store (in hours).
/// Only used for testnets. If not specified, set to 1 hour. Always set to 25 hours for live
/// networks.
pub keep_finalized_for: Option<u32>,
pub struct Cli {
pub subcommand: Option<Subcommand>,
pub run: RunCmd,
pub storage_monitor: sc_storage_monitor::StorageMonitorParams,