cli.rs 3.22 KB
Newer Older
Gavin Wood's avatar
Gavin Wood committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
// Copyright 2017-2020 Parity Technologies (UK) Ltd.
// This file is part of Polkadot.

// Polkadot 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.

// Polkadot 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 Polkadot.  If not, see <http://www.gnu.org/licenses/>.

//! Polkadot CLI library.

use structopt::StructOpt;

#[allow(missing_docs)]
22
#[derive(Debug, StructOpt)]
Gavin Wood's avatar
Gavin Wood committed
23
pub enum Subcommand {
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
	/// Build a chain specification.
	BuildSpec(sc_cli::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),
Gavin Wood's avatar
Gavin Wood committed
44
45
46
47

	#[allow(missing_docs)]
	#[structopt(name = "validation-worker", setting = structopt::clap::AppSettings::Hidden)]
	ValidationWorker(ValidationWorkerCommand),
48
49
50
51
52
53
54

	/// The custom benchmark subcommmand benchmarking runtime pallets.
	#[structopt(
		name = "benchmark",
		about = "Benchmark runtime pallets."
	)]
	Benchmark(frame_benchmarking_cli::BenchmarkCmd),
Bastian Köcher's avatar
Bastian Köcher committed
55
56
57

	/// Key management cli utilities
	Key(sc_cli::KeySubcommand),
Gavin Wood's avatar
Gavin Wood committed
58
59
60
}

#[allow(missing_docs)]
61
#[derive(Debug, StructOpt)]
Gavin Wood's avatar
Gavin Wood committed
62
pub struct ValidationWorkerCommand {
63
64
	/// The path that the executor can use for its caching purposes.
	pub cache_base_path: std::path::PathBuf,
65

Gavin Wood's avatar
Gavin Wood committed
66
67
68
69
	#[allow(missing_docs)]
	pub mem_id: String,
}

Gavin Wood's avatar
Gavin Wood committed
70
#[allow(missing_docs)]
71
#[derive(Debug, StructOpt)]
Gavin Wood's avatar
Gavin Wood committed
72
73
74
75
76
77
78
79
pub struct RunCmd {
	#[allow(missing_docs)]
	#[structopt(flatten)]
	pub base: sc_cli::RunCmd,

	/// Force using Kusama native runtime.
	#[structopt(long = "force-kusama")]
	pub force_kusama: bool,
Gavin Wood's avatar
Gavin Wood committed
80

ddorgan's avatar
ddorgan committed
81
82
83
84
	/// Force using Westend native runtime.
	#[structopt(long = "force-westend")]
	pub force_westend: bool,

85
86
87
88
	/// Force using Rococo native runtime.
	#[structopt(long = "force-rococo")]
	pub force_rococo: bool,

89
90
91
92
93
94
95
96
	/// Setup a GRANDPA scheduled voting pause.
	///
	/// This parameter takes two values, namely a block number and a delay (in
	/// blocks). After the given block number is finalized the GRANDPA voter
	/// will temporarily stop voting for new blocks until the given delay has
	/// elapsed (i.e. until a block at height `pause_block + delay` is imported).
	#[structopt(long = "grandpa-pause", number_of_values(2))]
	pub grandpa_pause: Vec<u32>,
97
98
99
100
101
102
103

	/// Add the destination address to the jaeger agent.
	///
	/// Must be valid socket address, of format `IP:Port`
	/// commonly `127.0.0.1:6831`.
	#[structopt(long)]
	pub jaeger_agent: Option<std::net::SocketAddr>,
Gavin Wood's avatar
Gavin Wood committed
104
}
105
106

#[allow(missing_docs)]
107
#[derive(Debug, StructOpt)]
108
109
110
111
112
113
pub struct Cli {
	#[structopt(subcommand)]
	pub subcommand: Option<Subcommand>,
	#[structopt(flatten)]
	pub run: RunCmd,
}