mirror of
https://github.com/bitcoin/bitcoin.git
synced 2025-04-29 23:09:44 -04:00
a23cca56c0
Rename `BResult` class to `util::Result` and update the class interface to be more compatible with `std::optional` and with a full-featured result class implemented in https://github.com/bitcoin/bitcoin/pull/25665. Motivation for this change is to update existing `BResult` usages now so they don't have to change later when more features are added in #25665. This change makes the following improvements originally implemented in #25665: - More explicit API. Drops potentially misleading `BResult` constructor that treats any bilingual string argument as an error. Adds `util::Error` constructor so it is never ambiguous when a result is being assigned an error or non-error value. - Better type compatibility. Supports `util::Result<bilingual_str>` return values to hold translated messages which are not errors. - More standard and consistent API. `util::Result` supports most of the same operators and methods as `std::optional`. `BResult` had a less familiar interface with `HasRes`/`GetObj`/`ReleaseObj` methods. The Result/Res/Obj naming was also not internally consistent. - Better code organization. Puts `src/util/` code in the `util::` namespace so naming reflects code organization and it is obvious where the class is coming from. Drops "B" from name because it is undocumented what it stands for (bilingual?) - Has unit tests.
127 lines
4 KiB
C++
127 lines
4 KiB
C++
// Copyright (c) 2022 The Bitcoin Core developers
|
|
// Distributed under the MIT software license, see the accompanying
|
|
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
|
|
|
#include <bench/bench.h>
|
|
#include <interfaces/chain.h>
|
|
#include <node/context.h>
|
|
#include <test/util/mining.h>
|
|
#include <test/util/setup_common.h>
|
|
#include <test/util/wallet.h>
|
|
#include <util/translation.h>
|
|
#include <validationinterface.h>
|
|
#include <wallet/context.h>
|
|
#include <wallet/receive.h>
|
|
#include <wallet/wallet.h>
|
|
|
|
#include <optional>
|
|
|
|
using wallet::CWallet;
|
|
using wallet::DatabaseFormat;
|
|
using wallet::DatabaseOptions;
|
|
using wallet::TxStateInactive;
|
|
using wallet::WALLET_FLAG_DESCRIPTORS;
|
|
using wallet::WalletContext;
|
|
using wallet::WalletDatabase;
|
|
|
|
static const std::shared_ptr<CWallet> BenchLoadWallet(std::unique_ptr<WalletDatabase> database, WalletContext& context, DatabaseOptions& options)
|
|
{
|
|
bilingual_str error;
|
|
std::vector<bilingual_str> warnings;
|
|
auto wallet = CWallet::Create(context, "", std::move(database), options.create_flags, error, warnings);
|
|
NotifyWalletLoaded(context, wallet);
|
|
if (context.chain) {
|
|
wallet->postInitProcess();
|
|
}
|
|
return wallet;
|
|
}
|
|
|
|
static void BenchUnloadWallet(std::shared_ptr<CWallet>&& wallet)
|
|
{
|
|
SyncWithValidationInterfaceQueue();
|
|
wallet->m_chain_notifications_handler.reset();
|
|
UnloadWallet(std::move(wallet));
|
|
}
|
|
|
|
static void AddTx(CWallet& wallet)
|
|
{
|
|
CMutableTransaction mtx;
|
|
mtx.vout.push_back({COIN, GetScriptForDestination(*Assert(wallet.GetNewDestination(OutputType::BECH32, "")))});
|
|
mtx.vin.push_back(CTxIn());
|
|
|
|
wallet.AddToWallet(MakeTransactionRef(mtx), TxStateInactive{});
|
|
}
|
|
|
|
static std::unique_ptr<WalletDatabase> DuplicateMockDatabase(WalletDatabase& database, DatabaseOptions& options)
|
|
{
|
|
auto new_database = CreateMockWalletDatabase(options);
|
|
|
|
// Get a cursor to the original database
|
|
auto batch = database.MakeBatch();
|
|
batch->StartCursor();
|
|
|
|
// Get a batch for the new database
|
|
auto new_batch = new_database->MakeBatch();
|
|
|
|
// Read all records from the original database and write them to the new one
|
|
while (true) {
|
|
CDataStream key(SER_DISK, CLIENT_VERSION);
|
|
CDataStream value(SER_DISK, CLIENT_VERSION);
|
|
bool complete;
|
|
batch->ReadAtCursor(key, value, complete);
|
|
if (complete) break;
|
|
new_batch->Write(key, value);
|
|
}
|
|
|
|
return new_database;
|
|
}
|
|
|
|
static void WalletLoading(benchmark::Bench& bench, bool legacy_wallet)
|
|
{
|
|
const auto test_setup = MakeNoLogFileContext<TestingSetup>();
|
|
test_setup->m_args.ForceSetArg("-unsafesqlitesync", "1");
|
|
|
|
WalletContext context;
|
|
context.args = &test_setup->m_args;
|
|
context.chain = test_setup->m_node.chain.get();
|
|
|
|
// Setup the wallet
|
|
// Loading the wallet will also create it
|
|
DatabaseOptions options;
|
|
if (legacy_wallet) {
|
|
options.require_format = DatabaseFormat::BERKELEY;
|
|
} else {
|
|
options.create_flags = WALLET_FLAG_DESCRIPTORS;
|
|
options.require_format = DatabaseFormat::SQLITE;
|
|
}
|
|
auto database = CreateMockWalletDatabase(options);
|
|
auto wallet = BenchLoadWallet(std::move(database), context, options);
|
|
|
|
// Generate a bunch of transactions and addresses to put into the wallet
|
|
for (int i = 0; i < 1000; ++i) {
|
|
AddTx(*wallet);
|
|
}
|
|
|
|
database = DuplicateMockDatabase(wallet->GetDatabase(), options);
|
|
|
|
// reload the wallet for the actual benchmark
|
|
BenchUnloadWallet(std::move(wallet));
|
|
|
|
bench.epochs(5).run([&] {
|
|
wallet = BenchLoadWallet(std::move(database), context, options);
|
|
|
|
// Cleanup
|
|
database = DuplicateMockDatabase(wallet->GetDatabase(), options);
|
|
BenchUnloadWallet(std::move(wallet));
|
|
});
|
|
}
|
|
|
|
#ifdef USE_BDB
|
|
static void WalletLoadingLegacy(benchmark::Bench& bench) { WalletLoading(bench, /*legacy_wallet=*/true); }
|
|
BENCHMARK(WalletLoadingLegacy);
|
|
#endif
|
|
|
|
#ifdef USE_SQLITE
|
|
static void WalletLoadingDescriptors(benchmark::Bench& bench) { WalletLoading(bench, /*legacy_wallet=*/false); }
|
|
BENCHMARK(WalletLoadingDescriptors);
|
|
#endif
|