Inside Bitcoin

1// Copyright (c) 2024-present The Bitcoin Core developers
2// Distributed under the MIT software license, see the accompanying
3// file COPYING or https://www.opensource.org/licenses/mit-license.php.
4
5#include <addresstype.h>
6#include <bench/bench.h>
7#include <consensus/amount.h>
8#include <interfaces/wallet.h>
9#include <key.h>
10#include <primitives/block.h>
11#include <primitives/transaction.h>
12#include <pubkey.h>
13#include <script/script.h>
14#include <sync.h>
15#include <test/util/setup_common.h>
16#include <tinyformat.h>
17#include <uint256.h>
18#include <util/check.h>
19#include <util/result.h>
20#include <wallet/db.h>
21#include <wallet/scriptpubkeyman.h>
22#include <wallet/test/util.h>
23#include <wallet/transaction.h>
24#include <wallet/wallet.h>
25#include <wallet/walletdb.h>
26
27#include <algorithm>
28#include <cstdint>
29#include <cstddef>
30#include <memory>
31#include <optional>
32#include <string>
33#include <utility>
34#include <vector>
35
36namespace wallet{
37
38static void WalletMigration(benchmark::Bench& bench)
39{
40    const auto test_setup{MakeNoLogFileContext<TestingSetup>()};
41    const auto loader{MakeWalletLoader(*test_setup->m_node.chain, test_setup->m_args)};
42
43    // Number of imported watch only addresses
44    int NUM_WATCH_ONLY_ADDR = 20;
45
46    // Add watch-only addresses
47    std::vector<std::pair<CScript, CTxDestination>> scripts_watch_only;
48    for (int w = 0; w < NUM_WATCH_ONLY_ADDR; ++w) {
49        CKey key = GenerateRandomKey();
50        const PKHash dest{key.GetPubKey()};
51        scripts_watch_only.emplace_back(GetScriptForDestination(dest), dest);
52    }
53
54    // Generate transactions and local addresses
55    std::vector<CKey> keys(500);
56    std::ranges::generate(keys, []{ return GenerateRandomKey(); });
57
58    std::unique_ptr<CWallet> wallet;
59    size_t i = 0;
60    bench.epochs(/*numEpochs=*/1) // run the migration exactly once
61        .setup([&] {
62            // Setup legacy wallet
63            wallet = std::make_unique<CWallet>(test_setup->m_node.chain.get(), std::string(i++, 'A'), CreateMockableWalletDatabase());
64            LegacyDataSPKM* legacy_spkm = wallet->GetOrCreateLegacyDataSPKM();
65            WalletBatch batch{wallet->GetDatabase()};
66
67            LOCK(wallet->cs_wallet);
68
69            // Write a best block record as migration expects one to exist
70            CBlockLocator loc;
71            batch.WriteBestBlock(loc);
72
73            // Add watch-only addresses
74            for (size_t w = 0; w < scripts_watch_only.size(); ++w) {
75                const auto& [script, dest] = scripts_watch_only.at(w);
76                assert(legacy_spkm->LoadWatchOnly(script));
77                assert(wallet->SetAddressBook(dest, strprintf("watch_%d", w), /*purpose=*/std::nullopt));
78                batch.WriteWatchOnly(script, CKeyMetadata());
79            }
80
81            // Generate transactions and local addresses
82            for (size_t j = 0; j < keys.size(); ++j) {
83                const CKey& key = keys.at(j);
84                // Load key, scripts and create address book record
85                CPubKey pubkey = key.GetPubKey();
86                Assert(legacy_spkm->LoadKey(key, pubkey));
87                CTxDestination dest{PKHash(pubkey)};
88                Assert(wallet->SetAddressBook(dest, strprintf("legacy_%d", j), /*purpose=*/std::nullopt));
89
90                CMutableTransaction mtx;
91                mtx.vout.emplace_back(COIN, GetScriptForDestination(dest));
92                mtx.vout.emplace_back(COIN, scripts_watch_only.at(j % NUM_WATCH_ONLY_ADDR).first);
93                // Use distinct dummy prevouts so all txs don't appear to spend the same null outpoint
94                mtx.vin.emplace_back(COutPoint(Txid::FromUint256(uint256{uint8_t(j + 1)}), 0));
95                mtx.vin.emplace_back(COutPoint(Txid::FromUint256(uint256{uint8_t(j + 1)}), 1));
96                wallet->AddToWallet(MakeTransactionRef(mtx), TxStateInactive{}, /*update_wtx=*/nullptr, /*rescanning_old_block=*/true);
97                batch.WriteKey(pubkey, key.GetPrivKey(), CKeyMetadata());
98            }
99        })
100        .run([&] {
101            auto res{MigrateLegacyToDescriptor(std::move(wallet), /*passphrase=*/"", *loader->context())};
102            assert(res);
103            assert(res->wallet);
104            assert(res->watchonly_wallet);
105        });
106}
107
108BENCHMARK(WalletMigration);
109
110} // namespace wallet
111