RPC help doc updates

who-biz · Jun 16, 2023 · e91c6e5 · e91c6e5
1 parent 7639548
commit e91c6e5
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 10 deletions.
diff --git a/src/rpc/mining.cpp b/src/rpc/mining.cpp
@@ -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"

diff --git a/src/rpc/misc.cpp b/src/rpc/misc.cpp
@@ -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"

diff --git a/src/rpc/net.cpp b/src/rpc/net.cpp
@@ -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"

diff --git a/src/rpc/pbaasrpc.cpp b/src/rpc/pbaasrpc.cpp
@@ -11806,7 +11806,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"

diff --git a/src/rpc/rawtransaction.cpp b/src/rpc/rawtransaction.cpp
@@ -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"
@@ -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"
@@ -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"

diff --git a/src/rpc/server.cpp b/src/rpc/server.cpp
@@ -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);