// Copyright 2019-2021 Parity Technologies (UK) Ltd. // This file is part of Cumulus. // Cumulus 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. // Cumulus 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 Cumulus. If not, see . use cumulus_client_consensus_aura::{ build_aura_consensus, BuildAuraConsensusParams, SlotProportion, }; use cumulus_client_consensus_common::ParachainConsensus; use cumulus_client_network::build_block_announce_validator; use cumulus_client_service::{ prepare_node_config, start_collator, start_full_node, StartCollatorParams, StartFullNodeParams, }; use cumulus_primitives_core::ParaId; use polkadot_primitives::v1::CollatorPair; use sc_client_api::ExecutorProvider; use sc_executor::native_executor_instance; use sc_network::NetworkService; use sc_service::{Configuration, PartialComponents, Role, TFullBackend, TFullClient, TaskManager}; use sc_telemetry::{Telemetry, TelemetryHandle, TelemetryWorker, TelemetryWorkerHandle}; use sp_api::ConstructRuntimeApi; use sp_consensus::SlotData; use sp_keystore::SyncCryptoStorePtr; use sp_runtime::traits::BlakeTwo256; use std::sync::Arc; use substrate_prometheus_endpoint::Registry; pub use sc_executor::NativeExecutor; type BlockNumber = u32; type Header = sp_runtime::generic::Header; pub type Block = sp_runtime::generic::Block; type Hash = sp_core::H256; // Native executor instance. native_executor_instance!( pub RococoParachainRuntimeExecutor, rococo_parachain_runtime::api::dispatch, rococo_parachain_runtime::native_version, ); // Native executor instance. native_executor_instance!( pub ShellRuntimeExecutor, shell_runtime::api::dispatch, shell_runtime::native_version, ); /// Starts a `ServiceBuilder` for a full service. /// /// Use this macro if you don't actually need the full service, but just the builder in order to /// be able to perform chain operations. pub fn new_partial( config: &Configuration, build_import_queue: BIQ, ) -> Result< PartialComponents< TFullClient, TFullBackend, (), sp_consensus::DefaultImportQueue>, sc_transaction_pool::FullPool>, (Option, Option), >, sc_service::Error, > where RuntimeApi: ConstructRuntimeApi> + Send + Sync + 'static, RuntimeApi::RuntimeApi: sp_transaction_pool::runtime_api::TaggedTransactionQueue + sp_api::Metadata + sp_session::SessionKeys + sp_api::ApiExt< Block, StateBackend = sc_client_api::StateBackendFor, Block>, > + sp_offchain::OffchainWorkerApi + sp_block_builder::BlockBuilder, sc_client_api::StateBackendFor, Block>: sp_api::StateBackend, Executor: sc_executor::NativeExecutionDispatch + 'static, BIQ: FnOnce( Arc>, &Configuration, Option, &TaskManager, ) -> Result< sp_consensus::DefaultImportQueue>, sc_service::Error, >, { let telemetry = config .telemetry_endpoints .clone() .filter(|x| !x.is_empty()) .map(|endpoints| -> Result<_, sc_telemetry::Error> { let worker = TelemetryWorker::new(16)?; let telemetry = worker.handle().new_telemetry(endpoints); Ok((worker, telemetry)) }) .transpose()?; let (client, backend, keystore_container, task_manager) = sc_service::new_full_parts::( &config, telemetry.as_ref().map(|(_, telemetry)| telemetry.handle()), )?; let client = Arc::new(client); let telemetry_worker_handle = telemetry.as_ref().map(|(worker, _)| worker.handle()); let telemetry = telemetry.map(|(worker, telemetry)| { task_manager.spawn_handle().spawn("telemetry", worker.run()); telemetry }); let transaction_pool = sc_transaction_pool::BasicPool::new_full( config.transaction_pool.clone(), config.role.is_authority().into(), config.prometheus_registry(), task_manager.spawn_handle(), client.clone(), ); let import_queue = build_import_queue( client.clone(), config, telemetry.as_ref().map(|telemetry| telemetry.handle()), &task_manager, )?; let params = PartialComponents { backend, client, import_queue, keystore_container, task_manager, transaction_pool, select_chain: (), other: (telemetry, telemetry_worker_handle), }; Ok(params) } /// Start a node with the given parachain `Configuration` and relay chain `Configuration`. /// /// This is the actual implementation that is abstract over the executor and the runtime api. #[sc_tracing::logging::prefix_logs_with("Parachain")] async fn start_node_impl( parachain_config: Configuration, collator_key: CollatorPair, polkadot_config: Configuration, id: ParaId, rpc_ext_builder: RB, build_import_queue: BIQ, build_consensus: BIC, ) -> sc_service::error::Result<(TaskManager, Arc>)> where RuntimeApi: ConstructRuntimeApi> + Send + Sync + 'static, RuntimeApi::RuntimeApi: sp_transaction_pool::runtime_api::TaggedTransactionQueue + sp_api::Metadata + sp_session::SessionKeys + sp_api::ApiExt< Block, StateBackend = sc_client_api::StateBackendFor, Block>, > + sp_offchain::OffchainWorkerApi + sp_block_builder::BlockBuilder + cumulus_primitives_core::CollectCollationInfo, sc_client_api::StateBackendFor, Block>: sp_api::StateBackend, Executor: sc_executor::NativeExecutionDispatch + 'static, RB: Fn( Arc>, ) -> jsonrpc_core::IoHandler + Send + 'static, BIQ: FnOnce( Arc>, &Configuration, Option, &TaskManager, ) -> Result< sp_consensus::DefaultImportQueue>, sc_service::Error, >, BIC: FnOnce( Arc>, Option<&Registry>, Option, &TaskManager, &polkadot_service::NewFull, Arc>>, Arc>, SyncCryptoStorePtr, bool, ) -> Result>, sc_service::Error>, { if matches!(parachain_config.role, Role::Light) { return Err("Light client not supported!".into()); } let parachain_config = prepare_node_config(parachain_config); let params = new_partial::(¶chain_config, build_import_queue)?; let (mut telemetry, telemetry_worker_handle) = params.other; let relay_chain_full_node = cumulus_client_service::build_polkadot_full_node( polkadot_config, collator_key.clone(), telemetry_worker_handle, ) .map_err(|e| match e { polkadot_service::Error::Sub(x) => x, s => format!("{}", s).into(), })?; let client = params.client.clone(); let backend = params.backend.clone(); let block_announce_validator = build_block_announce_validator( relay_chain_full_node.client.clone(), id, Box::new(relay_chain_full_node.network.clone()), relay_chain_full_node.backend.clone(), ); let force_authoring = parachain_config.force_authoring; let validator = parachain_config.role.is_authority(); let prometheus_registry = parachain_config.prometheus_registry().cloned(); let transaction_pool = params.transaction_pool.clone(); let mut task_manager = params.task_manager; let import_queue = params.import_queue; let (network, network_status_sinks, system_rpc_tx, start_network) = sc_service::build_network(sc_service::BuildNetworkParams { config: ¶chain_config, client: client.clone(), transaction_pool: transaction_pool.clone(), spawn_handle: task_manager.spawn_handle(), import_queue, on_demand: None, block_announce_validator_builder: Some(Box::new(|_| block_announce_validator)), })?; let rpc_client = client.clone(); let rpc_extensions_builder = Box::new(move |_, _| rpc_ext_builder(rpc_client.clone())); sc_service::spawn_tasks(sc_service::SpawnTasksParams { on_demand: None, remote_blockchain: None, rpc_extensions_builder, client: client.clone(), transaction_pool: transaction_pool.clone(), task_manager: &mut task_manager, config: parachain_config, keystore: params.keystore_container.sync_keystore(), backend: backend.clone(), network: network.clone(), network_status_sinks, system_rpc_tx, telemetry: telemetry.as_mut(), })?; let announce_block = { let network = network.clone(); Arc::new(move |hash, data| network.announce_block(hash, data)) }; if validator { let parachain_consensus = build_consensus( client.clone(), prometheus_registry.as_ref(), telemetry.as_ref().map(|t| t.handle()), &task_manager, &relay_chain_full_node, transaction_pool, network, params.keystore_container.sync_keystore(), force_authoring, )?; let spawner = task_manager.spawn_handle(); let params = StartCollatorParams { para_id: id, block_status: client.clone(), announce_block, client: client.clone(), task_manager: &mut task_manager, collator_key, relay_chain_full_node, spawner, parachain_consensus, }; start_collator(params).await?; } else { let params = StartFullNodeParams { client: client.clone(), announce_block, task_manager: &mut task_manager, para_id: id, polkadot_full_node: relay_chain_full_node, }; start_full_node(params)?; } start_network.start_network(); Ok((task_manager, client)) } /// Build the import queue for the rococo parachain runtime. pub fn rococo_parachain_build_import_queue( client: Arc>, config: &Configuration, telemetry: Option, task_manager: &TaskManager, ) -> Result< sp_consensus::DefaultImportQueue< Block, TFullClient, >, sc_service::Error, > { let slot_duration = cumulus_client_consensus_aura::slot_duration(&*client)?; cumulus_client_consensus_aura::import_queue::< sp_consensus_aura::sr25519::AuthorityPair, _, _, _, _, _, _, >(cumulus_client_consensus_aura::ImportQueueParams { block_import: client.clone(), client: client.clone(), create_inherent_data_providers: move |_, _| async move { let time = sp_timestamp::InherentDataProvider::from_system_time(); let slot = sp_consensus_aura::inherents::InherentDataProvider::from_timestamp_and_duration( *time, slot_duration.slot_duration(), ); Ok((time, slot)) }, registry: config.prometheus_registry().clone(), can_author_with: sp_consensus::CanAuthorWithNativeVersion::new(client.executor().clone()), spawner: &task_manager.spawn_essential_handle(), telemetry, }) .map_err(Into::into) } /// Start a rococo parachain node. pub async fn start_rococo_parachain_node( parachain_config: Configuration, collator_key: CollatorPair, polkadot_config: Configuration, id: ParaId, ) -> sc_service::error::Result< (TaskManager, Arc>) > { start_node_impl::( parachain_config, collator_key, polkadot_config, id, |_| Default::default(), rococo_parachain_build_import_queue, |client, prometheus_registry, telemetry, task_manager, relay_chain_node, transaction_pool, sync_oracle, keystore, force_authoring| { let slot_duration = cumulus_client_consensus_aura::slot_duration(&*client)?; let proposer_factory = sc_basic_authorship::ProposerFactory::with_proof_recording( task_manager.spawn_handle(), client.clone(), transaction_pool, prometheus_registry.clone(), telemetry.clone(), ); let relay_chain_backend = relay_chain_node.backend.clone(); let relay_chain_client = relay_chain_node.client.clone(); Ok(build_aura_consensus::< sp_consensus_aura::sr25519::AuthorityPair, _, _, _, _, _, _, _, _, _, >(BuildAuraConsensusParams { proposer_factory, create_inherent_data_providers: move |_, (relay_parent, validation_data)| { let parachain_inherent = cumulus_primitives_parachain_inherent::ParachainInherentData::create_at_with_client( relay_parent, &relay_chain_client, &*relay_chain_backend, &validation_data, id, ); async move { let time = sp_timestamp::InherentDataProvider::from_system_time(); let slot = sp_consensus_aura::inherents::InherentDataProvider::from_timestamp_and_duration( *time, slot_duration.slot_duration(), ); let parachain_inherent = parachain_inherent.ok_or_else(|| { Box::::from( "Failed to create parachain inherent", ) })?; Ok((time, slot, parachain_inherent)) } }, block_import: client.clone(), relay_chain_client: relay_chain_node.client.clone(), relay_chain_backend: relay_chain_node.backend.clone(), para_client: client.clone(), backoff_authoring_blocks: Option::<()>::None, sync_oracle, keystore, force_authoring, slot_duration, // We got around 500ms for proposing block_proposal_slot_portion: SlotProportion::new(1f32 / 24f32), telemetry, })) }, ) .await } /// Build the import queue for the shell runtime. pub fn shell_build_import_queue( client: Arc>, config: &Configuration, _: Option, task_manager: &TaskManager, ) -> Result< sp_consensus::DefaultImportQueue< Block, TFullClient, >, sc_service::Error, > { cumulus_client_consensus_relay_chain::import_queue( client.clone(), client, |_, _| async { Ok(()) }, &task_manager.spawn_essential_handle(), config.prometheus_registry().clone(), ) .map_err(Into::into) } /// Start a rococo-shell parachain node. pub async fn start_shell_node( parachain_config: Configuration, collator_key: CollatorPair, polkadot_config: Configuration, id: ParaId, ) -> sc_service::error::Result< (TaskManager, Arc>) > { start_node_impl::( parachain_config, collator_key, polkadot_config, id, |_| Default::default(), shell_build_import_queue, |client, prometheus_registry, telemetry, task_manager, relay_chain_node, transaction_pool, _, _, _| { let proposer_factory = sc_basic_authorship::ProposerFactory::with_proof_recording( task_manager.spawn_handle(), client.clone(), transaction_pool, prometheus_registry.clone(), telemetry.clone(), ); let relay_chain_backend = relay_chain_node.backend.clone(); let relay_chain_client = relay_chain_node.client.clone(); Ok( cumulus_client_consensus_relay_chain::build_relay_chain_consensus( cumulus_client_consensus_relay_chain::BuildRelayChainConsensusParams { para_id: id, proposer_factory, block_import: client.clone(), relay_chain_client: relay_chain_node.client.clone(), relay_chain_backend: relay_chain_node.backend.clone(), create_inherent_data_providers: move |_, (relay_parent, validation_data)| { let parachain_inherent = cumulus_primitives_parachain_inherent::ParachainInherentData::create_at_with_client( relay_parent, &relay_chain_client, &*relay_chain_backend, &validation_data, id, ); async move { let parachain_inherent = parachain_inherent.ok_or_else(|| { Box::::from( "Failed to create parachain inherent", ) })?; Ok(parachain_inherent) } }, }, ), ) }, ) .await }