Persisting and loading wallet records

1251bool RunWithinTxn(WalletDatabase& database, std::string_view process_desc, const std::function<bool(WalletBatch&)>& func)
1252{
1253    WalletBatch batch(database);
1254    return RunWithinTxn(batch, process_desc, func);
1255}
1256
1257bool WalletBatch::WriteAddressPreviouslySpent(const CTxDestination& dest, bool previously_spent)
1258{
1259    auto key{std::make_pair(DBKeys::DESTDATA, std::make_pair(EncodeDestination(dest), std::string("used")))};
1260    return previously_spent ? WriteIC(key, std::string("1")) : EraseIC(key);
1261}
1262
1263bool WalletBatch::WriteAddressReceiveRequest(const CTxDestination& dest, const std::string& id, const std::string& receive_request)
1264{
1265    return WriteIC(std::make_pair(DBKeys::DESTDATA, std::make_pair(EncodeDestination(dest), "rr" + id)), receive_request);
1266}
1267
1268bool WalletBatch::EraseAddressReceiveRequest(const CTxDestination& dest, const std::string& id)
1269{
1270    return EraseIC(std::make_pair(DBKeys::DESTDATA, std::make_pair(EncodeDestination(dest), "rr" + id)));
1271}
1272
1273bool WalletBatch::EraseAddressData(const CTxDestination& dest)
1274{
1275    DataStream prefix;
1276    prefix << DBKeys::DESTDATA << EncodeDestination(dest);
1277    return m_batch->ErasePrefix(prefix);
1278}
1279
1280bool WalletBatch::WriteWalletFlags(const uint64_t flags)
1281{
1282    return WriteIC(DBKeys::FLAGS, flags);
1283}
1284
1285bool WalletBatch::EraseRecords(const std::unordered_set<std::string>& types)
1286{
1287    return std::all_of(types.begin(), types.end(), [&](const std::string& type) {
1288        return m_batch->ErasePrefix(DataStream() << type);
1289    });
1290}
1291
1292bool WalletBatch::TxnBegin()
1293{
1294    return m_batch->TxnBegin();
1295}
1296
1297bool WalletBatch::TxnCommit()
1298{
1299    bool res = m_batch->TxnCommit();
1300    if (res) {
1301        for (const auto& listener : m_txn_listeners) {
1302            listener.on_commit();
1303        }
1304        // txn finished, clear listeners
1305        m_txn_listeners.clear();
1306    }
1307    return res;
1308}
1309
1310bool WalletBatch::TxnAbort()
1311{
1312    bool res = m_batch->TxnAbort();
1313    if (res) {
1314        for (const auto& listener : m_txn_listeners) {
1315            listener.on_abort();
1316        }
1317        // txn finished, clear listeners
1318        m_txn_listeners.clear();
1319    }
1320    return res;
1321}
1322
1323void WalletBatch::RegisterTxnListener(const DbTxnListener& l)
1324{
1325    assert(m_batch->HasActiveTxn());
1326    m_txn_listeners.emplace_back(l);
1327}
1328
1329std::unique_ptr<WalletDatabase> MakeDatabase(const fs::path& path, const DatabaseOptions& options, DatabaseStatus& status, bilingual_str& error)
1330{
1331    bool exists;
1332    try {
1333        exists = fs::symlink_status(path).type() != fs::file_type::not_found;
1334    } catch (const fs::filesystem_error& e) {
1335        error = Untranslated(strprintf("Failed to access database path '%s': %s", fs::PathToString(path), e.code().message()));
1336        status = DatabaseStatus::FAILED_BAD_PATH;
1337        return nullptr;
1338    }
1339
1340    std::optional<DatabaseFormat> format;
1341    if (exists) {
1342        if (IsBDBFile(BDBDataFile(path))) {
1343            format = DatabaseFormat::BERKELEY_RO;
1344        }
1345        if (IsSQLiteFile(SQLiteDataFile(path))) {
1346            if (format) {
1347                error = Untranslated(strprintf("Failed to load database path '%s'. Data is in ambiguous format.", fs::PathToString(path)));
1348                status = DatabaseStatus::FAILED_BAD_FORMAT;
1349                return nullptr;
1350            }
1351            format = DatabaseFormat::SQLITE;
1352        }
1353    } else if (options.require_existing) {
1354        error = Untranslated(strprintf("Failed to load database path '%s'. Path does not exist.", fs::PathToString(path)));
1355        status = DatabaseStatus::FAILED_NOT_FOUND;
1356        return nullptr;
1357    }
1358
1359    if (!format && options.require_existing) {
1360        error = Untranslated(strprintf("Failed to load database path '%s'. Data is not in recognized format.", fs::PathToString(path)));
1361        status = DatabaseStatus::FAILED_BAD_FORMAT;
1362        return nullptr;
1363    }
1364
1365    if (format && options.require_create) {
1366        error = Untranslated(strprintf("Failed to create database path '%s'. Database already exists.", fs::PathToString(path)));
1367        status = DatabaseStatus::FAILED_ALREADY_EXISTS;
1368        return nullptr;
1369    }
1370
1371    // BERKELEY_RO can only be opened if require_format was set, which only occurs in migration.
1372    if (format && format == DatabaseFormat::BERKELEY_RO && (!options.require_format || options.require_format != DatabaseFormat::BERKELEY_RO)) {
1373        error = Untranslated(strprintf("Failed to open database path '%s'. The wallet appears to be a Legacy wallet, please use the wallet migration tool (migratewallet RPC or the GUI option).", fs::PathToString(path)));
1374        status = DatabaseStatus::FAILED_LEGACY_DISABLED;
1375        return nullptr;
1376    }
1377
1378    // A db already exists so format is set, but options also specifies the format, so make sure they agree
1379    if (format && options.require_format && format != options.require_format) {
1380        error = Untranslated(strprintf("Failed to load database path '%s'. Data is not in required format.", fs::PathToString(path)));
1381        status = DatabaseStatus::FAILED_BAD_FORMAT;
1382        return nullptr;
1383    }
1384
1385    // Format is not set when a db doesn't already exist, so use the format specified by the options if it is set.
1386    if (!format && options.require_format) format = options.require_format;
1387
1388    if (!format) {
1389        format = DatabaseFormat::SQLITE;
1390    }
1391
1392    if (format == DatabaseFormat::SQLITE) {
1393        return MakeSQLiteDatabase(path, options, status, error);
1394    }
1395
1396    if (format == DatabaseFormat::BERKELEY_RO) {
1397        return MakeBerkeleyRODatabase(path, options, status, error);
1398    }
1399
1400    error = Untranslated(STR_INTERNAL_BUG("Could not determine wallet format"));
1401    status = DatabaseStatus::FAILED_BAD_FORMAT;
1402    return nullptr;
1403}
1404} // namespace wallet
1405