Files
lightning/doc/lightning-listforwards.7.md
Rusty Russell bcabb3825f Makefile: Revert ba7d4a8f6b (make-schema: don't include tools/fromschema.py in SHASUMS)
1. If the tool changes, you need to regenerate since the output may
   change.

2. This didn't just filter that out, ignored all but the first
   dependency, which made bisecting the bookkeeper plugin a nightmare:
   it didn't regenerate the .po file, causing random crashes.

If we want this, try $(filter-out tools/fromschema.py) instead.  But I
don't think we want that.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-09-08 00:36:51 +03:00

67 lines
2.2 KiB
Markdown

lightning-listforwards -- Command showing all htlcs and their information
=========================================================================
SYNOPSIS
--------
**listforwards** [*status*] [*in_channel*] [*out_channel*]
DESCRIPTION
-----------
The **listforwards** RPC command displays all htlcs that have been
attempted to be forwarded by the Core Lightning node.
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.
RETURN VALUE
------------
[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
- **out_channel** (short_channel_id, optional): the channel that the HTLC (trying to) forward to
- **payment_hash** (hex, optional): payment hash sought by HTLC (always 64 characters)
- **style** (string, optional): Either a legacy onion format or a modern tlv format (one of "legacy", "tlv")
If **out_msat** is present:
- **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
[comment]: # (GENERATE-FROM-SCHEMA-END)
AUTHOR
------
Rene Pickhardt <<r.pickhardt@gmail.com>> is mainly responsible.
SEE ALSO
--------
lightning-getinfo(7)
RESOURCES
---------
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:cc82cc624fd377f957a83e1d3a49607a7cfa3c87505ba70a3f3fa07d6d922089)