public static interface RouterGrpc.AsyncService
Router is a service that offers advanced interaction with the router subsystem of the daemon.
| Modifier and Type | Method and Description |
|---|---|
default void |
buildRoute(RouterOuterClass.BuildRouteRequest request,
io.grpc.stub.StreamObserver<RouterOuterClass.BuildRouteResponse> responseObserver)
BuildRoute builds a fully specified route based on a list of hop public
keys.
|
default void |
estimateRouteFee(RouterOuterClass.RouteFeeRequest request,
io.grpc.stub.StreamObserver<RouterOuterClass.RouteFeeResponse> responseObserver)
EstimateRouteFee allows callers to obtain a lower bound w.r.t how much it
may cost to send an HTLC to the target end destination.
|
default void |
getMissionControlConfig(RouterOuterClass.GetMissionControlConfigRequest request,
io.grpc.stub.StreamObserver<RouterOuterClass.GetMissionControlConfigResponse> responseObserver)
GetMissionControlConfig returns mission control's current config.
|
default io.grpc.stub.StreamObserver<RouterOuterClass.ForwardHtlcInterceptResponse> |
htlcInterceptor(io.grpc.stub.StreamObserver<RouterOuterClass.ForwardHtlcInterceptRequest> responseObserver)
HtlcInterceptor dispatches a bi-directional streaming RPC in which
Forwarded HTLC requests are sent to the client and the client responds with
a boolean that tells LND if this htlc should be intercepted.
|
default void |
queryMissionControl(RouterOuterClass.QueryMissionControlRequest request,
io.grpc.stub.StreamObserver<RouterOuterClass.QueryMissionControlResponse> responseObserver)
QueryMissionControl exposes the internal mission control state to callers.
|
default void |
queryProbability(RouterOuterClass.QueryProbabilityRequest request,
io.grpc.stub.StreamObserver<RouterOuterClass.QueryProbabilityResponse> responseObserver)
Deprecated.
|
default void |
resetMissionControl(RouterOuterClass.ResetMissionControlRequest request,
io.grpc.stub.StreamObserver<RouterOuterClass.ResetMissionControlResponse> responseObserver)
ResetMissionControl clears all mission control state and starts with a clean
slate.
|
default void |
sendPayment(RouterOuterClass.SendPaymentRequest request,
io.grpc.stub.StreamObserver<RouterOuterClass.PaymentStatus> responseObserver)
Deprecated.
|
default void |
sendPaymentV2(RouterOuterClass.SendPaymentRequest request,
io.grpc.stub.StreamObserver<LightningApi.Payment> responseObserver)
SendPaymentV2 attempts to route a payment described by the passed
PaymentRequest to the final destination.
|
default void |
sendToRoute(RouterOuterClass.SendToRouteRequest request,
io.grpc.stub.StreamObserver<RouterOuterClass.SendToRouteResponse> responseObserver)
Deprecated.
|
default void |
sendToRouteV2(RouterOuterClass.SendToRouteRequest request,
io.grpc.stub.StreamObserver<LightningApi.HTLCAttempt> responseObserver)
SendToRouteV2 attempts to make a payment via the specified route.
|
default void |
setMissionControlConfig(RouterOuterClass.SetMissionControlConfigRequest request,
io.grpc.stub.StreamObserver<RouterOuterClass.SetMissionControlConfigResponse> responseObserver)
SetMissionControlConfig will set mission control's config, if the config
provided is valid.
|
default void |
subscribeHtlcEvents(RouterOuterClass.SubscribeHtlcEventsRequest request,
io.grpc.stub.StreamObserver<RouterOuterClass.HtlcEvent> responseObserver)
SubscribeHtlcEvents creates a uni-directional stream from the server to
the client which delivers a stream of htlc events.
|
default void |
trackPayment(RouterOuterClass.TrackPaymentRequest request,
io.grpc.stub.StreamObserver<RouterOuterClass.PaymentStatus> responseObserver)
Deprecated.
|
default void |
trackPayments(RouterOuterClass.TrackPaymentsRequest request,
io.grpc.stub.StreamObserver<LightningApi.Payment> responseObserver)
TrackPayments returns an update stream for every payment that is not in a
terminal state.
|
default void |
trackPaymentV2(RouterOuterClass.TrackPaymentRequest request,
io.grpc.stub.StreamObserver<LightningApi.Payment> responseObserver)
TrackPaymentV2 returns an update stream for the payment identified by the
payment hash.
|
default void |
updateChanStatus(RouterOuterClass.UpdateChanStatusRequest request,
io.grpc.stub.StreamObserver<RouterOuterClass.UpdateChanStatusResponse> responseObserver)
UpdateChanStatus attempts to manually set the state of a channel
(enabled, disabled, or auto).
|
default void |
xImportMissionControl(RouterOuterClass.XImportMissionControlRequest request,
io.grpc.stub.StreamObserver<RouterOuterClass.XImportMissionControlResponse> responseObserver)
XImportMissionControl is an experimental API that imports the state provided
to the internal mission control's state, using all results which are more
recent than our existing values.
|
default void sendPaymentV2(RouterOuterClass.SendPaymentRequest request, io.grpc.stub.StreamObserver<LightningApi.Payment> responseObserver)
SendPaymentV2 attempts to route a payment described by the passed PaymentRequest to the final destination. The call returns a stream of payment updates.
default void trackPaymentV2(RouterOuterClass.TrackPaymentRequest request, io.grpc.stub.StreamObserver<LightningApi.Payment> responseObserver)
TrackPaymentV2 returns an update stream for the payment identified by the payment hash.
default void trackPayments(RouterOuterClass.TrackPaymentsRequest request, io.grpc.stub.StreamObserver<LightningApi.Payment> responseObserver)
TrackPayments returns an update stream for every payment that is not in a terminal state. Note that if payments are in-flight while starting a new subscription, the start of the payment stream could produce out-of-order and/or duplicate events. In order to get updates for every in-flight payment attempt make sure to subscribe to this method before initiating any payments.
default void estimateRouteFee(RouterOuterClass.RouteFeeRequest request, io.grpc.stub.StreamObserver<RouterOuterClass.RouteFeeResponse> responseObserver)
EstimateRouteFee allows callers to obtain a lower bound w.r.t how much it may cost to send an HTLC to the target end destination.
@Deprecated default void sendToRoute(RouterOuterClass.SendToRouteRequest request, io.grpc.stub.StreamObserver<RouterOuterClass.SendToRouteResponse> responseObserver)
Deprecated, use SendToRouteV2. SendToRoute attempts to make a payment via the specified route. This method differs from SendPayment in that it allows users to specify a full route manually. This can be used for things like rebalancing, and atomic swaps. It differs from the newer SendToRouteV2 in that it doesn't return the full HTLC information.
default void sendToRouteV2(RouterOuterClass.SendToRouteRequest request, io.grpc.stub.StreamObserver<LightningApi.HTLCAttempt> responseObserver)
SendToRouteV2 attempts to make a payment via the specified route. This method differs from SendPayment in that it allows users to specify a full route manually. This can be used for things like rebalancing, and atomic swaps.
default void resetMissionControl(RouterOuterClass.ResetMissionControlRequest request, io.grpc.stub.StreamObserver<RouterOuterClass.ResetMissionControlResponse> responseObserver)
ResetMissionControl clears all mission control state and starts with a clean slate.
default void queryMissionControl(RouterOuterClass.QueryMissionControlRequest request, io.grpc.stub.StreamObserver<RouterOuterClass.QueryMissionControlResponse> responseObserver)
QueryMissionControl exposes the internal mission control state to callers. It is a development feature.
default void xImportMissionControl(RouterOuterClass.XImportMissionControlRequest request, io.grpc.stub.StreamObserver<RouterOuterClass.XImportMissionControlResponse> responseObserver)
XImportMissionControl is an experimental API that imports the state provided to the internal mission control's state, using all results which are more recent than our existing values. These values will only be imported in-memory, and will not be persisted across restarts.
default void getMissionControlConfig(RouterOuterClass.GetMissionControlConfigRequest request, io.grpc.stub.StreamObserver<RouterOuterClass.GetMissionControlConfigResponse> responseObserver)
GetMissionControlConfig returns mission control's current config.
default void setMissionControlConfig(RouterOuterClass.SetMissionControlConfigRequest request, io.grpc.stub.StreamObserver<RouterOuterClass.SetMissionControlConfigResponse> responseObserver)
SetMissionControlConfig will set mission control's config, if the config provided is valid.
default void queryProbability(RouterOuterClass.QueryProbabilityRequest request, io.grpc.stub.StreamObserver<RouterOuterClass.QueryProbabilityResponse> responseObserver)
Deprecated. QueryProbability returns the current success probability estimate for a given node pair and amount. The call returns a zero success probability if no channel is available or if the amount violates min/max HTLC constraints.
default void buildRoute(RouterOuterClass.BuildRouteRequest request, io.grpc.stub.StreamObserver<RouterOuterClass.BuildRouteResponse> responseObserver)
BuildRoute builds a fully specified route based on a list of hop public keys. It retrieves the relevant channel policies from the graph in order to calculate the correct fees and time locks.
default void subscribeHtlcEvents(RouterOuterClass.SubscribeHtlcEventsRequest request, io.grpc.stub.StreamObserver<RouterOuterClass.HtlcEvent> responseObserver)
SubscribeHtlcEvents creates a uni-directional stream from the server to the client which delivers a stream of htlc events.
@Deprecated default void sendPayment(RouterOuterClass.SendPaymentRequest request, io.grpc.stub.StreamObserver<RouterOuterClass.PaymentStatus> responseObserver)
Deprecated, use SendPaymentV2. SendPayment attempts to route a payment described by the passed PaymentRequest to the final destination. The call returns a stream of payment status updates.
@Deprecated default void trackPayment(RouterOuterClass.TrackPaymentRequest request, io.grpc.stub.StreamObserver<RouterOuterClass.PaymentStatus> responseObserver)
Deprecated, use TrackPaymentV2. TrackPayment returns an update stream for the payment identified by the payment hash.
default io.grpc.stub.StreamObserver<RouterOuterClass.ForwardHtlcInterceptResponse> htlcInterceptor(io.grpc.stub.StreamObserver<RouterOuterClass.ForwardHtlcInterceptRequest> responseObserver)
HtlcInterceptor dispatches a bi-directional streaming RPC in which Forwarded HTLC requests are sent to the client and the client responds with a boolean that tells LND if this htlc should be intercepted. In case of interception, the htlc can be either settled, cancelled or resumed later by using the ResolveHoldForward endpoint.
default void updateChanStatus(RouterOuterClass.UpdateChanStatusRequest request, io.grpc.stub.StreamObserver<RouterOuterClass.UpdateChanStatusResponse> responseObserver)
UpdateChanStatus attempts to manually set the state of a channel (enabled, disabled, or auto). A manual "disable" request will cause the channel to stay disabled until a subsequent manual request of either "enable" or "auto".