bip39

Documentation

Overview

Package bip39 is the Golang implementation of the BIP39 spec.

The official BIP39 spec can be found at https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki

Index

• Constants
• Variables
• func EntropyFromMnemonic(mnemonic string) ([]byte, error)
• func GetWordList() []string
• func GetWordListString() string
• func Hello() string
• func IsMnemonicValid(mnemonic string) bool
• func MnemonicToByteArray(mnemonic string, raw ...bool) ([]byte, error)
• func NewEntropy(bitSize int) ([]byte, error)
• func NewMnemonic(entropy []byte) (string, error)
• func NewSeed(mnemonic string, password string) []byte
• func NewSeedWithErrorChecking(mnemonic string, password string) ([]byte, error)
• func SetWordList(list []string)
• func SetWordListLang(lang int) error

Constants

const (
	// LangChineseSimplified 简体中文
	LangChineseSimplified = iota
	// LangChineseTraditional 繁体中文
	LangChineseTraditional
	// LangEnglish 英语
	LangEnglish
	// LangFrench 法语
	LangFrench
	// LangItalian 意大利语
	LangItalian
	// LangJapanese 日文
	LangJapanese
	// LangKorean 韩文
	LangKorean
	// LangSpanish 西班牙语
	LangSpanish
)

Variables

var (
	// ErrInvalidMnemonic is returned when trying to use a malformed mnemonic.
	ErrInvalidMnemonic = errors.New("invalid mnenomic")

	// ErrEntropyLengthInvalid is returned when trying to use an entropy set with
	// an invalid size.
	ErrEntropyLengthInvalid = errors.New("entropy length must be [128, 256] and a multiple of 32")

	// ErrValidatedSeedLengthMismatch is returned when a validated seed is not the
	// same size as the given seed. This should never happen is present only as a
	// sanity assertion.
	ErrValidatedSeedLengthMismatch = errors.New("seed length does not match validated seed length")

	// ErrChecksumIncorrect is returned when entropy has the incorrect checksum.
	ErrChecksumIncorrect = errors.New("checksum incorrect")
)

Functions

func EntropyFromMnemonic

func EntropyFromMnemonic(mnemonic string) ([]byte, error)

EntropyFromMnemonic takes a mnemonic generated by this library, and returns the input entropy used to generate the given mnemonic. An error is returned if the given mnemonic is invalid.

func GetWordList

func GetWordList() []string

GetWordList gets the list of words to use for mnemonics.

func GetWordListString

func GetWordListString() string

GetWordListString 当前词汇表（以,分隔）

func Hello

func Hello() string

Hello 返回简单的hello 字符串，可用于验证api调用

func IsMnemonicValid

func IsMnemonicValid(mnemonic string) 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, raw ...bool) ([]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.

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.

bitSize has to be a multiple 32 and be within the inclusive range of {128, 256}

func NewMnemonic

func NewMnemonic(entropy []byte) (string, error)

NewMnemonic will return a string consisting of the mnemonic words for the given entropy. Words are splitted by one space, eg: 丝 吨 第 序 东 收 供 已 涌 爹 子 览 , bag dentist hero goddess art top picnic load certain neither thumb lift 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) ([]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 SetWordList

func SetWordList(list []string)

SetWordList sets the list of words to use for mnemonics. Currently the list that is set is used package-wide.

func SetWordListLang

func SetWordListLang(lang int) error

SetWordListLang 设置词汇表语言(默认英语)