org.lightningj.lnd.wrapper.signer

Class SynchronousSignerAPI

java.lang.Object

org.lightningj.lnd.wrapper.API

org.lightningj.lnd.wrapper.SynchronousAPI

org.lightningj.lnd.wrapper.signer.SynchronousSignerAPI

public class SynchronousSignerAPI
extends SynchronousAPI

API Class for generating synchronous API calls to LDN server using wrapped objects. Created by Philip Vendil.

Field Summary

Fields inherited from class org.lightningj.lnd.wrapper.API

channel, DEFAULT_MAX_INBOUND_MESSAGE_SIZE, log, performValidation, statusExceptionWrapper, wrapperFactory

Constructor Summary

Constructors

Constructor and Description
SynchronousSignerAPI(io.grpc.ManagedChannel channel) Constructor used for setting up a connection using a GRPC managed channel that can be customized.
SynchronousSignerAPI(java.lang.String host, int port, java.io.File trustedServerCertificate, java.io.File macaroonFile) Minimal constructor for setting up a connection with LND Application.
SynchronousSignerAPI(java.lang.String host, int port, io.grpc.netty.shaded.io.netty.handler.ssl.SslContext sslContext, MacaroonContext macaroonContext) Constructor for setting up a connection with LND Application with more flexible SSL context parameters.

Method Summary

Modifier and Type	Method and Description
InputScriptResp	computeInputScript(byte[] rawTxBytes, java.util.List<SignDescriptor> signDescs, java.util.List<TxOut> prevOutputs) Method to generate a computeInputScript request.
InputScriptResp	computeInputScript(SignReq request) Method to send a computeInputScript request.
SharedKeyResponse	deriveSharedKey(byte[] ephemeralPubkey, KeyLocator keyLoc, KeyDescriptor keyDesc) Method to generate a deriveSharedKey request.
SharedKeyResponse	deriveSharedKey(SharedKeyRequest request) Method to send a deriveSharedKey request.
protected SignerGrpc.SignerBlockingStub	getStub()
MuSig2CleanupResponse	muSig2Cleanup(byte[] sessionId) Method to generate a muSig2Cleanup request.
MuSig2CleanupResponse	muSig2Cleanup(MuSig2CleanupRequest request) Method to send a muSig2Cleanup request.
MuSig2CombineKeysResponse	muSig2CombineKeys(java.util.List<byte[]> allSignerPubkeys, java.util.List<TweakDesc> tweaks, TaprootTweakDesc taprootTweak, MuSig2Version version) Method to generate a muSig2CombineKeys request.
MuSig2CombineKeysResponse	muSig2CombineKeys(MuSig2CombineKeysRequest request) Method to send a muSig2CombineKeys request.
MuSig2CombineSigResponse	muSig2CombineSig(byte[] sessionId, java.util.List<byte[]> otherPartialSignatures) Method to generate a muSig2CombineSig request.
MuSig2CombineSigResponse	muSig2CombineSig(MuSig2CombineSigRequest request) Method to send a muSig2CombineSig request.
MuSig2SessionResponse	muSig2CreateSession(KeyLocator keyLoc, java.util.List<byte[]> allSignerPubkeys, java.util.List<byte[]> otherSignerPublicNonces, java.util.List<TweakDesc> tweaks, TaprootTweakDesc taprootTweak, MuSig2Version version, byte[] pregeneratedLocalNonce) Method to generate a muSig2CreateSession request.
MuSig2SessionResponse	muSig2CreateSession(MuSig2SessionRequest request) Method to send a muSig2CreateSession request.
MuSig2RegisterNoncesResponse	muSig2RegisterNonces(byte[] sessionId, java.util.List<byte[]> otherSignerPublicNonces) Method to generate a muSig2RegisterNonces request.
MuSig2RegisterNoncesResponse	muSig2RegisterNonces(MuSig2RegisterNoncesRequest request) Method to send a muSig2RegisterNonces request.
MuSig2SignResponse	muSig2Sign(byte[] sessionId, byte[] messageDigest, java.lang.Boolean cleanup) Method to generate a muSig2Sign request.
MuSig2SignResponse	muSig2Sign(MuSig2SignRequest request) Method to send a muSig2Sign request.
SignMessageResp	signMessage(byte[] msg, KeyLocator keyLoc, java.lang.Boolean doubleHash, java.lang.Boolean compactSig, java.lang.Boolean schnorrSig, byte[] schnorrSigTapTweak) Method to generate a signMessage request.
SignMessageResp	signMessage(SignMessageReq request) Method to send a signMessage request.
SignResp	signOutputRaw(byte[] rawTxBytes, java.util.List<SignDescriptor> signDescs, java.util.List<TxOut> prevOutputs) Method to generate a signOutputRaw request.
SignResp	signOutputRaw(SignReq request) Method to send a signOutputRaw request.
VerifyMessageResp	verifyMessage(byte[] msg, byte[] signature, byte[] pubkey, java.lang.Boolean isSchnorrSig) Method to generate a verifyMessage request.
VerifyMessageResp	verifyMessage(VerifyMessageReq request) Method to send a verifyMessage request.

Methods inherited from class org.lightningj.lnd.wrapper.SynchronousAPI

processRepeatableResponse, processResponse

Methods inherited from class org.lightningj.lnd.wrapper.API

close, isPerformValidation, processRequest, setPerformValidation, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

SynchronousSignerAPI

public SynchronousSignerAPI(java.lang.String host,
                            int port,
                            java.io.File trustedServerCertificate,
                            java.io.File macaroonFile)
                     throws javax.net.ssl.SSLException,
                            ClientSideException

Minimal constructor for setting up a connection with LND Application.

Parameters:

host - the hostname of ldn application

port - the port of the application.

trustedServerCertificate - a link of the SSL certificate used by the LND Application.

macaroonFile - the file pointing to the macaroon to use, or null if no macaroons are used.

Throws:

javax.net.ssl.SSLException - if problems occurred setting up the SSL Connection.

ClientSideException - if problems occurred reading the macaroon file.

SynchronousSignerAPI

public SynchronousSignerAPI(java.lang.String host,
                            int port,
                            io.grpc.netty.shaded.io.netty.handler.ssl.SslContext sslContext,
                            MacaroonContext macaroonContext)

Constructor for setting up a connection with LND Application with more flexible SSL context parameters.

Parameters:

host - the hostname of ldn application

port - the port of the application.

sslContext - the SSL Context used when connecting the LND Application.

macaroonContext - the macaroon context to use.

SynchronousSignerAPI

public SynchronousSignerAPI(io.grpc.ManagedChannel channel)

Constructor used for setting up a connection using a GRPC managed channel that can be customized.

Parameters:

channel - the managed channel to use.

Method Detail

signOutputRaw

public SignResp signOutputRaw(byte[] rawTxBytes,
                              java.util.List<SignDescriptor> signDescs,
                              java.util.List<TxOut> prevOutputs)
                       throws StatusException,
                              ValidationException

Method to generate a signOutputRaw request.

Returns:

a wrapped SignResp

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

SignerGrpc.SignerBlockingStub.signOutputRaw(SignerOuterClass.SignReq)

signOutputRaw

public SignResp signOutputRaw(SignReq request)
                       throws StatusException,
                              ValidationException

Method to send a signOutputRaw request.

Returns:

a wrapped SignResp

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

SignerGrpc.SignerBlockingStub.signOutputRaw(SignerOuterClass.SignReq)

computeInputScript

public InputScriptResp computeInputScript(byte[] rawTxBytes,
                                          java.util.List<SignDescriptor> signDescs,
                                          java.util.List<TxOut> prevOutputs)
                                   throws StatusException,
                                          ValidationException

Method to generate a computeInputScript request.

Returns:

a wrapped InputScriptResp

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

SignerGrpc.SignerBlockingStub.computeInputScript(SignerOuterClass.SignReq)

computeInputScript

public InputScriptResp computeInputScript(SignReq request)
                                   throws StatusException,
                                          ValidationException

Method to send a computeInputScript request.

Returns:

a wrapped InputScriptResp

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

SignerGrpc.SignerBlockingStub.computeInputScript(SignerOuterClass.SignReq)

deriveSharedKey

public SharedKeyResponse deriveSharedKey(byte[] ephemeralPubkey,
                                         KeyLocator keyLoc,
                                         KeyDescriptor keyDesc)
                                  throws StatusException,
                                         ValidationException

Method to generate a deriveSharedKey request.

Returns:

a wrapped SharedKeyResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

SignerGrpc.SignerBlockingStub.deriveSharedKey(SignerOuterClass.SharedKeyRequest)

deriveSharedKey

public SharedKeyResponse deriveSharedKey(SharedKeyRequest request)
                                  throws StatusException,
                                         ValidationException

Method to send a deriveSharedKey request.

Returns:

a wrapped SharedKeyResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

SignerGrpc.SignerBlockingStub.deriveSharedKey(SignerOuterClass.SharedKeyRequest)

muSig2CombineKeys

public MuSig2CombineKeysResponse muSig2CombineKeys(java.util.List<byte[]> allSignerPubkeys,
                                                   java.util.List<TweakDesc> tweaks,
                                                   TaprootTweakDesc taprootTweak,
                                                   MuSig2Version version)
                                            throws StatusException,
                                                   ValidationException

Method to generate a muSig2CombineKeys request.

Returns:

a wrapped MuSig2CombineKeysResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

SignerGrpc.SignerBlockingStub.muSig2CombineKeys(SignerOuterClass.MuSig2CombineKeysRequest)

muSig2CombineKeys

public MuSig2CombineKeysResponse muSig2CombineKeys(MuSig2CombineKeysRequest request)
                                            throws StatusException,
                                                   ValidationException

Method to send a muSig2CombineKeys request.

Returns:

a wrapped MuSig2CombineKeysResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

SignerGrpc.SignerBlockingStub.muSig2CombineKeys(SignerOuterClass.MuSig2CombineKeysRequest)

muSig2CreateSession

public MuSig2SessionResponse muSig2CreateSession(KeyLocator keyLoc,
                                                 java.util.List<byte[]> allSignerPubkeys,
                                                 java.util.List<byte[]> otherSignerPublicNonces,
                                                 java.util.List<TweakDesc> tweaks,
                                                 TaprootTweakDesc taprootTweak,
                                                 MuSig2Version version,
                                                 byte[] pregeneratedLocalNonce)
                                          throws StatusException,
                                                 ValidationException

Method to generate a muSig2CreateSession request.

Returns:

a wrapped MuSig2SessionResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

SignerGrpc.SignerBlockingStub.muSig2CreateSession(SignerOuterClass.MuSig2SessionRequest)

muSig2CreateSession

public MuSig2SessionResponse muSig2CreateSession(MuSig2SessionRequest request)
                                          throws StatusException,
                                                 ValidationException

Method to send a muSig2CreateSession request.

Returns:

a wrapped MuSig2SessionResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

SignerGrpc.SignerBlockingStub.muSig2CreateSession(SignerOuterClass.MuSig2SessionRequest)

muSig2RegisterNonces

public MuSig2RegisterNoncesResponse muSig2RegisterNonces(byte[] sessionId,
                                                         java.util.List<byte[]> otherSignerPublicNonces)
                                                  throws StatusException,
                                                         ValidationException

Method to generate a muSig2RegisterNonces request.

Returns:

a wrapped MuSig2RegisterNoncesResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

SignerGrpc.SignerBlockingStub.muSig2RegisterNonces(SignerOuterClass.MuSig2RegisterNoncesRequest)

muSig2RegisterNonces

public MuSig2RegisterNoncesResponse muSig2RegisterNonces(MuSig2RegisterNoncesRequest request)
                                                  throws StatusException,
                                                         ValidationException

Method to send a muSig2RegisterNonces request.

Returns:

a wrapped MuSig2RegisterNoncesResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

SignerGrpc.SignerBlockingStub.muSig2RegisterNonces(SignerOuterClass.MuSig2RegisterNoncesRequest)

muSig2Sign

public MuSig2SignResponse muSig2Sign(byte[] sessionId,
                                     byte[] messageDigest,
                                     java.lang.Boolean cleanup)
                              throws StatusException,
                                     ValidationException

Method to generate a muSig2Sign request.

Returns:

a wrapped MuSig2SignResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

SignerGrpc.SignerBlockingStub.muSig2Sign(SignerOuterClass.MuSig2SignRequest)

muSig2Sign

public MuSig2SignResponse muSig2Sign(MuSig2SignRequest request)
                              throws StatusException,
                                     ValidationException

Method to send a muSig2Sign request.

Returns:

a wrapped MuSig2SignResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

SignerGrpc.SignerBlockingStub.muSig2Sign(SignerOuterClass.MuSig2SignRequest)

muSig2CombineSig

public MuSig2CombineSigResponse muSig2CombineSig(byte[] sessionId,
                                                 java.util.List<byte[]> otherPartialSignatures)
                                          throws StatusException,
                                                 ValidationException

Method to generate a muSig2CombineSig request.

Returns:

a wrapped MuSig2CombineSigResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

SignerGrpc.SignerBlockingStub.muSig2CombineSig(SignerOuterClass.MuSig2CombineSigRequest)

muSig2CombineSig

public MuSig2CombineSigResponse muSig2CombineSig(MuSig2CombineSigRequest request)
                                          throws StatusException,
                                                 ValidationException

Method to send a muSig2CombineSig request.

Returns:

a wrapped MuSig2CombineSigResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

SignerGrpc.SignerBlockingStub.muSig2CombineSig(SignerOuterClass.MuSig2CombineSigRequest)

muSig2Cleanup

public MuSig2CleanupResponse muSig2Cleanup(byte[] sessionId)
                                    throws StatusException,
                                           ValidationException

Method to generate a muSig2Cleanup request.

Returns:

a wrapped MuSig2CleanupResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

SignerGrpc.SignerBlockingStub.muSig2Cleanup(SignerOuterClass.MuSig2CleanupRequest)

muSig2Cleanup

public MuSig2CleanupResponse muSig2Cleanup(MuSig2CleanupRequest request)
                                    throws StatusException,
                                           ValidationException

Method to send a muSig2Cleanup request.

Returns:

a wrapped MuSig2CleanupResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

SignerGrpc.SignerBlockingStub.muSig2Cleanup(SignerOuterClass.MuSig2CleanupRequest)

signMessage

public SignMessageResp signMessage(byte[] msg,
                                   KeyLocator keyLoc,
                                   java.lang.Boolean doubleHash,
                                   java.lang.Boolean compactSig,
                                   java.lang.Boolean schnorrSig,
                                   byte[] schnorrSigTapTweak)
                            throws StatusException,
                                   ValidationException

Method to generate a signMessage request.

Returns:

a wrapped SignMessageResp

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

SignerGrpc.SignerBlockingStub.signMessage(SignerOuterClass.SignMessageReq)

signMessage

public SignMessageResp signMessage(SignMessageReq request)
                            throws StatusException,
                                   ValidationException

Method to send a signMessage request.

Returns:

a wrapped SignMessageResp

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

SignerGrpc.SignerBlockingStub.signMessage(SignerOuterClass.SignMessageReq)

verifyMessage

public VerifyMessageResp verifyMessage(byte[] msg,
                                       byte[] signature,
                                       byte[] pubkey,
                                       java.lang.Boolean isSchnorrSig)
                                throws StatusException,
                                       ValidationException

Method to generate a verifyMessage request.

Returns:

a wrapped VerifyMessageResp

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

SignerGrpc.SignerBlockingStub.verifyMessage(SignerOuterClass.VerifyMessageReq)

verifyMessage

public VerifyMessageResp verifyMessage(VerifyMessageReq request)
                                throws StatusException,
                                       ValidationException

Method to send a verifyMessage request.

Returns:

a wrapped VerifyMessageResp

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

SignerGrpc.SignerBlockingStub.verifyMessage(SignerOuterClass.VerifyMessageReq)

getStub

protected SignerGrpc.SignerBlockingStub getStub()