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

65 lines
2.2 KiB
Markdown
Raw Normal View History

docs: Update manpages to be recognized correctly by mrkd mrkd started enforcing the `name -- short description` style of top-level headings somewhere, and was thus failing to build the man-pages. I swapped the title and with the existing short description to make it work again. `mrkd` will automatically infer the section from the filename so no need to put it in the title as well. In addition I removed the "last updated" lines at the bottom since they are out of date at best, and misleading at the worst. If we want to keep them, I'd suggest generating them from the commit that last touched them.
2019-08-31 13:30:56 +01:00
lightning-listpays -- Command for querying payment status
=========================================================
doc/manpages: replace asciidoc by markdown
2019-08-10 00:54:18 +01:00
SYNOPSIS
--------
Remove useless \
2022-01-26 17:18:49 +00:00
**listpays** [*bolt11*] [*payment_hash*] [*status*]
doc/manpages: replace asciidoc by markdown
2019-08-10 00:54:18 +01:00
DESCRIPTION
-----------
The **listpay** RPC command gets the status of all *pay* commands, or a
listpays: fixed bolt11 null with keysend and update doc command listpays: make doc-all missed Changelog-Added: JSON-RPC: `listpays` can be used to query payments using the `payment_hash` Changelog-Added: JSON-RPC: `listpays` now includes the `payment_hash`
2020-07-29 09:48:47 +01:00
single one if either *bolt11* or *payment_hash* was specified.
review 1/2: Fixed the doc missing details about formatting. Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2021-09-06 11:08:07 +01:00
It is possible filter the payments also by *status*.
doc/manpages: replace asciidoc by markdown
2019-08-10 00:54:18 +01:00
RETURN VALUE
------------
doc/schemas: generate manpage section from schema. We start with the listpays manpage. Which is now complete! Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-05-26 06:49:01 +01:00
[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an object containing **pays** is returned. It is an array of objects, where each object contains:
doc: generate correct markdown from schemas. You can't start a list without a paragraph separator. ```diff --- /tmp/before 2022-07-20 22:02:23.485372596 +0930 +++ /tmp/after 2022-07-20 22:02:33.745528456 +0930 @@ -21,12 +21,16 @@ On startup of the daemon, no autoclean is set up. RETURN VALUE - On success, an object is returned, containing: - enabled (boolean): - whether invoice autocleaning is active + On success, an object is returned, containing: - If enabled is true: - expired_by (u64): how long an invoice must be ex‐ - pired (seconds) before we delete it - cycle_seconds (u64): how long an - invoice must be expired (seconds) before we delete it + • enabled (boolean): whether invoice autocleaning is active + + If enabled is true: + + • expired_by (u64): how long an invoice must be expired (seconds) be‐ + fore we delete it + • cycle_seconds (u64): how long an invoice must be expired (seconds) + before we delete it AUTHOR ZmnSCPxj <ZmnSCPxj@protonmail.com> is mainly responsible. ``` Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-09-05 22:33:09 +01:00
doc: always escape underscores in property names If there's only a single underscore, lowdown ignores it, but if there are multiple (see min_final_cltv_expiry) it decides we're trying to highlight part of the word. Reported-by: @wtogami Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-09-05 22:45:06 +01:00
- **payment\_hash** (hex): the hash of the *payment_preimage* which will prove payment (always 64 characters)
doc/schemas: generate manpage section from schema. We start with the listpays manpage. Which is now complete! Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-05-26 06:49:01 +01:00
- **status** (string): status of the payment (one of "pending", "failed", "complete")
doc: always escape underscores in property names If there's only a single underscore, lowdown ignores it, but if there are multiple (see min_final_cltv_expiry) it decides we're trying to highlight part of the word. Reported-by: @wtogami Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-09-05 22:45:06 +01:00
- **created\_at** (u64): the UNIX timestamp showing when this payment was initiated
doc/schemas: generate manpage section from schema. We start with the listpays manpage. Which is now complete! Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-05-26 06:49:01 +01:00
- **destination** (pubkey, optional): the final destination of the payment if known
- **label** (string, optional): the label, if given to sendpay
- **bolt11** (string, optional): the bolt11 string (if pay supplied one)
pay/sendpay: also store description in case bolt11 uses description_hash. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-04-02 03:33:35 +01:00
- **description** (string, optional): the description matching the bolt11 description hash (if pay supplied one)
doc/schemas: generate manpage section from schema. We start with the listpays manpage. Which is now complete! Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-05-26 06:49:01 +01:00
- **bolt12** (string, optional): the bolt12 string (if supplied for pay: **experimental-offers** only).
If **status** is "pending" or "complete":
doc: generate correct markdown from schemas. You can't start a list without a paragraph separator. ```diff --- /tmp/before 2022-07-20 22:02:23.485372596 +0930 +++ /tmp/after 2022-07-20 22:02:33.745528456 +0930 @@ -21,12 +21,16 @@ On startup of the daemon, no autoclean is set up. RETURN VALUE - On success, an object is returned, containing: - enabled (boolean): - whether invoice autocleaning is active + On success, an object is returned, containing: - If enabled is true: - expired_by (u64): how long an invoice must be ex‐ - pired (seconds) before we delete it - cycle_seconds (u64): how long an - invoice must be expired (seconds) before we delete it + • enabled (boolean): whether invoice autocleaning is active + + If enabled is true: + + • expired_by (u64): how long an invoice must be expired (seconds) be‐ + fore we delete it + • cycle_seconds (u64): how long an invoice must be expired (seconds) + before we delete it AUTHOR ZmnSCPxj <ZmnSCPxj@protonmail.com> is mainly responsible. ``` Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-09-05 22:33:09 +01:00
doc: always escape underscores in property names If there's only a single underscore, lowdown ignores it, but if there are multiple (see min_final_cltv_expiry) it decides we're trying to highlight part of the word. Reported-by: @wtogami Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-09-05 22:45:06 +01:00
- **amount\_sent\_msat** (msat): the amount we actually sent, including fees
- **amount\_msat** (msat, optional): the amount the destination received, if known
doc/schemas: generate manpage section from schema. We start with the listpays manpage. Which is now complete! Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-05-26 06:49:01 +01:00
If **status** is "complete":
doc: generate correct markdown from schemas. You can't start a list without a paragraph separator. ```diff --- /tmp/before 2022-07-20 22:02:23.485372596 +0930 +++ /tmp/after 2022-07-20 22:02:33.745528456 +0930 @@ -21,12 +21,16 @@ On startup of the daemon, no autoclean is set up. RETURN VALUE - On success, an object is returned, containing: - enabled (boolean): - whether invoice autocleaning is active + On success, an object is returned, containing: - If enabled is true: - expired_by (u64): how long an invoice must be ex‐ - pired (seconds) before we delete it - cycle_seconds (u64): how long an - invoice must be expired (seconds) before we delete it + • enabled (boolean): whether invoice autocleaning is active + + If enabled is true: + + • expired_by (u64): how long an invoice must be expired (seconds) be‐ + fore we delete it + • cycle_seconds (u64): how long an invoice must be expired (seconds) + before we delete it AUTHOR ZmnSCPxj <ZmnSCPxj@protonmail.com> is mainly responsible. ``` Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-09-05 22:33:09 +01:00
doc/schemas: generate manpage section from schema. We start with the listpays manpage. Which is now complete! Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-05-26 06:49:01 +01:00
- **preimage** (hex): proof of payment (always 64 characters)
doc: always escape underscores in property names If there's only a single underscore, lowdown ignores it, but if there are multiple (see min_final_cltv_expiry) it decides we're trying to highlight part of the word. Reported-by: @wtogami Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-09-05 22:45:06 +01:00
- **number\_of\_parts** (u64, optional): the number of parts for a successful payment (only if more than one).
doc/schemas: generate manpage section from schema. We start with the listpays manpage. Which is now complete! Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-05-26 06:49:01 +01:00
If **status** is "failed":
doc: generate correct markdown from schemas. You can't start a list without a paragraph separator. ```diff --- /tmp/before 2022-07-20 22:02:23.485372596 +0930 +++ /tmp/after 2022-07-20 22:02:33.745528456 +0930 @@ -21,12 +21,16 @@ On startup of the daemon, no autoclean is set up. RETURN VALUE - On success, an object is returned, containing: - enabled (boolean): - whether invoice autocleaning is active + On success, an object is returned, containing: - If enabled is true: - expired_by (u64): how long an invoice must be ex‐ - pired (seconds) before we delete it - cycle_seconds (u64): how long an - invoice must be expired (seconds) before we delete it + • enabled (boolean): whether invoice autocleaning is active + + If enabled is true: + + • expired_by (u64): how long an invoice must be expired (seconds) be‐ + fore we delete it + • cycle_seconds (u64): how long an invoice must be expired (seconds) + before we delete it AUTHOR ZmnSCPxj <ZmnSCPxj@protonmail.com> is mainly responsible. ``` Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-09-05 22:33:09 +01:00
doc/schemas: generate manpage section from schema. We start with the listpays manpage. Which is now complete! Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-05-26 06:49:01 +01:00
- **erroronion** (hex, optional): the error onion returned on failure, if any.
doc: fix GH/readthedocs rendering of manual pages. They render the comment as if it's in the list. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-09-03 11:07:59 +01:00
doc/schemas: generate manpage section from schema. We start with the listpays manpage. Which is now complete! Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-05-26 06:49:01 +01:00
[comment]: # (GENERATE-FROM-SCHEMA-END)
doc/manpages: replace asciidoc by markdown
2019-08-10 00:54:18 +01:00
doc: document ordering of listpays/listsendpays. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-05-31 03:39:27 +01:00
The returned array is ordered by increasing **created_at** fields.
doc/manpages: replace asciidoc by markdown
2019-08-10 00:54:18 +01:00
AUTHOR
------
Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible.
SEE ALSO
--------
lightning-pay(7), lightning-paystatus(7), lightning-listsendpays(7).
RESOURCES
---------
Main web site: <https://github.com/ElementsProject/lightning>
doc: force refresh of all manpages. The idea is that you regenerate the man pages in the same commit you alter them: that's how we know whether to try regenerating them or not (git doesn't store timestamps, so it can't really tell). Travis will now check this, so force them all to sync to this commit. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2020-08-25 02:33:16 +01:00
doc: always escape underscores in property names If there's only a single underscore, lowdown ignores it, but if there are multiple (see min_final_cltv_expiry) it decides we're trying to highlight part of the word. Reported-by: @wtogami Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-09-05 22:45:06 +01:00
[comment]: # ( SHA256STAMP:fd723be0ea9b4d6722adad5d325de6cf9c53e1842281205a82ee74ab702a17bd)