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.

56,532 bytes · SHA-256 f1f6e7a6f98b1da7… · View upstream ↗

1// Copyright (c) 2009-2010 Satoshi Nakamoto
2// Copyright (c) 2009-present The Bitcoin Core developers
3// Distributed under the MIT software license, see the accompanying
4// file COPYING or http://www.opensource.org/licenses/mit-license.php.
5
6#ifndef BITCOIN_WALLET_WALLET_H
7#define BITCOIN_WALLET_WALLET_H
8
9#include <addresstype.h>
10#include <consensus/amount.h>
11#include <interfaces/chain.h>
12#include <interfaces/handler.h>
13#include <kernel/cs_main.h>
14#include <node/types.h>
15#include <outputtype.h>
16#include <policy/feerate.h>
17#include <primitives/transaction.h>
18#include <primitives/transaction_identifier.h>
19#include <script/interpreter.h>
20#include <script/script.h>
21#include <support/allocators/secure.h>
22#include <sync.h>
23#include <tinyformat.h>
24#include <uint256.h>
25#include <util/btcsignals.h>
26#include <util/expected.h>
27#include <util/fs.h>
28#include <util/hasher.h>
29#include <util/log.h>
30#include <util/result.h>
31#include <util/string.h>
32#include <util/time.h>
33#include <util/ui_change_type.h>
34#include <wallet/crypter.h>
35#include <wallet/db.h>
36#include <wallet/scriptpubkeyman.h>
37#include <wallet/transaction.h>
38#include <wallet/types.h>
39#include <wallet/walletutil.h>
40
41#include <atomic>
42#include <cassert>
43#include <cstddef>
44#include <cstdint>
45#include <functional>
46#include <limits>
47#include <map>
48#include <memory>
49#include <optional>
50#include <set>
51#include <string>
52#include <unordered_map>
53#include <utility>
54#include <vector>
55
56class CKey;
57class CKeyID;
58class CPubKey;
59class Coin;
60class SigningProvider;
61enum class MemPoolRemovalReason;
62enum class SigningResult;
63namespace common {
64enum class PSBTError;
65} // namespace common
66namespace interfaces {
67class Wallet;
68}
69namespace wallet {
70class CWallet;
71class WalletBatch;
72enum class DBErrors : int;
73} // namespace wallet
74struct CBlockLocator;
75struct CExtKey;
76struct FlatSigningProvider;
77struct KeyOriginInfo;
78class PartiallySignedTransaction;
79struct SignatureData;
80
81using LoadWalletFn = std::function<void(std::unique_ptr<interfaces::Wallet> wallet)>;
82
83struct bilingual_str;
84
85namespace wallet {
86struct WalletContext;
87
88//! Explicitly delete the wallet.
89//! Blocks the current thread until the wallet is destructed.
90void WaitForDeleteWallet(std::shared_ptr<CWallet>&& wallet);
91
92bool AddWallet(WalletContext& context, const std::shared_ptr<CWallet>& wallet);
93bool RemoveWallet(WalletContext& context, const std::shared_ptr<CWallet>& wallet, std::optional<bool> load_on_start, std::vector<bilingual_str>& warnings);
94bool RemoveWallet(WalletContext& context, const std::shared_ptr<CWallet>& wallet, std::optional<bool> load_on_start);
95std::vector<std::shared_ptr<CWallet>> GetWallets(WalletContext& context);
96std::shared_ptr<CWallet> GetDefaultWallet(WalletContext& context, size_t& count);
97std::shared_ptr<CWallet> GetWallet(WalletContext& context, const std::string& name);
98std::shared_ptr<CWallet> LoadWallet(WalletContext& context, const std::string& name, std::optional<bool> load_on_start, const DatabaseOptions& options, DatabaseStatus& status, bilingual_str& error, std::vector<bilingual_str>& warnings);
99std::shared_ptr<CWallet> CreateWallet(WalletContext& context, const std::string& name, std::optional<bool> load_on_start, DatabaseOptions& options, DatabaseStatus& status, bilingual_str& error, std::vector<bilingual_str>& warnings);
100std::shared_ptr<CWallet> RestoreWallet(WalletContext& context, const fs::path& backup_file, const std::string& wallet_name, std::optional<bool> load_on_start, DatabaseStatus& status, bilingual_str& error, std::vector<bilingual_str>& warnings, bool load_after_restore = true, bool allow_unnamed = false);
101std::unique_ptr<interfaces::Handler> HandleLoadWallet(WalletContext& context, LoadWalletFn load_wallet);
102void NotifyWalletLoaded(WalletContext& context, const std::shared_ptr<CWallet>& wallet);
103std::unique_ptr<WalletDatabase> MakeWalletDatabase(const std::string& name, const DatabaseOptions& options, DatabaseStatus& status, bilingual_str& error);
104
105//! -fallbackfee default
106inline constexpr CAmount DEFAULT_FALLBACK_FEE = 0;
107//! -discardfee default
108inline constexpr CAmount DEFAULT_DISCARD_FEE{10'000};
109//! -mintxfee default
110inline constexpr CAmount DEFAULT_TRANSACTION_MINFEE = 1000;
111//! -consolidatefeerate default
112inline constexpr CAmount DEFAULT_CONSOLIDATE_FEERATE{10'000}; // 10 sat/vbyte
113/**
114 * maximum fee increase allowed to do partial spend avoidance, even for nodes with this feature disabled by default
115 *
116 * A value of -1 disables this feature completely.
117 * A value of 0 (current default) means to attempt to do partial spend avoidance, and use its results if the fees remain *unchanged*
118 * A value > 0 means to do partial spend avoidance if the fee difference against a regular coin selection instance is in the range [0..value].
119 */
120inline constexpr CAmount DEFAULT_MAX_AVOIDPARTIALSPEND_FEE = 0;
121//! discourage APS fee higher than this amount
122inline constexpr CAmount HIGH_APS_FEE{COIN / 10000};
123//! minimum recommended increment for replacement txs
124inline constexpr CAmount WALLET_INCREMENTAL_RELAY_FEE = 5000;
125//! Default for -spendzeroconfchange
126inline constexpr bool DEFAULT_SPEND_ZEROCONF_CHANGE = true;
127//! Default for -walletrejectlongchains
128inline constexpr bool DEFAULT_WALLET_REJECT_LONG_CHAINS{true};
129//! -txconfirmtarget default
130inline constexpr unsigned int DEFAULT_TX_CONFIRM_TARGET = 6;
131//! -walletrbf default
132inline constexpr bool DEFAULT_WALLET_RBF = true;
133inline constexpr bool DEFAULT_WALLETBROADCAST = true;
134inline constexpr bool DEFAULT_DISABLE_WALLET = false;
135inline constexpr bool DEFAULT_WALLETCROSSCHAIN = false;
136//! -maxtxfee default
137inline constexpr CAmount DEFAULT_TRANSACTION_MAXFEE{COIN / 10};
138//! Discourage users to set fees higher than this amount (in satoshis) per kB
139inline constexpr CAmount HIGH_TX_FEE_PER_KB{COIN / 100};
140//! -maxtxfee will warn if called with a higher fee than this amount (in satoshis)
141inline constexpr CAmount HIGH_MAX_TX_FEE{100 * HIGH_TX_FEE_PER_KB};
142//! Pre-calculated constants for input size estimation in *virtual size*
143inline constexpr size_t DUMMY_NESTED_P2WPKH_INPUT_SIZE = 91;
144
145class CCoinControl;
146
147//! Default for -addresstype
148inline constexpr OutputType DEFAULT_ADDRESS_TYPE{OutputType::BECH32};
149
150inline constexpr uint64_t KNOWN_WALLET_FLAGS =
151        WALLET_FLAG_AVOID_REUSE
152    |   WALLET_FLAG_BLANK_WALLET
153    |   WALLET_FLAG_KEY_ORIGIN_METADATA
154    |   WALLET_FLAG_LAST_HARDENED_XPUB_CACHED
155    |   WALLET_FLAG_DISABLE_PRIVATE_KEYS
156    |   WALLET_FLAG_DESCRIPTORS
157    |   WALLET_FLAG_EXTERNAL_SIGNER;
158
159inline constexpr uint64_t MUTABLE_WALLET_FLAGS =
160        WALLET_FLAG_AVOID_REUSE;
161
162static const std::map<WalletFlags, std::string> WALLET_FLAG_TO_STRING{
163    {WALLET_FLAG_AVOID_REUSE, "avoid_reuse"},
164    {WALLET_FLAG_BLANK_WALLET, "blank"},
165    {WALLET_FLAG_KEY_ORIGIN_METADATA, "key_origin_metadata"},
166    {WALLET_FLAG_LAST_HARDENED_XPUB_CACHED, "last_hardened_xpub_cached"},
167    {WALLET_FLAG_DISABLE_PRIVATE_KEYS, "disable_private_keys"},
168    {WALLET_FLAG_DESCRIPTORS, "descriptor_wallet"},
169    {WALLET_FLAG_EXTERNAL_SIGNER, "external_signer"}
170};
171
172static const std::map<std::string, WalletFlags> STRING_TO_WALLET_FLAG{
173    {WALLET_FLAG_TO_STRING.at(WALLET_FLAG_AVOID_REUSE), WALLET_FLAG_AVOID_REUSE},
174    {WALLET_FLAG_TO_STRING.at(WALLET_FLAG_BLANK_WALLET), WALLET_FLAG_BLANK_WALLET},
175    {WALLET_FLAG_TO_STRING.at(WALLET_FLAG_KEY_ORIGIN_METADATA), WALLET_FLAG_KEY_ORIGIN_METADATA},
176    {WALLET_FLAG_TO_STRING.at(WALLET_FLAG_LAST_HARDENED_XPUB_CACHED), WALLET_FLAG_LAST_HARDENED_XPUB_CACHED},
177    {WALLET_FLAG_TO_STRING.at(WALLET_FLAG_DISABLE_PRIVATE_KEYS), WALLET_FLAG_DISABLE_PRIVATE_KEYS},
178    {WALLET_FLAG_TO_STRING.at(WALLET_FLAG_DESCRIPTORS), WALLET_FLAG_DESCRIPTORS},
179    {WALLET_FLAG_TO_STRING.at(WALLET_FLAG_EXTERNAL_SIGNER), WALLET_FLAG_EXTERNAL_SIGNER}
180};
181
182/** A wrapper to reserve an address from a wallet
183 *
184 * ReserveDestination is used to reserve an address.
185 * It is currently only used inside of CreateTransaction.
186 *
187 * Instantiating a ReserveDestination does not reserve an address. To do so,
188 * GetReservedDestination() needs to be called on the object. Once an address has been
189 * reserved, call KeepDestination() on the ReserveDestination object to make sure it is not
190 * returned. Call ReturnDestination() to return the address so it can be reused (for
191 * example, if the address was used in a new transaction
192 * and that transaction was not completed and needed to be aborted).
193 *
194 * If an address is reserved and KeepDestination() is not called, then the address will be
195 * returned when the ReserveDestination goes out of scope.
196 */
197class ReserveDestination
198{
199protected:
200    //! The wallet to reserve from
201    const CWallet* const pwallet;
202    //! The ScriptPubKeyMan to reserve from. Based on type when GetReservedDestination is called
203    ScriptPubKeyMan* m_spk_man{nullptr};
204    OutputType const type;
205    //! The index of the address's key in the keypool
206    int64_t nIndex{-1};
207    //! The destination
208    CTxDestination address;
209    //! Whether this is from the internal (change output) keypool
210    bool fInternal{false};
211
212public:
213    //! Construct a ReserveDestination object. This does NOT reserve an address yet
214    explicit ReserveDestination(CWallet* pwallet, OutputType type)
215      : pwallet(pwallet)
216      , type(type) { }
217
218    ReserveDestination(const ReserveDestination&) = delete;
219    ReserveDestination& operator=(const ReserveDestination&) = delete;
220
221    //! Destructor. If a key has been reserved and not KeepKey'ed, it will be returned to the keypool
222    ~ReserveDestination()
223    {
224        ReturnDestination();
225    }
226
227    //! Reserve an address
228    util::Result<CTxDestination> GetReservedDestination(bool internal);
229    //! Return reserved address
230    void ReturnDestination();
231    //! Keep the address. Do not return its key to the keypool when this object goes out of scope
232    void KeepDestination();
233};
234
235/**
236 * Address book data.
237 */
238struct CAddressBookData
239{
240    /**
241     * Address label which is always nullopt for change addresses. For sending
242     * and receiving addresses, it will be set to an arbitrary label string
243     * provided by the user, or to "", which is the default label. The presence
244     * or absence of a label is used to distinguish change addresses from
245     * non-change addresses by wallet transaction listing and fee bumping code.
246     */
247    std::optional<std::string> label;
248
249    /**
250     * Address purpose which was originally recorded for payment protocol

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.