Docco tweak and Termux Fixes (#585)

Author: 3rdIteration

README.md

@@ -112,7 +112,7 @@ If you need help, [your best bet is to look at my BTCRecover playlist on YouTube
      * [Damaged Raw Eth Private Keys]() Individual Private keys that are missing characters.
      * [Toastwallet](https://toastwallet.github.io/browser/) Toastwallet Passphrase
  * [Free and Open Source](http://en.wikipedia.org/wiki/Free_and_open-source_software) - anyone can download, inspect, use, and redistribute this software
- * Supported on Windows, Linux, and OS X
+ * Supported on Windows, Linux, and MacOS
  * Support for Unicode passwords and seeds
  * Multithreaded searches, with user-selectable thread count
  * Ability to spread search workload over multiple devices
@@ -126,7 +126,7 @@ If you need help, [your best bet is to look at my BTCRecover playlist on YouTube
  * “Offline” mode for nearly all supported wallets - use one of the [extract scripts (click for more information)](docs/Extract_Scripts.md) to extract just enough information to attempt password recovery, without giving *btcrecover* or whoever runs it access to *any* of the addresses or private keys in your Bitcoin wallet.
 
 ## Setup and Usage Tutorials ##
-BTCRecover is a Python (3.8, 3.9, 3.10, 3.11) script so will run on Windows, Linux and Mac environments. [See the installation guide for more info](docs/INSTALL.md)
+BTCRecover is a Python (3.9, 3.10, 3.11, 3.12 and 3.13) script so will run on Windows, Linux, Mac and even Android environments. [See the installation guide for more info](docs/INSTALL.md)
 
 [I have created a growing playlist](https://www.youtube.com/playlist?list=PL7rfJxwogDzmd1IanPrmlTg3ewAIq-BZJ) that covers a number of usage examples for using this tool to recover seed phrases, BIP39 passphrases, etc.
 

btcrecover/btcrseed.py

@@ -32,7 +32,6 @@
 # Import modules bundled with BTCRecover
 from . import btcrpass
 from .addressset import AddressSet
-from lib.bitcoinlib_mod import encoding as encoding_mod
 from lib.bitcoinlib import encoding
 from lib.cashaddress import convert, base58
 from lib.base58_tools import base58_tools
@@ -44,6 +43,15 @@
 import lib.stacks.c32 as c32
 from lib.p2tr_helper import P2TR_tools
 
+# import bundled modules that won't work in some environments
+bundled_bitcoinlib_mod_available = False
+try:
+    from lib.bitcoinlib_mod import encoding as encoding_mod
+
+    bundled_bitcoinlib_mod_available = True
+except:
+    pass
+
 # Enable functions that may not work for some standard libraries in some environments
 hashlib_ripemd160_available = False
 
@@ -356,12 +364,14 @@ def _addresses_to_hash160s(addresses):
                     try:
                         hash160 = binascii.unhexlify(encoding.addr_bech32_to_pubkeyhash(address, prefix=None,  include_witver=False, as_hex=True)) #Base58 conversion above will give a keyError if attempted with a Bech32 address for things like BTC
                     except Exception as e:
-                        # Try for some obscure altcoins which require modified versions of Bitcoinlib
-                        try:
-                            hash160 = binascii.unhexlify(encoding_mod.grs_addr_base58_to_pubkeyhash(address, True))
-                        except Exception as e:
-                            hash160 = binascii.unhexlify(encoding_mod.addr_bech32_to_pubkeyhash(address, prefix=None,  include_witver=False, as_hex=True)) #
-
+                        if bundled_bitcoinlib_mod_available:
+                            # Try for some obscure altcoins which require modified versions of Bitcoinlib
+                            try:
+                                hash160 = binascii.unhexlify(encoding_mod.grs_addr_base58_to_pubkeyhash(address, True))
+                            except Exception as e:
+                                hash160 = binascii.unhexlify(encoding_mod.addr_bech32_to_pubkeyhash(address, prefix=None,  include_witver=False, as_hex=True))
+                        else:
+                            print("Address not valid and unable to load modified bitcoinlib on this platform...")
 
             hash160s.add(hash160)
         return hash160s

btcrecover/test/test_seeds.py

@@ -114,6 +114,19 @@ def can_load_staking_deposit():
             eth2_staking_deposit_available = False
     return eth2_staking_deposit_available
 
+# import bundled modules that won't work in some environments
+bundled_bitcoinlib_mod_available = None
+def can_load_bundled_bitcoinlib_mod():
+    global bundled_bitcoinlib_mod_available
+    if bundled_bitcoinlib_mod_available is None:
+        try:
+            from lib.bitcoinlib_mod import encoding as encoding_mod
+
+            bundled_bitcoinlib_mod_available = True
+        except:
+            bundled_bitcoinlib_mod_available = False
+    return bundled_bitcoinlib_mod_available
+
 # Similar to unittest.skipUnless, except the first arg is a function returning a bool instead
 # of just a bool. This function isn't called until just before the test is to be run. This
 # permits checking the character mode (which isn't set until later) and prevents multiprocessing
@@ -658,6 +671,7 @@ def test_bip44_addr_BTC(self):
                             "certain come keen collect slab gauge photo inside mechanic deny leader drop",
                             ["m/44'/0'/0'/0"])
 
+    @skipUnless(can_load_bundled_bitcoinlib_mod,"Unable to load modified bitcoinlib in this environment")
     def test_bip44_addr_TerraLuna(self):
         self.address_tester(btcrseed.WalletBIP39, "terra1negkjtkr6wu2uzcwcuz0kj8w4z64uax3w0dv5u", 2,
                             "earth jelly weapon word focus shaft danger cruel inflict strong palace barrel peace strike timber orbit orphan tower size series scatter kiwi fat filter",

docs/INSTALL.md

@@ -24,6 +24,7 @@ Ubuntu Linux: <https://youtu.be/Met3NbxcZTU>
 
 MacOS: <https://youtu.be/Qzc3oHzbcAo>
 
+Android via Termux: TBC
 
 ## 1) Downloading *btcrecover* ##
 
@@ -32,12 +33,12 @@ Just download the latest version from <https://github.com/3rdIteration/btcrecove
 
 ## 2) Install Python ##
 
-**Note:** Only Python 3.8 and later are officially supported... BTCRecover is automatically tested with all supported Python versions (3.8, 3.9, 3.10, 3.11) on all supported environments (Windows, Linux, Mac), so you can be sure that both BTCRecover and all required packages will work correctly. Some features of BTCRecover may work on earlier versions of Python, your best bet is to use run-all-tests.py to see what works and what doesn't...
+**Note:** Only Python 3.9 and later are officially supported... BTCRecover is automatically tested with all supported Python versions (3.9, 3.10, 3.11, 3.12, 3.13) on all supported environments (Windows, Linux, Mac), so you can be sure that both BTCRecover and all required packages will work correctly. Some features of BTCRecover may work on earlier versions of Python, your best bet is to use run-all-tests.py to see what works and what doesn't...
 
 ### Windows ###
 Video Demo of Installing BTCRecover in Windows: <https://youtu.be/8q65eqpf4gE>
 
-Visit the Python download page here: <https://www.python.org/downloads/windows/>, and click the link for the latest **Python 3.10** release (Python 3.11, etc, will work, but Python 3.10 has simpler installation of required modules) release near the top of the page under the heading *Python Releases for Windows*. Download and run either the `Windows x86 MSI installer` for the 32-bit version of Python, or the `Windows x86-64 MSI installer` for the 64-bit one. Modern PCs should use the 64-bit version, however if you're unsure which one is compatible with your PC, choose the 32-bit one.
+Visit the Python download page here: <https://www.python.org/downloads/windows/>, and click the link for the latest **Python 3.12** release (Python 3.13, etc, will work, but Python 3.12 has simpler installation of required modules) release near the top of the page under the heading *Python Releases for Windows*. Download and run either the `Windows x86 MSI installer` for the 32-bit version of Python, or the `Windows x86-64 MSI installer` for the 64-bit one. Modern PCs should use the 64-bit version, however if you're unsure which one is compatible with your PC, choose the 32-bit one.
 
 _**When installing Python in Windows, be sure to select to "Add Python to PATH" on the first screen of the installer...**_
 
@@ -60,8 +61,24 @@ If you get a message that there is no installation candidate for Python3-pip, yo
 
 You can then re-run the command to install python3-pip from above.
 
+### Android via Termux ###
+Some warnings and notes...
+* Termux is not automatically tested like other platforms... 
+* Your phone may not have sufficient cooling to run BTCRecover for any meaninful length of time
+* Performance will also vary dramatically between phones and Android versions... (Though it is actually fast enough to be useful for simple recoveries)
+* Termux is not a standard Linux environment and is not officially supported, but might work following the process below... (And if it doesn't, just use a PC instead...)
+* Install Termux following the instructions here: https://termux.dev/en/ (Currently not officially distributed on Google Play and the version on Google Play is not currently up-to-date)
+
+You will then need to install Python as well as some other packages (Mostly the Coincurve build requirements)
+
+   pkg install python-pip git autoconf automake build-essential libtool pkg-config binutils-is-llvm rust
+
+Once this is done, you can install the base requirements for BTCRecover that allow recovery of common wallet types. (The full requirements have a lot of packages that won't easily work with Termux) You can also install py-crypto-hd-wallet via pip3 for extended wallet support.(This will take a while to build)
+
 #### Enabling Native RIPEMD160 Support
-As of OpenSSL v3 (Late 2021), ripemd160 is no longer enabled by default and is now part of the "Legacy" set of hash functions. In Linux/MacOS environments, the hashlib module in Python relies on OpenSSL for ripemd160, so if you want full performance in these environments, you may need modify your OpenSSL settings to enable the legacy provider.
+As of OpenSSL v3 (Late 2021), ripemd160 is no longer enabled by default in some Linux environments and is now part of the "Legacy" set of hash functions. In Linux/MacOS environments, the hashlib module in Python relies on OpenSSL for ripemd160, so if you want full performance in these environments, you may need modify your OpenSSL settings to enable the legacy provider.
+
+You can check if this is required by running `python check_ripemd160.py`
 
 As of July 2022, BTCRecover does include a "pure Python" implementation of RIPEMD160, but this only offers about 1/3 of the performance when compared to a native implementation via hashlib.
 

requirements.txt

@@ -1,4 +1,3 @@
 coincurve~=19.0.0
-green~=4.0.2
 protobuf~=3.19.1
 pycryptodome~=3.19.1