Assert that RPCArg names are equal to CRPCCommand ones (abc, avalanche)
ClosedPublic
Actions

Authored by PiRK on Dec 23 2021, 16:08.

Details

Reviewers

Fabien

Group Reviewers

Restricted Project

Commits

rABC3d7fdc544aab: Assert that RPCArg names are equal to CRPCCommand ones (abc, avalanche)

Summary

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 CRPCCommands 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 D10741 for a list of bugs that have been found as a result of the changes here.

The changes here add an assert in the CRPCCommand constructor that the RPCArg names are identical to the ones in the CRPCCommand.

This should be the final diff related to core#18531.

Depends on D10741

Test Plan

ninja all check-all

Diff Detail

Repository

rABC Bitcoin ABC

Lint

Lint Passed

Unit

No Test Coverage

Build Status

Buildable 17756
Build 35338: Build Diff	build-without-wallet · build-debug · build-clang · lint-circular-dependencies · build-diff · build-clang-tidy
Build 35337: arc lint + arc unit

Event Timeline

PiRK created this revision.Dec 23 2021, 16:08

Herald added a reviewer: Restricted Project. · View Herald TranscriptDec 23 2021, 16:08

PiRK requested review of this revision.Dec 23 2021, 16:08

teamcity edited the summary of this revision. (Show Details)Dec 23 2021, 16:08

Harbormaster completed remote builds in B17755: Diff 31578.Dec 23 2021, 16:24

there is one more RPC to tackle in rpc/abc.cpp

include the final RPC command from rpc/abc.cpp

PiRK added a child revision: D10743: remove dead rpc code.Dec 23 2021, 16:58

Harbormaster completed remote builds in B17756: Diff 31579.Dec 23 2021, 17:07

Fabien accepted this revision.Jan 3 2022, 07:19

This revision is now accepted and ready to land.Jan 3 2022, 07:19

PiRK retitled this revision from Assert that RPCArg names are equal to CRPCCommand ones (abc, valanche) to Assert that RPCArg names are equal to CRPCCommand ones (abc, avalanche).Jan 3 2022, 14:05

Closed by commit rABC3d7fdc544aab: Assert that RPCArg names are equal to CRPCCommand ones (abc, avalanche) (authored by PiRK). · Explain WhyJan 3 2022, 14:09

This revision was automatically updated to reflect the committed changes.

PiRK added a commit: rABC3d7fdc544aab: Assert that RPCArg names are equal to CRPCCommand ones (abc, avalanche).