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

Interface PublicKey

All Known Implementing Classes:

ImmutablePublicKey

@Immutable
public interface PublicKey

A typed instance of an XRPL Seed, which can be decoded into an instance of Decoded.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	PublicKey.PublicKeyDeserializer	A custom Jackson deserializer to deserialize PublicKeys from a hex string in JSON.
static class	PublicKey.PublicKeySerializer	A custom Jackson serializer that serializes a PublicKey to a hex-string.

Method Summary

Modifier and Type	Method	Description
default String	base16Value()	The private-key value, as a Base16-encoded (i.e., HEX) string.
default String	base58Value()	The public-key, as a base-58 encoded String.
static ImmutablePublicKey.Builder	builder()	Instantiates a new builder.
static PublicKey	fromBase16EncodedPublicKey(String base16EncodedPublicKey)	Construct a PrivateKey from a base16-encoded (HEX) String.
static PublicKey	fromBase58EncodedPublicKey(String base58EncodedPublicKey)	Construct a PublicKey from a base58-encoded String.
UnsignedByteArray	value()	The key in binary (Note: will be 33 bytes).
default VersionType	versionType()	The type of this key.

Method Details

builder

static ImmutablePublicKey.Builder builder()

Instantiates a new builder.

Returns:

A ImmutablePublicKey.Builder.

fromBase58EncodedPublicKey

static PublicKey fromBase58EncodedPublicKey(String base58EncodedPublicKey)

Construct a PublicKey from a base58-encoded String.

Parameters:

base58EncodedPublicKey - A base58-encoded String.

Returns:

A PrivateKey.

fromBase16EncodedPublicKey

static PublicKey fromBase16EncodedPublicKey(String base16EncodedPublicKey)

Construct a PrivateKey from a base16-encoded (HEX) String.

Parameters:

base16EncodedPublicKey - A base16-encoded (HEX) String.

Returns:

A PrivateKey.

value

UnsignedByteArray value()

The key in binary (Note: will be 33 bytes).

Returns:

An instance of UnsignedByteArray.

base58Value

@Derived
default String base58Value()

The public-key, as a base-58 encoded String.

Returns:

A String.

base16Value

@Derived
default String base16Value()

The private-key value, as a Base16-encoded (i.e., HEX) string. Note that if this is an Ed25519 private-key, then this value contains a leading prefix of `ED`, in hex.

Returns:

A String.

versionType

@Derived
default VersionType versionType()

The type of this key.

Returns:

A VersionType.