Skip to content

Commit f769a0d

Browse files
MarcoFalkesidhujag
MarcoFalke
authored and
sidhujag
committed
Merge bitcoin#19849: Assert that RPCArg names are equal to CRPCCommand ones (blockchain,rawtransaction)
fa6bb0c Assert that RPCArg names are equal to CRPCCommand ones (rawtransaction) (MarcoFalke) fa80c81 Assert that RPCArg names are equal to CRPCCommand ones (blockchain) (MarcoFalke) Pull request description: This is split out from bitcoin#18531 to just touch some RPC methods. Description from the main pr: ### Motivation RPCArg names in the rpc help are currently only used for documentation. However, in the future they could be used to teach the server the named arguments. Named arguments are currently registered by the `CRPCCommand`s and duplicate the RPCArg names from the documentation. This redundancy is fragile, and has lead to errors in the past (despite having linters to catch those kind of errors). See section "bugs found" for a list of bugs that have been found as a result of the changes here. ### Changes The changes here add an assert in the `CRPCCommand` constructor that the RPCArg names are identical to the ones in the `CRPCCommand`. ### Future work > Here or follow up, makes sense to also assert type of returned UniValue? Sure, but let's not get ahead of ourselves. I am going to submit any further works as follow-ups, including: * Removing the CRPCCommand arguments, now that they are asserted to be equal and thus redundant * Removing all python regex linters on the args, now that RPCMan can be used to generate any output, including the cli.cpp table * Auto-formatting and sanity checking the RPCExamples with RPCMan * Checking passed-in json in self-check. Removing redundant checks * Checking returned json against documentation to avoid regressions or false documentation * Compile the RPC documentation at compile-time to ensure it doesn't change at runtime and is completely static ### Bugs found * The assert identified issue bitcoin#18607 * The changes itself fixed bug bitcoin#19250 ACKs for top commit: fjahr: utACK fa6bb0c tryphe: utACK fa6bb0c. Reducing data duplication is nice. Code changes are minimal and concise. Tree-SHA512: deb0edc3f999baf055526eaa199b98c500635e12502dece7aa3cad5319db330eb5ee7459a5c8f040a83671a7f20c560c19a2026fb76c8416f138aa332727cbce
1 parent 5de0f88 commit f769a0d

3 files changed

Lines changed: 296 additions & 193 deletions

File tree

‎src/rest.cpp‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -302,7 +302,7 @@ static bool rest_block_notxdetails(const util::Ref& context, HTTPRequest* req, c
302302
}
303303

304304
// A bit of a hack - dependency on a function defined in rpc/blockchain.cpp
305-
UniValue getblockchaininfo(const JSONRPCRequest& request);
305+
RPCHelpMan getblockchaininfo();
306306

307307
static bool rest_chaininfo(const util::Ref& context, HTTPRequest* req, const std::string& strURIPart)
308308
{
@@ -315,7 +315,7 @@ static bool rest_chaininfo(const util::Ref& context, HTTPRequest* req, const std
315315
case RetFormat::JSON: {
316316
JSONRPCRequest jsonRequest(context);
317317
jsonRequest.params = UniValue(UniValue::VARR);
318-
UniValue chainInfoObject = getblockchaininfo(jsonRequest);
318+
UniValue chainInfoObject = getblockchaininfo().HandleRequest(jsonRequest);
319319
std::string strJSON = chainInfoObject.write() + "\n";
320320
req->WriteHeader("Content-Type", "application/json");
321321
req->WriteReply(HTTP_OK, strJSON);

0 commit comments

Comments
 (0)