feat(p2p): add ability to update peer_id.json with SIGUSR1

Author: glevco

hathor/builder/cli_builder.py

@@ -13,7 +13,6 @@
 # limitations under the License.
 
 import getpass
-import json
 import os
 import platform
 import sys
@@ -96,8 +95,7 @@ def create_manager(self, reactor: Reactor) -> HathorManager:
         self.log = logger.new()
         self.reactor = reactor
 
-        peer_id = self.create_peer_id()
-
+        peer_id = PeerId.create_from_json_path(self._args.peer) if self._args.peer else PeerId()
         python = f'{platform.python_version()}-{platform.python_implementation()}'
 
         self.log.info(
@@ -322,6 +320,7 @@ def create_manager(self, reactor: Reactor) -> HathorManager:
             verification_service=verification_service,
             cpu_mining_service=cpu_mining_service,
             execution_manager=execution_manager,
+            peer_id_json_path=self._args.peer,
         )
 
         if self._args.x_ipython_kernel:
@@ -397,14 +396,6 @@ def get_hostname(self) -> Optional[str]:
             print('Hostname discovered and set to {}'.format(hostname))
         return hostname
 
-    def create_peer_id(self) -> PeerId:
-        if not self._args.peer:
-            peer_id = PeerId()
-        else:
-            data = json.load(open(self._args.peer, 'r'))
-            peer_id = PeerId.create_from_json(data)
-        return peer_id
-
     def create_wallet(self) -> BaseWallet:
         if self._args.wallet == 'hd':
             kwargs: dict[str, Any] = {

hathor/cli/run_node.py

@@ -267,6 +267,7 @@ def signal_usr1_handler(self, sig: int, frame: Any) -> None:
             self.log.warn('USR1 received. Killing all connections...')
             if self.manager and self.manager.connections:
                 self.manager.connections.disconnect_all_peers(force=True)
+                self.manager.update_peer_id()
         except Exception:
             # see: https://docs.python.org/3/library/signal.html#note-on-signal-handlers-and-exceptions
             self.log.error('prevented exception from escaping the signal handler', exc_info=True)

hathor/manager.py

@@ -89,31 +89,34 @@ class UnhealthinessReason(str, Enum):
     # This is the interval to be used by the task to check if the node is synced
     CHECK_SYNC_STATE_INTERVAL = 30  # seconds
 
-    def __init__(self,
-                 reactor: Reactor,
-                 *,
-                 settings: HathorSettings,
-                 pubsub: PubSubManager,
-                 consensus_algorithm: ConsensusAlgorithm,
-                 daa: DifficultyAdjustmentAlgorithm,
-                 peer_id: PeerId,
-                 tx_storage: TransactionStorage,
-                 p2p_manager: ConnectionsManager,
-                 event_manager: EventManager,
-                 feature_service: FeatureService,
-                 bit_signaling_service: BitSignalingService,
-                 verification_service: VerificationService,
-                 cpu_mining_service: CpuMiningService,
-                 network: str,
-                 execution_manager: ExecutionManager,
-                 hostname: Optional[str] = None,
-                 wallet: Optional[BaseWallet] = None,
-                 capabilities: Optional[list[str]] = None,
-                 checkpoints: Optional[list[Checkpoint]] = None,
-                 rng: Optional[Random] = None,
-                 environment_info: Optional[EnvironmentInfo] = None,
-                 full_verification: bool = False,
-                 enable_event_queue: bool = False):
+    def __init__(
+        self,
+        reactor: Reactor,
+        *,
+        settings: HathorSettings,
+        pubsub: PubSubManager,
+        consensus_algorithm: ConsensusAlgorithm,
+        daa: DifficultyAdjustmentAlgorithm,
+        peer_id: PeerId,
+        tx_storage: TransactionStorage,
+        p2p_manager: ConnectionsManager,
+        event_manager: EventManager,
+        feature_service: FeatureService,
+        bit_signaling_service: BitSignalingService,
+        verification_service: VerificationService,
+        cpu_mining_service: CpuMiningService,
+        network: str,
+        execution_manager: ExecutionManager,
+        hostname: Optional[str] = None,
+        wallet: Optional[BaseWallet] = None,
+        capabilities: Optional[list[str]] = None,
+        checkpoints: Optional[list[Checkpoint]] = None,
+        rng: Optional[Random] = None,
+        environment_info: Optional[EnvironmentInfo] = None,
+        full_verification: bool = False,
+        enable_event_queue: bool = False,
+        peer_id_json_path: str | None = None,
+    ) -> None:
         """
         :param reactor: Twisted reactor which handles the mainloop and the events.
         :param peer_id: Id of this node.
@@ -135,6 +138,7 @@ def __init__(self,
         self._settings = settings
         self.daa = daa
         self._cmd_path: Optional[str] = None
+        self._peer_id_json_path = peer_id_json_path
 
         self.log = logger.new()
 
@@ -1173,6 +1177,11 @@ def get_cmd_path(self) -> Optional[str]:
         """Return the cmd path. If no cmd path is set, returns None."""
         return self._cmd_path
 
+    def update_peer_id(self) -> None:
+        """Recreate this manager's PeerId from the json file, that may have changed."""
+        if self._peer_id_json_path:
+            self.my_peer = PeerId.create_from_json_path(self._peer_id_json_path)
+
 
 class ParentTxs(NamedTuple):
     """ Tuple where the `must_include` hash, when present (at most 1), must be included in a pair, and a list of hashes

hathor/p2p/peer_id.py

@@ -14,6 +14,7 @@
 
 import base64
 import hashlib
+import json
 from enum import Enum
 from math import inf
 from typing import TYPE_CHECKING, Any, Optional, cast
@@ -159,9 +160,15 @@ def verify_signature(self, signature: bytes, data: bytes) -> bool:
         else:
             return True
 
+    @classmethod
+    def create_from_json_path(cls, path: str) -> 'PeerId':
+        """Create a new PeerId from a JSON file."""
+        data = json.load(open(path, 'r'))
+        return PeerId.create_from_json(data)
+
     @classmethod
     def create_from_json(cls, data: dict[str, Any]) -> 'PeerId':
-        """ Create a new PeerId from a JSON.
+        """ Create a new PeerId from JSON data.
 
         It is used both to load a PeerId from disk and to create a PeerId
         from a peer connection.