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

Class AbstractDelegatedTransactionSigner

java.lang.Object

org.xrpl.xrpl4j.crypto.core.signing.AbstractDelegatedTransactionSigner

All Implemented Interfaces:

DelegatedPublicKeyProvider, DelegatedTransactionSigner

public abstract class AbstractDelegatedTransactionSigner
extends Object
implements DelegatedTransactionSigner

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

Constructor Summary

Constructors

Constructor	Description
AbstractDelegatedTransactionSigner(SignatureUtils signatureUtils, AddressUtils addressService)	Required-args Constructor.

Method Summary

Modifier and Type	Method	Description
protected abstract Signature	ecDsaSign(KeyMetadata privateKeyMetadata, UnsignedByteArray signableTransactionBytes)	Does the actual work of computing a signature using a secp256k1 private-key, as locatable using privateKeyMetadata.
protected abstract Signature	edDsaSign(KeyMetadata privateKeyMetadata, UnsignedByteArray signableTransactionBytes)	Does the actual work of computing a signature using a ed25519 private-key, as locatable using privateKeyMetadata.
<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.

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.core.signing.DelegatedPublicKeyProvider

getPublicKey

Constructor Details

AbstractDelegatedTransactionSigner

public AbstractDelegatedTransactionSigner(SignatureUtils signatureUtils,
 AddressUtils addressService)

Required-args Constructor.

Parameters:

signatureUtils - An SignatureUtils for help with signing.

addressService - An AddressUtils.

Method Details

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.

edDsaSign

protected abstract Signature edDsaSign(KeyMetadata privateKeyMetadata,
 UnsignedByteArray signableTransactionBytes)

Does the actual work of computing a signature using a ed25519 private-key, as locatable using privateKeyMetadata.

Parameters:

privateKeyMetadata - A KeyMetadata to describe the private-key to use for signing.

signableTransactionBytes - A UnsignedByteArray to sign.

Returns:

A Signature with data that can be used to submit a transaction to the XRP Ledger.

ecDsaSign

protected abstract Signature ecDsaSign(KeyMetadata privateKeyMetadata,
 UnsignedByteArray signableTransactionBytes)

Does the actual work of computing a signature using a secp256k1 private-key, as locatable using privateKeyMetadata.

Parameters:

privateKeyMetadata - A KeyMetadata to describe the private-key to use for signing.

signableTransactionBytes - A UnsignedByteArray to sign.

Returns:

A Signature with data that can be used to submit a transaction to the XRP Ledger.