aboutsummaryrefslogtreecommitdiff
path: root/src/rpcblockchain.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/rpcblockchain.cpp')
-rw-r--r--src/rpcblockchain.cpp157
1 files changed, 141 insertions, 16 deletions
diff --git a/src/rpcblockchain.cpp b/src/rpcblockchain.cpp
index 483d8d2e8d..6f0b353e34 100644
--- a/src/rpcblockchain.cpp
+++ b/src/rpcblockchain.cpp
@@ -85,7 +85,13 @@ Value getblockcount(const Array& params, bool fHelp)
if (fHelp || params.size() != 0)
throw runtime_error(
"getblockcount\n"
- "Returns the number of blocks in the longest block chain.");
+ "\nReturns the number of blocks in the longest block chain.\n"
+ "\nResult:\n"
+ "n (numeric) The current block count\n"
+ "\nExamples:\n"
+ + HelpExampleCli("getblockcount", "")
+ + HelpExampleRpc("getblockcount", "")
+ );
return chainActive.Height();
}
@@ -95,7 +101,13 @@ Value getbestblockhash(const Array& params, bool fHelp)
if (fHelp || params.size() != 0)
throw runtime_error(
"getbestblockhash\n"
- "Returns the hash of the best (tip) block in the longest block chain.");
+ "\nReturns the hash of the best (tip) block in the longest block chain.\n"
+ "\nResult\n"
+ "\"hex\" (string) the block hash hex encoded\n"
+ "\nExamples\n"
+ + HelpExampleCli("getbestblockhash", "")
+ + HelpExampleRpc("getbestblockhash", "")
+ );
return chainActive.Tip()->GetBlockHash().GetHex();
}
@@ -105,7 +117,13 @@ Value getdifficulty(const Array& params, bool fHelp)
if (fHelp || params.size() != 0)
throw runtime_error(
"getdifficulty\n"
- "Returns the proof-of-work difficulty as a multiple of the minimum difficulty.");
+ "\nReturns the proof-of-work difficulty as a multiple of the minimum difficulty.\n"
+ "\nResult:\n"
+ "n.nnn (numeric) the proof-of-work difficulty as a multiple of the minimum difficulty.\n"
+ "\nExamples:\n"
+ + HelpExampleCli("getdifficulty", "")
+ + HelpExampleRpc("getdifficulty", "")
+ );
return GetDifficulty();
}
@@ -115,8 +133,16 @@ Value settxfee(const Array& params, bool fHelp)
{
if (fHelp || params.size() < 1 || params.size() > 1)
throw runtime_error(
- "settxfee <amount btc/kb>\n"
- "<amount> is a real and is rounded to the nearest 0.00000001 btc per kb");
+ "settxfee amount\n"
+ "\nSet the transaction fee. 'amount' is a real and is rounded to the nearest 0.00000001\n"
+ "\nArguments:\n"
+ "1. amount (numeric, required) The transaction fee in btc rounded to the nearest 0.00000001\n"
+ "\nResult\n"
+ "true|false (boolean) Returns true if successful\n"
+ "\nExamples:\n"
+ + HelpExampleCli("settxfee", "0.00001")
+ + HelpExampleRpc("settxfee", "0.00001")
+ );
// Amount
int64_t nAmount = 0;
@@ -132,7 +158,16 @@ Value getrawmempool(const Array& params, bool fHelp)
if (fHelp || params.size() != 0)
throw runtime_error(
"getrawmempool\n"
- "Returns all transaction ids in memory pool.");
+ "\nReturns all transaction ids in memory pool as a json array of string transaction ids.\n"
+ "\nResult:\n"
+ "[ (json array of string)\n"
+ " \"transactionid\" (string) The transaction id\n"
+ " ,...\n"
+ "]\n"
+ "\nExamples\n"
+ + HelpExampleCli("getrawmempool", "")
+ + HelpExampleRpc("getrawmempool", "")
+ );
vector<uint256> vtxid;
mempool.queryHashes(vtxid);
@@ -148,8 +183,16 @@ Value getblockhash(const Array& params, bool fHelp)
{
if (fHelp || params.size() != 1)
throw runtime_error(
- "getblockhash <index>\n"
- "Returns hash of block in best-block-chain at <index>.");
+ "getblockhash index\n"
+ "\nReturns hash of block in best-block-chain at index provided.\n"
+ "\nArguments:\n"
+ "1. index (numeric, required) The block index\n"
+ "\nResult:\n"
+ "\"hash\" (string) The block hash\n"
+ "\nExamples:\n"
+ + HelpExampleCli("getblockhash", "1000")
+ + HelpExampleRpc("getblockhash", "1000")
+ );
int nHeight = params[0].get_int();
if (nHeight < 0 || nHeight > chainActive.Height())
@@ -163,9 +206,36 @@ Value getblock(const Array& params, bool fHelp)
{
if (fHelp || params.size() < 1 || params.size() > 2)
throw runtime_error(
- "getblock <hash> [verbose=true]\n"
- "If verbose is false, returns a string that is serialized, hex-encoded data for block <hash>.\n"
- "If verbose is true, returns an Object with information about block <hash>."
+ "getblock \"hash\" ( verbose )\n"
+ "\nIf verbose is false, returns a string that is serialized, hex-encoded data for block 'hash'.\n"
+ "If verbose is true, returns an Object with information about block <hash>.\n"
+ "\nArguments:\n"
+ "1. \"hash\" (string, required) The block hash\n"
+ "2. verbose (boolean, optional, default=true) true for a json object, false for the hex encoded data\n"
+ "\nResult (for verbose = true):\n"
+ "{\n"
+ " \"hash\" : \"hash\", (string) the block hash (same as provided)\n"
+ " \"confirmations\" : n, (numeric) The number of confirmations\n"
+ " \"size\" : n, (numeric) The block size\n"
+ " \"height\" : n, (numeric) The block height or index\n"
+ " \"version\" : n, (numeric) The block version\n"
+ " \"merkleroot\" : \"xxxx\", (string) The merkle root\n"
+ " \"tx\" : [ (array of string) The transaction ids\n"
+ " \"transactionid\" (string) The transaction id\n"
+ " ,...\n"
+ " ],\n"
+ " \"time\" : ttt, (numeric) The block time in seconds since epoch (Jan 1 1970 GMT)\n"
+ " \"nonce\" : n, (numeric) The nonce\n"
+ " \"bits\" : \"1d00ffff\", (string) The bits\n"
+ " \"difficulty\" : x.xxx, (numeric) The difficulty\n"
+ " \"previousblockhash\" : \"hash\", (string) The hash of the previous block\n"
+ " \"nextblockhash\" : \"hash\" (string) The hash of the next block\n"
+ "}\n"
+ "\nResult (for verbose=false):\n"
+ "\"data\" (string) A string that is serialized, hex-encoded data for block 'hash'.\n"
+ "\nExamples:\n"
+ + HelpExampleCli("getblock", "\"00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09\"")
+ + HelpExampleRpc("getblock", "\"00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09\"")
);
std::string strHash = params[0].get_str();
@@ -198,7 +268,22 @@ Value gettxoutsetinfo(const Array& params, bool fHelp)
if (fHelp || params.size() != 0)
throw runtime_error(
"gettxoutsetinfo\n"
- "Returns statistics about the unspent transaction output set.");
+ "\nReturns statistics about the unspent transaction output set.\n"
+ "Note this call may take some time.\n"
+ "\nResult:\n"
+ "{\n"
+ " \"height\":n, (numeric) The current block height (index)\n"
+ " \"bestblock\": \"hex\", (string) the best block hash hex\n"
+ " \"transactions\": n, (numeric) The number of transactions\n"
+ " \"txouts\": n, (numeric) The number of output transactions\n"
+ " \"bytes_serialized\": n, (numeric) The serialized size\n"
+ " \"hash_serialized\": \"hash\", (string) The serialized hash\n"
+ " \"total_amount\": x.xxx (numeric) The total amount\n"
+ "}\n"
+ "\nExamples:\n"
+ + HelpExampleCli("gettxoutsetinfo", "")
+ + HelpExampleRpc("gettxoutsetinfo", "")
+ );
Object ret;
@@ -219,8 +304,39 @@ Value gettxout(const Array& params, bool fHelp)
{
if (fHelp || params.size() < 2 || params.size() > 3)
throw runtime_error(
- "gettxout <txid> <n> [includemempool=true]\n"
- "Returns details about an unspent transaction output.");
+ "gettxout \"txid\" n ( includemempool )\n"
+ "\nReturns details about an unspent transaction output.\n"
+ "\nArguments:\n"
+ "1. \"txid\" (string, required) The transaction id\n"
+ "2. n (numeric, required) vout value\n"
+ "3. includemempool (boolean, optional) Whether to included the mem pool\n"
+ "\nResult:\n"
+ "{\n"
+ " \"bestblock\" : \"hash\", (string) the block hash\n"
+ " \"confirmations\" : n, (numeric) The number of confirmations\n"
+ " \"value\" : x.xxx, (numeric) The transaction value in btc\n"
+ " \"scriptPubKey\" : { (json object)\n"
+ " \"asm\" : \"code\", (string) \n"
+ " \"hex\" : \"hex\", (string) \n"
+ " \"reqSigs\" : n, (numeric) Number of required signatures\n"
+ " \"type\" : \"pubkeyhash\", (string) The type, eg pubkeyhash\n"
+ " \"addresses\" : [ (array of string) array of bitcoin addresses\n"
+ " \"bitcoinaddress\" (string) bitcoin address\n"
+ " ,...\n"
+ " ]\n"
+ " },\n"
+ " \"version\" : n, (numeric) The version\n"
+ " \"coinbase\" : true|false (boolean) Coinbase or not\n"
+ "}\n"
+
+ "\nExamples:\n"
+ "\nGet unspent transactions\n"
+ + HelpExampleCli("listunspent", "") +
+ "\nView the details\n"
+ + HelpExampleCli("gettxout", "\"txid\" 1") +
+ "\nAs a json rpc call\n"
+ + HelpExampleRpc("gettxout", "\"txid\", 1")
+ );
Object ret;
@@ -266,8 +382,17 @@ Value verifychain(const Array& params, bool fHelp)
{
if (fHelp || params.size() > 2)
throw runtime_error(
- "verifychain [check level] [num blocks]\n"
- "Verifies blockchain database.");
+ "verifychain ( checklevel numblocks )\n"
+ "\nVerifies blockchain database.\n"
+ "\nArguments:\n"
+ "1. checklevel (numeric, optional, default=3) The level\n"
+ "2. numblocks (numeric, optional, 288) The number of blocks\n"
+ "\nResult:\n"
+ "true|false (boolean) Verified or not\n"
+ "\nExamples:\n"
+ + HelpExampleCli("verifychain", "")
+ + HelpExampleRpc("verifychain", "")
+ );
int nCheckLevel = GetArg("-checklevel", 3);
int nCheckDepth = GetArg("-checkblocks", 288);
generated by cgit v1.2.3 (git 2.26.2) at 2024-11-06 05:48:32 +0000