mirrors/lnd
1
0
Fork 0
mirror of https://github.com/lightningnetwork/lnd.git synced 2025-01-19 05:45:21 +01:00
Code Issues Projects Releases Wiki Activity

lnrpc+cmd: clarify docs about addinvoice no-amount hop hints

Browse Source 
Add additional comment to `lnclic addinvoice`'s `--private` flag warning
about including a large number of private channel hints when using zero
ammounts.

Also added a comment to the `private` field in the `Invoice` proto
message.
This commit is contained in:
alpeb-btc 2022-11-04 15:56:47 -05:00
parent 0cae501009
commit eefe1c816e
No known key found for this signature in database
GPG Key ID: D5ED3433FAD75FDC
5 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
cmd/lncli/cmd_invoice.go
View File

@ -64,7 +64,10 @@ var addInvoiceCommand = cli.Command{
Name: "private", Name: "private",
Usage: "encode routing hints in the invoice with " + Usage: "encode routing hints in the invoice with " +
"private channels in order to assist the " + "private channels in order to assist the " +
"payer in reaching you", "payer in reaching you. If amt and amt_msat " +
"are zero, a large number of hints with " +
"these channels can be included, which " +
"might not be desirable.",
}, },
cli.BoolFlag{ cli.BoolFlag{
Name: "amp", Name: "amp",

2
lnrpc/invoicesrpc/invoices.swagger.json
View File

@ -514,7 +514,7 @@
}, },
"private": { "private": {
"type": "boolean", "type": "boolean",
"description": "Whether this invoice should include routing hints for private channels." "description": "Whether this invoice should include routing hints for private channels.\nNote: When enabled, if value and value_msat are zero, a large number of\nhints with these channels can be included, which might not be desirable."
}, },
"add_index": { "add_index": {
"type": "string", "type": "string",

2
lnrpc/lightning.pb.go
View File

@ -11640,6 +11640,8 @@ type Invoice struct {
// invoice's destination. // invoice's destination.
RouteHints []*RouteHint `protobuf:"bytes,14,rep,name=route_hints,json=routeHints,proto3" json:"route_hints,omitempty"` RouteHints []*RouteHint `protobuf:"bytes,14,rep,name=route_hints,json=routeHints,proto3" json:"route_hints,omitempty"`
// Whether this invoice should include routing hints for private channels. // Whether this invoice should include routing hints for private channels.
// Note: When enabled, if value and value_msat are zero, a large number of
// hints with these channels can be included, which might not be desirable.
Private bool `protobuf:"varint,15,opt,name=private,proto3" json:"private,omitempty"` Private bool `protobuf:"varint,15,opt,name=private,proto3" json:"private,omitempty"`
// The "add" index of this invoice. Each newly created invoice will increment // The "add" index of this invoice. Each newly created invoice will increment
// this index making it monotonically increasing. Callers to the // this index making it monotonically increasing. Callers to the

2
lnrpc/lightning.proto
View File

@ -3401,6 +3401,8 @@ message Invoice {
repeated RouteHint route_hints = 14; repeated RouteHint route_hints = 14;
// Whether this invoice should include routing hints for private channels. // Whether this invoice should include routing hints for private channels.
// Note: When enabled, if value and value_msat are zero, a large number of
// hints with these channels can be included, which might not be desirable.
bool private = 15; bool private = 15;
/* /*

2
lnrpc/lightning.swagger.json
View File

@ -5048,7 +5048,7 @@
}, },
"private": { "private": {
"type": "boolean", "type": "boolean",
"description": "Whether this invoice should include routing hints for private channels." "description": "Whether this invoice should include routing hints for private channels.\nNote: When enabled, if value and value_msat are zero, a large number of\nhints with these channels can be included, which might not be desirable."
}, },
"add_index": { "add_index": {
"type": "string", "type": "string",