bip39

Documentation

Index

• Constants
• Variables
• func IsMnemonicValid(mnemonic string, dic *WordDictionary) bool
• func MnemonicToByteArray(mnemonic string, dic *WordDictionary) ([]byte, error)
• func NewEntropy(bitSize int) ([]byte, error)
• func NewMnemonic(entropy []byte, dic *WordDictionary) (string, error)
• func NewSeed(mnemonic string, password string) []byte
• func NewSeedWithErrorChecking(mnemonic string, password string, dic *WordDictionary) ([]byte, error)
• func SetDict(lang string, words string, split string)
• type WordDictionary
  • func ENUS() *WordDictionary
  • func GetDict(lang string) (*WordDictionary, bool)
  • func NewWordDictionary(words string, split string) *WordDictionary

Constants

const (
	BIPPurpose         = 44
	BIPCoinType        = 714
	BIPChange          = false
	BIP44Prefix        = "44'/714'/"
	FullFundraiserPath = BIP44Prefix + "0'/0/0"
)

Variables

var (
	Last11BitsMask          = big.NewInt(2047)
	RightShift11BitsDivider = big.NewInt(2048)
	BigOne                  = big.NewInt(1)
	BigTwo                  = big.NewInt(2)
)

Some bitwise operands for working with big.Ints

Functions

func IsMnemonicValid

func IsMnemonicValid(mnemonic string, dic *WordDictionary) 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 MnemonicToByteArray

func MnemonicToByteArray(mnemonic string, dic *WordDictionary) ([]byte, error)

MnemonicToByteArray takes a mnemonic string and turns it into a byte array suitable for creating another mnemonic. An error is returned if the mnemonic is invalid. FIXME This does not work for all values in the test vectors. Namely Vectors 0, 4, and 8. This is not really important because BIP39 doesnt really define a conversion from string to bytes.

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.

func NewMnemonic

func NewMnemonic(entropy []byte, dic *WordDictionary) (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 NewSeed

func NewSeed(mnemonic string, password string) []byte

NewSeed creates a hashed seed output given a provided string and password. No checking is performed to validate that the string provided is a valid mnemonic.

func NewSeedWithErrorChecking

func NewSeedWithErrorChecking(mnemonic string, password string, dic *WordDictionary) ([]byte, error)

NewSeedWithErrorChecking creates a hashed seed output given the mnemonic string and a password. An error is returned if the mnemonic is not convertible to a byte array.

func SetDict

func SetDict(lang string, words string, split string)

SetDict set language dictionary

Types

type WordDictionary

type WordDictionary struct {
	WordList       []string
	ReverseWordMap map[string]int
}

WordDictionary .

func ENUS

func ENUS() *WordDictionary

ENUS .

func GetDict

func GetDict(lang string) (*WordDictionary, bool)

GetDict .

func NewWordDictionary

func NewWordDictionary(words string, split string) *WordDictionary

NewWordDictionary create new bip39 word dictionary