Bitcoin Core 28.99.0
P2P Digital Currency
wallet_ismine.cpp
Go to the documentation of this file.
1// Copyright (c) 2022 The Bitcoin Core developers
2// Distributed under the MIT software license, see the accompanying
3// file COPYING or http://www.opensource.org/licenses/mit-license.php.
4
5#include <addresstype.h>
6#include <bench/bench.h>
7#include <bitcoin-build-config.h> // IWYU pragma: keep
8#include <key.h>
9#include <key_io.h>
10#include <script/descriptor.h>
11#include <script/script.h>
13#include <sync.h>
15#include <wallet/context.h>
16#include <wallet/db.h>
17#include <wallet/test/util.h>
18#include <wallet/types.h>
19#include <wallet/wallet.h>
20#include <wallet/walletutil.h>
21
22#include <cassert>
23#include <cstdint>
24#include <memory>
25#include <string>
26#include <utility>
27
28namespace wallet {
29static void WalletIsMine(benchmark::Bench& bench, bool legacy_wallet, int num_combo = 0)
30{
31 const auto test_setup = MakeNoLogFileContext<TestingSetup>();
32
33 WalletContext context;
34 context.args = &test_setup->m_args;
35 context.chain = test_setup->m_node.chain.get();
36
37 // Setup the wallet
38 // Loading the wallet will also create it
39 uint64_t create_flags = 0;
40 if (!legacy_wallet) {
41 create_flags = WALLET_FLAG_DESCRIPTORS;
42 }
43 auto database = CreateMockableWalletDatabase();
44 auto wallet = TestLoadWallet(std::move(database), context, create_flags);
45
46 // For a descriptor wallet, fill with num_combo combo descriptors with random keys
47 // This benchmarks a non-HD wallet migrated to descriptors
48 if (!legacy_wallet && num_combo > 0) {
49 LOCK(wallet->cs_wallet);
50 for (int i = 0; i < num_combo; ++i) {
51 CKey key;
52 key.MakeNewKey(/*fCompressed=*/true);
54 std::string error;
55 std::vector<std::unique_ptr<Descriptor>> desc = Parse("combo(" + EncodeSecret(key) + ")", keys, error, /*require_checksum=*/false);
56 WalletDescriptor w_desc(std::move(desc.at(0)), /*creation_time=*/0, /*range_start=*/0, /*range_end=*/0, /*next_index=*/0);
57 auto spkm = wallet->AddWalletDescriptor(w_desc, keys, /*label=*/"", /*internal=*/false);
58 assert(spkm);
59 }
60 }
61
63
64 bench.run([&] {
65 LOCK(wallet->cs_wallet);
66 isminetype mine = wallet->IsMine(script);
67 assert(mine == ISMINE_NO);
68 });
69
70 TestUnloadWallet(std::move(wallet));
71}
72
73#ifdef USE_BDB
74static void WalletIsMineLegacy(benchmark::Bench& bench) { WalletIsMine(bench, /*legacy_wallet=*/true); }
75BENCHMARK(WalletIsMineLegacy, benchmark::PriorityLevel::LOW);
76#endif
77
78#ifdef USE_SQLITE
79static void WalletIsMineDescriptors(benchmark::Bench& bench) { WalletIsMine(bench, /*legacy_wallet=*/false); }
80static void WalletIsMineMigratedDescriptors(benchmark::Bench& bench) { WalletIsMine(bench, /*legacy_wallet=*/false, /*num_combo=*/2000); }
81BENCHMARK(WalletIsMineDescriptors, benchmark::PriorityLevel::LOW);
82BENCHMARK(WalletIsMineMigratedDescriptors, benchmark::PriorityLevel::LOW);
83#endif
84} // namespace wallet
CScript GetScriptForDestination(const CTxDestination &dest)
Generate a Bitcoin scriptPubKey for the given CTxDestination.
An encapsulated private key.
Definition: key.h:35
void MakeNewKey(bool fCompressed)
Generate a new private key using a cryptographic PRNG.
Definition: key.cpp:161
Serialized script, used inside transaction inputs and outputs.
Definition: script.h:415
Main entry point to nanobench's benchmarking facility.
Definition: nanobench.h:627
Bench & run(char const *benchmarkName, Op &&op)
Repeatedly calls op() based on the configuration, and performs measurements.
Definition: nanobench.h:1234
Descriptor with some wallet metadata.
Definition: walletutil.h:85
static UniValue Parse(std::string_view raw)
Parse string to UniValue or throw runtime_error if string contains invalid JSON.
Definition: client.cpp:327
CTxDestination DecodeDestination(const std::string &str, std::string &error_msg, std::vector< int > *error_locations)
Definition: key_io.cpp:299
std::string EncodeSecret(const CKey &key)
Definition: key_io.cpp:231
@ LOW
Definition: bench.h:47
BENCHMARK(WalletBalanceDirty, benchmark::PriorityLevel::HIGH)
const std::string ADDRESS_BCRT1_UNSPENDABLE
Definition: util.h:37
std::shared_ptr< CWallet > TestLoadWallet(std::unique_ptr< WalletDatabase > database, WalletContext &context, uint64_t create_flags)
Definition: util.cpp:50
static void WalletIsMine(benchmark::Bench &bench, bool legacy_wallet, int num_combo=0)
void TestUnloadWallet(std::shared_ptr< CWallet > &&wallet)
Definition: util.cpp:73
std::unique_ptr< WalletDatabase > CreateMockableWalletDatabase(MockableData records)
Definition: util.cpp:186
isminetype
IsMine() return codes, which depend on ScriptPubKeyMan implementation.
Definition: types.h:41
@ ISMINE_NO
Definition: types.h:42
@ WALLET_FLAG_DESCRIPTORS
Indicate that this wallet supports DescriptorScriptPubKeyMan.
Definition: walletutil.h:74
WalletContext struct containing references to state shared between CWallet instances,...
Definition: context.h:36
interfaces::Chain * chain
Definition: context.h:37
ArgsManager * args
Definition: context.h:39
#define LOCK(cs)
Definition: sync.h:257
assert(!tx.IsCoinBase())
is a home for public enum and struct type definitions that are used by internally by wallet code,...