build: require sqlite when building the wallet

Require that sqlite is available in order to compile the wallet. Removes
instances of USE_SQLITE since it is no longer possible to not have
sqlite available.

Co-authored-by: Ava Chow <[email protected]>

CMakeLists.txt

@@ -96,15 +96,13 @@ option(BUILD_UTIL_CHAINSTATE "Build experimental bitcoin-chainstate executable."
 option(BUILD_KERNEL_LIB "Build experimental bitcoinkernel library." ${BUILD_UTIL_CHAINSTATE})
 
 option(ENABLE_WALLET "Enable wallet." ON)
-option(WITH_SQLITE "Enable SQLite wallet support." ${ENABLE_WALLET})
-if(WITH_SQLITE)
+if(ENABLE_WALLET)
   if(VCPKG_TARGET_TRIPLET)
     # Use of the `unofficial::` namespace is a vcpkg package manager convention.
     find_package(unofficial-sqlite3 CONFIG REQUIRED)
   else()
     find_package(SQLite3 3.7.17 REQUIRED)
   endif()
-  set(USE_SQLITE ON)
 endif()
 option(WITH_BDB "Enable Berkeley DB (BDB) wallet support." OFF)
 cmake_dependent_option(WARN_INCOMPATIBLE_BDB "Warn when using a Berkeley DB (BDB) version other than 4.8." ON "WITH_BDB" OFF)
@@ -649,7 +647,6 @@ message("  libbitcoinkernel (experimental) ..... ${BUILD_KERNEL_LIB}")
 message("Optional features:")
 message("  wallet support ...................... ${ENABLE_WALLET}")
 if(ENABLE_WALLET)
-  message("   - descriptor wallets (SQLite) ...... ${WITH_SQLITE}")
   message("   - legacy wallets (Berkeley DB) ..... ${WITH_BDB}")
 endif()
 message("  external signer ..................... ${ENABLE_EXTERNAL_SIGNER}")

cmake/bitcoin-build-config.h.in

@@ -144,7 +144,4 @@
 /* Define if QR support should be compiled in */
 #cmakedefine USE_QRCODE 1
 
-/* Define if sqlite support should be compiled in */
-#cmakedefine USE_SQLITE 1
-
 #endif //BITCOIN_CONFIG_H

doc/build-openbsd.md

@@ -103,7 +103,7 @@ There are many ways to configure Bitcoin Core, here are a few common examples:
 This enables descriptor wallet support and the GUI, assuming SQLite and Qt 5 are installed.
 
 ```bash
-cmake -B build -DWITH_SQLITE=ON -DBUILD_GUI=ON
+cmake -B build -DBUILD_GUI=ON
 ```
 
 Run `cmake -B build -LH` to see the full list of available options.

src/bench/wallet_create.cpp

@@ -3,7 +3,6 @@
 // file COPYING or https://www.opensource.org/licenses/mit-license.php.
 
 #include <bench/bench.h>
-#include <bitcoin-build-config.h> // IWYU pragma: keep
 #include <random.h>
 #include <support/allocators/secure.h>
 #include <test/util/setup_common.h>
@@ -61,9 +60,7 @@ static void WalletCreate(benchmark::Bench& bench, bool encrypted)
 static void WalletCreatePlain(benchmark::Bench& bench) { WalletCreate(bench, /*encrypted=*/false); }
 static void WalletCreateEncrypted(benchmark::Bench& bench) { WalletCreate(bench, /*encrypted=*/true); }
 
-#ifdef USE_SQLITE
 BENCHMARK(WalletCreatePlain, benchmark::PriorityLevel::LOW);
 BENCHMARK(WalletCreateEncrypted, benchmark::PriorityLevel::LOW);
-#endif
 
 } // namespace wallet

src/bench/wallet_ismine.cpp

@@ -75,10 +75,8 @@ static void WalletIsMineLegacy(benchmark::Bench& bench) { WalletIsMine(bench, /*
 BENCHMARK(WalletIsMineLegacy, benchmark::PriorityLevel::LOW);
 #endif
 
-#ifdef USE_SQLITE
 static void WalletIsMineDescriptors(benchmark::Bench& bench) { WalletIsMine(bench, /*legacy_wallet=*/false); }
 static void WalletIsMineMigratedDescriptors(benchmark::Bench& bench) { WalletIsMine(bench, /*legacy_wallet=*/false, /*num_combo=*/2000); }
 BENCHMARK(WalletIsMineDescriptors, benchmark::PriorityLevel::LOW);
 BENCHMARK(WalletIsMineMigratedDescriptors, benchmark::PriorityLevel::LOW);
-#endif
 } // namespace wallet

src/bench/wallet_loading.cpp

@@ -73,8 +73,6 @@ static void WalletLoadingLegacy(benchmark::Bench& bench) { WalletLoading(bench,
 BENCHMARK(WalletLoadingLegacy, benchmark::PriorityLevel::HIGH);
 #endif
 
-#ifdef USE_SQLITE
 static void WalletLoadingDescriptors(benchmark::Bench& bench) { WalletLoading(bench, /*legacy_wallet=*/false); }
 BENCHMARK(WalletLoadingDescriptors, benchmark::PriorityLevel::HIGH);
-#endif
 } // namespace wallet

src/bench/wallet_migration.cpp

@@ -2,8 +2,6 @@
 // Distributed under the MIT software license, see the accompanying
 // file COPYING or https://www.opensource.org/licenses/mit-license.php.
 
-#include <bitcoin-build-config.h> // IWYU pragma: keep
-
 #include <bench/bench.h>
 #include <kernel/chain.h>
 #include <interfaces/chain.h>
@@ -17,8 +15,6 @@
 
 #include <optional>
 
-#if defined(USE_SQLITE) // only enable benchmark when sqlite is enabled
-
 namespace wallet{
 
 static void WalletMigration(benchmark::Bench& bench)
@@ -75,5 +71,3 @@ static void WalletMigration(benchmark::Bench& bench)
 BENCHMARK(WalletMigration, benchmark::PriorityLevel::LOW);
 
 } // namespace wallet
-
-#endif // end USE_SQLITE && USE_BDB

src/qt/bitcoingui.cpp

@@ -1215,11 +1215,6 @@ void BitcoinGUI::setNumBlocks(int count, const QDateTime& blockDate, double nVer
 void BitcoinGUI::createWallet()
 {
 #ifdef ENABLE_WALLET
-#ifndef USE_SQLITE
-    // Compiled without sqlite support (required for descriptor wallets)
-    message(tr("Error creating wallet"), tr("Cannot create new wallet, the software was compiled without sqlite support (required for descriptor wallets)"), CClientUIInterface::MSG_ERROR);
-    return;
-#endif // USE_SQLITE
     auto activity = new CreateWalletActivity(getWalletController(), this);
     connect(activity, &CreateWalletActivity::created, this, &BitcoinGUI::setCurrentWallet);
     connect(activity, &CreateWalletActivity::created, rpcConsole, &RPCConsole::setCurrentWallet);

src/wallet/CMakeLists.txt

@@ -42,17 +42,12 @@ target_link_libraries(bitcoin_wallet
     $<TARGET_NAME_IF_EXISTS:USDT::headers>
 )
 
-if(NOT USE_SQLITE AND NOT USE_BDB)
-  message(FATAL_ERROR "Wallet functionality requested but no BDB or SQLite support available.")
-endif()
-if(USE_SQLITE)
-  target_sources(bitcoin_wallet PRIVATE sqlite.cpp)
-  target_link_libraries(bitcoin_wallet
-    PRIVATE
-      $<TARGET_NAME_IF_EXISTS:unofficial::sqlite3::sqlite3>
-      $<TARGET_NAME_IF_EXISTS:SQLite::SQLite3>
-  )
-endif()
+target_sources(bitcoin_wallet PRIVATE sqlite.cpp)
+target_link_libraries(bitcoin_wallet
+  PRIVATE
+    $<TARGET_NAME_IF_EXISTS:unofficial::sqlite3::sqlite3>
+    $<TARGET_NAME_IF_EXISTS:SQLite::SQLite3>
+)
 if(USE_BDB)
   target_sources(bitcoin_wallet PRIVATE bdb.cpp salvage.cpp)
   target_link_libraries(bitcoin_wallet PUBLIC BerkeleyDB::BerkeleyDB)

src/wallet/init.cpp

@@ -90,11 +90,7 @@ void WalletInit::AddWalletOptions(ArgsManager& argsman) const
     argsman.AddHiddenArgs({"-dblogsize", "-flushwallet", "-privdb", "-swapbdbendian"});
 #endif
 
-#ifdef USE_SQLITE
     argsman.AddArg("-unsafesqlitesync", "Set SQLite synchronous=OFF to disable waiting for the database to sync to disk. This is unsafe and can cause data loss and corruption. This option is only used by tests to improve their performance (default: false)", ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::WALLET_DEBUG_TEST);
-#else
-    argsman.AddHiddenArgs({"-unsafesqlitesync"});
-#endif
 
     argsman.AddArg("-walletrejectlongchains", strprintf("Wallet will not create transactions that violate mempool chain limits (default: %u)", DEFAULT_WALLET_REJECT_LONG_CHAINS), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::WALLET_DEBUG_TEST);
     argsman.AddArg("-walletcrosschain", strprintf("Allow reusing wallet files across chains (default: %u)", DEFAULT_WALLETCROSSCHAIN), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::WALLET_DEBUG_TEST);

src/wallet/rpc/wallet.cpp

@@ -403,9 +403,6 @@ static RPCHelpMan createwallet()
         flags |= WALLET_FLAG_AVOID_REUSE;
     }
     if (self.Arg<bool>("descriptors")) {
-#ifndef USE_SQLITE
-        throw JSONRPCError(RPC_WALLET_ERROR, "Compiled without sqlite support (required for descriptor wallets)");
-#endif
         flags |= WALLET_FLAG_DESCRIPTORS;
     } else {
         if (!context.chain->rpcEnableDeprecated("create_bdb")) {

src/wallet/test/db_tests.cpp

@@ -13,9 +13,7 @@
 #ifdef USE_BDB
 #include <wallet/bdb.h>
 #endif
-#ifdef USE_SQLITE
 #include <wallet/sqlite.h>
-#endif
 #include <wallet/migrate.h>
 #include <wallet/test/util.h>
 #include <wallet/walletutil.h> // for WALLET_FLAG_DESCRIPTORS
@@ -138,9 +136,7 @@ static std::vector<std::unique_ptr<WalletDatabase>> TestDatabases(const fs::path
     // Needs BDB to make the DB to read
     dbs.emplace_back(std::make_unique<BerkeleyRODatabase>(BDBDataFile(path_root / "bdb"), /*open=*/false));
 #endif
-#ifdef USE_SQLITE
     dbs.emplace_back(MakeSQLiteDatabase(path_root / "sqlite", options, status, error));
-#endif
     dbs.emplace_back(CreateMockableWalletDatabase());
     return dbs;
 }
@@ -293,8 +289,6 @@ BOOST_AUTO_TEST_CASE(erase_prefix)
     }
 }
 
-#ifdef USE_SQLITE
-
 // Test-only statement execution error
 constexpr int TEST_SQLITE_ERROR = -999;
 
@@ -385,7 +379,6 @@ BOOST_AUTO_TEST_CASE(concurrent_txn_dont_interfere)
     BOOST_CHECK(handler2->Read(key, read_value));
     BOOST_CHECK_EQUAL(read_value, value2);
 }
-#endif // USE_SQLITE
 
 BOOST_AUTO_TEST_SUITE_END()
 } // namespace wallet

src/wallet/test/fuzz/CMakeLists.txt

@@ -8,9 +8,10 @@ target_sources(fuzz
     coinselection.cpp
     crypter.cpp
     fees.cpp
-    $<$<BOOL:${USE_SQLITE}>:${CMAKE_CURRENT_LIST_DIR}/notifications.cpp>
-    $<$<BOOL:${USE_SQLITE}>:${CMAKE_CURRENT_LIST_DIR}/scriptpubkeyman.cpp>
+    notifications.cpp
+    scriptpubkeyman.cpp
     spend.cpp
+    scriptpubkeyman.cpp
     wallet_bdb_parser.cpp
 )
 target_link_libraries(fuzz bitcoin_wallet)

src/wallet/test/util.h

@@ -27,9 +27,7 @@ class WalletDatabase;
 struct WalletContext;
 
 static const DatabaseFormat DATABASE_FORMATS[] = {
-#ifdef USE_SQLITE
        DatabaseFormat::SQLITE,
-#endif
 #ifdef USE_BDB
        DatabaseFormat::BERKELEY,
 #endif

src/wallet/walletdb.cpp

@@ -22,9 +22,7 @@
 #include <wallet/bdb.h>
 #endif
 #include <wallet/migrate.h>
-#ifdef USE_SQLITE
 #include <wallet/sqlite.h>
-#endif
 #include <wallet/wallet.h>
 
 #include <atomic>
@@ -1464,25 +1462,14 @@ std::unique_ptr<WalletDatabase> MakeDatabase(const fs::path& path, const Databas
 
     // If the format is not specified or detected, choose the default format based on what is available. We prefer BDB over SQLite for now.
     if (!format) {
-#ifdef USE_SQLITE
         format = DatabaseFormat::SQLITE;
-#endif
 #ifdef USE_BDB
         format = DatabaseFormat::BERKELEY;
 #endif
     }
 
     if (format == DatabaseFormat::SQLITE) {
-#ifdef USE_SQLITE
-        if constexpr (true) {
-            return MakeSQLiteDatabase(path, options, status, error);
-        } else
-#endif
-        {
-            error = Untranslated(strprintf("Failed to open database path '%s'. Build does not support SQLite database format.", fs::PathToString(path)));
-            status = DatabaseStatus::FAILED_BAD_FORMAT;
-            return nullptr;
-        }
+        return MakeSQLiteDatabase(path, options, status, error);
     }
 
     if (format == DatabaseFormat::BERKELEY_RO) {

test/CMakeLists.txt

@@ -16,7 +16,6 @@ function(create_test_config)
   endmacro()
 
   set_configure_variable(ENABLE_WALLET ENABLE_WALLET)
-  set_configure_variable(WITH_SQLITE USE_SQLITE)
   set_configure_variable(WITH_BDB USE_BDB)
   set_configure_variable(BUILD_CLI BUILD_BITCOIN_CLI)
   set_configure_variable(BUILD_UTIL BUILD_BITCOIN_UTIL)

test/config.ini.in

@@ -16,7 +16,6 @@ RPCAUTH=@abs_top_srcdir@/share/rpcauth/rpcauth.py
 [components]
 # Which components are enabled. These are commented out by `configure` if they were disabled when running config.
 @ENABLE_WALLET_TRUE@ENABLE_WALLET=true
-@USE_SQLITE_TRUE@USE_SQLITE=true
 @USE_BDB_TRUE@USE_BDB=true
 @BUILD_BITCOIN_CLI_TRUE@ENABLE_CLI=true
 @BUILD_BITCOIN_UTIL_TRUE@ENABLE_BITCOIN_UTIL=true

test/functional/feature_filelock.py

@@ -59,8 +59,7 @@ def check_wallet_filelock(descriptors):
 
             if self.is_bdb_compiled():
                 check_wallet_filelock(False)
-            if self.is_sqlite_compiled():
-                check_wallet_filelock(True)
+            check_wallet_filelock(True)
 
 if __name__ == '__main__':
     FilelockTest(__file__).main()

test/functional/mempool_persist.py

@@ -59,7 +59,7 @@ def set_test_params(self):
 
     def run_test(self):
         self.mini_wallet = MiniWallet(self.nodes[2])
-        if self.is_sqlite_compiled():
+        if self.is_wallet_compiled():
             self.nodes[2].createwallet(
                 wallet_name="watch",
                 descriptors=True,
@@ -73,7 +73,7 @@ def run_test(self):
         tx_creation_time_lower = int(time.time())
         for _ in range(5):
             last_txid = self.mini_wallet.send_self_transfer(from_node=self.nodes[2])["txid"]
-        if self.is_sqlite_compiled():
+        if self.is_wallet_compiled():
             self.nodes[2].syncwithvalidationinterfacequeue()  # Flush mempool to wallet
             node2_balance = wallet_watch.getbalance()
         self.sync_all()
@@ -137,7 +137,7 @@ def run_test(self):
         assert_equal(entry_prioritised_before_restart['fees']['base'] + Decimal('0.00009999'), entry_prioritised_before_restart['fees']['modified'])
 
         # Verify accounting of mempool transactions after restart is correct
-        if self.is_sqlite_compiled():
+        if self.is_wallet_compiled():
             self.nodes[2].loadwallet("watch")
             wallet_watch = self.nodes[2].get_wallet_rpc("watch")
             self.nodes[2].syncwithvalidationinterfacequeue()  # Flush mempool to wallet

test/functional/test_framework/test_framework.py

@@ -229,14 +229,10 @@ def parse_args(self, test_file):
             # So set it to None to force -disablewallet, because the wallet is not needed.
             self.options.descriptors = None
         elif self.options.descriptors is None:
-            # Some wallet is either required or optionally used by the test.
-            # Prefer SQLite unless it isn't available
-            if self.is_sqlite_compiled():
+            if self.is_wallet_compiled():
                 self.options.descriptors = True
-            elif self.is_bdb_compiled():
-                self.options.descriptors = False
             else:
-                # If neither are compiled, tests requiring a wallet will be skipped and the value of self.options.descriptors won't matter
+                # Tests requiring a wallet will be skipped and the value of self.options.descriptors won't matter
                 # It still needs to exist and be None in order for tests to work however.
                 # So set it to None, which will also set -disablewallet.
                 self.options.descriptors = None
@@ -966,16 +962,9 @@ def skip_if_no_wallet(self):
         self._requires_wallet = True
         if not self.is_wallet_compiled():
             raise SkipTest("wallet has not been compiled.")
-        if self.options.descriptors:
-            self.skip_if_no_sqlite()
-        else:
+        if not self.options.descriptors:
             self.skip_if_no_bdb()
 
-    def skip_if_no_sqlite(self):
-        """Skip the running test if sqlite has not been compiled."""
-        if not self.is_sqlite_compiled():
-            raise SkipTest("sqlite has not been compiled.")
-
     def skip_if_no_bdb(self):
         """Skip the running test if BDB has not been compiled."""
         if not self.is_bdb_compiled():
@@ -1030,7 +1019,7 @@ def is_specified_wallet_compiled(self):
         """Checks whether wallet support for the specified type
            (legacy or descriptor wallet) was compiled."""
         if self.options.descriptors:
-            return self.is_sqlite_compiled()
+            return self.is_wallet_compiled()
         else:
             return self.is_bdb_compiled()
 
@@ -1050,10 +1039,6 @@ def is_usdt_compiled(self):
         """Checks whether the USDT tracepoints were compiled."""
         return self.config["components"].getboolean("ENABLE_USDT_TRACEPOINTS")
 
-    def is_sqlite_compiled(self):
-        """Checks whether the wallet module was compiled with Sqlite support."""
-        return self.config["components"].getboolean("USE_SQLITE")
-
     def is_bdb_compiled(self):
         """Checks whether the wallet module was compiled with BDB support."""
         return self.config["components"].getboolean("USE_BDB")

test/functional/tool_wallet.py

@@ -367,8 +367,7 @@ def test_dump_createfromdump(self):
         self.do_tool_createfromdump("load", "wallet.dump")
         if self.is_bdb_compiled():
             self.do_tool_createfromdump("load-bdb", "wallet.dump", "bdb")
-        if self.is_sqlite_compiled():
-            self.do_tool_createfromdump("load-sqlite", "wallet.dump", "sqlite")
+        self.do_tool_createfromdump("load-sqlite", "wallet.dump", "sqlite")
 
         self.log.info('Checking createfromdump handling of magic and versions')
         bad_ver_wallet_dump = self.nodes[0].datadir_path / "wallet-bad_ver1.dump"

test/functional/wallet_avoid_mixing_output_types.py

@@ -127,7 +127,6 @@ def set_test_params(self):
 
     def skip_test_if_missing_module(self):
         self.skip_if_no_wallet()
-        self.skip_if_no_sqlite()
 
     def make_payment(self, A, B, v, addr_type):
         fee_rate = random.randint(1, 20)

test/functional/wallet_descriptor.py

@@ -33,7 +33,6 @@ def set_test_params(self):
 
     def skip_test_if_missing_module(self):
         self.skip_if_no_wallet()
-        self.skip_if_no_sqlite()
         self.skip_if_no_py_sqlite3()
 
     def test_concurrent_writes(self):