docs: document changes to waitsendpay command.

Signed-off-by: Rusty Russell <[email protected]>

CHANGELOG.md

@@ -30,6 +30,8 @@ changes.
 
 ### Removed
 
+- JSON API: the `waitsendpay` command error return no longer includes `channel_update`
+
 ### Fixed
 
 - Protocol: handling `query_channel_range` for large numbers of blocks

doc/lightning-waitsendpay.7

@@ -2,12 +2,12 @@
 .\"     Title: lightning-waitsendpay
 .\"    Author: [see the "AUTHOR" section]
 .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
-.\"      Date: 04/26/2018
+.\"      Date: 01/15/2019
 .\"    Manual: \ \&
 .\"    Source: \ \&
 .\"  Language: English
 .\"
-.TH "LIGHTNING\-WAITSENDP" "7" "04/26/2018" "\ \&" "\ \&"
+.TH "LIGHTNING\-WAITSENDP" "7" "01/15/2019" "\ \&" "\ \&"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -168,9 +168,19 @@ A routing failure object has the fields below:
 .sp -1
 .IP \(bu 2.3
 .\}
-\fIerring_channel\fR\&. The short channel ID of the channel that has the error, or
-\fI0:0:0\fR
-if the destination node raised the error\&.
+\fIerring_channel\fR\&. The short channel ID of the channel that has the error (or the final channel if the destination raised the error)\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+\fIerring_direction\fR\&. The direction of traversing the
+\fIerring_channel\fR\&.
 .RE
 .sp
 .RS 4
@@ -192,11 +202,8 @@ if the destination node raised the error\&.
 .sp -1
 .IP \(bu 2.3
 .\}
-\fIchannel_update\fR\&. The hex string of the
-\fIchannel_update\fR
-message received from the remote node\&. Only present if error is from the remote node and the
-\fIfailcode\fR
-has the UPDATE bit set, as per BOLT #4\&.
+\fIfailcodename\fR\&. The human\-readable name corresponding to
+\fIfailcode\fR, if known\&.
 .RE
 .SH "AUTHOR"
 .sp

doc/lightning-waitsendpay.7.txt

@@ -71,13 +71,10 @@ A routing failure object has the fields below:
 * 'erring_node'. The hex string of the pubkey id of the node
   that reported the error.
 * 'erring_channel'. The short channel ID of the channel that
-  has the error, or '0:0:0' if the destination node raised
-  the error.
+  has the error (or the final channel if the destination raised the error).
+* 'erring_direction'. The direction of traversing the 'erring_channel'.
 * 'failcode'. The failure code, as per BOLT #4.
-* 'channel_update'. The hex string of the 'channel_update'
-  message received from the remote node. Only present if
-  error is from the remote node and the 'failcode' has the
-  UPDATE bit set, as per BOLT #4.
+* 'failcodename'. The human-readable name corresponding to 'failcode', if known.
 
 AUTHOR
 ------