mnemonic

README

This folder contains the main bulk of the package source code. The file mnemonic.go defines the public API functions, utils.go defines internal helper functions, mnemonic_erorrs.go defines the various errors messages and mnemonic_test.go contains the tests.

Documentation

Overview

Package mnemonic provides three exported functions for creating and verifying BIP39 phrases and seeds according to https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki.

Index

• func EntropyToPhraseAndSeed(entropy, passphrase, wlFile string) (phrase, seed string, err error)
• func PhraseToEntropyAndSeed(phrase, passphrase, wlFile string) (string, string, error)
• func VerifyPhraseAndSeed(phrase, passphrase, seed string) (bool, error)

Functions

func EntropyToPhraseAndSeed

func EntropyToPhraseAndSeed(entropy, passphrase,
	wlFile string) (phrase, seed string, err error)

EntropyToPhraseAndSeed accepts entropy, optional passphrase and path to the word file. It then creates the phrase and the seed.

func PhraseToEntropyAndSeed

func PhraseToEntropyAndSeed(phrase, passphrase,
	wlFile string) (string, string, error)

PhraseToEntropyAndSeed take the phrase, optional passphrase and path to the word file. It then creates the entropy and the seed.

func VerifyPhraseAndSeed

func VerifyPhraseAndSeed(phrase, passphrase, seed string) (bool, error)

VerifyPhraseAndSeed takes phrase, optional passphrase and a seed checks if the phrase generates the same seed using the passphrase.