Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ebellocchia/go-bip39
BIP39 implementation for mnemonic generation/validation and seed generation in Go language
https://github.com/ebellocchia/go-bip39
bip39 bitcoin cryptocurrency go go-package golang golang-package mnemonic mnemonic-phrase
Last synced: 19 days ago
JSON representation
BIP39 implementation for mnemonic generation/validation and seed generation in Go language
- Host: GitHub
- URL: https://github.com/ebellocchia/go-bip39
- Owner: ebellocchia
- License: mit
- Created: 2020-04-22T18:14:03.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-12-31T21:38:27.000Z (almost 3 years ago)
- Last Synced: 2024-10-15T22:19:21.198Z (about 1 month ago)
- Topics: bip39, bitcoin, cryptocurrency, go, go-package, golang, golang-package, mnemonic, mnemonic-phrase
- Language: Go
- Size: 21.5 KB
- Stars: 2
- Watchers: 2
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Bip39 package
[](https://travis-ci.com/ebellocchia/go-bip39)
[](https://codecov.io/gh/ebellocchia/go-bip39)
[](https://raw.githubusercontent.com/ebellocchia/go-bip39/master/LICENSE)
## Introduction
This package implements the [BIP-0039](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki) specification. This includes:
- Mnemonic generation from a specified number of words, using random entropy
- Mnemonic generation from a specified entropy
- Mnemonic validation
- Seed generation from a mnemonic with a specified passphrase
**NOTE:** only the English words list is currently supported.
## Installation
The package can be installed by simply running:
go get -u github.com/ebellocchia/go-bip39
## Usage
The package is pretty easy to use, so a code example is probably self-explanatory.
**Example**
package main
import (
"github.com/ebellocchia/go-bip39"
"fmt"
"encoding/hex"
)
func main() {
// Generate a random entropy with the specified number of bits
// An error is returned if the entropy bit length is not valid
entropy, err := bip39.GenerateEntropy(bip39.EntropyBits128)
if err != nil {
panic(err)
}
fmt.Println(hex.EncodeToString(entropy))
// Generate a mnemonic from the entropy
// An error is returned if the entropy bit length is not valid
mnemonic, err := bip39.MnemonicFromEntropy(entropy)
if err != nil {
panic(err)
}
fmt.Println(mnemonic.Words)
// Generate a mnemonic with a specified number of words (a random entropy will be generated internally)
// An error is returned if the number of words is not valid
mnemonic, err = bip39.MnemonicFromWordsNum(bip39.WordsNum12)
if err != nil {
panic(err)
}
fmt.Println(mnemonic.Words)
// Create a mnemonic directly from an existent string
mnemonic = bip39.MnemonicFromString("legal winner thank year wave sausage worth useful legal winner thank yellow")
fmt.Println(mnemonic.Words)
// Get entropy back from the mnemonic
// An error is returned if the mnemonic is not valid
entropy, err = mnemonic.ToEntropy()
if err != nil {
panic(err)
}
fmt.Println(hex.EncodeToString(entropy))
// Validate a mnemonic, return an error if not valid
err = mnemonic.Validate()
if err != nil {
panic(err)
}
// Get if the mnemonic is valid. Same of before but bool is returned instead of error.
is_valid := mnemonic.IsValid()
if !is_valid {
// Do something...
}
// Generate a seed from the mnemonic using the specified passphrase (can be also empty)
// An error is returned if the mnemonic is not valid
seed, err := mnemonic.GenerateSeed("my_passphrase")
if err != nil {
panic(err)
}
fmt.Println(hex.EncodeToString(seed))
}
The valid bit lengths for entropy generation are:
- *bip39.EntropyBits128*
- *bip39.EntropyBits160*
- *bip39.EntropyBits192*
- *bip39.EntropyBits224*
- *bip39.EntropyBits256*
The valid words number for mnemonic generation are:
- *bip39.WordsNum12*
- *bip39.WordsNum15*
- *bip39.WordsNum18*
- *bip39.WordsNum21*
- *bip39.WordsNum24*
## License
This software is available under the MIT license.