hera.api

Interface KeyStoreOperation

All Known Implementing Classes:

KeyStoreTemplate

@ApiAudience.Public
 @ApiStability.Unstable
public interface KeyStoreOperation

Provide server keystore related operations. It provides followings:

• create / lookup stored accounts
• locking / unlocking account
• sign raw transaction with unlocked account
• importing / exporting account

Method Summary

Modifier and Type	Method and Description
AccountAddress	create(java.lang.String password) Create an account with a password.
EncryptedPrivateKey	exportKey(Authentication authentication) Export an encrypted private key of account which is stored in a server key store.
AccountAddress	importKey(EncryptedPrivateKey encryptedKey, java.lang.String oldPassword, java.lang.String newPassword) Import an encrypted private key to a server key store.
java.util.List<AccountAddress>	list() Get account list on a key store.
boolean	lock(Authentication authentication) Lock a private key of account which is stored in a server key store.
Transaction	sign(RawTransaction rawTransaction) Sign for transaction.
boolean	unlock(Authentication authentication) Unlock a private key of account which is stored in a server key store.

Method Detail

list

java.util.List<AccountAddress> list()

Get account list on a key store.

Returns:

account list

create

AccountAddress create(java.lang.String password)

Create an account with a password. The private key is stored in a server key store.

Parameters:

password - a password to encrypt private key

Returns:

created account

lock

boolean lock(Authentication authentication)

Lock a private key of account which is stored in a server key store.

Parameters:

authentication - an authentication to lock

Returns:

lock result

unlock

boolean unlock(Authentication authentication)

Unlock a private key of account which is stored in a server key store.

Parameters:

authentication - an authentication to unlock

Returns:

unlock result

sign

Transaction sign(RawTransaction rawTransaction)

Sign for transaction. A sender of transaction should be unlocked.

Parameters:

rawTransaction - raw transaction to sign

Returns:

signed transaction

importKey

AccountAddress importKey(EncryptedPrivateKey encryptedKey,
                         java.lang.String oldPassword,
                         java.lang.String newPassword)

Import an encrypted private key to a server key store. An oldPassword is used to decrypt passed private key. An newPassword is used to store private key as encrypted state in a server.

Parameters:

encryptedKey - an encrypted private key

oldPassword - an old password to decrypt encrypted private key

newPassword - an new password to encrypt passed private key in a server keystore

Returns:

an imported account

exportKey

EncryptedPrivateKey exportKey(Authentication authentication)

Export an encrypted private key of account which is stored in a server key store. An encrypt password is set from authentication

Parameters:

authentication - an authentication of stored account

Returns:

an encrypted private key