From a518fff0f2e479064dd4cff6c29fb54c72c1407b Mon Sep 17 00:00:00 2001
From: Andrew Toth <andrewstoth@gmail.com>
Date: Mon, 3 Oct 2022 23:28:56 -0400
Subject: [PATCH 1/3] rest: add verbose and mempool_sequence query params for
mempool/contents
---
src/rest.cpp | 15 ++++++++++++++-
1 file changed, 14 insertions(+), 1 deletion(-)
diff --git a/src/rest.cpp b/src/rest.cpp
index 7f00db2222c..c3c79433690 100644
--- a/src/rest.cpp
+++ b/src/rest.cpp
@@ -608,7 +608,20 @@ static bool rest_mempool(const std::any& context, HTTPRequest* req, const std::s
case RESTResponseFormat::JSON: {
std::string str_json;
if (param == "contents") {
- str_json = MempoolToJSON(*mempool, true).write() + "\n";
+ const std::string raw_verbose{req->GetQueryParameter("verbose").value_or("true")};
+ if (raw_verbose != "true" && raw_verbose != "false") {
+ return RESTERR(req, HTTP_BAD_REQUEST, "The \"verbose\" query parameter must be either \"true\" or \"false\".");
+ }
+ const std::string raw_mempool_sequence{req->GetQueryParameter("mempool_sequence").value_or("false")};
+ if (raw_mempool_sequence != "true" && raw_mempool_sequence != "false") {
+ return RESTERR(req, HTTP_BAD_REQUEST, "The \"mempool_sequence\" query parameter must be either \"true\" or \"false\".");
+ }
+ const bool verbose{raw_verbose == "true"};
+ const bool mempool_sequence{raw_mempool_sequence == "true"};
+ if (verbose && mempool_sequence) {
+ return RESTERR(req, HTTP_BAD_REQUEST, "Verbose results cannot contain mempool sequence values. (hint: set \"verbose=false\")");
+ }
+ str_json = MempoolToJSON(*mempool, verbose, mempool_sequence).write() + "\n";
} else {
str_json = MempoolInfoToJSON(*mempool).write() + "\n";
}
From 52a31dccc92366efb36db3b94920bdf8b05b264c Mon Sep 17 00:00:00 2001
From: Andrew Toth <andrewstoth@gmail.com>
Date: Mon, 3 Oct 2022 23:29:21 -0400
Subject: [PATCH 2/3] tests: mempool/contents verbose and mempool_sequence
query params tests
---
test/functional/interface_rest.py | 28 ++++++++++++++++++++++++++++
1 file changed, 28 insertions(+)
diff --git a/test/functional/interface_rest.py b/test/functional/interface_rest.py
index 610a28c56b9..ebefb8bd6a2 100755
--- a/test/functional/interface_rest.py
+++ b/test/functional/interface_rest.py
@@ -348,6 +348,34 @@ class RESTTest (BitcoinTestFramework):
assert_equal(json_obj[tx]['spentby'], txs[i + 1:i + 2])
assert_equal(json_obj[tx]['depends'], txs[i - 1:i])
+ # Check the mempool response for explicit parameters
+ json_obj = self.test_rest_request("/mempool/contents", query_params={"verbose": "true", "mempool_sequence": "false"})
+ assert_equal(json_obj, raw_mempool_verbose)
+
+ # Check the mempool response for not verbose
+ json_obj = self.test_rest_request("/mempool/contents", query_params={"verbose": "false"})
+ raw_mempool = self.nodes[0].getrawmempool(verbose=False)
+
+ assert_equal(json_obj, raw_mempool)
+
+ # Check the mempool response for sequence
+ json_obj = self.test_rest_request("/mempool/contents", query_params={"verbose": "false", "mempool_sequence": "true"})
+ raw_mempool = self.nodes[0].getrawmempool(verbose=False, mempool_sequence=True)
+
+ assert_equal(json_obj, raw_mempool)
+
+ # Check for error response if verbose=true and mempool_sequence=true
+ resp = self.test_rest_request("/mempool/contents", ret_type=RetType.OBJ, status=400, query_params={"verbose": "true", "mempool_sequence": "true"})
+ assert_equal(resp.read().decode('utf-8').strip(), 'Verbose results cannot contain mempool sequence values. (hint: set "verbose=false")')
+
+ # Check for error response if verbose is not "true" or "false"
+ resp = self.test_rest_request("/mempool/contents", ret_type=RetType.OBJ, status=400, query_params={"verbose": "TRUE"})
+ assert_equal(resp.read().decode('utf-8').strip(), 'The "verbose" query parameter must be either "true" or "false".')
+
+ # Check for error response if mempool_sequence is not "true" or "false"
+ resp = self.test_rest_request("/mempool/contents", ret_type=RetType.OBJ, status=400, query_params={"verbose": "false", "mempool_sequence": "TRUE"})
+ assert_equal(resp.read().decode('utf-8').strip(), 'The "mempool_sequence" query parameter must be either "true" or "false".')
+
# Now mine the transactions
newblockhash = self.generate(self.nodes[1], 1)
From 1ff5d61dfdaf8987e5619162662e4c760af76a43 Mon Sep 17 00:00:00 2001
From: Andrew Toth <andrewstoth@gmail.com>
Date: Tue, 4 Oct 2022 09:19:05 -0400
Subject: [PATCH 3/3] doc: add mempool/contents rest verbose and
mempool_sequence args
---
doc/REST-interface.md | 8 ++++++--
1 file changed, 6 insertions(+), 2 deletions(-)
diff --git a/doc/REST-interface.md b/doc/REST-interface.md
index 265b74ee9af..9173f08efb9 100644
--- a/doc/REST-interface.md
+++ b/doc/REST-interface.md
@@ -123,11 +123,15 @@ Returns various information about the transaction mempool.
Only supports JSON as output format.
Refer to the `getmempoolinfo` RPC help for details.
-`GET /rest/mempool/contents.json`
+`GET /rest/mempool/contents.json?verbose=<true|false>&mempool_sequence=<false|true>`
Returns the transactions in the mempool.
Only supports JSON as output format.
-Refer to the `getrawmempool` RPC help for details.
+Refer to the `getrawmempool` RPC help for details. Defaults to setting
+`verbose=true` and `mempool_sequence=false`.
+
+*Query parameters for `verbose` and `mempool_sequence` available in 25.0 and up.*
+
Risks
-------------