use futures::prelude::*; use futures::select; use polkadot_node_subsystem::{messages::{AllMessages, ProvisionerInherentData, ProvisionerMessage}, SubsystemError}; use polkadot_overseer::OverseerHandler; use polkadot_primitives::v1::{ Block, Hash, Header, }; use sc_block_builder::{BlockBuilderApi, BlockBuilderProvider}; use sp_api::{ApiExt, ProvideRuntimeApi}; use sp_blockchain::HeaderBackend; use sp_consensus::{Proposal, RecordProof}; use sp_inherents::InherentData; use sp_runtime::traits::{DigestFor, HashFor}; use sp_transaction_pool::TransactionPool; use std::{fmt, pin::Pin, sync::Arc, time}; /// How long proposal can take before we give up and err out const PROPOSE_TIMEOUT: core::time::Duration = core::time::Duration::from_secs(2); /// Custom Proposer factory for Polkadot pub struct ProposerFactory { inner: sc_basic_authorship::ProposerFactory, overseer: OverseerHandler, } impl ProposerFactory { pub fn new( client: Arc, transaction_pool: Arc, overseer: OverseerHandler, ) -> Self { ProposerFactory { inner: sc_basic_authorship::ProposerFactory::new( client, transaction_pool, None, ), overseer, } } } impl sp_consensus::Environment for ProposerFactory where TxPool: 'static + TransactionPool, Client: 'static + BlockBuilderProvider + ProvideRuntimeApi + HeaderBackend + Send + Sync, Client::Api: BlockBuilderApi + ApiExt, Backend: 'static + sc_client_api::Backend>, // Rust bug: https://github.com/rust-lang/rust/issues/24159 sp_api::StateBackendFor: sp_api::StateBackend> + Send, { type CreateProposer = Pin> + Send + 'static, >>; type Proposer = Proposer; type Error = Error; fn init(&mut self, parent_header: &Header) -> Self::CreateProposer { // create the inner proposer let proposer = self.inner.init(parent_header).into_inner(); // data to be moved into the future let overseer = self.overseer.clone(); let parent_header_hash = parent_header.hash(); async move { Ok(Proposer { inner: proposer?, overseer, parent_header_hash, }) }.boxed() } } /// Custom Proposer for Polkadot. /// /// This proposer gets the ProvisionerInherentData and injects it into the wrapped /// proposer's inherent data, then delegates the actual proposal generation. pub struct Proposer, Backend, Client> { inner: sc_basic_authorship::Proposer, overseer: OverseerHandler, parent_header_hash: Hash, } // This impl has the same generic bounds as the Proposer impl. impl Proposer where TxPool: 'static + TransactionPool, Client: 'static + BlockBuilderProvider + ProvideRuntimeApi + HeaderBackend + Send + Sync, Client::Api: BlockBuilderApi + ApiExt, Backend: 'static + sc_client_api::Backend>, // Rust bug: https://github.com/rust-lang/rust/issues/24159 sp_api::StateBackendFor: sp_api::StateBackend> + Send, { /// Get provisioner inherent data /// /// This function has a constant timeout: `PROPOSE_TIMEOUT`. fn get_provisioner_data(&self) -> impl Future> { // clone this (lightweight) data because we're going to move it into the future let mut overseer = self.overseer.clone(); let parent_header_hash = self.parent_header_hash.clone(); let mut provisioner_inherent_data = async move { let (sender, receiver) = futures::channel::oneshot::channel(); // strictly speaking, we don't _have_ to .await this send_msg before opening the // receiver; it's possible that the response there would be ready slightly before // this call completes. IMO it's not worth the hassle or overhead of spawning a // distinct task for that kind of miniscule efficiency improvement. overseer.send_msg(AllMessages::Provisioner( ProvisionerMessage::RequestInherentData(parent_header_hash, sender), )).await?; receiver.await.map_err(Error::ClosedChannelFromProvisioner) } .boxed() .fuse(); let mut timeout = wasm_timer::Delay::new(PROPOSE_TIMEOUT).fuse(); async move { select! { pid = provisioner_inherent_data => pid, _ = timeout => Err(Error::Timeout), } } } } impl sp_consensus::Proposer for Proposer where TxPool: 'static + TransactionPool, Client: 'static + BlockBuilderProvider + ProvideRuntimeApi + HeaderBackend + Send + Sync, Client::Api: BlockBuilderApi + ApiExt, Backend: 'static + sc_client_api::Backend>, // Rust bug: https://github.com/rust-lang/rust/issues/24159 sp_api::StateBackendFor: sp_api::StateBackend> + Send, { type Transaction = sc_client_api::TransactionFor; type Proposal = Pin>, Error>> + Send, >>; type Error = Error; fn propose( self, mut inherent_data: InherentData, inherent_digests: DigestFor, max_duration: time::Duration, record_proof: RecordProof, ) -> Self::Proposal { let provisioner_data = self.get_provisioner_data(); async move { let provisioner_data = match provisioner_data.await { Ok(pd) => pd, Err(err) => { log::warn!("could not get provisioner inherent data; injecting default data: {}", err); Default::default() } }; inherent_data.put_data( polkadot_primitives::v1::INCLUSION_INHERENT_IDENTIFIER, &provisioner_data, )?; self.inner .propose(inherent_data, inherent_digests, max_duration, record_proof) .await .map_err(Into::into) } .boxed() } } // It would have been more ergonomic to use thiserror to derive the // From implementations, Display, and std::error::Error, but unfortunately // two of the wrapped errors (sp_inherents::Error, SubsystemError) also // don't impl std::error::Error, which breaks the thiserror derive. #[derive(Debug)] pub enum Error { Consensus(sp_consensus::Error), Blockchain(sp_blockchain::Error), Inherent(sp_inherents::Error), Timeout, ClosedChannelFromProvisioner(futures::channel::oneshot::Canceled), Subsystem(SubsystemError) } impl From for Error { fn from(e: sp_consensus::Error) -> Error { Error::Consensus(e) } } impl From for Error { fn from(e: sp_blockchain::Error) -> Error { Error::Blockchain(e) } } impl From for Error { fn from(e: sp_inherents::Error) -> Error { Error::Inherent(e) } } impl From for Error { fn from(e: SubsystemError) -> Error { Error::Subsystem(e) } } impl fmt::Display for Error { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match self { Self::Consensus(err) => write!(f, "consensus error: {}", err), Self::Blockchain(err) => write!(f, "blockchain error: {}", err), Self::Inherent(err) => write!(f, "inherent error: {:?}", err), Self::Timeout => write!(f, "timeout: provisioner did not return inherent data after {:?}", PROPOSE_TIMEOUT), Self::ClosedChannelFromProvisioner(err) => write!(f, "provisioner closed inherent data channel before sending: {}", err), Self::Subsystem(err) => write!(f, "subsystem error: {:?}", err), } } } impl std::error::Error for Error { fn source(&self) -> Option<&(dyn std::error::Error + 'static)> { match self { Self::Consensus(err) => Some(err), Self::Blockchain(err) => Some(err), Self::ClosedChannelFromProvisioner(err) => Some(err), _ => None } } }