org.lightningj.lnd.wrapper.chainkit

Class AsynchronousChainKitAPI

java.lang.Object

org.lightningj.lnd.wrapper.API

org.lightningj.lnd.wrapper.AsynchronousAPI

org.lightningj.lnd.wrapper.chainkit.AsynchronousChainKitAPI

public class AsynchronousChainKitAPI
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
AsynchronousChainKitAPI(io.grpc.ManagedChannel channel) Constructor used for setting up a connection using a GRPC managed channel that can be customized.
AsynchronousChainKitAPI(java.lang.String host, int port, java.io.File trustedServerCertificate, java.io.File macaroonFile) Minimal constructor for setting up a connection with LND Application.
AsynchronousChainKitAPI(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	getBestBlock(GetBestBlockRequest request, io.grpc.stub.StreamObserver<GetBestBlockResponse> responseObserver) Method to send a getBestBlock request.
void	getBestBlock(io.grpc.stub.StreamObserver<GetBestBlockResponse> responseObserver) Method to generate a getBestBlock request.
void	getBlock(byte[] blockHash, io.grpc.stub.StreamObserver<GetBlockResponse> responseObserver) Method to generate a getBlock request.
void	getBlock(GetBlockRequest request, io.grpc.stub.StreamObserver<GetBlockResponse> responseObserver) Method to send a getBlock request.
void	getBlockHash(GetBlockHashRequest request, io.grpc.stub.StreamObserver<GetBlockHashResponse> responseObserver) Method to send a getBlockHash request.
void	getBlockHash(java.lang.Long blockHeight, io.grpc.stub.StreamObserver<GetBlockHashResponse> responseObserver) Method to generate a getBlockHash request.
void	getBlockHeader(byte[] blockHash, io.grpc.stub.StreamObserver<GetBlockHeaderResponse> responseObserver) Method to generate a getBlockHeader request.
void	getBlockHeader(GetBlockHeaderRequest request, io.grpc.stub.StreamObserver<GetBlockHeaderResponse> responseObserver) Method to send a getBlockHeader request.
protected ChainKitGrpc.ChainKitStub	getStub()

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

AsynchronousChainKitAPI

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

AsynchronousChainKitAPI

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

AsynchronousChainKitAPI

public AsynchronousChainKitAPI(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(byte[] blockHash,
                           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:

.ChainKitStub#getBlockHeader(Chainkit.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:

.ChainKitStub#getBlockHeader(Chainkit.GetBlockHeaderRequest,io.grpc.stub.StreamObserver)

getBestBlock

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

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

.ChainKitStub#getBestBlock(Chainkit.GetBestBlockRequest, io.grpc.stub.StreamObserver)

getBestBlock

public void getBestBlock(GetBestBlockRequest request,
                         io.grpc.stub.StreamObserver<GetBestBlockResponse> responseObserver)
                  throws StatusException,
                         ValidationException

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

.ChainKitStub#getBestBlock(Chainkit.GetBestBlockRequest,io.grpc.stub.StreamObserver)

getBlockHash

public void getBlockHash(java.lang.Long blockHeight,
                         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:

.ChainKitStub#getBlockHash(Chainkit.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:

.ChainKitStub#getBlockHash(Chainkit.GetBlockHashRequest,io.grpc.stub.StreamObserver)

getBlock

public void getBlock(byte[] blockHash,
                     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:

.ChainKitStub#getBlock(Chainkit.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:

.ChainKitStub#getBlock(Chainkit.GetBlockRequest,io.grpc.stub.StreamObserver)

getStub

protected ChainKitGrpc.ChainKitStub getStub()