one.harmony.cmd

Class Keys

java.lang.Object

one.harmony.cmd.Keys

public class Keys
extends java.lang.Object

Keys class provides the local key management features such as adding a account, import/export keys, delete keystore, etc.

Constructor Summary

Constructors

Constructor and Description
Keys()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	addKey(java.lang.String accountName) addKey method creates a new key in the keystore using the default passphrase (harmony-one) and the automatically generated mnemonics.
static java.lang.String	addKey(java.lang.String accountName, java.lang.String passphrase) addKey method creates a new key in the keystore using the automatically generated mnemonics.
static java.lang.String	addKey(java.lang.String accountName, java.lang.String passphrase, java.lang.String mnemonic) addKey method creates a new key in the local keystore, but requires mnemonics.
static void	cleanKeyStore() cleanKeyStore method clears the local keystore.
static java.lang.String	exportKeyStoreFromAccountName(java.lang.String accountName) Export the keystore file contents using the provided account name and default passphrase (harmony-one)
static java.lang.String	exportKeyStoreFromAccountName(java.lang.String accountName, java.lang.String passphrase) Export the keystore file contents using the provided account name and passpharase.
static java.lang.String	exportKeyStoreFromAddress(java.lang.String oneAddress) Export the keystore file contents using the Harmony one address and default passphrase.
static java.lang.String	exportKeyStoreFromAddress(java.lang.String oneAddress, java.lang.String passphrase) Export the keystore file contents using the Harmony one address and provided passphrase.
static java.lang.String	exportPrivateKeyFromAccountName(java.lang.String accountName) Export the secp256k1 private key using the provided account name and default passphrase.
static java.lang.String	exportPrivateKeyFromAccountName(java.lang.String accountName, java.lang.String passphrase) Export the secp256k1 private key using the provided account name and passphrase.
static java.lang.String	exportPrivateKeyFromAddress(java.lang.String oneAddress) Export the secp256k1 private key using the provided Harmony one address.
static java.lang.String	exportPrivateKeyFromAddress(java.lang.String oneAddress, java.lang.String passphrase) Export the secp256k1 private key using the provided Harmony one address and passphrase.
static java.lang.String	getKeysLocation() getKeysLocation method helps with getting the local keystore location where the keys are stored.
static java.lang.String	importKeyStore(java.lang.String keyFilePath, java.lang.String accountName) importKeyStore method imports an existing keystore key using the provides path and account name, but using the default passphrase (harmony-one).
static java.lang.String	importKeyStore(java.lang.String keyFilePath, java.lang.String accountName, java.lang.String passphrase) importKeyStore method imports an existing keystore key using the provided path, account name, and passphrase.
static java.lang.String	importPrivateKey(java.lang.String secp256k1PRV, java.lang.String accountName) Import an existing keystore key (only accept secp256k1 private keys) and uses the default passphrase.
static java.lang.String	importPrivateKey(java.lang.String secp256k1PRV, java.lang.String accountName, java.lang.String passphrase) Import an existing keystore key (only accept secp256k1 private keys), account name, and passphrase
static java.util.Map<java.lang.String,java.lang.String>	listAccounts()
static boolean	setAccountName(java.lang.String oneAddress, java.lang.String accountName) setAccountName method helps with changing the account name of an already existing account

Methods inherited from class java.lang.Object

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

Constructor Detail

Keys

public Keys()

Method Detail

addKey

public static java.lang.String addKey(java.lang.String accountName,
                                      java.lang.String passphrase,
                                      java.lang.String mnemonic)
                               throws org.web3j.crypto.CipherException,
                                      java.lang.IllegalArgumentException,
                                      java.io.IOException

addKey method creates a new key in the local keystore, but requires mnemonics. If the accountName already exists or the supplied mnemonics is invalid then this method throws an IllegalArgumentException.

Parameters:

accountName -

passphrase -

mnemonic -

Returns:

Throws:

org.web3j.crypto.CipherException

java.lang.IllegalArgumentException

java.io.IOException

addKey

public static java.lang.String addKey(java.lang.String accountName,
                                      java.lang.String passphrase)
                               throws org.web3j.crypto.CipherException,
                                      java.lang.IllegalArgumentException,
                                      java.io.IOException

addKey method creates a new key in the keystore using the automatically generated mnemonics. The generated mnemonics is written to the log file.

Parameters:

accountName -

passphrase -

Returns:

Throws:

org.web3j.crypto.CipherException

java.lang.IllegalArgumentException

java.io.IOException

addKey

public static java.lang.String addKey(java.lang.String accountName)
                               throws org.web3j.crypto.CipherException,
                                      java.lang.IllegalArgumentException,
                                      java.io.IOException

addKey method creates a new key in the keystore using the default passphrase (harmony-one) and the automatically generated mnemonics. The generated mnemonics is written to the log file.

Parameters:

accountName -

Returns:

Throws:

org.web3j.crypto.CipherException

java.lang.IllegalArgumentException

java.io.IOException

importKeyStore

public static java.lang.String importKeyStore(java.lang.String keyFilePath,
                                              java.lang.String accountName)
                                       throws org.web3j.crypto.CipherException,
                                              java.lang.IllegalArgumentException,
                                              java.io.IOException

importKeyStore method imports an existing keystore key using the provides path and account name, but using the default passphrase (harmony-one).

Parameters:

keyFilePath - absolute path to key store file

accountName -

Throws:

org.web3j.crypto.CipherException

java.lang.IllegalArgumentException

java.io.IOException

importKeyStore

public static java.lang.String importKeyStore(java.lang.String keyFilePath,
                                              java.lang.String accountName,
                                              java.lang.String passphrase)
                                       throws org.web3j.crypto.CipherException,
                                              java.lang.IllegalArgumentException,
                                              java.io.IOException

importKeyStore method imports an existing keystore key using the provided path, account name, and passphrase. If the account name already exists, it will throw an IllegalArgumentException exception.

Parameters:

keyFilePath -

accountName -

passphrase -

Throws:

org.web3j.crypto.CipherException

java.lang.IllegalArgumentException

java.io.IOException

importPrivateKey

public static java.lang.String importPrivateKey(java.lang.String secp256k1PRV,
                                                java.lang.String accountName,
                                                java.lang.String passphrase)
                                         throws org.web3j.crypto.CipherException,
                                                java.lang.IllegalArgumentException,
                                                java.io.IOException

Import an existing keystore key (only accept secp256k1 private keys), account name, and passphrase

Parameters:

secp256k1PRV -

accountName -

passphrase -

Returns:

Throws:

org.web3j.crypto.CipherException

java.lang.IllegalArgumentException

java.io.IOException

importPrivateKey

public static java.lang.String importPrivateKey(java.lang.String secp256k1PRV,
                                                java.lang.String accountName)
                                         throws org.web3j.crypto.CipherException,
                                                java.lang.IllegalArgumentException,
                                                java.io.IOException

Import an existing keystore key (only accept secp256k1 private keys) and uses the default passphrase.

Parameters:

secp256k1PRV -

accountName -

Returns:

Throws:

org.web3j.crypto.CipherException

java.lang.IllegalArgumentException

java.io.IOException

exportPrivateKeyFromAddress

public static java.lang.String exportPrivateKeyFromAddress(java.lang.String oneAddress,
                                                           java.lang.String passphrase)
                                                    throws org.web3j.crypto.CipherException,
                                                           com.fasterxml.jackson.core.JsonParseException,
                                                           com.fasterxml.jackson.databind.JsonMappingException,
                                                           java.io.IOException

Export the secp256k1 private key using the provided Harmony one address and passphrase.

Parameters:

oneAddress -

passphrase -

Throws:

org.web3j.crypto.CipherException

java.io.IOException

com.fasterxml.jackson.databind.JsonMappingException

com.fasterxml.jackson.core.JsonParseException

exportPrivateKeyFromAddress

public static java.lang.String exportPrivateKeyFromAddress(java.lang.String oneAddress)
                                                    throws com.fasterxml.jackson.core.JsonParseException,
                                                           com.fasterxml.jackson.databind.JsonMappingException,
                                                           org.web3j.crypto.CipherException,
                                                           java.io.IOException

Export the secp256k1 private key using the provided Harmony one address.

Parameters:

oneAddress -

Throws:

java.io.IOException

org.web3j.crypto.CipherException

com.fasterxml.jackson.databind.JsonMappingException

com.fasterxml.jackson.core.JsonParseException

exportPrivateKeyFromAccountName

public static java.lang.String exportPrivateKeyFromAccountName(java.lang.String accountName,
                                                               java.lang.String passphrase)
                                                        throws org.web3j.crypto.CipherException,
                                                               com.fasterxml.jackson.core.JsonParseException,
                                                               com.fasterxml.jackson.databind.JsonMappingException,
                                                               java.io.IOException

Export the secp256k1 private key using the provided account name and passphrase.

Parameters:

accountName -

passphrase -

Throws:

org.web3j.crypto.CipherException

java.io.IOException

com.fasterxml.jackson.databind.JsonMappingException

com.fasterxml.jackson.core.JsonParseException

exportPrivateKeyFromAccountName

public static java.lang.String exportPrivateKeyFromAccountName(java.lang.String accountName)
                                                        throws com.fasterxml.jackson.core.JsonParseException,
                                                               com.fasterxml.jackson.databind.JsonMappingException,
                                                               org.web3j.crypto.CipherException,
                                                               java.io.IOException

Export the secp256k1 private key using the provided account name and default passphrase.

Parameters:

accountName -

Throws:

java.io.IOException

org.web3j.crypto.CipherException

com.fasterxml.jackson.databind.JsonMappingException

com.fasterxml.jackson.core.JsonParseException

exportKeyStoreFromAddress

public static java.lang.String exportKeyStoreFromAddress(java.lang.String oneAddress,
                                                         java.lang.String passphrase)
                                                  throws com.fasterxml.jackson.core.JsonParseException,
                                                         com.fasterxml.jackson.databind.JsonMappingException,
                                                         java.io.IOException,
                                                         org.web3j.crypto.CipherException

Export the keystore file contents using the Harmony one address and provided passphrase.

Parameters:

oneAddress -

passphrase -

Throws:

java.io.IOException

com.fasterxml.jackson.databind.JsonMappingException

com.fasterxml.jackson.core.JsonParseException

org.web3j.crypto.CipherException

exportKeyStoreFromAddress

public static java.lang.String exportKeyStoreFromAddress(java.lang.String oneAddress)
                                                  throws com.fasterxml.jackson.core.JsonParseException,
                                                         com.fasterxml.jackson.databind.JsonMappingException,
                                                         java.io.IOException,
                                                         org.web3j.crypto.CipherException

Export the keystore file contents using the Harmony one address and default passphrase.

Parameters:

oneAddress -

Throws:

org.web3j.crypto.CipherException

java.io.IOException

com.fasterxml.jackson.databind.JsonMappingException

com.fasterxml.jackson.core.JsonParseException

exportKeyStoreFromAccountName

public static java.lang.String exportKeyStoreFromAccountName(java.lang.String accountName,
                                                             java.lang.String passphrase)
                                                      throws com.fasterxml.jackson.core.JsonParseException,
                                                             com.fasterxml.jackson.databind.JsonMappingException,
                                                             java.io.IOException,
                                                             org.web3j.crypto.CipherException

Export the keystore file contents using the provided account name and passpharase.

Parameters:

accountName -

passphrase -

Throws:

java.io.IOException

com.fasterxml.jackson.databind.JsonMappingException

com.fasterxml.jackson.core.JsonParseException

org.web3j.crypto.CipherException

exportKeyStoreFromAccountName

public static java.lang.String exportKeyStoreFromAccountName(java.lang.String accountName)
                                                      throws com.fasterxml.jackson.core.JsonParseException,
                                                             com.fasterxml.jackson.databind.JsonMappingException,
                                                             java.io.IOException,
                                                             org.web3j.crypto.CipherException

Export the keystore file contents using the provided account name and default passphrase (harmony-one)

Parameters:

oneAddress -

Throws:

org.web3j.crypto.CipherException

java.io.IOException

com.fasterxml.jackson.databind.JsonMappingException

com.fasterxml.jackson.core.JsonParseException

listAccounts

public static java.util.Map<java.lang.String,java.lang.String> listAccounts()

Returns:

map of account names and addresses

getKeysLocation

public static java.lang.String getKeysLocation()

getKeysLocation method helps with getting the local keystore location where the keys are stored.

Returns:

keystore location path

setAccountName

public static boolean setAccountName(java.lang.String oneAddress,
                                     java.lang.String accountName)

setAccountName method helps with changing the account name of an already existing account

Parameters:

oneAddress -

accountName -

Returns:

boolean indicating the status

cleanKeyStore

public static void cleanKeyStore()
                          throws java.io.IOException

cleanKeyStore method clears the local keystore. All accounts will be permanently deleted.

Throws:

java.io.IOException