From 54b45e155e02cba19975be0bb826ff748d7e895e Mon Sep 17 00:00:00 2001 From: Luke Dashjr Date: Tue, 15 Nov 2022 21:07:11 +0000 Subject: [PATCH 1/2] RPC/Blockchain: Clarify invalid-action error in scanblocks & scantxoutset --- src/rpc/blockchain.cpp | 4 ++-- test/functional/rpc_scanblocks.py | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/rpc/blockchain.cpp b/src/rpc/blockchain.cpp index bc1028aec39..98257e8b998 100644 --- a/src/rpc/blockchain.cpp +++ b/src/rpc/blockchain.cpp @@ -2205,7 +2205,7 @@ static RPCHelpMan scantxoutset() result.pushKV("unspents", unspents); result.pushKV("total_amount", ValueFromAmount(total_in)); } else { - throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid command"); + throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("Invalid action '%s'", request.params[0].get_str())); } return result; }, @@ -2402,7 +2402,7 @@ static RPCHelpMan scanblocks() ret.pushKV("relevant_blocks", blocks); } else { - throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid command"); + throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("Invalid action '%s'", request.params[0].get_str())); } return ret; }, diff --git a/test/functional/rpc_scanblocks.py b/test/functional/rpc_scanblocks.py index 68c84b17a22..743cdf89ed6 100755 --- a/test/functional/rpc_scanblocks.py +++ b/test/functional/rpc_scanblocks.py @@ -122,7 +122,7 @@ class ScanblocksTest(BitcoinTestFramework): assert_equal(node.scanblocks("abort"), False) # test invalid command - assert_raises_rpc_error(-8, "Invalid command", node.scanblocks, "foobar") + assert_raises_rpc_error(-8, "Invalid action 'foobar'", node.scanblocks, "foobar") if __name__ == '__main__': From f9869843a664391a493fca4b0ad2828f944cb13a Mon Sep 17 00:00:00 2001 From: Luke Dashjr Date: Thu, 24 Mar 2022 00:15:50 +0000 Subject: [PATCH 2/2] RPC/blockchain: scan{blocks,txoutset>: Further doc improvements --- src/rpc/blockchain.cpp | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/src/rpc/blockchain.cpp b/src/rpc/blockchain.cpp index 98257e8b998..027a61ff8b0 100644 --- a/src/rpc/blockchain.cpp +++ b/src/rpc/blockchain.cpp @@ -2254,12 +2254,13 @@ static RPCHelpMan scanblocks() }, { scan_result_status_none, - RPCResult{"When action=='start'", RPCResult::Type::OBJ, "", "", { + RPCResult{"When action=='start'; only returns after scan completes", RPCResult::Type::OBJ, "", "", { {RPCResult::Type::NUM, "from_height", "The height we started the scan from"}, {RPCResult::Type::NUM, "to_height", "The height we ended the scan at"}, - {RPCResult::Type::ARR, "relevant_blocks", "", {{RPCResult::Type::STR_HEX, "blockhash", "A relevant blockhash"},}}, - }, - }, + {RPCResult::Type::ARR, "relevant_blocks", "Blocks that may have matched a scanobject.", { + {RPCResult::Type::STR_HEX, "blockhash", "A relevant blockhash"}, + }}, + }}, RPCResult{"when action=='status' and a scan is currently in progress", RPCResult::Type::OBJ, "", "", { {RPCResult::Type::NUM, "progress", "Approximate percent complete"}, {RPCResult::Type::NUM, "current_height", "Height of the block currently being scanned"},