Package org.xrpl.xrpl4j.crypto.core.keys

Class PrivateKey

java.lang.Object

org.xrpl.xrpl4j.crypto.core.keys.PrivateKey

All Implemented Interfaces:

Destroyable

public class PrivateKey
extends Object
implements Destroyable

A typed instance of an XRPL private-key.

Field Summary

Fields

Modifier and Type	Field	Description
static final UnsignedByte	PREFIX	Keys generated from the secp256k1 curve have 33 bytes in XRP Ledger.

Method Summary

Modifier and Type	Method	Description
final void	destroy()
boolean	equals(Object obj)
int	hashCode()
final boolean	isDestroyed()
static PrivateKey	of(UnsignedByteArray value)	Instantiates a new instance of a private key using the supplied bytes.
String	sha256()	A SHA-256 hash of the private key material contained in this object.
String	toString()
UnsignedByteArray	value()	Accessor for the key value, in binary (Note: will be 33 bytes).
final VersionType	versionType()	The type of this key (either VersionType.ED25519 or VersionType.SECP256K1).

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

PREFIX

public static final UnsignedByte PREFIX

Keys generated from the secp256k1 curve have 33 bytes in XRP Ledger. However, keys derived from the ed25519 curve have only 32 bytes, and so get prefixed with this HEX value so that all keys in the ledger are 33 bytes.

Method Details

of

public static PrivateKey of(UnsignedByteArray value)

Instantiates a new instance of a private key using the supplied bytes. Note that in order to derive a private key, considering using instances of either WalletFactory or KeyPairService.

Parameters:

value - An UnsignedByteArray containing this key's binary value.

Returns:

A PrivateKey.

value

public UnsignedByteArray value()

Accessor for the key value, in binary (Note: will be 33 bytes).

Returns:

An instance of UnsignedByteArray.

versionType

public final VersionType versionType()

The type of this key (either VersionType.ED25519 or VersionType.SECP256K1).

Returns:

A VersionType.

destroy

public final void destroy()

Specified by:

destroy in interface Destroyable

isDestroyed

public final boolean isDestroyed()

Specified by:

isDestroyed in interface Destroyable

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

sha256

public String sha256()

A SHA-256 hash of the private key material contained in this object.

Returns:

A hex-encoded String representing the hash of this private key.

toString

public String toString()

Overrides:

toString in class Object