org.lightningj.lnd.wrapper.chainkit

Class SynchronousChainKitAPI

java.lang.Object

org.lightningj.lnd.wrapper.API

org.lightningj.lnd.wrapper.SynchronousAPI

org.lightningj.lnd.wrapper.chainkit.SynchronousChainKitAPI

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

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

SynchronousChainKitAPI

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

SynchronousChainKitAPI

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

SynchronousChainKitAPI

public SynchronousChainKitAPI(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(byte[] blockHash)
                                      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:

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

.ChainKitBlockingStub#getBlockHeader(Chainkit.GetBlockHeaderRequest)

getBestBlock

public GetBestBlockResponse getBestBlock()
                                  throws StatusException,
                                         ValidationException

Method to generate a getBestBlock request.

Returns:

a wrapped GetBestBlockResponse

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:

.ChainKitBlockingStub#getBestBlock(Chainkit.GetBestBlockRequest)

getBestBlock

public GetBestBlockResponse getBestBlock(GetBestBlockRequest request)
                                  throws StatusException,
                                         ValidationException

Method to send a getBestBlock request.

Returns:

a wrapped GetBestBlockResponse

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:

.ChainKitBlockingStub#getBestBlock(Chainkit.GetBestBlockRequest)

getBlockHash

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

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

.ChainKitBlockingStub#getBlockHash(Chainkit.GetBlockHashRequest)

getBlock

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

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

.ChainKitBlockingStub#getBlock(Chainkit.GetBlockRequest)

getStub

protected ChainKitGrpc.ChainKitBlockingStub getStub()