mnemonic

Documentation

Overview

Package mnemonic provides functions to generate mnemonic phrases.

Index

• Variables
• func FromEntropy(entropy string) (string, error)
• func Generate(wordsNum int) (string, error)
• func GetBip32ExtendedKey(mne, pwd, path string) (key *bip32.Key, err error)

Variables

var (
	// ErrWordsNumberInvalid is returned when trying to generate mnemonic with invalid words number.
	ErrWordsNumberInvalid = errors.New("mnemonic words number must be [12, 24] and a multiple of 3")

	ErrInvalidMnemonic = errors.New("invalid mnemonic")
)

Functions

func FromEntropy

func FromEntropy(entropy string) (string, error)

FromEntropy will return a mnemonic string for the given hex-encoded entropy.

func Generate

func Generate(wordsNum int) (string, error)

Generate will return a mnemonic string constains [wordsNum] words using random entropy.

func GetBip32ExtendedKey

func GetBip32ExtendedKey(mne, pwd, path string) (key *bip32.Key, err error)

GetBip32ExtendedKey derives bip32.Key with specify mnemonic and path.