Merge #337: [backport] 'Use a verbosity instead of two verbose parame…

…ters'

865a47e [backport] Use a verbosity instead of two verbose parameters (Gregory Sanders)

src/rpc/blockchain.cpp

@@ -674,14 +674,17 @@ UniValue getblockheader(const JSONRPCRequest& request)
 UniValue getblock(const JSONRPCRequest& request)
 {
  if (request.fHelp || request.params.size() < 1 || request.params.size() > 2)
- throw runtime_error(
- "getblock \"blockhash\" ( 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"
+ throw std::runtime_error(
+ "getblock \"blockhash\" ( verbosity ) \n"
+ "\nIf verbosity is 0, returns a string that is serialized, hex-encoded data for block 'hash'.\n"
+ "If verbosity is 1, returns an Object with information about block <hash>.\n"
+ "If verbosity is 2, returns an Object with information about block <hash> and information about each transaction. \n"
  "\nArguments:\n"
  "1. \"blockhash\" (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"
+ "2. verbosity (numeric, optional, default=1) 0 for hex encoded data, 1 for a json object, and 2 for json object with transaction data\n"
+ "\nResult (for verbosity = 0):\n"
+ "\"data\" (string) A string that is serialized, hex-encoded data for block 'hash'.\n"
+ "\nResult (for verbosity = 1):\n"
  "{\n"
  " \"hash\" : \"hash\", (string) the block hash (same as provided)\n"
  " \"confirmations\" : n, (numeric) The number of confirmations, or -1 if the block is not on the main chain\n"
@@ -705,8 +708,14 @@ UniValue getblock(const JSONRPCRequest& request)
  " \"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"
+ "\nResult (for verbosity = 2):\n"
+ "{\n"
+ " ..., Same output as verbosity = 1.\n"
+ " \"tx\" : [ (array of Objects) The transactions in the format of the getrawtransaction RPC. Different from verbosity = 1 \"tx\" result.\n"
+ " ,...\n"
+ " ],\n"
+ " ,... Same output as verbosity = 1.\n"
+ "}\n"
  "\nExamples:\n"
  + HelpExampleCli("getblock", "\"00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09\"")
  + HelpExampleRpc("getblock", "\"00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09\"")
@@ -717,31 +726,40 @@ UniValue getblock(const JSONRPCRequest& request)
  std::string strHash = request.params[0].get_str();
  uint256 hash(uint256S(strHash));
 
- bool fVerbose = true;
- if (request.params.size() > 1)
- fVerbose = request.params[1].get_bool();
+ int verbosity = 1;
+ if (!request.params[1].isNull()) {
+ if(request.params[1].isNum())
+ verbosity = request.params[1].get_int();
+ else
+ verbosity = request.params[1].get_bool() ? 1 : 0;
+ }
 
- if (mapBlockIndex.count(hash) == 0)
+ if (mapBlockIndex.count(hash) == 0) {
  throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Block not found");
+ }
 
  CBlock block;
  CBlockIndex* pblockindex = mapBlockIndex[hash];
-
  if (fHavePruned && !(pblockindex->nStatus & BLOCK_HAVE_DATA) && pblockindex->nTx > 0)
- throw JSONRPCError(RPC_INTERNAL_ERROR, "Block not available (pruned data)");
+ throw JSONRPCError(RPC_MISC_ERROR, "Block not available (pruned data)");
 
- if(!ReadBlockFromDisk(block, pblockindex, Params().GetConsensus()))
- throw JSONRPCError(RPC_INTERNAL_ERROR, "Can't read block from disk");
+ if (!ReadBlockFromDisk(block, pblockindex, Params().GetConsensus()))
+ // Block not found on disk. This could be because we have the block
+ // header in our index but don't have the block (for example if a
+ // non-whitelisted node sends us an unrequested long chain of valid
+ // blocks, we add the headers to our index, but don't accept the
+ // block).
+ throw JSONRPCError(RPC_MISC_ERROR, "Block not found on disk");
 
- if (!fVerbose)
+ if (verbosity <= 0)
  {
  CDataStream ssBlock(SER_NETWORK, PROTOCOL_VERSION | RPCSerializationFlags());
  ssBlock << block;
  std::string strHex = HexStr(ssBlock.begin(), ssBlock.end());
  return strHex;
  }
 
- return blockToJSON(block, pblockindex);
+ return blockToJSON(block, pblockindex, verbosity >= 2);
 }
 
 struct CCoinsStats
@@ -1413,7 +1431,7 @@ static const CRPCCommand commands[] =
  { "blockchain", "getblockchaininfo", &getblockchaininfo, true, {} },
  { "blockchain", "getbestblockhash", &getbestblockhash, true, {} },
  { "blockchain", "getblockcount", &getblockcount, true, {} },
- { "blockchain", "getblock", &getblock, true, {"blockhash","verbose"} },
+ { "blockchain", "getblock", &getblock, true, {"blockhash","verbosity"} },
  { "blockchain", "getblockhash", &getblockhash, true, {"height"} },
  { "blockchain", "getblockheader", &getblockheader, true, {"blockhash","verbose"} },
  { "blockchain", "getchaintips", &getchaintips, true, {} },

src/rpc/client.cpp

@@ -82,7 +82,7 @@ static const CRPCConvertParam vRPCConvertParams[] =
  { "listunspent", 1, "maxconf" },
  { "listunspent", 2, "addresses" },
  { "listunspent", 3, "include_unsafe" },
- { "getblock", 1, "verbose" },
+ { "getblock", 1, "verbosity" },
  { "getblockheader", 1, "verbose" },
  { "gettransaction", 1, "include_watchonly" },
  { "getrawtransaction", 1, "verbose" },