org.lightningj.paywall.lightninghandler.lnd

Class BaseLNDLightningHandler

java.lang.Object

org.lightningj.paywall.lightninghandler.lnd.BaseLNDLightningHandler

All Implemented Interfaces:

LightningHandler

Direct Known Subclasses:

SimpleBaseLNDLightningHandler

public abstract class BaseLNDLightningHandler
extends java.lang.Object
implements LightningHandler

Base implementation of LND Lightning Handler handling the methods for generateInvoice, lookupInvoice and invoice subscribing. See SimpleBaseLNDLightningHandler that manages APIs, opening/closing connection. Extends this if custom management of LND APIs should be done, otherwise use SimpleBaseLNDLightningHandler.

See Also:

Created by Philip Vendil on 2018-11-24.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<LightningEventListener>	listeners
protected static java.util.logging.Logger	log

Constructor Summary

Constructors

Constructor and Description
BaseLNDLightningHandler()

Method Summary

Modifier and Type	Method and Description
protected void	checkConnection()
protected void	clearCache() Method to clear all cached objects, should be called when reconnecting to LND node.
Invoice	generateInvoice(PreImageData preImageData, ConvertedOrder paymentData) Method to create an invoice in the underlying LND node.
protected abstract org.lightningj.lnd.wrapper.AsynchronousLndAPI	getAsyncAPI() Method to get the asynchronous lnd api from lightningj.
protected LNDHelper	getLndHelper()
NodeInfo	getNodeInfo() Method to fetch the related lightning node's information to include in invoices.
protected abstract NodeInfo	getNodeInfoFromConfiguration() Method to retrieve node information from configuration or null if not configured.
protected abstract java.lang.String	getSupportedCurrencyCode() Method to retrieve configured supported currency code.
protected abstract org.lightningj.lnd.wrapper.SynchronousLndAPI	getSyncAPI() Method to get the synchronous lnd api from lightningj.
protected void	listenToInvoices(LightningHandlerContext context) Help method that setup invoice subscription with underlying LND 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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.lightningj.paywall.lightninghandler.LightningHandler

close, connect, isConnected

Field Detail

log

protected static java.util.logging.Logger log

listeners

protected java.util.List<LightningEventListener> listeners

Constructor Detail

BaseLNDLightningHandler

public BaseLNDLightningHandler()

Method Detail

generateInvoice

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

Method to create an invoice in the underlying LND node.

Specified by:

generateInvoice in interface LightningHandler

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.

lookupInvoice

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

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

Specified by:

lookupInvoice in interface LightningHandler

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 LND node.

registerListener

public void registerListener(LightningEventListener listener)
                      throws InternalErrorException

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

Specified by:

registerListener in interface LightningHandler

Parameters:

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

Throws:

InternalErrorException - if problems occurred registering from listeners.

unregisterListener

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

Specified by:

unregisterListener in interface LightningHandler

Parameters:

listener - the listener to remove from list of listeners.

Throws:

InternalErrorException - if problems occurred un-registering from listeners.

listenToInvoices

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

Help method that setup invoice subscription with underlying LND node.

Parameters:

context - the related LND context with latest indicies.

Throws:

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

InternalErrorException - if internal problems occurred with subscribing to LND node.

checkConnection

protected void checkConnection()
                        throws java.io.IOException,
                               InternalErrorException

Throws:

java.io.IOException

InternalErrorException

clearCache

protected void clearCache()

Method to clear all cached objects, should be called when reconnecting to LND node.

getNodeInfo

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

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

Specified by:

getNodeInfo in interface LightningHandler

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.

getLndHelper

protected LNDHelper getLndHelper()
                          throws java.io.IOException,
                                 InternalErrorException

Throws:

java.io.IOException

InternalErrorException

getAsyncAPI

protected abstract org.lightningj.lnd.wrapper.AsynchronousLndAPI getAsyncAPI()
                                                                      throws java.io.IOException,
                                                                             InternalErrorException

Method to get the asynchronous lnd api from lightningj.

Returns:

the asynchronous lnd api from lightningj.

Throws:

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

InternalErrorException - if internal problems occurred with LND node.

getSyncAPI

protected abstract org.lightningj.lnd.wrapper.SynchronousLndAPI getSyncAPI()
                                                                    throws java.io.IOException,
                                                                           InternalErrorException

Method to get the synchronous lnd api from lightningj.

Returns:

the synchronous lnd api from lightningj.

Throws:

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

InternalErrorException - if internal problems occurred with LND node.

getNodeInfoFromConfiguration

protected abstract NodeInfo getNodeInfoFromConfiguration()
                                                  throws InternalErrorException

Method to retrieve node information from configuration or null if not configured.

Used when the LND macaroon doesn't have access rights to retrieve LND Node information.

Returns:

populated NodeInfo from configuration or nulll if no configuration exists.

Throws:

InternalErrorException - if problems occurred parsing the configuration.

getSupportedCurrencyCode

protected abstract java.lang.String getSupportedCurrencyCode()
                                                      throws InternalErrorException

Method to retrieve configured supported currency code. Should be one of CryptoAmount CURRENCY_CODE_ constants.

Returns:

The used currency code

Throws:

InternalErrorException - if currency code configuration was unparsable.