Skip to content

Commit 7c4a2cb

Browse files
authored
NIP-47: mark "state" field as optional in make_invoice response for backward compatibility (#2046)
1 parent 3760a6e commit 7c4a2cb

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

47.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -335,7 +335,7 @@ Response:
335335
"result_type": "make_invoice",
336336
"result": {
337337
"type": "incoming", // "incoming" for invoices, "outgoing" for payments
338-
"state": "pending",
338+
"state": "pending", // optional
339339
"invoice": "string", // encoded invoice, optional
340340
"description": "string", // invoice's description, optional
341341
"description_hash": "string", // invoice's description hash, optional
@@ -369,7 +369,7 @@ Response:
369369
"result_type": "lookup_invoice",
370370
"result": {
371371
"type": "incoming", // "incoming" for invoices, "outgoing" for payments
372-
"state": "pending", // can be "pending", "settled", "expired" (for invoices) or "failed" (for payments)
372+
"state": "pending", // can be "pending", "settled", "expired" (for invoices) or "failed" (for payments), optional
373373
"invoice": "string", // encoded invoice, optional
374374
"description": "string", // invoice's description, optional
375375
"description_hash": "string", // invoice's description hash, optional
@@ -418,7 +418,7 @@ Response:
418418
"transactions": [
419419
{
420420
"type": "incoming", // "incoming" for invoices, "outgoing" for payments
421-
"state": "pending", // can be "pending", "settled", "expired" (for invoices) or "failed" (for payments)
421+
"state": "pending", // can be "pending", "settled", "expired" (for invoices) or "failed" (for payments), optional
422422
"invoice": "string", // encoded invoice, optional
423423
"description": "string", // invoice's description, optional
424424
"description_hash": "string", // invoice's description hash, optional
@@ -495,7 +495,7 @@ Notification:
495495
"notification_type": "payment_received",
496496
"notification": {
497497
"type": "incoming",
498-
"state": "settled",
498+
"state": "settled", // optional
499499
"invoice": "string", // encoded invoice
500500
"description": "string", // invoice's description, optional
501501
"description_hash": "string", // invoice's description hash, optional
@@ -521,7 +521,7 @@ Notification:
521521
"notification_type": "payment_sent",
522522
"notification": {
523523
"type": "outgoing",
524-
"state": "settled",
524+
"state": "settled", // optional
525525
"invoice": "string", // encoded invoice
526526
"description": "string", // invoice's description, optional
527527
"description_hash": "string", // invoice's description hash, optional

0 commit comments

Comments
 (0)