Package convex.core.crypto

Class Mnemonic

java.lang.Object

convex.core.crypto.Mnemonic

public class Mnemonic
extends Object

Static utility functions for Mnemonic encoding

Constructor Summary

Constructors

Constructor	Description
Mnemonic()

Method Summary

Modifier and Type	Method	Description
static String	createSecureRandom()	Create a secure random mnemonic string
static byte[]	decode(String phrase, int bitLength)	Decode from a Mnemonic string
static <T extends AKeyPair> T	decodeKeyPair(String mnemonic)	Create a keypair from a mnemonic string
static <T extends AKeyPair> T	decodeKeyPair(String mnemonic, String passphrase)	Create a keypair from a mnemonic string
static String	encode(byte[] data)	Encode bytes as a mnemonic string
static String	encode(BigInteger x, int bitLength)	Encode bytes as a mnemonic string

Methods inherited from class java.lang.Object

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

Constructor Details

Mnemonic

public Mnemonic()

Method Details

encode

public static String encode(byte[] data)

Encode bytes as a mnemonic string

Parameters:

data - Byte array to encode

Returns:

Mnemonic String

encode

public static String encode(BigInteger x,
 int bitLength)

Encode bytes as a mnemonic string

Parameters:

x - Bytes to encode

bitLength - Length of key to encode

Returns:

Mnemonic String

decode

public static byte[] decode(String phrase,
 int bitLength)

Decode from a Mnemonic string

Parameters:

phrase - Mnemonic string

bitLength - Bits to extract

Returns:

Decoded byte array

createSecureRandom

public static String createSecureRandom()

Create a secure random mnemonic string

Returns:

Mnemonic String

decodeKeyPair

public static <T extends AKeyPair> T decodeKeyPair(String mnemonic)

Create a keypair from a mnemonic string

Parameters:

mnemonic - RFC1751 mnemonic string

Returns:

Key pair instance

decodeKeyPair

public static <T extends AKeyPair> T decodeKeyPair(String mnemonic,
 String passphrase)

Create a keypair from a mnemonic string

Parameters:

mnemonic - RFC1751 mnemonic string

passphrase - Additional passphrase for specific key (may be null / empty)

Returns:

Key pair instance