lib.rs 8.49 KB
Newer Older
Shawn Tabrizi's avatar
Shawn Tabrizi committed
1
// Copyright 2017-2020 Parity Technologies (UK) Ltd.
Gav's avatar
Gav committed
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// 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,
};
30
#[cfg(feature = "cli")]
31
use tokio::runtime::Runtime;
32
use log::info;
33
use structopt::StructOpt;
34
use sp_api::ConstructRuntimeApi;
35
36

pub use service::{
37
38
	AbstractService, CustomConfiguration, ProvideRuntimeApi, CoreApi, ParachainHost, IsKusama,
	WrappedExecutor, Block, self, RuntimeApiCollection, TFullClient
39
40
};

41
42
pub use sc_cli::{VersionInfo, IntoExit, NoCustom, SharedParams};
pub use sc_cli::{display_role, error};
Gavin Wood's avatar
Gavin Wood committed
43

44
45
/// 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
46
47
48
49
	Ok(match ChainSpec::from(id) {
		Some(spec) => Some(spec.load()?),
		None => None,
	})
50
51
}

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

58
59
impl sc_cli::GetSharedParams for PolkadotSubCommands {
	fn shared_params(&self) -> Option<&sc_cli::SharedParams> { None }
60
61
62
}

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

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

74
/// Parses polkadot specific CLI arguments and run the service.
75
76
77
#[cfg(feature = "cli")]
pub fn run<E: IntoExit>(exit: E, version: sc_cli::VersionInfo) -> error::Result<()> {
	let cmd = sc_cli::parse_and_prepare::<PolkadotSubCommands, PolkadotSubParams, _>(
Gavin Wood's avatar
Gavin Wood committed
78
79
80
		&version,
		"parity-polkadot",
		std::env::args(),
81
	);
82

83
84
	// Preload spec to select native runtime
	let spec = match cmd.shared_params() {
85
		Some(params) => Some(sc_cli::load_spec(params, &load_spec)?),
86
87
88
		None => None,
	};
	if spec.as_ref().map_or(false, |c| c.is_kusama()) {
89
90
91
92
93
		execute_cmd_with_runtime::<
			service::kusama_runtime::RuntimeApi,
			service::KusamaExecutor,
			service::kusama_runtime::UncheckedExtrinsic,
			_
94
		>(exit, &version, cmd, spec)
95
96
97
98
99
100
	} else {
		execute_cmd_with_runtime::<
			service::polkadot_runtime::RuntimeApi,
			service::PolkadotExecutor,
			service::polkadot_runtime::UncheckedExtrinsic,
			_
101
		>(exit, &version, cmd, spec)
102
103
104
	}
}

105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
#[cfg(feature = "cli")]
use sp_core::Blake2Hasher;

#[cfg(feature = "cli")]
// We can't simply use `service::TLightClient` due to a
// Rust bug: https://github.com/rust-lang/rust/issues/43580
type TLightClient<Runtime, Dispatch> = sc_client::Client<
	sc_client::light::backend::Backend<sc_client_db::light::LightStorage<Block>, Blake2Hasher>,
	sc_client::light::call_executor::GenesisCallExecutor<
		sc_client::light::backend::Backend<sc_client_db::light::LightStorage<Block>, Blake2Hasher>,
		sc_client::LocalCallExecutor<
			sc_client::light::backend::Backend<sc_client_db::light::LightStorage<Block>, Blake2Hasher>,
			sc_executor::NativeExecutor<Dispatch>
		>
	>,
	Block,
	Runtime
>;

124
/// Execute the given `cmd` with the given runtime.
125
#[cfg(feature = "cli")]
126
127
fn execute_cmd_with_runtime<R, D, E, X>(
	exit: X,
128
129
	version: &sc_cli::VersionInfo,
	cmd: sc_cli::ParseAndPrepare<PolkadotSubCommands, PolkadotSubParams>,
130
	spec: Option<service::ChainSpec>,
131
132
) -> error::Result<()>
where
133
	R: ConstructRuntimeApi<Block, service::TFullClient<Block, R, D>>
134
		+ Send + Sync + 'static,
135
136
137
138
	<R as ConstructRuntimeApi<Block, service::TFullClient<Block, R, D>>>::RuntimeApi:
		RuntimeApiCollection<E, StateBackend = sc_client_api::StateBackendFor<service::TFullBackend<Block>, Block>>,
	<R as ConstructRuntimeApi<Block, service::TLightClient<Block, R, D>>>::RuntimeApi:
		RuntimeApiCollection<E, StateBackend = sc_client_api::StateBackendFor<service::TLightBackend<Block>, Block>>,
139
140
141
	E: service::Codec + Send + Sync + 'static,
	D: service::NativeExecutionDispatch + 'static,
	X: IntoExit,
142
143
144
145
146
147
148
149
	// Rust bug: https://github.com/rust-lang/rust/issues/24159
	<<R as ConstructRuntimeApi<Block, TFullClient<Block, R, D>>>::RuntimeApi as sp_api::ApiExt<Block>>::StateBackend:
		sp_api::StateBackend<Blake2Hasher>,
	// Rust bug: https://github.com/rust-lang/rust/issues/43580
	R: ConstructRuntimeApi<
		Block,
		TLightClient<R, D>
	>,
150
{
151
152
153
	let is_kusama = spec.as_ref().map_or(false, |s| s.is_kusama());
	// Use preloaded spec
	let load_spec = |_: &str| Ok(spec);
154
	match cmd {
155
		sc_cli::ParseAndPrepare::Run(cmd) => cmd.run(load_spec, exit,
156
157
158
159
			|exit, _cli_args, custom_args, mut config| {
				info!("{}", version.name);
				info!("  version {}", config.full_version());
				info!("  by {}, 2017-2019", version.author);
Gavin Wood's avatar
Gavin Wood committed
160
161
				info!("Chain specification: {}", config.chain_spec.name());
				info!("Native runtime: {}", D::native_version().runtime_version);
162
				if is_kusama {
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
					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(),
						),
André Silva's avatar
André Silva committed
181
					_ =>
Gavin Wood's avatar
Gavin Wood committed
182
183
184
185
						run_until_exit(
							runtime,
							service::new_full::<R, D, E>(config).map_err(|e| format!("{:?}", e))?,
							exit.into_exit(),
André Silva's avatar
André Silva committed
186
						),
187
188
				}.map_err(|e| format!("{:?}", e))
			}),
189
190
			sc_cli::ParseAndPrepare::BuildSpec(cmd) => cmd.run::<NoCustom, _, _, _>(load_spec),
			sc_cli::ParseAndPrepare::ExportBlocks(cmd) => cmd.run_with_builder::<_, _, _, _, _, _, _>(|config|
191
				Ok(service::new_chain_ops::<R, D, E>(config)?), load_spec, exit),
192
			sc_cli::ParseAndPrepare::ImportBlocks(cmd) => cmd.run_with_builder::<_, _, _, _, _, _, _>(|config|
193
				Ok(service::new_chain_ops::<R, D, E>(config)?), load_spec, exit),
194
			sc_cli::ParseAndPrepare::CheckBlock(cmd) => cmd.run_with_builder::<_, _, _, _, _, _, _>(|config|
195
				Ok(service::new_chain_ops::<R, D, E>(config)?), load_spec, exit),
196
197
			sc_cli::ParseAndPrepare::PurgeChain(cmd) => cmd.run(load_spec),
			sc_cli::ParseAndPrepare::RevertChain(cmd) => cmd.run_with_builder::<_, _, _, _, _, _>(|config|
198
				Ok(service::new_chain_ops::<R, D, E>(config)?), load_spec),
199
			sc_cli::ParseAndPrepare::CustomCommand(PolkadotSubCommands::ValidationWorker(args)) => {
200
201
202
203
204
205
206
				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(())
				}
207
			}
208
	}
209
}
210

211
/// Run the given `service` using the `runtime` until it exits or `e` fires.
212
#[cfg(feature = "cli")]
213
pub fn run_until_exit(
André Silva's avatar
André Silva committed
214
	mut runtime: Runtime,
215
216
217
	service: impl AbstractService,
	e: impl Future<Output = ()> + Send + Unpin + 'static,
) -> error::Result<()> {
218
	let (exit_send, exit) = oneshot::channel();
Arkadiy Paronyan's avatar
Arkadiy Paronyan committed
219

220
	let executor = runtime.executor();
221
	let informant = sc_cli::informant::build(&service);
222
223
224
	let future = select(exit, informant)
		.map(|_| Ok(()))
		.compat();
225

226
	executor.spawn(future);
227

André Silva's avatar
André Silva committed
228
229
230
231
	// 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();

232
233
234
235
236
237
238
239
240
241
	let service_res = {
		let service = service
			.map_err(|err| error::Error::Service(err));

		let select = select(service, e)
			.map(|_| Ok(()))
			.compat();

		runtime.block_on(select)
	};
242

243
244
	let _ = exit_send.send(());

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

249
	service_res
Gav's avatar
Gav committed
250
}