Skip to content

Commit 3a32b62

Browse files
author
MarcoFalke
committed
Merge #20462: RPC/Wallet: unloadwallet: Clarify docs/error when both the RPC request and wallet_name parameter specify a wallet
b1f59d5 RPC/Wallet: unloadwallet: Clarify docs/error when both the RPC endpoint and wallet_name parameter specify a wallet (Luke Dashjr) Pull request description: Just documentation clarifications from #20448 ACKs for top commit: MarcoFalke: review ACK b1f59d5 jonatack: re-ACK b1f59d5 per `git diff e8303a0 b1f59d5` Tree-SHA512: ac068b0aa7ceed49496367fdd9425b59dbba18b56e89b26afc22a6c8ece51f0b92a169cacd55740b1cadab2b32f4f8e8700e609066ab7e59d3b53c7891da585e
2 parents 6f9dac5 + b1f59d5 commit 3a32b62

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

src/wallet/rpcwallet.cpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2791,7 +2791,7 @@ static RPCHelpMan unloadwallet()
27912791
"Unloads the wallet referenced by the request endpoint otherwise unloads the wallet specified in the argument.\n"
27922792
"Specifying the wallet name on a wallet endpoint is invalid.",
27932793
{
2794-
{"wallet_name", RPCArg::Type::STR, /* default */ "the wallet name from the RPC request", "The name of the wallet to unload."},
2794+
{"wallet_name", RPCArg::Type::STR, /* default */ "the wallet name from the RPC endpoint", "The name of the wallet to unload. Must be provided in the RPC endpoint or this parameter (but not both)."},
27952795
{"load_on_startup", RPCArg::Type::BOOL, /* default */ "null", "Save wallet name to persistent settings and load on startup. True to add wallet to startup list, false to remove, null to leave unchanged."},
27962796
},
27972797
RPCResult{RPCResult::Type::OBJ, "", "", {
@@ -2806,7 +2806,7 @@ static RPCHelpMan unloadwallet()
28062806
std::string wallet_name;
28072807
if (GetWalletNameFromJSONRPCRequest(request, wallet_name)) {
28082808
if (!request.params[0].isNull()) {
2809-
throw JSONRPCError(RPC_INVALID_PARAMETER, "Cannot unload the requested wallet");
2809+
throw JSONRPCError(RPC_INVALID_PARAMETER, "Both the RPC endpoint wallet and wallet_name parameter were provided (only one allowed)");
28102810
}
28112811
} else {
28122812
wallet_name = request.params[0].get_str();

test/functional/wallet_multiwallet.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -355,7 +355,8 @@ def wallet_file(name):
355355
assert_raises_rpc_error(-1, "JSON value is not a string as expected", self.nodes[0].unloadwallet)
356356
assert_raises_rpc_error(-18, "Requested wallet does not exist or is not loaded", self.nodes[0].unloadwallet, "dummy")
357357
assert_raises_rpc_error(-18, "Requested wallet does not exist or is not loaded", node.get_wallet_rpc("dummy").unloadwallet)
358-
assert_raises_rpc_error(-8, "Cannot unload the requested wallet", w1.unloadwallet, "w2"),
358+
assert_raises_rpc_error(-8, "Both the RPC endpoint wallet and wallet_name parameter were provided (only one allowed)", w1.unloadwallet, "w2"),
359+
assert_raises_rpc_error(-8, "Both the RPC endpoint wallet and wallet_name parameter were provided (only one allowed)", w1.unloadwallet, "w1"),
359360

360361
# Successfully unload the specified wallet name
361362
self.nodes[0].unloadwallet("w1")

0 commit comments

Comments
 (0)