bip39

README

go-bip39

A golang implementation of the BIP0039 spec for mnemonic seeds

Credits

English wordlist and test vectors are from the standard Python BIP0039 implementation from the Trezor guys: https://github.com/trezor/python-mnemonic

Example

package main

import (
  "github.com/tyler-smith/go-bip39"
  "github.com/tyler-smith/go-bip32"
  "fmt"
)

func main(){
  // Generate a mnemonic for memorization or user-friendly seeds
  entropy, _ := bip39.NewEntropy(256)
  mnemonic, _ := bip39.NewMnemonic(entropy)

  // Generate a Bip32 HD wallet for the mnemonic and a user supplied password
  seed := bip39.NewSeed(mnemonic, "Secret Passphrase")

  masterKey, _ := bip32.NewMasterKey(seed)
  publicKey := masterKey.PublicKey()

  // Display mnemonic and keys
  fmt.Println("Mnemonic: ", mnemonic)
  fmt.Println("Master private key: ", masterKey)
  fmt.Println("Master public key: ", publicKey)
}

Documentation

Index

• Variables
• func IsMnemonicValid(mnemonic string) bool
• func MnemonicToByteArray(mnemonic string) ([]byte, error)
• func NewEntropy(bitSize int) ([]byte, error)
• func NewMnemonic(entropy []byte) (string, error)
• func NewSeed(mnemonic string, password string) []byte
• func NewSeedWithErrorChecking(mnemonic string, password string) ([]byte, error)

Variables

var (
	Last11BitsMask          = big.NewInt(2047)
	RightShift11BitsDivider = big.NewInt(2048)
	BigOne                  = big.NewInt(1)
	BigTwo                  = big.NewInt(2)
)

Some bitwise operands for working with big.Ints

var EnglishWordList = strings.Split(englishWordList, "\n")

Language-specific wordlists

var ReverseWordMap map[string]int = map[string]int{}

var WordList = EnglishWordList

The wordlist to use

Functions

func IsMnemonicValid

func IsMnemonicValid(mnemonic string) bool

func MnemonicToByteArray

func MnemonicToByteArray(mnemonic string) ([]byte, error)

func NewEntropy

func NewEntropy(bitSize int) ([]byte, error)

func NewMnemonic

func NewMnemonic(entropy []byte) (string, error)

func NewSeed

func NewSeed(mnemonic string, password string) []byte

func NewSeedWithErrorChecking

func NewSeedWithErrorChecking(mnemonic string, password string) ([]byte, error)