org.lightningj.lnd.wrapper.invoices

Class SynchronousInvoicesAPI

java.lang.Object

org.lightningj.lnd.wrapper.API

org.lightningj.lnd.wrapper.SynchronousAPI

org.lightningj.lnd.wrapper.invoices.SynchronousInvoicesAPI

public class SynchronousInvoicesAPI
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
SynchronousInvoicesAPI(io.grpc.ManagedChannel channel) Constructor used for setting up a connection using a GRPC managed channel that can be customized.
SynchronousInvoicesAPI(java.lang.String host, int port, java.io.File trustedServerCertificate, java.io.File macaroonFile) Minimal constructor for setting up a connection with LND Application.
SynchronousInvoicesAPI(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
AddHoldInvoiceResp	addHoldInvoice(AddHoldInvoiceRequest request) Method to send a addHoldInvoice request.
AddHoldInvoiceResp	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) Method to generate a addHoldInvoice request.
CancelInvoiceResp	cancelInvoice(byte[] paymentHash) Method to generate a cancelInvoice request.
CancelInvoiceResp	cancelInvoice(CancelInvoiceMsg request) Method to send a cancelInvoice request.
protected InvoicesGrpc.InvoicesBlockingStub	getStub()
Invoice	lookupInvoiceV2(byte[] paymentHash, byte[] paymentAddr, byte[] setId, LookupModifier lookupModifier) Method to generate a lookupInvoiceV2 request.
Invoice	lookupInvoiceV2(LookupInvoiceMsg request) Method to send a lookupInvoiceV2 request.
SettleInvoiceResp	settleInvoice(byte[] preimage) Method to generate a settleInvoice request.
SettleInvoiceResp	settleInvoice(SettleInvoiceMsg request) Method to send a settleInvoice request.
java.util.Iterator<Invoice>	subscribeSingleInvoice(byte[] rHash) Method to generate a subscribeSingleInvoice request.
java.util.Iterator<Invoice>	subscribeSingleInvoice(SubscribeSingleInvoiceRequest request) Method to send a subscribeSingleInvoice 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

SynchronousInvoicesAPI

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

SynchronousInvoicesAPI

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

SynchronousInvoicesAPI

public SynchronousInvoicesAPI(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 CancelInvoiceResp cancelInvoice(byte[] paymentHash)
                                throws StatusException,
                                       ValidationException

Method to generate a cancelInvoice request.

Returns:

a wrapped CancelInvoiceResp

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.InvoicesBlockingStub.cancelInvoice(InvoicesOuterClass.CancelInvoiceMsg)

cancelInvoice

public CancelInvoiceResp cancelInvoice(CancelInvoiceMsg request)
                                throws StatusException,
                                       ValidationException

Method to send a cancelInvoice request.

Returns:

a wrapped CancelInvoiceResp

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.InvoicesBlockingStub.cancelInvoice(InvoicesOuterClass.CancelInvoiceMsg)

addHoldInvoice

public AddHoldInvoiceResp 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)
                                  throws StatusException,
                                         ValidationException

Method to generate a addHoldInvoice request.

Returns:

a wrapped AddHoldInvoiceResp

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.InvoicesBlockingStub.addHoldInvoice(InvoicesOuterClass.AddHoldInvoiceRequest)

addHoldInvoice

public AddHoldInvoiceResp addHoldInvoice(AddHoldInvoiceRequest request)
                                  throws StatusException,
                                         ValidationException

Method to send a addHoldInvoice request.

Returns:

a wrapped AddHoldInvoiceResp

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.InvoicesBlockingStub.addHoldInvoice(InvoicesOuterClass.AddHoldInvoiceRequest)

settleInvoice

public SettleInvoiceResp settleInvoice(byte[] preimage)
                                throws StatusException,
                                       ValidationException

Method to generate a settleInvoice request.

Returns:

a wrapped SettleInvoiceResp

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.InvoicesBlockingStub.settleInvoice(InvoicesOuterClass.SettleInvoiceMsg)

settleInvoice

public SettleInvoiceResp settleInvoice(SettleInvoiceMsg request)
                                throws StatusException,
                                       ValidationException

Method to send a settleInvoice request.

Returns:

a wrapped SettleInvoiceResp

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.InvoicesBlockingStub.settleInvoice(InvoicesOuterClass.SettleInvoiceMsg)

subscribeSingleInvoice

public java.util.Iterator<Invoice> subscribeSingleInvoice(byte[] rHash)
                                                   throws StatusException,
                                                          ValidationException

Method to generate a subscribeSingleInvoice request.

Returns:

a wrapped java.util.Iterator

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.InvoicesBlockingStub.subscribeSingleInvoice(InvoicesOuterClass.SubscribeSingleInvoiceRequest)

subscribeSingleInvoice

public java.util.Iterator<Invoice> subscribeSingleInvoice(SubscribeSingleInvoiceRequest request)
                                                   throws StatusException,
                                                          ValidationException

Method to send a subscribeSingleInvoice request.

Returns:

a wrapped java.util.Iterator

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.InvoicesBlockingStub.subscribeSingleInvoice(InvoicesOuterClass.SubscribeSingleInvoiceRequest)

lookupInvoiceV2

public Invoice lookupInvoiceV2(byte[] paymentHash,
                               byte[] paymentAddr,
                               byte[] setId,
                               LookupModifier lookupModifier)
                        throws StatusException,
                               ValidationException

Method to generate a lookupInvoiceV2 request.

Returns:

a wrapped Invoice

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.InvoicesBlockingStub.lookupInvoiceV2(InvoicesOuterClass.LookupInvoiceMsg)

lookupInvoiceV2

public Invoice lookupInvoiceV2(LookupInvoiceMsg request)
                        throws StatusException,
                               ValidationException

Method to send a lookupInvoiceV2 request.

Returns:

a wrapped Invoice

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.InvoicesBlockingStub.lookupInvoiceV2(InvoicesOuterClass.LookupInvoiceMsg)

getStub

protected InvoicesGrpc.InvoicesBlockingStub getStub()