diff --git a/src/rpc/abc.cpp b/src/rpc/abc.cpp --- a/src/rpc/abc.cpp +++ b/src/rpc/abc.cpp @@ -16,7 +16,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "getexcessiveblock", - "\nReturn the excessive block size.", + "Return the excessive block size.", {}, RPCResult{" excessiveBlockSize (integer) block size in bytes\n"}, RPCExamples{HelpExampleCli("getexcessiveblock", "") + @@ -33,7 +33,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "setexcessiveblock", - "\nSet the excessive block size. Excessive blocks will not be used in " + "Set the excessive block size. Excessive blocks will not be used in " "the active chain or relayed. This discourages the propagation of " "blocks that you consider excessively large.", { diff --git a/src/rpc/avalanche.cpp b/src/rpc/avalanche.cpp --- a/src/rpc/avalanche.cpp +++ b/src/rpc/avalanche.cpp @@ -17,7 +17,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "getavalanchekey", - "\nReturns the key used to sign avalanche messages.\n", + "Returns the key used to sign avalanche messages.\n", {}, RPCResults{}, RPCExamples{HelpExampleRpc("getavalanchekey", "")}, @@ -47,7 +47,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "addavalanchenode", - "\nAdd a node in the set of peers to poll for avalanche.\n", + "Add a node in the set of peers to poll for avalanche.\n", { {"nodeid", RPCArg::Type::NUM, RPCArg::Optional::NO, "Node to be added to avalanche."}, @@ -85,7 +85,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "buildavalancheproof", - "\nBuild a proof for avalanche's sybil resistance.\n", + "Build a proof for avalanche's sybil resistance.\n", { {"sequence", RPCArg::Type::NUM, RPCArg::Optional::NO, "The proof's sequence"}, diff --git a/src/rpc/blockchain.cpp b/src/rpc/blockchain.cpp --- a/src/rpc/blockchain.cpp +++ b/src/rpc/blockchain.cpp @@ -177,7 +177,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "getblockcount", - "\nReturns the number of blocks in the longest blockchain.\n", + "Returns the number of blocks in the longest blockchain.\n", {}, RPCResult{"n (numeric) The current block count\n"}, RPCExamples{HelpExampleCli("getblockcount", "") + @@ -193,7 +193,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "getbestblockhash", - "\nReturns the hash of the best (tip) block in the longest " + "Returns the hash of the best (tip) block in the longest " "blockchain.\n", {}, RPCResult{"\"hex\" (string) the block hash, hex-encoded\n"}, @@ -210,7 +210,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "getfinalizedblockhash", - "\nReturns the hash of the currently finalized block\n", + "Returns the hash of the currently finalized block\n", {}, RPCResult{"\"hex\" (string) the block hash hex-encoded\n"}, RPCExamples{HelpExampleCli("getfinalizedblockhash", "") + @@ -239,7 +239,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "waitfornewblock", - "\nWaits for a specific new block and returns useful info about it.\n" + "Waits for a specific new block and returns useful info about it.\n" "\nReturns the current block on timeout or exit.\n", { {"timeout", RPCArg::Type::NUM, /* default */ "0", @@ -288,7 +288,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "waitforblock", - "\nWaits for a specific new block and returns useful info about it.\n" + "Waits for a specific new block and returns useful info about it.\n" "\nReturns the current block on timeout or exit.\n", { {"blockhash", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, @@ -344,7 +344,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "waitforblockheight", - "\nWaits for (at least) block height and returns the height and " + "Waits for (at least) block height and returns the height and " "hash\nof the current tip.\n" "\nReturns the current block on timeout or exit.\n", { @@ -397,7 +397,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "syncwithvalidationinterfacequeue", - "\nWaits for the validation interface queue to catch up on everything " + "Waits for the validation interface queue to catch up on everything " "that was there when we entered this function.\n", {}, RPCResults{}, @@ -414,7 +414,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "getdifficulty", - "\nReturns the proof-of-work difficulty as a multiple of the minimum " + "Returns the proof-of-work difficulty as a multiple of the minimum " "difficulty.\n", {}, RPCResult{"n.nnn (numeric) the proof-of-work difficulty as a " @@ -557,7 +557,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "getrawmempool", - "\nReturns all transaction ids in memory pool as a json array of " + "Returns all transaction ids in memory pool as a json array of " "string transaction ids.\n" "\nHint: use getmempoolentry to fetch a specific transaction from the " "mempool.\n", @@ -593,7 +593,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "getmempoolancestors", - "\nIf txid is in the mempool, returns all in-mempool ancestors.\n", + "If txid is in the mempool, returns all in-mempool ancestors.\n", { {"txid", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The transaction id (must be in mempool)"}, @@ -664,7 +664,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "getmempooldescendants", - "\nIf txid is in the mempool, returns all in-mempool descendants.\n", + "If txid is in the mempool, returns all in-mempool descendants.\n", { {"txid", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The transaction id (must be in mempool)"}, @@ -734,7 +734,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "getmempoolentry", - "\nReturns mempool data for given transaction\n", + "Returns mempool data for given transaction\n", { {"txid", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The transaction id (must be in mempool)"}, @@ -766,7 +766,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "getblockhash", - "\nReturns hash of block in best-block-chain at height provided.\n", + "Returns hash of block in best-block-chain at height provided.\n", { {"height", RPCArg::Type::NUM, RPCArg::Optional::NO, "The height index"}, @@ -792,7 +792,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "getblockheader", - "\nIf verbose is false, returns a string that is serialized, " + "If verbose is false, returns a string that is serialized, " "hex-encoded data for blockheader 'hash'.\n" "If verbose is true, returns an Object with information about " "blockheader .\n", @@ -910,7 +910,7 @@ static UniValue getblock(const Config &config, const JSONRPCRequest &request) { RPCHelpMan{ "getblock", - "\nIf verbosity is 0 or false, returns a string that is serialized, " + "If verbosity is 0 or false, returns a string that is serialized, " "hex-encoded data for block 'hash'.\n" "If verbosity is 1 or true, returns an Object with information about " "block .\n" @@ -1089,7 +1089,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "gettxoutsetinfo", - "\nReturns statistics about the unspent transaction output set.\n" + "Returns statistics about the unspent transaction output set.\n" "Note this call may take some time.\n", {}, RPCResult{ @@ -1133,7 +1133,7 @@ UniValue gettxout(const Config &config, const JSONRPCRequest &request) { RPCHelpMan{ "gettxout", - "\nReturns details about an unspent transaction output.\n", + "Returns details about an unspent transaction output.\n", { {"txid", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The transaction id"}, @@ -1221,7 +1221,7 @@ int nCheckDepth = gArgs.GetArg("-checkblocks", DEFAULT_CHECKBLOCKS); RPCHelpMan{ "verifychain", - "\nVerifies blockchain database.\n", + "Verifies blockchain database.\n", { {"checklevel", RPCArg::Type::NUM, /* default */ strprintf("%d, range=0-4", nCheckLevel), @@ -1600,7 +1600,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "getmempoolinfo", - "\nReturns details on the active state of the TX memory pool.\n", + "Returns details on the active state of the TX memory pool.\n", {}, RPCResult{ "{\n" @@ -1631,7 +1631,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "preciousblock", - "\nTreats a block as if it were received before others with the same " + "Treats a block as if it were received before others with the same " "work.\n" "\nA later preciousblock call can override the effect of an earlier " "one.\n" @@ -1670,7 +1670,7 @@ UniValue finalizeblock(const Config &config, const JSONRPCRequest &request) { RPCHelpMan{ "finalizeblock", - "\nTreats a block as final. It cannot be reorged. Any chain\n" + "Treats a block as final. It cannot be reorged. Any chain\n" "that does not contain this block is invalid. Used on a less\n" "work chain, it can effectively PUT YOU OUT OF CONSENSUS.\n" "USE WITH CAUTION!\n", @@ -1714,7 +1714,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "invalidateblock", - "\nPermanently marks a block as invalid, as if it violated a consensus " + "Permanently marks a block as invalid, as if it violated a consensus " "rule.\n", { {"blockhash", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, @@ -1753,7 +1753,7 @@ UniValue parkblock(const Config &config, const JSONRPCRequest &request) { RPCHelpMan{ "parkblock", - "\nMarks a block as parked.\n", + "Marks a block as parked.\n", { {"blockhash", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "the hash of the block to park"}, @@ -1793,7 +1793,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "reconsiderblock", - "\nRemoves invalidity status of a block and its descendants, " + "Removes invalidity status of a block and its descendants, " "reconsider them for activation.\n" "This can be used to undo the effects of invalidateblock.\n", { @@ -1831,7 +1831,7 @@ UniValue unparkblock(const Config &config, const JSONRPCRequest &request) { RPCHelpMan{ "unparkblock", - "\nRemoves parked status of a block and its descendants, reconsider " + "Removes parked status of a block and its descendants, reconsider " "them for activation.\n" "This can be used to undo the effects of parkblock.\n", { @@ -1872,7 +1872,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "getchaintxstats", - "\nCompute statistics about the total number and rate of transactions " + "Compute statistics about the total number and rate of transactions " "in the chain.\n", { {"nblocks", RPCArg::Type::NUM, /* default */ "one month", @@ -1996,7 +1996,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "getblockstats", - "\nCompute per block statistics for a given window. All amounts are " + "Compute per block statistics for a given window. All amounts are " "in " + CURRENCY_UNIT + ".\n" @@ -2276,7 +2276,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "savemempool", - "\nDumps the mempool to disk. It will fail until the previous dump is " + "Dumps the mempool to disk. It will fail until the previous dump is " "fully loaded.\n", {}, RPCResults{}, @@ -2367,7 +2367,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "scantxoutset", - "\nEXPERIMENTAL warning: this call may be removed or changed in future " + "EXPERIMENTAL warning: this call may be removed or changed in future " "releases.\n" "\nScans the unspent transaction output set for entries that match " "certain output descriptors.\n" @@ -2544,7 +2544,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "getblockfilter", - "\nRetrieve a BIP 157 content filter for a particular block.\n", + "Retrieve a BIP 157 content filter for a particular block.\n", { {"blockhash", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The hash of the block"}, diff --git a/src/rpc/mining.cpp b/src/rpc/mining.cpp --- a/src/rpc/mining.cpp +++ b/src/rpc/mining.cpp @@ -88,7 +88,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "getnetworkhashps", - "\nReturns the estimated network hashes per second based on the last n " + "Returns the estimated network hashes per second based on the last n " "blocks.\n" "Pass in [blocks] to override # of blocks, -1 specifies since last " "difficulty change.\n" @@ -179,7 +179,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "generatetoaddress", - "\nMine blocks immediately to a specified address before the " + "Mine blocks immediately to a specified address before the " "RPC call returns)\n", { {"nblocks", RPCArg::Type::NUM, RPCArg::Optional::NO, @@ -221,7 +221,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "getmininginfo", - "\nReturns a json object containing mining-related " + "Returns a json object containing mining-related " "information.", {}, RPCResult{ @@ -338,7 +338,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "getblocktemplate", - "\nIf the request parameters include a 'mode' key, that is used to " + "If the request parameters include a 'mode' key, that is used to " "explicitly select between the default 'template' request or a " "'proposal'.\n" "It returns data needed to construct a block to work on.\n" @@ -709,7 +709,7 @@ // We allow 2 arguments for compliance with BIP22. Argument 2 is ignored. RPCHelpMan{ "submitblock", - "\nAttempts to submit new block to network.\n" + "Attempts to submit new block to network.\n" "See https://en.bitcoin.it/wiki/BIP_0022 for full specification.\n", { {"hexdata", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, @@ -776,7 +776,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "submitheader", - "\nDecode the given hexdata as a header and submit it as a candidate " + "Decode the given hexdata as a header and submit it as a candidate " "chain tip if valid." "\nThrows when the header is invalid.\n", { @@ -818,7 +818,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "estimatefee", - "\nEstimates the approximate fee per kilobyte needed for a " + "Estimates the approximate fee per kilobyte needed for a " "transaction\n", {}, RPCResult{"n (numeric) estimated fee-per-kilobyte\n"}, diff --git a/src/rpc/misc.cpp b/src/rpc/misc.cpp --- a/src/rpc/misc.cpp +++ b/src/rpc/misc.cpp @@ -32,7 +32,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "validateaddress", - "\nReturn information about the given bitcoin address.\n", + "Return information about the given bitcoin address.\n", { {"address", RPCArg::Type::STR, RPCArg::Optional::NO, "The bitcoin address to validate"}, @@ -82,7 +82,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "createmultisig", - "\nCreates a multi-signature address with n signature of m keys " + "Creates a multi-signature address with n signature of m keys " "required.\n" "It returns a json object with the address and redeemScript.\n", { @@ -161,7 +161,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "getdescriptorinfo", - {"\nAnalyses a descriptor.\n"}, + {"Analyses a descriptor.\n"}, { {"descriptor", RPCArg::Type::STR, RPCArg::Optional::NO, "The descriptor."}, @@ -208,7 +208,7 @@ UniValue deriveaddresses(const Config &config, const JSONRPCRequest &request) { RPCHelpMan{ "deriveaddresses", - {"\nDerives one or more addresses corresponding to an output " + {"Derives one or more addresses corresponding to an output " "descriptor.\n" "Examples of output descriptors are:\n" " pkh() P2PKH outputs for the given " @@ -307,7 +307,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "verifymessage", - "\nVerify a signed message\n", + "Verify a signed message\n", { {"address", RPCArg::Type::STR, RPCArg::Optional::NO, "The bitcoin address to use for the signature."}, @@ -378,7 +378,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "signmessagewithprivkey", - "\nSign a message with the private key of an address\n", + "Sign a message with the private key of an address\n", { {"privkey", RPCArg::Type::STR, RPCArg::Optional::NO, "The private key to sign the message with."}, @@ -424,7 +424,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "setmocktime", - "\nSet the local time to given timestamp (-regtest only)\n", + "Set the local time to given timestamp (-regtest only)\n", { {"timestamp", RPCArg::Type::NUM, RPCArg::Optional::NO, "Unix seconds-since-epoch timestamp\n" @@ -462,7 +462,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "mockscheduler", - "\nBump the scheduler into the future (-regtest only)\n", + "Bump the scheduler into the future (-regtest only)\n", { {"delta_time", RPCArg::Type::NUM, RPCArg::Optional::NO, "Number of seconds to forward the scheduler into the future."}, @@ -698,7 +698,7 @@ if (request.fHelp) { throw std::runtime_error(RPCHelpMan{ "echo|echojson ...", - "\nSimply echo back the input arguments. This command is for " + "Simply echo back the input arguments. This command is for " "testing.\n" "\nThe difference between echo and echojson is that echojson has " "argument conversion enabled in the client-side table in " diff --git a/src/rpc/net.cpp b/src/rpc/net.cpp --- a/src/rpc/net.cpp +++ b/src/rpc/net.cpp @@ -31,7 +31,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "getconnectioncount", - "\nReturns the number of connections to other nodes.\n", + "Returns the number of connections to other nodes.\n", {}, RPCResult{"n (numeric) The connection count\n"}, RPCExamples{HelpExampleCli("getconnectioncount", "") + @@ -51,7 +51,7 @@ static UniValue ping(const Config &config, const JSONRPCRequest &request) { RPCHelpMan{ "ping", - "\nRequests that a ping be sent to all other nodes, to measure ping " + "Requests that a ping be sent to all other nodes, to measure ping " "time.\n" "Results provided in getpeerinfo, pingtime and pingwait fields are " "decimal seconds.\n" @@ -79,7 +79,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "getpeerinfo", - "\nReturns data about each connected network node as a json array of " + "Returns data about each connected network node as a json array of " "objects.\n", {}, RPCResult{ @@ -267,7 +267,7 @@ strCommand != "remove")) { throw std::runtime_error(RPCHelpMan{ "addnode", - "\nAttempts to add or remove a node from the addnode list.\n" + "Attempts to add or remove a node from the addnode list.\n" "Or try a connection to a node once.\n" "Nodes added using addnode (or -connect) are protected from " "DoS disconnection and are not required to be\n" @@ -320,7 +320,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "disconnectnode", - "\nImmediately disconnects from the specified peer node.\n" + "Immediately disconnects from the specified peer node.\n" "\nStrictly one out of 'address' and 'nodeid' can be provided to " "identify the node.\n" "\nTo disconnect by nodeid, either set 'address' to the empty string, " @@ -378,7 +378,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "getaddednodeinfo", - "\nReturns information about the given added node, or all added nodes\n" + "Returns information about the given added node, or all added nodes\n" "(note that onetry addnodes are not listed here)\n", { {"node", RPCArg::Type::STR, /* default */ "all nodes", @@ -455,7 +455,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "getnettotals", - "\nReturns information about network traffic, including bytes in, " + "Returns information about network traffic, including bytes in, " "bytes out,\n" "and current time.\n", {}, @@ -641,7 +641,7 @@ static UniValue setban(const Config &config, const JSONRPCRequest &request) { const RPCHelpMan help{ "setban", - "\nAttempts to add or remove an IP/Subnet from the banned list.\n", + "Attempts to add or remove an IP/Subnet from the banned list.\n", { {"subnet", RPCArg::Type::STR, RPCArg::Optional::NO, "The IP/Subnet (see getpeerinfo for nodes IP) with an optional " @@ -744,7 +744,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "listbanned", - "\nList all manually banned IPs/Subnets.\n", + "List all manually banned IPs/Subnets.\n", {}, RPCResults{}, RPCExamples{HelpExampleCli("listbanned", "") + @@ -778,7 +778,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "clearbanned", - "\nClear all banned IPs.\n", + "Clear all banned IPs.\n", {}, RPCResults{}, RPCExamples{HelpExampleCli("clearbanned", "") + @@ -801,7 +801,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "setnetworkactive", - "\nDisable/enable all p2p network activity.\n", + "Disable/enable all p2p network activity.\n", { {"state", RPCArg::Type::BOOL, RPCArg::Optional::NO, "true to enable networking, false to disable"}, @@ -826,7 +826,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "getnodeaddresses", - "\nReturn known addresses which can potentially be used to find new " + "Return known addresses which can potentially be used to find new " "nodes in the network\n", { {"count", RPCArg::Type::NUM, /* default */ "1", diff --git a/src/rpc/rawtransaction.cpp b/src/rpc/rawtransaction.cpp --- a/src/rpc/rawtransaction.cpp +++ b/src/rpc/rawtransaction.cpp @@ -78,7 +78,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "getrawtransaction", - "\nBy default this function only works for mempool transactions. When " + "By default this function only works for mempool transactions. When " "called with a blockhash\n" "argument, getrawtransaction will return the transaction if the " "specified block is available and\n" @@ -253,7 +253,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "gettxoutproof", - "\nReturns a hex-encoded proof that \"txid\" was included in a block.\n" + "Returns a hex-encoded proof that \"txid\" was included in a block.\n" "\nNOTE: By default this function only works sometimes. " "This is when there is an\n" "unspent output in the utxo for this transaction. To make it always " @@ -376,7 +376,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "verifytxoutproof", - "\nVerifies that a proof points to a transaction in a block, returning " + "Verifies that a proof points to a transaction in a block, returning " "the transaction it commits to\n" "and throwing an RPC error if the block is not in our best chain\n", { @@ -426,7 +426,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "createrawtransaction", - "\nCreate a transaction spending the given inputs and creating new " + "Create a transaction spending the given inputs and creating new " "outputs.\n" "Outputs can be addresses or data.\n" "Returns hex-encoded raw transaction.\n" @@ -531,7 +531,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "decoderawtransaction", - "\nReturn a JSON object representing the serialized, hex-encoded " + "Return a JSON object representing the serialized, hex-encoded " "transaction.\n", { {"hexstring", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, @@ -602,7 +602,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "decodescript", - "\nDecode a hex-encoded script.\n", + "Decode a hex-encoded script.\n", { {"hexstring", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "the hex-encoded script"}, @@ -655,7 +655,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "combinerawtransaction", - "\nCombine multiple partially signed transactions into one " + "Combine multiple partially signed transactions into one " "transaction.\n" "The combined transaction may be another partially signed transaction " "or a \n" @@ -754,7 +754,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "signrawtransactionwithkey", - "\nSign inputs for raw transaction (serialized, hex-encoded).\n" + "Sign inputs for raw transaction (serialized, hex-encoded).\n" "The second argument is an array of base58-encoded private\n" "keys that will be the only keys used to sign the transaction.\n" "The third optional argument (may be null) is an array of previous " @@ -875,7 +875,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "sendrawtransaction", - "\nSubmits raw transaction (serialized, hex-encoded) to local node and " + "Submits raw transaction (serialized, hex-encoded) to local node and " "network.\n" "\nAlso see createrawtransaction and " "signrawtransactionwithkey calls.\n", @@ -949,7 +949,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "testmempoolaccept", - "\nReturns if raw transaction (serialized, hex-encoded) would be " + "Returns if raw transaction (serialized, hex-encoded) would be " "accepted by mempool.\n" "\nThis checks if the transaction violates the consensus or policy " "rules.\n" @@ -1087,7 +1087,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "decodepsbt", - "\nReturn a JSON object representing the serialized, base64-encoded " + "Return a JSON object representing the serialized, base64-encoded " "partially signed Bitcoin transaction.\n", { {"psbt", RPCArg::Type::STR, RPCArg::Optional::NO, @@ -1362,7 +1362,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "combinepsbt", - "\nCombine multiple partially signed Bitcoin transactions into one " + "Combine multiple partially signed Bitcoin transactions into one " "transaction.\n" "Implements the Combiner role.\n", { @@ -1488,7 +1488,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "createpsbt", - "\nCreates a transaction in the Partially Signed Transaction format.\n" + "Creates a transaction in the Partially Signed Transaction format.\n" "Implements the Creator role.\n", { { @@ -1595,7 +1595,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "converttopsbt", - "\nConverts a network serialized transaction to a PSBT. " + "Converts a network serialized transaction to a PSBT. " "This should be used only with createrawtransaction and " "fundrawtransaction\n" "createpsbt and walletcreatefundedpsbt should be used for new " @@ -1660,7 +1660,7 @@ UniValue utxoupdatepsbt(const Config &config, const JSONRPCRequest &request) { RPCHelpMan{ "utxoupdatepsbt", - "\nUpdates all inputs and outputs in a PSBT with data from output " + "Updates all inputs and outputs in a PSBT with data from output " "descriptors, the UTXO set or the mempool.\n", { {"psbt", RPCArg::Type::STR, RPCArg::Optional::NO, @@ -1760,7 +1760,7 @@ UniValue joinpsbts(const Config &config, const JSONRPCRequest &request) { RPCHelpMan{ "joinpsbts", - "\nJoins multiple distinct PSBTs with different inputs and outputs " + "Joins multiple distinct PSBTs with different inputs and outputs " "into one PSBT with inputs and outputs from all of the PSBTs\n" "No input in any of the PSBTs can be in more than one of the PSBTs.\n", {{"txs", @@ -1862,7 +1862,7 @@ UniValue analyzepsbt(const Config &config, const JSONRPCRequest &request) { RPCHelpMan{ "analyzepsbt", - "\nAnalyzes and provides information about the current status of a " + "Analyzes and provides information about the current status of a " "PSBT and its inputs\n", {{"psbt", RPCArg::Type::STR, RPCArg::Optional::NO, "A base64 string of a PSBT"}}, diff --git a/src/rpc/server.cpp b/src/rpc/server.cpp --- a/src/rpc/server.cpp +++ b/src/rpc/server.cpp @@ -174,7 +174,7 @@ if (jsonRequest.fHelp || jsonRequest.params.size() > 1) { throw std::runtime_error(RPCHelpMan{ "help", - "\nList all commands, or get help for a specified command.\n", + "List all commands, or get help for a specified command.\n", { {"command", RPCArg::Type::STR, /* default */ "all commands", "The command to get help on"}, @@ -201,7 +201,7 @@ if (jsonRequest.fHelp || jsonRequest.params.size() > 1) { throw std::runtime_error(RPCHelpMan{ "stop", - "\nStop Bitcoin server.", + "Stop Bitcoin server.", {}, RPCResults{}, RPCExamples{""}, @@ -222,7 +222,7 @@ static UniValue uptime(const Config &config, const JSONRPCRequest &request) { RPCHelpMan{ "uptime", - "\nReturns the total uptime of the server.\n", + "Returns the total uptime of the server.\n", {}, RPCResult{"ttt (numeric) The number of seconds that the server " "has been running\n"}, @@ -238,7 +238,7 @@ const JSONRPCRequest &request) { RPCHelpMan{ "getrpcinfo", - "\nReturns details of the RPC server.\n", + "Returns details of the RPC server.\n", {}, RPCResults{}, RPCExamples{""}, diff --git a/src/rpc/util.cpp b/src/rpc/util.cpp --- a/src/rpc/util.cpp +++ b/src/rpc/util.cpp @@ -505,7 +505,7 @@ if (was_optional) { ret += " )"; } - ret += "\n"; + ret += "\n\n"; // Description ret += m_description; diff --git a/src/wallet/rpcdump.cpp b/src/wallet/rpcdump.cpp --- a/src/wallet/rpcdump.cpp +++ b/src/wallet/rpcdump.cpp @@ -112,7 +112,7 @@ RPCHelpMan{ "importprivkey", - "\nAdds a private key (as returned by dumpprivkey) to your wallet. " + "Adds a private key (as returned by dumpprivkey) to your wallet. " "Requires a new wallet backup.\n" "Hint: use importmulti to import more than one private key.\n" "\nNote: This call can take minutes to complete if rescan is true, " @@ -230,7 +230,7 @@ RPCHelpMan{ "abortrescan", - "\nStops current wallet rescan triggered by an RPC call, e.g. by an " + "Stops current wallet rescan triggered by an RPC call, e.g. by an " "importprivkey call.\n", {}, RPCResults{}, @@ -259,7 +259,7 @@ RPCHelpMan{ "importaddress", - "\nAdds an address or script (in hex) that can be watched as if it " + "Adds an address or script (in hex) that can be watched as if it " "were in your wallet but cannot be used to spend. Requires a new " "wallet backup.\n" "\nNote: This call can take minutes to complete if rescan is true, " @@ -389,7 +389,7 @@ RPCHelpMan{ "importprunedfunds", - "\nImports funds without rescan. Corresponding address or script must " + "Imports funds without rescan. Corresponding address or script must " "previously be included in wallet. Aimed towards pruned wallets. The " "end-user is responsible to import additional transactions that " "subsequently spend the imported outputs or rescan after the point in " @@ -471,7 +471,7 @@ RPCHelpMan{ "removeprunedfunds", - "\nDeletes the specified transaction from the wallet. Meant for use " + "Deletes the specified transaction from the wallet. Meant for use " "with pruned wallets and as a companion to importprunedfunds. This " "will affect wallet balances.\n", { @@ -519,7 +519,7 @@ RPCHelpMan{ "importpubkey", - "\nAdds a public key (in hex) that can be watched as if it were in " + "Adds a public key (in hex) that can be watched as if it were in " "your wallet but cannot be used to spend. Requires a new wallet " "backup.\n" "\nNote: This call can take minutes to complete if rescan is true, " @@ -625,7 +625,7 @@ RPCHelpMan{ "importwallet", - "\nImports keys from a wallet dump file (see dumpwallet). Requires a " + "Imports keys from a wallet dump file (see dumpwallet). Requires a " "new wallet backup to include imported keys.\n", { {"filename", RPCArg::Type::STR, RPCArg::Optional::NO, @@ -828,7 +828,7 @@ RPCHelpMan{ "dumpprivkey", - "\nReveals the private key corresponding to 'address'.\n" + "Reveals the private key corresponding to 'address'.\n" "Then the importprivkey can be used with this output\n", { {"address", RPCArg::Type::STR, RPCArg::Optional::NO, @@ -876,7 +876,7 @@ RPCHelpMan{ "dumpwallet", - "\nDumps all wallet keys in a human-readable format to a server-side " + "Dumps all wallet keys in a human-readable format to a server-side " "file. This does not allow overwriting existing files.\n" "Imported scripts are included in the dumpsfile, but corresponding " "addresses may not be added automatically by importwallet.\n" @@ -1536,7 +1536,7 @@ RPCHelpMan{ "importmulti", - "\nImport addresses/scripts (with private or public keys, redeem " + "Import addresses/scripts (with private or public keys, redeem " "script (P2SH)), rescanning all addresses in one-shot-only (rescan can " "be disabled via options). Requires a new wallet backup.\n", { diff --git a/src/wallet/rpcwallet.cpp b/src/wallet/rpcwallet.cpp --- a/src/wallet/rpcwallet.cpp +++ b/src/wallet/rpcwallet.cpp @@ -196,7 +196,7 @@ RPCHelpMan{ "getnewaddress", - "\nReturns a new Bitcoin address for receiving payments.\n" + "Returns a new Bitcoin address for receiving payments.\n" "If 'label' is specified, it is added to the address book \n" "so payments received with the address will be associated with " "'label'.\n", @@ -259,7 +259,7 @@ RPCHelpMan{ "getrawchangeaddress", - "\nReturns a new Bitcoin address, for receiving change.\n" + "Returns a new Bitcoin address, for receiving change.\n" "This is for use with raw transactions, NOT normal use.\n", {}, RPCResult{"\"address\" (string) The address\n"}, @@ -305,7 +305,7 @@ RPCHelpMan{ "setlabel", - "\nSets the label associated with the given address.\n", + "Sets the label associated with the given address.\n", { {"address", RPCArg::Type::STR, RPCArg::Optional::NO, "The bitcoin address to be associated with a label."}, @@ -405,7 +405,7 @@ RPCHelpMan{ "sendtoaddress", - "\nSend an amount to a given address.\n" + + "Send an amount to a given address.\n" + HelpRequiringPassphrase(pwallet) + "\n", { {"address", RPCArg::Type::STR, RPCArg::Optional::NO, @@ -508,7 +508,7 @@ RPCHelpMan{ "listaddressgroupings", - "\nLists groups of addresses which have had their common ownership\n" + "Lists groups of addresses which have had their common ownership\n" "made public by common use as inputs or as the resulting change\n" "in past transactions\n", {}, @@ -572,7 +572,7 @@ RPCHelpMan{ "signmessage", - "\nSign a message with the private key of an address" + + "Sign a message with the private key of an address" + HelpRequiringPassphrase(pwallet) + "\n", { {"address", RPCArg::Type::STR, RPCArg::Optional::NO, @@ -650,7 +650,7 @@ RPCHelpMan{ "getreceivedbyaddress", - "\nReturns the total amount received by the given address in " + "Returns the total amount received by the given address in " "transactions with at least minconf confirmations.\n", { {"address", RPCArg::Type::STR, RPCArg::Optional::NO, @@ -737,7 +737,7 @@ RPCHelpMan{ "getreceivedbylabel", - "\nReturns the total amount received by addresses with