core-lightning/doc/schemas
Vincenzo Palazzo 6f0dbbb20f bolt12: allow to inject payer_metadata
Payer metadata is a field that controls the payer ID
provided during the fetchinvoice process.

There are use cases where this is highly useful, such as
proving that the payer has paid for the correct item.

Imagine visiting a merchant's website to pay for multiple offers, where
one of these offers is a default offer (with no description and no set amount).

In this scenario, the merchant could claim not to have received
payment for a specific item. Since the same offer may be used to
fetch invoices for different products, there needs to be a way to
identify which product the invoice corresponds to.

With this commit, it will be possible to inject payer metadata,
which helps solve the issue described above.

For example, possible payer metadata could be `to_hex(b"{payer_node_id}.{product_id}.{created_at}")`.

Changelog-Added: JSON-RPC: `fetchinvoice` allows setting invreq_metadata via `payer_metadata` parameter.
Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2024-11-19 22:54:22 +01:00
..
notification doc: fix up added versions for notification schemas. 2024-07-12 17:30:14 -07:00
lightning-addgossip.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-addpsbtoutput.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-askrene-age.json askrene: commit to API. 2024-11-08 21:48:55 +10:30
lightning-askrene-bias-channel.json askrene: commit to API. 2024-11-08 21:48:55 +10:30
lightning-askrene-create-channel.json askrene: commit to API. 2024-11-08 21:48:55 +10:30
lightning-askrene-create-layer.json askrene: commit to API. 2024-11-08 21:48:55 +10:30
lightning-askrene-disable-node.json askrene: commit to API. 2024-11-08 21:48:55 +10:30
lightning-askrene-inform-channel.json askrene: commit to API. 2024-11-08 21:48:55 +10:30
lightning-askrene-listlayers.json askrene: commit to API. 2024-11-08 21:48:55 +10:30
lightning-askrene-listreservations.json askrene: commit to API. 2024-11-08 21:48:55 +10:30
lightning-askrene-remove-layer.json askrene: commit to API. 2024-11-08 21:48:55 +10:30
lightning-askrene-reserve.json askrene: commit to API. 2024-11-08 21:48:55 +10:30
lightning-askrene-unreserve.json askrene: commit to API. 2024-11-08 21:48:55 +10:30
lightning-askrene-update-channel.json askrene: commit to API. 2024-11-08 21:48:55 +10:30
lightning-autoclean-once.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-autoclean-status.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-batching.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-bkpr-channelsapy.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-bkpr-dumpincomecsv.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-bkpr-editdescriptionbyoutpoint.json bkpr: add examples for new edit description RPC calls 2024-11-12 09:46:09 +10:30
lightning-bkpr-editdescriptionbypaymentid.json bkpr: add examples for new edit description RPC calls 2024-11-12 09:46:09 +10:30
lightning-bkpr-inspect.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-bkpr-listaccountevents.json bkpr: add new json RPC "bkpr-editdescriptionbypaymentid" 2024-11-12 09:46:09 +10:30
lightning-bkpr-listbalances.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-bkpr-listincome.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-blacklistrune.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-check.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-checkmessage.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-checkrune.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-close.json lightningd: actually deprecate old close fields. 2024-11-17 16:04:06 +10:30
lightning-commando-blacklist.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-commando-listrunes.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-commando-rune.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-commando.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-connect.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-createinvoice.json docs: no longer tell people experimental-offers is required. 2024-11-18 10:42:54 +01:00
lightning-createonion.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-createrune.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-datastore.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-datastoreusage.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-decode.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-decodepay.json lightningd: deprecate decodepay. 2024-11-17 14:21:23 +10:30
lightning-deldatastore.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-delforward.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-delinvoice.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-delpay.json docs: no longer tell people experimental-offers is required. 2024-11-18 10:42:54 +01:00
lightning-deprecations.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-dev-forget-channel.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-dev-splice.json splice: Documentation for the “splice” command 2024-11-12 06:42:52 +10:30
lightning-disableinvoicerequest.json docs: no longer tell people experimental-offers is required. 2024-11-18 10:42:54 +01:00
lightning-disableoffer.json docs: no longer tell people experimental-offers is required. 2024-11-18 10:42:54 +01:00
lightning-disconnect.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-emergencyrecover.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-enableoffer.json docs: no longer tell people experimental-offers is required. 2024-11-18 10:42:54 +01:00
lightning-exposesecret.json exposesecret: new plugin and command to get hsm_secret. 2024-11-13 08:49:55 +10:30
lightning-feerates.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-fetchinvoice.json bolt12: allow to inject payer_metadata 2024-11-19 22:54:22 +01:00
lightning-fundchannel.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-fundchannel_cancel.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-fundchannel_complete.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-fundchannel_start.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-funderupdate.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-fundpsbt.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-getemergencyrecoverdata.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-getinfo.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-getlog.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-getroute.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-getroutes.json askrene: commit to API. 2024-11-08 21:48:55 +10:30
lightning-help.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-injectpaymentonion.json lightningd: injectpaymentonion should fail on re-attempts. 2024-11-18 11:03:26 +10:30
lightning-invoice.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-invoicerequest.json docs: no longer tell people experimental-offers is required. 2024-11-18 10:42:54 +01:00
lightning-keysend.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-listaddresses.json doc: Add schema for listaddresses 2024-11-17 20:27:13 +10:30
lightning-listchannels.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-listclosedchannels.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-listconfigs.json lightningd: deprecate experimental-offers option. 2024-11-18 10:42:54 +01:00
lightning-listdatastore.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-listforwards.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-listfunds.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-listhtlcs.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-listinvoicerequests.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-listinvoices.json docs: no longer tell people experimental-offers is required. 2024-11-18 10:42:54 +01:00
lightning-listnodes.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-listoffers.json docs: no longer tell people experimental-offers is required. 2024-11-18 10:42:54 +01:00
lightning-listpays.json docs: no longer tell people experimental-offers is required. 2024-11-18 10:42:54 +01:00
lightning-listpeerchannels.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-listpeers.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-listsendpays.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-listsqlschemas.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-listtransactions.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-makesecret.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-multifundchannel.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-multiwithdraw.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-newaddr.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-notifications.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-offer.json docs: no longer tell people experimental-offers is required. 2024-11-18 10:42:54 +01:00
lightning-openchannel_abort.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-openchannel_bump.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-openchannel_init.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-openchannel_signed.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-openchannel_update.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-parsefeerate.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-pay.json docs: no longer tell people experimental-offers is required. 2024-11-18 10:42:54 +01:00
lightning-ping.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-plugin.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-preapproveinvoice.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-preapprovekeysend.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-reckless.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-recover.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-recoverchannel.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-renepay.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-renepaystatus.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-reserveinputs.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-sendcustommsg.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-sendinvoice.json docs: no longer tell people experimental-offers is required. 2024-11-18 10:42:54 +01:00
lightning-sendonion.json docs: no longer tell people experimental-offers is required. 2024-11-18 10:42:54 +01:00
lightning-sendpay.json docs: no longer tell people experimental-offers is required. 2024-11-18 10:42:54 +01:00
lightning-sendpsbt.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-setchannel.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-setconfig.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-setpsbtversion.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-showrunes.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-signinvoice.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-signmessage.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-signpsbt.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-splice_init.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-splice_signed.json splice: Modify splice_signed to work with multiple channels 2024-11-12 06:42:52 +10:30
lightning-splice_update.json splice: Allow splice_update to return signatures 2024-11-12 06:42:52 +10:30
lightning-sql-template.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-staticbackup.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-stop.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-txdiscard.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-txprepare.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-txsend.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-unreserveinputs.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-upgradewallet.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-utxopsbt.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-wait.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-waitanyinvoice.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-waitblockheight.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-waitinvoice.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-waitsendpay.json docs: no longer tell people experimental-offers is required. 2024-11-18 10:42:54 +01:00
lightning-withdraw.json doc: fix all JSON schemas to enforce no additional properties. 2024-10-30 15:39:12 +10:30
lightning-xpay.json xpay: new plugin which uses askrene, injectpaymentonion. 2024-11-18 11:03:26 +10:30