READ THE CODE

Inside Bitcoin

The code behind the network, with room to understand it.

Stable release v32.1bitcoin/bitcoin · f0de87f04062 ↗3,020 source files · 47.5 MB stored on the server440 file guides

Release published 2026-10-28 · Snapshot fetched 2026-11-01. Latest stable release at fetch time; development branches and Git history are excluded. Only the selected code window and visible folders load here.

33,624 bytes · SHA-256 f4f05aa877eb5763… · View upstream ↗

1// Copyright (c) 2012-present 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 <wallet/wallet.h>
6
7#include <cstdint>
8#include <future>
9#include <memory>
10#include <vector>
11
12#include <addresstype.h>
13#include <interfaces/chain.h>
14#include <key_io.h>
15#include <node/blockstorage.h>
16#include <node/types.h>
17#include <policy/policy.h>
18#include <rpc/server.h>
19#include <script/solver.h>
20#include <test/util/common.h>
21#include <test/util/logging.h>
22#include <test/util/random.h>
23#include <test/util/setup_common.h>
24#include <util/translation.h>
25#include <validation.h>
26#include <validationinterface.h>
27#include <wallet/coincontrol.h>
28#include <wallet/context.h>
29#include <wallet/receive.h>
30#include <wallet/spend.h>
31#include <wallet/test/util.h>
32#include <wallet/test/wallet_test_fixture.h>
33
34#include <boost/test/unit_test.hpp>
35#include <univalue.h>
36
37using node::MAX_BLOCKFILE_SIZE;
38
39namespace wallet {
40
41// Ensure that fee levels defined in the wallet are at least as high
42// as the default levels for node policy.
43static_assert(DEFAULT_TRANSACTION_MINFEE >= DEFAULT_MIN_RELAY_TX_FEE, "wallet minimum fee is smaller than default relay fee");
44static_assert(WALLET_INCREMENTAL_RELAY_FEE >= DEFAULT_INCREMENTAL_RELAY_FEE, "wallet incremental fee is smaller than default incremental relay fee");
45
46BOOST_FIXTURE_TEST_SUITE(wallet_tests, WalletTestingSetup)
47
48static CMutableTransaction TestSimpleSpend(const CTransaction& from, uint32_t index, const CKey& key, const CScript& pubkey)
49{
50    CMutableTransaction mtx;
51    mtx.vout.emplace_back(from.vout[index].nValue - DEFAULT_TRANSACTION_MAXFEE, pubkey);
52    mtx.vin.push_back({CTxIn{from.GetHash(), index}});
53    FillableSigningProvider keystore;
54    keystore.AddKey(key);
55    std::map<COutPoint, Coin> coins;
56    coins[mtx.vin[0].prevout].out = from.vout[index];
57    std::map<int, bilingual_str> input_errors;
58    BOOST_CHECK(SignTransaction(mtx, &keystore, coins, {.sighash_type = SIGHASH_ALL}, input_errors));
59    return mtx;
60}
61
62static void AddKey(CWallet& wallet, const CKey& key)
63{
64    LOCK(wallet.cs_wallet);
65    FlatSigningProvider provider;
66    std::string error;
67    auto descs = Parse("combo(" + EncodeSecret(key) + ")", provider, error, /* require_checksum=*/ false);
68    assert(descs.size() == 1);
69    auto& desc = descs.at(0);
70    WalletDescriptor w_desc(std::move(desc), 0, 0, 1, 1);
71    Assert(wallet.AddWalletDescriptor(w_desc, provider, "", false));
72}
73
74BOOST_FIXTURE_TEST_CASE(update_non_range_descriptor, TestingSetup)
75{
76    CWallet wallet(m_node.chain.get(), "", CreateMockableWalletDatabase());
77    {
78        LOCK(wallet.cs_wallet);
79        wallet.SetWalletFlag(WALLET_FLAG_DESCRIPTORS);
80        auto key{GenerateRandomKey()};
81        auto desc_str{"combo(" + EncodeSecret(key) + ")"};
82        FlatSigningProvider provider;
83        std::string error;
84        auto descs{Parse(desc_str, provider, error, /* require_checksum=*/ false)};
85        auto& desc{descs.at(0)};
86        WalletDescriptor w_desc{std::move(desc), 0, 0, 0, 0};
87        BOOST_CHECK(wallet.AddWalletDescriptor(w_desc, provider, "", false));
88        // Wallet should update the non-range descriptor successfully
89        BOOST_CHECK(wallet.AddWalletDescriptor(w_desc, provider, "", false));
90    }
91}
92
93BOOST_FIXTURE_TEST_CASE(scan_for_wallet_transactions, TestChain100Setup)
94{
95    // Cap last block file size, and mine new block in a new block file.
96    CBlockIndex* oldTip = WITH_LOCK(Assert(m_node.chainman)->GetMutex(), return m_node.chainman->ActiveChain().Tip());
97    WITH_LOCK(::cs_main, m_node.chainman->m_blockman.GetBlockFileInfo(oldTip->GetBlockPos().nFile)->nSize = MAX_BLOCKFILE_SIZE);
98    CreateAndProcessBlock({}, GetScriptForRawPubKey(coinbaseKey.GetPubKey()));
99    CBlockIndex* newTip = WITH_LOCK(Assert(m_node.chainman)->GetMutex(), return m_node.chainman->ActiveChain().Tip());
100
101    // Verify ScanForWalletTransactions fails to read an unknown start block.
102    {
103        CWallet wallet(m_node.chain.get(), "", CreateMockableWalletDatabase());
104        {
105            LOCK(wallet.cs_wallet);
106            LOCK(Assert(m_node.chainman)->GetMutex());
107            wallet.SetWalletFlag(WALLET_FLAG_DESCRIPTORS);
108            wallet.SetLastBlockProcessed(m_node.chainman->ActiveChain().Height(), m_node.chainman->ActiveChain().Tip()->GetBlockHash());
109        }
110        AddKey(wallet, coinbaseKey);
111        WalletRescanReserver reserver(wallet);
112        reserver.reserve();
113        CWallet::ScanResult result = wallet.ScanForWalletTransactions(/*start_block=*/{}, /*start_height=*/0, /*max_height=*/{}, reserver, /*save_progress=*/false);
114        BOOST_CHECK_EQUAL(result.status, CWallet::ScanResult::FAILURE);
115        BOOST_CHECK(result.last_failed_block.IsNull());
116        BOOST_CHECK(result.last_scanned_block.IsNull());
117        BOOST_CHECK(!result.last_scanned_height);
118        BOOST_CHECK_EQUAL(GetBalance(wallet).m_mine_immature, 0);
119    }
120
121    // Verify ScanForWalletTransactions picks up transactions in both the old
122    // and new block files.
123    {
124        CWallet wallet(m_node.chain.get(), "", CreateMockableWalletDatabase());
125        {
126            LOCK(wallet.cs_wallet);
127            LOCK(Assert(m_node.chainman)->GetMutex());
128            wallet.SetWalletFlag(WALLET_FLAG_DESCRIPTORS);
129            wallet.SetLastBlockProcessed(newTip->nHeight, newTip->GetBlockHash());
130        }
131        AddKey(wallet, coinbaseKey);
132        WalletRescanReserver reserver(wallet);
133        std::chrono::steady_clock::time_point fake_time;
134        reserver.setNow([&] { fake_time += 60s; return fake_time; });
135        reserver.reserve();
136
137        {
138            CBlockLocator locator;
139            BOOST_CHECK(WalletBatch{wallet.GetDatabase()}.ReadBestBlock(locator));
140            BOOST_REQUIRE(!locator.IsNull());
141            BOOST_CHECK(locator.vHave.front() == newTip->GetBlockHash());
142        }
143
144        CWallet::ScanResult result = wallet.ScanForWalletTransactions(/*start_block=*/oldTip->GetBlockHash(), /*start_height=*/oldTip->nHeight, /*max_height=*/{}, reserver, /*save_progress=*/true);
145        BOOST_CHECK_EQUAL(result.status, CWallet::ScanResult::SUCCESS);
146        BOOST_CHECK(result.last_failed_block.IsNull());
147        BOOST_CHECK_EQUAL(result.last_scanned_block, newTip->GetBlockHash());
148        BOOST_CHECK_EQUAL(*result.last_scanned_height, newTip->nHeight);
149        BOOST_CHECK_EQUAL(GetBalance(wallet).m_mine_immature, 100 * COIN);
150
151        {
152            CBlockLocator locator;
153            BOOST_CHECK(WalletBatch{wallet.GetDatabase()}.ReadBestBlock(locator));
154            BOOST_REQUIRE(!locator.IsNull());
155            BOOST_CHECK(locator.vHave.front() == newTip->GetBlockHash());
156        }
157    }
158
159    // Prune the older block file.
160    int file_number;
161    {
162        LOCK(cs_main);
163        file_number = oldTip->GetBlockPos().nFile;
164        Assert(m_node.chainman)->m_blockman.PruneOneBlockFile(file_number);
165    }
166    m_node.chainman->m_blockman.UnlinkPrunedFiles({file_number});
167
168    // Verify ScanForWalletTransactions only picks transactions in the new block
169    // file.
170    {
171        CWallet wallet(m_node.chain.get(), "", CreateMockableWalletDatabase());
172        {
173            LOCK(wallet.cs_wallet);
174            LOCK(Assert(m_node.chainman)->GetMutex());
175            wallet.SetWalletFlag(WALLET_FLAG_DESCRIPTORS);
176            wallet.SetLastBlockProcessed(m_node.chainman->ActiveChain().Height(), m_node.chainman->ActiveChain().Tip()->GetBlockHash());
177        }
178        AddKey(wallet, coinbaseKey);
179        WalletRescanReserver reserver(wallet);
180        reserver.reserve();
181        CWallet::ScanResult result = wallet.ScanForWalletTransactions(/*start_block=*/oldTip->GetBlockHash(), /*start_height=*/oldTip->nHeight, /*max_height=*/{}, reserver, /*save_progress=*/false);
182        BOOST_CHECK_EQUAL(result.status, CWallet::ScanResult::FAILURE);
183        BOOST_CHECK_EQUAL(result.last_failed_block, oldTip->GetBlockHash());
184        BOOST_CHECK_EQUAL(result.last_scanned_block, newTip->GetBlockHash());
185        BOOST_CHECK_EQUAL(*result.last_scanned_height, newTip->nHeight);
186        BOOST_CHECK_EQUAL(GetBalance(wallet).m_mine_immature, 50 * COIN);
187    }
188
189    // Prune the remaining block file.
190    {
191        LOCK(cs_main);
192        file_number = newTip->GetBlockPos().nFile;
193        Assert(m_node.chainman)->m_blockman.PruneOneBlockFile(file_number);
194    }
195    m_node.chainman->m_blockman.UnlinkPrunedFiles({file_number});
196
197    // Verify ScanForWalletTransactions scans no blocks.
198    {
199        CWallet wallet(m_node.chain.get(), "", CreateMockableWalletDatabase());
200        {
201            LOCK(wallet.cs_wallet);
202            LOCK(Assert(m_node.chainman)->GetMutex());
203            wallet.SetWalletFlag(WALLET_FLAG_DESCRIPTORS);
204            wallet.SetLastBlockProcessed(m_node.chainman->ActiveChain().Height(), m_node.chainman->ActiveChain().Tip()->GetBlockHash());
205        }
206        AddKey(wallet, coinbaseKey);
207        WalletRescanReserver reserver(wallet);
208        reserver.reserve();
209        CWallet::ScanResult result = wallet.ScanForWalletTransactions(/*start_block=*/oldTip->GetBlockHash(), /*start_height=*/oldTip->nHeight, /*max_height=*/{}, reserver, /*save_progress=*/false);
210        BOOST_CHECK_EQUAL(result.status, CWallet::ScanResult::FAILURE);
211        BOOST_CHECK_EQUAL(result.last_failed_block, newTip->GetBlockHash());
212        BOOST_CHECK(result.last_scanned_block.IsNull());
213        BOOST_CHECK(!result.last_scanned_height);
214        BOOST_CHECK_EQUAL(GetBalance(wallet).m_mine_immature, 0);
215    }
216}
217
218BOOST_FIXTURE_TEST_CASE(scan_for_wallet_transactions_abort, TestChain100Setup)
219{
220    CWallet wallet(m_node.chain.get(), "", CreateMockableWalletDatabase());
221    uint256 genesis_hash;
222    {
223        LOCK(wallet.cs_wallet);
224        LOCK(Assert(m_node.chainman)->GetMutex());
225        wallet.SetWalletFlag(WALLET_FLAG_DESCRIPTORS);
226        wallet.SetLastBlockProcessed(m_node.chainman->ActiveChain().Height(), m_node.chainman->ActiveChain().Tip()->GetBlockHash());
227        genesis_hash = m_node.chainman->ActiveChain().Genesis()->GetBlockHash();
228    }
229
230    // An abort requested while no rescan is held is stale and must
231    // not cancel a later scan.
232    wallet.AbortRescan();
233    WalletRescanReserver reserver(wallet);
234    BOOST_CHECK(reserver.reserve());
235    BOOST_CHECK(!wallet.IsAbortingRescan());
236
237    // An abort requested after the reservation but before the scan starts
238    // (e.g. while importdescriptors is still deriving keys) must cancel the
239    // scan.
240    wallet.AbortRescan();
241    CWallet::ScanResult result = wallet.ScanForWalletTransactions(genesis_hash, /*start_height=*/0, /*max_height=*/{}, reserver, /*save_progress=*/false);
242    BOOST_CHECK_EQUAL(result.status, CWallet::ScanResult::USER_ABORT);
243    BOOST_CHECK(result.last_scanned_block.IsNull());
244    BOOST_CHECK(!result.last_scanned_height);
245    BOOST_CHECK(result.last_failed_block.IsNull());
246}
247
248// This test verifies that wallet settings can be added and removed
249// concurrently, ensuring no race conditions occur during either process.
250BOOST_FIXTURE_TEST_CASE(write_wallet_settings_concurrently, TestingSetup)

src/wallet/receive.cpp

src/wallet/coinselection.cpp

src/consensus/validation.h

src/primitives/transaction.cpp

src/script/descriptor.cpp

src/bitcoin-cli.cpp

src/rpc/blockchain.cpp

src/rpc/rawtransaction.cpp

src/init.cpp

src/crypto/sha256.cpp

src/consensus/merkle.h

src/consensus/tx_check.h

src/consensus/tx_verify.h

src/policy/feerate.h

src/policy/feerate.cpp

src/primitives/transaction_identifier.h

src/chainparamsbase.h

src/chainparamsbase.cpp

src/util/moneystr.cpp

src/crypto/ripemd160.h

src/crypto/sha1.h

src/crypto/sha512.h

src/crypto/hmac_sha256.h

src/crypto/hmac_sha512.h

src/crypto/hmac_sha256.cpp

src/crypto/hmac_sha512.cpp

src/crypto/hkdf_sha256_32.h

src/crypto/hkdf_sha256_32.cpp

src/support/cleanse.h

src/support/cleanse.cpp

src/crypto/siphash.cpp

src/crypto/muhash.h

src/crypto/chacha20.h

src/crypto/poly1305.h

src/crypto/chacha20poly1305.h

src/crypto/chacha20poly1305.cpp

src/util/chaintype.cpp

src/util/obfuscation.h

src/util/byte_units.h

src/util/overflow.h

src/blockencodings.cpp

src/net_permissions.cpp

src/policy/packages.cpp

src/policy/rbf.cpp

src/policy/truc_policy.cpp

src/policy/ephemeral_policy.cpp

src/policy/settings.cpp

src/policy/policy.cpp

src/node/transaction.cpp

src/node/coin.cpp

src/rpc/client.cpp

src/rpc/external_signer.cpp

src/rpc/request.cpp

src/rpc/server_util.cpp

src/rpc/fees.cpp

src/rpc/output_script.cpp

src/rpc/rawtransaction_util.cpp

src/rpc/rawtransaction_util.h

src/rpc/register.h

src/rpc/request.h

src/rpc/server_util.h

src/rpc/protocol.h

src/rpc/server.h

src/rpc/signmessage.cpp

src/rpc/txoutproof.cpp

src/rpc/util.cpp

src/rpc/util.h

src/wallet/rpc/addresses.cpp

src/wallet/rpc/backup.cpp

src/wallet/rpc/coins.cpp

src/wallet/rpc/encrypt.cpp

src/wallet/rpc/signmessage.cpp

src/wallet/rpc/util.cpp

src/wallet/rpc/util.h

src/wallet/coincontrol.cpp

src/wallet/coincontrol.h

src/wallet/context.cpp

src/wallet/context.h

src/wallet/crypter.cpp

src/wallet/crypter.h

src/wallet/db.cpp

src/wallet/export.cpp

src/wallet/external_signer_scriptpubkeyman.cpp

src/wallet/rpc/spend.cpp

src/wallet/rpc/transactions.cpp

src/wallet/rpc/wallet.cpp

src/wallet/feebumper.cpp

src/wallet/feebumper.h

src/index/base.h

src/index/base.cpp

src/index/txindex.h

src/index/txindex.cpp

src/index/txindex_key.h

src/index/txospenderindex.h

src/index/txospenderindex.cpp

src/index/blockfilterindex.h

src/index/blockfilterindex.cpp

src/index/coinstatsindex.h

src/index/coinstatsindex.cpp

src/index/db_key.h

src/index/disktxpos.h

src/kernel/chain.cpp

src/kernel/chain.h

src/kernel/checks.cpp

src/kernel/checks.h

src/kernel/context.cpp

src/kernel/context.h

src/kernel/cs_main.cpp

src/kernel/cs_main.h

src/kernel/disconnected_transactions.cpp

src/kernel/disconnected_transactions.h

src/kernel/mempool_removal_reason.cpp

src/kernel/mempool_removal_reason.h

src/kernel/coinstats.cpp

src/kernel/coinstats.h

src/kernel/chainparams.cpp

src/kernel/chainparams.h

src/wallet/sqlite.cpp

src/wallet/sqlite.h

src/wallet/transaction.cpp

src/wallet/transaction.h

src/wallet/dump.cpp

src/wallet/dump.h

src/wallet/init.cpp

src/wallet/walletutil.cpp

src/wallet/walletutil.h

src/wallet/wallettool.cpp

src/wallet/wallettool.h

src/wallet/export.h

src/wallet/migrate.cpp

src/wallet/migrate.h

src/wallet/db.h

src/wallet/walletdb.cpp

src/wallet/interfaces.cpp

src/wallet/scriptpubkeyman.cpp

src/wallet/scriptpubkeyman.h

src/kernel/bitcoinkernel.cpp

src/kernel/bitcoinkernel.h

src/kernel/bitcoinkernel_wrapper.h

src/node/chainstate.cpp

src/node/chainstate.h

src/node/blockstorage.cpp

src/node/blockstorage.h

src/node/mempool_persist.cpp

src/node/mempool_persist.h

src/node/utxo_snapshot.cpp

src/node/utxo_snapshot.h

src/node/kernel_notifications.cpp

src/node/kernel_notifications.h

src/node/blockmanager_args.cpp

src/kernel/blockmanager_opts.h

src/util/expected.cpp

src/policy/settings.h

src/util/types.h

src/kernel/messagestartchars.h

src/kernel/warning.h

src/util/exception.h

src/common/license_info.h

src/node/coins_view_args.h

src/node/database_args.h

src/util/batchpriority.h

src/util/ui_change_type.h

src/node/coins_view_args.cpp

src/node/peerman_args.h

src/util/serfloat.h

src/node/blockmanager_args.h

src/node/database_args.cpp

src/util/overloaded.h

src/interfaces/types.h

src/node/chainstatemanager_args.h

src/node/minisketchwrapper.h

src/util/macros.h

src/util/syserror.h

src/common/run_command.h

src/util/bytevectorhash.cpp

src/node/mempool_persist_args.cpp

src/util/exec.h

src/util/rbf.h

src/crypto/hex_base.h

src/node/mempool_persist_args.h

src/interfaces/echo.h

src/util/any.h

src/util/batchpriority.cpp

src/util/threadnames.h

src/node/coin.h

src/node/mempool_args.h

src/util/asmap.h

src/util/bytevectorhash.h

src/node/context.cpp

src/util/insert.h

src/util/readwritefile.h

src/node/peerman_args.cpp

src/node/interface_ui.cpp

src/interfaces/handler.h

src/node/mining_args.h

src/util/hasher.cpp

src/common/init.h

src/kernel/mempool_limits.h

src/common/system.h

src/crypto/sha3.h

src/util/threadinterrupt.cpp

src/node/protocol_version.h

src/util/exception.cpp

src/common/messages.h

src/node/connection_types.cpp

src/util/bip32.h

src/common/license_info.cpp

src/util/stdmutex.h

src/common/run_command.cpp

src/util/check.cpp

src/util/golombrice.h

src/node/types.h

src/node/timeoffsets.h

src/util/readwritefile.cpp

src/util/fastrange.h

src/util/signalinterrupt.h

src/util/task_runner.h

src/util/syserror.cpp

src/common/interfaces.cpp

src/common/types.h

src/util/threadinterrupt.h

src/kernel/chainstatemanager_opts.h

src/node/psbt.h

src/policy/ephemeral_policy.h

src/util/trace.h

src/common/url.cpp

src/kernel/mempool_options.h

src/util/serfloat.cpp

src/kernel/notifications_interface.h

src/node/timeoffsets.cpp

src/node/warnings.cpp

src/util/hash_type.h

src/crypto/hex_base.cpp

src/node/eviction.h

src/util/tokenbucket.h

src/crypto/aes.h

src/common/pcp.h

src/util/feefrac.cpp

src/node/transaction.h

src/util/threadnames.cpp

src/common/signmessage.h

src/util/exec.cpp

src/util/signalinterrupt.cpp

src/clientversion.cpp

src/common/signmessage.cpp

src/compat/assumptions.h

src/compat/byteswap.h

src/deploymentinfo.cpp

src/deploymentinfo.h

src/deploymentstatus.cpp

src/deploymentstatus.h

src/dummywallet.cpp

src/external_signer.h

src/init/bitcoin-gui.cpp

src/init/bitcoin-node.cpp

src/init/bitcoin-qt.cpp

src/init/bitcoin-wallet.cpp

src/init/bitcoind.cpp

src/init/common.h

src/interfaces/init.h

src/interfaces/ipc.h

src/key_io.h

src/logging/categories.h

src/logging/timer.h

src/mapport.h

src/musig.h

src/net_permissions.h

src/netgroup.h

src/netmessagemaker.h

src/node/chainstatemanager_args.cpp

src/node/connection_types.h

src/node/context.h

src/node/interface_ui.h

src/node/mempool_args.cpp

src/node/mining_args.cpp

src/node/minisketchwrapper.cpp

src/node/txreconciliation.h

src/policy/fees/estimator_args.cpp

src/policy/fees/estimator_args.h

src/policy/fees/estimator_man.cpp

src/policy/fees/estimator_man.h

src/policy/packages.h

src/policy/rbf.h

src/policy/truc_policy.h

src/pow.h

src/primitives/block.cpp

src/randomenv.h

src/rest.h

src/script/keyorigin.h

src/script/parsing.cpp

src/script/parsing.h

src/script/script_error.h

src/script/sigcache.cpp

src/script/sigcache.h

src/script/solver.h

src/script/verify_flags.h

src/semaphore_grant.h

src/signet.h

src/span.h

src/support/allocators/secure.h

src/support/allocators/zeroafterfree.h

src/util/tokenpipe.cpp

src/util/translation.h

src/util/vector.h

src/versionbits.h

src/versionbits_impl.h

src/wallet/external_signer_scriptpubkeyman.h

src/wallet/fees.h

src/wallet/load.h

src/wallet/receive.h

src/wallet/rpc/wallet.h

src/wallet/types.h

src/walletinitinterface.h

src/zmq/zmqabstractnotifier.cpp

Independent explanations by MyBitcoinExplorer. Not affiliated with or endorsed by Bitcoin Core. Guides are educational and do not replace the source or its tests.

Bitcoin Core source © its contributors, distributed under the MIT license. Original notices and bundled third-party licenses are retained in the source tree.