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

Class AbstractDelegatedSignatureService

java.lang.Object

org.xrpl.xrpl4j.crypto.core.signing.AbstractDelegatedSignatureService

All Implemented Interfaces:

DelegatedPublicKeyProvider, DelegatedSignatureService, DelegatedTransactionSigner, DelegatedTransactionVerifier

public abstract class AbstractDelegatedSignatureService
extends Object
implements DelegatedSignatureService

An abstract implementation of DelegatedSignatureService with common functionality that sub-classes can utilize.

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor	Description
AbstractDelegatedSignatureService(DelegatedTransactionSigner delegatedTransactionSigner, DelegatedTransactionVerifier delegatedTransactionVerifier)	Required-args constructor.

Method Summary

Modifier and Type	Method	Description
PublicKey	getPublicKey(KeyMetadata keyMetadata)	Accessor for the public-key corresponding to the supplied key meta-data.
<T extends Transaction> Signature	multiSign(KeyMetadata keyMetadata, T transaction)	Obtain a multi-sig signature for the supplied transaction using keyMetadata.
Signature	sign(KeyMetadata keyMetadata, UnsignedClaim unsignedClaim)	Obtain a signature for the supplied unsigned payment channel claim using the private-key that corresponds to keyMetadata.
<T extends Transaction> SingleSingedTransaction<T>	sign(KeyMetadata keyMetadata, T transaction)	Obtain a signature for the supplied transaction using the private-key that corresponds to keyMetadata.
<T extends Transaction> boolean	verifyMultiSigned(Set<SignatureWithKeyMetadata> signatureWithKeyMetadataSet, T unsignedTransaction)	Verify that all signers have properly signed the unsignedTransaction.
<T extends Transaction> boolean	verifyMultiSigned(Set<SignatureWithKeyMetadata> signatureWithKeyMetadataSet, T unsignedTransaction, int minSigners)	Verify that minSigners from the collection of public keys have supplied signatures for the given the unsignedTransaction.
<T extends Transaction> boolean	verifySingleSigned(SignatureWithKeyMetadata signatureWithKeyMetadata, T unsignedTransaction)	TransactionVerifier the supplied digital-signature to ensure that it was constructed using the private-key corresponding to publicKey.

Methods inherited from class java.lang.Object

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

Field Details

logger

protected final org.slf4j.Logger logger

Constructor Details

AbstractDelegatedSignatureService

public AbstractDelegatedSignatureService(DelegatedTransactionSigner delegatedTransactionSigner,
 DelegatedTransactionVerifier delegatedTransactionVerifier)

Required-args constructor.

Parameters:

delegatedTransactionSigner - A DelegatedTransactionSigner to sign transactions.

delegatedTransactionVerifier - A DelegatedTransactionVerifier to verify signatures.

Method Details

getPublicKey

public PublicKey getPublicKey(KeyMetadata keyMetadata)

Description copied from interface: DelegatedPublicKeyProvider

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:

getPublicKey in interface DelegatedPublicKeyProvider

Parameters:

keyMetadata - A KeyMetadata for a key-pair.

Returns:

A PublicKey.

sign

public <T extends Transaction>
SingleSingedTransaction<T> sign(KeyMetadata keyMetadata,
 T transaction)

Description copied from interface: DelegatedTransactionSigner

Obtain a signature for the supplied transaction using the private-key that corresponds to keyMetadata.

Specified by:

sign in interface DelegatedTransactionSigner

Type Parameters:

T - The type of the transaction to be signed.

Parameters:

keyMetadata - A KeyMetadata that describes the public/private Keypair to use for signing operations.

transaction - The Transaction to sign.

Returns:

A SingleSingedTransaction containing binary data that can be submitted to the XRP Ledger in order to effect a transaction.

sign

public Signature sign(KeyMetadata keyMetadata,
 UnsignedClaim unsignedClaim)

Description copied from interface: DelegatedTransactionSigner

Obtain a signature for the supplied unsigned payment channel claim using the private-key that corresponds to keyMetadata.

Specified by:

sign in interface DelegatedTransactionSigner

Parameters:

keyMetadata - A KeyMetadata that describes the public/private Keypair to use for signing operations.

unsignedClaim - The UnsignedClaim to sign.

Returns:

A SingleSingedTransaction containing binary data that can be submitted to the XRP Ledger in order to effect a transaction.

multiSign

public <T extends Transaction> Signature multiSign(KeyMetadata keyMetadata,
 T transaction)

Description copied from interface: DelegatedTransactionSigner

Obtain a multi-sig signature for the supplied transaction using keyMetadata.

Specified by:

multiSign in interface DelegatedTransactionSigner

Type Parameters:

T - The type Transaction to be signed.

Parameters:

keyMetadata - A KeyMetadata that refers to a private key that can be used to sign transaction.

transaction - The Transaction to sign.

Returns:

A SingleSingedTransaction of type DelegatedTransactionSigner containing everything related to a signed transaction.

verifySingleSigned

public <T extends Transaction> boolean verifySingleSigned(SignatureWithKeyMetadata signatureWithKeyMetadata,
 T unsignedTransaction)

Description copied from interface: DelegatedTransactionVerifier

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

Specified by:

verifySingleSigned in interface DelegatedTransactionVerifier

Type Parameters:

T - A Transaction.

Parameters:

signatureWithKeyMetadata - A SignatureWithKeyMetadata that contains a signature and a public key that can be used to verify the transaction signature.

unsignedTransaction - A DelegatedTransactionVerifier that was signed.

Returns:

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

verifyMultiSigned

public <T extends Transaction> boolean verifyMultiSigned(Set<SignatureWithKeyMetadata> signatureWithKeyMetadataSet,
 T unsignedTransaction)

Description copied from interface: DelegatedTransactionVerifier

Verify that all signers have properly signed the unsignedTransaction.

Specified by:

verifyMultiSigned in interface DelegatedTransactionVerifier

Type Parameters:

T - The actual type of Transaction.

Parameters:

signatureWithKeyMetadataSet - A Set of SignatureWithKeyMetadata used for verification.

unsignedTransaction - The Transaction of type DelegatedTransactionVerifier that was signed.

Returns:

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

verifyMultiSigned

public <T extends Transaction> boolean verifyMultiSigned(Set<SignatureWithKeyMetadata> signatureWithKeyMetadataSet,
 T unsignedTransaction,
 int minSigners)

Description copied from interface: DelegatedTransactionVerifier

Verify that minSigners from the collection of public keys have supplied signatures for the given the unsignedTransaction.

Specified by:

verifyMultiSigned in interface DelegatedTransactionVerifier

Type Parameters:

T - The actual type of Transaction.

Parameters:

signatureWithKeyMetadataSet - A Set of SignatureWithKeyMetadata used for verification.

unsignedTransaction - The transaction of type DelegatedTransactionVerifier 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.