org.lightningj.lnd.wrapper.neutrino

Class AsynchronousNeutrinoAPI

java.lang.Object

org.lightningj.lnd.wrapper.API

org.lightningj.lnd.wrapper.AsynchronousAPI

org.lightningj.lnd.wrapper.neutrino.AsynchronousNeutrinoAPI

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

AsynchronousNeutrinoAPI

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

AsynchronousNeutrinoAPI

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

AsynchronousNeutrinoAPI

public AsynchronousNeutrinoAPI(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 void getBlockHeader(java.lang.String hash,
                           io.grpc.stub.StreamObserver<GetBlockHeaderResponse> responseObserver)
                    throws StatusException,
                           ValidationException

Method to generate a getBlockHeader 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:

NeutrinoKitGrpc.NeutrinoKitStub.getBlockHeader(Neutrino.GetBlockHeaderRequest, io.grpc.stub.StreamObserver)

getBlockHeader

public void getBlockHeader(GetBlockHeaderRequest request,
                           io.grpc.stub.StreamObserver<GetBlockHeaderResponse> responseObserver)
                    throws StatusException,
                           ValidationException

Method to send a getBlockHeader 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:

NeutrinoKitGrpc.NeutrinoKitStub.getBlockHeader(Neutrino.GetBlockHeaderRequest,io.grpc.stub.StreamObserver)

getCFilter

public void getCFilter(java.lang.String hash,
                       io.grpc.stub.StreamObserver<GetCFilterResponse> responseObserver)
                throws StatusException,
                       ValidationException

Method to generate a getCFilter 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:

NeutrinoKitGrpc.NeutrinoKitStub.getCFilter(Neutrino.GetCFilterRequest, io.grpc.stub.StreamObserver)

getCFilter

public void getCFilter(GetCFilterRequest request,
                       io.grpc.stub.StreamObserver<GetCFilterResponse> responseObserver)
                throws StatusException,
                       ValidationException

Method to send a getCFilter 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:

NeutrinoKitGrpc.NeutrinoKitStub.getCFilter(Neutrino.GetCFilterRequest,io.grpc.stub.StreamObserver)

getBlockHash

public void getBlockHash(java.lang.Integer height,
                         io.grpc.stub.StreamObserver<GetBlockHashResponse> responseObserver)
                  throws StatusException,
                         ValidationException

Method to generate a getBlockHash 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:

NeutrinoKitGrpc.NeutrinoKitStub.getBlockHash(Neutrino.GetBlockHashRequest, io.grpc.stub.StreamObserver)

getBlockHash

public void getBlockHash(GetBlockHashRequest request,
                         io.grpc.stub.StreamObserver<GetBlockHashResponse> responseObserver)
                  throws StatusException,
                         ValidationException

Method to send a getBlockHash 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:

NeutrinoKitGrpc.NeutrinoKitStub.getBlockHash(Neutrino.GetBlockHashRequest,io.grpc.stub.StreamObserver)

disconnectPeer

public void disconnectPeer(java.lang.String peerAddrs,
                           io.grpc.stub.StreamObserver<DisconnectPeerResponse> responseObserver)
                    throws StatusException,
                           ValidationException

Method to generate a disconnectPeer 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:

NeutrinoKitGrpc.NeutrinoKitStub.disconnectPeer(Neutrino.DisconnectPeerRequest, io.grpc.stub.StreamObserver)

disconnectPeer

public void disconnectPeer(DisconnectPeerRequest request,
                           io.grpc.stub.StreamObserver<DisconnectPeerResponse> responseObserver)
                    throws StatusException,
                           ValidationException

Method to send a disconnectPeer 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:

NeutrinoKitGrpc.NeutrinoKitStub.disconnectPeer(Neutrino.DisconnectPeerRequest,io.grpc.stub.StreamObserver)

addPeer

public void addPeer(java.lang.String peerAddrs,
                    io.grpc.stub.StreamObserver<AddPeerResponse> responseObserver)
             throws StatusException,
                    ValidationException

Method to generate a addPeer 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:

NeutrinoKitGrpc.NeutrinoKitStub.addPeer(Neutrino.AddPeerRequest, io.grpc.stub.StreamObserver)

addPeer

public void addPeer(AddPeerRequest request,
                    io.grpc.stub.StreamObserver<AddPeerResponse> responseObserver)
             throws StatusException,
                    ValidationException

Method to send a addPeer 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:

NeutrinoKitGrpc.NeutrinoKitStub.addPeer(Neutrino.AddPeerRequest,io.grpc.stub.StreamObserver)

isBanned

public void isBanned(java.lang.String peerAddrs,
                     io.grpc.stub.StreamObserver<IsBannedResponse> responseObserver)
              throws StatusException,
                     ValidationException

Method to generate a isBanned 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:

NeutrinoKitGrpc.NeutrinoKitStub.isBanned(Neutrino.IsBannedRequest, io.grpc.stub.StreamObserver)

isBanned

public void isBanned(IsBannedRequest request,
                     io.grpc.stub.StreamObserver<IsBannedResponse> responseObserver)
              throws StatusException,
                     ValidationException

Method to send a isBanned 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:

NeutrinoKitGrpc.NeutrinoKitStub.isBanned(Neutrino.IsBannedRequest,io.grpc.stub.StreamObserver)

getBlock

public void getBlock(java.lang.String hash,
                     io.grpc.stub.StreamObserver<GetBlockResponse> responseObserver)
              throws StatusException,
                     ValidationException

Method to generate a getBlock 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:

NeutrinoKitGrpc.NeutrinoKitStub.getBlock(Neutrino.GetBlockRequest, io.grpc.stub.StreamObserver)

getBlock

public void getBlock(GetBlockRequest request,
                     io.grpc.stub.StreamObserver<GetBlockResponse> responseObserver)
              throws StatusException,
                     ValidationException

Method to send a getBlock 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:

NeutrinoKitGrpc.NeutrinoKitStub.getBlock(Neutrino.GetBlockRequest,io.grpc.stub.StreamObserver)

status

public void status(io.grpc.stub.StreamObserver<StatusResponse> responseObserver)
            throws StatusException,
                   ValidationException

Method to generate a status 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:

NeutrinoKitGrpc.NeutrinoKitStub.status(Neutrino.StatusRequest, io.grpc.stub.StreamObserver)

status

public void status(StatusRequest request,
                   io.grpc.stub.StreamObserver<StatusResponse> responseObserver)
            throws StatusException,
                   ValidationException

Method to send a status 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:

NeutrinoKitGrpc.NeutrinoKitStub.status(Neutrino.StatusRequest,io.grpc.stub.StreamObserver)

getStub

protected NeutrinoKitGrpc.NeutrinoKitStub getStub()