add Ethereum docs for gurnec#46

[ci skip]

README.md

@@ -10,7 +10,7 @@
      * [MultiBit HD](https://multibit.org/) and [MultiBit Classic](https://multibit.org/help/v0.5/help_contents.html)
      * [Electrum](https://electrum.org/) (1.x and 2.x)
      * Most wallets based on [bitcoinj](https://bitcoinj.github.io/), including [Hive for OS X](https://github.com/hivewallet/hive-mac/wiki/FAQ)
-     * BIP-39 passphrases (e.g. [TREZOR](https://www.bitcointrezor.com/) & [Ledger](https://www.ledgerwallet.com/) passphrases)
+     * BIP-39 passphrases, Bitcoin & Ethereum supported (e.g. [TREZOR](https://www.bitcointrezor.com/) & [Ledger](https://www.ledgerwallet.com/) passphrases)
      * [mSIGNA (CoinVault)](https://ciphrex.com/products/)
      * [Blockchain.info](https://blockchain.info/wallet)
      * [pywallet --dumpwallet](https://github.com/jackjack-jj/pywallet) of Bitcoin Unlimited/Classic/XT/Core wallets
@@ -24,17 +24,19 @@
      * [Dogecoin Core](http://dogecoin.com/)
      * [MultiDoge](http://multidoge.org/)
      * [Dogecoin Wallet for Android](http://dogecoin.com/) encrypted backups
- * Bitcoin seed recovery support for:
+ * Bitcoin & Ethereum seed recovery support for:
      * [Electrum](https://electrum.org/) (1.x and 2.x, plus wallet file loading support)
      * BIP-32/39 compliant wallets ([bitcoinj](https://bitcoinj.github.io/)), including:
          * [MultiBit HD](https://multibit.org/)
          * [Bitcoin Wallet for Android/BlackBerry](https://play.google.com/store/apps/details?id=de.schildbach.wallet) (with seeds previously extracted by [decrypt\_bitcoinj\_seeds](https://github.com/gurnec/decrypt_bitcoinj_seed))
          * [Hive for Android](https://play.google.com/store/apps/details?id=com.hivewallet.hive.cordova), [for iOS](https://github.com/hivewallet/hive-ios), and [Hive Web](https://hivewallet.com/)
          * [breadwallet for iOS](https://breadwallet.com/)
-     * BIP-32/39/44 compliant wallets, including:
+     * BIP-32/39/44 Bitcoin & Ethereum compliant wallets, including:
          * [Mycelium for Android](https://wallet.mycelium.com/)
          * [TREZOR](https://www.bitcointrezor.com/)
          * [Ledger](https://www.ledgerwallet.com/)
+         * [Jaxx](https://jaxx.io/)
+         * [MyEtherWallet](https://www.myetherwallet.com/)
          * [Bither](https://bither.net/)
          * [Blockchain.info](https://blockchain.info/wallet)
  * [Free and Open Source](http://en.wikipedia.org/wiki/Free_and_open-source_software) - anyone can download, inspect, use, and redistribute this software

TUTORIAL.md

@@ -424,12 +424,12 @@ As you can see, the Windows command prompt was incapable of rendering some of th
     * *Windows*: Open a Command Prompt window (click the Start Menu and type "command"), and type in the two lines below. 
 
             cd Downloads\btcrecover-master
-            C:\python27\python btcrecover.py --wallet wallet.dat --tokenlist tokens.txt --other-options...
+            C:\python27\python btcrecover.py --wallet wallet.dat --tokenlist tokens.txt [other-options...]
 
     * *OS X*: Open a terminal window (open the Launchpad and search for "terminal"), and type in the two lines below.
 
             cd Downloads/btcrecover-master
-            python btcrecover.py --wallet wallet.dat --tokenlist tokens.txt --other-options...
+            python btcrecover.py --wallet wallet.dat --tokenlist tokens.txt [other-options...]
 
 After a short delay, *btcrecover* should begin testing passwords and will display a progress bar and an ETA as shown below. If it appears to be stuck just counting upwards with the message `Counting passwords ...` and no progress bar, please read the [Memory limitations](docs/Limitations_and_Caveats.md#memory) section. If that doesn't help, then you've probably chosen too many tokens or typos to test resulting in more combinations than your system can handle (although the [`--max-tokens`](#token-counts) option may be able to help).
 
@@ -486,18 +486,20 @@ Note that if you don't include the `--android-pin` option, *btcrecover* will try
 
 ### BIP-39 Passphrases ###
 
-Some [BIP-39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki) compliant wallets offer a feature to add a “BIP-39 passphrase” to your seed (mnemonic), most notably the TREZOR hardware wallet. Note that TREZOR also offers a PIN feature which is not supported by *btcrecover*.
+Some [BIP-39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki) compliant wallets offer a feature to add a “BIP-39” or “plausible deniability” passphrase to your seed (mnemonic), most notably the TREZOR hardware wallet. (Note that most hardware wallets also offer a PIN feature which is not supported by *btcrecover*.)
 
-If you know your seed, but need help recovering your passphrase, *btcrecover* may be able to help. You will also need to know either:
+If you know your seed, but don't remember this passphrase, *btcrecover* may be able to help. You will also need to know either:
 
- 1. Preferably your master public key / “xpub”  (for the *first* account in your wallet, if it supports multiple accounts), or
+ 1. Preferably your master public key / “xpub”  (for the *first* account in your wallet, if it supports multiple accounts), *or*
  2. a receiving address that was generated by your wallet (in its first account), along with a good estimate of how many addresses you created before the receiving address you'd like to use.
 
 Once you have this information, run *btcrecover* normally, except that *instead* of providing a wallet file on the command line as described above with the `--wallet wallet.dat` option, use the `--bip39` option, e.g.:
 
-    C:\python27\python btcrecover.py --bip39 --tokenlist tokens.txt --other-options...
+    C:\python27\python btcrecover.py --bip39 --tokenlist tokens.txt [other-options...]
 
-When you run this, you will be prompted for your master public key (or your address), and your seed.
+If you have an Ethereum seed, also add the `--wallet-type ethereum` option. When you run this, you will be prompted for your master public key (or your address), and your seed.
+
+**Note** that *btcrecover* assumes your wallet software is using both the BIP-39 the BIP-44 standards. If your wallet is not strictly complaint with these standards, *btcrecover* will probably not work correctly to find your passphrase. It may be possible to use the `--bip32-path` option to work correctly with a wallet using different standards—feel free to open an [issue on GitHub](https://github.com/gurnec/btcrecover/issues/new) if you're unsure of your wallet's compatibility with *btcrecover*.
 
 ### GPU acceleration for Bitcoin Unlimited/Classic/XT/Core, Armory, and Litecoin-Qt wallets ###
 

docs/INSTALL.md

@@ -18,7 +18,8 @@ Locate your wallet type in the list below, and follow the instructions in the se
  * MultiBit HD - [Python 2.7](#python-27), [scrypt](#scrypt), optional: [PyCrypto](#pycrypto)
  * Electrum (1.x or 2.x) - [Python 2.7](#python-27), recommended: [PyCrypto](#pycrypto)
  * Electrum 2.8+ fully encrypted wallets - [Python 2.7](#python-27) (2.7.8+ recommended), [Armory 0.92+](Seedrecover_Quick_Start_Guide.md#installation), optional: [PyCrypto](#pycrypto)
- * BIP-39 passphrases (e.g. TREZOR) - [Python 2.7](#python-27) (2.7.8+ recommended), [Armory 0.92+](Seedrecover_Quick_Start_Guide.md#installation)
+ * BIP-39 Bitcoin passphrases (e.g. TREZOR) - [Python 2.7](#python-27) (2.7.8+ recommended), [Armory 0.92+](Seedrecover_Quick_Start_Guide.md#installation)
+ * BIP-39 Ethereum passphrases (e.g. TREZOR) - [Python 2.7](#python-27) (2.7.8+ recommended), [Armory 0.92+ and pysha3](Seedrecover_Quick_Start_Guide.md#installation)
  * Hive for OS X - [Python 2.7](#python-27), [scrypt](#scrypt), [Google protobuf](#google-protocol-buffers), optional: [PyCrypto](#pycrypto)
  * mSIGNA (CoinVault) - [Python 2.7](#python-27), recommended: [PyCrypto](#pycrypto)
  * Blockchain.info - [Python 2.7](#python-27) (2.7.8+ recommended), recommended: [PyCrypto](#pycrypto)
@@ -68,7 +69,7 @@ Download and run the PyCrypto 2.6 installer for Python 2.7, either the 32-bit ve
 
 ##### Linux #####
 
-Many distributions include PyCrypto pre-installed, check your distribution’s package management system to see if it is available (it is often called “python-crypto”). If not, try installing it by using PyPI, for example on Debian-like distributions, if this doesn't work:
+Many distributions include PyCrypto pre-installed, check your distribution’s package management system to see if it is available (it is often called “python-crypto”). If not, try installing it from PyPI, for example on Debian-like distributions (including Ubuntu), if this doesn't work:
 
     sudo apt-get install python-crypto
 
@@ -115,12 +116,14 @@ then try this instead:
 
 ##### Linux #####
 
+Install pylibscrypt and at least one scrypt library, for example on Debian-like distributions (including Ubuntu):
+
  1. Open a terminal window, and type this to install pylibscrypt:
 
         sudo apt-get install python-pip
         sudo pip install pylibscrypt
 
- 2. Install one of the scrypt libraries listed under the Requirements section here: <https://pypi.python.org/pypi/pylibscrypt>. For example on Debian-like distributions, try ***one*** of these commands:
+ 2. Install *one* of the scrypt libraries listed under the Requirements section here: <https://pypi.python.org/pypi/pylibscrypt>, e.g. try each of these commands, stopping after the *first one* succeeds:
 
         sudo apt-get install libscrypt0
         sudo apt-get install python-scrypt
@@ -155,7 +158,7 @@ Open a command prompt window, and type this to install Google Protocol Buffers:
 
 ##### Linux #####
 
-Open a terminal window, and type this to install Google Protocol Buffers:
+Install the Google's Python protobuf library, for example on Debian-like distributions (including Ubuntu), open a terminal window and type this:
 
     sudo apt-get install python-pip
     sudo pip install protobuf

docs/Seedrecover_Quick_Start_Guide.md

@@ -1,6 +1,6 @@
 # *seedrecover.py* #
 
-*seedrecover.py* is a Bitcoin seed recovery tool which can take a seed with one or more mistakes in it, and recover the correct seed if not too many mistakes have been made.
+*seedrecover.py* is a Bitcoin and Ethereum seed recovery tool which can take a seed with one or more mistakes in it, and recover the correct seed if not too many mistakes have been made.
 
 
 ## Installation ##
@@ -19,7 +19,11 @@ Note that *seedrecover.py* uses Armory (Bitcoin wallet software) to accelerate t
 
  3. Double-click the downloaded file to install Armory.
 
- 4. (optional) Follow [these instructions](INSTALL.md#windows) to download and install pywin32.
+ 4. For Ethereum wallets only, open a command prompt window, and type this to install pysha3:
+
+        C:\Python27\Scripts\pip install pysha3
+
+ 5. (optional) Follow [these instructions](INSTALL.md#windows) to download and install pywin32.
 
 ### Linux ###
 
@@ -29,8 +33,15 @@ Because Armory has a number of dependencies, installing it on Linux isn't always
 
 Alternatively you can manually download and install the latest version of Armory from here (but avoid any `Pre-release` versions): <https://github.com/goatpig/BitcoinArmory/releases>.
 
+For Ethereum wallets only, install the pysha3 library, for example on Debian-like distributions (including Ubuntu), open a terminal window and type this:
+
+    sudo apt-get install python-pip
+    sudo pip install pysha3
+
 ### OS X ###
 
+Please read the [Running *seedrecover.py*](#running-seedrecoverpy) section first to check if *seedrecover.py* will work with your wallet on OS X.
+
  1. Download the latest version of Armory for `osx` from here: <https://github.com/goatpig/BitcoinArmory/releases> (but avoid any `Pre-release` versions).
 
  2. Open your Downloads, and double-click the Armory file to decompress it.
@@ -50,7 +61,7 @@ In order to run *seedrecover.py*, you'll need these two things:
      1. for Electrum (1.x or 2.x), a copy of your wallet file (a wallet file using Electrum 2.8's new full-file encryption won't work here), *or*
      2. your master public key (sometimes called an *xpub*), *or*
      3. a receiving address that was generated by your wallet from your seed, along with a good estimate of how many addresses you created before the receiving address you'd like to use, *or*
-     4. an "address database". If you don't have i., ii., or iii. from above, please see the [Recovery with an Address Database](#recovery-with-an-address-database) section below. 
+     4. an "address database". If you don't have i., ii., or iii. from above, please see the [Recovery with an Address Database](#recovery-with-an-address-database) section below.
 
         **Note** that seed recovery based on addresses (option iii. or iv. above) is not currently supported on OS X.
 

docs/install-armory.sh

@@ -2,7 +2,7 @@
 
 set -e
 
-LATEST="https://github.com/goatpig/BitcoinArmory/releases/download/v0.96/armory_0.96-gcc5.4_amd64.deb"
+LATEST="https://github.com/goatpig/BitcoinArmory/releases/download/v0.96.1/armory_0.96.1_amd64.deb"
 
 curl -LfsS --retry 10 -o '/tmp/armory.deb' "$LATEST"