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
|
|
|
|
|
--------
|
|
|
|
|
|
2022-01-26 18:18:49 +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
|
2022-04-06 07:09:48 +02:00
|
|
|
attempted to be forwarded by the Core Lightning node.
|
2019-08-10 01:54:18 +02:00
|
|
|
|
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
|
|
|
|
|
------------
|
|
|
|
|
|
2021-06-16 03:05:17 +02:00
|
|
|
[comment]: # (GENERATE-FROM-SCHEMA-START)
|
|
|
|
|
On success, an object containing **forwards** is returned. It is an array of objects, where each object contains:
|
|
|
|
|
- **in_channel** (short_channel_id): the channel that received the HTLC
|
|
|
|
|
- **in_msat** (msat): the value of the incoming HTLC
|
|
|
|
|
- **status** (string): still ongoing, completed, failed locally, or failed after forwarding (one of "offered", "settled", "local_failed", "failed")
|
|
|
|
|
- **received_time** (number): the UNIX timestamp when this was received
|
2022-07-09 05:23:24 +02:00
|
|
|
- **out_channel** (short_channel_id, optional): the channel that the HTLC (trying to) forward to
|
2021-06-16 03:05:17 +02:00
|
|
|
- **payment_hash** (hex, optional): payment hash sought by HTLC (always 64 characters)
|
2022-03-31 05:14:27 +02:00
|
|
|
- **style** (string, optional): Either a legacy onion format or a modern tlv format (one of "legacy", "tlv")
|
2021-06-16 03:05:17 +02:00
|
|
|
|
2022-07-09 05:23:24 +02:00
|
|
|
If **out_msat** is present:
|
2021-06-16 03:05:17 +02:00
|
|
|
- **fee_msat** (msat): the amount this paid in fees
|
|
|
|
|
- **out_msat** (msat): the amount we sent out the *out_channel*
|
|
|
|
|
|
|
|
|
|
If **status** is "settled" or "failed":
|
|
|
|
|
- **resolved_time** (number): the UNIX timestamp when this was resolved
|
|
|
|
|
|
|
|
|
|
If **status** is "local_failed" or "failed":
|
|
|
|
|
- **failcode** (u32, optional): the numeric onion code returned
|
|
|
|
|
- **failreason** (string, optional): the name of the onion code returned
|
2021-09-03 12:07:59 +02:00
|
|
|
|
2021-06-16 03:05:17 +02:00
|
|
|
[comment]: # (GENERATE-FROM-SCHEMA-END)
|
2019-08-10 01:54:18 +02:00
|
|
|
|
|
|
|
|
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
|
|
|
|
2022-07-09 05:23:24 +02:00
|
|
|
[comment]: # ( SHA256STAMP:c8adfa0a6dcae939c5da919d7996261db8663a871210e33b426c3b40c30d7b29)
|
