public static final class RouterGrpc.RouterFutureStub extends io.grpc.stub.AbstractFutureStub<RouterGrpc.RouterFutureStub>
Router is a service that offers advanced interaction with the router subsystem of the daemon.
Modifier and Type | Method and Description |
---|---|
protected RouterGrpc.RouterFutureStub |
build(io.grpc.Channel channel,
io.grpc.CallOptions callOptions) |
com.google.common.util.concurrent.ListenableFuture<RouterOuterClass.BuildRouteResponse> |
buildRoute(RouterOuterClass.BuildRouteRequest request)
BuildRoute builds a fully specified route based on a list of hop public
keys.
|
com.google.common.util.concurrent.ListenableFuture<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.
|
com.google.common.util.concurrent.ListenableFuture<RouterOuterClass.GetMissionControlConfigResponse> |
getMissionControlConfig(RouterOuterClass.GetMissionControlConfigRequest request)
GetMissionControlConfig returns mission control's current config.
|
com.google.common.util.concurrent.ListenableFuture<RouterOuterClass.QueryMissionControlResponse> |
queryMissionControl(RouterOuterClass.QueryMissionControlRequest request)
QueryMissionControl exposes the internal mission control state to callers.
|
com.google.common.util.concurrent.ListenableFuture<RouterOuterClass.QueryProbabilityResponse> |
queryProbability(RouterOuterClass.QueryProbabilityRequest request)
Deprecated.
|
com.google.common.util.concurrent.ListenableFuture<RouterOuterClass.ResetMissionControlResponse> |
resetMissionControl(RouterOuterClass.ResetMissionControlRequest request)
ResetMissionControl clears all mission control state and starts with a clean
slate.
|
com.google.common.util.concurrent.ListenableFuture<RouterOuterClass.SendToRouteResponse> |
sendToRoute(RouterOuterClass.SendToRouteRequest request)
Deprecated.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.HTLCAttempt> |
sendToRouteV2(RouterOuterClass.SendToRouteRequest request)
SendToRouteV2 attempts to make a payment via the specified route.
|
com.google.common.util.concurrent.ListenableFuture<RouterOuterClass.SetMissionControlConfigResponse> |
setMissionControlConfig(RouterOuterClass.SetMissionControlConfigRequest request)
SetMissionControlConfig will set mission control's config, if the config
provided is valid.
|
com.google.common.util.concurrent.ListenableFuture<RouterOuterClass.UpdateChanStatusResponse> |
updateChanStatus(RouterOuterClass.UpdateChanStatusRequest request)
UpdateChanStatus attempts to manually set the state of a channel
(enabled, disabled, or auto).
|
com.google.common.util.concurrent.ListenableFuture<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.RouterFutureStub build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
build
in class io.grpc.stub.AbstractStub<RouterGrpc.RouterFutureStub>
public com.google.common.util.concurrent.ListenableFuture<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 com.google.common.util.concurrent.ListenableFuture<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 com.google.common.util.concurrent.ListenableFuture<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 com.google.common.util.concurrent.ListenableFuture<RouterOuterClass.ResetMissionControlResponse> resetMissionControl(RouterOuterClass.ResetMissionControlRequest request)
ResetMissionControl clears all mission control state and starts with a clean slate.
public com.google.common.util.concurrent.ListenableFuture<RouterOuterClass.QueryMissionControlResponse> queryMissionControl(RouterOuterClass.QueryMissionControlRequest request)
QueryMissionControl exposes the internal mission control state to callers. It is a development feature.
public com.google.common.util.concurrent.ListenableFuture<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 com.google.common.util.concurrent.ListenableFuture<RouterOuterClass.GetMissionControlConfigResponse> getMissionControlConfig(RouterOuterClass.GetMissionControlConfigRequest request)
GetMissionControlConfig returns mission control's current config.
public com.google.common.util.concurrent.ListenableFuture<RouterOuterClass.SetMissionControlConfigResponse> setMissionControlConfig(RouterOuterClass.SetMissionControlConfigRequest request)
SetMissionControlConfig will set mission control's config, if the config provided is valid.
public com.google.common.util.concurrent.ListenableFuture<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 com.google.common.util.concurrent.ListenableFuture<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 com.google.common.util.concurrent.ListenableFuture<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".