mirror of
https://github.com/aljazceru/lightning.git
synced 2025-12-24 01:24:26 +01:00
bcabb3825f
1. If the tool changes, you need to regenerate since the output may change. 2. This didn't just filter that out, ignored all but the first dependency, which made bisecting the bookkeeper plugin a nightmare: it didn't regenerate the .po file, causing random crashes. If we want this, try $(filter-out tools/fromschema.py) instead. But I don't think we want that. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
64 lines
2.1 KiB
Markdown
64 lines
2.1 KiB
Markdown
lightning-waitinvoice -- Command for waiting for specific payment
|
|
=================================================================
|
|
|
|
SYNOPSIS
|
|
--------
|
|
|
|
**waitinvoice** *label*
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
|
|
The **waitinvoice** RPC command waits until a specific invoice is paid,
|
|
then returns that single entry as per **listinvoice**.
|
|
|
|
RETURN VALUE
|
|
------------
|
|
|
|
[comment]: # (GENERATE-FROM-SCHEMA-START)
|
|
On success, an object is returned, containing:
|
|
|
|
- **label** (string): unique label supplied at invoice creation
|
|
- **description** (string): description used in the invoice
|
|
- **payment_hash** (hash): the hash of the *payment_preimage* which will prove payment (always 64 characters)
|
|
- **status** (string): Whether it's paid or expired (one of "paid", "expired")
|
|
- **expires_at** (u64): UNIX timestamp of when it will become / became unpayable
|
|
- **amount_msat** (msat, optional): the amount required to pay this invoice
|
|
- **bolt11** (string, optional): the BOLT11 string (always present unless *bolt12* is)
|
|
- **bolt12** (string, optional): the BOLT12 string (always present unless *bolt11* is)
|
|
|
|
If **status** is "paid":
|
|
|
|
- **pay_index** (u64): Unique incrementing index for this payment
|
|
- **amount_received_msat** (msat): the amount actually received (could be slightly greater than *amount_msat*, since clients may overpay)
|
|
- **paid_at** (u64): UNIX timestamp of when it was paid
|
|
- **payment_preimage** (secret): proof of payment (always 64 characters)
|
|
|
|
[comment]: # (GENERATE-FROM-SCHEMA-END)
|
|
|
|
On error the returned object will contain `code` and `message` properties,
|
|
with `code` being one of the following:
|
|
|
|
- -32602: If the given parameters are wrong.
|
|
- -1: If the invoice is deleted while unpaid, or the invoice does not exist.
|
|
- 903: If the invoice expires before being paid, or is already expired.
|
|
|
|
AUTHOR
|
|
------
|
|
|
|
Christian Decker <<decker.christian@gmail.com>> is mainly
|
|
responsible.
|
|
|
|
SEE ALSO
|
|
--------
|
|
|
|
lightning-waitanyinvoice(7), lightning-listinvoice(7),
|
|
lightning-delinvoice(7), lightning-invoice(7)
|
|
|
|
RESOURCES
|
|
---------
|
|
|
|
Main web site: <https://github.com/ElementsProject/lightning>
|
|
|
|
[comment]: # ( SHA256STAMP:ce034f1801260480032a98348aae928055f3d9edf12f45cefcd8b6007289ff83)
|