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