client/authority-discovery/service: Improve PeerId comment

paritytech · Oct 26, 2020 · Oct 21, 2020 · Oct 22, 2020 · Oct 23, 2020 · Oct 23, 2020
commit f0071a1bb1df9fe1472504e8e847e26f2bd13afa
diff --git a/client/authority-discovery/src/service.rs b/client/authority-discovery/src/service.rs
@@ -43,8 +43,12 @@ impl Service {
 	/// Returns `None` if no entry was present or connection to the
 	/// [`crate::Worker`] failed.
 	///
-	/// [`Multiaddr`]s returned always include a [`PeerId`] via a
-	/// [`libp2p::core::multiaddr:Protocol::P2p`] component.
+	/// Note: [`Multiaddr`]s returned always include a [`PeerId`] via a
+	/// [`libp2p::core::multiaddr:Protocol::P2p`] component. Equality of
+	/// [`PeerId`]s across [`Multiaddr`]s returned by a single call is not
+	/// enforced today, given that there are still authorities out there
+	/// publishing the addresses of their sentry nodes on the DHT. In the future
+	/// this guarantee can be provided.
 	pub async fn get_addresses_by_authority_id(&mut self, authority: AuthorityId) -> Option<Vec<Multiaddr>> {
 		let (tx, rx) = oneshot::channel();