From 9cc9e40b89a51fb1e31626d35ff6008824d5db45 Mon Sep 17 00:00:00 2001 From: Daniel McNally Date: Mon, 6 Mar 2023 19:47:16 -0500 Subject: [PATCH] lnrpc: update docs for invoice amt_paid This corrects the documentation for the `amt_paid` and `amt_paid_msat` fields on the `Invoice` message to indicate that the fields will be set if the state of the invoice is either accepted or settled, not only settled. This reflects the actual behavior of lnd, as demonstrated in the below `lncli` output: ``` "amt_paid": "10000", "amt_paid_sat": "10", "amt_paid_msat": "10000", "state": "ACCEPTED", ``` --- lnrpc/invoicesrpc/invoices.swagger.json | 4 ++-- lnrpc/lightning.pb.go | 20 ++++++++++---------- lnrpc/lightning.proto | 20 ++++++++++---------- lnrpc/lightning.swagger.json | 4 ++-- 4 files changed, 24 insertions(+), 24 deletions(-) diff --git a/lnrpc/invoicesrpc/invoices.swagger.json b/lnrpc/invoicesrpc/invoices.swagger.json index 2fca20090..8452e9972 100644 --- a/lnrpc/invoicesrpc/invoices.swagger.json +++ b/lnrpc/invoicesrpc/invoices.swagger.json @@ -533,12 +533,12 @@ "amt_paid_sat": { "type": "string", "format": "int64", - "description": "The amount that was accepted for this invoice, in satoshis. This will ONLY\nbe set if this invoice has been settled. We provide this field as if the\ninvoice was created with a zero value, then we need to record what amount\nwas ultimately accepted. Additionally, it's possible that the sender paid\nMORE that was specified in the original invoice. So we'll record that here\nas well.\nNote: Output only, don't specify for creating an invoice." + "description": "The amount that was accepted for this invoice, in satoshis. This will ONLY\nbe set if this invoice has been settled or accepted. We provide this field\nas if the invoice was created with a zero value, then we need to record what\namount was ultimately accepted. Additionally, it's possible that the sender\npaid MORE that was specified in the original invoice. So we'll record that\nhere as well.\nNote: Output only, don't specify for creating an invoice." }, "amt_paid_msat": { "type": "string", "format": "int64", - "description": "The amount that was accepted for this invoice, in millisatoshis. This will\nONLY be set if this invoice has been settled. We provide this field as if\nthe invoice was created with a zero value, then we need to record what\namount was ultimately accepted. Additionally, it's possible that the sender\npaid MORE that was specified in the original invoice. So we'll record that\nhere as well.\nNote: Output only, don't specify for creating an invoice." + "description": "The amount that was accepted for this invoice, in millisatoshis. This will\nONLY be set if this invoice has been settled or accepted. We provide this\nfield as if the invoice was created with a zero value, then we need to\nrecord what amount was ultimately accepted. Additionally, it's possible that\nthe sender paid MORE that was specified in the original invoice. So we'll\nrecord that here as well.\nNote: Output only, don't specify for creating an invoice." }, "state": { "$ref": "#/definitions/InvoiceInvoiceState", diff --git a/lnrpc/lightning.pb.go b/lnrpc/lightning.pb.go index 2bb01b923..386cf377a 100644 --- a/lnrpc/lightning.pb.go +++ b/lnrpc/lightning.pb.go @@ -11696,20 +11696,20 @@ type Invoice struct { // Deprecated: Do not use. AmtPaid int64 `protobuf:"varint,18,opt,name=amt_paid,json=amtPaid,proto3" json:"amt_paid,omitempty"` // The amount that was accepted for this invoice, in satoshis. This will ONLY - // be set if this invoice has been settled. We provide this field as if the - // invoice was created with a zero value, then we need to record what amount - // was ultimately accepted. Additionally, it's possible that the sender paid - // MORE that was specified in the original invoice. So we'll record that here - // as well. - // Note: Output only, don't specify for creating an invoice. - AmtPaidSat int64 `protobuf:"varint,19,opt,name=amt_paid_sat,json=amtPaidSat,proto3" json:"amt_paid_sat,omitempty"` - // The amount that was accepted for this invoice, in millisatoshis. This will - // ONLY be set if this invoice has been settled. We provide this field as if - // the invoice was created with a zero value, then we need to record what + // be set if this invoice has been settled or accepted. We provide this field + // as if the invoice was created with a zero value, then we need to record what // amount was ultimately accepted. Additionally, it's possible that the sender // paid MORE that was specified in the original invoice. So we'll record that // here as well. // Note: Output only, don't specify for creating an invoice. + AmtPaidSat int64 `protobuf:"varint,19,opt,name=amt_paid_sat,json=amtPaidSat,proto3" json:"amt_paid_sat,omitempty"` + // The amount that was accepted for this invoice, in millisatoshis. This will + // ONLY be set if this invoice has been settled or accepted. We provide this + // field as if the invoice was created with a zero value, then we need to + // record what amount was ultimately accepted. Additionally, it's possible that + // the sender paid MORE that was specified in the original invoice. So we'll + // record that here as well. + // Note: Output only, don't specify for creating an invoice. AmtPaidMsat int64 `protobuf:"varint,20,opt,name=amt_paid_msat,json=amtPaidMsat,proto3" json:"amt_paid_msat,omitempty"` // The state the invoice is in. // Note: Output only, don't specify for creating an invoice. diff --git a/lnrpc/lightning.proto b/lnrpc/lightning.proto index c27e35e28..438a4bf55 100644 --- a/lnrpc/lightning.proto +++ b/lnrpc/lightning.proto @@ -3456,22 +3456,22 @@ message Invoice { /* The amount that was accepted for this invoice, in satoshis. This will ONLY - be set if this invoice has been settled. We provide this field as if the - invoice was created with a zero value, then we need to record what amount - was ultimately accepted. Additionally, it's possible that the sender paid - MORE that was specified in the original invoice. So we'll record that here - as well. + be set if this invoice has been settled or accepted. We provide this field + as if the invoice was created with a zero value, then we need to record what + amount was ultimately accepted. Additionally, it's possible that the sender + paid MORE that was specified in the original invoice. So we'll record that + here as well. Note: Output only, don't specify for creating an invoice. */ int64 amt_paid_sat = 19; /* The amount that was accepted for this invoice, in millisatoshis. This will - ONLY be set if this invoice has been settled. We provide this field as if - the invoice was created with a zero value, then we need to record what - amount was ultimately accepted. Additionally, it's possible that the sender - paid MORE that was specified in the original invoice. So we'll record that - here as well. + ONLY be set if this invoice has been settled or accepted. We provide this + field as if the invoice was created with a zero value, then we need to + record what amount was ultimately accepted. Additionally, it's possible that + the sender paid MORE that was specified in the original invoice. So we'll + record that here as well. Note: Output only, don't specify for creating an invoice. */ int64 amt_paid_msat = 20; diff --git a/lnrpc/lightning.swagger.json b/lnrpc/lightning.swagger.json index 13e3611d9..79ec8b3c0 100644 --- a/lnrpc/lightning.swagger.json +++ b/lnrpc/lightning.swagger.json @@ -5116,12 +5116,12 @@ "amt_paid_sat": { "type": "string", "format": "int64", - "description": "The amount that was accepted for this invoice, in satoshis. This will ONLY\nbe set if this invoice has been settled. We provide this field as if the\ninvoice was created with a zero value, then we need to record what amount\nwas ultimately accepted. Additionally, it's possible that the sender paid\nMORE that was specified in the original invoice. So we'll record that here\nas well.\nNote: Output only, don't specify for creating an invoice." + "description": "The amount that was accepted for this invoice, in satoshis. This will ONLY\nbe set if this invoice has been settled or accepted. We provide this field\nas if the invoice was created with a zero value, then we need to record what\namount was ultimately accepted. Additionally, it's possible that the sender\npaid MORE that was specified in the original invoice. So we'll record that\nhere as well.\nNote: Output only, don't specify for creating an invoice." }, "amt_paid_msat": { "type": "string", "format": "int64", - "description": "The amount that was accepted for this invoice, in millisatoshis. This will\nONLY be set if this invoice has been settled. We provide this field as if\nthe invoice was created with a zero value, then we need to record what\namount was ultimately accepted. Additionally, it's possible that the sender\npaid MORE that was specified in the original invoice. So we'll record that\nhere as well.\nNote: Output only, don't specify for creating an invoice." + "description": "The amount that was accepted for this invoice, in millisatoshis. This will\nONLY be set if this invoice has been settled or accepted. We provide this\nfield as if the invoice was created with a zero value, then we need to\nrecord what amount was ultimately accepted. Additionally, it's possible that\nthe sender paid MORE that was specified in the original invoice. So we'll\nrecord that here as well.\nNote: Output only, don't specify for creating an invoice." }, "state": { "$ref": "#/definitions/InvoiceInvoiceState",