Package org.xrpl.xrpl4j.crypto.core.signing

Class SignatureUtils

java.lang.Object

org.xrpl.xrpl4j.crypto.core.signing.SignatureUtils

public class SignatureUtils
extends Object

Utility methods to help with generating, validating, and manipulating digital signatures.

Constructor Summary

Constructors

Constructor	Description
SignatureUtils(com.fasterxml.jackson.databind.ObjectMapper objectMapper, XrplBinaryCodec binaryCodec)	Required-args constructor.

Method Summary

Modifier and Type	Method	Description
<T extends Transaction> SingleSingedTransaction<T>	addSignatureToTransaction(T transaction, Signature signature)	Add Transaction.transactionSignature() to the given transaction.
static SignatureUtils	getInstance()	Obtain the singleton instance of SignatureUtils.
UnsignedByteArray	toMultiSignableBytes(Transaction transaction, Address signerAddress)	Helper method to convert a Transaction into bytes that can be signed by multiple signers, as is the case when the source account has set a SignerList.
UnsignedByteArray	toSignableBytes(UnsignedClaim unsignedClaim)	Helper method to convert an UnsignedClaim into bytes that can be used directly for signing.
UnsignedByteArray	toSignableBytes(Transaction transaction)	Helper method to convert a Transaction into bytes that can be used directly for signing.

Methods inherited from class java.lang.Object

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

Constructor Details

SignatureUtils

public SignatureUtils(com.fasterxml.jackson.databind.ObjectMapper objectMapper,
 XrplBinaryCodec binaryCodec)

Required-args constructor.

Parameters:

objectMapper - A ObjectMapper.

binaryCodec - A XrplBinaryCodec.

Method Details

getInstance

public static SignatureUtils getInstance()

Obtain the singleton instance of SignatureUtils.

Returns:

An SignatureUtils.

toSignableBytes

public UnsignedByteArray toSignableBytes(Transaction transaction)

Helper method to convert a Transaction into bytes that can be used directly for signing.

Parameters:

transaction - A Transaction to be signed.

Returns:

An UnsignedByteArray.

toSignableBytes

public UnsignedByteArray toSignableBytes(UnsignedClaim unsignedClaim)

Helper method to convert an UnsignedClaim into bytes that can be used directly for signing.

Parameters:

unsignedClaim - An UnsignedClaim to be signed.

Returns:

An UnsignedByteArray.

toMultiSignableBytes

public UnsignedByteArray toMultiSignableBytes(Transaction transaction,
 Address signerAddress)

Helper method to convert a Transaction into bytes that can be signed by multiple signers, as is the case when the source account has set a SignerList.

Parameters:

transaction - A Transaction to be signed.

signerAddress - The Address of the signer of the transaction.

Returns:

An UnsignedByteArray.

addSignatureToTransaction

public <T extends Transaction>
SingleSingedTransaction<T> addSignatureToTransaction(T transaction,
 Signature signature)

Add Transaction.transactionSignature() to the given transaction. Because Transaction is not an Immutable object, it does not have a generated builder like its subclasses do. Thus, this method needs to rebuild transactions based on their runtime type.

Type Parameters:

T - extends Transaction.

Parameters:

transaction - An unsigned Transaction to add a signature to. Note that Transaction.transactionSignature() must not be provided, and Transaction.signingPublicKey() must be provided.

signature - A Signature containing the transaction signature.

Returns:

A copy of transaction with the Transaction.transactionSignature() field added.