From 1bd1829a8e2f58880010098260c920a1eff9f85f Mon Sep 17 00:00:00 2001 From: Rusty Russell Date: Thu, 15 Aug 2019 10:12:22 +0930 Subject: [PATCH] doc: update lightning-listforwards(7) It didn't have the new payment_hash field in it, and needed updating to list optional fields. Signed-off-by: Rusty Russell --- doc/lightning-listforwards.7 | 74 ++++++++++++++++++++------------ doc/lightning-listforwards.7.txt | 19 +++++--- 2 files changed, 61 insertions(+), 32 deletions(-) diff --git a/doc/lightning-listforwards.7 b/doc/lightning-listforwards.7 index 29e22caa4..0c407bc17 100644 --- a/doc/lightning-listforwards.7 +++ b/doc/lightning-listforwards.7 @@ -2,12 +2,12 @@ .\" Title: lightning-listforwards .\" Author: [see the "AUTHOR" section] .\" Generator: DocBook XSL Stylesheets v1.79.1 -.\" Date: 07/15/2019 +.\" Date: 08/15/2019 .\" Manual: \ \& .\" Source: \ \& .\" Language: English .\" -.TH "LIGHTNING\-LISTFORWA" "7" "07/15/2019" "\ \&" "\ \&" +.TH "LIGHTNING\-LISTFORWA" "7" "08/15/2019" "\ \&" "\ \&" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -61,18 +61,6 @@ Each entry in \fIforwards\fR will include: .sp -1 .IP \(bu 2.3 .\} -\fIout_channel\fR -\- the short_channel_id of to which the outgoing htlc is supposed to be forwarded\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} \fIin_msatoshi\fR, \fIin_msat\fR \- amount of msatoshis that are forwarded to this node\&. @@ -86,9 +74,16 @@ Each entry in \fIforwards\fR will include: .sp -1 .IP \(bu 2.3 .\} -\fIout_msatoshi\fR, -\fIout_msat\fR -\- amount of msatoshis to be forwarded\&. +\fIstatus\fR +\- status can be either +\fIoffered\fR +if the routing process is still ongoing, +\fIsettled\fR +if the routing process is completed, +\fIfailed\fR +if the routing process could not be completed, or +\fIlocal_failed\fR +if the node failed the forward itself\&. .RE .sp .RS 4 @@ -99,6 +94,20 @@ Each entry in \fIforwards\fR will include: .sp -1 .IP \(bu 2.3 .\} +\fIreceived_time\fR +\- timestamp when incoming htlc was received\&. +.RE +.sp +The following additional fields are usually present, but will not be for some variants of status \fIlocal_failed\fR (if it failed before we determined these): +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} \fIfee\fR, \fIfee_msat\fR \- fee offered for forwarding the htlc in msatoshi\&. @@ -112,14 +121,8 @@ Each entry in \fIforwards\fR will include: .sp -1 .IP \(bu 2.3 .\} -\fIstatus\fR -\- status can be either -\fIoffered\fR -if the routing process is still ongoing, -\fIsettled\fR -if the routing process is completed or -\fIfailed\fR -if the routing process could not be completed\&. +\fIout_channel\fR +\- the short_channel_id of to which the outgoing htlc is supposed to be forwarded\&. .RE .sp .RS 4 @@ -130,10 +133,27 @@ if the routing process could not be completed\&. .sp -1 .IP \(bu 2.3 .\} -\fIreceived_time\fR -\- timestamp when incoming htlc was received\&. +\fIout_msatoshi\fR, +\fIout_msat\fR +\- amount of msatoshis to be forwarded\&. .RE .sp +The following fields may be offered, but for old forgotten HTLCs they will be omitted: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fIpayment_hash\fR +\- the payment_hash belonging to the HTLC\&. +.RE +.sp +If the status is not \fIoffered\fR, the following additional fields are present: +.sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c diff --git a/doc/lightning-listforwards.7.txt b/doc/lightning-listforwards.7.txt index 3643b0d7c..8b2128a44 100644 --- a/doc/lightning-listforwards.7.txt +++ b/doc/lightning-listforwards.7.txt @@ -22,17 +22,26 @@ Each entry in 'forwards' will include: - 'in_channel' - the short_channel_id of the channel that recieved the incoming htlc. -- 'out_channel' - the short_channel_id of to which the outgoing htlc is supposed to be forwarded. - - 'in_msatoshi', 'in_msat' - amount of msatoshis that are forwarded to this node. -- 'out_msatoshi', 'out_msat' - amount of msatoshis to be forwarded. +- 'status' - status can be either 'offered' if the routing process is still ongoing, 'settled' if the routing process is completed, 'failed' if the routing process could not be completed, or 'local_failed' if the node failed the forward itself. + +- '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): - 'fee', 'fee_msat' - fee offered for forwarding the htlc in msatoshi. -- '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. +- 'out_channel' - the short_channel_id of to which the outgoing htlc is supposed to be forwarded. -- 'received_time' - timestamp when incoming htlc was received. +- '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).