// Copyright 2015-2019 Parity Technologies (UK) Ltd. // This file is part of Parity Ethereum. // Parity Ethereum 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. // Parity Ethereum 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 Parity Ethereum. If not, see . use std::sync::Arc; use std::collections::HashMap; use chain::sync_packet::{PacketInfo, SyncPacket}; use network::{NetworkContext, PeerId, PacketId, Error, SessionInfo, ProtocolId}; use network::client_version::ClientVersion; use bytes::Bytes; use client_traits::BlockChainClient; use ethcore_private_tx::PrivateStateDB; use types::BlockNumber; use ethcore::snapshot::SnapshotService; use parking_lot::RwLock; /// IO interface for the syncing handler. /// Provides peer connection management and an interface to the blockchain client. // TODO: ratings pub trait SyncIo { /// Disable a peer fn disable_peer(&mut self, peer_id: PeerId); /// Disconnect peer fn disconnect_peer(&mut self, peer_id: PeerId); /// Respond to current request with a packet. Can be called from an IO handler for incoming packet. fn respond(&mut self, packet_id: PacketId, data: Vec) -> Result<(), Error>; /// Send a packet to a peer using specified protocol. fn send(&mut self, peer_id: PeerId, packet_id: SyncPacket, data: Vec) -> Result<(), Error>; /// Get the blockchain fn chain(&self) -> &dyn BlockChainClient; /// Get the snapshot service. fn snapshot_service(&self) -> &dyn SnapshotService; /// Get the private state wrapper fn private_state(&self) -> Option>; /// Returns peer version identifier fn peer_version(&self, peer_id: PeerId) -> ClientVersion { ClientVersion::from(peer_id.to_string()) } /// Returns information on p2p session fn peer_session_info(&self, peer_id: PeerId) -> Option; /// Maximum mutually supported ETH protocol version fn eth_protocol_version(&self, peer_id: PeerId) -> u8; /// Maximum mutually supported version of a gien protocol. fn protocol_version(&self, protocol: &ProtocolId, peer_id: PeerId) -> u8; /// Returns if the chain block queue empty fn is_chain_queue_empty(&self) -> bool { self.chain().is_queue_empty() } /// Check if the session is expired fn is_expired(&self) -> bool; /// Return sync overlay fn chain_overlay(&self) -> &RwLock>; /// Returns the size the payload shouldn't exceed fn payload_soft_limit(&self) -> usize; } /// Wraps `NetworkContext` and the blockchain client pub struct NetSyncIo<'s> { network: &'s dyn NetworkContext, chain: &'s dyn BlockChainClient, snapshot_service: &'s dyn SnapshotService, chain_overlay: &'s RwLock>, private_state: Option>, } impl<'s> NetSyncIo<'s> { /// Creates a new instance from the `NetworkContext` and the blockchain client reference. pub fn new(network: &'s dyn NetworkContext, chain: &'s dyn BlockChainClient, snapshot_service: &'s dyn SnapshotService, chain_overlay: &'s RwLock>, private_state: Option>) -> NetSyncIo<'s> { NetSyncIo { network, chain, snapshot_service, chain_overlay, private_state, } } } impl<'s> SyncIo for NetSyncIo<'s> { fn disable_peer(&mut self, peer_id: PeerId) { self.network.disable_peer(peer_id); } fn disconnect_peer(&mut self, peer_id: PeerId) { self.network.disconnect_peer(peer_id); } fn respond(&mut self, packet_id: PacketId, data: Vec) -> Result<(), Error>{ self.network.respond(packet_id, data) } fn send(&mut self, peer_id: PeerId, packet_id: SyncPacket, data: Vec) -> Result<(), Error>{ self.network.send_protocol(packet_id.protocol(), peer_id, packet_id.id(), data) } fn chain(&self) -> &dyn BlockChainClient { self.chain } fn chain_overlay(&self) -> &RwLock> { self.chain_overlay } fn snapshot_service(&self) -> &dyn SnapshotService { self.snapshot_service } fn private_state(&self) -> Option> { self.private_state.clone() } fn peer_session_info(&self, peer_id: PeerId) -> Option { self.network.session_info(peer_id) } fn is_expired(&self) -> bool { self.network.is_expired() } fn eth_protocol_version(&self, peer_id: PeerId) -> u8 { self.network.protocol_version(self.network.subprotocol_name(), peer_id).unwrap_or(0) } fn protocol_version(&self, protocol: &ProtocolId, peer_id: PeerId) -> u8 { self.network.protocol_version(*protocol, peer_id).unwrap_or(0) } fn peer_version(&self, peer_id: PeerId) -> ClientVersion { self.network.peer_client_version(peer_id) } fn payload_soft_limit(&self) -> usize { self.network.payload_soft_limit() } }