bip39

Documentation

Index

• Constants
• Variables
• func IsMnemonicValid(mnemonic string) bool
• func MnemonicToByteArray(mnemonic string) ([]byte, error)
• func MustNewDefaultMnemonic() string
• func NewDefaultMnemonic() (string, error)
• func NewEntropy(bitSize int) ([]byte, error)
• func NewMnemonic(entropy []byte) (string, error)

Constants

const DefaultMnemonicEntropyBitSize = 128

DefaultMnemonicEntropyBitSize is the default bit size for NewDefaultMnemonic's entropy

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")

EnglishWordList Language-specific wordlists

var ReverseWordMap = map[string]int{}

ReverseWordMap reverse word map

var WordList = EnglishWordList

WordList The wordlist to use

Functions

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) ([]byte, 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. FIXME This does not work for all values in the test vectors. Namely Vectors 0, 4, and 8. This is not really important because BIP39 doesnt really define a conversion from string to bytes.

func MustNewDefaultMnemonic

func MustNewDefaultMnemonic() string

MustNewDefaultMnemonic returns a generated mnemomic using entropy with bitSize 128 and panics if there is an error

func NewDefaultMnemonic

func NewDefaultMnemonic() (string, error)

NewDefaultMnemonic returns a generated mnemomic using entropy with bitSize 128

func NewEntropy

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

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

func NewMnemonic

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

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