bip39

README

BIP 39: Mnemonic Code for Generating Deterministic Keys

Specification

This BIP describes the implementation of a mnemonic code or mnemonic sentence -- a group of easy to remember words -- for the generation of deterministic wallets.

Documentation

Index

• Variables
• type Entropy
  • func NewEntropy(ent int) (Entropy, error)
  • func (e Entropy) Valid() error
• type Mnemonic
• type Seed
  • func NewSeed(mnemonic Mnemonic, password string) Seed
• type WordList
  • func NewWordList(list []string) WordList
  • func (l WordList) Get(w string) (int, bool)
  • func (l WordList) List() []string
  • func (l WordList) NewMnemonic(ent Entropy) (Mnemonic, error)

Variables

var English = NewWordList(
	strings.Split(
		strings.TrimSpace(english),
		"\n",
	),
)

Types

type Entropy

type Entropy []byte

func NewEntropy

func NewEntropy(ent int) (Entropy, error)

func (Entropy) Valid

func (e Entropy) Valid() error

type Mnemonic

type Mnemonic []string

type Seed

type Seed []byte

func NewSeed

func NewSeed(mnemonic Mnemonic, password string) Seed

type WordList

type WordList struct {
	// contains filtered or unexported fields
}

func NewWordList

func NewWordList(list []string) WordList

func (WordList) Get

func (l WordList) Get(w string) (int, bool)

func (WordList) List

func (l WordList) List() []string

func (WordList) NewMnemonic

func (l WordList) NewMnemonic(ent Entropy) (Mnemonic, error)