Fix getpeerinfo doc #24691

maflcko · 2022-03-28T08:00:57Z

Replace node with peer
Remove unused \n
Mark optional fields optional. See commit 9344697, found by rpc: Fail to return undocumented or misdocumented JSON #23083

maflcko · 2022-03-28T08:10:32Z

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

ACK faac877

jonatack · 2022-03-28T10:58:00Z

Post-merge ACK

fc892c3 rpc: Fail to return undocumented or misdocumented JSON (MarcoFalke) f4bc4a7 rpc: Add m_skip_type_check to RPCResult (MarcoFalke) Pull request description: This avoids documentation shortcomings such as the ones fixed in commit e7b6272, 138d55e, 577bd51, f8c84e0, 0ee9a00, 13f4185, or faecb2e ACKs for top commit: fanquake: ACK fc892c3 - tested that this catches issue, i.e #24691: Tree-SHA512: 9d0d7e6291bfc6f67541a4ff746d374ad8751fefcff6d103d8621c0298b190ab1d209ce96cfc3a0d4a6a5460a9f9bb790eb96027b16e5ff91f2512e40c92ca84

174af33 util: Add inotify_rm_watch to syscall sandbox (AllowFileSystem) (Hennadii Stepanov) ded10fe build: Fix Boost.Process test for Boost 1.78 (Hennadii Stepanov) 26c2f23 build: Fix Boost.Process detection on macOS arm64 (Hennadii Stepanov) 85f85c7 util: add linkat to syscall sandbox (AllowFileSystem) (fanquake) eaa0419 contrib: fix signet miner (sighash mismatch) (Sebastian Falbesoner) 235b042 rpc: Exclude descriptor when address is excluded (MarcoFalke) b05a59b ci: Temporarily use clang-13 to work around clang-14 TSan bug (MarcoFalke) 65b9667 doc, init: add links to doc/cjdns.md (Jon Atack) 7a553d4 doc: update i2p.md with cjdns, improve local addresses section (Jon Atack) 4148396 doc: update tor.md with cjdns and getnodeaddresses, fix tor grep, (Jon Atack) 4690e8a doc: create initial doc/cjdns.md for cjdns how-to documentation (Jon Atack) 5d24f61 Clarify in -maxtimeadjustment that only outbound peers influence time data (Jon Atack) b1646f1 test: set segwit height back to 0 on regtest (Martin Zumsande) ef6a37b rpc: rename getdeploymentinfo status-next to status_next (Jon Atack) 2a6fcf9 init, doc: improve -onlynet help and tor/i2p documentation (Jon Atack) Pull request description: Backport the following to 23.x: - #24468 - #24528 - #24527 - #24609 - #24555 - #24663 - #24572 - #24636 - #24553 - #24659 - #24521 - #24523 - #24690 - #24710 Possibly also: - #24579 - #24691 ACKs for top commit: laanwj: List-of-commits ACK 174af33, I think we should merge this and move forward with rc3.. hebasto: ACK 174af33 Tree-SHA512: 5a493e1652b780b527767d6ca9e67012abd2fa5573496e85e0d8aa4bed3eb332bfcd72610b8dfb954ff274d42450623233c96c479de2085b9c8344ba5abf1935

faac877 doc: Fix getpeerinfo doc (MarcoFalke) Pull request description: * Replace `node` with `peer` * Remove unused `\n` * Mark optional fields optional. See commit 9344697, found by bitcoin#23083 ACKs for top commit: fanquake: ACK faac877 Tree-SHA512: ae4d52a0dcf8e132d9084e632d65fa835b1e7d0ed5c3d45a360570414d1e20bc7fb6500ff9be94b784af1dec5badcd1304153b1a4a59a6c484a87d8afd88b8bd

…d JSON fc892c3 rpc: Fail to return undocumented or misdocumented JSON (MarcoFalke) f4bc4a7 rpc: Add m_skip_type_check to RPCResult (MarcoFalke) Pull request description: This avoids documentation shortcomings such as the ones fixed in commit e7b6272, 138d55e, 577bd51, f8c84e0, 0ee9a00, 13f4185, or faecb2e ACKs for top commit: fanquake: ACK fc892c3 - tested that this catches issue, i.e bitcoin#24691: Tree-SHA512: 9d0d7e6291bfc6f67541a4ff746d374ad8751fefcff6d103d8621c0298b190ab1d209ce96cfc3a0d4a6a5460a9f9bb790eb96027b16e5ff91f2512e40c92ca84

luke-jr · 2022-04-13T23:04:04Z

Note: This change would be incorrect in 23.x.

…issing getpeerinfo#relaytxes a17c5e9 Rename NetinfoRequestHandler::is_block_relay data member to is_tx_relay (Jon Atack) f0bb7db Fix frequent -netinfo JSON errors from null getpeerinfo#relaytxes (Jon Atack) Pull request description: CLI -netinfo frequently returns "error: JSON value is not a boolean as expected" since the merge of #21160, which moved fRelayTxes (renamed to m_relay_txs in that pull) from CNodeStats to CNodeStateStats. This change made getpeerinfo "relaytxes" an optional field that can return UniValue IsNull(). It is the only optional field consumed by -netinfo where the latter didn't already handle that case. See also bitcoin/bitcoin#24691. Also rename the NetinfoRequestHandler::is_block_relay data member to is_tx_relay and inverse its boolean logic. The naming is out of date and incorrect, as lack of request of tx relay does not imply block relay, and a preference for tx relay doesn't imply that block relay isn't happening. Thanks to Marco Falke and Martin Zumsande for their feedback on this. (I may look at reducing the number of optional node stats fields via refactoring at the net processing level, but ongoing refactoring there may make that slow or complicated and this is a one-line fix that works now.) ACKs for top commit: mzumsande: Code review ACK a17c5e9 Tree-SHA512: dc54ce80b78122874a6794555f99e5b328a1574b52bb3e7f974c699c2b759a60ea0807a6483c5bc0414a950d853c0eeeb13dcc1b790d3917c6ee4c9c99fe159f

…etpeerinfo#relaytxes a17c5e9 Rename NetinfoRequestHandler::is_block_relay data member to is_tx_relay (Jon Atack) f0bb7db Fix frequent -netinfo JSON errors from null getpeerinfo#relaytxes (Jon Atack) Pull request description: CLI -netinfo frequently returns "error: JSON value is not a boolean as expected" since the merge of bitcoin#21160, which moved fRelayTxes (renamed to m_relay_txs in that pull) from CNodeStats to CNodeStateStats. This change made getpeerinfo "relaytxes" an optional field that can return UniValue IsNull(). It is the only optional field consumed by -netinfo where the latter didn't already handle that case. See also bitcoin#24691. Also rename the NetinfoRequestHandler::is_block_relay data member to is_tx_relay and inverse its boolean logic. The naming is out of date and incorrect, as lack of request of tx relay does not imply block relay, and a preference for tx relay doesn't imply that block relay isn't happening. Thanks to Marco Falke and Martin Zumsande for their feedback on this. (I may look at reducing the number of optional node stats fields via refactoring at the net processing level, but ongoing refactoring there may make that slow or complicated and this is a one-line fix that works now.) ACKs for top commit: mzumsande: Code review ACK a17c5e9 Tree-SHA512: dc54ce80b78122874a6794555f99e5b328a1574b52bb3e7f974c699c2b759a60ea0807a6483c5bc0414a950d853c0eeeb13dcc1b790d3917c6ee4c9c99fe159f

doc: Fix getpeerinfo doc

faac877

maflcko force-pushed the 2203-doc- branch from fadbb52 to faac877 Compare March 28, 2022 08:01

maflcko added Docs RPC/REST/ZMQ labels Mar 28, 2022

maflcko mentioned this pull request Mar 28, 2022

net/net processing: Move tx inventory into net_processing #21160

Merged

fanquake approved these changes Mar 28, 2022

View reviewed changes

fanquake merged commit 56c4ac5 into bitcoin:master Mar 28, 2022

maflcko deleted the 2203-doc-🎲 branch March 28, 2022 11:16

jonatack mentioned this pull request Mar 28, 2022

23.x backports #24512

Merged

jonatack mentioned this pull request May 20, 2022

Fix frequent -netinfo JSON errors from missing getpeerinfo#relaytxes #25176

Merged

vasild mentioned this pull request Aug 25, 2022

p2p: always provide CNodeStateStats and getpeerinfo/netinfo/gui updates #25923

Closed

fanquake mentioned this pull request Sep 22, 2022

rpc, doc: getpeerinfo updates #26109

Merged

bitcoin locked and limited conversation to collaborators Apr 13, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix getpeerinfo doc #24691

Fix getpeerinfo doc #24691

maflcko commented Mar 28, 2022

maflcko commented Mar 28, 2022

fanquake left a comment

jonatack commented Mar 28, 2022

luke-jr commented Apr 13, 2022

Fix getpeerinfo doc #24691

Fix getpeerinfo doc #24691

Conversation

maflcko commented Mar 28, 2022

maflcko commented Mar 28, 2022

fanquake left a comment

Choose a reason for hiding this comment

jonatack commented Mar 28, 2022

luke-jr commented Apr 13, 2022