Moved env_to_send_in_RPC function to libp2p/init.py

libp2p/__init__.py

@@ -49,6 +49,7 @@ from libp2p.peer.id import (
 )
 from libp2p.peer.peerstore import (
     PeerStore,
+    create_signed_peer_record,
 )
 from libp2p.security.insecure.transport import (
     PLAINTEXT_PROTOCOL_ID,
@@ -155,6 +156,75 @@ def get_default_muxer_options() -> TMuxerOptions:
     else:  # YAMUX is default
         return create_yamux_muxer_option()
 
+def env_to_send_in_RPC(host: IHost) -> tuple[bytes, bool]:
+    """
+    Returns the signed peer record (Envelope) to be sent in an RPC,
+    by checking whether the host already has a cached signed peer record.
+    If one exists and its addresses match the host's current listen addresses,
+    the cached envelope is reused. Otherwise, a new signed peer record is created,
+    cached, and returned.
+
+    Parameters
+    ----------
+    host : IHost
+        The local host instance, providing access to peer ID, listen addresses,
+        private key, and the peerstore.
+
+    Returns
+    -------
+    tuple[bytes, bool]
+        A tuple containing:
+        - The serialized envelope (bytes) for the signed peer record.
+        - A boolean flag indicating whether a new record was created (True)
+          or an existing cached one was reused (False).
+
+    """
+
+    listen_addrs_set = {addr for addr in host.get_addrs()}
+    local_env = host.get_peerstore().get_local_record()
+
+    if local_env is None:
+        # No cached SPR yet -> create one
+        return issue_and_cache_local_record(host), True
+    else:
+        record_addrs_set = local_env._env_addrs_set()
+        if record_addrs_set == listen_addrs_set:
+            # Perfect match -> reuse cached envelope
+            return local_env.marshal_envelope(), False
+        else:
+            # Addresses changed -> issue a new SPR and cache it
+            return issue_and_cache_local_record(host), True
+
+
+def issue_and_cache_local_record(host: IHost) -> bytes:
+    """
+    Create and cache a new signed peer record (Envelope) for the host.
+
+    This function generates a new signed peer record from the host’s peer ID,
+    listen addresses, and private key. The resulting envelope is stored in
+    the peerstore as the local record for future reuse.
+
+    Parameters
+    ----------
+    host : IHost
+        The local host instance, providing access to peer ID, listen addresses,
+        private key, and the peerstore.
+
+    Returns
+    -------
+    bytes
+        The serialized envelope (bytes) representing the newly created signed
+        peer record.
+    """
+    env = create_signed_peer_record(
+        host.get_id(),
+        host.get_addrs(),
+        host.get_private_key(),
+    )
+    # Cache it for nexxt time use
+    host.get_peerstore().set_local_record(env)
+    return env.marshal_envelope()
+
 
 def new_swarm(
     key_pair: KeyPair | None = None,

libp2p/kad_dht/kad_dht.py

@@ -18,11 +18,12 @@ from multiaddr import (
 import trio
 import varint
 
+from libp2p import env_to_send_in_RPC
 from libp2p.abc import (
     IHost,
 )
 from libp2p.discovery.random_walk.rt_refresh_manager import RTRefreshManager
-from libp2p.kad_dht.utils import env_to_send_in_RPC, maybe_consume_signed_record
+from libp2p.kad_dht.utils import maybe_consume_signed_record
 from libp2p.network.stream.net_stream import (
     INetStream,
 )

libp2p/kad_dht/peer_routing.py

@@ -10,6 +10,7 @@ import logging
 import trio
 import varint
 
+from libp2p import env_to_send_in_RPC
 from libp2p.abc import (
     IHost,
     INetStream,
@@ -34,7 +35,6 @@ from .routing_table import (
     RoutingTable,
 )
 from .utils import (
-    env_to_send_in_RPC,
     maybe_consume_signed_record,
     sort_peer_ids_by_distance,
 )

libp2p/kad_dht/provider_store.py

@@ -16,13 +16,14 @@ from multiaddr import (
 import trio
 import varint
 
+from libp2p import env_to_send_in_RPC
 from libp2p.abc import (
     IHost,
 )
 from libp2p.custom_types import (
     TProtocol,
 )
-from libp2p.kad_dht.utils import env_to_send_in_RPC, maybe_consume_signed_record
+from libp2p.kad_dht.utils import maybe_consume_signed_record
 from libp2p.peer.id import (
     ID,
 )

libp2p/kad_dht/utils.py

@@ -12,7 +12,6 @@ from libp2p.peer.envelope import consume_envelope
 from libp2p.peer.id import (
     ID,
 )
-from libp2p.peer.peerstore import create_signed_peer_record
 
 from .pb.kademlia_pb2 import (
     Message,
@@ -91,34 +90,6 @@ def maybe_consume_signed_record(
     return True
 
 
-def env_to_send_in_RPC(host: IHost) -> tuple[bytes, bool]:
-    listen_addrs_set = {addr for addr in host.get_addrs()}
-    local_env = host.get_peerstore().get_local_record()
-
-    if local_env is None:
-        # No cached SPR yet -> create one
-        return issue_and_cache_local_record(host), True
-    else:
-        record_addrs_set = local_env._env_addrs_set()
-        if record_addrs_set == listen_addrs_set:
-            # Perfect match -> reuse cached envelope
-            return local_env.marshal_envelope(), False
-        else:
-            # Addresses changed -> issue a new SPR and cache it
-            return issue_and_cache_local_record(host), True
-
-
-def issue_and_cache_local_record(host: IHost) -> bytes:
-    env = create_signed_peer_record(
-        host.get_id(),
-        host.get_addrs(),
-        host.get_private_key(),
-    )
-    # Cache it for nexxt time use
-    host.get_peerstore().set_local_record(env)
-    return env.marshal_envelope()
-
-
 def create_key_from_binary(binary_data: bytes) -> bytes:
     """
     Creates a key for the DHT by hashing binary data with SHA-256.

libp2p/kad_dht/value_store.py

@@ -9,13 +9,14 @@ import time
 
 import varint
 
+from libp2p import env_to_send_in_RPC
 from libp2p.abc import (
     IHost,
 )
 from libp2p.custom_types import (
     TProtocol,
 )
-from libp2p.kad_dht.utils import env_to_send_in_RPC, maybe_consume_signed_record
+from libp2p.kad_dht.utils import maybe_consume_signed_record
 from libp2p.peer.id import (
     ID,
 )