Package org.xrpl.xrpl4j.crypto.signing.bc

Class BcDerivedKeySignatureService

java.lang.Object

org.xrpl.xrpl4j.crypto.signing.bc.BcDerivedKeySignatureService

All Implemented Interfaces:

SignatureService<PrivateKeyReference>, TransactionSigner<PrivateKeyReference>, TransactionVerifier

public class BcDerivedKeySignatureService
extends Object
implements SignatureService<PrivateKeyReference>

An implementation of SignatureService that uses an in-memory secret value to deterministically create a seed value that can then be used to generate XRPL private keys. This implementation keeps a cache of instances of SignatureService that it delegates to based upon the PrivateKeyReference supplied on each call.

WARNING: This implementation stores private seed-generation material in-memory. Depending on your security requirements, consider a different implementation of SignatureService.

Constructor Summary

Constructors

Constructor	Description
BcDerivedKeySignatureService(ServerSecretSupplier serverSecretSupplier)	Required-args Constructor.
BcDerivedKeySignatureService(ServerSecretSupplier serverSecretSupplier, com.github.benmanes.caffeine.cache.CaffeineSpec caffeineSpec)	Required-args Constructor.

Method Summary

Modifier and Type	Method	Description
PublicKey	derivePublicKey(PrivateKeyReference privateKeyable)	Accessor for the public-key corresponding to the supplied key meta-data.
<T extends Transaction> Signature	multiSign(PrivateKeyReference privateKeyReference, T transaction)	Get a signature for the supplied unsigned transaction using the supplied TransactionSigner.
Signature	multiSignInner(PrivateKeyReference privateKeyable, Batch batchTransaction)	Obtain a multi-signature for a batch transaction using the supplied TransactionSigner.
<T extends Transaction> Signer	multiSignToSigner(PrivateKeyReference privateKeyable, T transaction)	Obtain a signature for the supplied unsigned transaction using the supplied TransactionSigner.
Signature	sign(PrivateKeyReference privateKeyReference, UnsignedClaim unsignedClaim)	Signs a claim for usage in a Payment Channel.
Signature	sign(PrivateKeyReference privateKeyReference, Attestation attestation)	Sign attestations for cross-chain account creation or transfers.
<T extends Transaction> SingleSignedTransaction<T>	sign(PrivateKeyReference privateKeyReference, T transaction)	Get a transaction with a single-sig using privateKeyable.
Signature	signInner(PrivateKeyReference privateKeyable, Batch batchTransaction)	Get a signature for a batch transaction using the supplied TransactionSigner.
<T extends Transaction> boolean	verify(Signer signer, T unsignedTransaction)	Verify the supplied digital-signature to ensure that it was constructed using the private-key corresponding to signerPublicKey.
<T extends Transaction> boolean	verifyMultiSigned(Set<Signer> signerSet, T unsignedTransaction, int minSigners)	Verify that minSigners from the collection of public keys have supplied signatures for a given signed transaction.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xrpl.xrpl4j.crypto.signing.TransactionVerifier

verifyMultiSigned

Constructor Details

BcDerivedKeySignatureService

public BcDerivedKeySignatureService(ServerSecretSupplier serverSecretSupplier)

Required-args Constructor.

Parameters:

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

BcDerivedKeySignatureService

public BcDerivedKeySignatureService(ServerSecretSupplier serverSecretSupplier,
 com.github.benmanes.caffeine.cache.CaffeineSpec caffeineSpec)

Required-args Constructor.

Parameters:

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

caffeineSpec - A CaffeineSpec that can be initialized externally to configure the Caffeine cache constructed by this service.

Method Details

derivePublicKey

public PublicKey derivePublicKey(PrivateKeyReference privateKeyable)

Description copied from interface: TransactionSigner

Accessor for the public-key corresponding to the supplied key meta-data. This method exists to support implementations that hold private-key material internally yet need a way for external callers to determine the actual public key for signature verification or other purposes.

Specified by:

derivePublicKey in interface TransactionSigner<PrivateKeyReference>

Parameters:

privateKeyable - A PrivateKeyable to derive a public key from.

Returns:

A PublicKey.

sign

public <T extends Transaction>
SingleSignedTransaction<T> sign(PrivateKeyReference privateKeyReference,
 T transaction)

Description copied from interface: TransactionSigner

Get a transaction with a single-sig using privateKeyable.

Specified by:

sign in interface TransactionSigner<PrivateKeyReference>

Type Parameters:

T - The type Transaction to be signed.

Parameters:

privateKeyReference - The TransactionSigner used to sign transaction.

transaction - The Transaction to sign.

Returns:

A SingleSignedTransaction of type TransactionSigner containing everything related to a signed transaction.

sign

public Signature sign(PrivateKeyReference privateKeyReference,
 UnsignedClaim unsignedClaim)

Description copied from interface: TransactionSigner

Signs a claim for usage in a Payment Channel.

Specified by:

sign in interface TransactionSigner<PrivateKeyReference>

Parameters:

privateKeyReference - A TransactionSigner used for signing.

unsignedClaim - An UnsignedClaim.

Returns:

A Signature.

sign

public Signature sign(PrivateKeyReference privateKeyReference,
 Attestation attestation)

Description copied from interface: TransactionSigner

Sign attestations for cross-chain account creation or transfers.

This method will be marked Beta until the featureXChainBridge amendment is enabled on mainnet. Its API is subject to change.

Specified by:

sign in interface TransactionSigner<PrivateKeyReference>

Parameters:

privateKeyReference - The TransactionSigner used to sign attestation.

attestation - An Attestation to sign.

Returns:

A Signature.

multiSign

public <T extends Transaction> Signature multiSign(PrivateKeyReference privateKeyReference,
 T transaction)

Description copied from interface: TransactionSigner

Get a signature for the supplied unsigned transaction using the supplied TransactionSigner. The primary reason this method's signature diverges from TransactionSigner.sign(PrivateKeyable, Transaction) is that for multi-sign scenarios, the interstitially signed transaction is always discarded. Instead, a quorum of signatures is needed, and then that quorum is submitted to the ledger with the unsigned transaction. Thus, getting a multi-signed transaction here is not useful and is not returned from this interface. Note that SignatureUtils can be used to assemble and obtain the bytes for a multi-signed transaction (these diverge slightly from the bytes of a single-signed transaction).

Specified by:

multiSign in interface TransactionSigner<PrivateKeyReference>

Type Parameters:

T - The type of the transaction to be signed.

Parameters:

privateKeyReference - The TransactionSigner used to sign transaction.

transaction - The Transaction to sign.

Returns:

A Signature for the transaction.

signInner

public Signature signInner(PrivateKeyReference privateKeyable,
 Batch batchTransaction)

Description copied from interface: TransactionSigner

Get a signature for a batch transaction using the supplied TransactionSigner.

Per XLS-0056, BatchSigners sign a specific format: HashPrefix::batch + flags + count + inner tx IDs. This differs from both single-signing and multi-signing.

This method will be marked Beta until the featureBatch amendment is enabled on mainnet. Its API is subject to change.

Specified by:

signInner in interface TransactionSigner<PrivateKeyReference>

Parameters:

privateKeyable - The TransactionSigner used to sign batchTransaction.

batchTransaction - The Batch transaction to sign.

Returns:

A Signature for the batch transaction.

multiSignInner

public Signature multiSignInner(PrivateKeyReference privateKeyable,
 Batch batchTransaction)

Description copied from interface: TransactionSigner

Obtain a multi-signature for a batch transaction using the supplied TransactionSigner.

This is used when a multi-sig account acts as a BatchSigner with nested Signers. Per rippled's checkBatchMultiSign, this uses batch serialization (HashPrefix::batch + flags + count + tx IDs) followed by appending the signer's account ID.

This method will be marked Beta until the featureBatch amendment is enabled on mainnet. Its API is subject to change.

Specified by:

multiSignInner in interface TransactionSigner<PrivateKeyReference>

Parameters:

privateKeyable - The TransactionSigner used to sign batchTransaction.

batchTransaction - The Batch transaction to sign.

Returns:

A Signature for the batch transaction with multi-sig format.

multiSignToSigner

public <T extends Transaction> Signer multiSignToSigner(PrivateKeyReference privateKeyable,
 T transaction)

Description copied from interface: TransactionSigner

Obtain a signature for the supplied unsigned transaction using the supplied TransactionSigner.

As is the case with TransactionSigner.multiSign(PrivateKeyable, Transaction), the primary reason this method's signature diverges from TransactionSigner.sign(PrivateKeyable, Transaction) is that for multi-sign scenarios, the interstitially signed transaction is always discarded. Instead, a quorum of signatures is need and then that quorum is submitted to the ledger with the unsigned transaction. Thus, obtaining a multi-signed transaction here is not useful and is not returned from this interface. Note that SignatureUtils can be used to assemble and obtain the bytes for a multi-signed transaction (these diverge slightly from the bytes of a single-signed transaction).

This method is nearly identical to TransactionSigner.multiSign(PrivateKeyable, Transaction) except that its return-type is a Signer, which is more convenient for submitting transactions to the XRP Ledger. Note however that this method internally calls TransactionSigner.derivePublicKey(PrivateKeyable), which in certain remote-key configurations (e.g., storing keys in a remote HSM) involves a potentially expensive remote call to the HSM. In most scenarios, the public key will already be available, so callers of this method should consider using TransactionSigner.multiSign(PrivateKeyable, Transaction) instead if public-key derivation is a performance concern.

Specified by:

multiSignToSigner in interface TransactionSigner<PrivateKeyReference>

Type Parameters:

T - The type of the transaction to be signed.

Parameters:

privateKeyable - The TransactionSigner used to sign transaction.

transaction - The Transaction to sign.

Returns:

A Signature for the transaction.

verify

public <T extends Transaction> boolean verify(Signer signer,
 T unsignedTransaction)

Description copied from interface: TransactionVerifier

Verify the supplied digital-signature to ensure that it was constructed using the private-key corresponding to signerPublicKey.

Specified by:

verify in interface TransactionVerifier

Type Parameters:

T - The actual type of Transaction.

Parameters:

signer - A Signer used for verification.

unsignedTransaction - The Transaction of type TransactionVerifier that was signed.

Returns:

true if the signature is valid and verified; false otherwise.

verifyMultiSigned

public <T extends Transaction> boolean verifyMultiSigned(Set<Signer> signerSet,
 T unsignedTransaction,
 int minSigners)

Description copied from interface: TransactionVerifier

Verify that minSigners from the collection of public keys have supplied signatures for a given signed transaction.

Specified by:

verifyMultiSigned in interface TransactionVerifier

Type Parameters:

T - The actual type of Transaction.

Parameters:

signerSet - A Set of Signer objects used for verification.

unsignedTransaction - The transaction of type TransactionVerifier that was signed.

minSigners - The minimum number of signatures required to form a quorum.

Returns:

true if a minimum number of signatures are valid for the supplied transaction; false otherwise.