A golang implementation of the BIP-39 specification.
In order to download the package you need to run:
$ go get github.com/quapka/PA193_mnemonic_aller/pkg/mnemonic
The project wraps some go build and go install calls in make calls.
Along with the package there is a simple command line interface, that allows you to use the full functionality of the library. However, this utility is not intended for production, rather serves as an example.
$ ./bip39 --help
Usage:
-entropy string
Entropy to get phrase and seed (can't be set with --phrase)
-passphrase string
Passphrase to get phrase and seed
-phrase string
Phrase to get entropy and seed (can't be set with --entropy)
-seed string
Seed to be provided with phrase to verify them (requires --phrase to be set)
-wordlist string
Path to wordlist (required)
$ ./bip39 --entropy "$(python -c "print '00' * 16")" --passphrase "TREZOR" --wordlist ../wordlists/english.txt
From entropy: 00000000000000000000000000000000
From passphrase: TREZOR
Phrase: abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about
Seed: c55257c360c07c72029aebc1b53c05ed0362ada38ead3e3e9efa3708e53495531f09a6987599d18264c1e1c92f2cf141630c7a3c4ab7c81b2f001698e7463b04
In order to build the utility run:
# the executable will end up in the ./bin folder
$ make bip39
# or create the binary locally
$ cd cmd/bip39 && go build .
The API consists of simply three functions. You can see the signatures here. In order to
func EntropyToPhraseAndSeed(entropy, passphrase, dictFilepath string) (phrase, seed string, err error)
func PhraseToEntropyAndSeed(phrase, passphrase, wlfile string) (string, string, error)
func VerifyPhraseAndSeed(phrase, passphrase, seed string) (bool, error)
There are three examples located in examples/ directory. Each subfolder contains example code using one of the functions of the API. You can either build the examples separately by running go build . inside the directory e.g.:
$ cd examples/entropy-to-phrase-and-seed
$ go build .
Or build them using make:
# build all examples at once
$ make build-examples
# build only one exapmle
$ make verify-phrase-and-seed
In case you have godoc tool you can view the documentation nicely by running:
godoc --http=localhost:6060
which will create a local websever, where you can search for this package.
In order to run test you can write make test and should observe similar output:
$ make test
go test -v ./pkg/mnemonic/*.go
=== RUN TestPbkdf2Sha512
--- PASS: TestPbkdf2Sha512 (0.17s)
=== RUN TestEntropyIsNotEmpty
--- PASS: TestEntropyIsNotEmpty (0.00s)
=== RUN TestENTIsInRange
--- PASS: TestENTIsInRange (0.00s)
=== RUN TestENTIsMultipleOf32
--- PASS: TestENTIsMultipleOf32 (0.00s)
=== RUN TestEntropyIsHexadecimal
--- PASS: TestEntropyIsHexadecimal (0.00s)
=== RUN TestCannotOpenWordlistFile
--- PASS: TestCannotOpenWordlistFile (0.00s)
=== RUN TestFunc_cleanInputEntropy
--- PASS: TestFunc_cleanInputEntropy (0.00s)
=== RUN TestFunc_getBinaryLength
--- PASS: TestFunc_getBinaryLength (0.00s)
=== RUN TestFunc_calculateCheckSum
--- PASS: TestFunc_calculateCheckSum (0.00s)
=== RUN TestFunc_convertToBinary
--- PASS: TestFunc_convertToBinary (0.00s)
=== RUN TestFunc_createGroups
--- PASS: TestFunc_createGroups (0.00s)
=== RUN TestFunc_createIndices
--- PASS: TestFunc_createIndices (0.00s)
=== RUN TestFunc_createPhraseWords
--- PASS: TestFunc_createPhraseWords (0.00s)
=== RUN TestFunc_loadWordList
--- PASS: TestFunc_loadWordList (0.01s)
=== RUN TestFunc_cleanLine
--- PASS: TestFunc_cleanLine (0.00s)
=== RUN TestFunc_validateWord
--- PASS: TestFunc_validateWord (0.00s)
=== RUN TestFunc_validateWordlist
--- PASS: TestFunc_validateWordlist (0.00s)
=== RUN TestPhraseToEntropyAndSeed
--- PASS: TestPhraseToEntropyAndSeed (0.08s)
=== RUN TestEntropyToPhraseAndSeed
--- PASS: TestEntropyToPhraseAndSeed (0.26s)
=== RUN TestVerifyPhraseAndSeed
--- PASS: TestVerifyPhraseAndSeed (0.07s)
PASS
ok command-line-arguments (cached)
In case you want to make a contribution, please, open an issue and give a succint and clear explanation of what is wrong (and how to reproduce it) or what you want to improve (and why). Adding a minimal code example when necessary. Be prepared to be asked for more details in case they are deemed necessary in order to debug the issue. If you create a new functionality, make sure you (unit) test it first.
The test vectors come from the Python implementation made by the Trezor team: https://github.com/trezor/python-mnemonic/blob/master/vectors.json
The English wordlist (in worldlists/english.txt) is from the BIP-39 spec.