// Copyright 2019-2020 Parity Technologies (UK) Ltd. // This file is part of substrate-subxt. // // subxt 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. // // subxt 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 substrate-subxt. If not, see . //! Service and ServiceFactory implementation. Specialized wrapper over substrate service. use sc_client_api::{ ExecutorProvider, RemoteBackend, }; use sc_executor::native_executor_instance; pub use sc_executor::NativeExecutor; use sc_finality_grandpa::{ FinalityProofProvider as GrandpaFinalityProofProvider, SharedVoterState, StorageAndProofProvider, }; use sc_service::{ error::Error as ServiceError, Configuration, RpcHandlers, TaskManager, SpawnTasksParams, BuildNetworkParams, build_network, }; use sp_consensus_aura::sr25519::AuthorityPair as AuraPair; use sp_inherents::InherentDataProviders; use std::{ sync::Arc, time::Duration, }; use test_node_runtime::{ self, opaque::Block, RuntimeApi, }; // Our native executor instance. native_executor_instance!( pub Executor, test_node_runtime::api::dispatch, test_node_runtime::native_version, ); /// Builds a new service for a full client. pub fn new_full(config: Configuration) -> Result<(TaskManager, RpcHandlers), ServiceError> { let inherent_data_providers = sp_inherents::InherentDataProviders::new(); let (client, backend, keystore, mut task_manager) = sc_service::new_full_parts::(&config)?; let client = Arc::new(client); let select_chain = sc_consensus::LongestChain::new(backend.clone()); let transaction_pool = sc_transaction_pool::BasicPool::new_full( config.transaction_pool.clone(), config.prometheus_registry(), task_manager.spawn_handle(), client.clone(), ); let (grandpa_block_import, grandpa_link) = sc_finality_grandpa::block_import( client.clone(), &(client.clone() as Arc<_>), select_chain.clone(), )?; let aura_block_import = sc_consensus_aura::AuraBlockImport::<_, _, _, AuraPair>::new( grandpa_block_import.clone(), client.clone(), ); let import_queue = sc_consensus_aura::import_queue::<_, _, _, AuraPair, _>( sc_consensus_aura::slot_duration(&*client)?, aura_block_import, Some(Box::new(grandpa_block_import.clone())), None, client.clone(), inherent_data_providers.clone(), &task_manager.spawn_handle(), config.prometheus_registry(), )?; let ( role, force_authoring, name, enable_grandpa, prometheus_registry, ) = ( config.role.clone(), config.force_authoring, config.network.node_name.clone(), !config.disable_grandpa, config.prometheus_registry().cloned(), ); let provider = client.clone() as Arc>; let finality_proof_provider = Arc::new(GrandpaFinalityProofProvider::new(backend.clone(), provider)); let (network, network_status_sinks, system_rpc_tx) = build_network(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, finality_proof_request_builder: None, finality_proof_provider: Some(finality_proof_provider), })?; let params = SpawnTasksParams { config, client: client.clone(), backend: backend.clone(), task_manager: &mut task_manager, keystore: keystore.clone(), on_demand: None, transaction_pool: transaction_pool.clone(), rpc_extensions_builder: Box::new(|_| {}), remote_blockchain: None, network: network.clone(), network_status_sinks, system_rpc_tx, telemetry_connection_sinks: Default::default() }; let rpc_handlers = sc_service::spawn_tasks(params)?; if role.is_authority() { let proposer = sc_basic_authorship::ProposerFactory::new( client.clone(), transaction_pool, prometheus_registry.as_ref(), ); let can_author_with = sp_consensus::CanAuthorWithNativeVersion::new(client.executor().clone()); let aura = sc_consensus_aura::start_aura::<_, _, _, _, _, AuraPair, _, _, _>( sc_consensus_aura::slot_duration(&*client)?, client.clone(), select_chain, grandpa_block_import, proposer, network.clone(), inherent_data_providers.clone(), force_authoring, keystore.clone(), can_author_with, )?; // the AURA authoring task is considered essential, i.e. if it // fails we take down the service with it. task_manager .spawn_essential_handle() .spawn_blocking("aura", aura); } // 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 = if role.is_authority() { Some(keystore as sp_core::traits::BareCryptoStorePtr) } else { None }; let grandpa_config = sc_finality_grandpa::Config { gossip_duration: Duration::from_millis(333), justification_period: 512, name: Some(name), observer_enabled: false, keystore, is_authority: role.is_network_authority(), }; if enable_grandpa { // start the full GRANDPA voter // NOTE: non-authorities could run the GRANDPA observer protocol, but at // this point the full voter should provide better guarantees of block // and vote data availability than the observer. The observer has not // been tested extensively yet and having most nodes in a network run it // could lead to finality stalls. let grandpa_config = sc_finality_grandpa::GrandpaParams { config: grandpa_config, link: grandpa_link, network, inherent_data_providers, telemetry_on_connect: None, voting_rule: sc_finality_grandpa::VotingRulesBuilder::default().build(), prometheus_registry, shared_voter_state: SharedVoterState::empty(), }; // the GRANDPA voter task is considered infallible, i.e. // if it fails we take down the service with it. task_manager.spawn_essential_handle().spawn_blocking( "grandpa-voter", sc_finality_grandpa::run_grandpa_voter(grandpa_config)?, ); } else { sc_finality_grandpa::setup_disabled_grandpa( client, &inherent_data_providers, network, )?; } Ok((task_manager, rpc_handlers)) } /// Builds a new service for a light client. pub fn new_light( config: Configuration, ) -> Result<(TaskManager, RpcHandlers), ServiceError> { let (client, backend, keystore, mut task_manager, on_demand) = sc_service::new_light_parts::(&config)?; let transaction_pool = Arc::new(sc_transaction_pool::BasicPool::new_light( config.transaction_pool.clone(), config.prometheus_registry(), task_manager.spawn_handle(), client.clone(), on_demand.clone(), )); let grandpa_block_import = sc_finality_grandpa::light_block_import( client.clone(), backend.clone(), &(client.clone() as Arc<_>), Arc::new(on_demand.checker().clone()) as Arc<_>, )?; let finality_proof_import = grandpa_block_import.clone(); let finality_proof_request_builder = finality_proof_import.create_finality_proof_request_builder(); let import_queue = sc_consensus_aura::import_queue::<_, _, _, AuraPair, _>( sc_consensus_aura::slot_duration(&*client)?, grandpa_block_import, None, Some(Box::new(finality_proof_import)), client.clone(), InherentDataProviders::new(), &task_manager.spawn_handle(), config.prometheus_registry(), )?; let finality_proof_provider = Arc::new(GrandpaFinalityProofProvider::new( backend.clone(), client.clone() as Arc<_>, )); let (network, network_status_sinks, system_rpc_tx) = build_network(BuildNetworkParams { config: &config, client: client.clone(), transaction_pool: transaction_pool.clone(), spawn_handle: task_manager.spawn_handle(), import_queue, on_demand: Some(on_demand.clone()), block_announce_validator_builder: None, finality_proof_request_builder: Some(finality_proof_request_builder), finality_proof_provider: Some(finality_proof_provider), })?; let params = SpawnTasksParams { on_demand: Some(on_demand), network, client, backend: backend.clone(), network_status_sinks, system_rpc_tx, telemetry_connection_sinks: Default::default(), remote_blockchain: Some(backend.remote_blockchain()), rpc_extensions_builder: Box::new(|_| ()), transaction_pool, config, keystore, task_manager: &mut task_manager, }; sc_service::spawn_tasks(params) .map(|rpc_handlers| (task_manager, rpc_handlers)) }