networking: simplify peer abstraction

Author: tcoratger

src/lean_spec/subspecs/networking/gossipsub/rpc.py

@@ -351,7 +351,7 @@ def decode(cls, data: bytes) -> ControlGraft:
 
 
 @dataclass(slots=True)
-class PeerInfo:
+class PrunePeerInfo:
     """Peer information for PRUNE peer exchange."""
 
     peer_id: bytes = b""
@@ -370,7 +370,7 @@ def encode(self) -> bytes:
         return bytes(result)
 
     @classmethod
-    def decode(cls, data: bytes) -> PeerInfo:
+    def decode(cls, data: bytes) -> PrunePeerInfo:
         """Decode from protobuf."""
         peer_id = b""
         signed_peer_record = b""
@@ -401,7 +401,7 @@ class ControlPrune:
     topic_id: str = ""
     """Topic being pruned from."""
 
-    peers: list[PeerInfo] = field(default_factory=list)
+    peers: list[PrunePeerInfo] = field(default_factory=list)
     """Peer exchange - alternative peers for the topic (v1.1)."""
 
     backoff: int = 0
@@ -422,7 +422,7 @@ def encode(self) -> bytes:
     def decode(cls, data: bytes) -> ControlPrune:
         """Decode from protobuf."""
         topic_id = ""
-        peers: list[PeerInfo] = []
+        peers: list[PrunePeerInfo] = []
         backoff = 0
         pos = 0
 
@@ -435,7 +435,7 @@ def decode(cls, data: bytes) -> ControlPrune:
                 pos += length
             elif field_num == 2 and wire_type == WIRE_TYPE_LENGTH_DELIMITED:
                 length, pos = _decode_length_at(data, pos)
-                peers.append(PeerInfo.decode(data[pos : pos + length]))
+                peers.append(PrunePeerInfo.decode(data[pos : pos + length]))
                 pos += length
             elif field_num == 3 and wire_type == WIRE_TYPE_VARINT:
                 backoff, pos = _decode_varint_at(data, pos)

…an_spec/subspecs/networking/peer/info.py src/lean_spec/subspecs/networking/peer.pysrc/lean_spec/subspecs/networking/peer/info.py renamed to src/lean_spec/subspecs/networking/peer.py src/lean_spec/subspecs/networking/peer/info.py renamed to src/lean_spec/subspecs/networking/peer.py

@@ -3,32 +3,15 @@
 from __future__ import annotations
 
 from dataclasses import dataclass, field
-from enum import IntEnum, auto
 from time import time
 from typing import TYPE_CHECKING
 
-from ..transport import PeerId
-from ..types import ConnectionState, Multiaddr
+from .transport import PeerId
+from .types import ConnectionState, Direction, Multiaddr
 
 if TYPE_CHECKING:
-    from ..enr import ENR
-    from ..reqresp import Status
-
-
-class Direction(IntEnum):
-    """
-    Direction of a peer connection.
-
-    Indicates whether:
-        - we initiated the connection (outbound) or
-        - the peer connected to us (inbound).
-    """
-
-    INBOUND = auto()
-    """Peer initiated the connection to us."""
-
-    OUTBOUND = auto()
-    """We initiated the connection to the peer."""
+    from .enr import ENR
+    from .reqresp import Status
 
 
 @dataclass

src/lean_spec/subspecs/networking/peer/__init__.py

@@ -31,7 +31,7 @@
 from lean_spec.subspecs.containers.attestation import SignedAggregatedAttestation, SignedAttestation
 from lean_spec.subspecs.networking.client.event_source import LiveNetworkEventSource
 from lean_spec.subspecs.networking.gossipsub.topic import GossipTopic
-from lean_spec.subspecs.networking.peer.info import PeerInfo
+from lean_spec.subspecs.networking.peer import PeerInfo
 from lean_spec.subspecs.networking.types import ConnectionState
 
 from .events import (

src/lean_spec/subspecs/networking/service/service.py

@@ -36,6 +36,22 @@
 """Multiaddress string, e.g. ``/ip4/192.168.1.1/udp/9000/quic-v1``."""
 
 
+class Direction(IntEnum):
+    """
+    Direction of a peer connection.
+
+    Indicates whether:
+        - we initiated the connection (outbound) or
+        - the peer connected to us (inbound).
+    """
+
+    INBOUND = auto()
+    """Peer initiated the connection to us."""
+
+    OUTBOUND = auto()
+    """We initiated the connection to the peer."""
+
+
 class ConnectionState(IntEnum):
     """
     Peer connection state machine.

src/lean_spec/subspecs/networking/types.py

@@ -11,7 +11,7 @@
 
 from lean_spec.subspecs.containers.slot import Slot
 from lean_spec.subspecs.networking import PeerId
-from lean_spec.subspecs.networking.peer.info import PeerInfo
+from lean_spec.subspecs.networking.peer import PeerInfo
 from lean_spec.subspecs.networking.reqresp.message import Status
 
 from .config import MAX_CONCURRENT_REQUESTS

src/lean_spec/subspecs/sync/peer_manager.py

@@ -19,7 +19,7 @@
 from lean_spec.subspecs.forkchoice import Store
 from lean_spec.subspecs.networking import PeerId
 from lean_spec.subspecs.networking.client import LiveNetworkEventSource
-from lean_spec.subspecs.networking.peer.info import PeerInfo
+from lean_spec.subspecs.networking.peer import PeerInfo
 from lean_spec.subspecs.networking.reqresp.message import Status
 from lean_spec.subspecs.networking.types import ConnectionState
 from lean_spec.subspecs.node import Node, NodeConfig

tests/interop/helpers/node_runner.py

@@ -34,7 +34,7 @@
 from lean_spec.subspecs.forkchoice import Store
 from lean_spec.subspecs.koalabear import Fp
 from lean_spec.subspecs.networking import PeerId
-from lean_spec.subspecs.networking.peer.info import PeerInfo
+from lean_spec.subspecs.networking.peer import PeerInfo
 from lean_spec.subspecs.networking.reqresp.message import Status
 from lean_spec.subspecs.networking.types import ConnectionState
 from lean_spec.subspecs.ssz.hash import hash_tree_root

tests/lean_spec/helpers/builders.py

@@ -9,7 +9,7 @@
 import pytest
 
 from lean_spec.subspecs.networking import PeerId
-from lean_spec.subspecs.networking.peer.info import PeerInfo
+from lean_spec.subspecs.networking.peer import PeerInfo
 from lean_spec.subspecs.networking.types import ConnectionState
 
 

tests/lean_spec/subspecs/conftest.py

@@ -16,33 +16,33 @@
     ControlMessage,
     ControlPrune,
     Message,
-    PeerInfo,
     ProtobufDecodeError,
+    PrunePeerInfo,
     SubOpts,
     _skip_field,
     encode_bytes,
     encode_tag,
 )
 
 
-class TestPeerInfoRoundtrip:
-    """Tests for PeerInfo protobuf encoding/decoding."""
+class TestPrunePeerInfoRoundtrip:
+    """Tests for PrunePeerInfo protobuf encoding/decoding."""
 
     def test_peer_info_with_both_fields(self) -> None:
-        """PeerInfo roundtrips with both peer_id and signed_peer_record."""
-        info = PeerInfo(peer_id=b"peer123", signed_peer_record=b"record456")
-        assert PeerInfo.decode(info.encode()) == info
+        """PrunePeerInfo roundtrips with both peer_id and signed_peer_record."""
+        info = PrunePeerInfo(peer_id=b"peer123", signed_peer_record=b"record456")
+        assert PrunePeerInfo.decode(info.encode()) == info
 
     def test_peer_info_peer_id_only(self) -> None:
-        """PeerInfo roundtrips with only peer_id."""
-        info = PeerInfo(peer_id=b"peerOnly")
-        assert PeerInfo.decode(info.encode()) == info
+        """PrunePeerInfo roundtrips with only peer_id."""
+        info = PrunePeerInfo(peer_id=b"peerOnly")
+        assert PrunePeerInfo.decode(info.encode()) == info
 
     def test_peer_info_empty(self) -> None:
-        """Empty PeerInfo produces empty encoding."""
-        info = PeerInfo()
+        """Empty PrunePeerInfo produces empty encoding."""
+        info = PrunePeerInfo()
         assert info.encode() == b""
-        assert PeerInfo.decode(b"") == PeerInfo()
+        assert PrunePeerInfo.decode(b"") == PrunePeerInfo()
 
 
 class TestPruneWithPeerExchange:
@@ -53,8 +53,8 @@ def test_prune_with_peers(self) -> None:
         prune = ControlPrune(
             topic_id="/topic",
             peers=[
-                PeerInfo(peer_id=b"alt1", signed_peer_record=b"rec1"),
-                PeerInfo(peer_id=b"alt2"),
+                PrunePeerInfo(peer_id=b"alt1", signed_peer_record=b"rec1"),
+                PrunePeerInfo(peer_id=b"alt2"),
             ],
             backoff=120,
         )