phantom/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2025-04-29 14:59:39 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

rpc: recommend -rpcclienttimeout=0 for waitfor*

Browse source
This commit is contained in:
Sjors Provoost 2024-08-13 11:51:26 +02:00
parent 77ec072925
commit de7c855b3a
No known key found for this signature in database
GPG key ID: 57FF9BDBCC301009
1 changed files with 6 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
src/rpc/blockchain.cpp
View file

@ -276,7 +276,8 @@ static RPCHelpMan waitfornewblock()
{ {
return RPCHelpMan{"waitfornewblock", return RPCHelpMan{"waitfornewblock",
"\nWaits for any new block and returns useful info about it.\n" "\nWaits for any new block and returns useful info about it.\n"
"\nReturns the current block on timeout or exit.\n", "\nReturns the current block on timeout or exit.\n"
"\nMake sure to use no RPC timeout (bitcoin-cli -rpcclienttimeout=0)",
{ {
{"timeout", RPCArg::Type::NUM, RPCArg::Default{0}, "Time in milliseconds to wait for a response. 0 indicates no timeout."}, {"timeout", RPCArg::Type::NUM, RPCArg::Default{0}, "Time in milliseconds to wait for a response. 0 indicates no timeout."},
}, },
@ -318,7 +319,8 @@ static RPCHelpMan waitforblock()
{ {
return RPCHelpMan{"waitforblock", return RPCHelpMan{"waitforblock",
"\nWaits for a specific new block and returns useful info about it.\n" "\nWaits for a specific new block and returns useful info about it.\n"
"\nReturns the current block on timeout or exit.\n", "\nReturns the current block on timeout or exit.\n"
"\nMake sure to use no RPC timeout (bitcoin-cli -rpcclienttimeout=0)",
{ {
{"blockhash", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "Block hash to wait for."}, {"blockhash", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "Block hash to wait for."},
{"timeout", RPCArg::Type::NUM, RPCArg::Default{0}, "Time in milliseconds to wait for a response. 0 indicates no timeout."}, {"timeout", RPCArg::Type::NUM, RPCArg::Default{0}, "Time in milliseconds to wait for a response. 0 indicates no timeout."},
@ -365,7 +367,8 @@ static RPCHelpMan waitforblockheight()
return RPCHelpMan{"waitforblockheight", return RPCHelpMan{"waitforblockheight",
"\nWaits for (at least) block height and returns the height and hash\n" "\nWaits for (at least) block height and returns the height and hash\n"
"of the current tip.\n" "of the current tip.\n"
"\nReturns the current block on timeout or exit.\n", "\nReturns the current block on timeout or exit.\n"
"\nMake sure to use no RPC timeout (bitcoin-cli -rpcclienttimeout=0)",
{ {
{"height", RPCArg::Type::NUM, RPCArg::Optional::NO, "Block height to wait for."}, {"height", RPCArg::Type::NUM, RPCArg::Optional::NO, "Block height to wait for."},
{"timeout", RPCArg::Type::NUM, RPCArg::Default{0}, "Time in milliseconds to wait for a response. 0 indicates no timeout."}, {"timeout", RPCArg::Type::NUM, RPCArg::Default{0}, "Time in milliseconds to wait for a response. 0 indicates no timeout."},