diff options
author | Ryan Ofsky <ryan@ofsky.org> | 2022-11-10 11:54:11 -0500 |
---|---|---|
committer | Ryan Ofsky <ryan@ofsky.org> | 2023-05-03 11:27:51 -0500 |
commit | 702b56d2a8ce48bc3b66a2867d09fa11dcf12fc5 (patch) | |
tree | f635fbee56d0344d335fc714671a9ea910774c17 /src/wallet/rpc/util.h | |
parent | 1d7f1ada48083d27adda47e04fd0311cc3cd6816 (diff) |
RPC: Add add OBJ_NAMED_PARAMS type
OBJ_NAMED_PARAMS type works the same as OBJ type except it registers the object
keys to be accepted as top-level named-only RPC parameters. Generated
documentation also lists the object keys seperately in a new "Named arguments"
section of help text.
Named-only RPC parameters have the same semantics as python keyword-only
arguments (https://peps.python.org/pep-3102/). They are always required to be
passed by name, so they don't affect interpretation of positional arguments,
and aren't affected when positional arguments are added or removed.
The new OBJ_NAMED_PARAMS type is used in the next commit to make it easier to
pass options values to various RPC methods.
Co-authored-by: Andrew Chow <github@achow101.com>
Diffstat (limited to 'src/wallet/rpc/util.h')
0 files changed, 0 insertions, 0 deletions