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 server340 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.

15,149 bytes · SHA-256 f795cf2bb28e959f… · View upstream ↗

1// Copyright (c) 2018-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#ifndef BITCOIN_INTERFACES_WALLET_H
6#define BITCOIN_INTERFACES_WALLET_H
7
8#include <addresstype.h>
9#include <common/signmessage.h>
10#include <common/types.h>
11#include <consensus/amount.h>
12#include <interfaces/chain.h>
13#include <primitives/transaction.h>
14#include <support/allocators/secure.h>
15#include <util/fs.h>
16#include <util/result.h>
17#include <util/ui_change_type.h>
18
19#include <compare>
20#include <cstddef>
21#include <cstdint>
22#include <functional>
23#include <map>
24#include <memory>
25#include <optional>
26#include <set>
27#include <string>
28#include <tuple>
29#include <utility>
30#include <vector>
31
32class ArgsManager;
33class CKeyID;
34class CPubKey;
35class CScript;
36class PartiallySignedTransaction;
37class uint256;
38enum class FeeReason;
39enum class OutputType;
40struct bilingual_str;
41namespace wallet {
42struct CreatedTransactionResult;
43class CCoinControl;
44class CWallet;
45enum class AddressPurpose;
46struct CRecipient;
47struct WalletContext;
48} // namespace wallet
49
50namespace interfaces {
51
52class Handler;
53struct WalletAddress;
54struct WalletBalances;
55struct WalletTx;
56struct WalletTxOut;
57struct WalletTxStatus;
58struct WalletMigrationResult;
59
60//! Interface for accessing a wallet.
61class Wallet
62{
63public:
64    virtual ~Wallet() = default;
65
66    //! Encrypt wallet.
67    virtual bool encryptWallet(const SecureString& wallet_passphrase) = 0;
68
69    //! Return whether wallet is encrypted.
70    virtual bool isCrypted() = 0;
71
72    //! Lock wallet.
73    virtual bool lock() = 0;
74
75    //! Unlock wallet.
76    virtual bool unlock(const SecureString& wallet_passphrase) = 0;
77
78    //! Return whether wallet is locked.
79    virtual bool isLocked() = 0;
80
81    //! Change wallet passphrase.
82    virtual bool changeWalletPassphrase(const SecureString& old_wallet_passphrase,
83        const SecureString& new_wallet_passphrase) = 0;
84
85    //! Abort a rescan.
86    virtual void abortRescan() = 0;
87
88    //! Back up wallet.
89    virtual bool backupWallet(const std::string& filename) = 0;
90
91    //! Get wallet name.
92    virtual std::string getWalletName() = 0;
93
94    // Get a new address.
95    virtual util::Result<CTxDestination> getNewDestination(OutputType type, const std::string& label) = 0;
96
97    //! Get public key.
98    virtual bool getPubKey(const CScript& script, const CKeyID& address, CPubKey& pub_key) = 0;
99
100    //! Sign message
101    virtual SigningResult signMessage(const std::string& message, const PKHash& pkhash, std::string& str_sig) = 0;
102
103    //! Return whether wallet has private key.
104    virtual bool isSpendable(const CTxDestination& dest) = 0;
105
106    //! Add or update address.
107    virtual bool setAddressBook(const CTxDestination& dest, const std::string& name, const std::optional<wallet::AddressPurpose>& purpose) = 0;
108
109    // Remove address.
110    virtual bool delAddressBook(const CTxDestination& dest) = 0;
111
112    //! Look up address in wallet, return whether exists.
113    virtual bool getAddress(const CTxDestination& dest,
114        std::string* name,
115        wallet::AddressPurpose* purpose) = 0;
116
117    //! Get wallet address list.
118    virtual std::vector<WalletAddress> getAddresses() = 0;
119
120    //! Get receive requests.
121    virtual std::vector<std::string> getAddressReceiveRequests() = 0;
122
123    //! Save or remove receive request.
124    virtual bool setAddressReceiveRequest(const CTxDestination& dest, const std::string& id, const std::string& value) = 0;
125
126    //! Display address on external signer
127    virtual util::Result<void> displayAddress(const CTxDestination& dest) = 0;
128
129    //! Lock coin.
130    virtual bool lockCoin(const COutPoint& output, bool write_to_db) = 0;
131
132    //! Unlock coin.
133    virtual bool unlockCoin(const COutPoint& output) = 0;
134
135    //! Return whether coin is locked.
136    virtual bool isLockedCoin(const COutPoint& output) = 0;
137
138    //! List locked coins.
139    virtual void listLockedCoins(std::vector<COutPoint>& outputs) = 0;
140
141    //! Create transaction.
142    virtual util::Result<wallet::CreatedTransactionResult> createTransaction(const std::vector<wallet::CRecipient>& recipients,
143        const wallet::CCoinControl& coin_control,
144        bool sign,
145        std::optional<unsigned int> change_pos) = 0;
146
147    //! Commit transaction.
148    virtual void commitTransaction(CTransactionRef tx, const std::vector<std::string>& messages) = 0;
149
150    //! Return whether transaction can be abandoned.
151    virtual bool transactionCanBeAbandoned(const Txid& txid) = 0;
152
153    //! Abandon transaction.
154    virtual bool abandonTransaction(const Txid& txid) = 0;
155
156    //! Return whether transaction can be bumped.
157    virtual bool transactionCanBeBumped(const Txid& txid) = 0;
158
159    //! Create bump transaction.
160    virtual bool createBumpTransaction(const Txid& txid,
161        const wallet::CCoinControl& coin_control,
162        std::vector<bilingual_str>& errors,
163        CAmount& old_fee,
164        CAmount& new_fee,
165        CMutableTransaction& mtx) = 0;
166
167    //! Sign bump transaction.
168    virtual bool signBumpTransaction(CMutableTransaction& mtx) = 0;
169
170    //! Commit bump transaction.
171    virtual bool commitBumpTransaction(const Txid& txid,
172        CMutableTransaction&& mtx,
173        std::vector<bilingual_str>& errors,
174        Txid& bumped_txid) = 0;
175
176    //! Get a transaction.
177    virtual CTransactionRef getTx(const Txid& txid) = 0;
178
179    //! Get transaction information.
180    virtual WalletTx getWalletTx(const Txid& txid) = 0;
181
182    //! Get list of all wallet transactions.
183    virtual std::set<WalletTx> getWalletTxs() = 0;
184
185    //! Try to get updated status for a particular transaction, if possible without blocking.
186    virtual bool tryGetTxStatus(const Txid& txid,
187        WalletTxStatus& tx_status,
188        int& num_blocks,
189        int64_t& block_time) = 0;
190
191    //! Get transaction details.
192    virtual WalletTx getWalletTxDetails(const Txid& txid,
193        WalletTxStatus& tx_status,
194        std::vector<std::string>& messages,
195        std::vector<std::string>& payment_requests,
196        bool& in_mempool,
197        int& num_blocks) = 0;
198
199    //! Fill PSBT.
200    virtual std::optional<common::PSBTError> fillPSBT(const common::PSBTFillOptions& options,
201        size_t* n_signed,
202        PartiallySignedTransaction& psbtx,
203        bool& complete) = 0;
204
205    //! Get balances.
206    virtual WalletBalances getBalances() = 0;
207
208    //! Get balances if possible without blocking.
209    virtual bool tryGetBalances(WalletBalances& balances, uint256& block_hash) = 0;
210
211    //! Get balance.
212    virtual CAmount getBalance() = 0;
213
214    //! Get available balance.
215    virtual CAmount getAvailableBalance(const wallet::CCoinControl& coin_control) = 0;
216
217    //! Return whether transaction input belongs to wallet.
218    virtual bool txinIsMine(const CTxIn& txin) = 0;
219
220    //! Return whether transaction output belongs to wallet.
221    virtual bool txoutIsMine(const CTxOut& txout) = 0;
222
223    //! Return debit amount if transaction input belongs to wallet.
224    virtual CAmount getDebit(const CTxIn& txin) = 0;
225
226    //! Return credit amount if transaction input belongs to wallet.
227    virtual CAmount getCredit(const CTxOut& txout) = 0;
228
229    //! Return AvailableCoins + LockedCoins grouped by wallet address.
230    //! (put change in one group with wallet address)
231    using CoinsList = std::map<CTxDestination, std::vector<std::tuple<COutPoint, WalletTxOut>>>;
232    virtual CoinsList listCoins() = 0;
233
234    //! Return wallet transaction output information.
235    virtual std::vector<WalletTxOut> getCoins(const std::vector<COutPoint>& outputs) = 0;
236
237    //! Get required fee.
238    virtual CAmount getRequiredFee(unsigned int tx_bytes) = 0;
239
240    //! Get minimum fee.
241    virtual CAmount getMinimumFee(unsigned int tx_bytes,
242        const wallet::CCoinControl& coin_control,
243        std::optional<int>* returned_target,
244        FeeReason* reason) = 0;
245
246    //! Get tx confirm target.
247    virtual unsigned int getConfirmTarget() = 0;
248
249    // Return whether HD enabled.
250    virtual bool hdEnabled() = 0;

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

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.