Merge branch 'master' of https://github.com/3rdIteration/btcrecover

.readthedocs.yml

@@ -4,6 +4,10 @@
 
 # Required
 version: 2
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.11"
 
 mkdocs:
   configuration: mkdocs.yml
@@ -14,6 +18,5 @@ formats:
 
 # Optionally set the version of Python and requirements required to build your docs
 python:
-   version: 3.7
    install:
    - requirements: docs/requirements.txt

btcrecover/btcrpass.py

@@ -28,7 +28,7 @@
 
 # Import modules included in standard libraries
 import sys, argparse, itertools, string, re, multiprocessing, signal, os, pickle, gc, \
-       time, timeit, hashlib, collections, base64, struct, atexit, zlib, math, json, numbers, datetime, binascii
+       time, timeit, hashlib, collections, base64, struct, atexit, zlib, math, json, numbers, datetime, binascii, gzip
 
 # Import modules bundled with BTCRecover
 import btcrecover.opencl_helpers
@@ -5443,9 +5443,16 @@ def open_or_use(filename, mode = "r",
         return None
     #
     if tstr == str and "b" not in mode:
-        file = io.open(filename, mode, encoding="utf_8_sig", errors=decoding_errors)
+        if filename[-3:] == ".gz":
+            mode = mode + "t"
+            file = gzip.open(filename, mode, encoding="utf_8_sig", errors=decoding_errors)
+        else:
+            file = io.open(filename, mode, encoding="utf_8_sig", errors=decoding_errors)
     else:
-        file = open(filename, mode)
+        if filename[-3:] == ".gz":
+            file = gzip.open(filename, mode)
+        else:
+            file = open(filename, mode)
     #
     if "b" not in mode:
         if file.read(5) == br"{\rtf":

docs/Creating_and_Using_AddressDB.md

@@ -24,12 +24,12 @@ A rought guide of the blockchain, AddressDB size and optimal parameters as at Ja
 
 | Coin         | Blockchain Size | AddressDB Size  | Required DBLength |
 | -------------|:---------------:| ---------------:|------------------:|
-| Bitcoin      | 324 GB          | 16 GB            | 31                |
+| Bitcoin      | 561 GB          | 16 GB            | 31                |
 | Bitcoin Cash | 155 GB          | 4 GB            | 29                |
-| Litecoin     | 90 GB            | 2 GB            | 28                |
+| Litecoin     | 133 GB            | 4 GB            | 29                |
 | Vertcoin     | 5 GB            | 32 MB           | 22                |
 | Monacoin     | 2.5 GB          | 32 MB           | 22                |
-| Ethereum     | N/A (AddressList from BigQuery with ~120 million addresses)           | 4 GB             | 29
+| Ethereum     | N/A (AddressList from BigQuery with ~250 million addresses)           | 4 GB             | 29
 | Dogecoin      | N/A (Addresslist from BigQuery with ~60 million addresses) | 1GB | 27 |
 
 _If in doubt, just download the full blockchain and parse it in it entritiy... The default will be fine..._

docs/passwordlist_file.md

@@ -1,7 +1,7 @@
 contributors: gurnec
 ## The Passwordlist ##
 
-If you already have a simple list of whole passwords you'd like to test, and you don't need any of the features described above, you can use the `--passwordlist` command-line option (instead of the `--tokenlist` option as described later in the [Running *btcrecover*](#running-btcrecover) section). If your password contains any non-[ASCII](https://en.wikipedia.org/wiki/ASCII) (non-English) characters, you should read the section on [Unicode Support](#unicode-support) before continuing.
+If you already have a simple list of whole passwords you'd like to test, and you don't need any of the features described above, you can use the `--passwordlist` command-line option (instead of the `--tokenlist` option as described later in the [Running *btcrecover*](#running-btcrecover) section). The passwordlist is just a standard text file, with one password per line. (It can be either raw text or also compressed with gzip)If your password contains any non-[ASCII](https://en.wikipedia.org/wiki/ASCII) (non-English) characters, you should read the section on [Unicode Support](#unicode-support) before continuing.
 
 If you specify `--passwordlist` without a file, *btcrecover* will prompt you to type in a list of passwords, one per line, in the Command Prompt window. If you already have a text file with the passwords in it, you can use `--passwordlist FILE` instead (replacing `FILE` with the file name).