core-lightning/doc/lightning-listforwards.7.txt

46 lines
1.2 KiB
Plaintext

LIGHTNING-LISTFORWARDS(7)
=========================
:doctype: manpage
NAME
----
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.
- 'out_channel' - the short_channel_id of to which the outgoing htlc is supposed to be forwarded.
- 'in_msatoshi' - amount of msatoshis that are forwarded to this node.
- 'out_msatoshi' - amount of msatoshis to be forwarded.
- 'fee' - fee offered for forwarding the htlc in msatoshi.
- '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.
AUTHOR
------
Rene Pickhardt <r.pickhardt@gmail.com> is mainly responsible.
SEE ALSO
--------
lightning-getinfo(7)
RESOURCES
---------
Main web site: https://github.com/ElementsProject/lightning