NIP-47: mark "state" field as optional in make_invoice response for backward compatibility (#2046)

This commit is contained in:
Riccardo Balbo
2025-09-04 17:12:45 +02:00
committed by GitHub
parent 3760a6e308
commit 7c4a2cb829

10
47.md
View File

@@ -335,7 +335,7 @@ Response:
"result_type": "make_invoice", "result_type": "make_invoice",
"result": { "result": {
"type": "incoming", // "incoming" for invoices, "outgoing" for payments "type": "incoming", // "incoming" for invoices, "outgoing" for payments
"state": "pending", "state": "pending", // optional
"invoice": "string", // encoded invoice, optional "invoice": "string", // encoded invoice, optional
"description": "string", // invoice's description, optional "description": "string", // invoice's description, optional
"description_hash": "string", // invoice's description hash, optional "description_hash": "string", // invoice's description hash, optional
@@ -369,7 +369,7 @@ Response:
"result_type": "lookup_invoice", "result_type": "lookup_invoice",
"result": { "result": {
"type": "incoming", // "incoming" for invoices, "outgoing" for payments "type": "incoming", // "incoming" for invoices, "outgoing" for payments
"state": "pending", // can be "pending", "settled", "expired" (for invoices) or "failed" (for payments) "state": "pending", // can be "pending", "settled", "expired" (for invoices) or "failed" (for payments), optional
"invoice": "string", // encoded invoice, optional "invoice": "string", // encoded invoice, optional
"description": "string", // invoice's description, optional "description": "string", // invoice's description, optional
"description_hash": "string", // invoice's description hash, optional "description_hash": "string", // invoice's description hash, optional
@@ -418,7 +418,7 @@ Response:
"transactions": [ "transactions": [
{ {
"type": "incoming", // "incoming" for invoices, "outgoing" for payments "type": "incoming", // "incoming" for invoices, "outgoing" for payments
"state": "pending", // can be "pending", "settled", "expired" (for invoices) or "failed" (for payments) "state": "pending", // can be "pending", "settled", "expired" (for invoices) or "failed" (for payments), optional
"invoice": "string", // encoded invoice, optional "invoice": "string", // encoded invoice, optional
"description": "string", // invoice's description, optional "description": "string", // invoice's description, optional
"description_hash": "string", // invoice's description hash, optional "description_hash": "string", // invoice's description hash, optional
@@ -495,7 +495,7 @@ Notification:
"notification_type": "payment_received", "notification_type": "payment_received",
"notification": { "notification": {
"type": "incoming", "type": "incoming",
"state": "settled", "state": "settled", // optional
"invoice": "string", // encoded invoice "invoice": "string", // encoded invoice
"description": "string", // invoice's description, optional "description": "string", // invoice's description, optional
"description_hash": "string", // invoice's description hash, optional "description_hash": "string", // invoice's description hash, optional
@@ -521,7 +521,7 @@ Notification:
"notification_type": "payment_sent", "notification_type": "payment_sent",
"notification": { "notification": {
"type": "outgoing", "type": "outgoing",
"state": "settled", "state": "settled", // optional
"invoice": "string", // encoded invoice "invoice": "string", // encoded invoice
"description": "string", // invoice's description, optional "description": "string", // invoice's description, optional
"description_hash": "string", // invoice's description hash, optional "description_hash": "string", // invoice's description hash, optional