bitcoin-cli: note -rpcclienttimeout is not implemented for IPC connections
What the developer wrote
Authored by Ryan Ofsky
bitcoin-cli: note -rpcclienttimeout is not implemented for IPC connections
The `-rpcclienttimeout` option applies only to HTTP connections. When
`bitcoin-cli` connects via IPC, the timeout is silently ignored. Clarify this
in the help string.
Noted by pinheadmz in
https://github.com/bitcoin/bitcoin/pull/32297#pullrequestreview-3922849038
What changed, and why it matters
This commit only updates a help text string in bitcoin-cli. It clarifies that the -rpcclienttimeout option does not work for local inter-process (IPC) connections. There is no code behavior change and no security fix.
No security action needed. Treat as a normal documentation/help-string improvement.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The change is a one-line string update in src/bitcoin-cli.cpp: the help description for -rpcclienttimeout now states it is not implemented for IPC connections. The underlying behavior (timeout ignored for IPC) already existed; the patch only documents it. No logic, parsing, networking, or authorization code is modified.
Changed components
src/bitcoin-cli.cpp help text for -rpcclienttimeoutInspect captured patch +1 / −1
diff --git a/src/bitcoin-cli.cpp b/src/bitcoin-cli.cpp
index 3455aea7..2ee52779 100644
--- a/src/bitcoin-cli.cpp
+++ b/src/bitcoin-cli.cpp
@@ -102,7 +102,7 @@ static void SetupCliArgs(ArgsManager& argsman)
argsman.AddArg("-color=<when>", strprintf("Color setting for CLI output (default: %s). Valid values: always, auto (add color codes when standard output is connected to a terminal and OS is not WIN32), never. Only applies to the output of -getinfo.", DEFAULT_COLOR_SETTING), ArgsManager::ALLOW_ANY | ArgsManager::DISALLOW_NEGATION, OptionsCategory::OPTIONS);
argsman.AddArg("-named", strprintf("Pass named instead of positional arguments (default: %s)", DEFAULT_NAMED), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
argsman.AddArg("-rpcid=<id>", strprintf("Set a custom JSON-RPC request ID string (default: %s)", DEFAULT_RPC_REQ_ID), ArgsManager::ALLOW_ANY | ArgsManager::DISALLOW_NEGATION | ArgsManager::DISALLOW_ELISION, OptionsCategory::OPTIONS);
- argsman.AddArg("-rpcclienttimeout=<n>", strprintf("Timeout in seconds during HTTP requests, or 0 for no timeout. (default: %d)", DEFAULT_HTTP_CLIENT_TIMEOUT), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
+ argsman.AddArg("-rpcclienttimeout=<n>", strprintf("Timeout in seconds during HTTP requests, or 0 for no timeout. Not implemented for IPC connections (see -ipcconnect). (default: %d)", DEFAULT_HTTP_CLIENT_TIMEOUT), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
argsman.AddArg("-rpcconnect=<ip>", strprintf("Send commands to node running on <ip> (default: %s)", DEFAULT_RPCCONNECT), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
argsman.AddArg("-rpccookiefile=<loc>", "Location of the auth cookie. Relative paths will be prefixed by a net-specific datadir location. (default: data dir)", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
argsman.AddArg("-rpcpassword=<pw>", "Password for JSON-RPC connections", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.