RPC/Blockchain: Minor improvements for scanblocks & scantxoutset docs/errors #26508

pull luke-jr wants to merge 2 commits into bitcoin:master from luke-jr:rpc_scanblocks_scantxoutset_doc_improvements changing 2 files +8 −7

luke-jr commented at 12:46 AM on November 16, 2022: member
- Clarify invalid-action error in scanblocks & scantxoutset
- Mention action=='start' only returns after scan completes (already in scantxoutset)
- Document relevant_blocks
RPC/Blockchain: Clarify invalid-action error in scanblocks & scantxoutset 54b45e155e
RPC/blockchain: scan{blocks,txoutset>: Further doc improvements f9869843a6
kristapsk approved
kristapsk commented at 2:26 AM on November 16, 2022: contributor

utACK f9869843a664391a493fca4b0ad2828f944cb13a
glozow added the label RPC/REST/ZMQ on Nov 16, 2022

in src/rpc/blockchain.cpp:2208 in 54b45e155e outdated

2204 | @@ -2205,7 +2205,7 @@ static RPCHelpMan scantxoutset()
2205 |          result.pushKV("unspents", unspents);
2206 |          result.pushKV("total_amount", ValueFromAmount(total_in));
2207 |      } else {
2208 | -        throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid command");
2209 | +        throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("Invalid action '%s'", request.params[0].get_str()));

maflcko commented at 7:58 AM on November 16, 2022:

nit: Instead of parsing the action 4 times, maybe just parse it once in the beginning and keep a named reference to it?

luke-jr commented at 9:09 PM on November 19, 2022:

Out of scope here IMO. (There's also no parsing involved)

maflcko approved
maflcko commented at 7:59 AM on November 16, 2022: member

lgtm
DrahtBot commented at 10:20 AM on November 16, 2022: contributor



The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.



Reviews

See the guideline for information on the review process.

Type Reviewers

ACK kristapsk, aureleoules, MarnixCroes
aureleoules approved
aureleoules commented at 12:43 PM on November 16, 2022: member

ACK f9869843a664391a493fca4b0ad2828f944cb13a
MarnixCroes approved
MarnixCroes commented at 7:34 PM on November 16, 2022: contributor

ACK f9869843a664391a493fca4b0ad2828f944cb13a
maflcko merged this on Nov 21, 2022
maflcko closed this on Nov 21, 2022
sidhujag referenced this in commit 204b97d35b on Nov 21, 2022
bitcoin locked this on Nov 21, 2023

Type	Reviewers
ACK	kristapsk, aureleoules, MarnixCroes

Contributors

Labels

RPC/Blockchain: Minor improvements for scanblocks & scantxoutset docs/errors #26508

Reviews