mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-04-26 14:37:57 +00:00
Aaro Altonen
80616f6d03
[litep2p](https://github.com/altonen/litep2p) is a libp2p-compatible P2P networking library. It supports all of the features of `rust-libp2p` that are currently being utilized by Polkadot SDK. Compared to `rust-libp2p`, `litep2p` has a quite different architecture which is why the new `litep2p` network backend is only able to use a little of the existing code in `sc-network`. The design has been mainly influenced by how we'd wish to structure our networking-related code in Polkadot SDK: independent higher-levels protocols directly communicating with the network over links that support bidirectional backpressure. A good example would be `NotificationHandle`/`RequestResponseHandle` abstractions which allow, e.g., `SyncingEngine` to directly communicate with peers to announce/request blocks. I've tried running `polkadot --network-backend litep2p` with a few different peer configurations and there is a noticeable reduction in networking CPU usage. For high load (`--out-peers 200`), networking CPU usage goes down from ~110% to ~30% (80 pp) and for normal load (`--out-peers 40`), the usage goes down from ~55% to ~18% (37 pp). These should not be taken as final numbers because: a) there are still some low-hanging optimization fruits, such as enabling [receive window auto-tuning](https://github.com/libp2p/rust-yamux/pull/176), integrating `Peerset` more closely with `litep2p` or improving memory usage of the WebSocket transport b) fixing bugs/instabilities that incorrectly cause `litep2p` to do less work will increase the networking CPU usage c) verification in a more diverse set of tests/conditions is needed Nevertheless, these numbers should give an early estimate for CPU usage of the new networking backend. This PR consists of three separate changes: * introduce a generic `PeerId` (wrapper around `Multihash`) so that we don't have use `NetworkService::PeerId` in every part of the code that uses a `PeerId` * introduce `NetworkBackend` trait, implement it for the libp2p network stack and make Polkadot SDK generic over `NetworkBackend` * implement `NetworkBackend` for litep2p The new library should be considered experimental which is why `rust-libp2p` will remain as the default option for the time being. This PR currently depends on the master branch of `litep2p` but I'll cut a new release for the library once all review comments have been addresses. --------- Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> Co-authored-by: Dmitry Markin <dmitry@markin.tech> Co-authored-by: Alexandru Vasile <60601340+lexnv@users.noreply.github.com> Co-authored-by: Alexandru Vasile <alexandru.vasile@parity.io>
91 lines
2.9 KiB
Rust
91 lines
2.9 KiB
Rust
// This file is part of Substrate.
|
|
|
|
// Copyright (C) Parity Technologies (UK) Ltd.
|
|
// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0
|
|
|
|
// This program 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.
|
|
|
|
// This program 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 this program. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
//! Substrate network possible errors.
|
|
|
|
use crate::{config::TransportConfig, types::ProtocolName};
|
|
|
|
use libp2p::{Multiaddr, PeerId};
|
|
|
|
use std::fmt;
|
|
|
|
/// Result type alias for the network.
|
|
pub type Result<T> = std::result::Result<T, Error>;
|
|
|
|
/// Error type for the network.
|
|
#[derive(thiserror::Error)]
|
|
pub enum Error {
|
|
/// Io error
|
|
#[error(transparent)]
|
|
Io(#[from] std::io::Error),
|
|
|
|
/// Client error
|
|
#[error(transparent)]
|
|
Client(#[from] Box<sp_blockchain::Error>),
|
|
/// The same bootnode (based on address) is registered with two different peer ids.
|
|
#[error(
|
|
"The same bootnode (`{address}`) is registered with two different peer ids: `{first_id}` and `{second_id}`"
|
|
)]
|
|
DuplicateBootnode {
|
|
/// The address of the bootnode.
|
|
address: Multiaddr,
|
|
/// The first peer id that was found for the bootnode.
|
|
first_id: PeerId,
|
|
/// The second peer id that was found for the bootnode.
|
|
second_id: PeerId,
|
|
},
|
|
/// Prometheus metrics error.
|
|
#[error(transparent)]
|
|
Prometheus(#[from] prometheus_endpoint::PrometheusError),
|
|
/// The network addresses are invalid because they don't match the transport.
|
|
#[error(
|
|
"The following addresses are invalid because they don't match the transport: {addresses:?}"
|
|
)]
|
|
AddressesForAnotherTransport {
|
|
/// Transport used.
|
|
transport: TransportConfig,
|
|
/// The invalid addresses.
|
|
addresses: Vec<Multiaddr>,
|
|
},
|
|
/// The same request-response protocol has been registered multiple times.
|
|
#[error("Request-response protocol registered multiple times: {protocol}")]
|
|
DuplicateRequestResponseProtocol {
|
|
/// Name of the protocol registered multiple times.
|
|
protocol: ProtocolName,
|
|
},
|
|
/// Peer does not exist.
|
|
#[error("Peer `{0}` does not exist.")]
|
|
PeerDoesntExist(PeerId),
|
|
/// Channel closed.
|
|
#[error("Channel closed")]
|
|
ChannelClosed,
|
|
/// Connection closed.
|
|
#[error("Connection closed")]
|
|
ConnectionClosed,
|
|
/// Litep2p error.
|
|
#[error("Litep2p error: `{0}`")]
|
|
Litep2p(litep2p::Error),
|
|
}
|
|
|
|
// Make `Debug` use the `Display` implementation.
|
|
impl fmt::Debug for Error {
|
|
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
|
fmt::Display::fmt(self, f)
|
|
}
|
|
}
|