mirror of
https://github.com/aljazceru/lightning.git
synced 2025-12-19 23:24:27 +01:00
cafa1a8c65
We have to allow them (as otherwise `fees_collected_msat` in getinfo breaks), but it means that actually, in_htlc_id might be missing in listforwards (also, out_htlc_id might be missing, which we didn't catch before). Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Fixes: #5628
68 lines
2.5 KiB
Markdown
68 lines
2.5 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
|
|
- **in\_htlc\_id** (u64, optional): the unique HTLC id the sender gave this (not present if incoming channel was closed before ugprade to v22.11)
|
|
- **out\_channel** (short\_channel\_id, optional): the channel that the HTLC (trying to) forward to
|
|
- **out\_htlc\_id** (u64, optional): the unique HTLC id we gave this when sending (may be missing even if out_channel is present, for old forwards before v22.11)
|
|
- **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-autoclean-status(7), lightning-getinfo(7)
|
|
|
|
RESOURCES
|
|
---------
|
|
|
|
Main web site: <https://github.com/ElementsProject/lightning>
|
|
|
|
[comment]: # ( SHA256STAMP:15bf997ae8e93ab28b0084d9cc45fc80fb18b2bcf705f690f77617f0b66b069d)
|