minor cleanup throughout codebase

Author: karask

README.rst

@@ -3,7 +3,7 @@ python-bitcoin-utils
 
 This is a bitcoin library that provides tools/utilities to interact with the Bitcoin network. One of the primary goals of the library is to explain the low-level details of Bitcoin. The code is easy to read and properly documented explaining in detail all the thorny aspects of the implementation. It is a low-level library which assumes some high-level understanding of how Bitcoin works. In the future this might change.
 
-The library (v0.8.2) currently supports private/public keys, all type of addresses and creation of any transaction, incl. segwit and taproot, with all SIGHASH types. All script op codes are included. Block parsing is also handled so you can read raw blocks directly. PSBT (BIP-174) is supported. Extra functionality will be added continuously and the documentation will be improved as the work progresses.
+The library (v0.8.3) currently supports private/public keys, all type of addresses and creation of any transaction, incl. segwit and taproot, with all SIGHASH types. All script op codes are included. Block parsing is also handled so you can read raw blocks directly. PSBT (BIP-174) is supported. Extra functionality will be added continuously and the documentation will be improved as the work progresses.
 
 The API documentation can be build with Sphinx but is also available as a PDF for convenience. One can currently use the library for experimenting and learning the inner workings of Bitcoin. It is not meant for production yet and parts of the API might be updated with new versions.
 

bitcoinutils/__init__.py

@@ -1 +1 @@
-__version__ = "0.8.2"
+__version__ = "0.8.3"

bitcoinutils/block.py

@@ -9,8 +9,6 @@
 
 from bitcoinutils.constants import HEADER_SIZE, BLOCK_MAGIC_NUMBER
 
-import os
-
 
 class BlockHeader:
     """
@@ -56,6 +54,8 @@ class BlockHeader:
         Retrieves the nonce used for mining to achieve the block's proof of work.
     format_timestamp()
         Formats the timestamp into a human-readable UTC datetime string.
+    get_target_hex()
+        Decodes target bits into the full proof-of-work target.
     """
 
     def __init__(
@@ -200,7 +200,7 @@ def format_timestamp(self):
         utc_time = datetime.fromtimestamp(self.timestamp, timezone.utc)
         return utc_time.strftime("%Y-%m-%d %H:%M:%S UTC")
 
-    def get_target_bits(self):
+    def get_target_hex(self):
         """
         Decodes the compact representation of the target bits into the full target hash
         that a block's hash must be less than or equal to, in order to solve the block.
@@ -210,7 +210,11 @@ def get_target_bits(self):
                 the full 256-bit target hash used in the proof of work.
         """
 
-        # Extract the exponent (first byte) and coefficient (last three bytes) from the target_bits
+        if self.target_bits is None:
+            return None
+
+        # Extract the exponent (first byte) and coefficient (last three bytes)
+        # from the target_bits.
         exponent = self.target_bits >> 24
         coefficient = self.target_bits & 0xFFFFFF
 
@@ -358,6 +362,10 @@ def from_raw(rawhexdata: Union[str, bytes]):
             rawdata = rawhexdata
         else:
             raise TypeError("Input must be a hexadecimal string or bytes")
+
+        if len(rawdata) < 8 + HEADER_SIZE + 1:
+            raise ValueError("Block data is too short.")
+
         magic = rawdata[0:4]
         block_size = struct.unpack("<I", rawdata[4:8])[0]
         block_size = block_size
@@ -375,15 +383,12 @@ def from_raw(rawhexdata: Union[str, bytes]):
                         rawdata[current_offset : current_offset + tx_length].hex()
                     )
                 )
-                temp = Transaction.from_raw(
-                    rawdata[current_offset : current_offset + tx_length].hex()
-                )
                 current_offset += tx_length
 
             except Exception as e:
-                print(e)
-                print(i, transaction_count)
-                break
+                raise ValueError(
+                    f"Could not parse transaction {i + 1} of {transaction_count}"
+                ) from e
 
         return Block(magic, block_size, header, transaction_count, transactions)
 

bitcoinutils/keys.py

@@ -1404,11 +1404,3 @@ def is_odd(self) -> bool:
         False otherwise."""
 
         return self.odd
-
-
-def main():
-    pass
-
-
-if __name__ == "__main__":
-    main()

bitcoinutils/psbt.py

@@ -20,7 +20,14 @@
 import base64
 
 from bitcoinutils.constants import SIGHASH_ALL
-from bitcoinutils.script import Script
+from bitcoinutils.script import (
+    Script,
+    is_p2pkh as _is_p2pkh,
+    is_p2sh as _is_p2sh,
+    is_p2wpkh as _is_p2wpkh,
+    is_p2wsh as _is_p2wsh,
+    is_p2tr as _is_p2tr,
+)
 from bitcoinutils.transactions import (
     Transaction,
     TxInput,
@@ -93,64 +100,6 @@ def _validate_pubkey_length(pubkey: bytes, context: str) -> None:
         )
 
 
-# ---------------------------------------------------------------------------
-# Script type detection helpers
-# ---------------------------------------------------------------------------
-
-def _is_p2pkh(script: Script) -> bool:
-    """OP_DUP OP_HASH160 <20-byte-hash> OP_EQUALVERIFY OP_CHECKSIG"""
-    s = script.script
-    return (
-        len(s) == 5
-        and s[0] == "OP_DUP"
-        and s[1] == "OP_HASH160"
-        and isinstance(s[2], str) and len(s[2]) == 40
-        and s[3] == "OP_EQUALVERIFY"
-        and s[4] == "OP_CHECKSIG"
-    )
-
-
-def _is_p2sh(script: Script) -> bool:
-    """OP_HASH160 <20-byte-hash> OP_EQUAL"""
-    s = script.script
-    return (
-        len(s) == 3
-        and s[0] == "OP_HASH160"
-        and isinstance(s[1], str) and len(s[1]) == 40
-        and s[2] == "OP_EQUAL"
-    )
-
-
-def _is_p2wpkh(script: Script) -> bool:
-    """OP_0 <20-byte-hash>"""
-    s = script.script
-    return (
-        len(s) == 2
-        and s[0] == "OP_0"
-        and isinstance(s[1], str) and len(s[1]) == 40
-    )
-
-
-def _is_p2wsh(script: Script) -> bool:
-    """OP_0 <32-byte-hash>"""
-    s = script.script
-    return (
-        len(s) == 2
-        and s[0] == "OP_0"
-        and isinstance(s[1], str) and len(s[1]) == 64
-    )
-
-
-def _is_p2tr(script: Script) -> bool:
-    """OP_1 <32-byte-key>"""
-    s = script.script
-    return (
-        len(s) == 2
-        and s[0] == "OP_1"
-        and isinstance(s[1], str) and len(s[1]) == 64
-    )
-
-
 # Map OP_n strings to integer n
 _OP_N_MAP = {f"OP_{i}": i for i in range(1, 17)}
 

bitcoinutils/script.py

@@ -452,4 +452,68 @@ def __repr__(self) -> str:
     def __eq__(self, _other: object) -> bool:
         if not isinstance(_other, Script):
             return False
-        return self.script == _other.script
+        return self.script == _other.script
+
+
+def is_p2pkh(script: Script) -> bool:
+    """Returns True for a P2PKH scriptPubKey."""
+
+    s = script.script
+    return (
+        len(s) == 5
+        and s[0] == "OP_DUP"
+        and s[1] == "OP_HASH160"
+        and isinstance(s[2], str)
+        and len(s[2]) == 40
+        and s[3] == "OP_EQUALVERIFY"
+        and s[4] == "OP_CHECKSIG"
+    )
+
+
+def is_p2sh(script: Script) -> bool:
+    """Returns True for OP_HASH160 <20-byte-hash> OP_EQUAL."""
+
+    s = script.script
+    return (
+        len(s) == 3
+        and s[0] == "OP_HASH160"
+        and isinstance(s[1], str)
+        and len(s[1]) == 40
+        and s[2] == "OP_EQUAL"
+    )
+
+
+def is_p2wpkh(script: Script) -> bool:
+    """Returns True for OP_0 <20-byte-hash>."""
+
+    s = script.script
+    return (
+        len(s) == 2
+        and s[0] == "OP_0"
+        and isinstance(s[1], str)
+        and len(s[1]) == 40
+    )
+
+
+def is_p2wsh(script: Script) -> bool:
+    """Returns True for OP_0 <32-byte-hash>."""
+
+    s = script.script
+    return (
+        len(s) == 2
+        and s[0] == "OP_0"
+        and isinstance(s[1], str)
+        and len(s[1]) == 64
+    )
+
+
+def is_p2tr(script: Script) -> bool:
+    """Returns True for OP_1 <32-byte-key>."""
+
+    s = script.script
+    return (
+        len(s) == 2
+        and s[0] == "OP_1"
+        and isinstance(s[1], str)
+        and len(s[1]) == 64
+    )

bitcoinutils/setup.py

@@ -16,6 +16,11 @@
 
 def setup(network: str = "testnet") -> str:
     global NETWORK
+    if network not in networks:
+        supported = ", ".join(sorted(networks))
+        raise ValueError(
+            f"Unknown network '{network}'. Supported networks: {supported}"
+        )
     NETWORK = network
     return NETWORK
 
@@ -26,40 +31,20 @@ def get_network() -> str:
 
 
 def is_mainnet() -> bool:
-    global NETWORK
-    if NETWORK == "mainnet":
-        return True
-    else:
-        return False
+    return NETWORK == "mainnet"
 
 
 def is_testnet() -> bool:
-    global NETWORK
-    if NETWORK == "testnet":
-        return True
-    else:
-        return False
+    return NETWORK == "testnet"
 
 
 def is_testnet4() -> bool:
-    global NETWORK
-    if NETWORK == "testnet4":
-        return True
-    else:
-        return False
+    return NETWORK == "testnet4"
 
 
 def is_signet() -> bool:
-    global NETWORK
-    if NETWORK == "signet":
-        return True
-    else:
-        return False
+    return NETWORK == "signet"
 
 
 def is_regtest() -> bool:
-    global NETWORK
-    if NETWORK == "regtest":
-        return True
-    else:
-        return False
+    return NETWORK == "regtest"