111 lines
3.2 KiB
Groff
111 lines
3.2 KiB
Groff
.TH "LIGHTNING-DECODEPAY" "7" "" "" "lightning-decodepay"
|
|
.SH NAME
|
|
lightning-decodepay - Command for decoding a bolt11 string (low-level)
|
|
.SH SYNOPSIS
|
|
|
|
\fBdecodepay\fR \fIbolt11\fR [\fIdescription\fR]
|
|
|
|
.SH DESCRIPTION
|
|
|
|
The \fBdecodepay\fR RPC command checks and parses a \fIbolt11\fR string as
|
|
specified by the BOLT 11 specification\.
|
|
|
|
.SH RETURN VALUE
|
|
|
|
On success, an object is returned, containing:
|
|
|
|
.RS
|
|
.IP \[bu]
|
|
\fBcurrency\fR (string): the BIP173 name for the currency
|
|
.IP \[bu]
|
|
\fBcreated_at\fR (u64): the UNIX-style timestamp of the invoice
|
|
.IP \[bu]
|
|
\fBexpiry\fR (u64): the number of seconds this is valid after \fItimestamp\fR
|
|
.IP \[bu]
|
|
\fBpayee\fR (pubkey): the public key of the recipient
|
|
.IP \[bu]
|
|
\fBpayment_hash\fR (hex): the hash of the \fIpayment_preimage\fR (always 64 characters)
|
|
.IP \[bu]
|
|
\fBsignature\fR (signature): signature of the \fIpayee\fR on this invoice
|
|
.IP \[bu]
|
|
\fBmin_final_cltv_expiry\fR (u32): the minimum CLTV delay for the final node
|
|
.IP \[bu]
|
|
\fBamount_msat\fR (msat, optional): Amount the invoice asked for
|
|
.IP \[bu]
|
|
\fBdescription\fR (string, optional): the description of the purpose of the purchase
|
|
.IP \[bu]
|
|
\fBdescription_hash\fR (hex, optional): the hash of the description, in place of \fIdescription\fR (always 64 characters)
|
|
.IP \[bu]
|
|
\fBpayment_secret\fR (hex, optional): the secret to hand to the payee node (always 64 characters)
|
|
.IP \[bu]
|
|
\fBfeatures\fR (hex, optional): the features bitmap for this invoice
|
|
.IP \[bu]
|
|
\fBfallbacks\fR (array of objects, optional): onchain addresses:
|
|
.RS
|
|
.IP \[bu]
|
|
\fBtype\fR (string): the address type (if known) (one of "P2PKH", "P2SH", "P2WPKH", "P2WSH")
|
|
.IP \[bu]
|
|
\fBhex\fR (hex): Raw encoded address
|
|
.IP \[bu]
|
|
\fBaddr\fR (string, optional): the address in appropriate format for \fItype\fR
|
|
|
|
.RE
|
|
|
|
.IP \[bu]
|
|
\fBroutes\fR (array of arrays, optional): Route hints to the \fIpayee\fR:
|
|
.RS
|
|
.IP \[bu]
|
|
hops in the route:
|
|
.RS
|
|
.IP \[bu]
|
|
\fBpubkey\fR (pubkey): the public key of the node
|
|
.IP \[bu]
|
|
\fBshort_channel_id\fR (short_channel_id): a channel to the next peer
|
|
.IP \[bu]
|
|
\fBfee_base_msat\fR (u32): the base fee for payments
|
|
.IP \[bu]
|
|
\fBfee_proportional_millionths\fR (u32): the parts-per-million fee for payments
|
|
.IP \[bu]
|
|
\fBcltv_expiry_delta\fR (u32): the CLTV delta across this hop
|
|
|
|
.RE
|
|
|
|
|
|
.RE
|
|
|
|
.IP \[bu]
|
|
\fBextra\fR (array of objects, optional): Any extra fields we didn't know how to parse:
|
|
.RS
|
|
.IP \[bu]
|
|
\fBtag\fR (string): The bech32 letter which identifies this field (always 1 characters)
|
|
.IP \[bu]
|
|
\fBdata\fR (string): The bech32 data for this field
|
|
|
|
.RE
|
|
|
|
|
|
.RE
|
|
|
|
Technically, the \fIdescription\fR field is optional if a
|
|
\fIdescription_hash\fR field is given, but in this case \fBdecodepay\fR will
|
|
only succeed if the optional \fIdescription\fR field is passed and matches
|
|
the \fIdescription_hash\fR\. In practice, these are currently unused\.
|
|
|
|
.SH AUTHOR
|
|
|
|
Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
|
|
|
|
.SH SEE ALSO
|
|
|
|
\fBlightning-pay\fR(7), \fBlightning-getroute\fR(7), \fBlightning-sendpay\fR(7)\.
|
|
|
|
|
|
\fBBOLT
|
|
#11\fR (\fIhttps://github.com/lightningnetwork/lightning-rfc/blob/master/11-payment-encoding.md\fR)\.
|
|
|
|
.SH RESOURCES
|
|
|
|
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
|
|
|
|
\" SHA256STAMP:2bd0b4c9b0e358ae5dbfde5d6a460fc6d24c397614c120a29c43a5cce4ebf721
|