GlcoinCore/squeaknode
1
0
Fork 0
mirror of https://github.com/yzernik/squeaknode.git synced 2026-08-18 13:09:08 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add docstrings for bitcoin client class (#1534)

Browse source
This commit is contained in:
Jonathan Zernik 2021-10-07 20:06:31 -07:00 • committed by GitHub
parent 315a84f846
commit 545d45299a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

22
squeaknode/bitcoin/bitcoin_client.py
View file

@ -32,16 +32,22 @@ class BitcoinClient(ABC):
@abstractmethod
def get_best_block_info(self) -> BlockInfo:
pass
"""Get block info for the latest Bitcoin block.
Returns:
BlockInfo: an object containing height, hash, and header.
Raises:
BitcoinRequestError: If the request fails.
"""
@abstractmethod
def get_block_info_by_height(self, block_height: int) -> BlockInfo:
pass
"""Get block info for the Bitcoin block at the given height.
@abstractmethod
def get_block_hash(self, block_height: int) -> bytes:
pass
Returns:
BlockInfo: an object containing height, hash, and header.
@abstractmethod
def get_block_header(self, block_hash: bytes, verbose: bool) -> bytes:
pass
Raises:
BitcoinRequestError: If the request fails.
"""