Skip to content

Commit

Permalink
Merge pull request KomodoPlatform#229 from alexenglish/master
Browse files Browse the repository at this point in the history
RPC help updates
  • Loading branch information
miketout authored Jun 20, 2023
2 parents 181ccf7 + e91c6e5 commit b9f7e30
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 10 deletions.
2 changes: 1 addition & 1 deletion src/rpc/mining.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ UniValue getgenerate(const UniValue& params, bool fHelp)
throw runtime_error(
"getgenerate\n"
"\nReturn if the server is set to mine and/or mint coins or not. The default is false.\n"
"It is set with the command line argument -gen (or komodo.conf setting gen) and -mint\n"
"It is set with the command line argument -gen and -mint (or conf file settings gen and mint)\n"
"It can also be set with the setgenerate call.\n"
"\nResult\n"
"{\n"
Expand Down
6 changes: 3 additions & 3 deletions src/rpc/misc.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -463,10 +463,10 @@ UniValue validateaddress(const UniValue& params, bool fHelp)
{
if (fHelp || params.size() != 1)
throw runtime_error(
"validateaddress \"komodoaddress\"\n"
"\nReturn information about the given Komodo address.\n"
"validateaddress \"address\"\n"
"\nReturn information about the given transparent address.\n"
"\nArguments:\n"
"1. \"komodoaddress\" (string, required) The Komodo address to validate\n"
"1. \"address\" (string, required) The transparent address to validate\n"
"\nResult:\n"
"{\n"
" \"isvalid\" : true|false, (boolean) If the address is valid or not. If not, this is the only property returned.\n"
Expand Down
2 changes: 1 addition & 1 deletion src/rpc/net.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -304,7 +304,7 @@ UniValue getaddednodeinfo(const UniValue& params, bool fHelp)
" \"connected\" : true|false, (boolean) If connected\n"
" \"addresses\" : [\n"
" {\n"
" \"address\" : \"192.168.0.201:8233\", (string) The Komodo server host and port\n"
" \"address\" : \"192.168.0.201:8233\", (string) The server host and port\n"
" \"connected\" : \"outbound\" (string) connection, inbound or outbound\n"
" }\n"
" ,...\n"
Expand Down
4 changes: 3 additions & 1 deletion src/rpc/pbaasrpc.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -11838,7 +11838,9 @@ UniValue registernamecommitment(const UniValue& params, bool fHelp)
"registernamecommitment \"name\" \"controladdress\" (\"referralidentity\") (\"parentnameorid\") (\"sourceoffunds\")\n"
"\nRegisters a name commitment, which is required as a source for the name to be used when registering an identity. The name commitment hides the name itself\n"
"while ensuring that the miner who mines in the registration cannot front-run the name unless they have also registered a name commitment for the same name or\n"
"are willing to forfeit the offer of payment for the chance that a commitment made now will allow them to register the name in the future.\n"
"are willing to forfeit the offer of payment for the chance that a commitment made now will allow them to register the name in the future.\n\n"

"Names must not have leading, trailing, or multiple consecutive spaces and must not include any of the following characters between parentheses (\\/:*?\"<>|@)\n"

"\nArguments\n"
"\"name\" (string, required) the unique name to commit to. creating a name commitment is not a registration, and if one is\n"
Expand Down
6 changes: 3 additions & 3 deletions src/rpc/rawtransaction.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -472,7 +472,7 @@ UniValue getrawtransaction(const UniValue& params, bool fHelp)
" \"reqSigs\" : n, (numeric) The required sigs\n"
" \"type\" : \"pubkeyhash\", (string) The type, eg 'pubkeyhash'\n"
" \"addresses\" : [ (json array of string)\n"
" \"komodoaddress\" (string) Komodo address\n"
" \"address\" (string) transparent address\n"
" ,...\n"
" ]\n"
" }\n"
Expand Down Expand Up @@ -937,7 +937,7 @@ UniValue decoderawtransaction(const UniValue& params, bool fHelp)
" \"reqSigs\" : n, (numeric) The required sigs\n"
" \"type\" : \"pubkeyhash\", (string) The type, eg 'pubkeyhash'\n"
" \"addresses\" : [ (json array of string)\n"
" \"RTZMZHDFSTFQst8XmX2dR4DaH87cEUs3gC\" (string) komodo address\n"
" \"RTZMZHDFSTFQst8XmX2dR4DaH87cEUs3gC\" (string) transparent address\n"
" ,...\n"
" ]\n"
" }\n"
Expand Down Expand Up @@ -1008,7 +1008,7 @@ UniValue decodescript(const UniValue& params, bool fHelp)
" \"type\":\"type\", (string) The output type\n"
" \"reqSigs\": n, (numeric) The required signatures\n"
" \"addresses\": [ (json array of string)\n"
" \"address\" (string) Komodo address\n"
" \"address\" (string) transparent address\n"
" ,...\n"
" ],\n"
" \"p2sh\",\"address\" (string) script address\n"
Expand Down
2 changes: 1 addition & 1 deletion src/rpc/server.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ UniValue stop(const UniValue& params, bool fHelp)
if (fHelp || params.size() > 1)
throw runtime_error(
"stop\n"
"\nStop Komodo server.");
"\nStop the server.");

#ifdef ENABLE_WALLET
GenerateBitcoins(false, NULL, 0);
Expand Down

0 comments on commit b9f7e30

Please sign in to comment.