diff --git a/cmd/lncli/cmd_invoice.go b/cmd/lncli/cmd_invoice.go index cdb177780..4053a8d7d 100644 --- a/cmd/lncli/cmd_invoice.go +++ b/cmd/lncli/cmd_invoice.go @@ -64,7 +64,10 @@ var addInvoiceCommand = cli.Command{ Name: "private", Usage: "encode routing hints in the invoice with " + "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{ Name: "amp", diff --git a/lnrpc/invoicesrpc/invoices.swagger.json b/lnrpc/invoicesrpc/invoices.swagger.json index f220d5988..ff3294e70 100644 --- a/lnrpc/invoicesrpc/invoices.swagger.json +++ b/lnrpc/invoicesrpc/invoices.swagger.json @@ -514,7 +514,7 @@ }, "private": { "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": { "type": "string", diff --git a/lnrpc/lightning.pb.go b/lnrpc/lightning.pb.go index 767198040..fe97d362c 100644 --- a/lnrpc/lightning.pb.go +++ b/lnrpc/lightning.pb.go @@ -11640,6 +11640,8 @@ type Invoice struct { // invoice's destination. 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. + // 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"` // The "add" index of this invoice. Each newly created invoice will increment // this index making it monotonically increasing. Callers to the diff --git a/lnrpc/lightning.proto b/lnrpc/lightning.proto index aa3138690..73cb4f72b 100644 --- a/lnrpc/lightning.proto +++ b/lnrpc/lightning.proto @@ -3401,6 +3401,8 @@ message Invoice { repeated RouteHint route_hints = 14; // 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; /* diff --git a/lnrpc/lightning.swagger.json b/lnrpc/lightning.swagger.json index 0b0f86adc..24223fad1 100644 --- a/lnrpc/lightning.swagger.json +++ b/lnrpc/lightning.swagger.json @@ -5048,7 +5048,7 @@ }, "private": { "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": { "type": "string",