aboutsummaryrefslogtreecommitdiff
path: root/src/rpc
diff options
context:
space:
mode:
authorAmiti Uttarwar <amiti@uttarwar.org>2020-09-24 22:40:46 -0700
committerAmiti Uttarwar <amiti@uttarwar.org>2020-10-09 16:08:02 -0700
commit3069b56a456d98fca7c4a4ccd329581bd1f0b853 (patch)
tree9bfacfa686baf101e824b36e3bf0e1b4d34e1221 /src/rpc
parent875e1ccc9fe01e026e564dfd39a64d9a4b332a89 (diff)
downloadbitcoin-3069b56a456d98fca7c4a4ccd329581bd1f0b853.tar.xz
[doc] Improve help for getpeerinfo connection_type field.
Diffstat (limited to 'src/rpc')
-rw-r--r--src/rpc/net.cpp4
1 files changed, 3 insertions, 1 deletions
diff --git a/src/rpc/net.cpp b/src/rpc/net.cpp
index def21b119e..431199d4f6 100644
--- a/src/rpc/net.cpp
+++ b/src/rpc/net.cpp
@@ -118,7 +118,9 @@ static RPCHelpMan getpeerinfo()
{RPCResult::Type::BOOL, "inbound", "Inbound (true) or Outbound (false)"},
{RPCResult::Type::BOOL, "addnode", "Whether connection was due to addnode/-connect or if it was an automatic/inbound connection\n"
"(DEPRECATED, returned only if the config option -deprecatedrpc=getpeerinfo_addnode is passed)"},
- {RPCResult::Type::STR, "connection_type", "Type of connection: \n" + Join(CONNECTION_TYPE_DOC, ",\n") + "."},
+ {RPCResult::Type::STR, "connection_type", "Type of connection: \n" + Join(CONNECTION_TYPE_DOC, ",\n") + ".\n"
+ "Please note this output is unlikely to be stable in upcoming releases as we iterate to\n"
+ "best capture connection behaviors."},
{RPCResult::Type::NUM, "startingheight", "The starting height (block) of the peer"},
{RPCResult::Type::NUM, "banscore", "The ban score (DEPRECATED, returned only if config option -deprecatedrpc=banscore is passed)"},
{RPCResult::Type::NUM, "synced_headers", "The last header we have in common with this peer"},