routerrpc: update QueryProbability documentation

Changes the docstring of QueryProbability to reflect changes that were
introduced in #6857.
This commit is contained in:
bitromortac committed 2023-01-11 16:47:54 +01:00
1 parent b1d6991b27
commit 045e5cf307
3 files changed
+10 -4

No files matched your search

+6 -2
View File
@@ -66,7 +66,9 @@ type RouterClient interface {
// provided is valid.
SetMissionControlConfig(ctx context.Context, in *SetMissionControlConfigRequest, opts ...grpc.CallOption) (*SetMissionControlConfigResponse, error)
// Deprecated. QueryProbability returns the current success probability
// estimate for a given node pair and amount.
// 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.
QueryProbability(ctx context.Context, in *QueryProbabilityRequest, opts ...grpc.CallOption) (*QueryProbabilityResponse, error)
// 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
@@ -484,7 +486,9 @@ type RouterServer interface {
// provided is valid.
SetMissionControlConfig(context.Context, *SetMissionControlConfigRequest) (*SetMissionControlConfigResponse, error)
// Deprecated. QueryProbability returns the current success probability
// estimate for a given node pair and amount.
// 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.
QueryProbability(context.Context, *QueryProbabilityRequest) (*QueryProbabilityResponse, error)
// 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