Merge pull request #1115 from HathorNetwork/refactor/p2p-peer-types

refactor(p2p): add PublicPeer and PrivatePeer to simplify Peer

Author: jansegre

hathor/builder/builder.py

@@ -35,7 +35,7 @@
 from hathor.manager import HathorManager
 from hathor.mining.cpu_mining_service import CpuMiningService
 from hathor.p2p.manager import ConnectionsManager
-from hathor.p2p.peer import Peer
+from hathor.p2p.peer import PrivatePeer
 from hathor.pubsub import PubSubManager
 from hathor.reactor import ReactorProtocol as Reactor
 from hathor.storage import RocksDBStorage
@@ -69,6 +69,7 @@ def add_factories(
         sync_v1_support: 'SyncSupportLevel',
         sync_v2_support: 'SyncSupportLevel',
         vertex_parser: VertexParser,
+        vertex_handler: VertexHandler,
     ) -> None:
         """Adds the sync factory to the manager according to the support level."""
         from hathor.p2p.sync_v1.factory import SyncV11Factory
@@ -82,9 +83,13 @@ def add_factories(
             p2p_manager.enable_sync_version(SyncVersion.V1_1)
         # sync-v2 support:
         if sync_v2_support > cls.UNAVAILABLE:
-            p2p_manager.add_sync_factory(
-                SyncVersion.V2, SyncV2Factory(settings, p2p_manager, vertex_parser=vertex_parser)
+            sync_v2_factory = SyncV2Factory(
+                settings,
+                p2p_manager,
+                vertex_parser=vertex_parser,
+                vertex_handler=vertex_handler,
             )
+            p2p_manager.add_sync_factory(SyncVersion.V2, sync_v2_factory)
         if sync_v2_support is cls.ENABLED:
             p2p_manager.enable_sync_version(SyncVersion.V2)
 
@@ -96,7 +101,7 @@ class StorageType(Enum):
 
 class BuildArtifacts(NamedTuple):
     """Artifacts created by a builder."""
-    peer: Peer
+    peer: PrivatePeer
     settings: HathorSettingsType
     rng: Random
     reactor: Reactor
@@ -137,7 +142,7 @@ def __init__(self) -> None:
         self._checkpoints: Optional[list[Checkpoint]] = None
         self._capabilities: Optional[list[str]] = None
 
-        self._peer: Optional[Peer] = None
+        self._peer: Optional[PrivatePeer] = None
         self._network: Optional[str] = None
         self._cmdline: str = ''
 
@@ -337,7 +342,7 @@ def set_capabilities(self, capabilities: list[str]) -> 'Builder':
         self._capabilities = capabilities
         return self
 
-    def set_peer(self, peer: Peer) -> 'Builder':
+    def set_peer(self, peer: PrivatePeer) -> 'Builder':
         self.check_if_can_modify()
         self._peer = peer
         return self
@@ -361,7 +366,7 @@ def _get_soft_voided_tx_ids(self) -> set[bytes]:
 
         return set(settings.SOFT_VOIDED_TX_IDS)
 
-    def _get_peer(self) -> Peer:
+    def _get_peer(self) -> PrivatePeer:
         if self._peer is not None:
             return self._peer
         raise ValueError('peer not set')
@@ -436,6 +441,7 @@ def _get_or_create_p2p_manager(self) -> ConnectionsManager:
             self._sync_v1_support,
             self._sync_v2_support,
             self._get_or_create_vertex_parser(),
+            self._get_or_create_vertex_handler(),
         )
         return self._p2p_manager
 

hathor/builder/cli_builder.py

@@ -36,7 +36,7 @@
 from hathor.mining.cpu_mining_service import CpuMiningService
 from hathor.p2p.entrypoint import Entrypoint
 from hathor.p2p.manager import ConnectionsManager
-from hathor.p2p.peer import Peer
+from hathor.p2p.peer import PrivatePeer
 from hathor.p2p.utils import discover_hostname, get_genesis_short_hash
 from hathor.pubsub import PubSubManager
 from hathor.reactor import ReactorProtocol as Reactor
@@ -100,7 +100,11 @@ def create_manager(self, reactor: Reactor) -> HathorManager:
         self.log = logger.new()
         self.reactor = reactor
 
-        peer = Peer.create_from_json_path(self._args.peer) if self._args.peer else Peer()
+        peer: PrivatePeer
+        if self._args.peer:
+            peer = PrivatePeer.create_from_json_path(self._args.peer)
+        else:
+            peer = PrivatePeer.auto_generated()
         python = f'{platform.python_version()}-{platform.python_implementation()}'
 
         self.log.info(
@@ -325,7 +329,6 @@ def create_manager(self, reactor: Reactor) -> HathorManager:
             whitelist_only=False,
             rng=Random(),
         )
-        SyncSupportLevel.add_factories(settings, p2p_manager, sync_v1_support, sync_v2_support, vertex_parser)
 
         vertex_handler = VertexHandler(
             reactor=reactor,
@@ -340,6 +343,15 @@ def create_manager(self, reactor: Reactor) -> HathorManager:
             log_vertex_bytes=self._args.log_vertex_bytes,
         )
 
+        SyncSupportLevel.add_factories(
+            settings,
+            p2p_manager,
+            sync_v1_support,
+            sync_v2_support,
+            vertex_parser,
+            vertex_handler,
+        )
+
         from hathor.consensus.poa import PoaBlockProducer, PoaSignerFile
         poa_block_producer: PoaBlockProducer | None = None
         if settings.CONSENSUS_ALGORITHM.is_poa():

hathor/cli/peer_id.py

@@ -20,9 +20,9 @@
 
 
 def main() -> None:
-    from hathor.p2p.peer import Peer
+    from hathor.p2p.peer import PrivatePeer
 
-    peer = Peer()
-    data = peer.to_json(include_private_key=True)
+    peer = PrivatePeer.auto_generated()
+    data = peer.to_json_private()
     txt = json.dumps(data, indent=4)
     print(txt)

hathor/manager.py

@@ -46,7 +46,7 @@
 from hathor.mining import BlockTemplate, BlockTemplates
 from hathor.mining.cpu_mining_service import CpuMiningService
 from hathor.p2p.manager import ConnectionsManager
-from hathor.p2p.peer import Peer
+from hathor.p2p.peer import PrivatePeer
 from hathor.p2p.peer_id import PeerId
 from hathor.profiler import get_cpu_profiler
 from hathor.pubsub import HathorEvents, PubSubManager
@@ -60,7 +60,7 @@
 from hathor.transaction.storage.tx_allow_scope import TxAllowScope
 from hathor.transaction.vertex_parser import VertexParser
 from hathor.types import Address, VertexId
-from hathor.util import EnvironmentInfo, LogDuration, Random, calculate_min_significant_weight, not_none
+from hathor.util import EnvironmentInfo, LogDuration, Random, calculate_min_significant_weight
 from hathor.verification.verification_service import VerificationService
 from hathor.vertex_handler import VertexHandler
 from hathor.wallet import BaseWallet
@@ -97,7 +97,7 @@ def __init__(
         pubsub: PubSubManager,
         consensus_algorithm: ConsensusAlgorithm,
         daa: DifficultyAdjustmentAlgorithm,
-        peer: Peer,
+        peer: PrivatePeer,
         tx_storage: TransactionStorage,
         p2p_manager: ConnectionsManager,
         event_manager: EventManager,
@@ -298,7 +298,7 @@ def start(self) -> None:
                 sys.exit(-1)
 
         if self._enable_event_queue:
-            self._event_manager.start(str(not_none(self.my_peer.id)))
+            self._event_manager.start(str(self.my_peer.id))
 
         self.state = self.NodeState.INITIALIZING
         self.pubsub.publish(HathorEvents.MANAGER_ON_START)

hathor/metrics.py

@@ -246,7 +246,7 @@ def collect_peer_connection_metrics(self) -> None:
         self.peer_connection_metrics.clear()
 
         for connection in self.connections.connections:
-            if not connection.peer or not connection.peer.id:
+            if not connection._peer:
                 # A connection without peer will not be able to communicate
                 # So we can just discard it for the sake of the metrics
                 continue

hathor/p2p/factory.py

@@ -19,7 +19,7 @@
 
 from hathor.conf.settings import HathorSettings
 from hathor.p2p.manager import ConnectionsManager
-from hathor.p2p.peer import Peer
+from hathor.p2p.peer import PrivatePeer
 from hathor.p2p.protocol import HathorLineReceiver
 
 if TYPE_CHECKING:
@@ -39,7 +39,7 @@ class HathorServerFactory(protocol.ServerFactory):
     def __init__(
         self,
         network: str,
-        my_peer: Peer,
+        my_peer: PrivatePeer,
         p2p_manager: ConnectionsManager,
         *,
         settings: HathorSettings,
@@ -75,7 +75,7 @@ class HathorClientFactory(protocol.ClientFactory):
     def __init__(
         self,
         network: str,
-        my_peer: Peer,
+        my_peer: PrivatePeer,
         p2p_manager: ConnectionsManager,
         *,
         settings: HathorSettings,