From 3f3705c4768893d03ea0bf3768af4a96628e84f4 Mon Sep 17 00:00:00 2001 From: thephez Date: Tue, 5 Dec 2017 17:17:45 -0500 Subject: [PATCH] [Trivial] Typo/doc updates and RPC help formatting (#1758) * Protocol Doc - correct type of DSQ nTime and fReady fields * Basic typo correction * RPC help typos - Change port in DisconnectNode example from Bitcoin port -> Dash port - Correct order of chainwork in getblockheader/getblockheaders help to match actual output - Add missing fields to getmininginfo/getblocktemplate help output * Remove duplicate generate field in getmininginfo output * Fix generate field type info / description in getmininginfo output --- dash-docs/protocol-documentation.md | 6 +++--- src/governance-object.h | 2 +- src/rpc/blockchain.cpp | 4 ++-- src/rpc/masternode.cpp | 2 +- src/rpc/mining.cpp | 4 +++- src/rpc/net.cpp | 4 ++-- 6 files changed, 12 insertions(+), 10 deletions(-) diff --git a/dash-docs/protocol-documentation.md b/dash-docs/protocol-documentation.md index aa5d0f6e28..ba3cb32dc1 100644 --- a/dash-docs/protocol-documentation.md +++ b/dash-docs/protocol-documentation.md @@ -148,9 +148,9 @@ Asks users to sign final mixing tx message. | ---------- | ----------- | --------- | -------- | | 4 | nDenom | int | Which denomination is allowed in this mixing session | 41 | vin | [CTxIn](#ctxin) | unspend output from masternode which is hosting this session -| 4 | nTime | int | the time this DSQ was created -| 4 | fReady | int | if the mixing pool is ready to be executed -| 71-73 | vchSig | char[] | Signature of this message by masternode (verifiable via pubKeyMasternode) +| 8 | nTime | int64_t | the time this DSQ was created +| 1 | fReady | bool | if the mixing pool is ready to be executed +| 66 | vchSig | char[] | Signature of this message by masternode (verifiable via pubKeyMasternode) ### DSACCEPT - "dsa" diff --git a/src/governance-object.h b/src/governance-object.h index 073911eff8..cbec7c24b6 100644 --- a/src/governance-object.h +++ b/src/governance-object.h @@ -162,7 +162,7 @@ private: /// true == minimum network support has been reached for this object to be funded (doesn't mean it will for sure though) bool fCachedFunding; - /// true == minimum network has been reached flagging this object as a valid and understood goverance object (e.g, the serialized data is correct format, etc) + /// true == minimum network has been reached flagging this object as a valid and understood governance object (e.g, the serialized data is correct format, etc) bool fCachedValid; /// true == minimum network support has been reached saying this object should be deleted from the system entirely diff --git a/src/rpc/blockchain.cpp b/src/rpc/blockchain.cpp index 50e05124a1..52f4434ad0 100644 --- a/src/rpc/blockchain.cpp +++ b/src/rpc/blockchain.cpp @@ -359,9 +359,9 @@ UniValue getblockheader(const UniValue& params, bool fHelp) " \"nonce\" : n, (numeric) The nonce\n" " \"bits\" : \"1d00ffff\", (string) The bits\n" " \"difficulty\" : x.xxx, (numeric) The difficulty\n" + " \"chainwork\" : \"0000...1f3\" (string) Expected number of hashes required to produce the current chain (in hex)\n" " \"previousblockhash\" : \"hash\", (string) The hash of the previous block\n" " \"nextblockhash\" : \"hash\", (string) The hash of the next block\n" - " \"chainwork\" : \"0000...1f3\" (string) Expected number of hashes required to produce the current chain (in hex)\n" "}\n" "\nResult (for verbose=false):\n" "\"data\" (string) A string that is serialized, hex-encoded data for block 'hash'.\n" @@ -419,9 +419,9 @@ UniValue getblockheaders(const UniValue& params, bool fHelp) " \"nonce\" : n, (numeric) The nonce\n" " \"bits\" : \"1d00ffff\", (string) The bits\n" " \"difficulty\" : x.xxx, (numeric) The difficulty\n" + " \"chainwork\" : \"0000...1f3\" (string) Expected number of hashes required to produce the current chain (in hex)\n" " \"previousblockhash\" : \"hash\", (string) The hash of the previous block\n" " \"nextblockhash\" : \"hash\", (string) The hash of the next block\n" - " \"chainwork\" : \"0000...1f3\" (string) Expected number of hashes required to produce the current chain (in hex)\n" "}, {\n" " ...\n" " },\n" diff --git a/src/rpc/masternode.cpp b/src/rpc/masternode.cpp index e5f84a728e..af1140e2ee 100644 --- a/src/rpc/masternode.cpp +++ b/src/rpc/masternode.cpp @@ -474,7 +474,7 @@ UniValue masternodelist(const UniValue& params, bool fHelp) " lastseen - Print timestamp of when a masternode was last seen on the network\n" " payee - Print Dash address associated with a masternode (can be additionally filtered,\n" " partial match)\n" - " protocol - Print protocol of a masternode (can be additionally filtered, exact match))\n" + " protocol - Print protocol of a masternode (can be additionally filtered, exact match)\n" " pubkey - Print the masternode (not collateral) public key\n" " rank - Print rank of a masternode based on current block\n" " status - Print masternode status: PRE_ENABLED / ENABLED / EXPIRED / WATCHDOG_EXPIRED / NEW_START_REQUIRED /\n" diff --git a/src/rpc/mining.cpp b/src/rpc/mining.cpp index 1a274b3e6a..b0c46ac577 100644 --- a/src/rpc/mining.cpp +++ b/src/rpc/mining.cpp @@ -246,11 +246,12 @@ UniValue getmininginfo(const UniValue& params, bool fHelp) " \"currentblocktx\": nnn, (numeric) The last block transaction\n" " \"difficulty\": xxx.xxxxx (numeric) The current difficulty\n" " \"errors\": \"...\" (string) Current errors\n" - " \"generate\": true|false (boolean) If the generation is on or off (see getgenerate or setgenerate calls)\n" " \"genproclimit\": n (numeric) The processor limit for generation. -1 if no generation. (see getgenerate or setgenerate calls)\n" + " \"networkhashps\": n (numeric) An estimate of the number of hashes per second the network is generating to maintain the current difficulty\n" " \"pooledtx\": n (numeric) The size of the mem pool\n" " \"testnet\": true|false (boolean) If using testnet or not\n" " \"chain\": \"xxxx\", (string) current network name as defined in BIP70 (main, test, regtest)\n" + " \"generate\": true|false (boolean) If the generation is on or off (see getgenerate or setgenerate calls)\n" "}\n" "\nExamples:\n" + HelpExampleCli("getmininginfo", "") @@ -359,6 +360,7 @@ UniValue getblocktemplate(const UniValue& params, bool fHelp) "\nResult:\n" "{\n" + " \"capabilities\" : [ \"capability\", ... ], (array of strings) specific client side supported features\n" " \"version\" : n, (numeric) The block version\n" " \"rules\" : [ \"rulename\", ... ], (array of strings) specific block rules that are to be enforced\n" " \"vbavailable\" : { (json object) set of pending, supported versionbit (BIP 9) softfork deployments\n" diff --git a/src/rpc/net.cpp b/src/rpc/net.cpp index 258ef29312..af8f03b8c9 100644 --- a/src/rpc/net.cpp +++ b/src/rpc/net.cpp @@ -240,8 +240,8 @@ UniValue disconnectnode(const UniValue& params, bool fHelp) "\nArguments:\n" "1. \"node\" (string, required) The node (see getpeerinfo for nodes)\n" "\nExamples:\n" - + HelpExampleCli("disconnectnode", "\"192.168.0.6:8333\"") - + HelpExampleRpc("disconnectnode", "\"192.168.0.6:8333\"") + + HelpExampleCli("disconnectnode", "\"192.168.0.6:9999\"") + + HelpExampleRpc("disconnectnode", "\"192.168.0.6:9999\"") ); if(!g_connman)