6#include <bitcoin-build-config.h>
22#include <validation.h>
28#include <unordered_map>
59 std::list<RPCCommandExecutionInfo>::iterator
it;
76 std::set<intptr_t> setDone;
77 std::vector<std::pair<std::string, const CRPCCommand*> > vCommands;
81 vCommands.emplace_back(entry.second.front()->category + entry.first, entry.second.front());
82 sort(vCommands.begin(), vCommands.end());
88 for (
const std::pair<std::string, const CRPCCommand*>&
command : vCommands)
91 std::string strMethod = pcmd->
name;
92 if ((strCommand !=
"" || pcmd->
category ==
"hidden") && strMethod != strCommand)
98 if (setDone.insert(pcmd->
unique_id).second)
99 pcmd->
actor(jreq, unused_result,
true);
101 catch (
const std::exception& e)
104 std::string strHelp = std::string(e.what());
105 if (strCommand ==
"")
107 if (strHelp.find(
'\n') != std::string::npos)
108 strHelp = strHelp.substr(0, strHelp.find(
'\n'));
112 if (!category.empty())
115 strRet +=
"== " +
Capitalize(category) +
" ==\n";
118 strRet += strHelp +
"\n";
122 strRet =
strprintf(
"help: unknown command: %s\n", strCommand);
123 strRet = strRet.substr(0,strRet.size()-1);
131 "List all commands, or get help for a specified command.\n",
142 std::string strCommand;
143 if (jsonRequest.params.size() > 0) {
144 strCommand = jsonRequest.params[0].
get_str();
146 if (strCommand ==
"dump_all_command_conversions") {
158 static const std::string RESULT{CLIENT_NAME
" stopping"};
164 "Request a graceful shutdown of " CLIENT_NAME
".",
175 if (jsonRequest.params[0].isNum()) {
187 "Returns the total uptime of the server.\n",
207 "Returns details of the RPC server.\n",
233 entry.
pushKV(
"duration", int64_t{Ticks<std::chrono::microseconds>(SteadyClock::now() - info.
start)});
234 active_commands.
push_back(std::move(entry));
238 result.
pushKV(
"active_commands", std::move(active_commands));
242 result.
pushKV(
"logpath", std::move(log_path));
275 auto new_end = std::remove(it->second.begin(), it->second.end(), pcmd);
276 if (it->second.end() != new_end) {
277 it->second.erase(new_end, it->second.end());
292 static std::once_flag g_rpc_interrupt_flag;
294 std::call_once(g_rpc_interrupt_flag, []() {
303 static std::once_flag g_rpc_stop_flag;
306 std::call_once(g_rpc_stop_flag, [&]() {
327 rpcWarmupStatus = newStatus;
334 fRPCInWarmup =
false;
341 *outStatus = rpcWarmupStatus;
347 const std::vector<std::string> enabled_methods =
gArgs.
GetArgs(
"-deprecatedrpc");
349 return find(enabled_methods.begin(), enabled_methods.end(), method) != enabled_methods.end();
360 }
catch (
const std::exception& e) {
382 std::unordered_map<std::string, const UniValue*> argsIn;
383 for (
size_t i=0; i<keys.size(); ++i) {
384 auto [
_, inserted] = argsIn.emplace(keys[i], &
values[i]);
398 int initial_hole_size = 0;
399 const std::string* initial_param =
nullptr;
401 for (
const auto& [argNamePattern, named_only]: argNames) {
402 std::vector<std::string> vargNames =
SplitString(argNamePattern,
'|');
403 auto fr = argsIn.end();
404 for (
const std::string & argName : vargNames) {
405 fr = argsIn.find(argName);
406 if (fr != argsIn.end()) {
415 if (fr != argsIn.end()) {
416 if (options.exists(fr->first)) {
419 options.pushKVEnd(fr->first, *fr->second);
425 if (!options.empty() || fr != argsIn.end()) {
426 for (
int i = 0; i < hole; ++i) {
433 if (!initial_param) initial_param = &argNamePattern;
436 if (
out.params.empty()) initial_hole_size = hole;
442 if (fr != argsIn.end()) {
443 if (!options.empty()) {
446 out.params.push_back(*fr->second);
449 if (!options.empty()) {
450 out.params.push_back(std::move(options));
458 auto positional_args{argsIn.extract(
"args")};
459 if (positional_args && positional_args.mapped()->isArray()) {
460 if (initial_hole_size < (
int)positional_args.mapped()->size() && initial_param) {
465 out.params = *positional_args.mapped();
466 for (
size_t i{
out.params.size()}; i < named_args.size(); ++i) {
467 out.params.push_back(named_args[i]);
471 if (!argsIn.empty()) {
480 for (
const auto&
command : commands) {
516 return command.actor(request, result, last_handler);
520 }
catch (
const std::exception& e) {
527 std::vector<std::string> commandList;
529 for (
const auto& i :
mapCommands) commandList.emplace_back(i.first);
567void RPCRunLater(
const std::string&
name, std::function<
void()> func, int64_t nSeconds)
572 deadlineTimers.erase(
name);
#define CHECK_NONFATAL(condition)
Identity function.
std::vector< std::string > GetArgs(const std::string &strArg) const
Return a vector of strings of the given argument.
std::map< std::string, std::vector< const CRPCCommand * > > mapCommands
bool removeCommand(const std::string &name, const CRPCCommand *pcmd)
std::vector< std::string > listCommands() const
Returns a list of registered commands.
UniValue execute(const JSONRPCRequest &request) const
Execute a method.
void appendCommand(const std::string &name, const CRPCCommand *pcmd)
Appends a CRPCCommand to the dispatch table.
std::string help(const std::string &name, const JSONRPCRequest &helpreq) const
UniValue dumpArgMap(const JSONRPCRequest &request) const
Return all named arguments that need to be converted by the client from string to another JSON type.
Different type to mark Mutex at global scope.
JSONRPCVersion m_json_version
enum JSONRPCRequest::Mode mode
std::optional< UniValue > id
virtual RPCTimerBase * NewTimer(std::function< void()> &func, int64_t millis)=0
Factory function for timers.
virtual const char * Name()=0
Implementation name.
void push_back(UniValue val)
const std::string & get_str() const
const std::vector< UniValue > & getValues() const
const std::vector< std::string > & getKeys() const
void pushKV(std::string key, UniValue val)
BCLog::Logger & LogInstance()
#define LogDebug(category,...)
std::vector< std::string > SplitString(std::string_view str, char sep)
UniValue JSONRPCError(int code, const std::string &message)
UniValue JSONRPCReplyObj(UniValue result, UniValue error, std::optional< UniValue > id, JSONRPCVersion jsonrpc_version)
void DeleteAuthCookie()
Delete RPC authentication cookie from disk.
@ RPC_MISC_ERROR
General application defined errors.
@ RPC_TYPE_ERROR
Unexpected type was passed as parameter.
@ RPC_CLIENT_NOT_CONNECTED
P2P client errors.
@ RPC_INVALID_PARAMETER
Invalid, missing or duplicate parameter.
@ RPC_IN_WARMUP
Client still warming up.
std::string HelpExampleCli(const std::string &methodname, const std::string &args)
std::string HelpExampleRpc(const std::string &methodname, const std::string &args)
static const int64_t values[]
A selection of numbers that do not trigger int64_t overflow when added/subtracted.
void RPCSetTimerInterfaceIfUnset(RPCTimerInterface *iface)
Set the factory function for timer, but only, if unset.
bool IsDeprecatedRPCEnabled(const std::string &method)
void SetRPCWarmupFinished()
static RPCHelpMan uptime()
void RPCUnsetTimerInterface(RPCTimerInterface *iface)
Unset factory function for timers.
static RPCHelpMan getrpcinfo()
void RPCRunLater(const std::string &name, std::function< void()> func, int64_t nSeconds)
Run func nSeconds from now.
static bool ExecuteCommands(const std::vector< const CRPCCommand * > &commands, const JSONRPCRequest &request, UniValue &result)
bool RPCIsInWarmup(std::string *outStatus)
static RPCTimerInterface * timerInterface
static bool ExecuteCommand(const CRPCCommand &command, const JSONRPCRequest &request, UniValue &result, bool last_handler)
static std::atomic< bool > g_rpc_running
static JSONRPCRequest transformNamedArguments(const JSONRPCRequest &in, const std::vector< std::pair< std::string, bool > > &argNames)
Process named arguments into a vector of positional arguments, based on the passed-in specification f...
static GlobalMutex g_deadline_timers_mutex
bool IsRPCRunning()
Query whether RPC is running.
UniValue JSONRPCExec(const JSONRPCRequest &jreq, bool catch_errors)
static bool fRPCInWarmup GUARDED_BY(g_rpc_warmup_mutex)
static GlobalMutex g_rpc_warmup_mutex
static RPCServerInfo g_rpc_server_info
static const CRPCCommand vRPCCommands[]
void SetRPCWarmupStatus(const std::string &newStatus)
Set the RPC warmup status.
void RPCSetTimerInterface(RPCTimerInterface *iface)
Set the factory function for timers.
void RpcInterruptionPoint()
Throw JSONRPCError if RPC is not running.
NodeContext & EnsureAnyNodeContext(const std::any &context)
std::string DefaultHint
Hint for default value.
@ OMITTED
Optional argument for which the default value is omitted from help text for one of two reasons:
bool hidden
For testing only.
RPCCommandExecution(const std::string &method)
std::list< RPCCommandExecutionInfo >::iterator it
SteadyClock::time_point start
@ ANY
Special type to disable type checks (for testing only)
std::list< RPCCommandExecutionInfo > active_commands GUARDED_BY(mutex)
#define WITH_LOCK(cs, code)
Run code while locking a mutex.
consteval auto _(util::TranslatedLiteral str)
const UniValue NullUniValue
std::string Capitalize(std::string str)
Capitalizes the first character of the given string.
void UninterruptibleSleep(const std::chrono::microseconds &n)
int64_t GetTime()
DEPRECATED Use either ClockType::now() or Now<TimePointType>() if a cast is needed.