readme.md

   1 [TOC]
   2
   3 # BIP39 Tool
   4
   5 A tool for converting BIP39 mnemonic phrases to addresses and private keys.
   6
   7 This tool tries to find the best world between Coinomi's and
   8 iancoleman's versions of the implementation, plus a few additions.
   9
  10 Note that this version is centered on my use of Coinomis's wallet, which
  11 has a few differences to exact BIP44 implementation:
  12
  13 - Coinomi's Ethereum networks don't use change in the BIP44 path.
  14
  15 ## Online Version
  16
  17 [https://tools.immae.eu/BIP39](https://tools.immae.eu/BIP39)
  18
  19 ## Standalone offline version
  20
  21 Download `bip39-standalone.html`
  22
  23 Open the file in a browser by double clicking it.
  24
  25 This can be compiled from source using the command `python compile.py`
  26
  27 ## Usage
  28
  29 Enter your BIP39 phrase into the 'BIP39 Phrase' field, or press
  30 'Generate Random Phrase'
  31
  32 If required, set the derivation path, although the defaults are quite usable.
  33
  34 See the table for a list of addresses generated from the phrase.
  35
  36 Toggle columns to blank to easily copy/paste a single column of data, eg to
  37 import private keys into a wallet or supply someone with a list of addresses.
  38
  39 The BIP32 keys can be used at [bip32.org](https://bip32.org) if desired.
  40
  41 ## Donations
  42
  43 Since this project is the efforts of many people, most of which don't appear in
  44 the obvious places like code or issues, donating to the project itself causes
  45 significant operational difficulties.
  46
  47 As a result, if you would like to support this project financially you are
  48 encouraged to donate to one of the many groups that makes the internet a place
  49 amenable to projects such as this one.
  50
  51 [Donation-accepting organizations and projects](https://en.bitcoin.it/wiki/Donation-accepting_organizations_and_projects)
  52
  53 If the list is too difficult to choose from, the EFF is a good choice.
  54
  55 [Electronic Frontier Foundation](https://supporters.eff.org/donate)
  56
  57 or for a direct bitcoin address, consider donating to the
  58 [Free Software Foundation](https://www.fsf.org/about/ways-to-donate/)
  59 at 1PC9aZC4hNX2rmmrt7uHTfYAS3hRbph4UN
  60
  61 ![alt text](https://static.fsf.org/nosvn/images/bitcoin_qrcodes/fsf.png "FSF Bitcoin Address")
  62
  63 ## Making changes
  64
  65 Please do not make modifications to `bip39-standalone.html`, since they will
  66 be overwritten by `compile.py`.
  67
  68 Make changes in `src/*`.
  69
  70 Changes are applied during release using the command `python compile.py`, so
  71 please do not commit changes to `bip39-standalone.html`
  72
  73 # Tests
  74
  75 Tests depend on
  76
  77 * nodejs
  78 * selenium webdriver - cd /path/to/bip39/tests; npm install
  79 * selenium driver for firefox ([geckodriver](https://github.com/mozilla/geckodriver/releases)) and / or chrome ([chromedriver](https://sites.google.com/a/chromium.org/chromedriver/downloads))
  80 * jasmine - npm install --global jasmine
  81
  82 Before running tests, the site must be served at http://localhost:8000.
  83
  84 ```
  85 $ cd /path/to/bip39/src
  86 $ python -m http.server
  87
  88 or for python2
  89 $ python -m SimpleHTTPServer
  90 ```
  91
  92 Run tests from the command-line
  93
  94 ```
  95 $ cd /path/to/bip39/tests
  96 $ jasmine spec/tests.js
  97 ```
  98
  99 # License
 100
 101 This BIP39 tool is released under the terms of the MIT license. See LICENSE for
 102 more information or see https://opensource.org/licenses/MIT.