lib.rs 7.02 KB
Newer Older
Gav's avatar
Gav committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// Copyright 2017 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.

#![warn(missing_docs)]
Arkadiy Paronyan's avatar
Arkadiy Paronyan committed
20
#![warn(unused_extern_crates)]
Gav's avatar
Gav committed
21

Gav Wood's avatar
Gav Wood committed
22
mod chain_spec;
23
24
#[cfg(feature = "browser")]
mod browser;
Gav Wood's avatar
Gav Wood committed
25

Arkadiy Paronyan's avatar
Arkadiy Paronyan committed
26
use chain_spec::ChainSpec;
27
28
29
use futures::{
	Future, FutureExt, TryFutureExt, future::select, channel::oneshot, compat::Future01CompatExt,
};
30
use tokio::runtime::Runtime;
31
use log::info;
32
use structopt::StructOpt;
33
34

pub use service::{
35
	AbstractService, CustomConfiguration, ProvideRuntimeApi, CoreApi, ParachainHost, IsKusama, self,
36
	WrappedExecutor
37
38
};

39
pub use cli::{VersionInfo, IntoExit, NoCustom, SharedParams};
Gavin Wood's avatar
Gavin Wood committed
40
pub use cli::{display_role, error};
Gavin Wood's avatar
Gavin Wood committed
41

42
43
/// Load the `ChainSpec` for the given `id`.
pub fn load_spec(id: &str) -> Result<Option<service::ChainSpec>, String> {
Arkadiy Paronyan's avatar
Arkadiy Paronyan committed
44
45
46
47
	Ok(match ChainSpec::from(id) {
		Some(spec) => Some(spec.load()?),
		None => None,
	})
48
49
}

50
51
#[derive(Debug, StructOpt, Clone)]
enum PolkadotSubCommands {
52
	#[structopt(name = "validation-worker", setting = structopt::clap::AppSettings::Hidden)]
Gavin Wood's avatar
Gavin Wood committed
53
	ValidationWorker(ValidationWorkerCommand),
54
55
}

Gavin Wood's avatar
Gavin Wood committed
56
57
impl cli::GetSharedParams for PolkadotSubCommands {
	fn shared_params(&self) -> Option<&cli::SharedParams> { None }
58
59
60
}

#[derive(Debug, StructOpt, Clone)]
Gavin Wood's avatar
Gavin Wood committed
61
struct ValidationWorkerCommand {
62
63
64
65
	#[structopt()]
	pub mem_id: String,
}

Gavin Wood's avatar
Gavin Wood committed
66
67
68
69
70
71
#[derive(Debug, StructOpt, Clone)]
struct PolkadotSubParams {
	#[structopt(long = "enable-authority-discovery")]
	pub authority_discovery_enabled: bool,
}

72
/// Parses polkadot specific CLI arguments and run the service.
73
74
pub fn run<E: IntoExit>(exit: E, version: cli::VersionInfo) -> error::Result<()> {
	let cmd = cli::parse_and_prepare::<PolkadotSubCommands, PolkadotSubParams, _>(
Gavin Wood's avatar
Gavin Wood committed
75
76
77
		&version,
		"parity-polkadot",
		std::env::args(),
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
	);
	if cmd
		.shared_params()
		.and_then(|p| p.chain.as_ref())
		.and_then(|c| ChainSpec::from(c))
		.map_or(false, |c| c.is_kusama())
	{
		execute_cmd_with_runtime::<
			service::kusama_runtime::RuntimeApi,
			service::KusamaExecutor,
			service::kusama_runtime::UncheckedExtrinsic,
			_
		>(exit, &version, cmd)
	} else {
		execute_cmd_with_runtime::<
			service::polkadot_runtime::RuntimeApi,
			service::PolkadotExecutor,
			service::polkadot_runtime::UncheckedExtrinsic,
			_
		>(exit, &version, cmd)
	}
}

/// Execute the given `cmd` with the given runtime.
fn execute_cmd_with_runtime<R, D, E, X>(
	exit: X,
	version: &cli::VersionInfo,
	cmd: cli::ParseAndPrepare<PolkadotSubCommands, PolkadotSubParams>,
) -> error::Result<()>
where
	R: service::ConstructRuntimeApi<service::Block, service::TFullClient<service::Block, R, D>>
		+ service::ConstructRuntimeApi<service::Block, service::TLightClient<service::Block, R, D>>
		+ Send + Sync + 'static,
	<R as service::ConstructRuntimeApi<service::Block, service::TFullClient<service::Block, R, D>>>::RuntimeApi: service::RuntimeApiCollection<E>,
	<R as service::ConstructRuntimeApi<service::Block, service::TLightClient<service::Block, R, D>>>::RuntimeApi: service::RuntimeApiCollection<E>,
	E: service::Codec + Send + Sync + 'static,
	D: service::NativeExecutionDispatch + 'static,
	X: IntoExit,
{
	match cmd {
		cli::ParseAndPrepare::Run(cmd) => cmd.run(&load_spec, exit,
			|exit, _cli_args, custom_args, mut config| {
				info!("{}", version.name);
				info!("  version {}", config.full_version());
				info!("  by {}, 2017-2019", version.author);
				info!("Chain specification: {}", config.chain_spec.name());
				if config.is_kusama() {
					info!("----------------------------");
					info!("This chain is not in any way");
					info!("      endorsed by the       ");
					info!("     KUSAMA FOUNDATION      ");
					info!("----------------------------");
				}
				info!("Node name: {}", config.name);
				info!("Roles: {}", display_role(&config));
				config.custom = service::CustomConfiguration::default();
				config.custom.authority_discovery_enabled = custom_args.authority_discovery_enabled;
				let runtime = Runtime::new().map_err(|e| format!("{:?}", e))?;
				match config.roles {
					service::Roles::LIGHT =>
						run_until_exit(
							runtime,
							service::new_light::<R, D, E>(config).map_err(|e| format!("{:?}", e))?,
							exit.into_exit(),
						),
					_ => run_until_exit(
144
						runtime,
145
146
						service::new_full::<R, D, E>(config).map_err(|e| format!("{:?}", e))?,
						exit.into_exit(),
147
					),
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
				}.map_err(|e| format!("{:?}", e))
			}),
			cli::ParseAndPrepare::BuildSpec(cmd) => cmd.run::<NoCustom, _, _, _>(&load_spec),
			cli::ParseAndPrepare::ExportBlocks(cmd) => cmd.run_with_builder::<_, _, _, _, _, _, _>(|config|
				Ok(service::new_chain_ops::<R, D, E>(config)?), &load_spec, exit),
			cli::ParseAndPrepare::ImportBlocks(cmd) => cmd.run_with_builder::<_, _, _, _, _, _, _>(|config|
				Ok(service::new_chain_ops::<R, D, E>(config)?), &load_spec, exit),
			cli::ParseAndPrepare::CheckBlock(cmd) => cmd.run_with_builder::<_, _, _, _, _, _, _>(|config|
				Ok(service::new_chain_ops::<R, D, E>(config)?), &load_spec, exit),
			cli::ParseAndPrepare::PurgeChain(cmd) => cmd.run(&load_spec),
			cli::ParseAndPrepare::RevertChain(cmd) => cmd.run_with_builder::<_, _, _, _, _, _>(|config|
				Ok(service::new_chain_ops::<R, D, E>(config)?), &load_spec),
			cli::ParseAndPrepare::CustomCommand(PolkadotSubCommands::ValidationWorker(args)) => {
				if cfg!(feature = "browser") {
					Err(error::Error::Input("Cannot run validation worker in browser".into()))
				} else {
					#[cfg(not(feature = "browser"))]
					service::run_validation_worker(&args.mem_id)?;
					Ok(())
				}
168
			}
169
	}
170
}
171

172
173
/// Run the given `service` using the `runtime` until it exits or `e` fires.
pub fn run_until_exit(
André Silva's avatar
André Silva committed
174
	mut runtime: Runtime,
175
176
177
	service: impl AbstractService,
	e: impl Future<Output = ()> + Send + Unpin + 'static,
) -> error::Result<()> {
178
	let (exit_send, exit) = oneshot::channel();
Arkadiy Paronyan's avatar
Arkadiy Paronyan committed
179

180
	let executor = runtime.executor();
181
	let informant = cli::informant::build(&service);
182
183
184
185
186
	let future = select(exit, informant)
		.map(|_| Ok(()))
		.compat();

	executor.spawn(future);
187

André Silva's avatar
André Silva committed
188
189
190
191
	// we eagerly drop the service so that the internal exit future is fired,
	// but we need to keep holding a reference to the global telemetry guard
	let _telemetry = service.telemetry();

192
193
194
195
196
197
198
199
200
201
	let service_res = {
		let service = service
			.map_err(|err| error::Error::Service(err))
			.compat();
		let select = select(service, e)
			.map(|_| Ok(()))
			.compat();
		runtime.block_on(select)
	};

202
203
204
	let _ = exit_send.send(());

	use futures01::Future;
André Silva's avatar
André Silva committed
205
206
207
	// TODO [andre]: timeout this future substrate/#1318
	let _ = runtime.shutdown_on_idle().wait();

208
	service_res
Gav's avatar
Gav committed
209
}