Remove chain info property from LESPeer (#1264)

Author: pipermerriam

p2p/peer.py

@@ -103,6 +103,7 @@
 
 if TYPE_CHECKING:
     from trinity.db.header import BaseAsyncHeaderDB  # noqa: F401
+    from trinity.protocol.common.proto import ChainInfo  # noqa: F401
     from trinity.protocol.eth.requests import HeaderRequest  # noqa: F401
     from trinity.protocol.base_request import BaseRequest  # noqa: F401
 
@@ -291,6 +292,7 @@ async def genesis(self) -> BlockHeader:
 
     @property
     async def _local_chain_info(self) -> 'ChainInfo':
+        from trinity.protocol.common.proto import ChainInfo  # noqa: F811
         genesis = await self.genesis
         head = await self.wait(self.headerdb.coro_get_canonical_head())
         total_difficulty = await self.headerdb.coro_get_score(head.hash)
@@ -1017,18 +1019,6 @@ async def __anext__(self) -> BasePeer:
 }
 
 
-class ChainInfo:
-    def __init__(self,
-                 block_number: int,
-                 block_hash: Hash32,
-                 total_difficulty: int,
-                 genesis_hash: Hash32) -> None:
-        self.block_number = block_number
-        self.block_hash = block_hash
-        self.total_difficulty = total_difficulty
-        self.genesis_hash = genesis_hash
-
-
 def _test() -> None:
     """
     Create a Peer instance connected to a local geth instance and log messages exchanged with it.

tests/trinity/integration/test_lightchain_integration.py

@@ -207,9 +207,8 @@ async def wait_for_header_sync(block_number):
         '0xf709ed2c57efc18a1675e8c740f3294c9e2cb36ba7bb3b89d3ab4c8fef9d8860')
 
     assert len(peer_pool) == 1
-    head_info = peer_pool.highest_td_peer.head_info
-    head = await peer_chain.get_block_header_by_hash(head_info.block_hash)
-    assert head.block_number == head_info.block_number
+    peer = peer_pool.highest_td_peer
+    head = await peer_chain.get_block_header_by_hash(peer.head_hash)
 
     # In order to answer queries for contract code, geth needs the state trie entry for the block
     # we specify in the query, but because of fast sync we can only assume it has that for recent

trinity/protocol/common/proto.py

@@ -0,0 +1,13 @@
+from typing import NamedTuple
+
+from eth_typing import (
+    BlockNumber,
+    Hash32,
+)
+
+
+class ChainInfo(NamedTuple):
+    block_number: BlockNumber
+    block_hash: Hash32
+    total_difficulty: int
+    genesis_hash: Hash32

trinity/protocol/eth/proto.py

@@ -2,7 +2,6 @@
 from typing import (
     List,
     Tuple,
-    TYPE_CHECKING,
     Union,
 )
 
@@ -19,6 +18,7 @@
     Protocol,
 )
 
+from trinity.protocol.common.proto import ChainInfo
 from trinity.rlp.block_body import BlockBody
 
 from .commands import (
@@ -36,11 +36,6 @@
     Transactions,
 )
 
-if TYPE_CHECKING:
-    from p2p.peer import (  # noqa: F401
-        ChainInfo
-    )
-
 
 class ETHProtocol(Protocol):
     name = 'eth'
@@ -52,13 +47,13 @@ class ETHProtocol(Protocol):
     cmd_length = 17
     logger = logging.getLogger("p2p.eth.ETHProtocol")
 
-    def send_handshake(self, head_info: 'ChainInfo') -> None:
+    def send_handshake(self, chain_info: ChainInfo) -> None:
         resp = {
             'protocol_version': self.version,
             'network_id': self.peer.network_id,
-            'td': head_info.total_difficulty,
-            'best_hash': head_info.block_hash,
-            'genesis_hash': head_info.genesis_hash,
+            'td': chain_info.total_difficulty,
+            'best_hash': chain_info.block_hash,
+            'genesis_hash': chain_info.genesis_hash,
         }
         cmd = Status(self.cmd_id_offset)
         self.logger.debug("Sending ETH/Status msg: %s", resp)

trinity/protocol/les/commands.py

@@ -111,15 +111,6 @@ def _serialize_item(self, key: str, value: bytes) -> bytes:
             # See comment in the definition of item_sedes as to why we do this.
             return b''
 
-    def as_head_info(self, decoded: _DecodedMsgType) -> HeadInfo:
-        decoded = cast(Dict[str, Any], decoded)
-        return HeadInfo(
-            block_number=decoded['headNum'],
-            block_hash=decoded['headHash'],
-            total_difficulty=decoded['headTd'],
-            reorg_depth=0,
-        )
-
 
 class Announce(Command):
     _cmd_id = 1
@@ -128,19 +119,10 @@ class Announce(Command):
         ('head_number', sedes.big_endian_int),
         ('head_td', sedes.big_endian_int),
         ('reorg_depth', sedes.big_endian_int),
+        # TODO: The params CountableList may contain any of the values from the
+        # Status msg.  Need to extend this command to process that too.
         ('params', sedes.CountableList(sedes.List([sedes.text, sedes.raw]))),
     ]
-    # TODO: The params CountableList above may contain any of the values from the Status msg.
-    # Need to extend this command to process that too.
-
-    def as_head_info(self, decoded: _DecodedMsgType) -> HeadInfo:
-        decoded = cast(Dict[str, Any], decoded)
-        return HeadInfo(
-            block_number=decoded['head_number'],
-            block_hash=decoded['head_hash'],
-            total_difficulty=decoded['head_td'],
-            reorg_depth=decoded['reorg_depth'],
-        )
 
 
 class GetBlockHeadersQuery(rlp.Serializable):

trinity/protocol/les/peer.py

@@ -3,6 +3,12 @@
     cast,
     Dict,
     List,
+    Union,
+)
+
+from eth_typing import (
+    BlockNumber,
+    Hash32,
 )
 
 from eth_utils import encode_hex
@@ -19,7 +25,6 @@
 
 from .commands import (
     Announce,
-    HeadInfo,
     Status,
     StatusV2,
 )
@@ -38,10 +43,9 @@ class LESPeer(BasePeer):
 
     _supported_sub_protocols = [LESProtocol, LESProtocolV2]
     sub_proto: LESProtocol = None
-    # TODO: This will no longer be needed once we've fixed #891, and then it should be removed.
-    head_info: HeadInfo = None
 
     _requests: LESExchangeHandler = None
+    head_number: BlockNumber = None
 
     def get_extra_stats(self) -> List[str]:
         stats_pairs = self.requests.get_stats().items()
@@ -54,10 +58,11 @@ def requests(self) -> LESExchangeHandler:
         return self._requests
 
     def handle_sub_proto_msg(self, cmd: Command, msg: _DecodedMsgType) -> None:
+        head_info = cast(Dict[str, Union[int, Hash32, BlockNumber]], msg)
         if isinstance(cmd, Announce):
-            self.head_info = cmd.as_head_info(msg)
-            self.head_td = self.head_info.total_difficulty
-            self.head_hash = self.head_info.block_hash
+            self.head_td = head_info['head_td']
+            self.head_hash = head_info['head_hash']
+            self.head_number = head_info['head_number']
 
         super().handle_sub_proto_msg(cmd, msg)
 
@@ -83,6 +88,6 @@ async def process_sub_proto_handshake(
                 "{} genesis ({}) does not match ours ({}), disconnecting".format(
                     self, encode_hex(msg['genesisHash']), genesis.hex_hash))
         # TODO: Disconnect if the remote doesn't serve headers.
-        self.head_info = cmd.as_head_info(msg)
-        self.head_td = self.head_info.total_difficulty
-        self.head_hash = self.head_info.block_hash
+        self.head_td = msg['headTd']
+        self.head_hash = msg['headHash']
+        self.head_number = msg['headNum']

trinity/protocol/les/proto.py

@@ -1,7 +1,6 @@
 from typing import (
     List,
     Tuple,
-    TYPE_CHECKING,
     Union,
 )
 
@@ -16,6 +15,8 @@
     Protocol,
 )
 
+from trinity.protocol.common.proto import ChainInfo
+
 from .commands import (
     Status,
     StatusV2,
@@ -38,11 +39,6 @@
 )
 from . import constants
 
-if TYPE_CHECKING:
-    from p2p.peer import (  # noqa: F401
-        ChainInfo
-    )
-
 
 class LESProtocol(Protocol):
     name = 'les'
@@ -51,7 +47,7 @@ class LESProtocol(Protocol):
                  ContractCodes]
     cmd_length = 15
 
-    def send_handshake(self, chain_info: 'ChainInfo') -> None:
+    def send_handshake(self, chain_info: ChainInfo) -> None:
         resp = {
             'protocolVersion': self.version,
             'networkId': self.peer.network_id,
@@ -148,7 +144,7 @@ class LESProtocolV2(LESProtocol):
                  ProofsV2, ContractCodes]
     cmd_length = 21
 
-    def send_handshake(self, chain_info: 'ChainInfo') -> None:
+    def send_handshake(self, chain_info: ChainInfo) -> None:
         resp = {
             'announceType': constants.LES_ANNOUNCE_SIMPLE,
             'protocolVersion': self.version,

trinity/sync/light/service.py

@@ -278,7 +278,7 @@ async def _raise_for_empty_code(
             # our best peer doesn't have the header we want, there are no eligible peers.
             raise NoEligiblePeers("Our best peer does not have the header %s" % block_hash)
 
-        head_number = peer.head_info.block_number
+        head_number = peer.head_number
         if head_number - header.block_number > MAX_REORG_DEPTH:
             # The peer claims to be far ahead of the header we requested
             if self.headerdb.get_canonical_block_hash(header.block_number) == block_hash: