mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2024-11-19 18:11:28 +01:00
Code Issues Projects Releases Wiki Activity
6176912683
core-lightning/doc/lightning-decodepay.7.md

75 lines
3.0 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 14:30:56 +02:00
lightning-decodepay -- Command for decoding a bolt11 string (low-level)
=======================================================================
doc/manpages: replace asciidoc by markdown
2019-08-10 01:54:18 +02:00
SYNOPSIS
--------
Remove useless \
2022-01-26 18:18:49 +01:00
**decodepay** *bolt11* [*description*]
doc/manpages: replace asciidoc by markdown
2019-08-10 01:54:18 +02:00
DESCRIPTION
-----------
The **decodepay** RPC command checks and parses a *bolt11* string as
specified by the BOLT 11 specification.
RETURN VALUE
------------
doc/schemas: decode, decodepay One of the more complex ones. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-05-26 07:54:01 +02:00
[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an object is returned, containing:
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 23:33:09 +02:00
doc/schemas: decode, decodepay One of the more complex ones. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-05-26 07:54:01 +02:00
- **currency** (string): the BIP173 name for the currency
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 23:45:06 +02:00
- **created\_at** (u64): the UNIX-style timestamp of the invoice
doc/schemas: decode, decodepay One of the more complex ones. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-05-26 07:54:01 +02:00
- **expiry** (u64): the number of seconds this is valid after *timestamp*
- **payee** (pubkey): the public key of the recipient
doc: use specific types in schema rather than "hex". We have "secret" and "hash" types which are often more appropriate. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2023-01-30 07:24:17 +01:00
- **payment\_hash** (hash): the hash of the *payment\_preimage*
doc/schemas: decode, decodepay One of the more complex ones. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-05-26 07:54:01 +02:00
- **signature** (signature): signature of the *payee* on this invoice
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 23:45:06 +02:00
- **min\_final\_cltv\_expiry** (u32): the minimum CLTV delay for the final node
- **amount\_msat** (msat, optional): Amount the invoice asked for
doc/schemas: decode, decodepay One of the more complex ones. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-05-26 07:54:01 +02:00
- **description** (string, optional): the description of the purpose of the purchase
doc: use specific types in schema rather than "hex". We have "secret" and "hash" types which are often more appropriate. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2023-01-30 07:24:17 +01:00
- **description\_hash** (hash, optional): the hash of the description, in place of *description*
- **payment\_secret** (hash, optional): the secret to hand to the payee node
doc/schemas: decode, decodepay One of the more complex ones. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-05-26 07:54:01 +02:00
- **features** (hex, optional): the features bitmap for this invoice
fromschema.py: escape underscores in descriptions
2022-11-11 03:03:13 +01:00
- **payment\_metadata** (hex, optional): the payment\_metadata to put in the payment
doc/schemas: decode, decodepay One of the more complex ones. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-05-26 07:54:01 +02:00
- **fallbacks** (array of objects, optional): onchain addresses:
- **type** (string): the address type (if known) (one of "P2PKH", "P2SH", "P2WPKH", "P2WSH")
- **hex** (hex): Raw encoded address
- **addr** (string, optional): the address in appropriate format for *type*
- **routes** (array of arrays, optional): Route hints to the *payee*:
- hops in the route:
- **pubkey** (pubkey): the public key of the node
doc: escape output types (esp `short_channel_id`). We can also remove the listpeers closer hack, which was removed from the schema already. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-09-08 03:08:00 +02:00
- **short\_channel\_id** (short\_channel\_id): a channel to the next peer
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 23:45:06 +02:00
- **fee\_base\_msat** (msat): the base fee for payments
- **fee\_proportional\_millionths** (u32): the parts-per-million fee for payments
- **cltv\_expiry\_delta** (u32): the CLTV delta across this hop
doc/schemas: decode, decodepay One of the more complex ones. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-05-26 07:54:01 +02:00
- **extra** (array of objects, optional): Any extra fields we didn't know how to parse:
- **tag** (string): The bech32 letter which identifies this field (always 1 characters)
- **data** (string): The bech32 data for this field
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 12:07:59 +02:00
doc/schemas: decode, decodepay One of the more complex ones. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-05-26 07:54:01 +02:00
[comment]: # (GENERATE-FROM-SCHEMA-END)
doc/manpages: replace asciidoc by markdown
2019-08-10 01:54:18 +02:00
Technically, the *description* field is optional if a
*description\_hash* field is given, but in this case **decodepay** will
only succeed if the optional *description* field is passed and matches
the *description\_hash*. In practice, these are currently unused.
AUTHOR
------
Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible.
SEE ALSO
--------
lightning-pay(7), lightning-getroute(7), lightning-sendpay(7).
[BOLT
doc: update references to old BOLTs repo. This reveals that common/test/run-bolt12_merkle-json.c was broken! Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-09-29 05:49:03 +02:00
\#11](https://github.com/lightning/bolts/blob/master/11-payment-encoding.md).
doc/manpages: replace asciidoc by markdown
2019-08-10 01:54:18 +02:00
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 03:33:16 +02:00
doc/schemas: fix old deprecations. `"deprecated": true` is obsolete; we don't document them anyway. Where it would have otherwise changed the GRPC wrappers, I actually put the version number in. We allow "listchannels" to have "satoshis" since we have some tests that run in deprecated-api mode. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2023-01-30 07:24:18 +01:00
[comment]: # ( SHA256STAMP:e20f638716d74697afbea9cb4dd5afa380505dda65dcd3bba1579d2ed79bdc6b)
Reference in New Issue Copy Permalink