2019-08-31 14:30:56 +02:00
|
|
|
lightning-listforwards -- Command showing all htlcs and their information
|
|
|
|
|
=========================================================================
|
2019-08-10 01:54:18 +02:00
|
|
|
|
|
|
|
|
SYNOPSIS
|
|
|
|
|
--------
|
|
|
|
|
|
2021-01-26 09:27:42 +01:00
|
|
|
**listforwards** \[*status*\] \[*in_channel*\] \[*out_channel*\]
|
2019-08-10 01:54:18 +02:00
|
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
|
-----------
|
|
|
|
|
|
|
|
|
|
The **listforwards** RPC command displays all htlcs that have been
|
|
|
|
|
attempted to be forwarded by the c-lightning node.
|
|
|
|
|
|
2021-01-26 09:27:42 +01:00
|
|
|
If *status* is specified, then only the forwards with the given status are returned.
|
|
|
|
|
*status* can be either *offered* or *settled* or *failed* or *local_failed*
|
|
|
|
|
|
|
|
|
|
If *in_channel* or *out_channel* is specified, then only the matching forwards
|
|
|
|
|
on the given in/out channel are returned.
|
|
|
|
|
|
2019-08-10 01:54:18 +02:00
|
|
|
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>
|
2020-08-25 03:33:16 +02:00
|
|
|
|
