Skip to content

feat(lncli): Add --route_hints flag to sendpayment and queryroutes #9721

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 26, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions cmd/commands/cmd_payments.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import (
"context"
"crypto/rand"
"encoding/hex"
"encoding/json"
"errors"
"fmt"
"io"
Expand Down Expand Up @@ -254,6 +255,15 @@ var SendPaymentCommand = cli.Command{
Name: "keysend",
Usage: "will generate a pre-image and encode it in the sphinx packet, a dest must be set [experimental]",
},
cli.StringFlag{
Name: "route_hints",
Usage: `route hints for sending through private ` +
`channels. eg: ` +
`'[{"hop_hints":[{"node_id":"A","chan_id":1,` +
`"fee_base_msat":2,` +
`"fee_proportional_millionths":3,` +
`"cltv_expiry_delta":4}]}]'`,
},
),
Action: SendPayment,
}
Expand Down Expand Up @@ -473,6 +483,20 @@ func SendPayment(ctx *cli.Context) error {

req.PaymentAddr = payAddr

if ctx.IsSet("route_hints") {
// Parse the route hints JSON.
routeHintsJSON := ctx.String("route_hints")
var routeHints []*lnrpc.RouteHint

err := json.Unmarshal([]byte(routeHintsJSON), &routeHints)
if err != nil {
return fmt.Errorf("error unmarshaling route_hints "+
"json: %w", err)
}

req.RouteHints = routeHints
}

return SendPaymentRequest(ctx, req, conn, conn, routerRPCSendPayment)
}

Expand Down Expand Up @@ -1154,6 +1178,15 @@ var queryRoutesCommand = cli.Command{
blindedBaseFlag,
blindedPPMFlag,
blindedCLTVFlag,
cli.StringFlag{
Name: "route_hints",
Usage: `route hints for searching through private ` +
`channels (and no blinded paths set). eg: ` +
`'[{"hop_hints":[{"node_id":"A","chan_id":1,` +
`"fee_base_msat":2,` +
`"fee_proportional_millionths":3,` +
`"cltv_expiry_delta":4}]}]'`,
},
},
Action: actionDecorator(queryRoutes),
}
Expand Down Expand Up @@ -1248,6 +1281,23 @@ func queryRoutes(ctx *cli.Context) error {
BlindedPaymentPaths: blindedRoutes,
}

if ctx.IsSet("route_hints") {
if len(blindedRoutes) > 0 {
return fmt.Errorf("--route_hints should not be used " +
"if blinded paths are set")
}
routeHintsJSON := ctx.String("route_hints")
var routeHints []*lnrpc.RouteHint

err := json.Unmarshal([]byte(routeHintsJSON), &routeHints)
if err != nil {
return fmt.Errorf("error unmarshaling route_hints "+
"json: %w", err)
}

req.RouteHints = routeHints
}

route, err := client.QueryRoutes(ctxc, req)
if err != nil {
return err
Expand Down
4 changes: 4 additions & 0 deletions docs/release-notes/release-notes-0.20.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,10 @@

## lncli Additions

* [`lncli sendpayment` and `lncli queryroutes` now support the
`--route_hints` flag](https://github.com/lightningnetwork/lnd/pull/9721) to
support routing through private channels.

# Improvements
## Functional Updates

Expand Down
Loading