Skip to content

Commit fa04cd6

Browse files
author
MarcoFalke
committed
doc: Properly document proxy_randomize_credentials as bool in getnetworkinfo
Also, fix indentation of some fields
1 parent fa9dec7 commit fa04cd6

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

src/rpc/net.cpp

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -448,11 +448,11 @@ static UniValue getnetworkinfo(const JSONRPCRequest& request)
448448
"Returns an object containing various state info regarding P2P networking.\n",
449449
{},
450450
RPCResult{
451-
"{\n"
451+
"{ (json object)\n"
452452
" \"version\": xxxxx, (numeric) the server version\n"
453-
" \"subversion\": \"/Satoshi:x.x.x/\", (string) the server subversion string\n"
453+
" \"subversion\" : \"str\", (string) the server subversion string\n"
454454
" \"protocolversion\": xxxxx, (numeric) the protocol version\n"
455-
" \"localservices\": \"xxxxxxxxxxxxxxxx\", (string) the services we offer to the network\n"
455+
" \"localservices\" : \"hex\", (string) the services we offer to the network\n"
456456
" \"localservicesnames\": [ (array) the services we offer to the network, in human-readable form\n"
457457
" \"SERVICE_NAME\", (string) the service name\n"
458458
" ...\n"
@@ -462,26 +462,26 @@ static UniValue getnetworkinfo(const JSONRPCRequest& request)
462462
" \"connections\": xxxxx, (numeric) the number of connections\n"
463463
" \"networkactive\": true|false, (bool) whether p2p networking is enabled\n"
464464
" \"networks\": [ (array) information per network\n"
465-
" {\n"
466-
" \"name\": \"xxx\", (string) network (ipv4, ipv6 or onion)\n"
465+
" { (json object)\n"
466+
" \"name\": \"str\", (string) network (ipv4, ipv6 or onion)\n"
467467
" \"limited\": true|false, (boolean) is the network limited using -onlynet?\n"
468468
" \"reachable\": true|false, (boolean) is the network reachable?\n"
469-
" \"proxy\": \"host:port\" (string) the proxy that is used for this network, or empty if none\n"
470-
" \"proxy_randomize_credentials\": true|false, (string) Whether randomized credentials are used\n"
471-
" }\n"
472-
" ,...\n"
469+
" \"proxy\" : \"str\" (string) (\"host:port\") the proxy that is used for this network, or empty if none\n"
470+
" \"proxy_randomize_credentials\" : true|false, (bool) Whether randomized credentials are used\n"
471+
" },\n"
472+
" ...\n"
473473
" ],\n"
474474
" \"relayfee\": x.xxxxxxxx, (numeric) minimum relay fee for transactions in " + CURRENCY_UNIT + "/kB\n"
475475
" \"incrementalfee\": x.xxxxxxxx, (numeric) minimum fee increment for mempool limiting or BIP 125 replacement in " + CURRENCY_UNIT + "/kB\n"
476476
" \"localaddresses\": [ (array) list of local addresses\n"
477-
" {\n"
478-
" \"address\": \"xxxx\", (string) network address\n"
477+
" { (json object)\n"
478+
" \"address\" : \"xxxx\", (string) network address\n"
479479
" \"port\": xxx, (numeric) network port\n"
480480
" \"score\": xxx (numeric) relative score\n"
481-
" }\n"
482-
" ,...\n"
483-
" ]\n"
484-
" \"warnings\": \"...\" (string) any network and blockchain warnings\n"
481+
" },\n"
482+
" ...\n"
483+
" ],\n"
484+
" \"warnings\" : \"str\", (string) any network and blockchain warnings\n"
485485
"}\n"
486486
},
487487
RPCExamples{

0 commit comments

Comments
 (0)