Solve unittest problems and merge conflicts

.github/workflows/unittests-noscrypt.yaml

@@ -15,13 +15,8 @@ jobs:
           architecture: 'x64'
       - name: Install dependencies
         run: |
-          pip install coveralls
-          pip install psycopg2
-          pip install mysql-connector
-          pip install mysqlclient
-          pip install parameterized
-          pip install Cython
-          python setup.py install
+          python -m pip install .[dev]
+          pip uninstall -y scrypt
       - name: Test with coverage
         env:
           BCL_CONFIG_FILE: config_encryption.ini.unittest

.github/workflows/unittests.yaml

@@ -18,14 +18,7 @@ jobs:
         architecture: 'x64'
     - name: Install dependencies
       run: |
-        pip install coveralls
-        pip install psycopg2
-        pip install mysql-connector
-        pip install mysqlclient
-        pip install parameterized
-        pip install scrypt
-        pip install Cython
-        python setup.py install
+        python -m pip install .[dev]
     - name: Test with coverage
       env:
         BCL_CONFIG_FILE: config.ini.unittest

.github/workflows/unittests_windows.yaml

@@ -11,20 +11,14 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v3
         with:
-          python-version: '3.9'
+          python-version: '3.11'
           architecture: 'x64'
       - name: Install dependencies
         run: |
-          pip install win-unicode-console
-          pip install coveralls
-          pip install psycopg2
-          pip install mysql-connector
-          pip install mysqlclient
-          pip install parameterized
-          pip install scrypt
-          python setup.py install
+          python -m pip install .[dev]
       - name: Test with coverage
         env:
           BCL_CONFIG_FILE: config.ini.unittest
           UNITTESTS_FULL_DATABASE_TEST: False
+          PYTHONUTF8: 1
         run: coverage run --source=bitcoinlib -m unittest -v

.readthedocs.yml

@@ -9,11 +9,11 @@ version: 2
 formats: all
 
 build:
-    image: latest
+    os: ubuntu-22.04
+    tools:
+        python: "3.11"
 
 # Optionally set the version of Python and requirements required to build your docs
 python:
-    version: 3.7
     install:
     - requirements: docs/requirements.txt
-#    - requirements: requirements.txt

CHANGELOG

@@ -1,3 +1,17 @@
+RELEASE 0.6.14 - Update installation instruction, docker & bugfixes
+===================================================================
+* Update installation instructions
+* Add Docker files for testing and installation testing
+* Fix Bitcoind constructors
+* Fix issue with hexadecimal passwords for Mnemonics
+* Fix regtest address prefix
+
+RELEASE 0.6.13 - Update config & fix some bugs
+==============================================
+* Rewrite configuration files for easier installation
+* Fix issues with bitcoind and litecoind client
+* Fix encoding issues with Python3.11 and Windows
+
 RELEASE 0.6.12 - Prepare for Taproot
 ====================================
 * Parse p2tr input scripts

README.rst

@@ -44,6 +44,7 @@ Then install using pip
 
 For more detailed installation instructions, how to install on other systems or troubleshooting please read https://bitcoinlib.readthedocs.io/en/latest/source/_static/manuals.install.html
 
+If you are using docker you can check some Dockerfiles to create images in the docker directory.
 
 Documentation
 -------------

bitcoinlib/config/VERSION

@@ -1 +1 @@
-0.6.12
+0.6.14

bitcoinlib/config/config.py

@@ -120,11 +120,11 @@
     1000000000000000000000000: 'Y',
 }
 
-if os.name == 'nt' and locale.getpreferredencoding() != 'UTF-8':
-    # TODO: Find a better windows hack
+if os.name == 'nt' and locale.getpreferredencoding().lower() != 'utf-8':
     import _locale
-    _locale._getdefaultlocale = (lambda *args: ['en_US', 'utf8'])
-elif locale.getpreferredencoding() != 'UTF-8':
+    _locale._gdl_bak = _locale._getdefaultlocale
+    _locale._getdefaultlocale = (lambda *args: (_locale._gdl_bak()[0], 'utf8'))
+elif locale.getpreferredencoding().lower() != 'utf-8':
     raise EnvironmentError("Locale is currently set to '%s'. "
                            "This library needs the locale set to UTF-8 to function properly" %
                            locale.getpreferredencoding())

bitcoinlib/data/networks.json

@@ -107,7 +107,7 @@
     "currency_code": "rBTC",
     "prefix_address": "00",
     "prefix_address_p2sh": "05",
-    "prefix_bech32": "bc",
+    "prefix_bech32": "bcrt",
     "prefix_wif": "80",
     "prefixes_wif": [
       ["0488B21E", "xpub", "public",  false, "legacy",      "p2pkh"],

bitcoinlib/data/providers.json

@@ -405,27 +405,5 @@
     "priority": 10,
     "denominator": 1,
     "network_overrides": null
-  },
-    "blocksmurfer": {
-    "provider": "blocksmurfer",
-    "network": "bitcoin",
-    "client_class": "BlocksmurferClient",
-    "provider_coin_id": "",
-    "url": "https://harari.blocksmurfer.io/api/v1/btc/",
-    "api_key": "",
-    "priority": 10,
-    "denominator": 100000000,
-    "network_overrides": null
-  },
-  "blocksmurfer.testnet": {
-    "provider": "blocksmurfer",
-    "network": "testnet",
-    "client_class": "BlocksmurferClient",
-    "provider_coin_id": "",
-    "url": "https://harari.blocksmurfer.io/api/v1/tbtc/",
-    "api_key": "",
-    "priority": 10,
-    "denominator": 100000000,
-    "network_overrides": null
   }
 }

bitcoinlib/encoding.py

@@ -33,7 +33,7 @@
 try:
     from Crypto.Hash import RIPEMD160
 except ImportError as err:
-    _logger.warning("Could not import RIPEMD160 from cryptodome, will try do use hashlib but this could lead to errors")
+    _logger.warning("Could not import RIPEMD160 from cryptodome, will try to use hashlib but this could lead to errors")
 
 try:
     from Crypto.Cipher import AES
@@ -962,12 +962,20 @@ def bip38_decrypt(encrypted_privkey, password):
 
     :return tupple (bytes, bytes): (Private Key bytes, 4 byte address hash for verification)
     """
-    d = change_base(encrypted_privkey, 58, 256)[2:]
-    flagbyte = d[0:1]
-    d = d[1:]
+    d = change_base(encrypted_privkey, 58, 256)
+    identifier = d[0:2]
+    flagbyte = d[2:3]
+    d = d[3:]
+    # ec_multiply = False
+    if identifier  == b'\x01\x43':
+        # ec_multiply = True
+        raise EncodingError("EC multiply BIP38 keys are not supported at the moment")
+    elif identifier != b'\x01\x42':
+        raise EncodingError("Unknown BIP38 identifier, value must be 0x0142 (non-EC-multiplied) or "
+                            "0x0143 (EC-multiplied)")
     if flagbyte == b'\xc0':
         compressed = False
-    elif flagbyte == b'\xe0':
+    elif flagbyte == b'\xe0' or flagbyte == b'\x20':
         compressed = True
     else:
         raise EncodingError("Unrecognised password protected key format. Flagbyte incorrect.")

bitcoinlib/mnemonic.py

@@ -82,8 +82,8 @@ def to_seed(self, words, password='', validate=True):
         # Check if passphrase is valid
         if validate:
             self.to_entropy(words)
-        mnemonic = to_bytes(words)
-        password = to_bytes(password)
+        mnemonic = bytes(words, 'utf8')
+        password = bytes(password, 'utf8')
         return hashlib.pbkdf2_hmac(hash_name='sha512', password=mnemonic, salt=b'mnemonic' + password,
                                    iterations=2048)
 

bitcoinlib/services/bitcoind.py

@@ -53,7 +53,7 @@ class BitcoindClient(BaseClient):
     """
 
     @staticmethod
-    def from_config(configfile=None, network='bitcoin'):
+    def from_config(configfile=None, network='bitcoin', *args):
         """
         Read settings from bitcoind config file
 
@@ -113,7 +113,7 @@ def from_config(configfile=None, network='bitcoin'):
         server = _read_from_config(config, 'rpc', 'externalip', server)
 
         url = "http://%s:%s@%s:%s" % (config.get('rpc', 'rpcuser'), config.get('rpc', 'rpcpassword'), server, port)
-        return BitcoindClient(network, url)
+        return BitcoindClient(network, url, *args)
 
     def __init__(self, network='bitcoin', base_url='', denominator=100000000, *args):
         """
@@ -123,7 +123,7 @@ def __init__(self, network='bitcoin', base_url='', denominator=100000000, *args)
         :type: str
         :param base_url: Connection URL in format http(s)://user:password@host:port.
         :type: str
-        :param denominator: Denominator for this currency. Should be always 100000000 (satoshis) for bitcoin
+        :param denominator: Denominator for this currency. Should be always 100000000 (Satoshi's) for bitcoin
         :type: str
         """
         if isinstance(network, Network):

bitcoinlib/services/dashd.py

@@ -56,7 +56,7 @@ class DashdClient(BaseClient):
     """
 
     @staticmethod
-    def from_config(configfile=None, network='dash'):
+    def from_config(configfile=None, network='dash', **kargs):
         """
         Read settings from dashd config file
 
@@ -104,9 +104,9 @@ def from_config(configfile=None, network='dash'):
         elif 'externalip' in config['rpc']:
             server = config.get('rpc', 'externalip')
         url = "http://%s:%s@%s:%s" % (config.get('rpc', 'rpcuser'), config.get('rpc', 'rpcpassword'), server, port)
-        return DashdClient(network, url)
+        return DashdClient(network, url, **kargs)
 
-    def __init__(self, network='dash', base_url='', denominator=100000000, *args):
+    def __init__(self, network='dash', base_url='', denominator=100000000, **kargs):
         """
         Open connection to dashcore node
 
@@ -123,7 +123,7 @@ def __init__(self, network='dash', base_url='', denominator=100000000, *args):
             network = bdc.network
         _logger.info("Connect to dashd")
         self.proxy = AuthServiceProxy(base_url)
-        super(self.__class__, self).__init__(network, PROVIDERNAME, base_url, denominator, *args)
+        super(self.__class__, self).__init__(network, PROVIDERNAME, base_url, denominator, **kargs)
 
     def _parse_transaction(self, tx, block_height=None, get_input_values=True):
         t = Transaction.parse_hex(tx['hex'], strict=self.strict, network=self.network)

bitcoinlib/services/dogecoind.py

@@ -54,7 +54,7 @@ class DogecoindClient(BaseClient):
     """
 
     @staticmethod
-    def from_config(configfile=None, network='dogecoin'):
+    def from_config(configfile=None, network='dogecoin', **kargs):
         """
         Read settings from dogecoind config file
 
@@ -113,9 +113,9 @@ def from_config(configfile=None, network='dogecoin'):
         server = _read_from_config(config, 'rpc', 'externalip', server)
 
         url = "http://%s:%s@%s:%s" % (config.get('rpc', 'rpcuser'), config.get('rpc', 'rpcpassword'), server, port)
-        return DogecoindClient(network, url)
+        return DogecoindClient(network, url, **kargs)
 
-    def __init__(self, network='dogecoin', base_url='', denominator=100000000, *args):
+    def __init__(self, network='dogecoin', base_url='', denominator=100000000, **kargs):
         """
         Open connection to dogecoin node
 
@@ -141,7 +141,7 @@ def __init__(self, network='dogecoin', base_url='', denominator=100000000, *args
                               "Please replace default password and set url in providers.json or dogecoin.conf file")
         _logger.info("Connect to dogecoind")
         self.proxy = AuthServiceProxy(base_url)
-        super(self.__class__, self).__init__(network, PROVIDERNAME, base_url, denominator, *args)
+        super(self.__class__, self).__init__(network, PROVIDERNAME, base_url, denominator, **kargs)
 
     def getutxos(self, address, after_txid='', max_txs=MAX_TRANSACTIONS):
         txs = []

bitcoinlib/services/litecoind.py

@@ -53,7 +53,7 @@ class LitecoindClient(BaseClient):
     """
 
     @staticmethod
-    def from_config(configfile=None, network='litecoin'):
+    def from_config(configfile=None, network='litecoin', **kargs):
         """
         Read settings from litecoind config file
 
@@ -112,9 +112,9 @@ def from_config(configfile=None, network='litecoin'):
         server = _read_from_config(config, 'rpc', 'bind', server)
         server = _read_from_config(config, 'rpc', 'externalip', server)
         url = "http://%s:%s@%s:%s" % (config.get('rpc', 'rpcuser'), config.get('rpc', 'rpcpassword'), server, port)
-        return LitecoindClient(network, url)
+        return LitecoindClient(network, url, **kargs)
 
-    def __init__(self, network='litecoin', base_url='', denominator=100000000, *args):
+    def __init__(self, network='litecoin', base_url='', denominator=100000000, **kargs):
         """
         Open connection to litecoin node
 
@@ -133,7 +133,7 @@ def __init__(self, network='litecoin', base_url='', denominator=100000000, *args
             network = bdc.network
         _logger.info("Connect to litecoind")
         self.proxy = AuthServiceProxy(base_url)
-        super(self.__class__, self).__init__(network, PROVIDERNAME, base_url, denominator, *args)
+        super(self.__class__, self).__init__(network, PROVIDERNAME, base_url, denominator, **kargs)
 
     def getbalance(self, addresslist):
         balance = 0

bitcoinlib/services/services.py

@@ -25,7 +25,7 @@
 from sqlalchemy import func
 from bitcoinlib import services
 from bitcoinlib.networks import Network
-from bitcoinlib.encoding import to_bytes, int_to_varbyteint, varstr, varbyteint_to_int
+from bitcoinlib.encoding import to_bytes, int_to_varbyteint, varstr
 from bitcoinlib.db_cache import *
 from bitcoinlib.transactions import Transaction, transaction_update_spents
 from bitcoinlib.blocks import Block
@@ -144,12 +144,6 @@ def __init__(self, network=DEFAULT_NETWORK, min_providers=1, max_providers=1, pr
         else:
             self._blockcount = self.blockcount()
 
-    def __exit__(self):
-        try:
-            self.cache.session.close()
-        except Exception:
-            pass
-
     def _reset_results(self):
         self.results = {}
         self.errors = {}
@@ -694,12 +688,6 @@ def __init__(self, network, db_uri=''):
             self.session = DbCache(db_uri=db_uri).session
         self.network = network
 
-    def __exit__(self):
-        try:
-            self.session.close()
-        except Exception:
-            pass
-
     def cache_enabled(self):
         """
         Check if caching is enabled. Returns False if SERVICE_CACHING_ENABLED is False or no session is defined.

bitcoinlib/transactions.py

@@ -859,7 +859,7 @@ def __init__(self, prev_txid, output_n, keys=None, signatures=None, public_hash=
                 b'\0' not in self.witnesses:
             self.signatures = [Signature.parse_bytes(self.witnesses[0])]
             self.hash_type = self.signatures[0].hash_type
-            self.keys = [Key(self.witnesses[1], network=self.network)]
+            self.keys = [Key(self.witnesses[1], network=self.network, strict=self.strict)]
 
         self.update_scripts(hash_type=self.hash_type)
 
@@ -1190,7 +1190,7 @@ def __init__(self, value, address='', public_hash=b'', public_key=b'', lock_scri
                 self.encoding = 'bech32'
             self.public_hash = self.script.public_hash
             if self.script.keys:
-                self.public_key = self.script.keys[0].public_hex
+                self.public_key = self.script.keys[0].public_byte
             if self.script_type == 'p2tr':
                 self.witver = self.script.commands[0] - 80
 
@@ -1498,7 +1498,9 @@ def parse_bytesio(cls, rawtx, strict=True, network=DEFAULT_NETWORK):
                 inputs[n].script = script if not inputs[n].script else inputs[n].script + script
                 inputs[n].keys = script.keys
                 inputs[n].signatures = script.signatures
-                if script.script_types[0][:13] == 'p2sh_multisig' or script.script_types[0] =='signature_multisig':
+                if not script.script_types:
+                    inputs[n].script_type = 'unknown'
+                elif script.script_types[0][:13] == 'p2sh_multisig' or script.script_types[0] =='signature_multisig':
                     inputs[n].script_type = 'p2sh_multisig'
                     inputs[n].redeemscript = inputs[n].witnesses[-1]
                 elif script.script_types[0] == 'p2tr_unlock':