From 045e5cf30782aabe015cb2c58805d8cce2753cdc Mon Sep 17 00:00:00 2001 From: bitromortac Date: Wed, 11 Jan 2023 15:51:39 +0100 Subject: [PATCH] routerrpc: update QueryProbability documentation Changes the docstring of QueryProbability to reflect changes that were introduced in #6857. --- lnrpc/routerrpc/router.proto | 4 +++- lnrpc/routerrpc/router.swagger.json | 2 +- lnrpc/routerrpc/router_grpc.pb.go | 8 ++++++-- 3 files changed, 10 insertions(+), 4 deletions(-) diff --git a/lnrpc/routerrpc/router.proto b/lnrpc/routerrpc/router.proto index cf0de130b..600511fe4 100644 --- a/lnrpc/routerrpc/router.proto +++ b/lnrpc/routerrpc/router.proto @@ -95,7 +95,9 @@ service Router { /* 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. */ rpc QueryProbability (QueryProbabilityRequest) returns (QueryProbabilityResponse); diff --git a/lnrpc/routerrpc/router.swagger.json b/lnrpc/routerrpc/router.swagger.json index 1503f2a15..e428c57e6 100644 --- a/lnrpc/routerrpc/router.swagger.json +++ b/lnrpc/routerrpc/router.swagger.json @@ -116,7 +116,7 @@ }, "/v2/router/mc/probability/{from_node}/{to_node}/{amt_msat}": { "get": { - "summary": "Deprecated. QueryProbability returns the current success probability\nestimate for a given node pair and amount.", + "summary": "Deprecated. QueryProbability returns the current success probability\nestimate for a given node pair and amount. The call returns a zero success\nprobability if no channel is available or if the amount violates min/max\nHTLC constraints.", "operationId": "Router_QueryProbability", "responses": { "200": { diff --git a/lnrpc/routerrpc/router_grpc.pb.go b/lnrpc/routerrpc/router_grpc.pb.go index 9a65770a3..3cc753ad7 100644 --- a/lnrpc/routerrpc/router_grpc.pb.go +++ b/lnrpc/routerrpc/router_grpc.pb.go @@ -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