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
aab9893661
core-lightning/doc/lightning-listforwards.7.md
Christian Decker c3254e6639 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-09-02 16:31:36 +02:00

1.8 KiB
Raw Blame History

lightning-listforwards -- Command showing all htlcs and their information

SYNOPSIS

listforwards

DESCRIPTION

The listforwards RPC command displays all htlcs that have been attempted to be forwarded by the c-lightning node.

RETURN VALUE

On success one array will be returned: forwards with htlcs that have been processed

Each entry in forwards will include:

  • in_channel: the short_channel_id of the channel that recieved the incoming htlc.
  • in_msatoshi, in_msat - amount of msatoshis that are forwarded to this node.
  • status: status can be either offered if the routing process is still ongoing, settled if the routing process is completed or failed if the routing process could not be completed.
  • received_time: timestamp when incoming htlc was received.

The following additional fields are usually present, but will not be for some variants of status local_failed (if it failed before we determined these):

  • out_channel: the short_channel_id of to which the outgoing htlc is supposed to be forwarded.
  • fee, fee_msat: fee offered for forwarding the htlc in msatoshi.
  • out_msatoshi, out_msat - amount of msatoshis to be forwarded.

The following fields may be offered, but for old forgotten HTLCs they will be omitted:

  • payment_hash - the payment_hash belonging to the HTLC.

If the status is not 'offered', the following additional fields are present:

  • resolved_time - timestamp when htlc was resolved (settled or failed).

AUTHOR

Rene Pickhardt <r.pickhardt@gmail.com> is mainly responsible.

SEE ALSO

lightning-getinfo(7)

RESOURCES

Main web site: https://github.com/ElementsProject/lightning