highperfocused/lnd
1
0
Fork 0
mirror of https://github.com/lightningnetwork/lnd.git synced 2025-06-07 13:39:46 +02:00
Code Issues Packages Projects Releases Wiki Activity

routerrpc: update QueryProbability documentation

Browse Source 
Changes the docstring of QueryProbability to reflect changes that were
introduced in #6857.
This commit is contained in:
bitromortac 2023-01-11 15:51:39 +01:00
parent b1d6991b27
commit 045e5cf307
No known key found for this signature in database
GPG Key ID: 1965063FC13BEBE2
3 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
lnrpc/routerrpc/router.proto
View File

@ -95,7 +95,9 @@ service Router {
/* /*
Deprecated. QueryProbability returns the current success probability 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) rpc QueryProbability (QueryProbabilityRequest)
returns (QueryProbabilityResponse); returns (QueryProbabilityResponse);

2
lnrpc/routerrpc/router.swagger.json
View File

@ -116,7 +116,7 @@
}, },
"/v2/router/mc/probability/{from_node}/{to_node}/{amt_msat}": { "/v2/router/mc/probability/{from_node}/{to_node}/{amt_msat}": {
"get": { "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", "operationId": "Router_QueryProbability",
"responses": { "responses": {
"200": { "200": {

8
lnrpc/routerrpc/router_grpc.pb.go
View File

@ -66,7 +66,9 @@ type RouterClient interface {
// provided is valid. // provided is valid.
SetMissionControlConfig(ctx context.Context, in *SetMissionControlConfigRequest, opts ...grpc.CallOption) (*SetMissionControlConfigResponse, error) SetMissionControlConfig(ctx context.Context, in *SetMissionControlConfigRequest, opts ...grpc.CallOption) (*SetMissionControlConfigResponse, error)
// Deprecated. QueryProbability returns the current success probability // 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) QueryProbability(ctx context.Context, in *QueryProbabilityRequest, opts ...grpc.CallOption) (*QueryProbabilityResponse, error)
// BuildRoute builds a fully specified route based on a list of hop public // 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 // keys. It retrieves the relevant channel policies from the graph in order to
@ -484,7 +486,9 @@ type RouterServer interface {
// provided is valid. // provided is valid.
SetMissionControlConfig(context.Context, *SetMissionControlConfigRequest) (*SetMissionControlConfigResponse, error) SetMissionControlConfig(context.Context, *SetMissionControlConfigRequest) (*SetMissionControlConfigResponse, error)
// Deprecated. QueryProbability returns the current success probability // 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) QueryProbability(context.Context, *QueryProbabilityRequest) (*QueryProbabilityResponse, error)
// BuildRoute builds a fully specified route based on a list of hop public // 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 // keys. It retrieves the relevant channel policies from the graph in order to