src/rest.cpp

   1 // Copyright (c) 2009-2010 Satoshi Nakamoto
   2 // Copyright (c) 2009-2016 The Bitcoin Core developers
   3 // Distributed under the MIT software license, see the accompanying
   4 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
   5
   6 #include "chain.h"
   7 #include "chainparams.h"
   8 #include "core_io.h"
   9 #include "primitives/block.h"
  10 #include "primitives/transaction.h"
  11 #include "validation.h"
  12 #include "httpserver.h"
  13 #include "rpc/blockchain.h"
  14 #include "rpc/server.h"
  15 #include "streams.h"
  16 #include "sync.h"
  17 #include "txmempool.h"
  18 #include "utilstrencodings.h"
  19 #include "version.h"
  20
  21 #include <boost/algorithm/string.hpp>
  22
  23 #include <univalue.h>
  24
  25 static const size_t MAX_GETUTXOS_OUTPOINTS = 15; //allow a max of 15 outpoints to be queried at once
  26
  27 enum RetFormat {
  28     RF_UNDEF,
  29     RF_BINARY,
  30     RF_HEX,
  31     RF_JSON,
  32 };
  33
  34 static const struct {
  35     enum RetFormat rf;
  36     const char* name;
  37 } rf_names[] = {
  38       {RF_UNDEF, ""},
  39       {RF_BINARY, "bin"},
  40       {RF_HEX, "hex"},
  41       {RF_JSON, "json"},
  42 };
  43
  44 struct CCoin {
  45     uint32_t nHeight;
  46     CTxOut out;
  47
  48     ADD_SERIALIZE_METHODS;
  49
  50     CCoin() : nHeight(0) {}
  51     explicit CCoin(Coin&& in) : nHeight(in.nHeight), out(std::move(in.out)) {}
  52
  53     template <typename Stream, typename Operation>
  54     inline void SerializationOp(Stream& s, Operation ser_action)
  55     {
  56         uint32_t nTxVerDummy = 0;
  57         READWRITE(nTxVerDummy);
  58         READWRITE(nHeight);
  59         READWRITE(out);
  60     }
  61 };
  62
  63 static bool RESTERR(HTTPRequest* req, enum HTTPStatusCode status, std::string message)
  64 {
  65     req->WriteHeader("Content-Type", "text/plain");
  66     req->WriteReply(status, message + "\r\n");
  67     return false;
  68 }
  69
  70 static enum RetFormat ParseDataFormat(std::string& param, const std::string& strReq)
  71 {
  72     const std::string::size_type pos = strReq.rfind('.');
  73     if (pos == std::string::npos)
  74     {
  75         param = strReq;
  76         return rf_names[0].rf;
  77     }
  78
  79     param = strReq.substr(0, pos);
  80     const std::string suff(strReq, pos + 1);
  81
  82     for (unsigned int i = 0; i < ARRAYLEN(rf_names); i++)
  83         if (suff == rf_names[i].name)
  84             return rf_names[i].rf;
  85
  86     /* If no suffix is found, return original string.  */
  87     param = strReq;
  88     return rf_names[0].rf;
  89 }
  90
  91 static std::string AvailableDataFormatsString()
  92 {
  93     std::string formats = "";
  94     for (unsigned int i = 0; i < ARRAYLEN(rf_names); i++)
  95         if (strlen(rf_names[i].name) > 0) {
  96             formats.append(".");
  97             formats.append(rf_names[i].name);
  98             formats.append(", ");
  99         }
 100
 101     if (formats.length() > 0)
 102         return formats.substr(0, formats.length() - 2);
 103
 104     return formats;
 105 }
 106
 107 static bool ParseHashStr(const std::string& strReq, uint256& v)
 108 {
 109     if (!IsHex(strReq) || (strReq.size() != 64))
 110         return false;
 111
 112     v.SetHex(strReq);
 113     return true;
 114 }
 115
 116 static bool CheckWarmup(HTTPRequest* req)
 117 {
 118     std::string statusmessage;
 119     if (RPCIsInWarmup(&statusmessage))
 120          return RESTERR(req, HTTP_SERVICE_UNAVAILABLE, "Service temporarily unavailable: " + statusmessage);
 121     return true;
 122 }
 123
 124 static bool rest_headers(HTTPRequest* req,
 125                          const std::string& strURIPart)
 126 {
 127     if (!CheckWarmup(req))
 128         return false;
 129     std::string param;
 130     const RetFormat rf = ParseDataFormat(param, strURIPart);
 131     std::vector<std::string> path;
 132     boost::split(path, param, boost::is_any_of("/"));
 133
 134     if (path.size() != 2)
 135         return RESTERR(req, HTTP_BAD_REQUEST, "No header count specified. Use /rest/headers/<count>/<hash>.<ext>.");
 136
 137     long count = strtol(path[0].c_str(), nullptr, 10);
 138     if (count < 1 || count > 2000)
 139         return RESTERR(req, HTTP_BAD_REQUEST, "Header count out of range: " + path[0]);
 140
 141     std::string hashStr = path[1];
 142     uint256 hash;
 143     if (!ParseHashStr(hashStr, hash))
 144         return RESTERR(req, HTTP_BAD_REQUEST, "Invalid hash: " + hashStr);
 145
 146     std::vector<const CBlockIndex *> headers;
 147     headers.reserve(count);
 148     {
 149         LOCK(cs_main);
 150         BlockMap::const_iterator it = mapBlockIndex.find(hash);
 151         const CBlockIndex *pindex = (it != mapBlockIndex.end()) ? it->second : nullptr;
 152         while (pindex != nullptr && chainActive.Contains(pindex)) {
 153             headers.push_back(pindex);
 154             if (headers.size() == (unsigned long)count)
 155                 break;
 156             pindex = chainActive.Next(pindex);
 157         }
 158     }
 159
 160     CDataStream ssHeader(SER_NETWORK, PROTOCOL_VERSION);
 161     for (const CBlockIndex *pindex : headers) {
 162         ssHeader << pindex->GetBlockHeader();
 163     }
 164
 165     switch (rf) {
 166     case RF_BINARY: {
 167         std::string binaryHeader = ssHeader.str();
 168         req->WriteHeader("Content-Type", "application/octet-stream");
 169         req->WriteReply(HTTP_OK, binaryHeader);
 170         return true;
 171     }
 172
 173     case RF_HEX: {
 174         std::string strHex = HexStr(ssHeader.begin(), ssHeader.end()) + "\n";
 175         req->WriteHeader("Content-Type", "text/plain");
 176         req->WriteReply(HTTP_OK, strHex);
 177         return true;
 178     }
 179     case RF_JSON: {
 180         UniValue jsonHeaders(UniValue::VARR);
 181         for (const CBlockIndex *pindex : headers) {
 182             jsonHeaders.push_back(blockheaderToJSON(pindex));
 183         }
 184         std::string strJSON = jsonHeaders.write() + "\n";
 185         req->WriteHeader("Content-Type", "application/json");
 186         req->WriteReply(HTTP_OK, strJSON);
 187         return true;
 188     }
 189     default: {
 190         return RESTERR(req, HTTP_NOT_FOUND, "output format not found (available: .bin, .hex)");
 191     }
 192     }
 193
 194     // not reached
 195     return true; // continue to process further HTTP reqs on this cxn
 196 }
 197
 198 static bool rest_block(HTTPRequest* req,
 199                        const std::string& strURIPart,
 200                        bool showTxDetails)
 201 {
 202     if (!CheckWarmup(req))
 203         return false;
 204     std::string hashStr;
 205     const RetFormat rf = ParseDataFormat(hashStr, strURIPart);
 206
 207     uint256 hash;
 208     if (!ParseHashStr(hashStr, hash))
 209         return RESTERR(req, HTTP_BAD_REQUEST, "Invalid hash: " + hashStr);
 210
 211     CBlock block;
 212     CBlockIndex* pblockindex = nullptr;
 213     {
 214         LOCK(cs_main);
 215         if (mapBlockIndex.count(hash) == 0)
 216             return RESTERR(req, HTTP_NOT_FOUND, hashStr + " not found");
 217
 218         pblockindex = mapBlockIndex[hash];
 219         if (fHavePruned && !(pblockindex->nStatus & BLOCK_HAVE_DATA) && pblockindex->nTx > 0)
 220             return RESTERR(req, HTTP_NOT_FOUND, hashStr + " not available (pruned data)");
 221
 222         if (!ReadBlockFromDisk(block, pblockindex, Params().GetConsensus()))
 223             return RESTERR(req, HTTP_NOT_FOUND, hashStr + " not found");
 224     }
 225
 226     CDataStream ssBlock(SER_NETWORK, PROTOCOL_VERSION | RPCSerializationFlags());
 227     ssBlock << block;
 228
 229     switch (rf) {
 230     case RF_BINARY: {
 231         std::string binaryBlock = ssBlock.str();
 232         req->WriteHeader("Content-Type", "application/octet-stream");
 233         req->WriteReply(HTTP_OK, binaryBlock);
 234         return true;
 235     }
 236
 237     case RF_HEX: {
 238         std::string strHex = HexStr(ssBlock.begin(), ssBlock.end()) + "\n";
 239         req->WriteHeader("Content-Type", "text/plain");
 240         req->WriteReply(HTTP_OK, strHex);
 241         return true;
 242     }
 243
 244     case RF_JSON: {
 245         UniValue objBlock = blockToJSON(block, pblockindex, showTxDetails);
 246         std::string strJSON = objBlock.write() + "\n";
 247         req->WriteHeader("Content-Type", "application/json");
 248         req->WriteReply(HTTP_OK, strJSON);
 249         return true;
 250     }
 251
 252     default: {
 253         return RESTERR(req, HTTP_NOT_FOUND, "output format not found (available: " + AvailableDataFormatsString() + ")");
 254     }
 255     }
 256
 257     // not reached
 258     return true; // continue to process further HTTP reqs on this cxn
 259 }
 260
 261 static bool rest_block_extended(HTTPRequest* req, const std::string& strURIPart)
 262 {
 263     return rest_block(req, strURIPart, true);
 264 }
 265
 266 static bool rest_block_notxdetails(HTTPRequest* req, const std::string& strURIPart)
 267 {
 268     return rest_block(req, strURIPart, false);
 269 }
 270
 271 // A bit of a hack - dependency on a function defined in rpc/blockchain.cpp
 272 UniValue getblockchaininfo(const JSONRPCRequest& request);
 273
 274 static bool rest_chaininfo(HTTPRequest* req, const std::string& strURIPart)
 275 {
 276     if (!CheckWarmup(req))
 277         return false;
 278     std::string param;
 279     const RetFormat rf = ParseDataFormat(param, strURIPart);
 280
 281     switch (rf) {
 282     case RF_JSON: {
 283         JSONRPCRequest jsonRequest;
 284         jsonRequest.params = UniValue(UniValue::VARR);
 285         UniValue chainInfoObject = getblockchaininfo(jsonRequest);
 286         std::string strJSON = chainInfoObject.write() + "\n";
 287         req->WriteHeader("Content-Type", "application/json");
 288         req->WriteReply(HTTP_OK, strJSON);
 289         return true;
 290     }
 291     default: {
 292         return RESTERR(req, HTTP_NOT_FOUND, "output format not found (available: json)");
 293     }
 294     }
 295
 296     // not reached
 297     return true; // continue to process further HTTP reqs on this cxn
 298 }
 299
 300 static bool rest_mempool_info(HTTPRequest* req, const std::string& strURIPart)
 301 {
 302     if (!CheckWarmup(req))
 303         return false;
 304     std::string param;
 305     const RetFormat rf = ParseDataFormat(param, strURIPart);
 306
 307     switch (rf) {
 308     case RF_JSON: {
 309         UniValue mempoolInfoObject = mempoolInfoToJSON();
 310
 311         std::string strJSON = mempoolInfoObject.write() + "\n";
 312         req->WriteHeader("Content-Type", "application/json");
 313         req->WriteReply(HTTP_OK, strJSON);
 314         return true;
 315     }
 316     default: {
 317         return RESTERR(req, HTTP_NOT_FOUND, "output format not found (available: json)");
 318     }
 319     }
 320
 321     // not reached
 322     return true; // continue to process further HTTP reqs on this cxn
 323 }
 324
 325 static bool rest_mempool_contents(HTTPRequest* req, const std::string& strURIPart)
 326 {
 327     if (!CheckWarmup(req))
 328         return false;
 329     std::string param;
 330     const RetFormat rf = ParseDataFormat(param, strURIPart);
 331
 332     switch (rf) {
 333     case RF_JSON: {
 334         UniValue mempoolObject = mempoolToJSON(true);
 335
 336         std::string strJSON = mempoolObject.write() + "\n";
 337         req->WriteHeader("Content-Type", "application/json");
 338         req->WriteReply(HTTP_OK, strJSON);
 339         return true;
 340     }
 341     default: {
 342         return RESTERR(req, HTTP_NOT_FOUND, "output format not found (available: json)");
 343     }
 344     }
 345
 346     // not reached
 347     return true; // continue to process further HTTP reqs on this cxn
 348 }
 349
 350 static bool rest_tx(HTTPRequest* req, const std::string& strURIPart)
 351 {
 352     if (!CheckWarmup(req))
 353         return false;
 354     std::string hashStr;
 355     const RetFormat rf = ParseDataFormat(hashStr, strURIPart);
 356
 357     uint256 hash;
 358     if (!ParseHashStr(hashStr, hash))
 359         return RESTERR(req, HTTP_BAD_REQUEST, "Invalid hash: " + hashStr);
 360
 361     CTransactionRef tx;
 362     uint256 hashBlock = uint256();
 363     if (!GetTransaction(hash, tx, Params().GetConsensus(), hashBlock, true))
 364         return RESTERR(req, HTTP_NOT_FOUND, hashStr + " not found");
 365
 366     CDataStream ssTx(SER_NETWORK, PROTOCOL_VERSION | RPCSerializationFlags());
 367     ssTx << tx;
 368
 369     switch (rf) {
 370     case RF_BINARY: {
 371         std::string binaryTx = ssTx.str();
 372         req->WriteHeader("Content-Type", "application/octet-stream");
 373         req->WriteReply(HTTP_OK, binaryTx);
 374         return true;
 375     }
 376
 377     case RF_HEX: {
 378         std::string strHex = HexStr(ssTx.begin(), ssTx.end()) + "\n";
 379         req->WriteHeader("Content-Type", "text/plain");
 380         req->WriteReply(HTTP_OK, strHex);
 381         return true;
 382     }
 383
 384     case RF_JSON: {
 385         UniValue objTx(UniValue::VOBJ);
 386         TxToUniv(*tx, hashBlock, objTx);
 387         std::string strJSON = objTx.write() + "\n";
 388         req->WriteHeader("Content-Type", "application/json");
 389         req->WriteReply(HTTP_OK, strJSON);
 390         return true;
 391     }
 392
 393     default: {
 394         return RESTERR(req, HTTP_NOT_FOUND, "output format not found (available: " + AvailableDataFormatsString() + ")");
 395     }
 396     }
 397
 398     // not reached
 399     return true; // continue to process further HTTP reqs on this cxn
 400 }
 401
 402 static bool rest_getutxos(HTTPRequest* req, const std::string& strURIPart)
 403 {
 404     if (!CheckWarmup(req))
 405         return false;
 406     std::string param;
 407     const RetFormat rf = ParseDataFormat(param, strURIPart);
 408
 409     std::vector<std::string> uriParts;
 410     if (param.length() > 1)
 411     {
 412         std::string strUriParams = param.substr(1);
 413         boost::split(uriParts, strUriParams, boost::is_any_of("/"));
 414     }
 415
 416     // throw exception in case of an empty request
 417     std::string strRequestMutable = req->ReadBody();
 418     if (strRequestMutable.length() == 0 && uriParts.size() == 0)
 419         return RESTERR(req, HTTP_BAD_REQUEST, "Error: empty request");
 420
 421     bool fInputParsed = false;
 422     bool fCheckMemPool = false;
 423     std::vector<COutPoint> vOutPoints;
 424
 425     // parse/deserialize input
 426     // input-format = output-format, rest/getutxos/bin requires binary input, gives binary output, ...
 427
 428     if (uriParts.size() > 0)
 429     {
 430
 431         //inputs is sent over URI scheme (/rest/getutxos/checkmempool/txid1-n/txid2-n/...)
 432         if (uriParts.size() > 0 && uriParts[0] == "checkmempool")
 433             fCheckMemPool = true;
 434
 435         for (size_t i = (fCheckMemPool) ? 1 : 0; i < uriParts.size(); i++)
 436         {
 437             uint256 txid;
 438             int32_t nOutput;
 439             std::string strTxid = uriParts[i].substr(0, uriParts[i].find("-"));
 440             std::string strOutput = uriParts[i].substr(uriParts[i].find("-")+1);
 441
 442             if (!ParseInt32(strOutput, &nOutput) || !IsHex(strTxid))
 443                 return RESTERR(req, HTTP_BAD_REQUEST, "Parse error");
 444
 445             txid.SetHex(strTxid);
 446             vOutPoints.push_back(COutPoint(txid, (uint32_t)nOutput));
 447         }
 448
 449         if (vOutPoints.size() > 0)
 450             fInputParsed = true;
 451         else
 452             return RESTERR(req, HTTP_BAD_REQUEST, "Error: empty request");
 453     }
 454
 455     switch (rf) {
 456     case RF_HEX: {
 457         // convert hex to bin, continue then with bin part
 458         std::vector<unsigned char> strRequestV = ParseHex(strRequestMutable);
 459         strRequestMutable.assign(strRequestV.begin(), strRequestV.end());
 460     }
 461
 462     case RF_BINARY: {
 463         try {
 464             //deserialize only if user sent a request
 465             if (strRequestMutable.size() > 0)
 466             {
 467                 if (fInputParsed) //don't allow sending input over URI and HTTP RAW DATA
 468                     return RESTERR(req, HTTP_BAD_REQUEST, "Combination of URI scheme inputs and raw post data is not allowed");
 469
 470                 CDataStream oss(SER_NETWORK, PROTOCOL_VERSION);
 471                 oss << strRequestMutable;
 472                 oss >> fCheckMemPool;
 473                 oss >> vOutPoints;
 474             }
 475         } catch (const std::ios_base::failure& e) {
 476             // abort in case of unreadable binary data
 477             return RESTERR(req, HTTP_BAD_REQUEST, "Parse error");
 478         }
 479         break;
 480     }
 481
 482     case RF_JSON: {
 483         if (!fInputParsed)
 484             return RESTERR(req, HTTP_BAD_REQUEST, "Error: empty request");
 485         break;
 486     }
 487     default: {
 488         return RESTERR(req, HTTP_NOT_FOUND, "output format not found (available: " + AvailableDataFormatsString() + ")");
 489     }
 490     }
 491
 492     // limit max outpoints
 493     if (vOutPoints.size() > MAX_GETUTXOS_OUTPOINTS)
 494         return RESTERR(req, HTTP_BAD_REQUEST, strprintf("Error: max outpoints exceeded (max: %d, tried: %d)", MAX_GETUTXOS_OUTPOINTS, vOutPoints.size()));
 495
 496     // check spentness and form a bitmap (as well as a JSON capable human-readable string representation)
 497     std::vector<unsigned char> bitmap;
 498     std::vector<CCoin> outs;
 499     std::string bitmapStringRepresentation;
 500     std::vector<bool> hits;
 501     bitmap.resize((vOutPoints.size() + 7) / 8);
 502     {
 503         LOCK2(cs_main, mempool.cs);
 504
 505         CCoinsView viewDummy;
 506         CCoinsViewCache view(&viewDummy);
 507
 508         CCoinsViewCache& viewChain = *pcoinsTip;
 509         CCoinsViewMemPool viewMempool(&viewChain, mempool);
 510
 511         if (fCheckMemPool)
 512             view.SetBackend(viewMempool); // switch cache backend to db+mempool in case user likes to query mempool
 513
 514         for (size_t i = 0; i < vOutPoints.size(); i++) {
 515             bool hit = false;
 516             Coin coin;
 517             if (view.GetCoin(vOutPoints[i], coin) && !mempool.isSpent(vOutPoints[i])) {
 518                 hit = true;
 519                 outs.emplace_back(std::move(coin));
 520             }
 521
 522             hits.push_back(hit);
 523             bitmapStringRepresentation.append(hit ? "1" : "0"); // form a binary string representation (human-readable for json output)
 524             bitmap[i / 8] |= ((uint8_t)hit) << (i % 8);
 525         }
 526     }
 527
 528     switch (rf) {
 529     case RF_BINARY: {
 530         // serialize data
 531         // use exact same output as mentioned in Bip64
 532         CDataStream ssGetUTXOResponse(SER_NETWORK, PROTOCOL_VERSION);
 533         ssGetUTXOResponse << chainActive.Height() << chainActive.Tip()->GetBlockHash() << bitmap << outs;
 534         std::string ssGetUTXOResponseString = ssGetUTXOResponse.str();
 535
 536         req->WriteHeader("Content-Type", "application/octet-stream");
 537         req->WriteReply(HTTP_OK, ssGetUTXOResponseString);
 538         return true;
 539     }
 540
 541     case RF_HEX: {
 542         CDataStream ssGetUTXOResponse(SER_NETWORK, PROTOCOL_VERSION);
 543         ssGetUTXOResponse << chainActive.Height() << chainActive.Tip()->GetBlockHash() << bitmap << outs;
 544         std::string strHex = HexStr(ssGetUTXOResponse.begin(), ssGetUTXOResponse.end()) + "\n";
 545
 546         req->WriteHeader("Content-Type", "text/plain");
 547         req->WriteReply(HTTP_OK, strHex);
 548         return true;
 549     }
 550
 551     case RF_JSON: {
 552         UniValue objGetUTXOResponse(UniValue::VOBJ);
 553
 554         // pack in some essentials
 555         // use more or less the same output as mentioned in Bip64
 556         objGetUTXOResponse.push_back(Pair("chainHeight", chainActive.Height()));
 557         objGetUTXOResponse.push_back(Pair("chaintipHash", chainActive.Tip()->GetBlockHash().GetHex()));
 558         objGetUTXOResponse.push_back(Pair("bitmap", bitmapStringRepresentation));
 559
 560         UniValue utxos(UniValue::VARR);
 561         for (const CCoin& coin : outs) {
 562             UniValue utxo(UniValue::VOBJ);
 563             utxo.push_back(Pair("height", (int32_t)coin.nHeight));
 564             utxo.push_back(Pair("value", ValueFromAmount(coin.out.nValue)));
 565
 566             // include the script in a json output
 567             UniValue o(UniValue::VOBJ);
 568             ScriptPubKeyToUniv(coin.out.scriptPubKey, o, true);
 569             utxo.push_back(Pair("scriptPubKey", o));
 570             utxos.push_back(utxo);
 571         }
 572         objGetUTXOResponse.push_back(Pair("utxos", utxos));
 573
 574         // return json string
 575         std::string strJSON = objGetUTXOResponse.write() + "\n";
 576         req->WriteHeader("Content-Type", "application/json");
 577         req->WriteReply(HTTP_OK, strJSON);
 578         return true;
 579     }
 580     default: {
 581         return RESTERR(req, HTTP_NOT_FOUND, "output format not found (available: " + AvailableDataFormatsString() + ")");
 582     }
 583     }
 584
 585     // not reached
 586     return true; // continue to process further HTTP reqs on this cxn
 587 }
 588
 589 static const struct {
 590     const char* prefix;
 591     bool (*handler)(HTTPRequest* req, const std::string& strReq);
 592 } uri_prefixes[] = {
 593       {"/rest/tx/", rest_tx},
 594       {"/rest/block/notxdetails/", rest_block_notxdetails},
 595       {"/rest/block/", rest_block_extended},
 596       {"/rest/chaininfo", rest_chaininfo},
 597       {"/rest/mempool/info", rest_mempool_info},
 598       {"/rest/mempool/contents", rest_mempool_contents},
 599       {"/rest/headers/", rest_headers},
 600       {"/rest/getutxos", rest_getutxos},
 601 };
 602
 603 bool StartREST()
 604 {
 605     for (unsigned int i = 0; i < ARRAYLEN(uri_prefixes); i++)
 606         RegisterHTTPHandler(uri_prefixes[i].prefix, false, uri_prefixes[i].handler);
 607     return true;
 608 }
 609
 610 void InterruptREST()
 611 {
 612 }
 613
 614 void StopREST()
 615 {
 616     for (unsigned int i = 0; i < ARRAYLEN(uri_prefixes); i++)
 617         UnregisterHTTPHandler(uri_prefixes[i].prefix, false);
 618 }