public static final class RouterGrpc.RouterBlockingStub extends io.grpc.stub.AbstractBlockingStub<RouterGrpc.RouterBlockingStub>
Router is a service that offers advanced interaction with the router subsystem of the daemon.
Modifier and Type | Method and Description |
---|---|
protected RouterGrpc.RouterBlockingStub |
build(io.grpc.Channel channel,
io.grpc.CallOptions callOptions) |
RouterOuterClass.BuildRouteResponse |
buildRoute(RouterOuterClass.BuildRouteRequest request)
BuildRoute builds a fully specified route based on a list of hop public
keys.
|
RouterOuterClass.RouteFeeResponse |
estimateRouteFee(RouterOuterClass.RouteFeeRequest request)
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.
|
RouterOuterClass.GetMissionControlConfigResponse |
getMissionControlConfig(RouterOuterClass.GetMissionControlConfigRequest request)
GetMissionControlConfig returns mission control's current config.
|
RouterOuterClass.QueryMissionControlResponse |
queryMissionControl(RouterOuterClass.QueryMissionControlRequest request)
QueryMissionControl exposes the internal mission control state to callers.
|
RouterOuterClass.QueryProbabilityResponse |
queryProbability(RouterOuterClass.QueryProbabilityRequest request)
Deprecated.
|
RouterOuterClass.ResetMissionControlResponse |
resetMissionControl(RouterOuterClass.ResetMissionControlRequest request)
ResetMissionControl clears all mission control state and starts with a clean
slate.
|
java.util.Iterator<RouterOuterClass.PaymentStatus> |
sendPayment(RouterOuterClass.SendPaymentRequest request)
Deprecated.
|
java.util.Iterator<LightningApi.Payment> |
sendPaymentV2(RouterOuterClass.SendPaymentRequest request)
SendPaymentV2 attempts to route a payment described by the passed
PaymentRequest to the final destination.
|
RouterOuterClass.SendToRouteResponse |
sendToRoute(RouterOuterClass.SendToRouteRequest request)
Deprecated.
|
LightningApi.HTLCAttempt |
sendToRouteV2(RouterOuterClass.SendToRouteRequest request)
SendToRouteV2 attempts to make a payment via the specified route.
|
RouterOuterClass.SetMissionControlConfigResponse |
setMissionControlConfig(RouterOuterClass.SetMissionControlConfigRequest request)
SetMissionControlConfig will set mission control's config, if the config
provided is valid.
|
java.util.Iterator<RouterOuterClass.HtlcEvent> |
subscribeHtlcEvents(RouterOuterClass.SubscribeHtlcEventsRequest request)
SubscribeHtlcEvents creates a uni-directional stream from the server to
the client which delivers a stream of htlc events.
|
java.util.Iterator<RouterOuterClass.PaymentStatus> |
trackPayment(RouterOuterClass.TrackPaymentRequest request)
Deprecated.
|
java.util.Iterator<LightningApi.Payment> |
trackPayments(RouterOuterClass.TrackPaymentsRequest request)
TrackPayments returns an update stream for every payment that is not in a
terminal state.
|
java.util.Iterator<LightningApi.Payment> |
trackPaymentV2(RouterOuterClass.TrackPaymentRequest request)
TrackPaymentV2 returns an update stream for the payment identified by the
payment hash.
|
RouterOuterClass.UpdateChanStatusResponse |
updateChanStatus(RouterOuterClass.UpdateChanStatusRequest request)
UpdateChanStatus attempts to manually set the state of a channel
(enabled, disabled, or auto).
|
RouterOuterClass.XImportMissionControlResponse |
xImportMissionControl(RouterOuterClass.XImportMissionControlRequest request)
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.
|
protected RouterGrpc.RouterBlockingStub build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
build
in class io.grpc.stub.AbstractStub<RouterGrpc.RouterBlockingStub>
public java.util.Iterator<LightningApi.Payment> sendPaymentV2(RouterOuterClass.SendPaymentRequest request)
SendPaymentV2 attempts to route a payment described by the passed PaymentRequest to the final destination. The call returns a stream of payment updates.
public java.util.Iterator<LightningApi.Payment> trackPaymentV2(RouterOuterClass.TrackPaymentRequest request)
TrackPaymentV2 returns an update stream for the payment identified by the payment hash.
public java.util.Iterator<LightningApi.Payment> trackPayments(RouterOuterClass.TrackPaymentsRequest request)
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.
public RouterOuterClass.RouteFeeResponse estimateRouteFee(RouterOuterClass.RouteFeeRequest request)
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 public RouterOuterClass.SendToRouteResponse sendToRoute(RouterOuterClass.SendToRouteRequest request)
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.
public LightningApi.HTLCAttempt sendToRouteV2(RouterOuterClass.SendToRouteRequest request)
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.
public RouterOuterClass.ResetMissionControlResponse resetMissionControl(RouterOuterClass.ResetMissionControlRequest request)
ResetMissionControl clears all mission control state and starts with a clean slate.
public RouterOuterClass.QueryMissionControlResponse queryMissionControl(RouterOuterClass.QueryMissionControlRequest request)
QueryMissionControl exposes the internal mission control state to callers. It is a development feature.
public RouterOuterClass.XImportMissionControlResponse xImportMissionControl(RouterOuterClass.XImportMissionControlRequest request)
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.
public RouterOuterClass.GetMissionControlConfigResponse getMissionControlConfig(RouterOuterClass.GetMissionControlConfigRequest request)
GetMissionControlConfig returns mission control's current config.
public RouterOuterClass.SetMissionControlConfigResponse setMissionControlConfig(RouterOuterClass.SetMissionControlConfigRequest request)
SetMissionControlConfig will set mission control's config, if the config provided is valid.
public RouterOuterClass.QueryProbabilityResponse queryProbability(RouterOuterClass.QueryProbabilityRequest request)
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.
public RouterOuterClass.BuildRouteResponse buildRoute(RouterOuterClass.BuildRouteRequest request)
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.
public java.util.Iterator<RouterOuterClass.HtlcEvent> subscribeHtlcEvents(RouterOuterClass.SubscribeHtlcEventsRequest request)
SubscribeHtlcEvents creates a uni-directional stream from the server to the client which delivers a stream of htlc events.
@Deprecated public java.util.Iterator<RouterOuterClass.PaymentStatus> sendPayment(RouterOuterClass.SendPaymentRequest request)
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 public java.util.Iterator<RouterOuterClass.PaymentStatus> trackPayment(RouterOuterClass.TrackPaymentRequest request)
Deprecated, use TrackPaymentV2. TrackPayment returns an update stream for the payment identified by the payment hash.
public RouterOuterClass.UpdateChanStatusResponse updateChanStatus(RouterOuterClass.UpdateChanStatusRequest request)
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".