bip39

package

v0.1.8 Latest Latest Go to latest Published: Sep 1, 2023 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/LinX-OpenNetwork/coinutil

Links

Open Source Insights

Documentation ¶

Index ¶

func BitLengthToWordLength(bitLength uint) (uint, error)
func GetWord(lang Language, index int64) (string, error)
func WordLengthToBitLength(n uint) (uint, error)
type Language
type Mnemonic
- func New(ent []byte, lang Language) (*Mnemonic, error)
- func NewRandom(length int, lang Language) (*Mnemonic, error)
- func (m *Mnemonic) GenerateSeed(passphrase string) *Seed
- func (m *Mnemonic) Sentence() string
type Seed
- func NewSeed(sentence string, passphrase string) *Seed
- func (s *Seed) String() string
- func (s *Seed) ToHex() string

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func BitLengthToWordLength ¶

func BitLengthToWordLength(bitLength uint) (uint, error)

BitLengthToWordLength returns the length of words for specified bit-length.

func GetWord ¶

func GetWord(lang Language, index int64) (string, error)

GetWord returns a word for the given language at the index

func WordLengthToBitLength ¶

func WordLengthToBitLength(n uint) (uint, error)

WordLengthToBitLength returns the length in bits for specified word length.

Types ¶

type Language ¶

type Language string

Language type indicates supported mnemonic languages

const (
	// English language
	English Language = "english"

	// Japanese language
	Japanese Language = "japanese"

	// Korean language
	Korean Language = "korean"

	// Spanish language
	Spanish Language = "spanish"

	// ChineseSimplified language
	ChineseSimplified Language = "chineseSimplified"

	// ChineseTraditional language
	ChineseTraditional Language = "chineseTraditional"

	// French Language
	French Language = "french"

	// Italian Language
	Italian Language = "italian"
)

type Mnemonic ¶

type Mnemonic struct {
	Words    []string
	Language Language
}

Mnemonic represents a collection of human readable words used for HD wallet seed generation

func New ¶

func New(ent []byte, lang Language) (*Mnemonic, error)

New returns a new Mnemonic for the given entropy and language

func NewRandom ¶

func NewRandom(length int, lang Language) (*Mnemonic, error)

NewRandom returns a new Mnemonic with random entropy of the given length in bits

func (*Mnemonic) GenerateSeed ¶

func (m *Mnemonic) GenerateSeed(passphrase string) *Seed

GenerateSeed returns a seed used for wallet generation per BIP-0032 or similar method. The internal Words set of the Mnemonic will be used

func (*Mnemonic) Sentence ¶

func (m *Mnemonic) Sentence() string

Sentence returns a Mnemonic's word collection as a space separated sentence

type Seed ¶

type Seed struct {
	Bytes []byte
}

Seed represents a binary seed used for HD wallet generation

func NewSeed ¶

func NewSeed(sentence string, passphrase string) *Seed

NewSeed creae a new Seed with the given sentence and passphrase

func (*Seed) String ¶

func (s *Seed) String() string

func (*Seed) ToHex ¶

func (s *Seed) ToHex() string

ToHex returns the seed bytes as a hex encoded string

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL