lib.rs 37 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// 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 service. Specialized wrapper over substrate service.

19
20
#![deny(unused_results)]

21
pub mod chain_spec;
22
mod grandpa_support;
23
mod parachains_db;
24

25
26
27
28
29
30
31
32
33
34
35
#[cfg(feature = "full-node")]
mod overseer;

#[cfg(feature = "full-node")]
pub use self::overseer::{
	OverseerGen,
	OverseerGenArgs,
	RealOverseerGen,
	create_default_subsystems,
};

36
#[cfg(feature = "full-node")]
37
use {
38
	tracing::info,
39
	polkadot_network_bridge::RequestMultiplexer,
40
	polkadot_node_core_av_store::Config as AvailabilityConfig,
41
	polkadot_node_core_av_store::Error as AvailabilityError,
42
	polkadot_node_core_approval_voting::Config as ApprovalVotingConfig,
43
	polkadot_node_core_candidate_validation::Config as CandidateValidationConfig,
44
	polkadot_overseer::BlockInfo,
45
	sp_trie::PrefixedMemoryDB,
46
	sc_client_api::ExecutorProvider,
47
	grandpa::{self, FinalityProofProvider as GrandpaFinalityProofProvider},
48
	sp_runtime::traits::Header as HeaderT,
49
50
};

51
52
53
54
55
56
57
58
59
60
#[cfg(feature = "full-node")]
pub use {
	sp_blockchain::HeaderBackend,
	sp_consensus_babe::BabeApi,
	sp_authority_discovery::AuthorityDiscoveryApi,
	sc_client_api::AuxStore,
	polkadot_primitives::v1::ParachainHost,
	polkadot_overseer::{Overseer, OverseerHandler},
};
pub use sp_core::traits::SpawnNamed;
61

62
#[cfg(feature = "full-node")]
63
64
use polkadot_subsystem::jaeger;

65
use std::sync::Arc;
66
use std::time::Duration;
67

68
use prometheus_endpoint::Registry;
69
use service::RpcHandlers;
70
71
72
#[cfg(feature = "full-node")]
use telemetry::{Telemetry, TelemetryWorkerHandle};
use telemetry::TelemetryWorker;
73

74
75
76
77
78
79
80
81
82
83
84
85
86
#[cfg(feature = "rococo-native")]
pub use polkadot_client::RococoExecutor;

#[cfg(feature = "westend-native")]
pub use polkadot_client::WestendExecutor;

#[cfg(feature = "kusama-native")]
pub use polkadot_client::KusamaExecutor;

pub use polkadot_client::{
	PolkadotExecutor, FullBackend, FullClient, AbstractClient, Client, ClientHandle, ExecuteWithClient,
	RuntimeApiCollection,
};
87
pub use chain_spec::{PolkadotChainSpec, KusamaChainSpec, WestendChainSpec, RococoChainSpec};
88
pub use consensus_common::{Proposal, SelectChain, BlockImport, block_validation::Chain};
89
pub use polkadot_primitives::v1::{Block, BlockId, CollatorPair, Hash, Id as ParaId};
90
91
92
pub use sc_client_api::{Backend, ExecutionStrategy, CallExecutor};
pub use sc_consensus::LongestChain;
pub use sc_executor::NativeExecutionDispatch;
93
pub use service::{
94
	Role, PruningMode, TransactionPoolOptions, Error as SubstrateServiceError, RuntimeGenesis,
95
	TFullClient, TLightClient, TFullBackend, TLightBackend, TFullCallExecutor, TLightCallExecutor,
96
	Configuration, ChainSpec, TaskManager,
97
98
99
};
pub use service::config::{DatabaseConfig, PrometheusConfig};
pub use sp_api::{ApiRef, Core as CoreApi, ConstructRuntimeApi, ProvideRuntimeApi, StateBackend};
100
101
pub use sp_runtime::traits::{DigestFor, HashFor, NumberFor, Block as BlockT, self as runtime_traits, BlakeTwo256};

102
#[cfg(feature = "kusama-native")]
103
pub use kusama_runtime;
104
pub use polkadot_runtime;
105
#[cfg(feature = "rococo-native")]
106
pub use rococo_runtime;
107
#[cfg(feature = "westend-native")]
108
109
pub use westend_runtime;

110
/// The maximum number of active leaves we forward to the [`Overseer`] on startup.
111
#[cfg(any(test,feature = "full-node"))]
112
113
const MAX_ACTIVE_LEAVES: usize = 4;

114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
#[derive(thiserror::Error, Debug)]
pub enum Error {
	#[error(transparent)]
	Io(#[from] std::io::Error),

	#[error(transparent)]
	AddrFormatInvalid(#[from] std::net::AddrParseError),

	#[error(transparent)]
	Sub(#[from] SubstrateServiceError),

	#[error(transparent)]
	Blockchain(#[from] sp_blockchain::Error),

	#[error(transparent)]
	Consensus(#[from] consensus_common::Error),

	#[error("Failed to create an overseer")]
	Overseer(#[from] polkadot_overseer::SubsystemError),

	#[error(transparent)]
	Prometheus(#[from] prometheus_endpoint::PrometheusError),

137
138
139
	#[error(transparent)]
	Telemetry(#[from] telemetry::Error),

140
141
142
	#[error(transparent)]
	Jaeger(#[from] polkadot_subsystem::jaeger::JaegerError),

143
144
145
146
147
148
	#[cfg(feature = "full-node")]
	#[error(transparent)]
	Availability(#[from] AvailabilityError),

	#[error("Authorities require the real overseer implementation")]
	AuthoritiesRequireRealOverseer,
149
150
151
152

	#[cfg(feature = "full-node")]
	#[error("Creating a custom database is required for validators")]
	DatabasePathRequired,
153
154
}

155
/// Can be called for a `Configuration` to identify which network the configuration targets.
156
157
158
159
160
161
pub trait IdentifyVariant {
	/// Returns if this is a configuration for the `Kusama` network.
	fn is_kusama(&self) -> bool;

	/// Returns if this is a configuration for the `Westend` network.
	fn is_westend(&self) -> bool;
162
163
164

	/// Returns if this is a configuration for the `Rococo` network.
	fn is_rococo(&self) -> bool;
165

166
167
168
	/// Returns if this is a configuration for the `Wococo` test network.
	fn is_wococo(&self) -> bool;

169
170
	/// Returns true if this configuration is for a development network.
	fn is_dev(&self) -> bool;
171
172
173
174
175
176
177
178
179
}

impl IdentifyVariant for Box<dyn ChainSpec> {
	fn is_kusama(&self) -> bool {
		self.id().starts_with("kusama") || self.id().starts_with("ksm")
	}
	fn is_westend(&self) -> bool {
		self.id().starts_with("westend") || self.id().starts_with("wnd")
	}
180
181
182
	fn is_rococo(&self) -> bool {
		self.id().starts_with("rococo") || self.id().starts_with("rco")
	}
183
184
185
	fn is_wococo(&self) -> bool {
		self.id().starts_with("wococo") || self.id().starts_with("wco")
	}
186
187
188
	fn is_dev(&self) -> bool {
		self.id().ends_with("dev")
	}
189
190
191
}

// If we're using prometheus, use a registry with a prefix of `polkadot`.
192
fn set_prometheus_registry(config: &mut Configuration) -> Result<(), Error> {
193
194
195
196
197
198
199
	if let Some(PrometheusConfig { registry, .. }) = config.prometheus_config.as_mut() {
		*registry = Registry::new_custom(Some("polkadot".into()), None)?;
	}

	Ok(())
}

200
201
/// Initialize the `Jeager` collector. The destination must listen
/// on the given address and port for `UDP` packets.
202
#[cfg(any(test,feature = "full-node"))]
203
204
205
206
207
208
209
210
211
212
213
214
fn jaeger_launch_collector_with_agent(spawner: impl SpawnNamed, config: &Configuration, agent: Option<std::net::SocketAddr>) -> Result<(), Error> {
	if let Some(agent) = agent {
		let cfg = jaeger::JaegerConfig::builder()
			.agent(agent)
			.named(&config.network.node_name)
			.build();

		jaeger::Jaeger::new(cfg).launch(spawner)?;
	}
	Ok(())
}

215
#[cfg(feature = "full-node")]
216
type FullSelectChain = sc_consensus::LongestChain<FullBackend, Block>;
217
#[cfg(feature = "full-node")]
218
219
220
221
type FullGrandpaBlockImport<RuntimeApi, Executor> = grandpa::GrandpaBlockImport<
	FullBackend, Block, FullClient<RuntimeApi, Executor>, FullSelectChain
>;

222
#[cfg(feature = "light-node")]
223
224
type LightBackend = service::TLightBackendWithHash<Block, sp_runtime::traits::BlakeTwo256>;

225
#[cfg(feature = "light-node")]
226
227
228
229
type LightClient<RuntimeApi, Executor> =
	service::TLightClientWithBackend<Block, RuntimeApi, Executor, LightBackend>;

#[cfg(feature = "full-node")]
230
231
232
233
234
fn new_partial<RuntimeApi, Executor>(
	config: &mut Configuration,
	jaeger_agent: Option<std::net::SocketAddr>,
	telemetry_worker_handle: Option<TelemetryWorkerHandle>,
) -> Result<
235
236
	service::PartialComponents<
		FullClient<RuntimeApi, Executor>, FullBackend, FullSelectChain,
237
		consensus_common::DefaultImportQueue<Block, FullClient<RuntimeApi, Executor>>,
238
		sc_transaction_pool::FullPool<Block, FullClient<RuntimeApi, Executor>>,
239
		(
240
241
242
243
			impl Fn(
				polkadot_rpc::DenyUnsafe,
				polkadot_rpc::SubscriptionTaskExecutor,
			) -> polkadot_rpc::RpcExtension,
244
245
246
247
248
			(
				babe::BabeBlockImport<
					Block, FullClient<RuntimeApi, Executor>, FullGrandpaBlockImport<RuntimeApi, Executor>
				>,
				grandpa::LinkHalf<Block, FullClient<RuntimeApi, Executor>, FullSelectChain>,
249
				babe::BabeLink<Block>,
Andreas Doerr's avatar
Andreas Doerr committed
250
				beefy_gadget::notification::BeefySignedCommitmentSender<Block>,
251
			),
252
			grandpa::SharedVoterState,
253
			std::time::Duration, // slot-duration
254
			Option<Telemetry>,
255
		)
256
	>,
257
258
	Error
>
259
260
261
	where
		RuntimeApi: ConstructRuntimeApi<Block, FullClient<RuntimeApi, Executor>> + Send + Sync + 'static,
		RuntimeApi::RuntimeApi:
262
		RuntimeApiCollection<StateBackend = sc_client_api::StateBackendFor<FullBackend, Block>>,
263
264
		Executor: NativeExecutionDispatch + 'static,
{
265
	set_prometheus_registry(config)?;
266

267

268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
	let telemetry = config.telemetry_endpoints.clone()
		.filter(|x| !x.is_empty())
		.map(move |endpoints| -> Result<_, telemetry::Error> {
			let (worker, mut worker_handle) = if let Some(worker_handle) = telemetry_worker_handle {
				(None, worker_handle)
			} else {
				let worker = TelemetryWorker::new(16)?;
				let worker_handle = worker.handle();
				(Some(worker), worker_handle)
			};
			let telemetry = worker_handle.new_telemetry(endpoints);
			Ok((worker, telemetry))
		})
		.transpose()?;

283
	let (client, backend, keystore_container, task_manager) =
284
285
286
287
		service::new_full_parts::<Block, RuntimeApi, Executor>(
			&config,
			telemetry.as_ref().map(|(_, telemetry)| telemetry.handle()),
		)?;
288
289
	let client = Arc::new(client);

290
291
292
293
294
295
296
297
	let telemetry = telemetry
		.map(|(worker, telemetry)| {
			if let Some(worker) = worker {
				task_manager.spawn_handle().spawn("telemetry", worker.run());
			}
			telemetry
		});

298
299
	jaeger_launch_collector_with_agent(task_manager.spawn_handle(), &*config, jaeger_agent)?;

300
301
302
303
	let select_chain = sc_consensus::LongestChain::new(backend.clone());

	let transaction_pool = sc_transaction_pool::BasicPool::new_full(
		config.transaction_pool.clone(),
304
		config.role.is_authority().into(),
305
		config.prometheus_registry(),
306
		task_manager.spawn_essential_handle(),
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
		client.clone(),
	);

	let grandpa_hard_forks = if config.chain_spec.is_kusama() {
		grandpa_support::kusama_hard_forks()
	} else {
		Vec::new()
	};

	let (grandpa_block_import, grandpa_link) =
		grandpa::block_import_with_authority_set_hard_forks(
			client.clone(),
			&(client.clone() as Arc<_>),
			select_chain.clone(),
			grandpa_hard_forks,
322
			telemetry.as_ref().map(|x| x.handle()),
323
324
325
326
		)?;

	let justification_import = grandpa_block_import.clone();

327
	let babe_config = babe::Config::get_or_compute(&*client)?;
328
	let (block_import, babe_link) = babe::block_import(
329
		babe_config.clone(),
330
331
332
333
		grandpa_block_import,
		client.clone(),
	)?;

334
	let slot_duration = babe_link.config().slot_duration();
335
336
337
338
339
340
	let import_queue = babe::import_queue(
		babe_link.clone(),
		block_import.clone(),
		Some(Box::new(justification_import)),
		client.clone(),
		select_chain.clone(),
341
342
343
344
345
346
347
348
349
350
351
		move |_, ()| async move {
			let timestamp = sp_timestamp::InherentDataProvider::from_system_time();

			let slot =
				sp_consensus_babe::inherents::InherentDataProvider::from_timestamp_and_duration(
					*timestamp,
					slot_duration,
				);

			Ok((timestamp, slot))
		},
352
		&task_manager.spawn_essential_handle(),
353
		config.prometheus_registry(),
Wei Tang's avatar
Wei Tang committed
354
		consensus_common::CanAuthorWithNativeVersion::new(client.executor().clone()),
355
		telemetry.as_ref().map(|x| x.handle()),
356
357
	)?;

358
359
360
	let (beefy_link, beefy_commitment_stream) =
		beefy_gadget::notification::BeefySignedCommitmentStream::channel();

361
	let justification_stream = grandpa_link.justification_stream();
362
363
	let shared_authority_set = grandpa_link.shared_authority_set().clone();
	let shared_voter_state = grandpa::SharedVoterState::empty();
364
365
366
367
	let finality_proof_provider = GrandpaFinalityProofProvider::new_for_service(
		backend.clone(),
		Some(shared_authority_set.clone()),
	);
368

369
	let import_setup = (block_import.clone(), grandpa_link, babe_link.clone(), beefy_link);
370
	let rpc_setup = shared_voter_state.clone();
371
372

	let shared_epoch_changes = babe_link.epoch_changes().clone();
373
	let slot_duration = babe_config.slot_duration();
374
375
376

	let rpc_extensions_builder = {
		let client = client.clone();
377
		let keystore = keystore_container.sync_keystore();
378
379
		let transaction_pool = transaction_pool.clone();
		let select_chain = select_chain.clone();
380
		let chain_spec = config.chain_spec.cloned_box();
381

382
383
384
		move |deny_unsafe, subscription_executor: polkadot_rpc::SubscriptionTaskExecutor|
			-> polkadot_rpc::RpcExtension
		{
385
386
387
388
			let deps = polkadot_rpc::FullDeps {
				client: client.clone(),
				pool: transaction_pool.clone(),
				select_chain: select_chain.clone(),
389
				chain_spec: chain_spec.cloned_box(),
390
391
392
393
394
395
396
397
398
				deny_unsafe,
				babe: polkadot_rpc::BabeDeps {
					babe_config: babe_config.clone(),
					shared_epoch_changes: shared_epoch_changes.clone(),
					keystore: keystore.clone(),
				},
				grandpa: polkadot_rpc::GrandpaDeps {
					shared_voter_state: shared_voter_state.clone(),
					shared_authority_set: shared_authority_set.clone(),
399
					justification_stream: justification_stream.clone(),
400
					subscription_executor: subscription_executor.clone(),
Jon Häggblad's avatar
Jon Häggblad committed
401
					finality_provider: finality_proof_provider.clone(),
402
				},
403
404
405
406
				beefy: polkadot_rpc::BeefyDeps {
					beefy_commitment_stream: beefy_commitment_stream.clone(),
					subscription_executor,
				},
407
408
409
			};

			polkadot_rpc::create_full(deps)
410
		}
411
412
	};

413
	Ok(service::PartialComponents {
414
415
416
417
418
419
420
		client,
		backend,
		task_manager,
		keystore_container,
		select_chain,
		import_queue,
		transaction_pool,
421
		other: (rpc_extensions_builder, import_setup, rpc_setup, slot_duration, telemetry)
422
	})
423
424
}

425
#[cfg(feature = "full-node")]
426
427
428
pub struct NewFull<C> {
	pub task_manager: TaskManager,
	pub client: C,
429
	pub overseer_handler: Option<OverseerHandler>,
430
431
	pub network: Arc<sc_network::NetworkService<Block, <Block as BlockT>::Hash>>,
	pub rpc_handlers: RpcHandlers,
432
	pub backend: Arc<FullBackend>,
433
434
435
436
}

#[cfg(feature = "full-node")]
impl<C> NewFull<C> {
437
438
	/// Convert the client type using the given `func`.
	pub fn with_client<NC>(self, func: impl FnOnce(C) -> NC) -> NewFull<NC> {
439
440
441
		NewFull {
			client: func(self.client),
			task_manager: self.task_manager,
442
			overseer_handler: self.overseer_handler,
443
444
			network: self.network,
			rpc_handlers: self.rpc_handlers,
445
			backend: self.backend,
446
447
448
449
		}
	}
}

450
451
/// Is this node a collator?
#[cfg(feature = "full-node")]
452
#[derive(Clone)]
453
454
pub enum IsCollator {
	/// This node is a collator.
455
	Yes(CollatorPair),
456
457
458
459
	/// This node is not a collator.
	No,
}

460
461
462
463
464
465
466
467
468
469
470
#[cfg(feature = "full-node")]
impl std::fmt::Debug for IsCollator {
	fn fmt(&self, fmt: &mut std::fmt::Formatter) -> std::fmt::Result {
		use sp_core::Pair;
		match self {
			IsCollator::Yes(pair) => write!(fmt, "Yes({})", pair.public()),
			IsCollator::No => write!(fmt, "No"),
		}
	}
}

471
472
473
474
#[cfg(feature = "full-node")]
impl IsCollator {
	/// Is this a collator?
	fn is_collator(&self) -> bool {
475
		matches!(self, Self::Yes(_))
476
477
478
	}
}

479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
/// Returns the active leaves the overseer should start with.
#[cfg(feature = "full-node")]
fn active_leaves<RuntimeApi, Executor>(
	select_chain: &sc_consensus::LongestChain<FullBackend, Block>,
	client: &FullClient<RuntimeApi, Executor>,
) -> Result<Vec<BlockInfo>, Error>
where
		RuntimeApi: ConstructRuntimeApi<Block, FullClient<RuntimeApi, Executor>> + Send + Sync + 'static,
		RuntimeApi::RuntimeApi:
		RuntimeApiCollection<StateBackend = sc_client_api::StateBackendFor<FullBackend, Block>>,
		Executor: NativeExecutionDispatch + 'static,
{
	let best_block = select_chain.best_chain()?;

	let mut leaves = select_chain
		.leaves()
		.unwrap_or_default()
		.into_iter()
		.filter_map(|hash| {
			let number = client.number(hash).ok()??;

			// Only consider leaves that are in maximum an uncle of the best block.
			if number < best_block.number().saturating_sub(1) {
				return None
			} else if hash == best_block.hash() {
				return None
			};

			let parent_hash = client.header(&BlockId::Hash(hash)).ok()??.parent_hash;

			Some(BlockInfo {
				hash,
				parent_hash,
				number,
			})
		})
		.collect::<Vec<_>>();

	// Sort by block number and get the maximum number of leaves
	leaves.sort_by_key(|b| b.number);

	leaves.push(BlockInfo {
		hash: best_block.hash(),
		parent_hash: *best_block.parent_hash(),
		number: *best_block.number(),
	});

	Ok(leaves.into_iter().rev().take(MAX_ACTIVE_LEAVES).collect())
}

529
530
531
532
533
/// Create a new full node of arbitrary runtime and executor.
///
/// This is an advanced feature and not recommended for general use. Generally, `build_full` is
/// a better choice.
#[cfg(feature = "full-node")]
534
pub fn new_full<RuntimeApi, Executor, OverseerGenerator>(
535
	mut config: Configuration,
536
	is_collator: IsCollator,
537
	grandpa_pause: Option<(u32, u32)>,
538
	disable_beefy: bool,
539
	jaeger_agent: Option<std::net::SocketAddr>,
540
	telemetry_worker_handle: Option<TelemetryWorkerHandle>,
541
	program_path: Option<std::path::PathBuf>,
542
	overseer_gen: OverseerGenerator,
543
) -> Result<NewFull<Arc<FullClient<RuntimeApi, Executor>>>, Error>
544
545
546
	where
		RuntimeApi: ConstructRuntimeApi<Block, FullClient<RuntimeApi, Executor>> + Send + Sync + 'static,
		RuntimeApi::RuntimeApi:
547
		RuntimeApiCollection<StateBackend = sc_client_api::StateBackendFor<FullBackend, Block>>,
548
		Executor: NativeExecutionDispatch + 'static,
549
		OverseerGenerator: OverseerGen,
550
551
552
{
	let role = config.role.clone();
	let force_authoring = config.force_authoring;
553
	let backoff_authoring_blocks = {
554
		let mut backoff = sc_consensus_slots::BackoffAuthoringOnFinalizedHeadLagging::default();
555

556
		if config.chain_spec.is_rococo() || config.chain_spec.is_wococo() {
557
558
559
560
561
562
563
564
			// it's a testnet that's in flux, finality has stalled sometimes due
			// to operational issues and it's annoying to slow down block
			// production to 1 block per hour.
			backoff.max_interval = 10;
		}

		Some(backoff)
	};
565

566
567
568
	let disable_grandpa = config.disable_grandpa;
	let name = config.network.node_name.clone();

569
	let service::PartialComponents {
570
571
572
		client,
		backend,
		mut task_manager,
573
		keystore_container,
574
575
576
		select_chain,
		import_queue,
		transaction_pool,
577
578
		other: (rpc_extensions_builder, import_setup, rpc_setup, slot_duration, mut telemetry)
	} = new_partial::<RuntimeApi, Executor>(&mut config, jaeger_agent, telemetry_worker_handle)?;
579

580
581
	let prometheus_registry = config.prometheus_registry().cloned();

582
	let shared_voter_state = rpc_setup;
583
	let auth_disc_publish_non_global_ips = config.network.allow_non_globals_in_dht;
584

585
586
587
588
	// Note: GrandPa is pushed before the Polkadot-specific protocols. This doesn't change
	// anything in terms of behaviour, but makes the logs more consistent with the other
	// Substrate nodes.
	config.network.extra_sets.push(grandpa::grandpa_peers_set_config());
589

590
	if config.chain_spec.is_rococo() || config.chain_spec.is_wococo() {
591
592
593
		config.network.extra_sets.push(beefy_gadget::beefy_peers_set_config());
	}

594
595
596
597
598
599
600
601
602
	{
		use polkadot_network_bridge::{peer_sets_info, IsAuthority};
		let is_authority = if role.is_authority() {
			IsAuthority::Yes
		} else {
			IsAuthority::No
		};
		config.network.extra_sets.extend(peer_sets_info(is_authority));
	}
603

604
	config.network.request_response_protocols.push(sc_finality_grandpa_warp_sync::request_response_config_for_chain(
605
		&config, task_manager.spawn_handle(), backend.clone(), import_setup.1.shared_authority_set().clone(),
606
	));
607
	let request_multiplexer = {
608
		let (multiplexer, configs) = RequestMultiplexer::new();
609
		config.network.request_response_protocols.extend(configs);
610
		multiplexer
611
	};
612

613
	let (network, system_rpc_tx, network_starter) =
614
615
616
617
618
619
620
621
622
623
624
		service::build_network(service::BuildNetworkParams {
			config: &config,
			client: client.clone(),
			transaction_pool: transaction_pool.clone(),
			spawn_handle: task_manager.spawn_handle(),
			import_queue,
			on_demand: None,
			block_announce_validator_builder: None,
		})?;

	if config.offchain_worker.enabled {
625
		let _ = service::build_offchain_workers(
626
			&config, task_manager.spawn_handle(), client.clone(), network.clone(),
627
628
		);
	}
629

630
631
632
633
634
635
636
637
638
	let parachains_db = crate::parachains_db::open_creating(
		config.database.path().ok_or(Error::DatabasePathRequired)?.into(),
		crate::parachains_db::CacheSizes::default(),
	)?;

	let availability_config = AvailabilityConfig {
		col_data: crate::parachains_db::REAL_COLUMNS.col_availability_data,
		col_meta: crate::parachains_db::REAL_COLUMNS.col_availability_meta,
	};
639

640
	let approval_voting_config = ApprovalVotingConfig {
641
		col_data: crate::parachains_db::REAL_COLUMNS.col_approval_data,
642
		slot_duration_millis: slot_duration.as_millis() as u64,
643
644
	};

645
646
647
648
649
650
651
652
653
654
655
	let candidate_validation_config = CandidateValidationConfig {
		artifacts_cache_path: config.database
			.path()
			.ok_or(Error::DatabasePathRequired)?
			.join("pvf-artifacts"),
		program_path: match program_path {
			None => std::env::current_exe()?,
			Some(p) => p,
		},
	};

656
	let chain_spec = config.chain_spec.cloned_box();
657
	let rpc_handlers = service::spawn_tasks(service::SpawnTasksParams {
658
659
660
		config,
		backend: backend.clone(),
		client: client.clone(),
661
		keystore: keystore_container.sync_keystore(),
662
663
664
665
666
667
		network: network.clone(),
		rpc_extensions_builder: Box::new(rpc_extensions_builder),
		transaction_pool: transaction_pool.clone(),
		task_manager: &mut task_manager,
		on_demand: None,
		remote_blockchain: None,
668
		system_rpc_tx,
669
		telemetry: telemetry.as_mut(),
670
	})?;
671

672
	let (block_import, link_half, babe_link, beefy_link) = import_setup;
673
674
675

	let overseer_client = client.clone();
	let spawner = task_manager.spawn_handle();
676
	let active_leaves = active_leaves(&select_chain, &*client)?;
677

678
679
680
	let authority_discovery_service = if role.is_authority() || is_collator.is_collator() {
		use sc_network::Event;
		use futures::StreamExt;
681

682
		let authority_discovery_role = if role.is_authority() {
683
			sc_authority_discovery::Role::PublishAndDiscover(
684
685
686
687
				keystore_container.keystore(),
			)
		} else {
			// don't publish our addresses when we're only a collator
688
			sc_authority_discovery::Role::Discover
689
690
691
692
693
694
		};
		let dht_event_stream = network.event_stream("authority-discovery")
			.filter_map(|e| async move { match e {
				Event::Dht(e) => Some(e),
				_ => None,
			}});
695
696
697
698
699
		let (worker, service) = sc_authority_discovery::new_worker_and_service_with_config(
			sc_authority_discovery::WorkerConfig {
				publish_non_global_ips: auth_disc_publish_non_global_ips,
				..Default::default()
			},
700
701
702
703
704
705
			client.clone(),
			network.clone(),
			Box::pin(dht_event_stream),
			authority_discovery_role,
			prometheus_registry.clone(),
		);
706

707
708
709
710
711
712
713
714
		task_manager.spawn_handle().spawn("authority-discovery-worker", worker.run());
		Some(service)
	} else {
		None
	};

	// we'd say let overseer_handler = authority_discovery_service.map(|authority_discovery_service|, ...),
	// but in that case we couldn't use ? to propagate errors
715
716
717
718
719
720
721
722
723
	let local_keystore = keystore_container.local_keystore();
	if local_keystore.is_none() {
		tracing::info!("Cannot run as validator without local keystore.");
	}

	let maybe_params = local_keystore
		.and_then(move |k| authority_discovery_service.map(|a| (a, k)));

	let overseer_handler = if let Some((authority_discovery_service, keystore)) = maybe_params {
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
		let (overseer, overseer_handler) = overseer_gen.generate::<
			service::SpawnTaskHandle,
			FullClient<RuntimeApi, Executor>,
		>(
			OverseerGenArgs {
				leaves: active_leaves,
				keystore,
				runtime_client: overseer_client.clone(),
				parachains_db,
				availability_config,
				approval_voting_config,
				network_service: network.clone(),
				authority_discovery_service,
				request_multiplexer,
				registry: prometheus_registry.as_ref(),
				spawner,
				is_collator,
				candidate_validation_config,
			}
743
744
745
746
747
		)?;
		let overseer_handler_clone = overseer_handler.clone();

		task_manager.spawn_essential_handle().spawn_blocking("overseer", Box::pin(async move {
			use futures::{pin_mut, select, FutureExt};
748

749
750
751
752
753
754
755
			let forward = polkadot_overseer::forward_events(overseer_client, overseer_handler_clone);

			let forward = forward.fuse();
			let overseer_fut = overseer.run().fuse();

			pin_mut!(overseer_fut);
			pin_mut!(forward);
756

757
			select! {
758
759
760
				_ = forward => (),
				_ = overseer_fut => (),
				complete => (),
761
			}
762
763
764
		}));

		Some(overseer_handler)
765
766
767
	} else {
		None
	};
768
769
770
771
772

	if role.is_authority() {
		let can_author_with =
			consensus_common::CanAuthorWithNativeVersion::new(client.executor().clone());

773
		let proposer = sc_basic_authorship::ProposerFactory::new(
774
			task_manager.spawn_handle(),
775
776
			client.clone(),
			transaction_pool,
777
			prometheus_registry.as_ref(),
778
			telemetry.as_ref().map(|x| x.handle()),
779
780
		);

781
782
783
		let client_clone = client.clone();
		let overseer_handler = overseer_handler.as_ref().ok_or(Error::AuthoritiesRequireRealOverseer)?.clone();
		let slot_duration = babe_link.config().slot_duration();
784
		let babe_config = babe::BabeParams {
785
			keystore: keystore_container.sync_keystore(),
786
787
788
789
790
			client: client.clone(),
			select_chain,
			block_import,
			env: proposer,
			sync_oracle: network.clone(),
791
			justification_sync_link: network.clone(),
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
			create_inherent_data_providers: move |parent, ()| {
				let client_clone = client_clone.clone();
				let overseer_handler = overseer_handler.clone();
				async move {
					let parachain = polkadot_node_core_parachains_inherent::ParachainsInherentDataProvider::create(
						&*client_clone,
						overseer_handler,
						parent,
					).await.map_err(|e| Box::new(e))?;

					let uncles = sc_consensus_uncles::create_uncles_inherent_data_provider(
						&*client_clone,
						parent,
					)?;

					let timestamp = sp_timestamp::InherentDataProvider::from_system_time();

					let slot =
						sp_consensus_babe::inherents::InherentDataProvider::from_timestamp_and_duration(
							*timestamp,
							slot_duration,
						);

					Ok((timestamp, slot, uncles, parachain))
				}
			},
818
			force_authoring,
819
			backoff_authoring_blocks,
820
821
			babe_link,
			can_author_with,
822
			block_proposal_slot_portion: babe::SlotProportion::new(2f32 / 3f32),
823
			telemetry: telemetry.as_ref().map(|x| x.handle()),
824
		};
825

826
827
828
		let babe = babe::start_babe(babe_config)?;
		task_manager.spawn_essential_handle().spawn_blocking("babe", babe);
	}
829

Andreas Doerr's avatar
Andreas Doerr committed
830
831
832
833
834
835
836
837
	// if the node isn't actively participating in consensus then it doesn't
	// need a keystore, regardless of which protocol we use below.
	let keystore_opt = if role.is_authority() {
		Some(keystore_container.sync_keystore())
	} else {
		None
	};

838
	// We currently only run the BEEFY gadget on the Rococo and Wococo testnets.
839
	if !disable_beefy && (chain_spec.is_rococo() || chain_spec.is_wococo()) {
Andreas Doerr's avatar
Andreas Doerr committed
840
841
842
843
844
845
846
847
848
		let beefy_params = beefy_gadget::BeefyParams {
			client: client.clone(),
			backend: backend.clone(),
			key_store: keystore_opt.clone(),
			network: network.clone(),
			signed_commitment_sender: beefy_link,
			min_block_delta: if chain_spec.is_wococo() { 4 } else { 8 },
			prometheus_registry: prometheus_registry.clone(),
		};
849

Andreas Doerr's avatar
Andreas Doerr committed
850
		let gadget = beefy_gadget::start_beefy_gadget::<_, _, _, _>(
Andreas Doerr's avatar
Andreas Doerr committed
851
			beefy_params
852
853
		);

854
855
856
857
858
859
860
		// Wococo's purpose is to be a testbed for BEEFY, so if it fails we'll
		// bring the node down with it to make sure it is noticed.
		if chain_spec.is_wococo() {
			task_manager.spawn_essential_handle().spawn_blocking("beefy-gadget", gadget);
		} else {
			task_manager.spawn_handle().spawn_blocking("beefy-gadget", gadget);
		}
861
862
	}

863
864
865
866
867
868
	let config = grandpa::Config {
		// FIXME substrate#1578 make this available through chainspec
		gossip_duration: Duration::from_millis(1000),
		justification_period: 512,
		name: Some(name),
		observer_enabled: false,
869
		keystore: keystore_opt,
870
		local_role: role,
871
		telemetry: telemetry.as_ref().map(|x| x.handle()),
872
	};
873

874
875
876
877
878
879
880
881
882
883
884
885
	let enable_grandpa = !disable_grandpa;
	if enable_grandpa {
		// start the full GRANDPA voter
		// NOTE: unlike in substrate we are currently running the full
		// GRANDPA voter protocol for all full nodes (regardless of whether
		// they're validators or not). at this point the full voter should
		// provide better guarantees of block and vote data availability than
		// the observer.

		// add a custom voting rule to temporarily stop voting for new blocks
		// after the given pause block is finalized and restarting after the
		// given delay.
886
887
888
		let builder = grandpa::VotingRulesBuilder::default();

		let builder = if let Some(ref overseer) = overseer_handler {
889
			builder.add(grandpa_support::ApprovalCheckingVotingRule::new(
890
891
892
893
894
895
896
				overseer.clone(),
				prometheus_registry.as_ref(),
			)?)
		} else {
			builder
		};

897
898
		let voting_rule = match grandpa_pause {
			Some((block, delay)) => {
899
900
901
902
				info!(
					block_number = %block,
					delay = %delay,
					"GRANDPA scheduled voting pause set for block #{} with a duration of {} blocks.",
903
904
905
					block,
					delay,
				);
906

907
				builder
908
909
					.add(grandpa_support::PauseAfterBlockFor(block, delay))
					.build()
910
			}
911
			None => builder.build(),
912
913
		};

914
915
916
917
918
		let grandpa_config = grandpa::GrandpaParams {
			config,
			link: link_half,
			network: network.clone(),
			voting_rule,
919
			prometheus_registry: prometheus_registry.clone(),
920
			shared_voter_state,
921
			telemetry: telemetry.as_ref().map(|x| x.handle()),
922
923
		};

924
925
926
927
928
		task_manager.spawn_essential_handle().spawn_blocking(
			"grandpa-voter",
			grandpa::run_grandpa_voter(grandpa_config)?
		);
	}
929

930
931
	network_starter.start_network();

932
933
934
	Ok(NewFull {
		task_manager,
		client,
935
		overseer_handler,
936
937
		network,
		rpc_handlers,
938
		backend,
939
	})
940
941
942
}

/// Builds a new service for a light client.
943
#[cfg(feature = "light-node")]
944
945
946
947
fn new_light<Runtime, Dispatch>(mut config: Configuration) -> Result<(
	TaskManager,
	RpcHandlers,
), Error>
948
949
950
	where
		Runtime: 'static + Send + Sync + ConstructRuntimeApi<Block, LightClient<Runtime, Dispatch>>,
		<Runtime as ConstructRuntimeApi<Block, LightClient<Runtime, Dispatch>>>::RuntimeApi:
951
		RuntimeApiCollection<StateBackend = sc_client_api::StateBackendFor<LightBackend, Block>>,
952
953
		Dispatch: NativeExecutionDispatch + 'static,
{
954
	set_prometheus_registry(&mut config)?;
955
956
	use sc_client_api::backend::RemoteBackend;

957
958
959
960
961
962
963
964
965
	let telemetry = config.telemetry_endpoints.clone()
		.filter(|x| !x.is_empty())
		.map(|endpoints| -> Result<_, telemetry::Error> {
			let worker = TelemetryWorker::new(16)?;
			let telemetry = worker.handle().new_telemetry(endpoints);
			Ok((worker, telemetry))
		})
		.transpose()?;

966
	let (client, backend, keystore_container, mut task_manager, on_demand) =
967
968
969
970
971
972
973
974
975
976
		service::new_light_parts::<Block, Runtime, Dispatch>(
			&config,
			telemetry.as_ref().map(|(_, telemetry)| telemetry.handle()),
		)?;

	let mut telemetry = telemetry
		.map(|(worker, telemetry)| {
			task_manager.spawn_handle().spawn("telemetry", worker.run());
			telemetry
		});
977

978
979
	config.network.extra_sets.push(grandpa::grandpa_peers_set_config());

980
981
982
983
984
	let select_chain = sc_consensus::LongestChain::new(backend.clone());

	let transaction_pool = Arc::new(sc_transaction_pool::BasicPool::new_light(
		config.transaction_pool.clone(),
		config.prometheus_registry(),
985
		task_manager.spawn_essential_handle(),
986
987
		client.clone(),
		on_demand.clone(),
988
989
	));

990
	let (grandpa_block_import, grandpa_link) = grandpa::block_import(
991
992
		client.clone(),
		&(client.clone() as Arc<_>),
993
		select_chain.clone(),
994
		telemetry.as_ref().map(|x| x.handle()),
995
	)?;
996
	let justification_import = grandpa_block_import.clone();
997
998
999
1000

	let (babe_block_import, babe_link) = babe::block_import(
		babe::Config::get_or_compute(&*client)?,
		grandpa_block_import,
For faster browsing, not all history is shown. View entire blame