fix definition link, simplify record parsing

Author: drHuangMHT

core/src/peer_record.rs

@@ -1,4 +1,4 @@
-use libp2p_identity::{Keypair, PeerId, PublicKey, SigningError};
+use libp2p_identity::{Keypair, PeerId, SigningError};
 use quick_protobuf::{BytesReader, Writer};
 use web_time::SystemTime;
 
@@ -30,7 +30,26 @@ impl PeerRecord {
     /// If this function succeeds, the [`SignedEnvelope`] contained a peer record with a valid
     /// signature and can hence be considered authenticated.
     pub fn from_signed_envelope(envelope: SignedEnvelope) -> Result<Self, FromEnvelopeError> {
-        let (_, peer_id, seq, addresses) = Self::try_deserialize_signed_envelope(&envelope)?;
+        use quick_protobuf::MessageRead;
+
+        let (payload, signing_key) =
+            envelope.payload_and_signing_key(String::from(DOMAIN_SEP), PAYLOAD_TYPE.as_bytes())?;
+        let mut reader = BytesReader::from_bytes(payload);
+        let record = proto::PeerRecord::from_reader(&mut reader, payload).map_err(DecodeError)?;
+
+        let peer_id = PeerId::from_bytes(&record.peer_id)?;
+
+        if peer_id != signing_key.to_peer_id() {
+            return Err(FromEnvelopeError::MismatchedSignature);
+        }
+
+        let seq = record.seq;
+        let addresses = record
+            .addresses
+            .into_iter()
+            .map(|a| a.multiaddr.to_vec().try_into())
+            .collect::<Result<Vec<_>, _>>()?;
+
         Ok(Self {
             peer_id,
             seq,
@@ -107,37 +126,6 @@ impl PeerRecord {
     pub fn addresses(&self) -> &[Multiaddr] {
         self.addresses.as_slice()
     }
-
-    /// Utility method for deserializing an [`SignedEnvelope`] using
-    /// [`PeerRecord`]-specific [domain separation](https://github.com/libp2p/specs/blob/master/RFC/0003-routing-records.md#signed-envelope-domain)
-    ///  and [payload type](https://github.com/libp2p/specs/blob/master/RFC/0003-routing-records.md#signed-envelope-payload-type).
-    /// Useful for extracting the address only.  
-    /// Returns `Ok((envelope_public_key, envelope_signer_id, sequence_number, signed_addresses))`
-    /// when the envelope is valid.
-    /// Will fail when the source of the addresses doesn't match signer of the envelope.
-    pub fn try_deserialize_signed_envelope(
-        envelope: &SignedEnvelope,
-    ) -> Result<(&PublicKey, PeerId, u64, Vec<Multiaddr>), FromEnvelopeError> {
-        use quick_protobuf::MessageRead;
-
-        let (payload, signing_key) =
-            envelope.payload_and_signing_key(String::from(DOMAIN_SEP), PAYLOAD_TYPE.as_bytes())?;
-        let mut reader = BytesReader::from_bytes(payload);
-        let record = proto::PeerRecord::from_reader(&mut reader, payload).map_err(DecodeError)?;
-
-        let peer_id = PeerId::from_bytes(&record.peer_id)?;
-
-        if peer_id != signing_key.to_peer_id() {
-            return Err(FromEnvelopeError::MismatchedSignature);
-        }
-
-        let addresses = record
-            .addresses
-            .into_iter()
-            .map(|a| a.multiaddr.to_vec().try_into())
-            .collect::<Result<Vec<_>, _>>()?;
-        Ok((signing_key, peer_id, record.seq, addresses))
-    }
 }
 
 #[derive(thiserror::Error, Debug)]

protocols/identify/src/generated/structs.proto

@@ -28,7 +28,8 @@ message Identify {
   // signedPeerRecord contains a serialized SignedEnvelope containing a PeerRecord,
   // signed by the sending node. It contains the same addresses as the listenAddrs field, but
   // in a form that lets us share authenticated addrs with other peers.
-  // see github.com/libp2p/go-libp2p/core/record/pb/envelope.proto and
-  // github.com/libp2p/go-libp2p/core/peer/pb/peer_record.proto for message definitions.
+  // see https://github.com/libp2p/rust-libp2p/blob/8ac5b5aac5f5c25a85f1065e292deeaf58290189/core/src/generated/envelope.proto#L12 
+  // and https://github.com/libp2p/rust-libp2p/blob/8ac5b5aac5f5c25a85f1065e292deeaf58290189/core/src/generated/peer_record.proto#L11 
+  // for message definitions.
   optional bytes signedPeerRecord = 8;
 }

protocols/identify/src/protocol.rs

@@ -230,15 +230,17 @@ impl TryFrom<proto::Identify> for Info {
         // When signedPeerRecord contains valid addresses, ignore addresses in listenAddrs.
         // When signedPeerRecord is invalid or signed by others, ignore the signedPeerRecord(set to
         // `None`).
-        let (signed_envelope, listen_addrs) = msg
+        let (listen_addrs, signed_envelope) = msg
             .signedPeerRecord
             .and_then(|b| {
                 let envelope = SignedEnvelope::from_protobuf_encoding(b.as_ref()).ok()?;
-                let (envelope_public_key, _, _, addresses) =
-                    PeerRecord::try_deserialize_signed_envelope(&envelope).ok()?;
-                (*envelope_public_key == identify_public_key).then_some((Some(envelope), addresses))
+                let peer_record = PeerRecord::from_signed_envelope(envelope).ok()?;
+                (peer_record.peer_id() == identify_public_key.to_peer_id()).then_some((
+                    peer_record.addresses().to_vec(),
+                    Some(peer_record.into_signed_envelope()),
+                ))
             })
-            .unwrap_or_else(|| (None, parse_listen_addrs(msg.listenAddrs)));
+            .unwrap_or_else(|| (parse_listen_addrs(msg.listenAddrs), None));
 
         let info = Info {
             public_key: identify_public_key,