org.lightningj.lnd.wrapper.invoices

Class AsynchronousInvoicesAPI

java.lang.Object

org.lightningj.lnd.wrapper.API

org.lightningj.lnd.wrapper.AsynchronousAPI

org.lightningj.lnd.wrapper.invoices.AsynchronousInvoicesAPI

public class AsynchronousInvoicesAPI
extends AsynchronousAPI

API Class for generating asynchronous 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
AsynchronousInvoicesAPI(io.grpc.ManagedChannel channel) Constructor used for setting up a connection using a GRPC managed channel that can be customized.
AsynchronousInvoicesAPI(java.lang.String host, int port, java.io.File trustedServerCertificate, java.io.File macaroonFile) Minimal constructor for setting up a connection with LND Application.
AsynchronousInvoicesAPI(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
void	addHoldInvoice(AddHoldInvoiceRequest request, io.grpc.stub.StreamObserver<AddHoldInvoiceResp> responseObserver) Method to send a addHoldInvoice request.
void	addHoldInvoice(java.lang.String memo, byte[] hash, java.lang.Long value, java.lang.Long valueMsat, byte[] descriptionHash, java.lang.Long expiry, java.lang.String fallbackAddr, java.lang.Long cltvExpiry, java.util.List<RouteHint> routeHints, java.lang.Boolean priv, io.grpc.stub.StreamObserver<AddHoldInvoiceResp> responseObserver) Method to generate a addHoldInvoice request.
void	cancelInvoice(byte[] paymentHash, io.grpc.stub.StreamObserver<CancelInvoiceResp> responseObserver) Method to generate a cancelInvoice request.
void	cancelInvoice(CancelInvoiceMsg request, io.grpc.stub.StreamObserver<CancelInvoiceResp> responseObserver) Method to send a cancelInvoice request.
protected InvoicesGrpc.InvoicesStub	getStub()
void	lookupInvoiceV2(byte[] paymentHash, byte[] paymentAddr, byte[] setId, LookupModifier lookupModifier, io.grpc.stub.StreamObserver<Invoice> responseObserver) Method to generate a lookupInvoiceV2 request.
void	lookupInvoiceV2(LookupInvoiceMsg request, io.grpc.stub.StreamObserver<Invoice> responseObserver) Method to send a lookupInvoiceV2 request.
void	settleInvoice(byte[] preimage, io.grpc.stub.StreamObserver<SettleInvoiceResp> responseObserver) Method to generate a settleInvoice request.
void	settleInvoice(SettleInvoiceMsg request, io.grpc.stub.StreamObserver<SettleInvoiceResp> responseObserver) Method to send a settleInvoice request.
void	subscribeSingleInvoice(byte[] rHash, io.grpc.stub.StreamObserver<Invoice> responseObserver) Method to generate a subscribeSingleInvoice request.
void	subscribeSingleInvoice(SubscribeSingleInvoiceRequest request, io.grpc.stub.StreamObserver<Invoice> responseObserver) Method to send a subscribeSingleInvoice request.

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

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

AsynchronousInvoicesAPI

public AsynchronousInvoicesAPI(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.

AsynchronousInvoicesAPI

public AsynchronousInvoicesAPI(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.

AsynchronousInvoicesAPI

public AsynchronousInvoicesAPI(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

cancelInvoice

public void cancelInvoice(byte[] paymentHash,
                          io.grpc.stub.StreamObserver<CancelInvoiceResp> responseObserver)
                   throws StatusException,
                          ValidationException

Method to generate a cancelInvoice request.

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:

InvoicesGrpc.InvoicesStub.cancelInvoice(InvoicesOuterClass.CancelInvoiceMsg, io.grpc.stub.StreamObserver)

cancelInvoice

public void cancelInvoice(CancelInvoiceMsg request,
                          io.grpc.stub.StreamObserver<CancelInvoiceResp> responseObserver)
                   throws StatusException,
                          ValidationException

Method to send a cancelInvoice request.

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:

InvoicesGrpc.InvoicesStub.cancelInvoice(InvoicesOuterClass.CancelInvoiceMsg,io.grpc.stub.StreamObserver)

addHoldInvoice

public void addHoldInvoice(java.lang.String memo,
                           byte[] hash,
                           java.lang.Long value,
                           java.lang.Long valueMsat,
                           byte[] descriptionHash,
                           java.lang.Long expiry,
                           java.lang.String fallbackAddr,
                           java.lang.Long cltvExpiry,
                           java.util.List<RouteHint> routeHints,
                           java.lang.Boolean priv,
                           io.grpc.stub.StreamObserver<AddHoldInvoiceResp> responseObserver)
                    throws StatusException,
                           ValidationException

Method to generate a addHoldInvoice request.

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:

InvoicesGrpc.InvoicesStub.addHoldInvoice(InvoicesOuterClass.AddHoldInvoiceRequest, io.grpc.stub.StreamObserver)

addHoldInvoice

public void addHoldInvoice(AddHoldInvoiceRequest request,
                           io.grpc.stub.StreamObserver<AddHoldInvoiceResp> responseObserver)
                    throws StatusException,
                           ValidationException

Method to send a addHoldInvoice request.

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:

InvoicesGrpc.InvoicesStub.addHoldInvoice(InvoicesOuterClass.AddHoldInvoiceRequest,io.grpc.stub.StreamObserver)

settleInvoice

public void settleInvoice(byte[] preimage,
                          io.grpc.stub.StreamObserver<SettleInvoiceResp> responseObserver)
                   throws StatusException,
                          ValidationException

Method to generate a settleInvoice request.

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:

InvoicesGrpc.InvoicesStub.settleInvoice(InvoicesOuterClass.SettleInvoiceMsg, io.grpc.stub.StreamObserver)

settleInvoice

public void settleInvoice(SettleInvoiceMsg request,
                          io.grpc.stub.StreamObserver<SettleInvoiceResp> responseObserver)
                   throws StatusException,
                          ValidationException

Method to send a settleInvoice request.

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:

InvoicesGrpc.InvoicesStub.settleInvoice(InvoicesOuterClass.SettleInvoiceMsg,io.grpc.stub.StreamObserver)

subscribeSingleInvoice

public void subscribeSingleInvoice(byte[] rHash,
                                   io.grpc.stub.StreamObserver<Invoice> responseObserver)
                            throws StatusException,
                                   ValidationException

Method to generate a subscribeSingleInvoice request.

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:

InvoicesGrpc.InvoicesStub.subscribeSingleInvoice(InvoicesOuterClass.SubscribeSingleInvoiceRequest, io.grpc.stub.StreamObserver)

subscribeSingleInvoice

public void subscribeSingleInvoice(SubscribeSingleInvoiceRequest request,
                                   io.grpc.stub.StreamObserver<Invoice> responseObserver)
                            throws StatusException,
                                   ValidationException

Method to send a subscribeSingleInvoice request.

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:

InvoicesGrpc.InvoicesStub.subscribeSingleInvoice(InvoicesOuterClass.SubscribeSingleInvoiceRequest,io.grpc.stub.StreamObserver)

lookupInvoiceV2

public void lookupInvoiceV2(byte[] paymentHash,
                            byte[] paymentAddr,
                            byte[] setId,
                            LookupModifier lookupModifier,
                            io.grpc.stub.StreamObserver<Invoice> responseObserver)
                     throws StatusException,
                            ValidationException

Method to generate a lookupInvoiceV2 request.

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:

InvoicesGrpc.InvoicesStub.lookupInvoiceV2(InvoicesOuterClass.LookupInvoiceMsg, io.grpc.stub.StreamObserver)

lookupInvoiceV2

public void lookupInvoiceV2(LookupInvoiceMsg request,
                            io.grpc.stub.StreamObserver<Invoice> responseObserver)
                     throws StatusException,
                            ValidationException

Method to send a lookupInvoiceV2 request.

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:

InvoicesGrpc.InvoicesStub.lookupInvoiceV2(InvoicesOuterClass.LookupInvoiceMsg,io.grpc.stub.StreamObserver)

getStub

protected InvoicesGrpc.InvoicesStub getStub()