Package org.xrpl.xrpl4j.crypto.signing

Class DerivedKeysSignatureService

java.lang.Object

org.xrpl.xrpl4j.crypto.signing.DerivedKeysSignatureService

All Implemented Interfaces:

SignatureService, TransactionSigner, TransactionVerifier

public class DerivedKeysSignatureService
extends Object
implements SignatureService

An implementation that uses an in-memory secret key in order to deterministically create a seed value that can then be used to deterministically generate XRPL private keys. Any derived key can then be used for signing XRP transactions. This implementation keeps a cache of instances of SingleKeySignatureService that it delegates to based upon KeyMetadata supplied on each call.

WARNING: This implementation stores private seed-generation material in-memory, and is thus only meant for lower-security environments. For higher security deployments, prefer an HSM-based implementation instead.

Constructor Summary

Constructors

Constructor	Description
DerivedKeysSignatureService(ServerSecretSupplier serverSecretSupplier, VersionType versionType)	Required-args Constructor for use in development mode.
DerivedKeysSignatureService(ServerSecretSupplier serverSecretSupplier, VersionType versionType, KeyPairService keyPairService)	Required-args Constructor.

Method Summary

Modifier and Type	Method	Description
protected SingleKeySignatureService	constructSignatureService(KeyMetadata privateKeyMetadata)	Construct a new SingleKeySignatureService using the provided privateKeyMetadata.
PublicKey	getPublicKey(KeyMetadata keyMetadata)
VersionType	getVersionType()	Accessor for the type of this service.
KeyStoreType	keyStoreType()
SignedTransaction	sign(KeyMetadata keyMetadata, Transaction transaction)
boolean	verify(KeyMetadata keyMetadata, SignedTransaction transactionWithSignature)

Methods inherited from class java.lang.Object

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

Constructor Detail

DerivedKeysSignatureService

public DerivedKeysSignatureService(ServerSecretSupplier serverSecretSupplier,
                                   VersionType versionType)

Required-args Constructor for use in development mode.

Parameters:

serverSecretSupplier - A ServerSecretSupplier that can be used to generate seed values, which can then be used to generate private keys.

versionType - A VersionType that defines which type of key this signature service uses.

DerivedKeysSignatureService

public DerivedKeysSignatureService(ServerSecretSupplier serverSecretSupplier,
                                   VersionType versionType,
                                   KeyPairService keyPairService)

Required-args Constructor.

Parameters:

serverSecretSupplier - A ServerSecretSupplier that can be used to generate seed values, which can

versionType - A VersionType that defines which type of key this signature service uses.

keyPairService - A KeyPairService.

Method Detail

sign

public SignedTransaction sign(KeyMetadata keyMetadata,
                              Transaction transaction)

Specified by:

sign in interface TransactionSigner

keyStoreType

public KeyStoreType keyStoreType()

Specified by:

keyStoreType in interface SignatureService

getPublicKey

public PublicKey getPublicKey(KeyMetadata keyMetadata)

Specified by:

getPublicKey in interface SignatureService

verify

public boolean verify(KeyMetadata keyMetadata,
                      SignedTransaction transactionWithSignature)

Specified by:

verify in interface TransactionVerifier

constructSignatureService

protected SingleKeySignatureService constructSignatureService(KeyMetadata privateKeyMetadata)

Construct a new SingleKeySignatureService using the provided privateKeyMetadata.

Parameters:

privateKeyMetadata - A KeyMetadata with information about a private key.

Returns:

A SingleKeySignatureService.

getVersionType

public VersionType getVersionType()

Accessor for the type of this service.

Returns:

A VersionType.