Skip to content

Commit fe1e763

Browse files
achow101thepastaclaw
authored andcommitted
Merge bitcoin#28597: wallet: No BDB creation, unless -deprecatedrpc=create_bdb
fa071ae wallet: No BDB creation, unless -deprecatedrpc=create_bdb (MarcoFalke) Pull request description: With BDB being removed soon, it seems confusing and harmful to allow users to create fresh BDB wallets going forward, as it would load them with an additional burden of having to migrate them soon after. Also, it would be good to allow for one release for test (and external) scripts to adapt. Fix all issues by introducing the `-deprecatedrpc=create_bdb` setting. ACKs for top commit: Sjors: tACK fa071ae achow101: ACK fa071ae furszy: utACK fa071ae Tree-SHA512: 37a4c3e4ba659e0ebe2382e71d9c80e42a895d9ad743f5dda7c110fbbb7d2a36f46769982552a9ac0c3a57203379ef164be97aa8033eb7674d6b4da030ba8f9b
1 parent 8ddebd5 commit fe1e763

File tree

4 files changed

+10
-3
lines changed

4 files changed

+10
-3
lines changed

src/rpc/util.cpp

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -579,6 +579,7 @@ TMPL_INST(nullptr, std::optional<bool>, maybe_arg ? std::optional{maybe_arg->get
579579
TMPL_INST(nullptr, const std::string*, maybe_arg ? &maybe_arg->get_str() : nullptr;);
580580

581581
// Required arg or optional arg with default value.
582+
TMPL_INST(CheckRequiredOrDefault, bool, CHECK_NONFATAL(maybe_arg)->get_bool(););
582583
TMPL_INST(CheckRequiredOrDefault, int, CHECK_NONFATAL(maybe_arg)->getInt<int>(););
583584
TMPL_INST(CheckRequiredOrDefault, uint64_t, CHECK_NONFATAL(maybe_arg)->getInt<uint64_t>(););
584585
TMPL_INST(CheckRequiredOrDefault, const std::string&, CHECK_NONFATAL(maybe_arg)->get_str(););

src/wallet/rpc/wallet.cpp

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -635,7 +635,7 @@ static RPCHelpMan createwallet()
635635
{"passphrase", RPCArg::Type::STR, RPCArg::Optional::OMITTED_NAMED_ARG, "Encrypt the wallet with this passphrase."},
636636
{"avoid_reuse", RPCArg::Type::BOOL, RPCArg::Default{false}, "Keep track of coin reuse, and treat dirty and clean coins differently with privacy considerations in mind."},
637637
{"descriptors", RPCArg::Type::BOOL, RPCArg::Default{true}, "Create a native descriptor wallet. The wallet will use descriptors internally to handle address creation."
638-
" Setting to \"false\" will create a legacy wallet; however, the legacy wallet type is being deprecated and"
638+
" Setting to \"false\" will create a legacy wallet; This is only possible with the -deprecatedrpc=create_bdb setting because, the legacy wallet type is being deprecated and"
639639
" support for creating and opening legacy wallets will be removed in the future."},
640640
{"load_on_startup", RPCArg::Type::BOOL, RPCArg::Optional::OMITTED_NAMED_ARG, "Save wallet name to persistent settings and load on startup. True to add wallet to startup list, false to remove, null to leave unchanged."},
641641
{"external_signer", RPCArg::Type::BOOL, RPCArg::Default{false}, "Use an external signer such as a hardware wallet. Requires -signer to be configured. Wallet creation will fail if keys cannot be fetched. Requires disable_private_keys and descriptors set to true."},
@@ -681,11 +681,16 @@ static RPCHelpMan createwallet()
681681
if (!request.params[5].isNull() && request.params[6].isNull()) {
682682
throw JSONRPCError(RPC_INVALID_PARAMETER, "The createwallet RPC requires specifying the 'load_on_startup' flag when param 'descriptors' is specified. Dash Core v21 introduced this requirement due to breaking changes in the createwallet RPC.");
683683
}
684-
if (request.params[5].isNull() || request.params[5].get_bool()) {
684+
if (self.Arg<bool>("descriptors")) {
685685
#ifndef USE_SQLITE
686686
throw JSONRPCError(RPC_WALLET_ERROR, "Compiled without sqlite support (required for descriptor wallets)");
687687
#endif
688688
flags |= WALLET_FLAG_DESCRIPTORS;
689+
} else {
690+
if (!context.chain->rpcEnableDeprecated("create_bdb")) {
691+
throw JSONRPCError(RPC_WALLET_ERROR, "BDB wallet creation is deprecated and will be removed in a future release."
692+
" In this release it can be re-enabled temporarily with the -deprecatedrpc=create_bdb setting.");
693+
}
689694
}
690695
if (!request.params[7].isNull() && request.params[7].get_bool()) {
691696
#ifdef ENABLE_EXTERNAL_SIGNER

test/functional/test_framework/util.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -421,6 +421,7 @@ def write_config(config_path, *, n, chain, extra_config="", disable_autoconnect=
421421
f.write("shrinkdebugfile=0\n")
422422
# To reduce IO and consumed disk storage use tiny size for allocated blk and rev files
423423
f.write("tinyblk=1\n")
424+
f.write("deprecatedrpc=create_bdb\n") # Required to run the tests
424425
# To improve SQLite wallet performance so that the tests don't timeout, use -unsafesqlitesync
425426
f.write("unsafesqlitesync=1\n")
426427
if disable_autoconnect:

test/functional/wallet_createwallet.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ def run_test(self):
175175

176176
if self.is_bdb_compiled():
177177
self.log.info("Test legacy wallet deprecation")
178-
res = self.nodes[0].createwallet(wallet_name="legacy_w0", descriptors=False, load_on_startup=True)
178+
res = self.nodes[0].createwallet(wallet_name="legacy_w0", passphrase=None, descriptors=False, load_on_startup=True)
179179
assert_equal(res["warning"], "Wallet created successfully. The legacy wallet type is being deprecated and support for creating and opening legacy wallets will be removed in the future.")
180180

181181
if __name__ == '__main__':

0 commit comments

Comments
 (0)