Package com.klaytn.caver.wallet.keyring

Class KeyStoreOption

java.lang.Object

com.klaytn.caver.wallet.keyring.KeyStoreOption

public class KeyStoreOption
extends java.lang.Object

Represent a Crypto Option class used when creating KeyStore instance.

Caver supports the following algorithms.

- Cipher algorithm : AES-128-CTR(Counter mode)

- Key derivation algorithm : PBKDF-2 or Scrypt

See Also:

KeyStore, KeyStore.CipherParams, KeyStore.IKdfParams, KeyStore.Pbkdf2KdfParams, KeyStore.ScryptKdfParams

Constructor Summary

Constructors

Constructor	Description
KeyStoreOption(KeyStore.CipherParams cipherParams, com.klaytn.caver.wallet.keyring.KeyStore.IKdfParams kdfParams, java.lang.String address)	Creates an KeyStoreOption instance.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getAddress()	Getter function of address.
KeyStore.CipherParams	getCipherParams()	Getter function of CipherParams.
static KeyStoreOption	getDefaultOptionWithKDF(java.lang.String kdfName)	Creates an KeyStoreOption of each option instance has default value.
static KeyStoreOption	getDefaultOptionWithKDF(java.lang.String kdfName, java.lang.String address)	Create a KeyStoreOption where each option has a default value.
com.klaytn.caver.wallet.keyring.KeyStore.IKdfParams	getKdfParams()	Getter function of KdfParams.
void	setAddress(java.lang.String address)	Setter function of address.
void	setCipherParams(KeyStore.CipherParams cipherParams)	Setter function of CipherParams.
void	setKdfParams(com.klaytn.caver.wallet.keyring.KeyStore.IKdfParams kdfParams)	Setter function of KdfParams.

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyStoreOption

public KeyStoreOption(KeyStore.CipherParams cipherParams,
                      com.klaytn.caver.wallet.keyring.KeyStore.IKdfParams kdfParams,
                      java.lang.String address)

Creates an KeyStoreOption instance.

Parameters:

cipherParams - Cipher option.(Key encrypt / decrypt)

kdfParams - Key derivation algorithm option.

address - An address.

Method Detail

getDefaultOptionWithKDF

public static KeyStoreOption getDefaultOptionWithKDF(java.lang.String kdfName)

Creates an KeyStoreOption of each option instance has default value.

Address is automatically set to null.

Example :
 
 KeyStoreOption option = KeyStoreOption.getDefaultOptionWithKDF("pbkdf2");
 
 

Parameters:

kdfName - Key derivation algorithm name. you can use "pbkdf2" or "scrypt".

Returns:

KeyStoreOption

getDefaultOptionWithKDF

public static KeyStoreOption getDefaultOptionWithKDF(java.lang.String kdfName,
                                                     java.lang.String address)

Create a KeyStoreOption where each option has a default value.

Example :
 
 String address = "0x{address}";
 KeyStoreOption option = KeyStoreOption.getDefaultOptionWithKDF("pbkdf2", address);
 
 

Parameters:

kdfName - Key derivation algorithm name. you can use "pbkdf2" or "scrypt".

address - An address.

Returns:

KeyStoreOption

getCipherParams

public KeyStore.CipherParams getCipherParams()

Getter function of CipherParams.

Returns:

KeyStore.CipherParams

getKdfParams

public com.klaytn.caver.wallet.keyring.KeyStore.IKdfParams getKdfParams()

Getter function of KdfParams.

Returns:

KeyStore.KdfParams

getAddress

public java.lang.String getAddress()

Getter function of address.

Returns:

String

setCipherParams

public void setCipherParams(KeyStore.CipherParams cipherParams)

Setter function of CipherParams.

Parameters:

cipherParams - KeyStore.CipherParams.

setKdfParams

public void setKdfParams(com.klaytn.caver.wallet.keyring.KeyStore.IKdfParams kdfParams)

Setter function of KdfParams.

Parameters:

kdfParams - KeyStore.KdfParams.

setAddress

public void setAddress(java.lang.String address)

Setter function of address.

Parameters:

address - An address.