BlockStoreProtocol

Author: richardkiss

chia/consensus/block_store_protocol.py

@@ -0,0 +1,72 @@
+from __future__ import annotations
+
+from typing import Optional, Protocol
+
+from chia_rs import BlockRecord, FullBlock, SubEpochChallengeSegment
+from chia_rs.sized_bytes import bytes32
+from chia_rs.sized_ints import uint32
+
+from chia.full_node.full_block_utils import GeneratorBlockInfo
+
+
+class BlockStoreProtocol(Protocol):
+    async def add_full_block(self, header_hash: bytes32, block: FullBlock, block_record: BlockRecord) -> None: ...
+
+    async def get_full_block(self, header_hash: bytes32) -> Optional[FullBlock]: ...
+
+    async def get_full_block_bytes(self, header_hash: bytes32) -> Optional[bytes]: ...
+
+    async def get_full_blocks_at(self, heights: list[uint32]) -> list[FullBlock]: ...
+
+    async def get_block_info(self, header_hash: bytes32) -> Optional[GeneratorBlockInfo]: ...
+
+    async def get_generator(self, header_hash: bytes32) -> Optional[bytes]: ...
+
+    async def get_generators_at(self, heights: set[uint32]) -> dict[uint32, bytes]: ...
+
+    async def get_block_record(self, header_hash: bytes32) -> Optional[BlockRecord]: ...
+
+    async def get_block_records_in_range(
+        self,
+        start: int,
+        stop: int,
+    ) -> dict[bytes32, BlockRecord]: ...
+
+    async def get_block_records_by_hash(self, header_hashes: list[bytes32]) -> list[BlockRecord]: ...
+
+    async def get_block_bytes_by_hash(self, header_hashes: list[bytes32]) -> list[bytes]: ...
+
+    async def get_blocks_by_hash(self, header_hashes: list[bytes32]) -> list[FullBlock]: ...
+
+    async def get_peak(self) -> Optional[tuple[bytes32, uint32]]: ...
+
+    async def get_block_bytes_in_range(
+        self,
+        start: int,
+        stop: int,
+    ) -> list[bytes]: ...
+
+    async def get_random_not_compactified(self, number: int) -> list[int]: ...
+
+    async def persist_sub_epoch_challenge_segments(
+        self, ses_block_hash: bytes32, segments: list[SubEpochChallengeSegment]
+    ) -> None: ...
+
+    async def get_sub_epoch_challenge_segments(
+        self,
+        ses_block_hash: bytes32,
+    ) -> Optional[list[SubEpochChallengeSegment]]: ...
+
+    async def rollback(self, height: int) -> None: ...
+
+    async def set_in_chain(self, header_hashes: list[tuple[bytes32]]) -> None: ...
+
+    async def set_peak(self, header_hash: bytes32) -> None: ...
+
+    async def is_fully_compactified(self, header_hash: bytes32) -> Optional[bool]: ...
+
+    async def replace_proof(self, header_hash: bytes32, block: FullBlock) -> None: ...
+
+    async def count_compactified_blocks(self) -> int: ...
+
+    async def count_uncompactified_blocks(self) -> int: ...

chia/full_node/block_store.py

@@ -11,6 +11,7 @@
 from chia_rs.sized_bytes import bytes32
 from chia_rs.sized_ints import uint32
 
+from chia.consensus.block_store_protocol import BlockStoreProtocol
 from chia.full_node.full_block_utils import GeneratorBlockInfo, block_info_from_block, generator_from_block
 from chia.util.db_wrapper import DBWrapper2, execute_fetchone
 from chia.util.errors import Err

chia/full_node/full_node.py

@@ -40,6 +40,7 @@
 from chia.consensus.block_body_validation import ForkInfo
 from chia.consensus.block_creation import unfinished_block_to_full_block
 from chia.consensus.block_height_map import BlockHeightMap
+from chia.consensus.block_store_protocol import BlockStoreProtocol
 from chia.consensus.blockchain import AddBlockResult, Blockchain, BlockchainMutexPriority, StateChangeSummary
 from chia.consensus.blockchain_interface import BlockchainInterface
 from chia.consensus.coin_store_protocol import CoinStoreProtocol
@@ -399,7 +400,7 @@ async def manage(self) -> AsyncIterator[None]:
                 await asyncio.gather(*self._segment_task_list, return_exceptions=True)
 
     @property
-    def block_store(self) -> BlockStore:
+    def block_store(self) -> BlockStoreProtocol:
         assert self._block_store is not None
         return self._block_store