mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-07-13 22:05:51 +00:00
Integrate litep2p into Polkadot SDK (#2944)
[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>
This commit is contained in:
@@ -34,9 +34,8 @@ use futures::{channel::mpsc, future, stream::Fuse, FutureExt, Stream, StreamExt}
|
||||
use addr_cache::AddrCache;
|
||||
use codec::{Decode, Encode};
|
||||
use ip_network::IpNetwork;
|
||||
use libp2p::{core::multiaddr, identity::PublicKey, multihash::Multihash, Multiaddr, PeerId};
|
||||
use linked_hash_set::LinkedHashSet;
|
||||
use multihash_codetable::{Code, MultihashDigest};
|
||||
use multihash::{Code, Multihash, MultihashDigest};
|
||||
|
||||
use log::{debug, error, log_enabled};
|
||||
use prometheus_endpoint::{register, Counter, CounterVec, Gauge, Opts, U64};
|
||||
@@ -44,8 +43,10 @@ use prost::Message;
|
||||
use rand::{seq::SliceRandom, thread_rng};
|
||||
|
||||
use sc_network::{
|
||||
event::DhtEvent, KademliaKey, NetworkDHTProvider, NetworkSigner, NetworkStateInfo, Signature,
|
||||
event::DhtEvent, multiaddr, KademliaKey, Multiaddr, NetworkDHTProvider, NetworkSigner,
|
||||
NetworkStateInfo,
|
||||
};
|
||||
use sc_network_types::PeerId;
|
||||
use sp_api::{ApiError, ProvideRuntimeApi};
|
||||
use sp_authority_discovery::{
|
||||
AuthorityDiscoveryApi, AuthorityId, AuthorityPair, AuthoritySignature,
|
||||
@@ -108,13 +109,13 @@ pub enum Role {
|
||||
/// network peerset.
|
||||
///
|
||||
/// 5. Allow querying of the collected addresses via the [`crate::Service`].
|
||||
pub struct Worker<Client, Network, Block, DhtEventStream> {
|
||||
pub struct Worker<Client, Block, DhtEventStream> {
|
||||
/// Channel receiver for messages send by a [`crate::Service`].
|
||||
from_service: Fuse<mpsc::Receiver<ServicetoWorkerMsg>>,
|
||||
|
||||
client: Arc<Client>,
|
||||
|
||||
network: Arc<Network>,
|
||||
network: Arc<dyn NetworkProvider>,
|
||||
|
||||
/// Channel we receive Dht events on.
|
||||
dht_event_rx: DhtEventStream,
|
||||
@@ -192,10 +193,9 @@ where
|
||||
}
|
||||
}
|
||||
|
||||
impl<Client, Network, Block, DhtEventStream> Worker<Client, Network, Block, DhtEventStream>
|
||||
impl<Client, Block, DhtEventStream> Worker<Client, Block, DhtEventStream>
|
||||
where
|
||||
Block: BlockT + Unpin + 'static,
|
||||
Network: NetworkProvider,
|
||||
Client: AuthorityDiscovery<Block> + 'static,
|
||||
DhtEventStream: Stream<Item = DhtEvent> + Unpin,
|
||||
{
|
||||
@@ -203,7 +203,7 @@ where
|
||||
pub(crate) fn new(
|
||||
from_service: mpsc::Receiver<ServicetoWorkerMsg>,
|
||||
client: Arc<Client>,
|
||||
network: Arc<Network>,
|
||||
network: Arc<dyn NetworkProvider>,
|
||||
dht_event_rx: DhtEventStream,
|
||||
role: Role,
|
||||
prometheus_registry: Option<prometheus_endpoint::Registry>,
|
||||
@@ -406,10 +406,14 @@ where
|
||||
Role::Discover => return Ok(()),
|
||||
};
|
||||
|
||||
let keys = Worker::<Client, Network, Block, DhtEventStream>::get_own_public_keys_within_authority_set(
|
||||
key_store.clone(),
|
||||
self.client.as_ref(),
|
||||
).await?.into_iter().collect::<HashSet<_>>();
|
||||
let keys =
|
||||
Worker::<Client, Block, DhtEventStream>::get_own_public_keys_within_authority_set(
|
||||
key_store.clone(),
|
||||
self.client.as_ref(),
|
||||
)
|
||||
.await?
|
||||
.into_iter()
|
||||
.collect::<HashSet<_>>();
|
||||
|
||||
if only_if_changed {
|
||||
// If the authority keys did not change and the `publish_if_changed_interval` was
|
||||
@@ -434,7 +438,7 @@ where
|
||||
}
|
||||
|
||||
let serialized_record = serialize_authority_record(addresses)?;
|
||||
let peer_signature = sign_record_with_peer_id(&serialized_record, self.network.as_ref())?;
|
||||
let peer_signature = sign_record_with_peer_id(&serialized_record, &self.network)?;
|
||||
|
||||
let keys_vec = keys.iter().cloned().collect::<Vec<_>>();
|
||||
|
||||
@@ -634,12 +638,15 @@ where
|
||||
// properly signed by the owner of the PeerId
|
||||
|
||||
if let Some(peer_signature) = peer_signature {
|
||||
let public_key = PublicKey::try_decode_protobuf(&peer_signature.public_key)
|
||||
.map_err(Error::ParsingLibp2pIdentity)?;
|
||||
let signature = Signature { public_key, bytes: peer_signature.signature };
|
||||
|
||||
if !signature.verify(record, &remote_peer_id) {
|
||||
return Err(Error::VerifyingDhtPayload)
|
||||
match self.network.verify(
|
||||
remote_peer_id.into(),
|
||||
&peer_signature.public_key,
|
||||
&peer_signature.signature,
|
||||
&record,
|
||||
) {
|
||||
Ok(true) => {},
|
||||
Ok(false) => return Err(Error::VerifyingDhtPayload),
|
||||
Err(error) => return Err(Error::ParsingLibp2pIdentity(error)),
|
||||
}
|
||||
} else if self.strict_record_validation {
|
||||
return Err(Error::MissingPeerIdSignature)
|
||||
@@ -701,9 +708,15 @@ where
|
||||
/// NetworkProvider provides [`Worker`] with all necessary hooks into the
|
||||
/// underlying Substrate networking. Using this trait abstraction instead of
|
||||
/// `sc_network::NetworkService` directly is necessary to unit test [`Worker`].
|
||||
pub trait NetworkProvider: NetworkDHTProvider + NetworkStateInfo + NetworkSigner {}
|
||||
pub trait NetworkProvider:
|
||||
NetworkDHTProvider + NetworkStateInfo + NetworkSigner + Send + Sync
|
||||
{
|
||||
}
|
||||
|
||||
impl<T> NetworkProvider for T where T: NetworkDHTProvider + NetworkStateInfo + NetworkSigner {}
|
||||
impl<T> NetworkProvider for T where
|
||||
T: NetworkDHTProvider + NetworkStateInfo + NetworkSigner + Send + Sync
|
||||
{
|
||||
}
|
||||
|
||||
fn hash_authority_id(id: &[u8]) -> KademliaKey {
|
||||
KademliaKey::new(&Code::Sha2_256.digest(id).digest())
|
||||
@@ -741,7 +754,7 @@ fn sign_record_with_peer_id(
|
||||
network: &impl NetworkSigner,
|
||||
) -> Result<schema::PeerSignature> {
|
||||
let signature = network
|
||||
.sign_with_local_identity(serialized_record)
|
||||
.sign_with_local_identity(serialized_record.to_vec())
|
||||
.map_err(|e| Error::CannotSign(format!("{} (network packet)", e)))?;
|
||||
let public_key = signature.public_key.encode_protobuf();
|
||||
let signature = signature.bytes;
|
||||
@@ -855,7 +868,7 @@ impl Metrics {
|
||||
|
||||
// Helper functions for unit testing.
|
||||
#[cfg(test)]
|
||||
impl<Block, Client, Network, DhtEventStream> Worker<Client, Network, Block, DhtEventStream> {
|
||||
impl<Block, Client, DhtEventStream> Worker<Client, Block, DhtEventStream> {
|
||||
pub(crate) fn inject_addresses(&mut self, authority: AuthorityId, addresses: Vec<Multiaddr>) {
|
||||
self.addr_cache.insert(authority, addresses);
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user