org.lightningj.paywall.lightninghandler

Interface LightningHandler

All Known Implementing Classes:

BaseLNDLightningHandler, SimpleBaseLNDLightningHandler, SpringLNDLightningHandler

public interface LightningHandler

Interface for used lightning implementation creating and listening for settled invoices. Created by Philip Vendil on 2018-11-24.

Method Summary

Modifier and Type	Method and Description
void	close() Method to close the LND connections and release underlying resources.
void	connect(LightningHandlerContext context) Method to open up a connection to the configured LND node.
Invoice	generateInvoice(PreImageData preImageData, ConvertedOrder paymentData) Method to create an invoice in the underlying lightning node.
NodeInfo	getNodeInfo() Method to fetch the related lightning node's information to include in invoices.
boolean	isConnected() Method to check if handler is connected to node.
Invoice	lookupInvoice(byte[] preImageHash) Method to lookup an invoice in LND given the invoice's pre-image hash.
void	registerListener(LightningEventListener listener) Method to register a listener to recieve notification about updated invoices and settled invoices.
void	unregisterListener(LightningEventListener listener) Method to remove a listener from the list of event listeners of events related to adding or settling invoices.

Method Detail

connect

void connect(LightningHandlerContext context)
      throws java.io.IOException,
             InternalErrorException

Method to open up a connection to the configured LND node. Calls to register and un-register listeners should be done before opening a connection to make sure the listeners receives all invoice notifications.

Parameters:

context - the last context by the payment handler, containing the indicies of the last invoices processed.

Throws:

java.io.IOException - if communication problems occurred with underlying node.

InternalErrorException - if internal problems occurred opening up a connection with LND node.

generateInvoice

Invoice generateInvoice(PreImageData preImageData,
                        ConvertedOrder paymentData)
                 throws java.io.IOException,
                        InternalErrorException

Method to create an invoice in the underlying lightning node.

Parameters:

preImageData - the generated pre image and hash to use in invoice.

paymentData - the payment data to generate invoice for.

Returns:

the generated invoice data containing bolt11 invoice etc.

Throws:

java.io.IOException - if communication problems occurred with underlying node.

InternalErrorException - if problems occurred generating the invoice.

registerListener

void registerListener(LightningEventListener listener)
               throws InternalErrorException

Method to register a listener to recieve notification about updated invoices and settled invoices.

Parameters:

listener - the event listener to add to list receiving notifications.

Throws:

InternalErrorException - if problems occurred registering from listeners.

unregisterListener

void unregisterListener(LightningEventListener listener)
                 throws InternalErrorException

Method to remove a listener from the list of event listeners of events related to adding or settling invoices.

Parameters:

listener - the listener to remove from list of listeners.

Throws:

InternalErrorException - if problems occurred un-registering from listeners.

lookupInvoice

Invoice lookupInvoice(byte[] preImageHash)
               throws java.io.IOException,
                      InternalErrorException

Method to lookup an invoice in LND given the invoice's pre-image hash.

Parameters:

preImageHash - the pre image hash of the invoice to lookup.

Returns:

related invoice, null if not found.

Throws:

java.io.IOException - if communication problems occurred with underlying node.

InternalErrorException - if internal problems occurred communication or parsing invoice with lightning node.

isConnected

boolean isConnected()
             throws java.io.IOException,
                    InternalErrorException

Method to check if handler is connected to node.

Returns:

true if connected,

Throws:

java.io.IOException - if communication problems occurred with underlying node.

InternalErrorException - if internal problems occurred checking connection status.

close

void close()
    throws java.io.IOException,
           InternalErrorException

Method to close the LND connections and release underlying resources.

Throws:

java.io.IOException - if communication problems occurred with underlying node.

InternalErrorException - if internal problems occurred closing the connections with lightning node.

getNodeInfo

NodeInfo getNodeInfo()
              throws java.io.IOException,
                     InternalErrorException

Method to fetch the related lightning node's information to include in invoices.

Returns:

the related lightning node's information

Throws:

java.io.IOException - if communication problems occurred with underlying node.

InternalErrorException - if internal problems occurred closing the connections with lightning node.