#![allow(clippy::unit_arg)] use crate::error; use crate::service::NetworkMessage; use crate::MessageProcessor; use beacon_chain::{BeaconChain, BeaconChainTypes}; use eth2_libp2p::{ behaviour::PubsubMessage, rpc::{RPCError, RPCErrorResponse, RPCRequest, RPCResponse, RequestId, ResponseTermination}, MessageId, PeerId, RPCEvent, }; use futures::future::Future; use futures::stream::Stream; use slog::{debug, o, trace, warn}; use ssz::{Decode, DecodeError}; use std::sync::Arc; use tokio::sync::mpsc; use types::{Attestation, AttesterSlashing, ProposerSlashing, SignedBeaconBlock, VoluntaryExit}; /// Handles messages received from the network and client and organises syncing. This /// functionality of this struct is to validate an decode messages from the network before /// passing them to the internal message processor. The message processor spawns a syncing thread /// which manages which blocks need to be requested and processed. pub struct MessageHandler { /// A channel to the network service to allow for gossip propagation. network_send: mpsc::UnboundedSender, /// Processes validated and decoded messages from the network. Has direct access to the /// sync manager. message_processor: MessageProcessor, /// The `MessageHandler` logger. log: slog::Logger, } /// Types of messages the handler can receive. #[derive(Debug)] pub enum HandlerMessage { /// We have initiated a connection to a new peer. PeerDialed(PeerId), /// Peer has disconnected, PeerDisconnected(PeerId), /// An RPC response/request has been received. RPC(PeerId, RPCEvent), /// A gossip message has been received. The fields are: message id, the peer that sent us this /// message and the message itself. PubsubMessage(MessageId, PeerId, PubsubMessage), } impl MessageHandler { /// Initializes and runs the MessageHandler. pub fn spawn( beacon_chain: Arc>, network_send: mpsc::UnboundedSender, executor: &tokio::runtime::TaskExecutor, log: slog::Logger, ) -> error::Result> { let message_handler_log = log.new(o!("service"=> "msg_handler")); trace!(message_handler_log, "Service starting"); let (handler_send, handler_recv) = mpsc::unbounded_channel(); // Initialise a message instance, which itself spawns the syncing thread. let message_processor = MessageProcessor::new(executor, beacon_chain, network_send.clone(), &log); // generate the Message handler let mut handler = MessageHandler { network_send, message_processor, log: message_handler_log, }; // spawn handler task and move the message handler instance into the spawned thread executor.spawn( handler_recv .for_each(move |msg| Ok(handler.handle_message(msg))) .map_err(move |_| { debug!(log, "Network message handler terminated."); }), ); Ok(handler_send) } /// Handle all messages incoming from the network service. fn handle_message(&mut self, message: HandlerMessage) { match message { // we have initiated a connection to a peer HandlerMessage::PeerDialed(peer_id) => { self.message_processor.on_connect(peer_id); } // A peer has disconnected HandlerMessage::PeerDisconnected(peer_id) => { self.message_processor.on_disconnect(peer_id); } // An RPC message request/response has been received HandlerMessage::RPC(peer_id, rpc_event) => { self.handle_rpc_message(peer_id, rpc_event); } // An RPC message request/response has been received HandlerMessage::PubsubMessage(id, peer_id, gossip) => { self.handle_gossip(id, peer_id, gossip); } } } /* RPC - Related functionality */ /// Handle RPC messages fn handle_rpc_message(&mut self, peer_id: PeerId, rpc_message: RPCEvent) { match rpc_message { RPCEvent::Request(id, req) => self.handle_rpc_request(peer_id, id, req), RPCEvent::Response(id, resp) => self.handle_rpc_response(peer_id, id, resp), RPCEvent::Error(id, error) => self.handle_rpc_error(peer_id, id, error), } } /// A new RPC request has been received from the network. fn handle_rpc_request(&mut self, peer_id: PeerId, request_id: RequestId, request: RPCRequest) { match request { RPCRequest::Status(status_message) => { self.message_processor .on_status_request(peer_id, request_id, status_message) } RPCRequest::Goodbye(goodbye_reason) => { debug!( self.log, "PeerGoodbye"; "peer" => format!("{:?}", peer_id), "reason" => format!("{:?}", goodbye_reason), ); self.message_processor.on_disconnect(peer_id); } RPCRequest::BlocksByRange(request) => self .message_processor .on_blocks_by_range_request(peer_id, request_id, request), RPCRequest::BlocksByRoot(request) => self .message_processor .on_blocks_by_root_request(peer_id, request_id, request), } } /// An RPC response has been received from the network. // we match on id and ignore responses past the timeout. fn handle_rpc_response( &mut self, peer_id: PeerId, request_id: RequestId, error_response: RPCErrorResponse, ) { // an error could have occurred. match error_response { RPCErrorResponse::InvalidRequest(error) => { warn!(self.log, "Peer indicated invalid request";"peer_id" => format!("{:?}", peer_id), "error" => error.as_string()); self.handle_rpc_error(peer_id, request_id, RPCError::RPCErrorResponse); } RPCErrorResponse::ServerError(error) => { warn!(self.log, "Peer internal server error";"peer_id" => format!("{:?}", peer_id), "error" => error.as_string()); self.handle_rpc_error(peer_id, request_id, RPCError::RPCErrorResponse); } RPCErrorResponse::Unknown(error) => { warn!(self.log, "Unknown peer error";"peer" => format!("{:?}", peer_id), "error" => error.as_string()); self.handle_rpc_error(peer_id, request_id, RPCError::RPCErrorResponse); } RPCErrorResponse::Success(response) => { match response { RPCResponse::Status(status_message) => { self.message_processor .on_status_response(peer_id, status_message); } RPCResponse::BlocksByRange(response) => { match self.decode_beacon_block(response) { Ok(beacon_block) => { self.message_processor.on_blocks_by_range_response( peer_id, request_id, Some(beacon_block), ); } Err(e) => { // TODO: Down-vote Peer warn!(self.log, "Peer sent invalid BEACON_BLOCKS response";"peer" => format!("{:?}", peer_id), "error" => format!("{:?}", e)); } } } RPCResponse::BlocksByRoot(response) => { match self.decode_beacon_block(response) { Ok(beacon_block) => { self.message_processor.on_blocks_by_root_response( peer_id, request_id, Some(beacon_block), ); } Err(e) => { // TODO: Down-vote Peer warn!(self.log, "Peer sent invalid BEACON_BLOCKS response";"peer" => format!("{:?}", peer_id), "error" => format!("{:?}", e)); } } } } } RPCErrorResponse::StreamTermination(response_type) => { // have received a stream termination, notify the processing functions match response_type { ResponseTermination::BlocksByRange => { self.message_processor .on_blocks_by_range_response(peer_id, request_id, None); } ResponseTermination::BlocksByRoot => { self.message_processor .on_blocks_by_root_response(peer_id, request_id, None); } } } } } /// Handle various RPC errors fn handle_rpc_error(&mut self, peer_id: PeerId, request_id: RequestId, error: RPCError) { warn!(self.log, "RPC Error"; "Peer" => format!("{:?}", peer_id), "request_id" => format!("{}", request_id), "Error" => format!("{:?}", error)); self.message_processor.on_rpc_error(peer_id, request_id); } /// Handle RPC messages fn handle_gossip(&mut self, id: MessageId, peer_id: PeerId, gossip_message: PubsubMessage) { match gossip_message { PubsubMessage::Block(message) => match self.decode_gossip_block(message) { Ok(block) => { let should_forward_on = self .message_processor .on_block_gossip(peer_id.clone(), block); // TODO: Apply more sophisticated validation and decoding logic if should_forward_on { self.propagate_message(id, peer_id); } } Err(e) => { debug!(self.log, "Invalid gossiped beacon block"; "peer_id" => format!("{}", peer_id), "Error" => format!("{:?}", e)); } }, PubsubMessage::Attestation(message) => match self.decode_gossip_attestation(message) { Ok(attestation) => { // TODO: Apply more sophisticated validation and decoding logic self.propagate_message(id, peer_id.clone()); self.message_processor .on_attestation_gossip(peer_id, attestation); } Err(e) => { debug!(self.log, "Invalid gossiped attestation"; "peer_id" => format!("{}", peer_id), "Error" => format!("{:?}", e)); } }, PubsubMessage::VoluntaryExit(message) => match self.decode_gossip_exit(message) { Ok(_exit) => { // TODO: Apply more sophisticated validation and decoding logic self.propagate_message(id, peer_id.clone()); // TODO: Handle exits debug!(self.log, "Received a voluntary exit"; "peer_id" => format!("{}", peer_id) ); } Err(e) => { debug!(self.log, "Invalid gossiped exit"; "peer_id" => format!("{}", peer_id), "Error" => format!("{:?}", e)); } }, PubsubMessage::ProposerSlashing(message) => { match self.decode_gossip_proposer_slashing(message) { Ok(_slashing) => { // TODO: Apply more sophisticated validation and decoding logic self.propagate_message(id, peer_id.clone()); // TODO: Handle proposer slashings debug!(self.log, "Received a proposer slashing"; "peer_id" => format!("{}", peer_id) ); } Err(e) => { debug!(self.log, "Invalid gossiped proposer slashing"; "peer_id" => format!("{}", peer_id), "Error" => format!("{:?}", e)); } } } PubsubMessage::AttesterSlashing(message) => { match self.decode_gossip_attestation_slashing(message) { Ok(_slashing) => { // TODO: Apply more sophisticated validation and decoding logic self.propagate_message(id, peer_id.clone()); // TODO: Handle attester slashings debug!(self.log, "Received an attester slashing"; "peer_id" => format!("{}", peer_id) ); } Err(e) => { debug!(self.log, "Invalid gossiped attester slashing"; "peer_id" => format!("{}", peer_id), "Error" => format!("{:?}", e)); } } } PubsubMessage::Unknown(message) => { // Received a message from an unknown topic. Ignore for now debug!(self.log, "Unknown Gossip Message"; "peer_id" => format!("{}", peer_id), "Message" => format!("{:?}", message)); } } } /// Informs the network service that the message should be forwarded to other peers. fn propagate_message(&mut self, message_id: MessageId, propagation_source: PeerId) { self.network_send .try_send(NetworkMessage::Propagate { propagation_source, message_id, }) .unwrap_or_else(|_| { warn!( self.log, "Could not send propagation request to the network service" ) }); } /* Decoding of gossipsub objects from the network. * * The decoding is done in the message handler as it has access to to a `BeaconChain` and can * therefore apply more efficient logic in decoding and verification. * * TODO: Apply efficient decoding/verification of these objects */ /* Gossipsub Domain Decoding */ // Note: These are not generics as type-specific verification will need to be applied. fn decode_gossip_block( &self, beacon_block: Vec, ) -> Result, DecodeError> { //TODO: Apply verification before decoding. SignedBeaconBlock::from_ssz_bytes(&beacon_block) } fn decode_gossip_attestation( &self, beacon_block: Vec, ) -> Result, DecodeError> { //TODO: Apply verification before decoding. Attestation::from_ssz_bytes(&beacon_block) } fn decode_gossip_exit(&self, voluntary_exit: Vec) -> Result { //TODO: Apply verification before decoding. VoluntaryExit::from_ssz_bytes(&voluntary_exit) } fn decode_gossip_proposer_slashing( &self, proposer_slashing: Vec, ) -> Result { //TODO: Apply verification before decoding. ProposerSlashing::from_ssz_bytes(&proposer_slashing) } fn decode_gossip_attestation_slashing( &self, attester_slashing: Vec, ) -> Result, DecodeError> { //TODO: Apply verification before decoding. AttesterSlashing::from_ssz_bytes(&attester_slashing) } /* Req/Resp Domain Decoding */ /// Verifies and decodes an ssz-encoded `SignedBeaconBlock`. If `None` is passed, this represents a /// stream termination. fn decode_beacon_block( &self, beacon_block: Vec, ) -> Result, DecodeError> { //TODO: Implement faster block verification before decoding entirely SignedBeaconBlock::from_ssz_bytes(&beacon_block) } }