Fix getpeerinfo doc #24691

pull MarcoFalke wants to merge 1 commits into bitcoin:master from MarcoFalke:2203-doc-🎲 changing 1 files +3 −3

MarcoFalke commented at 8:00 AM on March 28, 2022: member
- Replace node with peer
- Remove unused \n
- Mark optional fields optional. See commit 9344697e57bd23d955df493d0581193ca1dc7cca, found by #23083
doc: Fix getpeerinfo doc faac877ffd
MarcoFalke force-pushed on Mar 28, 2022
MarcoFalke added the label Docs on Mar 28, 2022
MarcoFalke added the label RPC/REST/ZMQ on Mar 28, 2022

MarcoFalke commented at 8:10 AM on March 28, 2022: member

diff --git a/getpeerinfo b/getpeerinfo
index ae40ea4..40b0d63 100644
--- a/getpeerinfo
+++ b/getpeerinfo
@@ -1,6 +1,6 @@
 getpeerinfo
 
-Returns data about each connected network node as a json array of objects.
+Returns data about each connected network peer as a json array of objects.
 
 Result:
 [                                         (json array)
@@ -17,7 +17,7 @@ Result:
       "str",                              (string) the service name if it is recognised
       ...
     ],
-    "relaytxes" : true|false,             (boolean) Whether peer has asked us to relay transactions to it
+    "relaytxes" : true|false,             (boolean, optional) Whether peer has asked us to relay transactions to it
     "lastsend" : xxx,                     (numeric) The UNIX epoch time of the last send
     "lastrecv" : xxx,                     (numeric) The UNIX epoch time of the last receive
     "last_transaction" : xxx,             (numeric) The UNIX epoch time of the last valid transaction received from this peer
@@ -55,7 +55,7 @@ Result:
                                           
       ...
     ],
-    "minfeefilter" : n,                   (numeric) The minimum fee rate for transactions this peer accepts
+    "minfeefilter" : n,                   (numeric, optional) The minimum fee rate for transactions this peer accepts
     "bytessent_per_msg" : {               (json object)
       "msg" : n,                          (numeric) The total bytes sent aggregated by message type
                                           When a message type is not listed in this json object, the bytes sent are 0.

fanquake approved
fanquake commented at 10:50 AM on March 28, 2022: member

ACK faac877ffd38c3d8515c9e7b585546434f91b741
fanquake merged this on Mar 28, 2022
fanquake closed this on Mar 28, 2022
jonatack commented at 10:58 AM on March 28, 2022: member

Post-merge ACK
MarcoFalke deleted the branch on Mar 28, 2022
fanquake referenced this in commit a13946b822 on Mar 28, 2022
fanquake referenced this in commit c243e08351 on Mar 31, 2022
sidhujag referenced this in commit 3b238d5d44 on Apr 3, 2022
sidhujag referenced this in commit 32e152c768 on Apr 3, 2022
luke-jr commented at 11:04 PM on April 13, 2022: member

Note: This change would be incorrect in 23.x.
MarcoFalke referenced this in commit 44037a2912 on May 23, 2022
sidhujag referenced this in commit 21ede5a53a on May 28, 2022
DrahtBot locked this on Apr 13, 2023

Contributors

Labels

Linked (view graph)

#23083 rpc: Fail to return undocumented or misdocumented JSON #25176 Fix frequent -netinfo JSON errors from missing getpeerinfo#relaytxes