mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-04-29 00:57: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>
73 lines
2.8 KiB
Rust
73 lines
2.8 KiB
Rust
// Copyright Parity Technologies (UK) Ltd.
|
|
// This file is part of Substrate.
|
|
|
|
// Substrate 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.
|
|
|
|
// Substrate 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 Substrate. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
//! Block relay protocol related definitions.
|
|
|
|
use futures::channel::oneshot;
|
|
use sc_network::{request_responses::RequestFailure, NetworkBackend, ProtocolName};
|
|
use sc_network_common::sync::message::{BlockData, BlockRequest};
|
|
use sc_network_types::PeerId;
|
|
use sp_runtime::traits::Block as BlockT;
|
|
use std::sync::Arc;
|
|
|
|
/// The serving side of the block relay protocol. It runs a single instance
|
|
/// of the server task that processes the incoming protocol messages.
|
|
#[async_trait::async_trait]
|
|
pub trait BlockServer<Block: BlockT>: Send {
|
|
/// Starts the protocol processing.
|
|
async fn run(&mut self);
|
|
}
|
|
|
|
/// The client side stub to download blocks from peers. This is a handle
|
|
/// that can be used to initiate concurrent downloads.
|
|
#[async_trait::async_trait]
|
|
pub trait BlockDownloader<Block: BlockT>: Send + Sync {
|
|
/// Performs the protocol specific sequence to fetch the blocks from the peer.
|
|
/// Output: if the download succeeds, the response is a `Vec<u8>` which is
|
|
/// in a format specific to the protocol implementation. The block data
|
|
/// can be extracted from this response using [`BlockDownloader::block_response_into_blocks`].
|
|
async fn download_blocks(
|
|
&self,
|
|
who: PeerId,
|
|
request: BlockRequest<Block>,
|
|
) -> Result<Result<(Vec<u8>, ProtocolName), RequestFailure>, oneshot::Canceled>;
|
|
|
|
/// Parses the protocol specific response to retrieve the block data.
|
|
fn block_response_into_blocks(
|
|
&self,
|
|
request: &BlockRequest<Block>,
|
|
response: Vec<u8>,
|
|
) -> Result<Vec<BlockData<Block>>, BlockResponseError>;
|
|
}
|
|
|
|
/// Errors returned by [`BlockDownloader::block_response_into_blocks`].
|
|
#[derive(Debug)]
|
|
pub enum BlockResponseError {
|
|
/// Failed to decode the response bytes.
|
|
DecodeFailed(String),
|
|
|
|
/// Failed to extract the blocks from the decoded bytes.
|
|
ExtractionFailed(String),
|
|
}
|
|
|
|
/// Block relay specific params for network creation, specified in
|
|
/// ['sc_service::BuildNetworkParams'].
|
|
pub struct BlockRelayParams<Block: BlockT, N: NetworkBackend<Block, <Block as BlockT>::Hash>> {
|
|
pub server: Box<dyn BlockServer<Block>>,
|
|
pub downloader: Arc<dyn BlockDownloader<Block>>,
|
|
pub request_response_config: N::RequestResponseProtocolConfig,
|
|
}
|