Adding support for main bolt12 commands to NIP-47

47.md

@@ -146,8 +146,9 @@ Request:
 {
     "method": "pay_invoice",
     "params": {
-        "invoice": "lnbc50n1...", // bolt11 invoice
-        "amount": 123, // invoice amount in msats, optional
+        "invoice": "lnbc50n1...", // bolt11 invoice/bolt12 offer
+        "amount": 123, // invoice amount in msats, optional if the bolt11 invoice or the bolt12 offer contains an amount
+        "payer_note": "string", // note to be included for a bolt12 invoice, optional
     }
 }
 ```
@@ -176,7 +177,7 @@ Request:
     "method": "multi_pay_invoice",
     "params": {
         "invoices": [
-          {"id":"4da52c32a1", "invoice": "lnbc1...", "amount": 123}, // bolt11 invoice and amount in msats, amount is optional
+          {"id":"4da52c32a1", "invoice": "lnbc1...", "amount": 123, "payer_note": "string"}, // bolt11 invoice/bolt12 offer, amount in msats and payer_note, amount is optional if the bolt11 invoice or the bolt12 offer contains an amount, payer_note only applies for bolt12 and is optional
           {"id":"3da52c32a1", "invoice": "lnbc50n1..."},
         ],
     }
@@ -331,8 +332,11 @@ Response:
         "invoice": "string", // encoded invoice, optional
         "description": "string", // invoice's description, optional
         "description_hash": "string", // invoice's description hash, optional
+        "offer_issuer": "string", // offer's issuer for a bolt12 transaction, optional
+        "payer_note": "string", // note from payer for a bolt12 transaction, optional
         "preimage": "string", // payment's preimage, optional if unpaid
         "payment_hash": "string", // Payment hash for the payment
+        "offer_id": "string", // the id of the offer, for a bolt12 invoice, optional
         "amount": 123, // value in msats
         "fees_paid": 123, // value in msats
         "created_at": unixtimestamp, // invoice/payment creation time
@@ -379,8 +383,11 @@ Response:
                "invoice": "string", // encoded invoice, optional
                "description": "string", // invoice's description, optional
                "description_hash": "string", // invoice's description hash, optional
+               "offer_issuer": "string", // offer's issuer for a bolt12 transaction, optional
+               "payer_note": "string", // note from payer for a bolt12 transaction, optional
                "preimage": "string", // payment's preimage, optional if unpaid
                "payment_hash": "string", // Payment hash for the payment
+               "offer_id": "string", // the id of the offer, for a bolt12 invoice, optional
                "amount": 123, // value in msats
                "fees_paid": 123, // value in msats
                "created_at": unixtimestamp, // invoice/payment creation time
@@ -413,6 +420,215 @@ Response:
 }
 ```
 
+### `make_offer`
+
+Request:
+```jsonc
+{
+    "method": "make_offer",
+    "params": {
+        "currency": "ABC", // ISO 4217 code of the currency (3 characters), optional (missing means msat)
+        "currency_minor_unit": 123, // number of decimals to apply to the amount, for currency different than msat, optional
+        "amount": 123, // minimum amount value, after adjustment by currency_minor_unit if applicable, optional
+        "description": "string", // offer's description, optional
+        "issuer": "string", // offer's issuer, optional
+        "absolute_expiry": unixtimestamp, // absolute expiry time of the offer, optional
+        "single_use": false // only allow the offer to be used once, optional, default false
+    }
+}
+```
+
+Response:
+```jsonc
+{
+    "result_type": "make_offer",
+    "result": {
+        "offer": "lno1pgx...", // encoded offer
+        "description": "string", // offer's description, optional
+        "issuer": "string", // offer's issuer, optional
+        "currency": "ABC", // ISO 4217 code of the currency (3 characters), optional (missing means msat)
+        "currency_minor_unit": 123, // number of decimals to apply to the amount, for currency different than msat, optional
+        "amount": 123, // minimum amount value, after adjustment by currency_minor_unit if applicable, optional
+        "offer_id": "string", // the id of the offer
+        "active": true, // whether the offer is enabled
+        "single_use": false, // whether the offer can only be used once
+        "used": false, // whether the offer has been used
+        "created_at": unixtimestamp, // offer creation time
+        "updated_at": unixtimestamp, // offer update time
+        "expires_at": unixtimestamp // offer absolute expiry time, optional
+    }
+}
+```
+
+### `lookup_offer`
+
+Request:
+```jsonc
+{
+    "method": "lookup_offer",
+    "params": {
+        "offer_id": "string", // the id of the offer
+    }
+}
+```
+
+Response:
+```jsonc
+{
+    "result_type": "lookup_offer",
+    "result": {
+        "offer": "lno1pgx...", // encoded offer
+        "description": "string", // offer's description, optional
+        "issuer": "string", // offer's issuer, optional
+        "currency": "ABC", // ISO 4217 code of the currency (3 characters), optional (missing means msat)
+        "currency_minor_unit": 123, // number of decimals to apply to the amount, for currency different than msat, optional
+        "amount": 123, // minimum amount value, after adjustment by currency_minor_unit if applicable, optional
+        "offer_id": "string", // the id of the offer
+        "active": true, // whether the offer is enabled
+        "single_use": false, // whether the offer can only be used once
+        "used": false, // whether the offer has been used
+        "created_at": unixtimestamp, // offer creation time
+        "updated_at": unixtimestamp, // offer update time
+        "expires_at": unixtimestamp // offer absolute expiry time, optional
+    }
+}
+```
+
+Errors:
+- `NOT_FOUND`: The offer could not be found by the given parameters.
+
+### `enable_offer`
+
+Request:
+```jsonc
+{
+    "method": "enable_offer",
+    "params": {
+        "offer_id": "string", // the id of the offer
+}
+}
+```
+
+Response:
+```jsonc
+{
+    "result_type": "enable_offer",
+    "result": {
+        "offer_id": "string", // the id of the offer
+        "active": true, // the offer is enabled, always true
+}
+}
+```
+
+Errors:
+- `NOT_FOUND`: The offer could not be found by the given parameters.
+
+### `disable_offer`
+
+Request:
+```jsonc
+{
+    "method": "disable_offer",
+    "params": {
+        "offer_id": "string", // the id of the offer
+}
+}
+```
+
+Response:
+```jsonc
+{
+    "result_type": "disable_offer",
+    "result": {
+        "offer_id": "string", // the id of the offer
+        "active": false, // the offer is enable, always false
+}
+}
+```
+
+Errors:
+- `NOT_FOUND`: The offer could not be found by the given parameters.
+
+### `list_offers`
+
+Lists offers. The `from` and `until` parameters are timestamps in seconds since epoch. If `from` is not specified, it defaults to 0.
+If `until` is not specified, it defaults to the current time. Offers are returned in descending order of creation
+time.
+
+Request:
+```jsonc
+{
+    "method": "list_offers",
+    "params": {
+        "from": 1693876973, // starting timestamp in seconds since epoch (inclusive), optional
+        "until": 1703225078, // ending timestamp in seconds since epoch (inclusive), optional
+        "limit": 10, // maximum number of invoices to return, optional
+        "offset": 0, // offset of the first invoice to return, optional
+        "active": true, // whether the offer is enabled, optional
+        "single_use": false, // whether the offer can only be used once, optional
+        "used": false // whether the offer has been used, optional
+}
+}
+```
+
+Response:
+```jsonc
+{
+    "result_type": "list_offers",
+    "result": {
+        "offers": [
+            {
+               "offer": "lno1pgx...", // encoded offer
+               "description": "string", // offer's description, optional
+               "issuer": "string", // offer's issuer, optional
+               "currency": "ABC", // ISO 4217 code of the currency (3 characters), optional (missing means msat)
+               "currency_minor_unit": 123, // number of decimals to apply to the amount, for currency different than msat, optional
+               "amount": 123, // minimum amount value, after adjustment by currency_minor_unit if applicable, optional
+               "offer_id": "string", // the id of the offer
+               "active": true, // whether the offer is enabled
+               "single_use": false, // whether the offer can only be used once
+               "used": false, // whether the offer has been used
+               "created_at": unixtimestamp, // offer creation time
+               "updated_at": unixtimestamp, // offer update time
+               "expires_at": unixtimestamp // offer absolute expiry time, optional
+           }
+        ],
+    },
+}
+```
+
+### `get_offer_info`
+
+Request:
+```jsonc
+{
+    "method": "get_offer_info",
+    "params": {
+        "offer_id": "string", // the id of the offer
+    }
+}
+```
+
+Response:
+```jsonc
+{
+    "result_type": "get_offer_info",
+    "result": {
+        "offer": "lno1pgx...", // encoded offer
+        "description": "string", // offer's description, optional
+        "issuer": "string", // offer's issuer, optional
+        "currency": "ABC", // ISO 4217 code of the currency (3 characters), optional (missing means msat)
+        "currency_minor_unit": 123, // number of decimals to apply to the amount, for currency different than msat, optional
+        "amount": 123, // minimum amount value, after adjustment by currency_minor_unit if applicable, optional
+        "offer_id": "string", // the id of the offer
+        "expires_at": unixtimestamp // offer absolute expiry time, optional
+    }
+}
+```
+
+Errors:
+- `DECODING_FAILED`: The offer could not be decoded by the given parameters.
+
 ### `get_info`
 
 Request:
@@ -434,7 +650,7 @@ Response:
             "network": "string", // mainnet, testnet, signet, or regtest
             "block_height": 1,
             "block_hash": "hex string",
-            "methods": ["pay_invoice", "get_balance", "make_invoice", "lookup_invoice", "list_transactions", "get_info"], // list of supported methods for this connection
+            "methods": ["pay_invoice", "get_balance", "make_invoice", "lookup_invoice", "list_transactions", "make_offer", "lookup_offer", "enable_offer", "disable_offer", "list_offers", "get_offer_info", "get_info"], // list of supported methods for this connection
             "notifications": ["payment_received", "payment_sent"], // list of supported notifications for this connection, optional.
     }
 }
@@ -455,8 +671,11 @@ Notification:
         "invoice": "string", // encoded invoice
         "description": "string", // invoice's description, optional
         "description_hash": "string", // invoice's description hash, optional
+        "offer_issuer": "string", // offer's issuer for a bolt12 transaction, optional
+        "payer_note": "string", // note from payer for a bolt12 transaction, optional
         "preimage": "string", // payment's preimage
         "payment_hash": "string", // Payment hash for the payment
+        "offer_id": "string", // the id of the offer, for a bolt12 invoice, optional
         "amount": 123, // value in msats
         "fees_paid": 123, // value in msats
         "created_at": unixtimestamp, // invoice/payment creation time
@@ -480,6 +699,8 @@ Notification:
         "invoice": "string", // encoded invoice
         "description": "string", // invoice's description, optional
         "description_hash": "string", // invoice's description hash, optional
+        "offer_issuer": "string", // offer's issuer for a bolt12 transaction, optional
+        "payer_note": "string", // note from payer for a bolt12 transaction, optional
         "preimage": "string", // payment's preimage
         "payment_hash": "string", // Payment hash for the payment
         "amount": 123, // value in msats