← Watch feed
routerrpc: document default timeout for EstimateRouteFee probes
Public commit record
73/100 · Adequate
What the developer wrote
Authored by Boris Nagaev
routerrpc: document default timeout for EstimateRouteFee probes
The RouteFeeRequest.timeout field did not document its behavior when
unset or explicitly set to zero. This is easy to misread as "no
timeout", i.e. an unbounded, uncancellable probe, especially given the
adjacent note that canceling the context does not stop the payment
loop.
In practice the probe path runs through SendPaymentV2, which replaces a
zero timeout_seconds with DefaultPaymentTimeout (60 seconds) before
dispatching the probe. A zero or unset timeout therefore falls back to
the same 60 second default that SendPaymentRequest.timeout_seconds
already documents.
Mirror that wording on RouteFeeRequest.timeout so the zero-value
behavior is explicit, and update the generated gRPC stub and swagger
description to match. Documentation only; no behavior change.
✓ Specific, descriptive subject✓ Names a concrete action or component✓ Provides detailed explanatory context
What changed, and why it matters
This commit only updates API documentation comments for the EstimateRouteFee feature. It clarifies that leaving the timeout field unset or setting it to zero causes a 60-second default to be used. No code behavior was changed.
Recommended action
No action required. This is a documentation-only clarification and does not alter runtime behavior.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The patch modifies lnrpc/routerrpc/router.proto, the generated router.pb.go, and router.swagger.json to add a sentence explaining the zero-value fallback for RouteFeeRequest.timeout. The commit message explicitly states this is documentation only and no behavior change. The underlying behavior (zero timeout replaced by DefaultPaymentTimeout in SendPaymentV2) already existed.
Changed components
lnrpc/routerrpc/router.protolnrpc/routerrpc/router.pb.golnrpc/routerrpc/router.swagger.jsonInspect captured patch +5 / −3
diff --git a/lnrpc/routerrpc/router.pb.go b/lnrpc/routerrpc/router.pb.go
index ff213e5..3008177 100644
--- a/lnrpc/routerrpc/router.pb.go
+++ b/lnrpc/routerrpc/router.pb.go
@@ -777,7 +777,8 @@ type RouteFeeRequest struct {
// timeout is reached. Note that the probing process itself can take longer
// than the timeout if the HTLC becomes delayed or stuck. Canceling the context
// of this call will not cancel the payment loop, the duration is only
- // controlled by the timeout parameter.
+ // controlled by the timeout parameter. If the field is not set or is
+ // explicitly set to zero, the default value of 60 seconds will be applied.
Timeout uint32 `protobuf:"varint,4,opt,name=timeout,proto3" json:"timeout,omitempty"`
// The channel ids of the channels that are allowed for the first hop. If
// empty, any channel may be used. This field is applicable to both
diff --git a/lnrpc/routerrpc/router.proto b/lnrpc/routerrpc/router.proto
index 0f7cc6b..a8aebe9 100644
--- a/lnrpc/routerrpc/router.proto
+++ b/lnrpc/routerrpc/router.proto
@@ -407,7 +407,8 @@ message RouteFeeRequest {
timeout is reached. Note that the probing process itself can take longer
than the timeout if the HTLC becomes delayed or stuck. Canceling the context
of this call will not cancel the payment loop, the duration is only
- controlled by the timeout parameter.
+ controlled by the timeout parameter. If the field is not set or is
+ explicitly set to zero, the default value of 60 seconds will be applied.
*/
uint32 timeout = 4;
diff --git a/lnrpc/routerrpc/router.swagger.json b/lnrpc/routerrpc/router.swagger.json
index d8bf6c9..121c50d 100644
--- a/lnrpc/routerrpc/router.swagger.json
+++ b/lnrpc/routerrpc/router.swagger.json
@@ -1935,7 +1935,7 @@
"timeout": {
"type": "integer",
"format": "int64",
- "description": "A user preference of how long a probe payment should maximally be allowed to\ntake, denoted in seconds. The probing payment loop is aborted if this\ntimeout is reached. Note that the probing process itself can take longer\nthan the timeout if the HTLC becomes delayed or stuck. Canceling the context\nof this call will not cancel the payment loop, the duration is only\ncontrolled by the timeout parameter."
+ "description": "A user preference of how long a probe payment should maximally be allowed to\ntake, denoted in seconds. The probing payment loop is aborted if this\ntimeout is reached. Note that the probing process itself can take longer\nthan the timeout if the HTLC becomes delayed or stuck. Canceling the context\nof this call will not cancel the payment loop, the duration is only\ncontrolled by the timeout parameter. If the field is not set or is\nexplicitly set to zero, the default value of 60 seconds will be applied."
},
"outgoing_chan_ids": {
"type": "array",
Risk score
Our methodology →Why this scored 15/100
Human-validated context
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
No validated notes yet.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.