to_entropy, more doctests, light refactor / cleanup, pyproject, remove openssl

Author: jtraub91

README.md

@@ -1,14 +1,6 @@
 # `bits10001010010101101`
 
-`bits` is a cli tool and pure Python library enabling easy and convenient use for all things Bitcoin
-
-## Highlights
-
-- Generate private key and calculate corresponding public key
-- Calculate standard address types (P2PKH, P2SH, Multisig, Segwit)
-- Create and sign transactions
-- Calculate mnemonic phrase and derive extended keys from seed (per BIP32, BIP39, BIP43, BIP44)
-- RPC interface with local `bitcoind` node
+`bits` is a cli tool and pure Python library for Bitcoin
 
 ## Dependencies
 
@@ -19,14 +11,3 @@
 ```bash
 pip install bits
 ```
-
-v0.1.0 - MVP
-
-v0.2.0
-
-- `sweep` cli command i.e. send all (or fraction) associated with from_addr to  to_addr (optional change_addr)
-
-v1.0.0
-
-- full node
-- `scan` cli command

bits/__init__.py

@@ -60,10 +60,6 @@ def load_config():
     bitsconfig_file.close()
 
 
-bitsconfig = {}
-load_config()
-
-
 def read_bytes(file_: Optional[IO] = None, input_format: str = "raw") -> bytes:
     """
     Read from optional file or stdin and convert to bytes
@@ -98,3 +94,7 @@ def print_bytes(data: bytes, output_format: str = "raw"):
         print(format(int.from_bytes(data, "big"), format_spec))
     else:
         raise ValueError(f"unrecognized output format: {output_format}")
+
+
+bitsconfig = {}
+load_config()

bits/bips/bip39/__init__.py

@@ -1,3 +1,6 @@
+"""
+https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki
+"""
 import hashlib
 import secrets
 import unicodedata
@@ -10,7 +13,11 @@ def load_wordlist():
     return words
 
 
-def calculate_mnemonic_phrase(entropy: bytes):
+def calculate_mnemonic_phrase(entropy: bytes) -> str:
+    """
+    >>> calculate_mnemonic_phrase(bytes.fromhex("6610b25967cdcca9d59875f5cb50b0ea75433311869e930b"))
+    'gravity machine north sort system female filter attitude volume fold club stay feature office ecology stable narrow fog'
+    """
     strength = len(entropy) * 8
     if strength not in [128, 160, 192, 224, 256]:
         raise ValueError(
@@ -33,7 +40,43 @@ def calculate_mnemonic_phrase(entropy: bytes):
     return " ".join([words[bit_group] for bit_group in reversed(bit_groups)])
 
 
-def to_seed(mnemonic, passphrase: str = "") -> bytes:
+def to_entropy(mnemonic: str) -> bytes:
+    """
+    Inverse of calculate_mnemonic_phrase(entropy)
+    Get original entropy from mnemonic
+    Args:
+        mnemonic: str, mnemonic phrase
+
+    >>> to_entropy("gravity machine north sort system female filter attitude volume fold club stay feature office ecology stable narrow fog").hex()
+    '6610b25967cdcca9d59875f5cb50b0ea75433311869e930b'
+    """
+    words = mnemonic.split()
+    if len(words) not in [12, 15, 18, 21, 24]:
+        raise ValueError("word length does not indicate a valid entropy bit length")
+    entropy_w_checksum_bitlen = len(words) * 11
+    entropy_w_checksum_len = (entropy_w_checksum_bitlen + 7) // 8
+    checksum_bitlen = len(words) // 3
+    entropy_bitlen = entropy_w_checksum_bitlen - checksum_bitlen
+    entropy_len = (entropy_bitlen + 7) // 8
+
+    wordlist = load_wordlist()
+
+    data = 0
+    for idx, word in enumerate(reversed(words)):
+        bit_group = wordlist.index(word)
+        data |= bit_group << (idx * 11)
+
+    checksum = (
+        data.to_bytes(entropy_w_checksum_len, "big")[-1] & 2**checksum_bitlen - 1
+    )
+    entropy = data >> checksum_bitlen
+    entropy = entropy.to_bytes(entropy_len, "big")
+    checksum_check = hashlib.sha256(entropy).digest()[0] >> (8 - checksum_bitlen)
+    assert checksum_check == checksum, "checksum validation error"
+    return entropy
+
+
+def to_seed(mnemonic: str, passphrase: str = "") -> bytes:
     """
     Defined in BIP39
     https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki#from-mnemonic-to-seed
@@ -45,7 +88,3 @@ def to_seed(mnemonic, passphrase: str = "") -> bytes:
         unicodedata.normalize("NFKD", "mnemonic" + passphrase).encode("utf-8"),
         ITERATIONS,
     )
-
-
-def to_entropy():
-    raise NotImplementedError

bits/blockchain.py

@@ -8,9 +8,11 @@
 from bits.script.utils import p2pk_script_pubkey
 from bits.tx import coinbase_txin
 from bits.tx import tx
+from bits.tx import tx_deser
 from bits.tx import txout
 from bits.utils import compact_size_uint
 from bits.utils import d_hash
+from bits.utils import parse_compact_size_uint
 
 
 COIN = 100000000  # satoshis / bitcoin
@@ -121,24 +123,41 @@ def genesis_coinbase_tx():
 
 
 def genesis_block():
+    """
+    Hard coded genesis block - mainnet
+    >>> gb = genesis_block()
+    >>> header = gb[:80]
+    >>> import hashlib
+    >>> hashlib.sha256(hashlib.sha256(header).digest()).digest()[::-1].hex()
+    '000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f'
+    """
+
     # https://github.com/bitcoin/bitcoin/blob/v0.1.5/main.cpp#L1495-L1498
     version: int = 1
     nTime = 1231006505
-    nBits = b"\x1D\x00\xFF\xFF"
+    nBits = 0x1D00FFFF
     nNonce = 2083236893
 
     coinbase_tx = genesis_coinbase_tx()
     merkle_ = merkle_root([coinbase_tx])
-
     return block_ser(
-        block_header(1, NULL_32, merkle_, nTime, nBits, nNonce), [coinbase_tx]
+        block_header(1, NULL_32, merkle_, nTime, nBits.to_bytes(4, "little"), nNonce),
+        [coinbase_tx],
     )
 
 
 def block_ser(blk_hdr: bytes, txns: List[bytes]) -> bytes:
     return blk_hdr + compact_size_uint(len(txns)) + b"".join(txns)
 
 
-def block_deser(block: bytes) -> Tuple[bytes, List[bytes]]:
-    # return block_header_, txns
-    raise NotImplementedError
+def block_deser(block: bytes) -> Tuple[bytes, List[dict]]:
+    header = block[:80]
+    number_of_txns, block_prime = parse_compact_size_uint(block[80:])
+    txns = []
+    while block_prime:
+        deserialized_tx, block_prime = tx_deser(block_prime)
+        txns.append(deserialized_tx)
+    assert (
+        len(txns) == number_of_txns
+    ), "error during parsing - number of txns does not match"
+    return header, txns

bits/db.py

@@ -10,7 +10,7 @@
 import bits.keys
 import bits.rpc
 from bits.script.utils import null_data_script_pubkey
-from bits.script.utils import p2pkh_script_pubkey
+from bits.script.utils import scriptpubkey
 from bits.utils import d_hash
 from bits.utils import pubkey_hash
 from bits.utils import to_bitcoin_address
@@ -77,7 +77,7 @@ def mine_block(recv_addr: Optional[bytes] = b"", network: str = "regtest"):
     """
     Retrieve all raw mempool transactions and submit in a block
     Args:
-        recv_addr: Optional[bytes], p2pkh addr to receive block reward
+        recv_addr: Optional[bytes], addr to receive block reward
     """
     current_block_height = bits.rpc.rpc_method("getblockcount")
     current_block_hash = bits.rpc.rpc_method("getblockhash", current_block_height)
@@ -98,8 +98,7 @@ def mine_block(recv_addr: Optional[bytes] = b"", network: str = "regtest"):
     ]
 
     if recv_addr:
-        pk_hash = bits.base58.base58check_decode(recv_addr)[1:]
-        script_pubkey = p2pkh_script_pubkey(pk_hash)
+        script_pubkey = scriptpubkey(recv_addr)
     else:
         script_pubkey = null_data_script_pubkey(recv_addr)
 

bits/integrations.py

@@ -19,16 +19,25 @@
 
 def scriptpubkey(data: bytes) -> bytes:
     """
-    Create scriptpubkey by inferring input data addr type.
+    Create scriptpubkey by inferring input data type.
     Returns identity if data not identified as pubkey, base58check, nor segwit
 
-    >>> scriptpubkey(bytes.fromhex("02726b45a5b1b506015dc926630b2627454d635d87eeb72bb7d5476d545d6769f9"))  # p2pk
-
-    >>> scriptpubkey(b"1GhhwzPms6aKhzK5EcSYdeJ8T35BvAsn7y")  # p2pkh
-
-    >>> scriptpubkey(b"3djjfdfkj)  # p2sh
-
-    >>> scriptpubkey(b"bc1q4s7tflrwuenru6tuwsa26rvflk8tfs2lk5gysg")    # p2wpkh
+    >>> # p2pk
+    >>> scriptpubkey(bytes.fromhex("025a058ec9fb35845ce07b6ec4929b443132b2fce2bb154e3aa66c19b851b0c449")).hex()
+    '21025a058ec9fb35845ce07b6ec4929b443132b2fce2bb154e3aa66c19b851b0c449ac'
+    >>> # p2pkh
+    >>> scriptpubkey(b"1A4wionHnAtthCbCb9CTmDJaKuEPNXZp8R").hex()
+    '76a91463780efe21b54d462d399b4c5b9902235aa570ec88ac'
+    >>> # p2sh
+    >>> scriptpubkey(b"3PSFZTX6WxhFTmPBLnCh6gwxomb4vvxSpP").hex()
+    'a914ee87e9344a5ef0f83a0aa250256a3cc394ab750387'
+    >>> # p2wpkh
+    >>> scriptpubkey(b"bc1qvduqal3pk4x5vtfendx9hxgzydd22u8v0pzd7h").hex()
+    '001463780efe21b54d462d399b4c5b9902235aa570ec'
+    >>> # TODO: p2wsh
+    >>> # raw
+    >>> scriptpubkey(bytes.fromhex("5221024c9b21035e4823d6f09d5a948201d14086d854dfa5bba828c06f5131d9cfe14f2103fe0b5ca0ab60705b21a00cbd9900026f282c7188427123e87e0dc344ce742eb02102528e776c2bf0be68f4503151fd036c9cb720c4977f6f5b0248d5472c654aebe453ae")).hex()
+    '5221024c9b21035e4823d6f09d5a948201d14086d854dfa5bba828c06f5131d9cfe14f2103fe0b5ca0ab60705b21a00cbd9900026f282c7188427123e87e0dc344ce742eb02102528e776c2bf0be68f4503151fd036c9cb720c4977f6f5b0248d5472c654aebe453ae'
     """
     # data is either pubkey, base58check, or segwit
     if is_point(data):
@@ -227,7 +236,9 @@ def script(args: list[str]) -> bytes:
     Generic script
     Args:
         args: list, script ops / data
-    >>> script(["OP_2", "03ffe6319b68b781d654e32b7b068e946eef2b0f094ba9eeb84308c6c58af71208", "03377714f72611b81ee5dfbe6f52bfe0e9b1f6827ca00b6ab90d899720b1df00fd", "02726b45a5b1b506015dc926630b2627454d635d87eeb72bb7d5476d545d6769f9", "OP_3"])
+
+    >>> script(["OP_2", "024c9b21035e4823d6f09d5a948201d14086d854dfa5bba828c06f5131d9cfe14f", "03fe0b5ca0ab60705b21a00cbd9900026f282c7188427123e87e0dc344ce742eb0", "02528e776c2bf0be68f4503151fd036c9cb720c4977f6f5b0248d5472c654aebe4", "OP_3", "OP_CHECKMULTISIG"]).hex()
+    '5221024c9b21035e4823d6f09d5a948201d14086d854dfa5bba828c06f5131d9cfe14f2103fe0b5ca0ab60705b21a00cbd9900026f282c7188427123e87e0dc344ce742eb02102528e776c2bf0be68f4503151fd036c9cb720c4977f6f5b0248d5472c654aebe453ae'
     """
     scriptbytes = b""
     for arg in args:

bits/openssl.py

@@ -11,7 +11,6 @@
 from typing import Tuple
 
 import bits.keys
-import bits.openssl
 import bits.script.constants
 import bits.utils
 from bits.base58 import base58check_decode
@@ -166,7 +165,7 @@ def coinbase_txin(
             (now required per BIP34)
 
     """
-    if block_height:
+    if block_height is not None:
         # "minimally encoded serialized CScript"
         if block_height <= 16:
             op = getattr(bits.script.constants, f"OP_{block_height}")