mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2025-01-18 05:12:45 +01:00
Code Issues Projects Releases Wiki Activity

Updated listforwards doc with new parameters

Browse Source 
Changelog-Added: JSON-RPC: `listforwards` can now filter by status, in and out channel.
This commit is contained in:
Karol Hosiawa 2021-01-26 09:27:42 +01:00 committed by Rusty Russell
parent 7b72ea7061
commit bb48de447d
2 changed files with 17 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/lightning-listforwards.7 generated
View File

@ -3,13 +3,21 @@
lightning-listforwards - Command showing all htlcs and their information lightning-listforwards - Command showing all htlcs and their information
.SH SYNOPSIS .SH SYNOPSIS
\fBlistforwards\fR \fBlistforwards\fR [\fIstatus\fR] [\fIin_channel\fR] [\fIout_channel\fR]
.SH DESCRIPTION .SH DESCRIPTION
The \fBlistforwards\fR RPC command displays all htlcs that have been The \fBlistforwards\fR RPC command displays all htlcs that have been
attempted to be forwarded by the c-lightning node\. attempted to be forwarded by the c-lightning node\.
If \fIstatus\fR is specified, then only the forwards with the given status are returned\.
\fIstatus\fR can be either \fIoffered\fR or \fIsettled\fR or \fIfailed\fR or \fIlocal_failed\fR
If \fIin_channel\fR or \fIout_channel\fR is specified, then only the matching forwards
on the given in/out channel are returned\.
.SH RETURN VALUE .SH RETURN VALUE
On success one array will be returned: \fIforwards\fR with htlcs that have On success one array will be returned: \fIforwards\fR with htlcs that have
@ -71,4 +79,4 @@ Rene Pickhardt \fI<r.pickhardt@gmail.com\fR> is mainly responsible\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:8cefda0944e3371f1f7bca046d8792125fb8b6eda11351b6f39a08bab60cff2e \" SHA256STAMP:b374dbf5f639ad8782b4ad2ff515f25b22a4407ef77f2e0904c975d1a7ccfbe4

8
doc/lightning-listforwards.7.md
View File

@ -4,7 +4,7 @@ lightning-listforwards -- Command showing all htlcs and their information
SYNOPSIS SYNOPSIS
-------- --------
**listforwards** **listforwards** \[*status*\] \[*in_channel*\] \[*out_channel*\]
DESCRIPTION DESCRIPTION
----------- -----------
@ -12,6 +12,12 @@ DESCRIPTION
The **listforwards** RPC command displays all htlcs that have been The **listforwards** RPC command displays all htlcs that have been
attempted to be forwarded by the c-lightning node. attempted to be forwarded by the c-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 RETURN VALUE
------------ ------------