openethereum/crates/ethcore/sync/src/sync_io.rs

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

134 lines
4.7 KiB
Rust
Raw Normal View History

2020-09-22 14:53:52 +02:00
// Copyright 2015-2020 Parity Technologies (UK) Ltd.
// This file is part of OpenEthereum.
2016-02-05 13:40:41 +01:00
2020-09-22 14:53:52 +02:00
// OpenEthereum is free software: you can redistribute it and/or modify
2016-02-05 13:40:41 +01:00
// 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.
2020-09-22 14:53:52 +02:00
// OpenEthereum is distributed in the hope that it will be useful,
2016-02-05 13:40:41 +01:00
// 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
2020-09-22 14:53:52 +02:00
// along with OpenEthereum. If not, see <http://www.gnu.org/licenses/>.
2016-02-05 13:40:41 +01:00
use bytes::Bytes;
2016-05-31 20:54:02 +02:00
use chain::sync_packet::{PacketInfo, SyncPacket};
use ethcore::{client::BlockChainClient, snapshot::SnapshotService};
2017-11-13 14:37:08 +01:00
use network::{
client_version::ClientVersion, Error, NetworkContext, PacketId, PeerId, ProtocolId, SessionInfo,
2020-08-05 06:08:03 +02:00
};
use parking_lot::RwLock;
use std::collections::HashMap;
use types::BlockNumber;
/// IO interface for the syncing handler.
2016-01-10 23:37:09 +01:00
/// Provides peer connection management and an interface to the blockchain client.
// TODO: ratings
pub trait SyncIo {
2016-01-10 23:37:09 +01:00
/// Disable a peer
2016-01-14 19:03:48 +01:00
fn disable_peer(&mut self, peer_id: PeerId);
2016-02-02 14:54:46 +01:00
/// Disconnect peer
fn disconnect_peer(&mut self, peer_id: PeerId);
2016-01-10 23:37:09 +01:00
/// Respond to current request with a packet. Can be called from an IO handler for incoming packet.
2017-11-13 14:37:08 +01:00
fn respond(&mut self, packet_id: PacketId, data: Vec<u8>) -> Result<(), Error>;
/// Send a packet to a peer using specified protocol.
fn send(&mut self, peer_id: PeerId, packet_id: SyncPacket, data: Vec<u8>) -> Result<(), Error>;
2016-01-10 23:37:09 +01:00
/// Get the blockchain
2020-07-29 10:36:15 +02:00
fn chain(&self) -> &dyn BlockChainClient;
/// Get the snapshot service.
2020-07-29 10:36:15 +02:00
fn snapshot_service(&self) -> &dyn SnapshotService;
Increase number of requested block bodies in chain sync (#10247) * Increase the number of block bodies requested during Sync. * Increase the number of block bodies requested during Sync. * Check if our peer is an older parity client with the bug of not handling large requests properly * Add a ClientVersion struct and a ClientCapabilites trait * Make ClientVersion its own module * Refactor and extend use of ClientVersion * Replace strings with ClientVersion in PeerInfo * Group further functionality in ClientCapabilities * Move parity client version data from tuple to its own struct. * Implement accessor methods for ParityClientData and remove them from ClientVersion. * Minor fixes * Make functions specific to parity return types specific to parity. * Test for shorter ID strings * Fix formatting and remove unneeded dependencies. * Roll back Cargo.lock * Commit last Cargo.lock * Convert from string to ClientVersion * * When checking if peer accepts service transactions just check if it's parity, remove version check. * Remove dependency on semver in ethcore-sync * Remove unnecessary String instantiation * Rename peer_info to peer_version * Update RPC test helpers * Simplify From<String> * Parse static version string only once * Update RPC tests to new ClientVersion struct * Document public members * More robust parsing of ID string * Minor changes. * Update version in which large block bodies requests appear. * Update ethcore/sync/src/block_sync.rs Co-Authored-By: elferdo <elferdo@gmail.com> * Update util/network/src/client_version.rs Co-Authored-By: elferdo <elferdo@gmail.com> * Update util/network/src/client_version.rs Co-Authored-By: elferdo <elferdo@gmail.com> * Update tests. * Minor fixes.
2019-02-07 15:27:09 +01:00
/// Returns peer version identifier
fn peer_version(&self, peer_id: PeerId) -> ClientVersion {
ClientVersion::from(peer_id.to_string())
2016-01-14 19:03:48 +01:00
}
/// Returns information on p2p session
fn peer_session_info(&self, peer_id: PeerId) -> Option<SessionInfo>;
/// Maximum mutually supported version of a gien protocol.
fn protocol_version(&self, protocol: ProtocolId, peer_id: PeerId) -> u8;
2016-03-17 14:56:19 +01:00
/// Returns if the chain block queue empty
fn is_chain_queue_empty(&self) -> bool {
self.chain().is_queue_empty()
2016-03-17 14:56:19 +01:00
}
/// Check if the session is expired
fn is_expired(&self) -> bool;
/// Return sync overlay
fn chain_overlay(&self) -> &RwLock<HashMap<BlockNumber, Bytes>>;
}
2016-01-13 15:10:48 +01:00
/// Wraps `NetworkContext` and the blockchain client
pub struct NetSyncIo<'s> {
2020-07-29 10:36:15 +02:00
network: &'s dyn NetworkContext,
chain: &'s dyn BlockChainClient,
snapshot_service: &'s dyn SnapshotService,
chain_overlay: &'s RwLock<HashMap<BlockNumber, Bytes>>,
}
impl<'s> NetSyncIo<'s> {
2016-01-13 15:10:48 +01:00
/// Creates a new instance from the `NetworkContext` and the blockchain client reference.
pub fn new(
2020-07-29 10:36:15 +02:00
network: &'s dyn NetworkContext,
chain: &'s dyn BlockChainClient,
snapshot_service: &'s dyn SnapshotService,
chain_overlay: &'s RwLock<HashMap<BlockNumber, Bytes>>,
) -> NetSyncIo<'s> {
NetSyncIo {
network: network,
chain: chain,
snapshot_service: snapshot_service,
chain_overlay: chain_overlay,
}
}
}
impl<'s> SyncIo for NetSyncIo<'s> {
2016-01-14 19:03:48 +01:00
fn disable_peer(&mut self, peer_id: PeerId) {
self.network.disable_peer(peer_id);
}
2020-08-05 06:08:03 +02:00
2016-02-02 14:54:46 +01:00
fn disconnect_peer(&mut self, peer_id: PeerId) {
self.network.disconnect_peer(peer_id);
}
2020-08-05 06:08:03 +02:00
2017-11-13 14:37:08 +01:00
fn respond(&mut self, packet_id: PacketId, data: Vec<u8>) -> Result<(), Error> {
self.network.respond(packet_id, data)
}
2020-08-05 06:08:03 +02:00
fn send(&mut self, peer_id: PeerId, packet_id: SyncPacket, data: Vec<u8>) -> Result<(), Error> {
self.network
.send_protocol(packet_id.protocol(), peer_id, packet_id.id(), data)
}
2020-08-05 06:08:03 +02:00
2020-07-29 10:36:15 +02:00
fn chain(&self) -> &dyn BlockChainClient {
self.chain
}
2020-08-05 06:08:03 +02:00
fn chain_overlay(&self) -> &RwLock<HashMap<BlockNumber, Bytes>> {
self.chain_overlay
}
2020-08-05 06:08:03 +02:00
2020-07-29 10:36:15 +02:00
fn snapshot_service(&self) -> &dyn SnapshotService {
self.snapshot_service
}
2020-08-05 06:08:03 +02:00
fn peer_session_info(&self, peer_id: PeerId) -> Option<SessionInfo> {
self.network.session_info(peer_id)
2016-01-14 19:03:48 +01:00
}
2020-08-05 06:08:03 +02:00
fn is_expired(&self) -> bool {
self.network.is_expired()
}
2020-08-05 06:08:03 +02:00
fn protocol_version(&self, protocol: ProtocolId, peer_id: PeerId) -> u8 {
self.network
.protocol_version(protocol, peer_id)
.unwrap_or(0)
}
2020-08-05 06:08:03 +02:00
Increase number of requested block bodies in chain sync (#10247) * Increase the number of block bodies requested during Sync. * Increase the number of block bodies requested during Sync. * Check if our peer is an older parity client with the bug of not handling large requests properly * Add a ClientVersion struct and a ClientCapabilites trait * Make ClientVersion its own module * Refactor and extend use of ClientVersion * Replace strings with ClientVersion in PeerInfo * Group further functionality in ClientCapabilities * Move parity client version data from tuple to its own struct. * Implement accessor methods for ParityClientData and remove them from ClientVersion. * Minor fixes * Make functions specific to parity return types specific to parity. * Test for shorter ID strings * Fix formatting and remove unneeded dependencies. * Roll back Cargo.lock * Commit last Cargo.lock * Convert from string to ClientVersion * * When checking if peer accepts service transactions just check if it's parity, remove version check. * Remove dependency on semver in ethcore-sync * Remove unnecessary String instantiation * Rename peer_info to peer_version * Update RPC test helpers * Simplify From<String> * Parse static version string only once * Update RPC tests to new ClientVersion struct * Document public members * More robust parsing of ID string * Minor changes. * Update version in which large block bodies requests appear. * Update ethcore/sync/src/block_sync.rs Co-Authored-By: elferdo <elferdo@gmail.com> * Update util/network/src/client_version.rs Co-Authored-By: elferdo <elferdo@gmail.com> * Update util/network/src/client_version.rs Co-Authored-By: elferdo <elferdo@gmail.com> * Update tests. * Minor fixes.
2019-02-07 15:27:09 +01:00
fn peer_version(&self, peer_id: PeerId) -> ClientVersion {
2016-12-10 14:20:34 +01:00
self.network.peer_client_version(peer_id)
}
}