Package org.web3j.crypto

Class WalletUtils

java.lang.Object

org.web3j.crypto.WalletUtils

Direct Known Subclasses:

Bip44WalletUtils

public class WalletUtils
extends Object

Utility functions for working with Wallet files.

Constructor Summary

Constructors

Constructor	Description
WalletUtils()

Method Summary

Modifier and Type	Method	Description
static org.web3j.crypto.Bip39Wallet	generateBip39Wallet(String password, File destinationDirectory)	Generates a BIP-39 compatible Ethereum wallet.
static org.web3j.crypto.Bip39Wallet	generateBip39WalletFromMnemonic(String password, String mnemonic, File destinationDirectory)	Generates a BIP-39 compatible Ethereum wallet using a mnemonic passed as argument.
static String	generateFullNewWalletFile(String password, File destinationDirectory)
static String	generateLightNewWalletFile(String password, File destinationDirectory)
static String	generateNewWalletFile(String password, File destinationDirectory)
static String	generateNewWalletFile(String password, File destinationDirectory, boolean useFullScrypt)
static String	generateWalletFile(String password, org.web3j.crypto.ECKeyPair ecKeyPair, File destinationDirectory, boolean useFullScrypt)
static String	getDefaultKeyDirectory()
static String	getMainnetKeyDirectory()
static String	getRinkebyKeyDirectory()	Get keystore destination directory for a Rinkeby network.
static String	getTestnetKeyDirectory()
static boolean	isValidAddress(String input)
static boolean	isValidAddress(String input, int addressLength)
static boolean	isValidPrivateKey(String privateKey)
static org.web3j.crypto.Credentials	loadBip39Credentials(String password, String mnemonic)
static org.web3j.crypto.Credentials	loadCredentials(String password, File source)
static org.web3j.crypto.Credentials	loadCredentials(String password, String source)
static org.web3j.crypto.Credentials	loadJsonCredentials(String password, String content)	Load credentials from JSON wallet string.

Methods inherited from class java.lang.Object

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

Constructor Details

WalletUtils

public WalletUtils()

Method Details

generateFullNewWalletFile

public static String generateFullNewWalletFile(String password,
 File destinationDirectory)
                                        throws NoSuchAlgorithmException,
NoSuchProviderException,
InvalidAlgorithmParameterException,
org.web3j.crypto.CipherException,
IOException

Throws:

NoSuchAlgorithmException

NoSuchProviderException

InvalidAlgorithmParameterException

org.web3j.crypto.CipherException

IOException

generateLightNewWalletFile

public static String generateLightNewWalletFile(String password,
 File destinationDirectory)
                                         throws NoSuchAlgorithmException,
NoSuchProviderException,
InvalidAlgorithmParameterException,
org.web3j.crypto.CipherException,
IOException

Throws:

NoSuchAlgorithmException

NoSuchProviderException

InvalidAlgorithmParameterException

org.web3j.crypto.CipherException

IOException

generateNewWalletFile

public static String generateNewWalletFile(String password,
 File destinationDirectory)
                                    throws org.web3j.crypto.CipherException,
InvalidAlgorithmParameterException,
NoSuchAlgorithmException,
NoSuchProviderException,
IOException

Throws:

org.web3j.crypto.CipherException

InvalidAlgorithmParameterException

NoSuchAlgorithmException

NoSuchProviderException

IOException

generateNewWalletFile

public static String generateNewWalletFile(String password,
 File destinationDirectory,
 boolean useFullScrypt)
                                    throws org.web3j.crypto.CipherException,
IOException,
InvalidAlgorithmParameterException,
NoSuchAlgorithmException,
NoSuchProviderException

Throws:

org.web3j.crypto.CipherException

IOException

InvalidAlgorithmParameterException

NoSuchAlgorithmException

NoSuchProviderException

generateWalletFile

public static String generateWalletFile(String password,
 org.web3j.crypto.ECKeyPair ecKeyPair,
 File destinationDirectory,
 boolean useFullScrypt)
                                 throws org.web3j.crypto.CipherException,
IOException

Throws:

org.web3j.crypto.CipherException

IOException

generateBip39Wallet

public static org.web3j.crypto.Bip39Wallet generateBip39Wallet(String password,
 File destinationDirectory)
                                                        throws org.web3j.crypto.CipherException,
IOException

Generates a BIP-39 compatible Ethereum wallet. The private key for the wallet can be calculated using following algorithm:

     Key = SHA-256(BIP_39_SEED(mnemonic, password))
 

Parameters:

password - Will be used for both wallet encryption and passphrase for BIP-39 seed

destinationDirectory - The directory containing the wallet

Returns:

A BIP-39 compatible Ethereum wallet

Throws:

org.web3j.crypto.CipherException - if the underlying cipher is not available

IOException - if the destination cannot be written to

generateBip39WalletFromMnemonic

public static org.web3j.crypto.Bip39Wallet generateBip39WalletFromMnemonic(String password,
 String mnemonic,
 File destinationDirectory)
                                                                    throws org.web3j.crypto.CipherException,
IOException

Generates a BIP-39 compatible Ethereum wallet using a mnemonic passed as argument.

Parameters:

password - Will be used for both wallet encryption and passphrase for BIP-39 seed

mnemonic - The mnemonic that will be used to generate the seed

destinationDirectory - The directory containing the wallet

Returns:

A BIP-39 compatible Ethereum wallet

Throws:

org.web3j.crypto.CipherException - if the underlying cipher is not available

IOException - if the destination cannot be written to

loadCredentials

public static org.web3j.crypto.Credentials loadCredentials(String password,
 String source)
                                                    throws IOException,
org.web3j.crypto.CipherException

Throws:

IOException

org.web3j.crypto.CipherException

loadCredentials

public static org.web3j.crypto.Credentials loadCredentials(String password,
 File source)
                                                    throws IOException,
org.web3j.crypto.CipherException

Throws:

IOException

org.web3j.crypto.CipherException

loadBip39Credentials

public static org.web3j.crypto.Credentials loadBip39Credentials(String password,
 String mnemonic)

loadJsonCredentials

public static org.web3j.crypto.Credentials loadJsonCredentials(String password,
 String content)
                                                        throws IOException,
org.web3j.crypto.CipherException

Load credentials from JSON wallet string.

Parameters:

password - - password to decrypt JSON wallet string

content - - JSON wallet content string

Returns:

Ethereum credentials

Throws:

org.web3j.crypto.CipherException - if the underlying cipher is not available

IOException - if a low-level I/O problem (unexpected end-of-input, network error) occurs

getDefaultKeyDirectory

public static String getDefaultKeyDirectory()

getTestnetKeyDirectory

public static String getTestnetKeyDirectory()

getMainnetKeyDirectory

public static String getMainnetKeyDirectory()

getRinkebyKeyDirectory

public static String getRinkebyKeyDirectory()

Get keystore destination directory for a Rinkeby network.

Returns:

a String containing destination directory

isValidPrivateKey

public static boolean isValidPrivateKey(String privateKey)

isValidAddress

public static boolean isValidAddress(String input)

isValidAddress

public static boolean isValidAddress(String input,
 int addressLength)