Package org.xrpl.xrpl4j.crypto.keys

Class PrivateKey

java.lang.Object

org.xrpl.xrpl4j.crypto.keys.PrivateKey

All Implemented Interfaces:

Destroyable, PrivateKeyable

public class PrivateKey
extends Object
implements PrivateKeyable, Destroyable

A typed instance of an XRPL private-key.

Field Summary

Fields

Modifier and Type	Field	Description
static final UnsignedByte	ED2559_PREFIX	Private keys (whether from the ed25519 or secp256k1 curves) have 32 bytes naturally.
static final UnsignedByte	PREFIX	Deprecated. This value will be removed in a future version.
static final UnsignedByte	SECP256K1_PREFIX	Private keys (whether from the ed25519 or secp256k1 curves) have 32 bytes naturally.

Method Summary

Modifier and Type	Method	Description
final void	destroy()
boolean	equals(Object obj)
static PrivateKey	fromNaturalBytes(UnsignedByteArray value, KeyType keyType)	Instantiates a new instance of PrivateKey using the supplied 32 bytes and specified key type.
static PrivateKey	fromPrefixedBytes(UnsignedByteArray value)	Instantiates a new instance of PrivateKey using the supplied bytes by inspecting the first byte out of 33 to see which KeyType to assign.
int	hashCode()
final boolean	isDestroyed()
final KeyType	keyType()	The type of this key (either KeyType.ED25519 or KeyType.SECP256K1).
UnsignedByteArray	naturalBytes()	Accessor for the byte value in value() but in a more natural form (i.e., the size of the returned value will be 32 bytes).
static PrivateKey	of(UnsignedByteArray value)	Deprecated. This method will be removed in a future version.
UnsignedByteArray	prefixedBytes()	Accessor for the bytes of this private key in a prefixed.
String	toString()
UnsignedByteArray	value()	Deprecated. Prefer prefixedBytes() or naturalBytes() instead.

Methods inherited from class java.lang.Object

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

Field Details

PREFIX

@Deprecated
public static final UnsignedByte PREFIX

Deprecated.

This value will be removed in a future version. Prefer ED2559_PREFIX or SECP256K1_PREFIX instead.

A one-byte prefix for ed25519 keys.

ED2559_PREFIX

public static final UnsignedByte ED2559_PREFIX

Private keys (whether from the ed25519 or secp256k1 curves) have 32 bytes naturally. At the same time, secp256k1 public keys have 33 bytes naturally, whereas ed25519 public keys have 32 bytes naturally. Because of this, in XRPL, ed25519 public keys are prefixed with a one-byte prefix (i.e., 0xED). For consistency, this library (and other XRPL tooling) also prepends all private keys with artificial prefixes (0xED for ed25519 or 0x00 for secp256k1). This value is the one-byte prefix for ed25519 keys.

SECP256K1_PREFIX

public static final UnsignedByte SECP256K1_PREFIX

Private keys (whether from the ed25519 or secp256k1 curves) have 32 bytes naturally. At the same time, secp256k1 public keys have 33 bytes naturally, whereas ed25519 public keys have 32 bytes naturally. Because of this, in XRPL, ed25519 public keys are prefixed with a one-byte prefix (i.e., 0xED). For consistency, this library (and other XRPL tooling) also prepends all private keys with artificial prefixes (0xED for ed25519 or 0x00 for secp256k1). This value is the one-byte prefix for secp256k1 keys.

Method Details

fromNaturalBytes

public static PrivateKey fromNaturalBytes(UnsignedByteArray value,
 KeyType keyType)

Instantiates a new instance of PrivateKey using the supplied 32 bytes and specified key type.

Parameters:

value - An UnsignedByteArray containing a private key's natural bytes (i.e., 32 bytes).

keyType - A KeyType for this private key.

Returns:

A PrivateKey.

fromPrefixedBytes

public static PrivateKey fromPrefixedBytes(UnsignedByteArray value)

Instantiates a new instance of PrivateKey using the supplied bytes by inspecting the first byte out of 33 to see which KeyType to assign.

Parameters:

value - An UnsignedByteArray containing a private key's natural bytes (i.e., 32 bytes).

Returns:

A PrivateKey.

of

@Deprecated
public static PrivateKey of(UnsignedByteArray value)

Deprecated.

This method will be removed in a future version. Prefer fromPrefixedBytes(UnsignedByteArray) instead.

Instantiates a new instance of PrivateKey using the supplied bytes by inspecting the first byte out of 33 to see which KeyType to assign.

Parameters:

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

Returns:

A PrivateKey.

value

@Deprecated
public UnsignedByteArray value()

Deprecated.

Prefer prefixedBytes() or naturalBytes() instead.

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

Returns:

An instance of UnsignedByteArray.

naturalBytes

public UnsignedByteArray naturalBytes()

Accessor for the byte value in value() but in a more natural form (i.e., the size of the returned value will be 32 bytes). Natural ed25519 or secp256k1 private keys will ordinarily contain only 32 bytes. However, in XRPL, private keys are represented with a single-byte prefix (i.e., `0xED` for ed25519 and `0x00` for secp256k1 keys).

Returns:

An instance of UnsignedByteArray.

prefixedBytes

public UnsignedByteArray prefixedBytes()

Accessor for the bytes of this private key in a prefixed. Natural ed25519 or secp256k1 private keys will ordinarily contain only 32 bytes. However, in XRPL, private keys are typically represented with a single-byte prefix (i.e., `0xED` for ed25519 and `0x00` for secp256k1 keys), which this method provides.

Returns:

An instance of UnsignedByteArray.

keyType

public final KeyType keyType()

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

Specified by:

keyType in interface PrivateKeyable

Returns:

A KeyType.

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

toString

public String toString()

Overrides:

toString in class Object