Get rid of libp2p dependency in sc-authority-discovery

prdoc/pr_5842.prdoc

@@ -0,0 +1,18 @@
+# Schema: Polkadot SDK PRDoc Schema (prdoc) v1.0.0
+# See doc at https://raw.githubusercontent.com/paritytech/polkadot-sdk/master/prdoc/schema_user.json
+
+title: Get rid of libp2p dependency in sc-authority-discovery
+
+doc:
+  - audience: Node Dev
+    description: |
+      Removes `libp2p` types in authority-discovery, and replace them with network backend agnostic types from `sc-network-types`.
+      The `sc-network` interface is therefore updated accordingly.
+
+crates:
+  - name: sc-network
+    bump: patch
+  - name: sc-network-types
+    bump: patch
+  - name: sc-authority-discovery
+    bump: patch

substrate/client/authority-discovery/Cargo.toml

@@ -24,7 +24,6 @@ codec = { workspace = true }
 futures = { workspace = true }
 futures-timer = { workspace = true }
 ip_network = { workspace = true }
-libp2p = { features = ["ed25519", "kad"], workspace = true }
 multihash = { workspace = true }
 linked_hash_set = { workspace = true }
 log = { workspace = true, default-features = true }

substrate/client/authority-discovery/src/tests.rs

@@ -25,7 +25,7 @@ use crate::{
 };
 
 use futures::{channel::mpsc::channel, executor::LocalPool, task::LocalSpawn};
-use libp2p::identity::ed25519;
+use sc_network_types::ed25519;
 use std::{collections::HashSet, sync::Arc};
 
 use sc_network::{multiaddr::Protocol, Multiaddr, PeerId};

substrate/client/authority-discovery/src/worker.rs

@@ -34,8 +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::kad::{PeerRecord, Record};
 use linked_hash_set::LinkedHashSet;
+use sc_network_types::rec::{Key, PeerRecord, Record};
 
 use log::{debug, error, trace};
 use prometheus_endpoint::{register, Counter, CounterVec, Gauge, Opts, U64};
@@ -580,7 +580,7 @@ where
 
 				debug!(target: LOG_TARGET, "Value for hash '{:?}' found on Dht.", v.record.key);
 
-				if let Err(e) = self.handle_dht_value_found_event(v) {
+				if let Err(e) = self.handle_dht_value_found_event(v.into()) {
 					if let Some(metrics) = &self.metrics {
 						metrics.handle_value_found_event_failure.inc();
 					}
@@ -592,7 +592,7 @@ where
 					metrics.dht_event_received.with_label_values(&["value_not_found"]).inc();
 				}
 
-				if self.in_flight_lookups.remove(&hash).is_some() {
+				if self.in_flight_lookups.remove::<KademliaKey>(&hash.to_vec().into()).is_some() {
 					debug!(target: LOG_TARGET, "Value for hash '{:?}' not found on Dht.", hash)
 				} else {
 					debug!(
@@ -602,7 +602,7 @@ where
 				}
 			},
 			DhtEvent::ValuePut(hash) => {
-				if !self.latest_published_kad_keys.contains(&hash) {
+				if !self.latest_published_kad_keys.contains::<KademliaKey>(&hash.to_vec().into()) {
 					return;
 				}
 
@@ -618,7 +618,7 @@ where
 				debug!(target: LOG_TARGET, "Successfully put hash '{:?}' on Dht.", hash)
 			},
 			DhtEvent::ValuePutFailed(hash) => {
-				if !self.latest_published_kad_keys.contains(&hash) {
+				if !self.latest_published_kad_keys.contains::<KademliaKey>(&hash.to_vec().into()) {
 					// Not a value we have published or received multiple times.
 					return;
 				}
@@ -646,7 +646,7 @@ where
 
 	async fn handle_put_record_requested(
 		&mut self,
-		record_key: KademliaKey,
+		record_key: Key,
 		record_value: Vec<u8>,
 		publisher: Option<PeerId>,
 		expires: Option<std::time::Instant>,
@@ -656,7 +656,7 @@ where
 		// Make sure we don't ever work with an outdated set of authorities
 		// and that we do not update known_authorithies too often.
 		let best_hash = self.client.best_hash().await?;
-		if !self.known_authorities.contains_key(&record_key) &&
+		if !self.known_authorities.contains_key::<KademliaKey>(&record_key.to_vec().into()) &&
 			self.authorities_queried_at
 				.map(|authorities_queried_at| authorities_queried_at != best_hash)
 				.unwrap_or(true)
@@ -677,8 +677,10 @@ where
 			self.authorities_queried_at = Some(best_hash);
 		}
 
-		let authority_id =
-			self.known_authorities.get(&record_key).ok_or(Error::UnknownAuthority)?;
+		let authority_id = self
+			.known_authorities
+			.get::<KademliaKey>(&record_key.to_vec().into())
+			.ok_or(Error::UnknownAuthority)?;
 		let signed_record =
 			Self::check_record_signed_with_authority_id(record_value.as_slice(), authority_id)?;
 		self.check_record_signed_with_network_key(
@@ -697,7 +699,8 @@ where
 				})
 				.unwrap_or_default(); // 0 is a sane default for records that do not have creation time present.
 
-		let current_record_info = self.last_known_records.get(&record_key);
+		let current_record_info =
+			self.last_known_records.get::<KademliaKey>(&record_key.to_vec().into());
 		// If record creation time is older than the current record creation time,
 		// we don't store it since we want to give higher priority to newer records.
 		if let Some(current_record_info) = current_record_info {
@@ -712,7 +715,12 @@ where
 			}
 		}
 
-		self.network.store_record(record_key, record_value, Some(publisher), expires);
+		self.network.store_record(
+			record_key.to_vec().into(),
+			record_value,
+			Some(publisher),
+			expires,
+		);
 		Ok(())
 	}
 
@@ -766,15 +774,19 @@ where
 		// Ensure `values` is not empty and all its keys equal.
 		let remote_key = peer_record.record.key.clone();
 
-		let authority_id: AuthorityId =
-			if let Some(authority_id) = self.in_flight_lookups.remove(&remote_key) {
-				self.known_lookups.insert(remote_key.clone(), authority_id.clone());
-				authority_id
-			} else if let Some(authority_id) = self.known_lookups.get(&remote_key) {
-				authority_id.clone()
-			} else {
-				return Err(Error::ReceivingUnexpectedRecord);
-			};
+		let authority_id: AuthorityId = if let Some(authority_id) =
+			self.in_flight_lookups.remove::<KademliaKey>(&remote_key.to_vec().into())
+		{
+			self.known_lookups
+				.insert(remote_key.clone().to_vec().into(), authority_id.clone());
+			authority_id
+		} else if let Some(authority_id) =
+			self.known_lookups.get::<KademliaKey>(&remote_key.to_vec().into())
+		{
+			authority_id.clone()
+		} else {
+			return Err(Error::ReceivingUnexpectedRecord);
+		};
 
 		let local_peer_id = self.network.local_peer_id();
 
@@ -835,7 +847,7 @@ where
 
 		let addr_cache_needs_update = self.handle_new_record(
 			&authority_id,
-			remote_key.clone(),
+			remote_key.clone().to_vec().into(),
 			RecordInfo {
 				creation_time: records_creation_time,
 				peers_with_record: answering_peer_id.into_iter().collect(),
@@ -870,7 +882,7 @@ where
 		if new_record.creation_time > current_record_info.creation_time {
 			let peers_that_need_updating = current_record_info.peers_with_record.clone();
 			self.network.put_record_to(
-				new_record.record.clone(),
+				new_record.record.clone().into(),
 				peers_that_need_updating.clone(),
 				// If this is empty it means we received the answer from our node local
 				// storage, so we need to update that as well.
@@ -907,7 +919,7 @@ where
 				authority_id, new_record.creation_time, current_record_info.creation_time,
 		);
 		self.network.put_record_to(
-			current_record_info.record.clone(),
+			current_record_info.record.clone().into(),
 			new_record.peers_with_record.clone(),
 			// If this is empty it means we received the answer from our node local
 			// storage, so we need to update that as well.

substrate/client/authority-discovery/src/worker/schema/tests.rs

@@ -26,9 +26,9 @@ mod schema_v2 {
 
 use super::*;
 use codec::Encode;
-use libp2p::identity::Keypair;
 use prost::Message;
 use sc_network::{Multiaddr, PeerId};
+use sc_network_types::ed25519::Keypair;
 
 #[test]
 fn v2_decodes_v1() {
@@ -61,7 +61,7 @@ fn v2_decodes_v1() {
 
 #[test]
 fn v1_decodes_v2() {
-	let peer_secret = Keypair::generate_ed25519();
+	let peer_secret = Keypair::generate();
 	let peer_public = peer_secret.public();
 	let peer_id = peer_public.to_peer_id();
 	let multiaddress: Multiaddr =
@@ -73,7 +73,7 @@ fn v1_decodes_v2() {
 	let record_v2 = schema_v2::AuthorityRecord { addresses: vec_addresses.clone() };
 	let mut vec_record_v2 = vec![];
 	record_v2.encode(&mut vec_record_v2).unwrap();
-	let vec_peer_public = peer_public.encode_protobuf();
+	let vec_peer_public = peer_public.to_bytes().to_vec();
 	let peer_signature_v2 =
 		PeerSignature { public_key: vec_peer_public, signature: vec_peer_signature };
 	let signed_record_v2 = SignedAuthorityRecord {
@@ -97,7 +97,7 @@ fn v1_decodes_v2() {
 
 #[test]
 fn v1_decodes_v3() {
-	let peer_secret = Keypair::generate_ed25519();
+	let peer_secret = Keypair::generate();
 	let peer_public = peer_secret.public();
 	let peer_id = peer_public.to_peer_id();
 	let multiaddress: Multiaddr =
@@ -112,7 +112,7 @@ fn v1_decodes_v3() {
 	};
 	let mut vec_record_v3 = vec![];
 	record_v3.encode(&mut vec_record_v3).unwrap();
-	let vec_peer_public = peer_public.encode_protobuf();
+	let vec_peer_public = peer_public.to_bytes().to_vec();
 	let peer_signature_v3 =
 		PeerSignature { public_key: vec_peer_public, signature: vec_peer_signature };
 	let signed_record_v3 = SignedAuthorityRecord {
@@ -136,7 +136,7 @@ fn v1_decodes_v3() {
 
 #[test]
 fn v3_decodes_v2() {
-	let peer_secret = Keypair::generate_ed25519();
+	let peer_secret = Keypair::generate();
 	let peer_public = peer_secret.public();
 	let peer_id = peer_public.to_peer_id();
 	let multiaddress: Multiaddr =
@@ -148,7 +148,7 @@ fn v3_decodes_v2() {
 	let record_v2 = schema_v2::AuthorityRecord { addresses: vec_addresses.clone() };
 	let mut vec_record_v2 = vec![];
 	record_v2.encode(&mut vec_record_v2).unwrap();
-	let vec_peer_public = peer_public.encode_protobuf();
+	let vec_peer_public = peer_public.to_bytes().to_vec();
 	let peer_signature_v2 =
 		schema_v2::PeerSignature { public_key: vec_peer_public, signature: vec_peer_signature };
 	let signed_record_v2 = schema_v2::SignedAuthorityRecord {

substrate/client/authority-discovery/src/worker/tests.rs

@@ -30,13 +30,15 @@ use futures::{
 	sink::SinkExt,
 	task::LocalSpawn,
 };
-use libp2p::{identity::SigningError, kad::record::Key as KademliaKey};
 use prometheus_endpoint::prometheus::default_registry;
-
 use sc_client_api::HeaderBackend;
-use sc_network::{service::signature::Keypair, Signature};
+use sc_network::{
+	service::signature::{Keypair, SigningError},
+	PublicKey, Signature,
+};
 use sc_network_types::{
 	multiaddr::{Multiaddr, Protocol},
+	rec::Key as KademliaKey,
 	PeerId,
 };
 use sp_api::{ApiRef, ProvideRuntimeApi};
@@ -167,7 +169,7 @@ impl NetworkSigner for TestNetwork {
 	fn sign_with_local_identity(
 		&self,
 		msg: Vec<u8>,
-	) -> std::result::Result<Signature, SigningError> {
+	) -> std::result::Result<Signature, sc_network::service::signature::SigningError> {
 		Signature::sign_message(msg, &self.identity)
 	}
 
@@ -178,8 +180,8 @@ impl NetworkSigner for TestNetwork {
 		signature: &Vec<u8>,
 		message: &Vec<u8>,
 	) -> std::result::Result<bool, String> {
-		let public_key = libp2p::identity::PublicKey::try_decode_protobuf(&public_key)
-			.map_err(|error| error.to_string())?;
+		let public_key =
+			PublicKey::try_decode_protobuf(&public_key).map_err(|error| error.to_string())?;
 		let peer_id: PeerId = peer_id.into();
 		let remote: PeerId = public_key.to_peer_id().into();
 

substrate/client/network/src/behaviour.rs

@@ -375,18 +375,23 @@ impl From<DiscoveryOut> for BehaviourOut {
 			},
 			DiscoveryOut::Discovered(peer_id) => BehaviourOut::Discovered(peer_id),
 			DiscoveryOut::ValueFound(results, duration) =>
-				BehaviourOut::Dht(DhtEvent::ValueFound(results), Some(duration)),
+				BehaviourOut::Dht(DhtEvent::ValueFound(results.into()), Some(duration)),
 			DiscoveryOut::ValueNotFound(key, duration) =>
-				BehaviourOut::Dht(DhtEvent::ValueNotFound(key), Some(duration)),
+				BehaviourOut::Dht(DhtEvent::ValueNotFound(key.to_vec().into()), Some(duration)),
 			DiscoveryOut::ValuePut(key, duration) =>
-				BehaviourOut::Dht(DhtEvent::ValuePut(key), Some(duration)),
+				BehaviourOut::Dht(DhtEvent::ValuePut(key.to_vec().into()), Some(duration)),
 			DiscoveryOut::PutRecordRequest(record_key, record_value, publisher, expires) =>
 				BehaviourOut::Dht(
-					DhtEvent::PutRecordRequest(record_key, record_value, publisher, expires),
+					DhtEvent::PutRecordRequest(
+						record_key.to_vec().into(),
+						record_value,
+						publisher,
+						expires,
+					),
 					None,
 				),
 			DiscoveryOut::ValuePutFailed(key, duration) =>
-				BehaviourOut::Dht(DhtEvent::ValuePutFailed(key), Some(duration)),
+				BehaviourOut::Dht(DhtEvent::ValuePutFailed(key.to_vec().into()), Some(duration)),
 			DiscoveryOut::RandomKademliaStarted => BehaviourOut::RandomKademliaStarted,
 		}
 	}

substrate/client/network/src/event.rs

@@ -22,12 +22,12 @@
 use crate::types::ProtocolName;
 
 use bytes::Bytes;
-use libp2p::{
-	kad::{record::Key, PeerRecord},
-	PeerId,
-};
 
 use sc_network_common::role::ObservedRole;
+use sc_network_types::{
+	rec::{Key, PeerRecord},
+	PeerId,
+};
 
 /// Events generated by DHT as a response to get_value and put_value requests.
 #[derive(Debug, Clone)]