org.lightningj.lnd.wrapper.router

Class SynchronousRouterAPI

java.lang.Object

org.lightningj.lnd.wrapper.API

org.lightningj.lnd.wrapper.SynchronousAPI

org.lightningj.lnd.wrapper.router.SynchronousRouterAPI

public class SynchronousRouterAPI
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
SynchronousRouterAPI(io.grpc.ManagedChannel channel) Constructor used for setting up a connection using a GRPC managed channel that can be customized.
SynchronousRouterAPI(java.lang.String host, int port, java.io.File trustedServerCertificate, java.io.File macaroonFile) Minimal constructor for setting up a connection with LND Application.
SynchronousRouterAPI(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
BuildRouteResponse	buildRoute(BuildRouteRequest request) Method to send a buildRoute request.
BuildRouteResponse	buildRoute(java.lang.Long amtMsat, java.lang.Integer finalCltvDelta, java.lang.Long outgoingChanId, java.util.List<byte[]> hopPubkeys, byte[] paymentAddr) Method to generate a buildRoute request.
RouteFeeResponse	estimateRouteFee(byte[] dest, java.lang.Long amtSat) Method to generate a estimateRouteFee request.
RouteFeeResponse	estimateRouteFee(RouteFeeRequest request) Method to send a estimateRouteFee request.
GetMissionControlConfigResponse	getMissionControlConfig() Method to generate a getMissionControlConfig request.
GetMissionControlConfigResponse	getMissionControlConfig(GetMissionControlConfigRequest request) Method to send a getMissionControlConfig request.
protected RouterGrpc.RouterBlockingStub	getStub()
QueryMissionControlResponse	queryMissionControl() Method to generate a queryMissionControl request.
QueryMissionControlResponse	queryMissionControl(QueryMissionControlRequest request) Method to send a queryMissionControl request.
QueryProbabilityResponse	queryProbability(byte[] fromNode, byte[] toNode, java.lang.Long amtMsat) Method to generate a queryProbability request.
QueryProbabilityResponse	queryProbability(QueryProbabilityRequest request) Method to send a queryProbability request.
ResetMissionControlResponse	resetMissionControl() Method to generate a resetMissionControl request.
ResetMissionControlResponse	resetMissionControl(ResetMissionControlRequest request) Method to send a resetMissionControl request.
java.util.Iterator<PaymentStatus>	sendPayment(byte[] dest, java.lang.Long amt, java.lang.Long amtMsat, byte[] paymentHash, java.lang.Integer finalCltvDelta, byte[] paymentAddr, java.lang.String paymentRequest, java.lang.Integer timeoutSeconds, java.lang.Long feeLimitSat, java.lang.Long feeLimitMsat, java.lang.Long outgoingChanId, java.util.List<java.lang.Long> outgoingChanIds, byte[] lastHopPubkey, java.lang.Integer cltvLimit, java.util.List<RouteHint> routeHints, java.util.Map<java.lang.Long,byte[]> destCustomRecordss, java.lang.Boolean allowSelfPayment, java.util.List<FeatureBit> destFeatures, java.lang.Integer maxParts, java.lang.Boolean noInflightUpdates, java.lang.Long maxShardSizeMsat, java.lang.Boolean amp, java.lang.Double timePref) Method to generate a sendPayment request.
java.util.Iterator<PaymentStatus>	sendPayment(SendPaymentRequest request) Method to send a sendPayment request.
java.util.Iterator<Payment>	sendPaymentV2(byte[] dest, java.lang.Long amt, java.lang.Long amtMsat, byte[] paymentHash, java.lang.Integer finalCltvDelta, byte[] paymentAddr, java.lang.String paymentRequest, java.lang.Integer timeoutSeconds, java.lang.Long feeLimitSat, java.lang.Long feeLimitMsat, java.lang.Long outgoingChanId, java.util.List<java.lang.Long> outgoingChanIds, byte[] lastHopPubkey, java.lang.Integer cltvLimit, java.util.List<RouteHint> routeHints, java.util.Map<java.lang.Long,byte[]> destCustomRecordss, java.lang.Boolean allowSelfPayment, java.util.List<FeatureBit> destFeatures, java.lang.Integer maxParts, java.lang.Boolean noInflightUpdates, java.lang.Long maxShardSizeMsat, java.lang.Boolean amp, java.lang.Double timePref) Method to generate a sendPaymentV2 request.
java.util.Iterator<Payment>	sendPaymentV2(SendPaymentRequest request) Method to send a sendPaymentV2 request.
SendToRouteResponse	sendToRoute(byte[] paymentHash, Route route, java.lang.Boolean skipTempErr) Method to generate a sendToRoute request.
SendToRouteResponse	sendToRoute(SendToRouteRequest request) Method to send a sendToRoute request.
HTLCAttempt	sendToRouteV2(byte[] paymentHash, Route route, java.lang.Boolean skipTempErr) Method to generate a sendToRouteV2 request.
HTLCAttempt	sendToRouteV2(SendToRouteRequest request) Method to send a sendToRouteV2 request.
SetMissionControlConfigResponse	setMissionControlConfig(MissionControlConfig config) Method to generate a setMissionControlConfig request.
SetMissionControlConfigResponse	setMissionControlConfig(SetMissionControlConfigRequest request) Method to send a setMissionControlConfig request.
java.util.Iterator<HtlcEvent>	subscribeHtlcEvents() Method to generate a subscribeHtlcEvents request.
java.util.Iterator<HtlcEvent>	subscribeHtlcEvents(SubscribeHtlcEventsRequest request) Method to send a subscribeHtlcEvents request.
java.util.Iterator<PaymentStatus>	trackPayment(byte[] paymentHash, java.lang.Boolean noInflightUpdates) Method to generate a trackPayment request.
java.util.Iterator<PaymentStatus>	trackPayment(TrackPaymentRequest request) Method to send a trackPayment request.
java.util.Iterator<Payment>	trackPayments(java.lang.Boolean noInflightUpdates) Method to generate a trackPayments request.
java.util.Iterator<Payment>	trackPayments(TrackPaymentsRequest request) Method to send a trackPayments request.
java.util.Iterator<Payment>	trackPaymentV2(byte[] paymentHash, java.lang.Boolean noInflightUpdates) Method to generate a trackPaymentV2 request.
java.util.Iterator<Payment>	trackPaymentV2(TrackPaymentRequest request) Method to send a trackPaymentV2 request.
UpdateChanStatusResponse	updateChanStatus(ChannelPoint chanPoint, ChanStatusAction action) Method to generate a updateChanStatus request.
UpdateChanStatusResponse	updateChanStatus(UpdateChanStatusRequest request) Method to send a updateChanStatus request.
XImportMissionControlResponse	xImportMissionControl(java.util.List<PairHistory> pairs, java.lang.Boolean force) Method to generate a xImportMissionControl request.
XImportMissionControlResponse	xImportMissionControl(XImportMissionControlRequest request) Method to send a xImportMissionControl 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

SynchronousRouterAPI

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

SynchronousRouterAPI

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

SynchronousRouterAPI

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

sendPayment

public java.util.Iterator<PaymentStatus> sendPayment(byte[] dest,
                                                     java.lang.Long amt,
                                                     java.lang.Long amtMsat,
                                                     byte[] paymentHash,
                                                     java.lang.Integer finalCltvDelta,
                                                     byte[] paymentAddr,
                                                     java.lang.String paymentRequest,
                                                     java.lang.Integer timeoutSeconds,
                                                     java.lang.Long feeLimitSat,
                                                     java.lang.Long feeLimitMsat,
                                                     java.lang.Long outgoingChanId,
                                                     java.util.List<java.lang.Long> outgoingChanIds,
                                                     byte[] lastHopPubkey,
                                                     java.lang.Integer cltvLimit,
                                                     java.util.List<RouteHint> routeHints,
                                                     java.util.Map<java.lang.Long,byte[]> destCustomRecordss,
                                                     java.lang.Boolean allowSelfPayment,
                                                     java.util.List<FeatureBit> destFeatures,
                                                     java.lang.Integer maxParts,
                                                     java.lang.Boolean noInflightUpdates,
                                                     java.lang.Long maxShardSizeMsat,
                                                     java.lang.Boolean amp,
                                                     java.lang.Double timePref)
                                              throws StatusException,
                                                     ValidationException

Method to generate a sendPayment request.

Returns:

a wrapped java.util.Iterator

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:

RouterGrpc.RouterBlockingStub.sendPayment(RouterOuterClass.SendPaymentRequest)

sendPayment

public java.util.Iterator<PaymentStatus> sendPayment(SendPaymentRequest request)
                                              throws StatusException,
                                                     ValidationException

Method to send a sendPayment request.

Returns:

a wrapped java.util.Iterator

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:

RouterGrpc.RouterBlockingStub.sendPayment(RouterOuterClass.SendPaymentRequest)

sendToRoute

public SendToRouteResponse sendToRoute(byte[] paymentHash,
                                       Route route,
                                       java.lang.Boolean skipTempErr)
                                throws StatusException,
                                       ValidationException

Method to generate a sendToRoute request.

Returns:

a wrapped SendToRouteResponse

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:

RouterGrpc.RouterBlockingStub.sendToRoute(RouterOuterClass.SendToRouteRequest)

sendToRoute

public SendToRouteResponse sendToRoute(SendToRouteRequest request)
                                throws StatusException,
                                       ValidationException

Method to send a sendToRoute request.

Returns:

a wrapped SendToRouteResponse

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:

RouterGrpc.RouterBlockingStub.sendToRoute(RouterOuterClass.SendToRouteRequest)

estimateRouteFee

public RouteFeeResponse estimateRouteFee(byte[] dest,
                                         java.lang.Long amtSat)
                                  throws StatusException,
                                         ValidationException

Method to generate a estimateRouteFee request.

Returns:

a wrapped RouteFeeResponse

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:

RouterGrpc.RouterBlockingStub.estimateRouteFee(RouterOuterClass.RouteFeeRequest)

estimateRouteFee

public RouteFeeResponse estimateRouteFee(RouteFeeRequest request)
                                  throws StatusException,
                                         ValidationException

Method to send a estimateRouteFee request.

Returns:

a wrapped RouteFeeResponse

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:

RouterGrpc.RouterBlockingStub.estimateRouteFee(RouterOuterClass.RouteFeeRequest)

resetMissionControl

public ResetMissionControlResponse resetMissionControl()
                                                throws StatusException,
                                                       ValidationException

Method to generate a resetMissionControl request.

Returns:

a wrapped ResetMissionControlResponse

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:

RouterGrpc.RouterBlockingStub.resetMissionControl(RouterOuterClass.ResetMissionControlRequest)

resetMissionControl

public ResetMissionControlResponse resetMissionControl(ResetMissionControlRequest request)
                                                throws StatusException,
                                                       ValidationException

Method to send a resetMissionControl request.

Returns:

a wrapped ResetMissionControlResponse

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:

RouterGrpc.RouterBlockingStub.resetMissionControl(RouterOuterClass.ResetMissionControlRequest)

queryMissionControl

public QueryMissionControlResponse queryMissionControl()
                                                throws StatusException,
                                                       ValidationException

Method to generate a queryMissionControl request.

Returns:

a wrapped QueryMissionControlResponse

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:

RouterGrpc.RouterBlockingStub.queryMissionControl(RouterOuterClass.QueryMissionControlRequest)

queryMissionControl

public QueryMissionControlResponse queryMissionControl(QueryMissionControlRequest request)
                                                throws StatusException,
                                                       ValidationException

Method to send a queryMissionControl request.

Returns:

a wrapped QueryMissionControlResponse

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:

RouterGrpc.RouterBlockingStub.queryMissionControl(RouterOuterClass.QueryMissionControlRequest)

xImportMissionControl

public XImportMissionControlResponse xImportMissionControl(java.util.List<PairHistory> pairs,
                                                           java.lang.Boolean force)
                                                    throws StatusException,
                                                           ValidationException

Method to generate a xImportMissionControl request.

Returns:

a wrapped XImportMissionControlResponse

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:

RouterGrpc.RouterBlockingStub.xImportMissionControl(RouterOuterClass.XImportMissionControlRequest)

xImportMissionControl

public XImportMissionControlResponse xImportMissionControl(XImportMissionControlRequest request)
                                                    throws StatusException,
                                                           ValidationException

Method to send a xImportMissionControl request.

Returns:

a wrapped XImportMissionControlResponse

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:

RouterGrpc.RouterBlockingStub.xImportMissionControl(RouterOuterClass.XImportMissionControlRequest)

getMissionControlConfig

public GetMissionControlConfigResponse getMissionControlConfig()
                                                        throws StatusException,
                                                               ValidationException

Method to generate a getMissionControlConfig request.

Returns:

a wrapped GetMissionControlConfigResponse

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:

RouterGrpc.RouterBlockingStub.getMissionControlConfig(RouterOuterClass.GetMissionControlConfigRequest)

getMissionControlConfig

public GetMissionControlConfigResponse getMissionControlConfig(GetMissionControlConfigRequest request)
                                                        throws StatusException,
                                                               ValidationException

Method to send a getMissionControlConfig request.

Returns:

a wrapped GetMissionControlConfigResponse

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:

RouterGrpc.RouterBlockingStub.getMissionControlConfig(RouterOuterClass.GetMissionControlConfigRequest)

setMissionControlConfig

public SetMissionControlConfigResponse setMissionControlConfig(MissionControlConfig config)
                                                        throws StatusException,
                                                               ValidationException

Method to generate a setMissionControlConfig request.

Returns:

a wrapped SetMissionControlConfigResponse

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:

RouterGrpc.RouterBlockingStub.setMissionControlConfig(RouterOuterClass.SetMissionControlConfigRequest)

setMissionControlConfig

public SetMissionControlConfigResponse setMissionControlConfig(SetMissionControlConfigRequest request)
                                                        throws StatusException,
                                                               ValidationException

Method to send a setMissionControlConfig request.

Returns:

a wrapped SetMissionControlConfigResponse

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:

RouterGrpc.RouterBlockingStub.setMissionControlConfig(RouterOuterClass.SetMissionControlConfigRequest)

queryProbability

public QueryProbabilityResponse queryProbability(byte[] fromNode,
                                                 byte[] toNode,
                                                 java.lang.Long amtMsat)
                                          throws StatusException,
                                                 ValidationException

Method to generate a queryProbability request.

Returns:

a wrapped QueryProbabilityResponse

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:

RouterGrpc.RouterBlockingStub.queryProbability(RouterOuterClass.QueryProbabilityRequest)

queryProbability

public QueryProbabilityResponse queryProbability(QueryProbabilityRequest request)
                                          throws StatusException,
                                                 ValidationException

Method to send a queryProbability request.

Returns:

a wrapped QueryProbabilityResponse

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:

RouterGrpc.RouterBlockingStub.queryProbability(RouterOuterClass.QueryProbabilityRequest)

buildRoute

public BuildRouteResponse buildRoute(java.lang.Long amtMsat,
                                     java.lang.Integer finalCltvDelta,
                                     java.lang.Long outgoingChanId,
                                     java.util.List<byte[]> hopPubkeys,
                                     byte[] paymentAddr)
                              throws StatusException,
                                     ValidationException

Method to generate a buildRoute request.

Returns:

a wrapped BuildRouteResponse

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:

RouterGrpc.RouterBlockingStub.buildRoute(RouterOuterClass.BuildRouteRequest)

buildRoute

public BuildRouteResponse buildRoute(BuildRouteRequest request)
                              throws StatusException,
                                     ValidationException

Method to send a buildRoute request.

Returns:

a wrapped BuildRouteResponse

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:

RouterGrpc.RouterBlockingStub.buildRoute(RouterOuterClass.BuildRouteRequest)

subscribeHtlcEvents

public java.util.Iterator<HtlcEvent> subscribeHtlcEvents()
                                                  throws StatusException,
                                                         ValidationException

Method to generate a subscribeHtlcEvents request.

Returns:

a wrapped java.util.Iterator

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:

RouterGrpc.RouterBlockingStub.subscribeHtlcEvents(RouterOuterClass.SubscribeHtlcEventsRequest)

subscribeHtlcEvents

public java.util.Iterator<HtlcEvent> subscribeHtlcEvents(SubscribeHtlcEventsRequest request)
                                                  throws StatusException,
                                                         ValidationException

Method to send a subscribeHtlcEvents request.

Returns:

a wrapped java.util.Iterator

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:

RouterGrpc.RouterBlockingStub.subscribeHtlcEvents(RouterOuterClass.SubscribeHtlcEventsRequest)

trackPayment

public java.util.Iterator<PaymentStatus> trackPayment(byte[] paymentHash,
                                                      java.lang.Boolean noInflightUpdates)
                                               throws StatusException,
                                                      ValidationException

Method to generate a trackPayment request.

Returns:

a wrapped java.util.Iterator

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:

RouterGrpc.RouterBlockingStub.trackPayment(RouterOuterClass.TrackPaymentRequest)

trackPayment

public java.util.Iterator<PaymentStatus> trackPayment(TrackPaymentRequest request)
                                               throws StatusException,
                                                      ValidationException

Method to send a trackPayment request.

Returns:

a wrapped java.util.Iterator

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:

RouterGrpc.RouterBlockingStub.trackPayment(RouterOuterClass.TrackPaymentRequest)

updateChanStatus

public UpdateChanStatusResponse updateChanStatus(ChannelPoint chanPoint,
                                                 ChanStatusAction action)
                                          throws StatusException,
                                                 ValidationException

Method to generate a updateChanStatus request.

Returns:

a wrapped UpdateChanStatusResponse

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:

RouterGrpc.RouterBlockingStub.updateChanStatus(RouterOuterClass.UpdateChanStatusRequest)

updateChanStatus

public UpdateChanStatusResponse updateChanStatus(UpdateChanStatusRequest request)
                                          throws StatusException,
                                                 ValidationException

Method to send a updateChanStatus request.

Returns:

a wrapped UpdateChanStatusResponse

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:

RouterGrpc.RouterBlockingStub.updateChanStatus(RouterOuterClass.UpdateChanStatusRequest)

sendPaymentV2

public java.util.Iterator<Payment> sendPaymentV2(byte[] dest,
                                                 java.lang.Long amt,
                                                 java.lang.Long amtMsat,
                                                 byte[] paymentHash,
                                                 java.lang.Integer finalCltvDelta,
                                                 byte[] paymentAddr,
                                                 java.lang.String paymentRequest,
                                                 java.lang.Integer timeoutSeconds,
                                                 java.lang.Long feeLimitSat,
                                                 java.lang.Long feeLimitMsat,
                                                 java.lang.Long outgoingChanId,
                                                 java.util.List<java.lang.Long> outgoingChanIds,
                                                 byte[] lastHopPubkey,
                                                 java.lang.Integer cltvLimit,
                                                 java.util.List<RouteHint> routeHints,
                                                 java.util.Map<java.lang.Long,byte[]> destCustomRecordss,
                                                 java.lang.Boolean allowSelfPayment,
                                                 java.util.List<FeatureBit> destFeatures,
                                                 java.lang.Integer maxParts,
                                                 java.lang.Boolean noInflightUpdates,
                                                 java.lang.Long maxShardSizeMsat,
                                                 java.lang.Boolean amp,
                                                 java.lang.Double timePref)
                                          throws StatusException,
                                                 ValidationException

Method to generate a sendPaymentV2 request.

Returns:

a wrapped java.util.Iterator

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:

RouterGrpc.RouterBlockingStub.sendPaymentV2(RouterOuterClass.SendPaymentRequest)

sendPaymentV2

public java.util.Iterator<Payment> sendPaymentV2(SendPaymentRequest request)
                                          throws StatusException,
                                                 ValidationException

Method to send a sendPaymentV2 request.

Returns:

a wrapped java.util.Iterator

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:

RouterGrpc.RouterBlockingStub.sendPaymentV2(RouterOuterClass.SendPaymentRequest)

trackPaymentV2

public java.util.Iterator<Payment> trackPaymentV2(byte[] paymentHash,
                                                  java.lang.Boolean noInflightUpdates)
                                           throws StatusException,
                                                  ValidationException

Method to generate a trackPaymentV2 request.

Returns:

a wrapped java.util.Iterator

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:

RouterGrpc.RouterBlockingStub.trackPaymentV2(RouterOuterClass.TrackPaymentRequest)

trackPaymentV2

public java.util.Iterator<Payment> trackPaymentV2(TrackPaymentRequest request)
                                           throws StatusException,
                                                  ValidationException

Method to send a trackPaymentV2 request.

Returns:

a wrapped java.util.Iterator

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:

RouterGrpc.RouterBlockingStub.trackPaymentV2(RouterOuterClass.TrackPaymentRequest)

sendToRouteV2

public HTLCAttempt sendToRouteV2(byte[] paymentHash,
                                 Route route,
                                 java.lang.Boolean skipTempErr)
                          throws StatusException,
                                 ValidationException

Method to generate a sendToRouteV2 request.

Returns:

a wrapped HTLCAttempt

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:

RouterGrpc.RouterBlockingStub.sendToRouteV2(RouterOuterClass.SendToRouteRequest)

sendToRouteV2

public HTLCAttempt sendToRouteV2(SendToRouteRequest request)
                          throws StatusException,
                                 ValidationException

Method to send a sendToRouteV2 request.

Returns:

a wrapped HTLCAttempt

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:

RouterGrpc.RouterBlockingStub.sendToRouteV2(RouterOuterClass.SendToRouteRequest)

trackPayments

public java.util.Iterator<Payment> trackPayments(java.lang.Boolean noInflightUpdates)
                                          throws StatusException,
                                                 ValidationException

Method to generate a trackPayments request.

Returns:

a wrapped java.util.Iterator

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:

RouterGrpc.RouterBlockingStub.trackPayments(RouterOuterClass.TrackPaymentsRequest)

trackPayments

public java.util.Iterator<Payment> trackPayments(TrackPaymentsRequest request)
                                          throws StatusException,
                                                 ValidationException

Method to send a trackPayments request.

Returns:

a wrapped java.util.Iterator

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:

RouterGrpc.RouterBlockingStub.trackPayments(RouterOuterClass.TrackPaymentsRequest)

getStub

protected RouterGrpc.RouterBlockingStub getStub()