Package convex.core.crypto

Class BIP39

java.lang.Object

convex.core.crypto.BIP39

public class BIP39
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MIN_WORDS	Minimum number of words accepted in a mnemonic
static final int	NUM_WORDS
static final int	SEED_LENGTH

Constructor Summary

Constructors

Constructor	Description
BIP39()

Method Summary

Modifier and Type	Method	Description
static String	checkMnemonic(String s)	Return true if the string is a valid mnemonic phrase
static String	createSecureMnemonic()
static String	createSecureMnemonic(int numWords)
static List<String>	createWords(SecureRandom r, int n)	Create a list of random mnemonic words given a random number generator
static Blob	getSeed(String mnemonic, String passphrase)	Gets a BIP39 seed given a mnemonic and passphrase
static Blob	getSeed(List<String> words, String passphrase)	Gets a BIP39 seed given a mnemonic and passphrase
static List<String>	getWords(String mnemonic)	Gets the individual words from a mnemonic String.
static String	mnemonic(List<String> words)	Create a mnemonic String from a list of words, separated by spaces
static String	normalise(String s)
static Blob	seedToEd25519Seed(Blob seed)	Converts a BIP39 seed to an Ed25519 seed.
static AKeyPair	seedToKeyPair(Blob seed)

Methods inherited from class java.lang.Object

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

Field Details

NUM_WORDS

public static final int NUM_WORDS

SEED_LENGTH

public static final int SEED_LENGTH

See Also:

• Constant Field Values

MIN_WORDS

public static final int MIN_WORDS

Minimum number of words accepted in a mnemonic

See Also:

• Constant Field Values

Constructor Details

BIP39

public BIP39()

Method Details

getSeed

public static Blob getSeed(List<String> words,
 String passphrase)
                    throws NoSuchAlgorithmException,
InvalidKeySpecException

Gets a BIP39 seed given a mnemonic and passphrase

Parameters:

words - Mnemonic words

passphrase - Optional BIP39 passphrase

Returns:

Blob containing BIP39 seed (64 bytes)

Throws:

NoSuchAlgorithmException

InvalidKeySpecException

seedToKeyPair

public static AKeyPair seedToKeyPair(Blob seed)

seedToEd25519Seed

public static Blob seedToEd25519Seed(Blob seed)

Converts a BIP39 seed to an Ed25519 seed. This is defined as the SHA3-256 hash of the BIP39 seed Note: longer term users may want hierarchical deterministic wallet generation

Parameters:

seed - BIP39 seed

Returns:

Ed25519 seed as a Blob

checkMnemonic

public static String checkMnemonic(String s)

Return true if the string is a valid mnemonic phrase

Parameters:

s - String to be tested as a mnemonic phrase

Returns:

String containing reason that mnemonic is not valid, or null if OK

getSeed

public static Blob getSeed(String mnemonic,
 String passphrase)

Gets a BIP39 seed given a mnemonic and passphrase

Parameters:

mnemonic - Mnemonic words

passphrase - Optional BIP39 passphrase

Returns:

Blob containing BIP39 seed (64 bytes)

createSecureMnemonic

public static String createSecureMnemonic()

createSecureMnemonic

public static String createSecureMnemonic(int numWords)

createWords

public static List<String> createWords(SecureRandom r,
 int n)

Create a list of random mnemonic words given a random number generator

Parameters:

r - Random number generator instance

n - Number of words to generate

Returns:

List of words

getWords

public static List<String> getWords(String mnemonic)

Gets the individual words from a mnemonic String. Will trim and normalise whitespace, convert to lowercase

Parameters:

mnemonic - Mnemonic String

Returns:

List of words

normalise

public static String normalise(String s)

mnemonic

public static String mnemonic(List<String> words)

Create a mnemonic String from a list of words, separated by spaces

Parameters:

words - List of words for mnemonic

Returns:

Combined mnemonic string