BlockHeightMapProtocol (#19798)

Author: richardkiss

benchmarks/block_ref.py

@@ -13,10 +13,10 @@
 from chia_rs.sized_bytes import bytes32
 from chia_rs.sized_ints import uint32
 
+from chia.consensus.block_height_map import BlockHeightMap
 from chia.consensus.blockchain import Blockchain
 from chia.consensus.default_constants import DEFAULT_CONSTANTS
 from chia.consensus.get_block_generator import get_block_generator
-from chia.full_node.block_height_map import BlockHeightMap
 from chia.full_node.block_store import BlockStore
 from chia.full_node.coin_store import CoinStore
 from chia.types.blockchain_format.serialized_program import SerializedProgram

chia/_tests/core/full_node/ram_db.py

@@ -7,8 +7,8 @@
 
 from chia_rs import ConsensusConstants
 
+from chia.consensus.block_height_map import BlockHeightMap
 from chia.consensus.blockchain import Blockchain
-from chia.full_node.block_height_map import BlockHeightMap
 from chia.full_node.block_store import BlockStore
 from chia.full_node.coin_store import CoinStore
 from chia.util.db_wrapper import DBWrapper2

chia/_tests/core/full_node/stores/test_block_store.py

@@ -18,10 +18,10 @@
 from chia._tests.blockchain.blockchain_test_utils import _validate_and_add_block
 from chia._tests.util.db_connection import DBConnection, PathDBConnection
 from chia.consensus.block_body_validation import ForkInfo
+from chia.consensus.block_height_map import BlockHeightMap
 from chia.consensus.blockchain import AddBlockResult, Blockchain
 from chia.consensus.default_constants import DEFAULT_CONSTANTS
 from chia.consensus.full_block_to_block_record import header_block_to_sub_block_record
-from chia.full_node.block_height_map import BlockHeightMap
 from chia.full_node.block_store import BlockStore
 from chia.full_node.coin_store import CoinStore
 from chia.full_node.full_block_utils import GeneratorBlockInfo

chia/_tests/core/full_node/stores/test_coin_store.py

@@ -16,10 +16,10 @@
 from chia._tests.util.db_connection import DBConnection
 from chia._tests.util.misc import Marks, datacases
 from chia.consensus.block_body_validation import ForkInfo
+from chia.consensus.block_height_map import BlockHeightMap
 from chia.consensus.block_rewards import calculate_base_farmer_reward, calculate_pool_reward
 from chia.consensus.blockchain import AddBlockResult, Blockchain
 from chia.consensus.coinbase import create_farmer_coin, create_pool_coin
-from chia.full_node.block_height_map import BlockHeightMap
 from chia.full_node.block_store import BlockStore
 from chia.full_node.coin_store import CoinStore
 from chia.full_node.hint_store import HintStore

chia/_tests/core/full_node/test_block_height_map.py

@@ -11,7 +11,7 @@
 from chia_rs.sized_ints import uint8, uint32
 
 from chia._tests.util.db_connection import DBConnection
-from chia.full_node.block_height_map import BlockHeightMap, SesCache
+from chia.consensus.block_height_map import BlockHeightMap, SesCache
 from chia.util.db_wrapper import DBWrapper2
 from chia.util.files import write_file_async
 

chia/_tests/core/test_db_conversion.py

@@ -10,9 +10,9 @@
 from chia._tests.util.temp_file import TempFile
 from chia.cmds.db_upgrade_func import convert_v1_to_v2
 from chia.consensus.block_body_validation import ForkInfo
+from chia.consensus.block_height_map import BlockHeightMap
 from chia.consensus.blockchain import Blockchain
 from chia.consensus.multiprocess_validation import PreValidationResult
-from chia.full_node.block_height_map import BlockHeightMap
 from chia.full_node.block_store import BlockStore
 from chia.full_node.coin_store import CoinStore
 from chia.full_node.hint_store import HintStore

chia/_tests/core/test_db_validation.py

@@ -14,10 +14,10 @@
 from chia._tests.util.temp_file import TempFile
 from chia.cmds.db_validate_func import validate_v2
 from chia.consensus.block_body_validation import ForkInfo
+from chia.consensus.block_height_map import BlockHeightMap
 from chia.consensus.blockchain import Blockchain
 from chia.consensus.default_constants import DEFAULT_CONSTANTS
 from chia.consensus.multiprocess_validation import PreValidationResult
-from chia.full_node.block_height_map import BlockHeightMap
 from chia.full_node.block_store import BlockStore
 from chia.full_node.coin_store import CoinStore
 from chia.simulator.block_tools import test_constants

chia/_tests/util/blockchain.py

@@ -10,8 +10,8 @@
 from chia_rs import ConsensusConstants, FullBlock
 from chia_rs.sized_ints import uint64
 
+from chia.consensus.block_height_map import BlockHeightMap
 from chia.consensus.blockchain import Blockchain
-from chia.full_node.block_height_map import BlockHeightMap
 from chia.full_node.block_store import BlockStore
 from chia.full_node.coin_store import CoinStore
 from chia.simulator.block_tools import BlockTools

chia/full_node/block_height_map.py chia/consensus/block_height_map.pychia/full_node/block_height_map.py renamed to chia/consensus/block_height_map.py

@@ -10,6 +10,7 @@
 from chia_rs.sized_bytes import bytes32
 from chia_rs.sized_ints import uint32
 
+from chia.consensus.block_height_map_protocol import BlockHeightMapProtocol
 from chia.util.db_wrapper import DBWrapper2
 from chia.util.files import write_file_async
 from chia.util.streamable import Streamable, streamable
@@ -23,7 +24,7 @@ class SesCache(Streamable):
     content: list[tuple[uint32, bytes]]
 
 
-class BlockHeightMap:
+class BlockHeightMap(BlockHeightMapProtocol):
     db: DBWrapper2
 
     # the below dictionaries are loaded from the database, from the peak

chia/consensus/block_height_map_protocol.py

@@ -0,0 +1,21 @@
+from __future__ import annotations
+
+from typing import Optional, Protocol
+
+from chia_rs import SubEpochSummary
+from chia_rs.sized_bytes import bytes32
+from chia_rs.sized_ints import uint32
+
+
+class BlockHeightMapProtocol(Protocol):
+    def update_height(self, height: uint32, header_hash: bytes32, ses: Optional[SubEpochSummary]) -> None: ...
+
+    def get_hash(self, height: uint32) -> bytes32: ...
+
+    def contains_height(self, height: uint32) -> bool: ...
+
+    def rollback(self, fork_height: int) -> None: ...
+
+    def get_ses(self, height: uint32) -> SubEpochSummary: ...
+
+    def get_ses_heights(self) -> list[uint32]: ...