org.lightningj.lnd.wrapper.neutrino

Class SynchronousNeutrinoAPI

java.lang.Object

org.lightningj.lnd.wrapper.API

org.lightningj.lnd.wrapper.SynchronousAPI

org.lightningj.lnd.wrapper.neutrino.SynchronousNeutrinoAPI

public class SynchronousNeutrinoAPI
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
SynchronousNeutrinoAPI(io.grpc.ManagedChannel channel) Constructor used for setting up a connection using a GRPC managed channel that can be customized.
SynchronousNeutrinoAPI(java.lang.String host, int port, java.io.File trustedServerCertificate, java.io.File macaroonFile) Minimal constructor for setting up a connection with LND Application.
SynchronousNeutrinoAPI(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
AddPeerResponse	addPeer(AddPeerRequest request) Method to send a addPeer request.
AddPeerResponse	addPeer(java.lang.String peerAddrs) Method to generate a addPeer request.
DisconnectPeerResponse	disconnectPeer(DisconnectPeerRequest request) Method to send a disconnectPeer request.
DisconnectPeerResponse	disconnectPeer(java.lang.String peerAddrs) Method to generate a disconnectPeer request.
GetBlockResponse	getBlock(GetBlockRequest request) Method to send a getBlock request.
GetBlockResponse	getBlock(java.lang.String hash) Method to generate a getBlock request.
GetBlockHashResponse	getBlockHash(GetBlockHashRequest request) Method to send a getBlockHash request.
GetBlockHashResponse	getBlockHash(java.lang.Integer height) Method to generate a getBlockHash request.
GetBlockHeaderResponse	getBlockHeader(GetBlockHeaderRequest request) Method to send a getBlockHeader request.
GetBlockHeaderResponse	getBlockHeader(java.lang.String hash) Method to generate a getBlockHeader request.
GetCFilterResponse	getCFilter(GetCFilterRequest request) Method to send a getCFilter request.
GetCFilterResponse	getCFilter(java.lang.String hash) Method to generate a getCFilter request.
protected NeutrinoKitGrpc.NeutrinoKitBlockingStub	getStub()
IsBannedResponse	isBanned(IsBannedRequest request) Method to send a isBanned request.
IsBannedResponse	isBanned(java.lang.String peerAddrs) Method to generate a isBanned request.
StatusResponse	status() Method to generate a status request.
StatusResponse	status(StatusRequest request) Method to send a status 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

SynchronousNeutrinoAPI

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

SynchronousNeutrinoAPI

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

SynchronousNeutrinoAPI

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

getBlockHeader

public GetBlockHeaderResponse getBlockHeader(java.lang.String hash)
                                      throws StatusException,
                                             ValidationException

Method to generate a getBlockHeader request.

Returns:

a wrapped GetBlockHeaderResponse

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:

NeutrinoKitGrpc.NeutrinoKitBlockingStub.getBlockHeader(Neutrino.GetBlockHeaderRequest)

getBlockHeader

public GetBlockHeaderResponse getBlockHeader(GetBlockHeaderRequest request)
                                      throws StatusException,
                                             ValidationException

Method to send a getBlockHeader request.

Returns:

a wrapped GetBlockHeaderResponse

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:

NeutrinoKitGrpc.NeutrinoKitBlockingStub.getBlockHeader(Neutrino.GetBlockHeaderRequest)

getCFilter

public GetCFilterResponse getCFilter(java.lang.String hash)
                              throws StatusException,
                                     ValidationException

Method to generate a getCFilter request.

Returns:

a wrapped GetCFilterResponse

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:

NeutrinoKitGrpc.NeutrinoKitBlockingStub.getCFilter(Neutrino.GetCFilterRequest)

getCFilter

public GetCFilterResponse getCFilter(GetCFilterRequest request)
                              throws StatusException,
                                     ValidationException

Method to send a getCFilter request.

Returns:

a wrapped GetCFilterResponse

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:

NeutrinoKitGrpc.NeutrinoKitBlockingStub.getCFilter(Neutrino.GetCFilterRequest)

getBlockHash

public GetBlockHashResponse getBlockHash(java.lang.Integer height)
                                  throws StatusException,
                                         ValidationException

Method to generate a getBlockHash request.

Returns:

a wrapped GetBlockHashResponse

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:

NeutrinoKitGrpc.NeutrinoKitBlockingStub.getBlockHash(Neutrino.GetBlockHashRequest)

getBlockHash

public GetBlockHashResponse getBlockHash(GetBlockHashRequest request)
                                  throws StatusException,
                                         ValidationException

Method to send a getBlockHash request.

Returns:

a wrapped GetBlockHashResponse

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:

NeutrinoKitGrpc.NeutrinoKitBlockingStub.getBlockHash(Neutrino.GetBlockHashRequest)

disconnectPeer

public DisconnectPeerResponse disconnectPeer(java.lang.String peerAddrs)
                                      throws StatusException,
                                             ValidationException

Method to generate a disconnectPeer request.

Returns:

a wrapped DisconnectPeerResponse

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:

NeutrinoKitGrpc.NeutrinoKitBlockingStub.disconnectPeer(Neutrino.DisconnectPeerRequest)

disconnectPeer

public DisconnectPeerResponse disconnectPeer(DisconnectPeerRequest request)
                                      throws StatusException,
                                             ValidationException

Method to send a disconnectPeer request.

Returns:

a wrapped DisconnectPeerResponse

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:

NeutrinoKitGrpc.NeutrinoKitBlockingStub.disconnectPeer(Neutrino.DisconnectPeerRequest)

addPeer

public AddPeerResponse addPeer(java.lang.String peerAddrs)
                        throws StatusException,
                               ValidationException

Method to generate a addPeer request.

Returns:

a wrapped AddPeerResponse

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:

NeutrinoKitGrpc.NeutrinoKitBlockingStub.addPeer(Neutrino.AddPeerRequest)

addPeer

public AddPeerResponse addPeer(AddPeerRequest request)
                        throws StatusException,
                               ValidationException

Method to send a addPeer request.

Returns:

a wrapped AddPeerResponse

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:

NeutrinoKitGrpc.NeutrinoKitBlockingStub.addPeer(Neutrino.AddPeerRequest)

isBanned

public IsBannedResponse isBanned(java.lang.String peerAddrs)
                          throws StatusException,
                                 ValidationException

Method to generate a isBanned request.

Returns:

a wrapped IsBannedResponse

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:

NeutrinoKitGrpc.NeutrinoKitBlockingStub.isBanned(Neutrino.IsBannedRequest)

isBanned

public IsBannedResponse isBanned(IsBannedRequest request)
                          throws StatusException,
                                 ValidationException

Method to send a isBanned request.

Returns:

a wrapped IsBannedResponse

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:

NeutrinoKitGrpc.NeutrinoKitBlockingStub.isBanned(Neutrino.IsBannedRequest)

getBlock

public GetBlockResponse getBlock(java.lang.String hash)
                          throws StatusException,
                                 ValidationException

Method to generate a getBlock request.

Returns:

a wrapped GetBlockResponse

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:

NeutrinoKitGrpc.NeutrinoKitBlockingStub.getBlock(Neutrino.GetBlockRequest)

getBlock

public GetBlockResponse getBlock(GetBlockRequest request)
                          throws StatusException,
                                 ValidationException

Method to send a getBlock request.

Returns:

a wrapped GetBlockResponse

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:

NeutrinoKitGrpc.NeutrinoKitBlockingStub.getBlock(Neutrino.GetBlockRequest)

status

public StatusResponse status()
                      throws StatusException,
                             ValidationException

Method to generate a status request.

Returns:

a wrapped StatusResponse

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:

NeutrinoKitGrpc.NeutrinoKitBlockingStub.status(Neutrino.StatusRequest)

status

public StatusResponse status(StatusRequest request)
                      throws StatusException,
                             ValidationException

Method to send a status request.

Returns:

a wrapped StatusResponse

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:

NeutrinoKitGrpc.NeutrinoKitBlockingStub.status(Neutrino.StatusRequest)

getStub

protected NeutrinoKitGrpc.NeutrinoKitBlockingStub getStub()