server: Introduce ApiProtocol (Chia-Network#15466)

* server: Introduce `ApiProtocol`

* genericize (#5)

* `ApiProtocol.api_ready` -> `ApiProtocol.ready()`

* Add `ApiProtocol.log` and give APIs separate loggers

* Fix `CrawlerAPI`

* Drop some unrelated removals

* Fix some of the generic hinting

* Revert some changes in `timelord_api.py`

* Fix `CawlerAPI` readiness

* Fix hinting

* Get some `CrawlerAPI` coverage

---------

Co-authored-by: Kyle Altendorf <[email protected]>

chia/data_layer/data_layer_api.py

@@ -7,9 +7,11 @@
 
 
 class DataLayerAPI:
+    log: logging.Logger
     data_layer: DataLayer
 
     def __init__(self, data_layer: DataLayer) -> None:
+        self.log = logging.getLogger(__name__)
         self.data_layer = data_layer
 
     # def _set_state_changed_callback(self, callback: StateChangedProtocol) -> None:
@@ -19,10 +21,5 @@ def __init__(self, data_layer: DataLayer) -> None:
     def server(self) -> ChiaServer:
         return self.data_layer.server
 
-    @property
-    def log(self) -> logging.Logger:
-        return self.data_layer.log
-
-    @property
-    def api_ready(self) -> bool:
+    def ready(self) -> bool:
         return self.data_layer.initialized

chia/farmer/farmer_api.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import json
+import logging
 import time
 from typing import Any, Dict, List, Optional, Tuple
 
@@ -53,11 +54,16 @@ def strip_old_entries(pairs: List[Tuple[float, Any]], before: float) -> List[Tup
 
 
 class FarmerAPI:
+    log: logging.Logger
     farmer: Farmer
 
     def __init__(self, farmer: Farmer) -> None:
+        self.log = logging.getLogger(__name__)
         self.farmer = farmer
 
+    def ready(self) -> bool:
+        return self.farmer.started
+
     @api_request(peer_required=True)
     async def new_proof_of_space(
         self, new_proof_of_space: harvester_protocol.NewProofOfSpace, peer: WSChiaConnection

chia/full_node/full_node_api.py

@@ -69,10 +69,12 @@
 
 
 class FullNodeAPI:
+    log: logging.Logger
     full_node: FullNode
     executor: ThreadPoolExecutor
 
     def __init__(self, full_node: FullNode) -> None:
+        self.log = logging.getLogger(__name__)
         self.full_node = full_node
         self.executor = ThreadPoolExecutor(max_workers=1)
 
@@ -81,12 +83,7 @@ def server(self) -> ChiaServer:
         assert self.full_node.server is not None
         return self.full_node.server
 
-    @property
-    def log(self) -> logging.Logger:
-        return self.full_node.log
-
-    @property
-    def api_ready(self) -> bool:
+    def ready(self) -> bool:
         return self.full_node.initialized
 
     @api_request(peer_required=True, reply_types=[ProtocolMessageTypes.respond_peers])

chia/harvester/harvester_api.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import asyncio
+import logging
 import time
 from pathlib import Path
 from typing import List, Optional, Tuple
@@ -29,11 +30,16 @@
 
 
 class HarvesterAPI:
+    log: logging.Logger
     harvester: Harvester
 
     def __init__(self, harvester: Harvester):
+        self.log = logging.getLogger(__name__)
         self.harvester = harvester
 
+    def ready(self) -> bool:
+        return True
+
     @api_request(peer_required=True)
     async def harvester_handshake(
         self, harvester_handshake: harvester_protocol.HarvesterHandshake, peer: WSChiaConnection

chia/introducer/introducer_api.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import logging
 from typing import Optional
 
 from chia.introducer.introducer import Introducer
@@ -14,11 +15,16 @@
 
 
 class IntroducerAPI:
+    log: logging.Logger
     introducer: Introducer
 
     def __init__(self, introducer) -> None:
+        self.log = logging.getLogger(__name__)
         self.introducer = introducer
 
+    def ready(self) -> bool:
+        return True
+
     def _set_state_changed_callback(self, callback: StateChangedProtocol) -> None:
         pass
 

chia/seeder/crawler_api.py

@@ -12,19 +12,20 @@
 
 
 class CrawlerAPI:
+    log: logging.Logger
     crawler: Crawler
 
     def __init__(self, crawler: Crawler) -> None:
+        self.log = logging.getLogger(__name__)
         self.crawler = crawler
 
     @property
     def server(self) -> ChiaServer:
         assert self.crawler.server is not None
         return self.crawler.server
 
-    @property
-    def log(self) -> logging.Logger:
-        return self.crawler.log
+    def ready(self) -> bool:
+        return True
 
     @api_request(peer_required=True)
     async def request_peers(

chia/seeder/start_crawler.py

@@ -29,7 +29,7 @@ def create_full_node_crawler_service(
     config: Dict,
     consensus_constants: ConsensusConstants,
     connect_to_daemon: bool = True,
-) -> Service[Crawler]:
+) -> Service[Crawler, CrawlerAPI]:
     service_config = config[SERVICE_NAME]
 
     crawler = Crawler(

chia/server/api_protocol.py

@@ -0,0 +1,12 @@
+from __future__ import annotations
+
+from logging import Logger
+
+from typing_extensions import Protocol
+
+
+class ApiProtocol(Protocol):
+    log: Logger
+
+    def ready(self) -> bool:
+        ...

chia/server/server.py

@@ -28,6 +28,7 @@
 from chia.protocols.protocol_state_machine import message_requires_reply
 from chia.protocols.protocol_timing import INVALID_PROTOCOL_BAN_SECONDS
 from chia.protocols.shared_protocol import protocol_version
+from chia.server.api_protocol import ApiProtocol
 from chia.server.introducer_peers import IntroducerPeers
 from chia.server.outbound_message import Message, NodeType
 from chia.server.ssl_context import private_ssl_paths, public_ssl_paths
@@ -122,7 +123,7 @@ class ChiaServer:
     _network_id: str
     _inbound_rate_limit_percent: int
     _outbound_rate_limit_percent: int
-    api: Any
+    api: ApiProtocol
     node: Any
     root_path: Path
     config: Dict[str, Any]
@@ -147,7 +148,7 @@ def create(
         cls,
         port: int,
         node: Any,
-        api: Any,
+        api: ApiProtocol,
         local_type: NodeType,
         ping_interval: int,
         network_id: str,

chia/server/start_data_layer.py

@@ -17,6 +17,7 @@
 from chia.util.default_root import DEFAULT_ROOT_PATH
 from chia.util.ints import uint16
 from chia.wallet.wallet_node import WalletNode
+from chia.wallet.wallet_node_api import WalletNodeAPI
 
 # See: https://bugs.python.org/issue29288
 "".encode("idna")
@@ -31,9 +32,9 @@ def create_data_layer_service(
     config: Dict[str, Any],
     downloaders: List[str],
     uploaders: List[str],  # dont add FilesystemUploader to this, it is the default uploader
-    wallet_service: Optional[Service[WalletNode]] = None,
+    wallet_service: Optional[Service[WalletNode, WalletNodeAPI]] = None,
     connect_to_daemon: bool = True,
-) -> Service[DataLayer]:
+) -> Service[DataLayer, DataLayerAPI]:
     if uploaders is None:
         uploaders = []
     if downloaders is None:

chia/server/start_farmer.py

@@ -30,7 +30,7 @@ def create_farmer_service(
     consensus_constants: ConsensusConstants,
     keychain: Optional[Keychain] = None,
     connect_to_daemon: bool = True,
-) -> Service[Farmer]:
+) -> Service[Farmer, FarmerAPI]:
     service_config = config[SERVICE_NAME]
 
     fnp = service_config.get("full_node_peer")

chia/server/start_full_node.py

@@ -33,7 +33,7 @@ def create_full_node_service(
     consensus_constants: ConsensusConstants,
     connect_to_daemon: bool = True,
     override_capabilities: Optional[List[Tuple[uint16, str]]] = None,
-) -> Service[FullNode]:
+) -> Service[FullNode, FullNodeAPI]:
     service_config = config[SERVICE_NAME]
 
     full_node = FullNode(

chia/server/start_harvester.py

@@ -28,7 +28,7 @@ def create_harvester_service(
     consensus_constants: ConsensusConstants,
     farmer_peer: Optional[UnresolvedPeerInfo],
     connect_to_daemon: bool = True,
-) -> Service[Harvester]:
+) -> Service[Harvester, HarvesterAPI]:
     service_config = config[SERVICE_NAME]
 
     overrides = service_config["network_overrides"]["constants"][service_config["selected_network"]]

chia/server/start_introducer.py

@@ -23,7 +23,7 @@ def create_introducer_service(
     config: Dict[str, Any],
     advertised_port: Optional[int] = None,
     connect_to_daemon: bool = True,
-) -> Service[Introducer]:
+) -> Service[Introducer, IntroducerAPI]:
     service_config = config[SERVICE_NAME]
 
     if advertised_port is None:

chia/server/start_service.py

@@ -14,6 +14,7 @@
 from chia.cmds.init_funcs import chia_full_version_str
 from chia.daemon.server import service_launch_lock_path
 from chia.rpc.rpc_server import RpcApiProtocol, RpcServer, RpcServiceProtocol, start_rpc_server
+from chia.server.api_protocol import ApiProtocol
 from chia.server.chia_policy import set_chia_policy
 from chia.server.outbound_message import NodeType
 from chia.server.server import ChiaServer
@@ -34,6 +35,7 @@
 
 T = TypeVar("T")
 _T_RpcServiceProtocol = TypeVar("_T_RpcServiceProtocol", bound=RpcServiceProtocol)
+_T_ApiProtocol = TypeVar("_T_ApiProtocol", bound=ApiProtocol)
 
 RpcInfo = Tuple[Type[RpcApiProtocol], int]
 
@@ -42,12 +44,12 @@ class ServiceException(Exception):
     pass
 
 
-class Service(Generic[_T_RpcServiceProtocol]):
+class Service(Generic[_T_RpcServiceProtocol, _T_ApiProtocol]):
     def __init__(
         self,
         root_path: Path,
         node: _T_RpcServiceProtocol,
-        peer_api: Any,
+        peer_api: _T_ApiProtocol,
         node_type: NodeType,
         advertised_port: int,
         service_name: str,

chia/server/start_timelord.py

@@ -31,7 +31,7 @@ def create_timelord_service(
     config: Dict[str, Any],
     constants: ConsensusConstants,
     connect_to_daemon: bool = True,
-) -> Service[Timelord]:
+) -> Service[Timelord, TimelordAPI]:
     service_config = config[SERVICE_NAME]
 
     connect_peers = {

chia/server/start_wallet.py

@@ -33,7 +33,7 @@ def create_wallet_service(
     consensus_constants: ConsensusConstants,
     keychain: Optional[Keychain] = None,
     connect_to_daemon: bool = True,
-) -> Service[WalletNode]:
+) -> Service[WalletNode, WalletNodeAPI]:
     service_config = config[SERVICE_NAME]
 
     overrides = service_config["network_overrides"]["constants"][service_config["selected_network"]]

chia/server/ws_connection.py

@@ -21,6 +21,7 @@
 from chia.protocols.protocol_state_machine import message_response_ok
 from chia.protocols.protocol_timing import API_EXCEPTION_BAN_SECONDS, INTERNAL_PROTOCOL_ERROR_BAN_SECONDS
 from chia.protocols.shared_protocol import Capability, Handshake
+from chia.server.api_protocol import ApiProtocol
 from chia.server.capabilities import known_active_capabilities
 from chia.server.outbound_message import Message, NodeType, make_msg
 from chia.server.rate_limits import RateLimiter
@@ -66,7 +67,7 @@ class WSChiaConnection:
     """
 
     ws: WebSocket = field(repr=False)
-    api: Any = field(repr=False)
+    api: ApiProtocol = field(repr=False)
     local_type: NodeType
     local_port: int
     local_capabilities_for_handshake: List[Tuple[uint16, str]] = field(repr=False)
@@ -123,7 +124,7 @@ def create(
         cls,
         local_type: NodeType,
         ws: WebSocket,
-        api: Any,
+        api: ApiProtocol,
         server_port: int,
         log: logging.Logger,
         is_outbound: bool,
@@ -373,9 +374,9 @@ async def _api_call(self, full_message: Message, task_id: bytes32) -> None:
                 raise ProtocolError(Err.INVALID_PROTOCOL_MESSAGE, [message_type])
 
             # If api is not ready ignore the request
-            if hasattr(self.api, "api_ready"):
-                if self.api.api_ready is False:
-                    return None
+            if not self.api.ready():
+                self.log.warning(f"API not ready, ignore request: {full_message}")
+                return None
 
             timeout: Optional[int] = 600
             if metadata.execute_task: