bip39

Documentation

Overview

package bip39 represents and converts bitcoin bip39 mnemonic phrases.

Index

• Constants
• Variables
• func Checksum(entropy []byte) byte
• func LabelFor(w Word) string
• func MnemonicSeed(m Mnemonic, password string) []byte
• type Mnemonic
  • func ParseMnemonic(mnemonic string) (Mnemonic, error)
  • func (m Mnemonic) Entropy() []byte
  • func (m Mnemonic) FixChecksum() Mnemonic
  • func (m Mnemonic) Valid() bool
• type Roll
• type Word
  • func ChecksumWord(entropy []byte) Word
  • func ClosestWord(word string) (Word, bool)
  • func DiceToWord(roll Roll) (Word, bool)
  • func RandomWord() Word

Constants

const LongestWord = 8

const NumWords = Word(len(index))

const ShortestWord = 3

Variables

var ErrInvalidChecksum = errors.New("bip39: invalid checksum")

Functions

func Checksum

func Checksum(entropy []byte) byte

func LabelFor

func LabelFor(w Word) string

func MnemonicSeed

func MnemonicSeed(m Mnemonic, password string) []byte

Types

type Mnemonic

type Mnemonic []Word

func ParseMnemonic

func ParseMnemonic(mnemonic string) (Mnemonic, error)

func (Mnemonic) Entropy

func (m Mnemonic) Entropy() []byte

Entropy returns the entropy represented by the mnemonic. It panics if the mnemonic is invalid.

func (Mnemonic) FixChecksum

func (m Mnemonic) FixChecksum() Mnemonic

FixChecksum returns a copy of the mnemonic with a correct checksum. This method defeats the purpose of the bip39 checksum, so it should only be used for generating new mnemonics.

func (Mnemonic) Valid

func (m Mnemonic) Valid() bool

Valid reports whether the mnemonic checksum is correct.

type Roll

type Roll [5]int

type Word

type Word int

func ChecksumWord

func ChecksumWord(entropy []byte) Word

func ClosestWord

func ClosestWord(word string) (Word, bool)

func DiceToWord

func DiceToWord(roll Roll) (Word, bool)

DiceToWord converts a dice roll to its bip39 word index. It returns false if the roll doesn't have a word defined.

func RandomWord

func RandomWord() Word