Merge pull request libp2p#1080 from yashksaini-coder/Fix/Decouple-peer-ID-postfix

Decouple Peer ID Postfix from `get_addrs` & Introduce `get_transport_addrs`

Author: seetadev

examples/ping/ping.py

@@ -93,11 +93,16 @@ async def run(port: int, destination: str, psk: int, transport: str) -> None:
 
             # Get all available addresses with peer ID
             all_addrs = host.get_addrs()
+            transport_addrs = host.get_transport_addrs()
 
             print("Listener ready, listening on:\n")
             for addr in all_addrs:
                 print(f"{addr}")
 
+            print("\nRaw transport addresses (without peer ID):")
+            for addr in transport_addrs:
+                print(f"{addr}")
+
             print(
                 f"\nRun this from the same folder in another console:\n\n"
                 f"ping-demo -d {host.get_addrs()[0]} -psk {psk} -t {transport}\n"

libp2p/abc.py

@@ -1819,6 +1819,19 @@ def get_addrs(self) -> list[Multiaddr]:
 
         """
 
+    @abstractmethod
+    def get_transport_addrs(self) -> list[Multiaddr]:
+        """
+        Retrieve the raw multiaddr addresses this host is listening to,
+        without the /p2p/{peer_id} suffix.
+
+        Returns
+        -------
+        list[Multiaddr]
+            A list of raw multiaddresses.
+
+        """
+
     @abstractmethod
     def get_peerstore(self) -> IPeerStore:
         """

libp2p/host/basic_host.py

@@ -312,19 +312,26 @@ def get_mux(self) -> Multiselect:
         """
         return self.multiselect
 
-    def get_addrs(self) -> list[multiaddr.Multiaddr]:
+    def get_transport_addrs(self) -> list[multiaddr.Multiaddr]:
         """
-        :return: all the multiaddr addresses this host is listening to
+        Return the raw multiaddr addresses this host is listening to,
+        without the /p2p/{peer_id} suffix.
         """
-        # TODO: We don't need "/p2p/{peer_id}" postfix actually.
-        p2p_part = multiaddr.Multiaddr(f"/p2p/{self.get_id()!s}")
-
         addrs: list[multiaddr.Multiaddr] = []
         for transport in self._network.listeners.values():
-            for addr in transport.get_addrs():
-                addrs.append(addr.encapsulate(p2p_part))
+            addrs.extend(transport.get_addrs())
         return addrs
 
+    def get_addrs(self) -> list[multiaddr.Multiaddr]:
+        """
+        Return all the multiaddr addresses this host is listening to.
+
+        Note: This method appends the /p2p/{peer_id} suffix to the addresses.
+        Use get_transport_addrs() for raw transport addresses.
+        """
+        p2p_part = multiaddr.Multiaddr(f"/p2p/{self.get_id()!s}")
+        return [addr.encapsulate(p2p_part) for addr in self.get_transport_addrs()]
+
     def get_connected_peers(self) -> list[ID]:
         """
         :return: all the ids of peers this host is currently connected to

newsfragments/1073.feature.rst

@@ -0,0 +1,2 @@
+Introduced ``get_transport_addrs()`` method to ``BasicHost`` for retrieving raw transport addresses without the peer ID suffix.
+Refactored ``get_addrs()`` to utilize this new method, maintaining backward compatibility.

tests/core/host/test_basic_host.py

@@ -4,6 +4,7 @@
 )
 
 import pytest
+from multiaddr import Multiaddr
 
 from libp2p import (
     new_swarm,
@@ -59,3 +60,35 @@ async def fake_negotiate(comm, timeout):
 
     # Ensure reset was called since negotiation failed
     net_stream.reset.assert_awaited()
+
+
+def test_get_addrs_and_transport_addrs():
+    key_pair = create_new_key_pair()
+    swarm = new_swarm(key_pair)
+    host = BasicHost(swarm)
+
+    # Mock the network listeners
+    mock_transport = MagicMock()
+    raw_addr = Multiaddr("/ip4/127.0.0.1/tcp/8000")
+    mock_transport.get_addrs.return_value = [raw_addr]
+
+    # Inject into swarm listeners
+    # swarm.listeners is a dict
+    swarm.listeners = {"tcp": mock_transport}
+
+    # Test get_transport_addrs
+    transport_addrs = host.get_transport_addrs()
+    assert len(transport_addrs) == 1
+    assert transport_addrs[0] == raw_addr
+    assert str(transport_addrs[0]) == "/ip4/127.0.0.1/tcp/8000"
+
+    # Test get_addrs
+    addrs = host.get_addrs()
+    assert len(addrs) == 1
+    addr_str = str(addrs[0])
+    peer_id_str = str(host.get_id())
+    assert peer_id_str in addr_str
+    # multiaddr might normalize /p2p/ to /ipfs/
+    assert addr_str.endswith(f"/p2p/{peer_id_str}") or addr_str.endswith(
+        f"/ipfs/{peer_id_str}"
+    )