bip39

Documentation

Overview

Package bip39 is the Golang implementation of the BIP39 spec.

The official BIP39 spec can be found at https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki

Index

• Constants
• Variables
• func EntropyFromMnemonic(mnemonic string) ([]byte, stack.Error)
• func GenerateSecureEntropy(entropyBits uint16) ([]byte, error)
• func GetWordIndexFromTree(word string) (int, bool)
• func GetWordList() []string
• func HasWord(word string) bool
• func IsMnemonicValid(mnemonic string) bool
• func MnemonicToByteArray(mnemonic string, raw ...bool) ([]byte, stack.Error)
• func NewEntropy(bitSize int) ([]byte, stack.Error)
• func NewMnemonic(entropy []byte) (string, stack.Error)
• func NewSeed(mnemonic string, password string) []byte
• func NewSeedWithErrorChecking(mnemonic string, password string) ([]byte, stack.Error)
• func NewSeedWithParams(mnemonic []byte, password []byte, iterations int, keyLength int, ...) []byte
• func SetWordList(language string)

Examples

• NewMnemonic
• NewSeed

Constants

const (
	ChineseSimplified  = "chinese-simplified"
	ChineseTraditional = "chinese-traditional"
	English            = "english"
	French             = "french"
	Italian            = "italian"
	Japanese           = "japanese"
	Korean             = "korean"
	Spanish            = "spanish"
)

supported language names

Variables

var (

	// ErrInvalidMnemonic is returned when trying to use a malformed mnemonic.
	ErrInvalidMnemonic = stack.New("invalid mnenomic due to malformed input")

	// ErrEntropyLengthInvalid is returned when trying to use an entropy set with
	// an invalid size.
	ErrEntropyLengthInvalid = stack.New("entropy length must be [128, 256] and a multiple of 32")

	// ErrValidatedSeedLengthMismatch is returned when a validated seed is not the
	// same size as the given seed. This should never happen is present only as a
	// sanity assertion.
	ErrValidatedSeedLengthMismatch = stack.New("seed length does not match validated seed length")

	// ErrChecksumIncorrect is returned when entropy has the incorrect checksum.
	ErrChecksumIncorrect = stack.New("checksum incorrect")
)

Functions

func EntropyFromMnemonic

func EntropyFromMnemonic(mnemonic string) ([]byte, stack.Error)

EntropyFromMnemonic takes a mnemonic generated by this library, and returns the input entropy used to generate the given mnemonic. An stack is returned if the given mnemonic is invalid.

func GenerateSecureEntropy

func GenerateSecureEntropy(entropyBits uint16) ([]byte, error)

NewEntropy will create random entropy bytes so long as the requested size bitSize is an appropriate size.

bitSize is the size of entropy bytes requested

func GetWordIndexFromTree

func GetWordIndexFromTree(word string) (int, bool)

GetWordIndex gets word index in wordMap.

func GetWordList

func GetWordList() []string

GetWordList gets the list of words to use for mnemonics.

func HasWord

func HasWord(word string) bool

func IsMnemonicValid

func IsMnemonicValid(mnemonic string) bool

IsMnemonicValid attempts to verify that the provided mnemonic is valid. Validity is determined by both the number of words being appropriate, and that all the words in the mnemonic are present in the word list.

func MnemonicToByteArray

func MnemonicToByteArray(mnemonic string, raw ...bool) ([]byte, stack.Error)

MnemonicToByteArray takes a mnemonic string and turns it into a byte array suitable for creating another mnemonic. An error is returned if the mnemonic is invalid.

func NewEntropy

func NewEntropy(bitSize int) ([]byte, stack.Error)

NewEntropy will create random entropy bytes so long as the requested size bitSize is an appropriate size.

bitSize has to be a multiple 32 and be within the inclusive range of {128, 256}

func NewMnemonic

func NewMnemonic(entropy []byte) (string, stack.Error)

NewMnemonic will return a string consisting of the mnemonic words for the given entropy. If the provide entropy is invalid, an stack error will be returned.

Example

package main

import (
	"encoding/hex"
	"fmt"

	"github.com/zerjioang/gotools/lib/bip39"
)

func main() {
	// the entropy can be any byte slice, generated how pleased,
	// as long its bit size is a multiple of 32 and is within
	// the inclusive range of {128,256}
	entropy, _ := hex.DecodeString("066dca1a2bb7e8a1db2832148ce9933eea0f3ac9548d793112d9a95c9407efad")

	// generate a mnemomic
	/*
		128 bits -> 12 words
		160 bits -> 15 words
		192 bits -> 18 words
		224 bits -> 21 words
		256 bits -> 24 words
	*/
	mnemomic, serr := bip39.NewMnemonic(entropy)
	fmt.Println(serr)
	fmt.Println(mnemomic)
}

Output:

all hour make first leader extend hole alien behind guard gospel lava path output census museum junior mass reopen famous sing advance salt reform

func NewSeed

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

NewSeed creates a hashed seed output given a provided string and password. No checking is performed to validate that the string provided is a valid mnemonic.

Example

package main

import (
	"encoding/hex"
	"fmt"

	"github.com/zerjioang/gotools/lib/bip39"
)

func main() {
	seed := bip39.NewSeed("all hour make first leader extend hole alien behind guard gospel lava path output census museum junior mass reopen famous sing advance salt reform", "TREZOR")
	fmt.Println(hex.EncodeToString(seed))
}

Output:

26e975ec644423f4a4c4f4215ef09b4bd7ef924e85d1d17c4cf3f136c2863cf6df0a475045652c57eb5fb41513ca2a2d67722b77e954b4b3fc11f7590449191d

func NewSeedWithErrorChecking

func NewSeedWithErrorChecking(mnemonic string, password string) ([]byte, stack.Error)

NewSeedWithErrorChecking creates a hashed seed output given the mnemonic string and a password. An stack is returned if the mnemonic is not convertible to a byte array.

func NewSeedWithParams

func NewSeedWithParams(mnemonic []byte, password []byte, iterations int, keyLength int, hashf func() hash.Hash) []byte

NewSeed creates a hashed seed output given a provided string and password. No checking is performed to validate that the string provided is a valid mnemonic.

func SetWordList

func SetWordList(language string)

SetWordList sets the list of words to use for mnemonics. Currently the list that is set is used package-wide.