io.github.novacrypto.bip39

Class MnemonicValidator

java.lang.Object

io.github.novacrypto.bip39.MnemonicValidator

public final class MnemonicValidator
extends java.lang.Object

Contains function for validating Mnemonics against the BIP0039 spec.

Method Summary

Modifier and Type	Method and Description
static MnemonicValidator	ofWordList(WordList wordList) Get a Mnemonic validator for the given word list.
void	validate(java.lang.CharSequence mnemonic) Check that the supplied mnemonic fits the BIP0039 spec.
void	validate(java.util.Collection<? extends java.lang.CharSequence> mnemonic) Check that the supplied mnemonic fits the BIP0039 spec.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

ofWordList

public static MnemonicValidator ofWordList(WordList wordList)

Get a Mnemonic validator for the given word list. No normalization is currently performed, this is an open issue: https://github.com/NovaCrypto/BIP39/issues/13

Parameters:

wordList - A WordList implementation

Returns:

A validator

validate

public void validate(java.lang.CharSequence mnemonic)
              throws InvalidChecksumException,
                     InvalidWordCountException,
                     WordNotFoundException,
                     UnexpectedWhiteSpaceException

Check that the supplied mnemonic fits the BIP0039 spec.

Parameters:

mnemonic - The memorable list of words

Throws:

InvalidChecksumException - If the last bytes don't match the expected last bytes

InvalidWordCountException - If the number of words is not a multiple of 3, 24 or fewer

WordNotFoundException - If a word in the mnemonic is not present in the word list

UnexpectedWhiteSpaceException - Occurs if one of the supplied words is empty, e.g. a double space

validate

public void validate(java.util.Collection<? extends java.lang.CharSequence> mnemonic)
              throws InvalidChecksumException,
                     InvalidWordCountException,
                     WordNotFoundException,
                     UnexpectedWhiteSpaceException

Check that the supplied mnemonic fits the BIP0039 spec.

The purpose of this method overload is to avoid constructing a mnemonic String if you have gathered a list of words from the user.

Parameters:

mnemonic - The memorable list of words

Throws:

InvalidChecksumException - If the last bytes don't match the expected last bytes

InvalidWordCountException - If the number of words is not a multiple of 3, 24 or fewer

WordNotFoundException - If a word in the mnemonic is not present in the word list

UnexpectedWhiteSpaceException - Occurs if one of the supplied words is empty