bip39

Documentation

Overview

Package bip39 implements the non-generation portions of BIP-39 "Mnemonic code for generating deterministic keys".

Index

• Variables
• func ExpandWord(prefix string) (string, error)
• func GetEntropyBits(l int) (int, error)
• func MnemonicToSeed(passphrase, mnemonic []byte) []byte
• func ValidateAndExpandMnemonic(raw []byte) ([]byte, error)

Variables

var ErrAmbiguous = fmt.Errorf("bip39: ambiguous mnemonic word")

ErrAmbiguous is the error returned when a mnemonic word is ambiguous.

Functions

func ExpandWord

func ExpandWord(prefix string) (string, error)

ExpandWord expands a potentially abreviated mnemonic word to the full word.

func GetEntropyBits

func GetEntropyBits(l int) (int, error)

GetEntropyBits returns the amount of entropy in a given number of words, in bits.

func MnemonicToSeed

func MnemonicToSeed(passphrase, mnemonic []byte) []byte

MnemonicToSeed converts from a mnemonic to a seed. Note that the mnemonic should be validated and fixed-up with ValidateAndExpandMnemonic prior to being converted to a seed.

func ValidateAndExpandMnemonic

func ValidateAndExpandMnemonic(raw []byte) ([]byte, error)

ValidateAndExpandMnemonic expands abbreviated 4-character prefixes to their full words, validates the mnemonic for correctness, and returns the full mnemonic suitable for seed derivation.