*: Don't leak prost dependency in error types

CHANGELOG.md

@@ -50,7 +50,30 @@
   See [PR 3001].
 - Introduce [`libp2p-tls` `v0.1.0`](transports/tls/CHANGELOG.md#010). See [PR 2945].
 - Update individual crates.
+  - Update to [`libp2p-autonat` `v0.89.0`](protocols/autonat/CHANGELOG.md#090).
+  - Update to [`libp2p-core` `v0.38.0`](core/CHANGELOG.md#0380).
+  - Update to [`libp2p-dcutr` `v0.8.0`](protocols/dcutr/CHANGELOG.md#080).
+  - Update to [`libp2p-deflate` `v0.38.0`](transports/deflate/CHANGELOG.md#0380).
+  - Update to [`libp2p-dns` `v0.38.0`](transports/dns/CHANGELOG.md#0380).
+  - Update to [`libp2p-floodsub` `v0.41.0`](protocols/floodsub/CHANGELOG.md#0410).
+  - Update to [`libp2p-gossipsub` `v0.43.0`](protocols/gossipsub/CHANGELOG.md#0430).
+  - Update to [`libp2p-identify` `v0.41.0`](protocols/identify/CHANGELOG.md#0410).
+  - Update to [`libp2p-kad` `v0.42.0`](protocols/kad/CHANGELOG.md#0420).
+  - Update to [`libp2p-mdns` `v0.42.0`](protocols/mdns/CHANGELOG.md#0420).
+  - Update to [`libp2p-metrics` `v0.11.0`](misc/metrics/CHANGELOG.md#0110).
+  - Update to [`libp2p-mplex` `v0.38.0`](muxers/mplex/CHANGELOG.md#0380).
+  - Update to [`libp2p-noise` `v0.41.0`](transports/noise/CHANGELOG.md#0410).
+  - Update to [`libp2p-ping` `v0.41.0`](protocols/ping/CHANGELOG.md#0410).
+  - Update to [`libp2p-plaintext` `v0.38.0`](transports/plaintext/CHANGELOG.md#0380).
+  - Update to [`libp2p-relay` `v0.14.0`](protocols/relay/CHANGELOG.md#0140).
+  - Update to [`libp2p-rendezvous` `v0.11.0`](protocols/rendezovus/CHANGELOG.md#0110).
+  - Update to [`libp2p-request-response` `v0.23.0`](protocols/request-response/CHANGELOG.md#0230).
+  - Update to [`libp2p-swarm` `v0.41.0`](swarm/CHANGELOG.md#0410).
   - Update to [`libp2p-tcp` `v0.38.0`](transports/tcp/CHANGELOG.md#0380).
+  - Update to [`libp2p-uds` `v0.37.0`](transports/uds/CHANGELOG.md#0370).
+  - Update to [`libp2p-wasm-ext` `v0.38.0`](transports/wasm-ext/CHANGELOG.md#0380).
+  - Update to [`libp2p-websocket` `v0.40.0`](transports/websocket/CHANGELOG.md#0400).
+  - Update to [`libp2p-yamux` `v0.42.0`](muxers/yamux/CHANGELOG.md#0420).
 
 [PR 3001]: https://github.com/libp2p/rust-libp2p/pull/3001
 [PR 2945]: https://github.com/libp2p/rust-libp2p/pull/2945

Cargo.toml

@@ -86,41 +86,41 @@ getrandom = "0.2.3" # Explicit dependency to be used in `wasm-bindgen` feature
 instant = "0.1.11" # Explicit dependency to be used in `wasm-bindgen` feature
 lazy_static = "1.2"
 
-libp2p-autonat = { version = "0.8.0", path = "protocols/autonat", optional = true }
-libp2p-core = { version = "0.37.0", path = "core" }
-libp2p-dcutr = { version = "0.7.0", path = "protocols/dcutr", optional = true }
-libp2p-floodsub = { version = "0.40.1", path = "protocols/floodsub", optional = true }
-libp2p-identify = { version = "0.40.0", path = "protocols/identify", optional = true }
-libp2p-kad = { version = "0.41.0", path = "protocols/kad", optional = true }
-libp2p-metrics = { version = "0.10.0", path = "misc/metrics", optional = true }
-libp2p-mplex = { version = "0.37.0", path = "muxers/mplex", optional = true }
-libp2p-noise = { version = "0.40.0", path = "transports/noise", optional = true }
-libp2p-ping = { version = "0.40.1", path = "protocols/ping", optional = true }
-libp2p-plaintext = { version = "0.37.0", path = "transports/plaintext", optional = true }
+libp2p-autonat = { version = "0.9.0", path = "protocols/autonat", optional = true }
+libp2p-core = { version = "0.38.0", path = "core" }
+libp2p-dcutr = { version = "0.8.0", path = "protocols/dcutr", optional = true }
+libp2p-floodsub = { version = "0.41.0", path = "protocols/floodsub", optional = true }
+libp2p-identify = { version = "0.41.0", path = "protocols/identify", optional = true }
+libp2p-kad = { version = "0.42.0", path = "protocols/kad", optional = true }
+libp2p-metrics = { version = "0.11.0", path = "misc/metrics", optional = true }
+libp2p-mplex = { version = "0.38.0", path = "muxers/mplex", optional = true }
+libp2p-noise = { version = "0.41.0", path = "transports/noise", optional = true }
+libp2p-ping = { version = "0.41.0", path = "protocols/ping", optional = true }
+libp2p-plaintext = { version = "0.38.0", path = "transports/plaintext", optional = true }
 libp2p-pnet = { version = "0.22.1", path = "transports/pnet", optional = true }
-libp2p-relay = { version = "0.13.0", path = "protocols/relay", optional = true }
-libp2p-rendezvous = { version = "0.10.0", path = "protocols/rendezvous", optional = true }
-libp2p-request-response = { version = "0.22.1", path = "protocols/request-response", optional = true }
-libp2p-swarm = { version = "0.40.1", path = "swarm" }
+libp2p-relay = { version = "0.14.0", path = "protocols/relay", optional = true }
+libp2p-rendezvous = { version = "0.11.0", path = "protocols/rendezvous", optional = true }
+libp2p-request-response = { version = "0.23.0", path = "protocols/request-response", optional = true }
+libp2p-swarm = { version = "0.41.0", path = "swarm" }
 libp2p-swarm-derive = { version = "0.30.1", path = "swarm-derive" }
-libp2p-uds = { version = "0.36.0", path = "transports/uds", optional = true }
-libp2p-wasm-ext = { version = "0.37.0", path = "transports/wasm-ext", optional = true }
-libp2p-yamux = { version = "0.41.0", path = "muxers/yamux", optional = true }
+libp2p-uds = { version = "0.37.0", path = "transports/uds", optional = true }
+libp2p-wasm-ext = { version = "0.38.0", path = "transports/wasm-ext", optional = true }
+libp2p-yamux = { version = "0.42.0", path = "muxers/yamux", optional = true }
 multiaddr = { version = "0.14.0" }
 parking_lot = "0.12.0"
 pin-project = "1.0.0"
 smallvec = "1.6.1"
 
 [target.'cfg(not(any(target_os = "emscripten", target_os = "wasi", target_os = "unknown")))'.dependencies]
-libp2p-deflate = { version = "0.37.0", path = "transports/deflate", optional = true }
-libp2p-dns = { version = "0.37.0", path = "transports/dns", optional = true }
-libp2p-mdns = { version = "0.41.0", path = "protocols/mdns", optional = true }
+libp2p-deflate = { version = "0.38.0", path = "transports/deflate", optional = true }
+libp2p-dns = { version = "0.38.0", path = "transports/dns", optional = true }
+libp2p-mdns = { version = "0.42.0", path = "protocols/mdns", optional = true }
 libp2p-tcp = { version = "0.38.0", path = "transports/tcp", optional = true }
-libp2p-websocket = { version = "0.39.0", path = "transports/websocket", optional = true }
+libp2p-websocket = { version = "0.40.0", path = "transports/websocket", optional = true }
 libp2p-tls = { version = "0.1.0-alpha", path = "transports/tls", optional = true }
 
 [target.'cfg(not(target_os = "unknown"))'.dependencies]
-libp2p-gossipsub = { version = "0.42.1", path = "protocols/gossipsub", optional = true }
+libp2p-gossipsub = { version = "0.43.0", path = "protocols/gossipsub", optional = true }
 
 [dev-dependencies]
 async-std = { version = "1.6.2", features = ["attributes"] }

core/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.38.0 [unreleased]
+
+- Hide `prost::Error` from public API in `FromEnvelopeError::InvalidPeerRecord` and `signed_envelope::DecodingError`. See [PR 3058].
+
+[PR 3058]: https://github.com/libp2p/rust-libp2p/pull/3058
+
 # 0.37.0
 
 - Implement `Hash` and `Ord` for `PublicKey`. See [PR 2915].

core/Cargo.toml

@@ -3,7 +3,7 @@ name = "libp2p-core"
 edition = "2021"
 rust-version = "1.56.1"
 description = "Core traits and structs of libp2p"
-version = "0.37.0"
+version = "0.38.0"
 authors = ["Parity Technologies <admin@parity.io>"]
 license = "MIT"
 repository = "https://github.com/libp2p/rust-libp2p"

core/src/lib.rs

@@ -79,6 +79,10 @@ pub use translation::address_translation;
 pub use transport::Transport;
 pub use upgrade::{InboundUpgrade, OutboundUpgrade, ProtocolName, UpgradeError, UpgradeInfo};
 
+#[derive(thiserror::Error, Debug)]
+#[error(transparent)]
+pub struct DecodeError(prost::DecodeError);
+
 use std::{future::Future, pin::Pin};
 
 /// Implemented on objects that can run a `Future` in the background.

core/src/peer_record.rs

@@ -1,10 +1,9 @@
 use crate::identity::error::SigningError;
 use crate::identity::Keypair;
 use crate::signed_envelope::SignedEnvelope;
-use crate::{peer_record_proto, signed_envelope, Multiaddr, PeerId};
+use crate::{peer_record_proto, signed_envelope, DecodeError, Multiaddr, PeerId};
 use instant::SystemTime;
 use std::convert::TryInto;
-use std::fmt;
 
 const PAYLOAD_TYPE: &str = "/libp2p/routing-state-record";
 const DOMAIN_SEP: &str = "libp2p-routing-state";
@@ -34,7 +33,7 @@ impl PeerRecord {
 
         let (payload, signing_key) =
             envelope.payload_and_signing_key(String::from(DOMAIN_SEP), PAYLOAD_TYPE.as_bytes())?;
-        let record = peer_record_proto::PeerRecord::decode(payload)?;
+        let record = peer_record_proto::PeerRecord::decode(payload).map_err(DecodeError)?;
 
         let peer_id = PeerId::from_bytes(&record.peer_id)?;
 
@@ -124,73 +123,23 @@ impl PeerRecord {
     }
 }
 
-#[derive(Debug)]
+#[derive(thiserror::Error, Debug)]
 pub enum FromEnvelopeError {
     /// Failed to extract the payload from the envelope.
-    BadPayload(signed_envelope::ReadPayloadError),
+    #[error("Failed to extract payload from envelope")]
+    BadPayload(#[from] signed_envelope::ReadPayloadError),
     /// Failed to decode the provided bytes as a [`PeerRecord`].
-    InvalidPeerRecord(prost::DecodeError),
+    #[error("Failed to decode bytes as PeerRecord")]
+    InvalidPeerRecord(#[from] DecodeError),
     /// Failed to decode the peer ID.
-    InvalidPeerId(multihash::Error),
+    #[error("Failed to decode bytes as PeerId")]
+    InvalidPeerId(#[from] multihash::Error),
     /// The signer of the envelope is different than the peer id in the record.
+    #[error("The signer of the envelope is different than the peer id in the record")]
     MismatchedSignature,
     /// Failed to decode a multi-address.
-    InvalidMultiaddr(multiaddr::Error),
-}
-
-impl From<signed_envelope::ReadPayloadError> for FromEnvelopeError {
-    fn from(e: signed_envelope::ReadPayloadError) -> Self {
-        Self::BadPayload(e)
-    }
-}
-
-impl From<prost::DecodeError> for FromEnvelopeError {
-    fn from(e: prost::DecodeError) -> Self {
-        Self::InvalidPeerRecord(e)
-    }
-}
-
-impl From<multihash::Error> for FromEnvelopeError {
-    fn from(e: multihash::Error) -> Self {
-        Self::InvalidPeerId(e)
-    }
-}
-
-impl From<multiaddr::Error> for FromEnvelopeError {
-    fn from(e: multiaddr::Error) -> Self {
-        Self::InvalidMultiaddr(e)
-    }
-}
-
-impl fmt::Display for FromEnvelopeError {
-    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        match self {
-            Self::BadPayload(_) => write!(f, "Failed to extract payload from envelope"),
-            Self::InvalidPeerRecord(_) => {
-                write!(f, "Failed to decode bytes as PeerRecord")
-            }
-            Self::InvalidPeerId(_) => write!(f, "Failed to decode bytes as PeerId"),
-            Self::MismatchedSignature => write!(
-                f,
-                "The signer of the envelope is different than the peer id in the record"
-            ),
-            Self::InvalidMultiaddr(_) => {
-                write!(f, "Failed to decode bytes as MultiAddress")
-            }
-        }
-    }
-}
-
-impl std::error::Error for FromEnvelopeError {
-    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
-        match self {
-            Self::InvalidPeerRecord(inner) => Some(inner),
-            Self::InvalidPeerId(inner) => Some(inner),
-            Self::MismatchedSignature => None,
-            Self::InvalidMultiaddr(inner) => Some(inner),
-            Self::BadPayload(inner) => Some(inner),
-        }
-    }
+    #[error("Failed to decode bytes as MultiAddress")]
+    InvalidMultiaddr(#[from] multiaddr::Error),
 }
 
 #[cfg(test)]

core/src/signed_envelope.rs

@@ -1,6 +1,6 @@
 use crate::identity::error::SigningError;
 use crate::identity::Keypair;
-use crate::{identity, PublicKey};
+use crate::{identity, DecodeError, PublicKey};
 use std::convert::TryInto;
 use std::fmt;
 use unsigned_varint::encode::usize_buffer;
@@ -94,7 +94,7 @@ impl SignedEnvelope {
     pub fn from_protobuf_encoding(bytes: &[u8]) -> Result<Self, DecodingError> {
         use prost::Message;
 
-        let envelope = crate::envelope_proto::Envelope::decode(bytes)?;
+        let envelope = crate::envelope_proto::Envelope::decode(bytes).map_err(DecodeError)?;
 
         Ok(Self {
             key: envelope
@@ -140,48 +140,19 @@ fn signature_payload(domain_separation: String, payload_type: &[u8], payload: &[
 }
 
 /// Errors that occur whilst decoding a [`SignedEnvelope`] from its byte representation.
-#[derive(Debug)]
+#[derive(thiserror::Error, Debug)]
 pub enum DecodingError {
     /// Decoding the provided bytes as a signed envelope failed.
-    InvalidEnvelope(prost::DecodeError),
+    #[error("Failed to decode envelope")]
+    InvalidEnvelope(#[from] DecodeError),
     /// The public key in the envelope could not be converted to our internal public key type.
-    InvalidPublicKey(identity::error::DecodingError),
+    #[error("Failed to convert public key")]
+    InvalidPublicKey(#[from] identity::error::DecodingError),
     /// The public key in the envelope could not be converted to our internal public key type.
+    #[error("Public key is missing from protobuf struct")]
     MissingPublicKey,
 }
 
-impl From<prost::DecodeError> for DecodingError {
-    fn from(e: prost::DecodeError) -> Self {
-        Self::InvalidEnvelope(e)
-    }
-}
-
-impl From<identity::error::DecodingError> for DecodingError {
-    fn from(e: identity::error::DecodingError) -> Self {
-        Self::InvalidPublicKey(e)
-    }
-}
-
-impl fmt::Display for DecodingError {
-    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        match self {
-            Self::InvalidEnvelope(_) => write!(f, "Failed to decode envelope"),
-            Self::InvalidPublicKey(_) => write!(f, "Failed to convert public key"),
-            Self::MissingPublicKey => write!(f, "Public key is missing from protobuf struct"),
-        }
-    }
-}
-
-impl std::error::Error for DecodingError {
-    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
-        match self {
-            Self::InvalidEnvelope(inner) => Some(inner),
-            Self::InvalidPublicKey(inner) => Some(inner),
-            Self::MissingPublicKey => None,
-        }
-    }
-}
-
 /// Errors that occur whilst extracting the payload of a [`SignedEnvelope`].
 #[derive(Debug)]
 pub enum ReadPayloadError {

misc/keygen/Cargo.toml

@@ -14,5 +14,5 @@ clap = { version = "4.0.13", features = ["derive"] }
 zeroize = "1"
 serde = { version = "1.0.136", features = ["derive"] }
 serde_json = "1.0.79"
-libp2p-core = { version = "0.37.0", path = "../../core" }
+libp2p-core = { version = "0.38.0", path = "../../core" }
 base64 = "0.13.0"

misc/metrics/CHANGELOG.md

@@ -1,3 +1,21 @@
+# 0.11.0 [unreleased]
+
+- Update to `libp2p-dcutr` `v0.8.0`.
+
+- Update to `libp2p-identify` `v0.41.0`.
+
+- Update to `libp2p-relay` `v0.14.0`.
+
+- Update to `libp2p-core` `v0.38.0`.
+
+- Update to `libp2p-swarm` `v0.41.0`.
+
+- Update to `libp2p-ping` `v0.41.0`.
+
+- Update to `libp2p-kad` `v0.42.0`.
+
+- Update to `libp2p-gossipsub` `v0.43.0`.
+
 # 0.10.0
 
 - Update to `libp2p-swarm` `v0.40.0`.
@@ -129,6 +147,7 @@
 - Drop support for gossipsub in wasm32-unknown-unknown target (see [PR 2506]).
 
 [PR 2442]: https://github.com/libp2p/rust-libp2p/pull/2442
+
 [PR 2506]: https://github.com/libp2p/rust-libp2p/pull/2506
 
 # 0.3.0 [2022-01-27]

misc/metrics/Cargo.toml

@@ -3,7 +3,7 @@ name = "libp2p-metrics"
 edition = "2021"
 rust-version = "1.56.1"
 description = "Metrics for libp2p"
-version = "0.10.0"
+version = "0.11.0"
 authors = ["Max Inden <mail@max-inden.de>"]
 license = "MIT"
 repository = "https://github.com/libp2p/rust-libp2p"
@@ -19,17 +19,17 @@ relay = ["libp2p-relay"]
 dcutr = ["libp2p-dcutr"]
 
 [dependencies]
-libp2p-core = { version = "0.37.0", path = "../../core" }
-libp2p-dcutr =  { version = "0.7.0", path = "../../protocols/dcutr", optional = true }
-libp2p-identify = { version = "0.40.0", path = "../../protocols/identify", optional = true }
-libp2p-kad = { version = "0.41.0", path = "../../protocols/kad", optional = true }
-libp2p-ping = { version = "0.40.0", path = "../../protocols/ping", optional = true }
-libp2p-relay =  { version = "0.13.0", path = "../../protocols/relay", optional = true }
-libp2p-swarm = { version = "0.40.0", path = "../../swarm" }
+libp2p-core = { version = "0.38.0", path = "../../core" }
+libp2p-dcutr =  { version = "0.8.0", path = "../../protocols/dcutr", optional = true }
+libp2p-identify = { version = "0.41.0", path = "../../protocols/identify", optional = true }
+libp2p-kad = { version = "0.42.0", path = "../../protocols/kad", optional = true }
+libp2p-ping = { version = "0.41.0", path = "../../protocols/ping", optional = true }
+libp2p-relay =  { version = "0.14.0", path = "../../protocols/relay", optional = true }
+libp2p-swarm = { version = "0.41.0", path = "../../swarm" }
 prometheus-client = "0.18.0"
 
 [target.'cfg(not(target_os = "unknown"))'.dependencies]
-libp2p-gossipsub =  { version = "0.42.0", path = "../../protocols/gossipsub", optional = true }
+libp2p-gossipsub =  { version = "0.43.0", path = "../../protocols/gossipsub", optional = true }
 
 [dev-dependencies]
 log = "0.4.0"

misc/prost-codec/CHANGELOG.md

@@ -1,5 +1,11 @@
+# 0.3.0 [unreleased]
+
+- Don't leak `prost` dependency in `Error` type. See [PR 3058].
+
+[PR 3058]: https://github.com/libp2p/rust-libp2p/pull/3058/
+
 # 0.2.0
 
 - Update to prost(-build) `v0.11`. See [PR 2788].
 
-[PR 2788]: https://github.com/libp2p/rust-libp2p/pull/2788/
+[PR 2788]: https://github.com/libp2p/rust-libp2p/pull/2788/

misc/prost-codec/Cargo.toml

@@ -3,7 +3,7 @@ name = "prost-codec"
 edition = "2021"
 rust-version = "1.56.1"
 description = "Asynchronous de-/encoding of Protobuf structs using asynchronous-codec, unsigned-varint and prost."
-version = "0.2.0"
+version = "0.3.0"
 authors = ["Max Inden <mail@max-inden.de>"]
 license = "MIT"
 repository = "https://github.com/libp2p/rust-libp2p"