[perso/Immae/Projets/Cryptomonnaies/BIP39.git] / readme.md

# BIP39 Tool

A tool for converting BIP39 mnemonic phrases to addresses and private keys.

## Online Version

https://iancoleman.io/bip39/

## Standalone offline version

Download `bip39-standalone.html`

Open the file in a browser by double clicking it.

This can be compiled from source using the command `python compile.py`

## Usage

Enter your BIP39 phrase into the 'BIP39 Phrase' field, or press
'Generate Random Phrase'

If required, set the derivation path, although the defaults are quite usable.

See the table for a list of addresses generated from the phrase.

Toggle columns to blank to easily copy/paste a single column of data, eg to
import private keys into a wallet or supply someone with a list of addresses.

The BIP32 keys can be used at [bip32.org](https://bip32.org) if desired.

## Donations

Since this project is the efforts of many people, most of which don't appear in
the obvious places like code or issues, donating to the project itself causes
significant operational difficulties.

As a result, if you would like to support this project financially you are
encouraged to donate to one of the many groups that makes the internet a place
amenable to projects such as this one.

[Donation-accepting organizations and projects](https://en.bitcoin.it/wiki/Donation-accepting_organizations_and_projects)

If the list is too difficult to choose from, the EFF is a good choice.

[Electronic Frontier Foundation](https://supporters.eff.org/donate)

or for a direct bitcoin address, consider donating to the
[Free Software Foundation](https://www.fsf.org/about/ways-to-donate/)
at 1PC9aZC4hNX2rmmrt7uHTfYAS3hRbph4UN

![alt text](https://static.fsf.org/nosvn/images/bitcoin_qrcodes/fsf.png "FSF Bitcoin Address")

## Making changes

Please do not make modifications to `bip39-standalone.html`, since they will
be overwritten by `compile.py`.

Make changes in `src/*`.

Changes are applied during release using the command `python compile.py`, so
please do not commit changes to `bip39-standalone.html`

# Tests

Tests depend on

* nodejs
* selenium webdriver - cd /path/to/bip39/tests; npm install
* selenium driver for firefox ([geckodriver](https://github.com/mozilla/geckodriver/releases)) and / or chrome ([chromedriver](https://sites.google.com/a/chromium.org/chromedriver/downloads))
* jasmine - npm install --global jasmine

Before running tests, the site must be served at http://localhost:8000.

```
$ cd /path/to/bip39/src
$ python -m http.server

or for python2
$ python -m SimpleHTTPServer
```

Run tests from the command-line

```
$ cd /path/to/bip39/tests
$ jasmine spec/tests.js
```

# License

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