mirror of
https://github.com/ElementsProject/lightning.git
synced 2024-11-19 18:11:28 +01:00
c3254e6639
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.
70 lines
1.9 KiB
Groff
Generated
70 lines
1.9 KiB
Groff
Generated
.TH "LIGHTNING-LISTFORWARDS" "7" "" "" "lightning-listforwards"
|
|
.SH NAME
|
|
lightning-listforwards - Command showing all htlcs and their information
|
|
.SH SYNOPSIS
|
|
|
|
\fBlistforwards\fR
|
|
|
|
.SH DESCRIPTION
|
|
|
|
The \fBlistforwards\fR RPC command displays all htlcs that have been
|
|
attempted to be forwarded by the c-lightning node\.
|
|
|
|
.SH RETURN VALUE
|
|
|
|
On success one array will be returned: \fIforwards\fR with htlcs that have
|
|
been processed
|
|
|
|
|
|
Each entry in \fIforwards\fR will include:
|
|
|
|
.IP \[bu]
|
|
\fIin_channel\fR: the short_channel_id of the channel that recieved the incoming htlc\.
|
|
.IP \[bu]
|
|
\fIin_msatoshi\fR, \fIin_msat\fR - amount of msatoshis that are forwarded to this node\.
|
|
.IP \[bu]
|
|
\fIstatus\fR: status can be either \fIoffered\fR if the routing process is still ongoing,
|
|
\fIsettled\fR if the routing process is completed or \fIfailed\fR if the routing process could not be completed\.
|
|
.IP \[bu]
|
|
\fIreceived_time\fR: timestamp when incoming htlc was received\.
|
|
|
|
|
|
The following additional fields are usually present, but will not be for some
|
|
variants of status \fIlocal_failed\fR (if it failed before we determined these):
|
|
|
|
.IP \[bu]
|
|
\fIout_channel\fR: the short_channel_id of to which the outgoing htlc is supposed to be forwarded\.
|
|
.IP \[bu]
|
|
\fIfee\fR, \fIfee_msat\fR: fee offered for forwarding the htlc in msatoshi\.
|
|
.IP \[bu]
|
|
\fIout_msatoshi\fR, \fIout_msat\fR - amount of msatoshis to be forwarded\.
|
|
|
|
|
|
The following fields may be offered, but for old forgotten HTLCs they will be omitted:
|
|
|
|
.IP \[bu]
|
|
\fIpayment_hash\fR - the payment_hash belonging to the HTLC\.
|
|
|
|
|
|
If the status is not 'offered', the following additional fields are present:
|
|
|
|
.IP \[bu]
|
|
\fIresolved_time\fR - timestamp when htlc was resolved (settled or failed)\.
|
|
|
|
.SH AUTHOR
|
|
|
|
Rene Pickhardt \fI<r.pickhardt@gmail.com\fR> is mainly responsible\.
|
|
|
|
.SH SEE ALSO
|
|
|
|
\fBlightning-getinfo\fR(7)
|
|
|
|
.SH RESOURCES
|
|
|
|
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
|
|
|
|
.HL
|
|
|
|
Last updated 2019-07-23 00:53:16 CEST
|
|
|