5.27 KB
Newer Older
// 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
// 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 <>.

//! Polkadot CLI library.

Arkadiy Paronyan's avatar
Arkadiy Paronyan committed
mod chain_spec;

use std::ops::Deref;
Arkadiy Paronyan's avatar
Arkadiy Paronyan committed
use chain_spec::ChainSpec;
use futures::Future;
use tokio::runtime::Runtime;
use service::{Service as BareService, Error as ServiceError};
use std::sync::Arc;
use log::{info, error};
use structopt::StructOpt;

pub use service::{
	Components as ServiceComponents, PolkadotService, CustomConfiguration, ServiceFactory, Factory,
	ProvideRuntimeApi, CoreApi, ParachainHost,

pub use cli::{VersionInfo, IntoExit, NoCustom};
pub use cli::error;

/// Abstraction over an executor that lets you spawn tasks in the background.
pub type TaskExecutor = Arc<dyn futures::future::Executor<Box<dyn Future<Item = (), Error = ()> + Send>> + Send + Sync>;
Arkadiy Paronyan's avatar
Arkadiy Paronyan committed
fn load_spec(id: &str) -> Result<Option<service::ChainSpec>, String> {
	Ok(match ChainSpec::from(id) {
		Some(spec) => Some(spec.load()?),
		None => None,
/// Additional worker making use of the node, to run asynchronously before shutdown.
/// This will be invoked with the service and spawn a future that resolves
/// when complete.
pub trait Worker: IntoExit {
	/// A future that resolves when the work is done or the node should exit.
	/// This will be run on a tokio runtime.
	type Work: Future<Item=(),Error=()> + Send + 'static;
	/// Return configuration for the polkadot node.
	// TODO: make this the full configuration, so embedded nodes don't need
	// string CLI args (
Arkadiy Paronyan's avatar
Arkadiy Paronyan committed
	fn configuration(&self) -> service::CustomConfiguration { Default::default() }
	/// Do work and schedule exit.
	fn work<S: PolkadotService>(self, service: &S, executor: TaskExecutor) -> Self::Work;
#[derive(Debug, StructOpt, Clone)]
enum PolkadotSubCommands {
	#[structopt(name = "validation-worker", raw(setting = "structopt::clap::AppSettings::Hidden"))]
Gavin Wood's avatar
Gavin Wood committed

impl cli::GetLogFilter for PolkadotSubCommands {
	fn get_log_filter(&self) -> Option<String> { None }

#[derive(Debug, StructOpt, Clone)]
Gavin Wood's avatar
Gavin Wood committed
struct ValidationWorkerCommand {
	pub mem_id: String,

/// Parses polkadot specific CLI arguments and run the service.
pub fn run<W>(worker: W, version: cli::VersionInfo) -> error::Result<()> where
	W: Worker,
	match cli::parse_and_prepare::<PolkadotSubCommands, NoCustom, _>(&version, "parity-polkadot", std::env::args()) {
		cli::ParseAndPrepare::Run(cmd) =>, worker,
		|worker, _cli_args, _custom_args, mut config| {
Arkadiy Paronyan's avatar
Arkadiy Paronyan committed
			info!("  version {}", config.full_version());
			info!("  by {}, 2017-2019",;
Arkadiy Paronyan's avatar
Arkadiy Paronyan committed
			info!("Chain specification: {}",;
			info!("Node name: {}",;
			info!("Roles: {:?}", config.roles);
			config.custom = worker.configuration();
			let runtime = Runtime::new().map_err(|e| format!("{:?}", e))?;
			match config.roles {
				service::Roles::LIGHT =>
						Factory::new_light(config).map_err(|e| format!("{:?}", e))?,
				_ => run_until_exit(
						Factory::new_full(config).map_err(|e| format!("{:?}", e))?,
			}.map_err(|e| format!("{:?}", e))
		cli::ParseAndPrepare::BuildSpec(cmd) =>,
		cli::ParseAndPrepare::ExportBlocks(cmd) =><service::Factory, _, _>(load_spec, worker),
		cli::ParseAndPrepare::ImportBlocks(cmd) =><service::Factory, _, _>(load_spec, worker),
		cli::ParseAndPrepare::PurgeChain(cmd) =>,
		cli::ParseAndPrepare::RevertChain(cmd) =><service::Factory, _>(load_spec),
		cli::ParseAndPrepare::CustomCommand(PolkadotSubCommands::ValidationWorker(args)) => {

fn run_until_exit<T, C, W>(
	mut runtime: Runtime,
	service: T,
	worker: W,
) -> error::Result<()>
		T: Deref<Target=BareService<C>> + Future<Item = (), Error = ServiceError> + Send + 'static,
		C: service::Components,
		BareService<C>: PolkadotService,
		W: Worker,
	let (exit_send, exit) = exit_future::signal();
	let informant = cli::informant::build(&service);
	executor.spawn(exit.until(informant).map(|_| ()));
	// 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();

	let work =*service, Arc::new(executor));
	let service = service.map_err(|err| error!("Error while running Service: {}", err));
	let _ = runtime.block_on(;;