mirror of
https://github.com/ElementsProject/lightning.git
synced 2024-12-28 01:24:42 +01:00
ba7d4a8f6b
We were including the entire list of prerequisites when generating a shastamp, which for schemas includes the `tools/fromschema.py` doc. This meant all of our shasums were updating anytime this tool file changed. Instead, we just include the first prerequisite. See: https://www.gnu.org/software/make/manual/html_node/Automatic-Variables.html#Automatic-Variables
74 lines
3.1 KiB
Markdown
74 lines
3.1 KiB
Markdown
lightning-decodepay -- Command for decoding a bolt11 string (low-level)
|
|
=======================================================================
|
|
|
|
SYNOPSIS
|
|
--------
|
|
|
|
**decodepay** *bolt11* [*description*]
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
|
|
The **decodepay** RPC command checks and parses a *bolt11* string as
|
|
specified by the BOLT 11 specification.
|
|
|
|
RETURN VALUE
|
|
------------
|
|
|
|
[comment]: # (GENERATE-FROM-SCHEMA-START)
|
|
On success, an object is returned, containing:
|
|
- **currency** (string): the BIP173 name for the currency
|
|
- **created_at** (u64): the UNIX-style timestamp of the invoice
|
|
- **expiry** (u64): the number of seconds this is valid after *timestamp*
|
|
- **payee** (pubkey): the public key of the recipient
|
|
- **payment_hash** (hex): the hash of the *payment_preimage* (always 64 characters)
|
|
- **signature** (signature): signature of the *payee* on this invoice
|
|
- **min_final_cltv_expiry** (u32): the minimum CLTV delay for the final node
|
|
- **amount_msat** (msat, optional): Amount the invoice asked for
|
|
- **description** (string, optional): the description of the purpose of the purchase
|
|
- **description_hash** (hex, optional): the hash of the description, in place of *description* (always 64 characters)
|
|
- **payment_secret** (hex, optional): the secret to hand to the payee node (always 64 characters)
|
|
- **features** (hex, optional): the features bitmap for this invoice
|
|
- **payment_metadata** (hex, optional): the payment_metadata to put in the payment
|
|
- **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
|
|
- **short_channel_id** (short_channel_id): a channel to the next peer
|
|
- **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
|
|
- **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
|
|
|
|
[comment]: # (GENERATE-FROM-SCHEMA-END)
|
|
|
|
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
|
|
\#11](https://github.com/lightningnetwork/lightning-rfc/blob/master/11-payment-encoding.md).
|
|
|
|
RESOURCES
|
|
---------
|
|
|
|
Main web site: <https://github.com/ElementsProject/lightning>
|
|
|
|
[comment]: # ( SHA256STAMP:e6e27ff57a8e26db5d4bba8be2a5faa6f1c58b20ef625f371e6e66d17932f8a0)
|