Skip to content

lnrpc: Clarify payment_addr and payment_secret #8479

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.

Sign up for GitHub

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
guggero merged 1 commit into from
Feb 14, 2024
Merged

lnrpc: Clarify payment_addr and payment_secret #8479

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 3 additions & 2 deletions lnrpc/invoicesrpc/invoices.pb.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 3 additions & 2 deletions lnrpc/invoicesrpc/invoices.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,8 +138,9 @@ message AddHoldInvoiceResp {
uint64 add_index = 2;

/*
The payment address of the generated invoice. This value should be used
in all payments for this invoice as we require it for end to end
The payment address of the generated invoice. This is also called
the payment secret in specifications (e.g. BOLT 11). This value should
be used in all payments for this invoice as we require it for end to end
security.
*/
bytes payment_addr = 3;
Expand Down
4 changes: 2 additions & 2 deletions lnrpc/invoicesrpc/invoices.swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,7 @@
"payment_addr": {
"type": "string",
"format": "byte",
"description": "The payment address of the generated invoice. This value should be used\nin all payments for this invoice as we require it for end to end\nsecurity."
"description": "The payment address of the generated invoice. This is also called\nthe payment secret in specifications (e.g. BOLT 11). This value should\nbe used in all payments for this invoice as we require it for end to end\nsecurity."
}
}
},
Expand Down Expand Up @@ -565,7 +565,7 @@
"payment_addr": {
"type": "string",
"format": "byte",
"description": "The payment address of this invoice. This value will be used in MPP\npayments, and also for newer invoices that always require the MPP payload\nfor added end-to-end security.\nNote: Output only, don't specify for creating an invoice."
"description": "The payment address of this invoice. This is also called payment secret in\nspecifications (e.g. BOLT 11). This value will be used in MPP payments, and\nalso for newer invoices that always require the MPP payload for added\nend-to-end security.\nNote: Output only, don't specify for creating an invoice."
},
"is_amp": {
"type": "boolean",
Expand Down
19 changes: 11 additions & 8 deletions lnrpc/lightning.pb.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

19 changes: 11 additions & 8 deletions lnrpc/lightning.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -884,7 +884,8 @@ message SendRequest {
repeated FeatureBit dest_features = 15;

/*
The payment address of the generated invoice.
The payment address of the generated invoice. This is also called
payment secret in specifications (e.g. BOLT 11).
*/
bytes payment_addr = 16;
}
Expand Down Expand Up @@ -3197,7 +3198,8 @@ message MPPRecord {
A unique, random identifier used to authenticate the sender as the intended
payer of a multi-path payment. The payment_addr must be the same for all
subpayments, and match the payment_addr provided in the receiver's invoice.
The same payment_addr must be used on all subpayments.
The same payment_addr must be used on all subpayments. This is also called
payment secret in specifications (e.g. BOLT 11).
*/
bytes payment_addr = 11;

Expand Down Expand Up @@ -3776,9 +3778,10 @@ message Invoice {
bool is_keysend = 25;

/*
The payment address of this invoice. This value will be used in MPP
payments, and also for newer invoices that always require the MPP payload
for added end-to-end security.
The payment address of this invoice. This is also called payment secret in
specifications (e.g. BOLT 11). This value will be used in MPP payments, and
also for newer invoices that always require the MPP payload for added
end-to-end security.
Note: Output only, don't specify for creating an invoice.
*/
bytes payment_addr = 26;
Expand Down Expand Up @@ -3883,9 +3886,9 @@ message AddInvoiceResponse {
uint64 add_index = 16;

/*
The payment address of the generated invoice. This value should be used
in all payments for this invoice as we require it for end to end
security.
The payment address of the generated invoice. This is also called
payment secret in specifications (e.g. BOLT 11). This value should be used
in all payments for this invoice as we require it for end to end security.
*/
bytes payment_addr = 17;
}
Expand Down
8 changes: 4 additions & 4 deletions lnrpc/lightning.swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3250,7 +3250,7 @@
"payment_addr": {
"type": "string",
"format": "byte",
"description": "The payment address of the generated invoice. This value should be used\nin all payments for this invoice as we require it for end to end\nsecurity."
"description": "The payment address of the generated invoice. This is also called\npayment secret in specifications (e.g. BOLT 11). This value should be used\nin all payments for this invoice as we require it for end to end security."
}
}
},
Expand Down Expand Up @@ -5407,7 +5407,7 @@
"payment_addr": {
"type": "string",
"format": "byte",
"description": "The payment address of this invoice. This value will be used in MPP\npayments, and also for newer invoices that always require the MPP payload\nfor added end-to-end security.\nNote: Output only, don't specify for creating an invoice."
"description": "The payment address of this invoice. This is also called payment secret in\nspecifications (e.g. BOLT 11). This value will be used in MPP payments, and\nalso for newer invoices that always require the MPP payload for added\nend-to-end security.\nNote: Output only, don't specify for creating an invoice."
},
"is_amp": {
"type": "boolean",
Expand Down Expand Up @@ -5715,7 +5715,7 @@
"payment_addr": {
"type": "string",
"format": "byte",
"description": "A unique, random identifier used to authenticate the sender as the intended\npayer of a multi-path payment. The payment_addr must be the same for all\nsubpayments, and match the payment_addr provided in the receiver's invoice.\nThe same payment_addr must be used on all subpayments."
"description": "A unique, random identifier used to authenticate the sender as the intended\npayer of a multi-path payment. The payment_addr must be the same for all\nsubpayments, and match the payment_addr provided in the receiver's invoice.\nThe same payment_addr must be used on all subpayments. This is also called\npayment secret in specifications (e.g. BOLT 11)."
},
"total_amt_msat": {
"type": "string",
Expand Down Expand Up @@ -7052,7 +7052,7 @@
"payment_addr": {
"type": "string",
"format": "byte",
"description": "The payment address of the generated invoice."
"description": "The payment address of the generated invoice. This is also called\npayment secret in specifications (e.g. BOLT 11)."
}
}
},
Expand Down
2 changes: 2 additions & 0 deletions lnrpc/routerrpc/router.pb.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 8 additions & 2 deletions lnrpc/routerrpc/router.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -306,7 +306,10 @@ message SendPaymentRequest {
*/
repeated uint64 outgoing_chan_ids = 19;

// An optional payment addr to be included within the last hop of the route.
/*
An optional payment addr to be included within the last hop of the route.
This is also called payment secret in specifications (e.g. BOLT 11).
*/
bytes payment_addr = 20;

/*
Expand Down Expand Up @@ -659,7 +662,10 @@ message BuildRouteRequest {
*/
repeated bytes hop_pubkeys = 4;

// An optional payment addr to be included within the last hop of the route.
/*
An optional payment addr to be included within the last hop of the route.
This is also called payment secret in specifications (e.g. BOLT 11).
*/
bytes payment_addr = 5;
}

Expand Down
6 changes: 3 additions & 3 deletions lnrpc/routerrpc/router.swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -927,7 +927,7 @@
"payment_addr": {
"type": "string",
"format": "byte",
"description": "A unique, random identifier used to authenticate the sender as the intended\npayer of a multi-path payment. The payment_addr must be the same for all\nsubpayments, and match the payment_addr provided in the receiver's invoice.\nThe same payment_addr must be used on all subpayments."
"description": "A unique, random identifier used to authenticate the sender as the intended\npayer of a multi-path payment. The payment_addr must be the same for all\nsubpayments, and match the payment_addr provided in the receiver's invoice.\nThe same payment_addr must be used on all subpayments. This is also called\npayment secret in specifications (e.g. BOLT 11)."
},
"total_amt_msat": {
"type": "string",
Expand Down Expand Up @@ -1173,7 +1173,7 @@
"payment_addr": {
"type": "string",
"format": "byte",
"description": "An optional payment addr to be included within the last hop of the route."
"description": "An optional payment addr to be included within the last hop of the route.\nThis is also called payment secret in specifications (e.g. BOLT 11)."
}
}
},
Expand Down Expand Up @@ -1774,7 +1774,7 @@
"payment_addr": {
"type": "string",
"format": "byte",
"description": "An optional payment addr to be included within the last hop of the route."
"description": "An optional payment addr to be included within the last hop of the route.\nThis is also called payment secret in specifications (e.g. BOLT 11)."
},
"max_shard_size_msat": {
"type": "string",
Expand Down