mnemonic

Documentation

Overview

Package bip39 is the official 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

• Variables
• func EntropyFromMnemonic(mnemonic string, language string) ([]byte, error)
• func IsMnemonicValid(mnemonic string, language string) bool
• func NewEntropy(bitSize int) ([]byte, error)
• func NewMnemonic(entropy []byte, language string) (string, error)
• func SetWordList(language string) ([]string, error)
• func SetWordMap(language string) (map[string]int, error)

Variables

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

	// ErrLanguageTypeUnsupported is return when find incorrect language type
	ErrLanguageTypeUnsupported = errors.New("Language Type Unsupported")
)

Functions

func EntropyFromMnemonic

func EntropyFromMnemonic(mnemonic string, language string) ([]byte, error)

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

func IsMnemonicValid

func IsMnemonicValid(mnemonic string, language 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 NewEntropy

func NewEntropy(bitSize int) ([]byte, 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, language string) (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.

func SetWordList

func SetWordList(language string) ([]string, error)

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

func SetWordMap

func SetWordMap(language string) (map[string]int, error)

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