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

doc: Deprecation reason of settled on Invoice

Browse Source 
This documents how to deal with `settled` being deprecated. It took me quite a bit of digging without such documentation.

[skip ci]
This commit is contained in:
Martin Habovštiak 2022-07-18 13:02:12 +02:00 committed by Martin Habovstiak
parent f7b7442680
commit b4647bc37f
4 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -469,6 +469,7 @@
}, },
"settled": { "settled": {
"type": "boolean", "type": "boolean",
"description": "The field is deprecated. Use the state field instead (compare to SETTLED).",
"title": "Whether this invoice has been fulfilled" "title": "Whether this invoice has been fulfilled"
}, },
"creation_date": { "creation_date": {

5
lnrpc/lightning.pb.go
View File

@ -11368,7 +11368,10 @@ type Invoice struct {
// //
//The fields value and value_msat are mutually exclusive. //The fields value and value_msat are mutually exclusive.
ValueMsat int64 `protobuf:"varint,23,opt,name=value_msat,json=valueMsat,proto3" json:"value_msat,omitempty"` ValueMsat int64 `protobuf:"varint,23,opt,name=value_msat,json=valueMsat,proto3" json:"value_msat,omitempty"`
// Whether this invoice has been fulfilled //
//Whether this invoice has been fulfilled
//
//The field is deprecated. Use the state field instead (compare to SETTLED).
// //
// Deprecated: Do not use. // Deprecated: Do not use.
Settled bool `protobuf:"varint,6,opt,name=settled,proto3" json:"settled,omitempty"` Settled bool `protobuf:"varint,6,opt,name=settled,proto3" json:"settled,omitempty"`

6
lnrpc/lightning.proto
View File

@ -3227,7 +3227,11 @@ message Invoice {
*/ */
int64 value_msat = 23; int64 value_msat = 23;
// Whether this invoice has been fulfilled /*
Whether this invoice has been fulfilled
The field is deprecated. Use the state field instead (compare to SETTLED).
*/
bool settled = 6 [deprecated = true]; bool settled = 6 [deprecated = true];
/* /*

1
lnrpc/lightning.swagger.json
View File

@ -4722,6 +4722,7 @@
}, },
"settled": { "settled": {
"type": "boolean", "type": "boolean",
"description": "The field is deprecated. Use the state field instead (compare to SETTLED).",
"title": "Whether this invoice has been fulfilled" "title": "Whether this invoice has been fulfilled"
}, },
"creation_date": { "creation_date": {