highperfocused/lnd
1
0
Fork 0
mirror of https://github.com/lightningnetwork/lnd.git synced 2025-09-26 02:56:30 +02:00
Code Issues Packages Projects Releases Wiki Activity

lnrpc: Clarify payment_addr and payment_secret

Browse Source 
Fix #7438, adding clarification statements in lnrpc proto files.
Originally proposed by daredevil3435 in PR #7873 and PR #7885.
This commit is contained in:
tdb3
2024-02-13 19:04:18 -05:00
parent 4855faf162
commit 3288490df3
9 changed files with 47 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
lnrpc/invoicesrpc/invoices.pb.go
View File

@@ -317,8 +317,9 @@ type AddHoldInvoiceResp struct {
// SubscribeInvoices call can use this to instantly get notified of all added
// invoices with an add_index greater than this one.
AddIndex uint64 `protobuf:"varint,2,opt,name=add_index,json=addIndex,proto3" json:"add_index,omitempty"`
// 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.
PaymentAddr []byte `protobuf:"bytes,3,opt,name=payment_addr,json=paymentAddr,proto3" json:"payment_addr,omitempty"`
}

5
lnrpc/invoicesrpc/invoices.proto
View File

@@ -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;

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

@@ -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."
}
}
},
@@ -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",