[REST] add a rest endpoint for estimatesmartfee, docs, and test #11770

   0 | @@ -0,0 +1,23 @@
   1 | +import http.client
   2 | +
   3 | +
   4 | +#allows simple http get calls
   5 | +def http_get_call(host, port, path, response_object = 0):

---

   1 | @@ -2,7 +2,6 @@
   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 | -

---

 282 | @@ -283,6 +283,7 @@ static bool rest_chaininfo(HTTPRequest* req, const std::string& strURIPart)
 283 |      case RF_JSON: {
 284 |          JSONRPCRequest jsonRequest;
 285 |          jsonRequest.params = UniValue(UniValue::VARR);
 286 | +

---

 596 | +    };
 597 | +
 598 | +
 599 | +    switch (rf) {
 600 | +    case RF_JSON: {
 601 | +

---

 593 | +    FeeEstimateMode mode;
 594 | +    if (!FeeModeFromString(modestr, mode)){
 595 | +        return RESTERR(req, HTTP_BAD_REQUEST, "<MODE> must be one of <unset|economical|conservative>");
 596 | +    };
 597 | +
 598 | +

---

 606 | +        params.push_back(conf_target);
 607 | +        params.push_back(mode);
 608 | +        jsonRequest.params = params;
 609 | +
 610 | +        UniValue estimatedfee;
 611 | +        estimatedfee = estimatesmartfee(jsonRequest);

---

 102 | +`GET /rest/fee/<MODE>/<TARGET>.json`
 103 | +
 104 | +Returns proper fee estimated by bitcoind. `<MODE>` should be one of `<unset|conservative|economical>`.
 105 | +`<TARGET>` is the desired confirmation time (in block height).
 106 | +
 107 | +

---

 582 | +
 583 | +    std::vector<std::string> path;
 584 | +    boost::split(path, param, boost::is_any_of("/"));
 585 | +    path.erase(path.begin());
 586 | +
 587 | +    if (path.size() != 2)

---

 570 | @@ -570,6 +571,55 @@ static bool rest_getutxos(HTTPRequest* req, const std::string& strURIPart)
 571 |      }
 572 |  }
 573 |  
 574 | +// A bit of a hack - dependency on a function defined in rpc/mining.cpp
 575 | +UniValue estimatesmartfee(const JSONRPCRequest& request);
 576 | +
 577 | +static bool rest_getfee(HTTPRequest* req, const std::string& strURIPart) {
 578 | +    if (!CheckWarmup(req))

---

  97 | @@ -98,6 +98,13 @@ Only supports JSON as output format.
  98 |  Returns transactions in the TX mempool.
  99 |  Only supports JSON as output format.
 100 |  
 101 | +#### Fees
 102 | +`GET /rest/fee/<MODE>/<TARGET>.json`
 103 | +
 104 | +Returns proper fee estimated by bitcoind. `<MODE>` should be one of `<unset|conservative|economical>`.

---

 570 | @@ -570,6 +571,55 @@ static bool rest_getutxos(HTTPRequest* req, const std::string& strURIPart)
 571 |      }
 572 |  }
 573 |  
 574 | +// A bit of a hack - dependency on a function defined in rpc/mining.cpp
 575 | +UniValue estimatesmartfee(const JSONRPCRequest& request);

---

 119 | @@ -117,7 +120,13 @@ def check_estimates(node, fees_seen, max_invalid, print_estimates = True):
 120 |          if e >= 0:
 121 |              valid_estimate = True
 122 |              if i >= 13:  # for n>=14 estimatesmartfee(n/2) should be at least as high as estimatefee(n)
 123 | -                assert(node.estimatesmartfee((i+1)//2)["feerate"] > float(e) - delta)
 124 | +                rpcfeerate = node.estimatesmartfee((i+1)//2)["feerate"]
 125 | +                assert(rpcfeerate > float(e) - delta)
 126 | +
 127 | +                json_string = http_get_call(url.hostname, url.port, '/rest/fee/' + 'unset/' + "{}".format((i+1)//2) + '.json')

---

  12 | @@ -13,6 +13,8 @@
  13 |  import re
  14 |  import subprocess
  15 |  import time
  16 | +import urllib.parse
  17 | +import http.client

---

 609 | +            conservative = true;
 610 | +        }
 611 | +        int64_t conf_target;
 612 | +        try {
 613 | +             conf_target = atoi64(path[1]);
 614 | +        } catch (std::invalid_argument& e) {

---

 605 | +        bool conservative;
 606 | +        if (mode == FeeEstimateMode::ECONOMICAL) {
 607 | +            conservative = false;
 608 | +        } else {
 609 | +            conservative = true;
 610 | +        }

---

 597 | +        auto modestr = path[0];
 598 | +        std::transform(modestr.cbegin(), modestr.cend(), modestr.begin(), ToUpper);
 599 | +        FeeEstimateMode mode;
 600 | +        if (!FeeModeFromString(modestr, mode)){
 601 | +            return RESTERR(req, HTTP_BAD_REQUEST, "<MODE> must be one of <unset|economical|conservative>");
 602 | +        };

---

 611 | +        int64_t conf_target;
 612 | +        try {
 613 | +             conf_target = atoi64(path[1]);
 614 | +        } catch (std::invalid_argument& e) {
 615 | +            return RESTERR(req, HTTP_BAD_REQUEST, strprintf("Uneable to parse confirmation target to int"));
 616 | +        };

---

 615 | +            return RESTERR(req, HTTP_BAD_REQUEST, strprintf("Uneable to parse confirmation target to int"));
 616 | +        };
 617 | +        unsigned int max_target = ::feeEstimator.HighestTargetTracked(FeeEstimateHorizon::LONG_HALFLIFE);
 618 | +        if (conf_target < 1 || (unsigned int)conf_target > max_target) {
 619 | +            return RESTERR(req, HTTP_BAD_REQUEST, strprintf("Invalid confirmation target, must be in between %u - %u", 1, max_target));
 620 | +        };

---

 298 | @@ -299,5 +299,17 @@ def run_test(self):
 299 |          json_obj = self.test_rest_request("/chaininfo")
 300 |          assert_equal(json_obj['bestblockhash'], bb_hash)
 301 |  
 302 | +        # Prepate for Fee estimation

---

 610 | +        }
 611 | +        int64_t conf_target;
 612 | +        try {
 613 | +             conf_target = atoi64(path[1]);
 614 | +        } catch (std::invalid_argument& e) {
 615 | +            return RESTERR(req, HTTP_BAD_REQUEST, strprintf("Uneable to parse confirmation target to int"));

---