← Watch feed
routerrpc: add missing lncli tags for RPC documentation
Public commit record
73/100 · Adequate
What the developer wrote
Authored by saubyk
routerrpc: add missing lncli tags for RPC documentation
Add lncli: tags to SendPaymentV2, SendToRouteV2, and EstimateRouteFee
proto definitions so the generated API docs correctly show their
corresponding CLI commands (sendpayment, sendtoroute, estimateroutefee)
instead of "There is no CLI command for this RPC".
✓ Specific, descriptive subject✓ Names a concrete action or component✓ Provides detailed explanatory context
What changed, and why it matters
This commit only updates documentation comments in protocol-buffer definitions and the generated API documentation files. It adds labels that tell readers which lncli command corresponds to three existing RPCs. No code behavior, permissions, or network logic changed.
Recommended action
No security action needed; this is a documentation-only change.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff adds lncli: tags to the proto comments for SendPaymentV2, EstimateRouteFee, and SendToRouteV2, then regenerates router.swagger.json and router_grpc.pb.go so the generated docs display the CLI command names. There are no functional changes to RPC handlers, request/response messages, validation, authentication, or routing behavior.
Changed components
lnrpc/routerrpc/router.protolnrpc/routerrpc/router.swagger.jsonlnrpc/routerrpc/router_grpc.pb.goInspect captured patch +12 / −6
diff --git a/lnrpc/routerrpc/router.proto b/lnrpc/routerrpc/router.proto
index 72fe020..fbdeb85 100644
--- a/lnrpc/routerrpc/router.proto
+++ b/lnrpc/routerrpc/router.proto
@@ -27,7 +27,7 @@ option go_package = "github.com/lightningnetwork/lnd/lnrpc/routerrpc";
// Router is a service that offers advanced interaction with the router
// subsystem of the daemon.
service Router {
- /*
+ /* lncli: `sendpayment`
SendPaymentV2 attempts to route a payment described by the passed
PaymentRequest to the final destination. The call returns a stream of
payment updates. When using this RPC, make sure to set a fee limit, as the
@@ -53,7 +53,7 @@ service Router {
*/
rpc TrackPayments (TrackPaymentsRequest) returns (stream lnrpc.Payment);
- /*
+ /* lncli: `estimateroutefee`
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.
*/
@@ -70,7 +70,7 @@ service Router {
option deprecated = true;
}
- /*
+ /* lncli: `sendtoroute`
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
diff --git a/lnrpc/routerrpc/router.swagger.json b/lnrpc/routerrpc/router.swagger.json
index 59aa426..9dc3f78 100644
--- a/lnrpc/routerrpc/router.swagger.json
+++ b/lnrpc/routerrpc/router.swagger.json
@@ -326,7 +326,7 @@
},
"/v2/router/route/estimatefee": {
"post": {
- "summary": "EstimateRouteFee allows callers to obtain a lower bound w.r.t how much it\nmay cost to send an HTLC to the target end destination.",
+ "summary": "lncli: `estimateroutefee`\nEstimateRouteFee allows callers to obtain a lower bound w.r.t how much it\nmay cost to send an HTLC to the target end destination.",
"operationId": "Router_EstimateRouteFee",
"responses": {
"200": {
@@ -359,7 +359,7 @@
},
"/v2/router/route/send": {
"post": {
- "summary": "SendToRouteV2 attempts to make a payment via the specified route. This\nmethod differs from SendPayment in that it allows users to specify a full\nroute manually. This can be used for things like rebalancing, and atomic\nswaps.",
+ "summary": "lncli: `sendtoroute`\nSendToRouteV2 attempts to make a payment via the specified route. This\nmethod differs from SendPayment in that it allows users to specify a full\nroute manually. This can be used for things like rebalancing, and atomic\nswaps.",
"operationId": "Router_SendToRouteV2",
"responses": {
"200": {
@@ -392,7 +392,7 @@
},
"/v2/router/send": {
"post": {
- "summary": "SendPaymentV2 attempts to route a payment described by the passed\nPaymentRequest to the final destination. The call returns a stream of\npayment updates. When using this RPC, make sure to set a fee limit, as the\ndefault routing fee limit is 0 sats. Without a non-zero fee limit only\nroutes without fees will be attempted which often fails with\nFAILURE_REASON_NO_ROUTE.",
+ "summary": "lncli: `sendpayment`\nSendPaymentV2 attempts to route a payment described by the passed\nPaymentRequest to the final destination. The call returns a stream of\npayment updates. When using this RPC, make sure to set a fee limit, as the\ndefault routing fee limit is 0 sats. Without a non-zero fee limit only\nroutes without fees will be attempted which often fails with\nFAILURE_REASON_NO_ROUTE.",
"operationId": "Router_SendPaymentV2",
"responses": {
"200": {
diff --git a/lnrpc/routerrpc/router_grpc.pb.go b/lnrpc/routerrpc/router_grpc.pb.go
index 6e7e980..33de748 100644
--- a/lnrpc/routerrpc/router_grpc.pb.go
+++ b/lnrpc/routerrpc/router_grpc.pb.go
@@ -19,6 +19,7 @@ const _ = grpc.SupportPackageIsVersion7
//
// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
type RouterClient interface {
+ // lncli: `sendpayment`
// SendPaymentV2 attempts to route a payment described by the passed
// PaymentRequest to the final destination. The call returns a stream of
// payment updates. When using this RPC, make sure to set a fee limit, as the
@@ -37,6 +38,7 @@ type RouterClient interface {
// payment attempt make sure to subscribe to this method before initiating any
// payments.
TrackPayments(ctx context.Context, in *TrackPaymentsRequest, opts ...grpc.CallOption) (Router_TrackPaymentsClient, error)
+ // lncli: `estimateroutefee`
// 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.
EstimateRouteFee(ctx context.Context, in *RouteFeeRequest, opts ...grpc.CallOption) (*RouteFeeResponse, error)
@@ -48,6 +50,7 @@ type RouterClient interface {
// things like rebalancing, and atomic swaps. It differs from the newer
// SendToRouteV2 in that it doesn't return the full HTLC information.
SendToRoute(ctx context.Context, in *SendToRouteRequest, opts ...grpc.CallOption) (*SendToRouteResponse, error)
+ // lncli: `sendtoroute`
// 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
@@ -497,6 +500,7 @@ func (c *routerClient) XFindBaseLocalChanAlias(ctx context.Context, in *FindBase
// All implementations must embed UnimplementedRouterServer
// for forward compatibility
type RouterServer interface {
+ // lncli: `sendpayment`
// SendPaymentV2 attempts to route a payment described by the passed
// PaymentRequest to the final destination. The call returns a stream of
// payment updates. When using this RPC, make sure to set a fee limit, as the
@@ -515,6 +519,7 @@ type RouterServer interface {
// payment attempt make sure to subscribe to this method before initiating any
// payments.
TrackPayments(*TrackPaymentsRequest, Router_TrackPaymentsServer) error
+ // lncli: `estimateroutefee`
// 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.
EstimateRouteFee(context.Context, *RouteFeeRequest) (*RouteFeeResponse, error)
@@ -526,6 +531,7 @@ type RouterServer interface {
// things like rebalancing, and atomic swaps. It differs from the newer
// SendToRouteV2 in that it doesn't return the full HTLC information.
SendToRoute(context.Context, *SendToRouteRequest) (*SendToRouteResponse, error)
+ // lncli: `sendtoroute`
// 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
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.