vincenzopalazzo
/
rgb-cln
1
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity
rgb-cln/doc/lightning-signinvoice.7.md

53 lines
1.2 KiB
Markdown
Raw Normal View History

lightningd: Add `signinvoice` to sign a BOLT11 invoice. Though there's already a `createinvoice` command, there are usecases where a user may want to sign an invoice that they don't yet have the preimage to. For example, they may have an htlc_accepted plugin that pays to obtain the preimage from someone else and returns a `{ "result": "resolve", ... }`. This RPC command addresses this usecase without overly complicating the semantics of the existing `createinvoice` command. Changelog-Added: JSON-RPC: `signinvoice` new command to sign BOLT11 invoices.
2022-11-07 00:45:47 +00:00
lightning-signinvoice -- Low-level invoice signing
=====================================================
SYNOPSIS
--------
**signinvoice** *invstring*
DESCRIPTION
-----------
The **signinvoice** RPC command signs an invoice. Unlike
**createinvoice** it does not save the invoice into the database and
thus does not require the preimage.
The *invstring* parameter is of bolt11 form, but the final signature
is ignored. Minimal sanity checks are done.
RETURN VALUE
------------
[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an object is returned, containing:
- **bolt11** (string): the bolt11 string
[comment]: # (GENERATE-FROM-SCHEMA-END)
On failure, an error is returned.
The following error codes may occur:
doc: fix display of lists and code blocks in manpages. The conversion from markdown to manpages does not display lists and code blocks correctly if they are not preceded by an empty line. Changelog-None
2023-10-14 09:09:05 +01:00
lightningd: Add `signinvoice` to sign a BOLT11 invoice. Though there's already a `createinvoice` command, there are usecases where a user may want to sign an invoice that they don't yet have the preimage to. For example, they may have an htlc_accepted plugin that pays to obtain the preimage from someone else and returns a `{ "result": "resolve", ... }`. This RPC command addresses this usecase without overly complicating the semantics of the existing `createinvoice` command. Changelog-Added: JSON-RPC: `signinvoice` new command to sign BOLT11 invoices.
2022-11-07 00:45:47 +00:00
- -1: Catchall nonspecific error.
AUTHOR
------
Carl Dong <<contact@carldong.me>> is mainly responsible.
SEE ALSO
--------
lightning-createinvoice(7), lightning-invoice(7), lightning-listinvoices(7),
lightning-delinvoice(7), lightning-getroute(7), lightning-sendpay(7),
lightning-offer(7).
RESOURCES
---------
Main web site: <https://github.com/ElementsProject/lightning>
schemas: deprecated is now a range. Don't assume removal is +6 months, but have a start deprecation/end support range. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2024-01-25 00:28:53 +00:00
[comment]: # ( SHA256STAMP:5f0154bc5c2e60c7ae5e238cd803a1171552c7c7fa46ddda538cd71ea1511533)