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.

6,434 bytes · SHA-256 9d22e4263e616234… · View upstream ↗

1// Copyright (c) 2023-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#ifndef BITCOIN_ADDRESSTYPE_H
6#define BITCOIN_ADDRESSTYPE_H
7
8#include <attributes.h>
9#include <pubkey.h>
10#include <script/script.h>
11#include <uint256.h>
12#include <util/check.h>
13#include <util/hash_type.h>
14
15#include <algorithm>
16#include <variant>
17#include <vector>
18
19class CNoDestination
20{
21private:
22    CScript m_script;
23
24public:
25    CNoDestination() = default;
26    explicit CNoDestination(const CScript& script) : m_script(script) {}
27
28    const CScript& GetScript() const LIFETIMEBOUND { return m_script; }
29
30    friend bool operator==(const CNoDestination& a, const CNoDestination& b) { return a.GetScript() == b.GetScript(); }
31    friend bool operator<(const CNoDestination& a, const CNoDestination& b) { return a.GetScript() < b.GetScript(); }
32};
33
34struct PubKeyDestination {
35private:
36    CPubKey m_pubkey;
37
38public:
39    explicit PubKeyDestination(const CPubKey& pubkey) : m_pubkey(pubkey) {}
40
41    const CPubKey& GetPubKey() const LIFETIMEBOUND { return m_pubkey; }
42
43    friend bool operator==(const PubKeyDestination& a, const PubKeyDestination& b) { return a.GetPubKey() == b.GetPubKey(); }
44    friend bool operator<(const PubKeyDestination& a, const PubKeyDestination& b) { return a.GetPubKey() < b.GetPubKey(); }
45};
46
47struct PKHash : public BaseHash<uint160>
48{
49    PKHash() : BaseHash() {}
50    explicit PKHash(const uint160& hash) : BaseHash(hash) {}
51    explicit PKHash(const CPubKey& pubkey);
52    explicit PKHash(const CKeyID& pubkey_id);
53};
54CKeyID ToKeyID(const PKHash& key_hash);
55
56struct WitnessV0KeyHash;
57
58struct ScriptHash : public BaseHash<uint160>
59{
60    ScriptHash() : BaseHash() {}
61    // These don't do what you'd expect.
62    // Use ScriptHash(GetScriptForDestination(...)) instead.
63    explicit ScriptHash(const WitnessV0KeyHash& hash) = delete;
64    explicit ScriptHash(const PKHash& hash) = delete;
65
66    explicit ScriptHash(const uint160& hash) : BaseHash(hash) {}
67    explicit ScriptHash(const CScript& script);
68    explicit ScriptHash(const CScriptID& script);
69};
70CScriptID ToScriptID(const ScriptHash& script_hash);
71
72struct WitnessV0ScriptHash : public BaseHash<uint256>
73{
74    WitnessV0ScriptHash() : BaseHash() {}
75    explicit WitnessV0ScriptHash(const uint256& hash) : BaseHash(hash) {}
76    explicit WitnessV0ScriptHash(const CScript& script);
77};
78
79struct WitnessV0KeyHash : public BaseHash<uint160>
80{
81    WitnessV0KeyHash() : BaseHash() {}
82    explicit WitnessV0KeyHash(const uint160& hash) : BaseHash(hash) {}
83    explicit WitnessV0KeyHash(const CPubKey& pubkey);
84    explicit WitnessV0KeyHash(const PKHash& pubkey_hash);
85};
86CKeyID ToKeyID(const WitnessV0KeyHash& key_hash);
87
88struct WitnessV1Taproot : public XOnlyPubKey
89{
90    WitnessV1Taproot() : XOnlyPubKey() {}
91    explicit WitnessV1Taproot(const XOnlyPubKey& xpk) : XOnlyPubKey(xpk) {}
92};
93
94//! CTxDestination subtype to encode any future Witness version
95struct WitnessUnknown
96{
97private:
98    unsigned int m_version;
99    std::vector<unsigned char> m_program;
100
101public:
102    WitnessUnknown(unsigned int version, const std::vector<unsigned char>& program) : m_version(version), m_program(program) {}
103    WitnessUnknown(int version, const std::vector<unsigned char>& program) : m_version(static_cast<unsigned int>(version)), m_program(program) {}
104
105    unsigned int GetWitnessVersion() const { return m_version; }
106    const std::vector<unsigned char>& GetWitnessProgram() const LIFETIMEBOUND { return m_program; }
107
108    friend bool operator==(const WitnessUnknown& w1, const WitnessUnknown& w2) {
109        if (w1.GetWitnessVersion() != w2.GetWitnessVersion()) return false;
110        return w1.GetWitnessProgram() == w2.GetWitnessProgram();
111    }
112
113    friend bool operator<(const WitnessUnknown& w1, const WitnessUnknown& w2) {
114        if (w1.GetWitnessVersion() < w2.GetWitnessVersion()) return true;
115        if (w1.GetWitnessVersion() > w2.GetWitnessVersion()) return false;
116        return w1.GetWitnessProgram() < w2.GetWitnessProgram();
117    }
118};
119
120/** Witness program for Pay-to-Anchor output script type */
121inline const std::vector<unsigned char> ANCHOR_BYTES{0x4e, 0x73};
122
123struct PayToAnchor : public WitnessUnknown
124{
125    PayToAnchor() : WitnessUnknown(1, ANCHOR_BYTES) {
126        Assume(CScript::IsPayToAnchor(1, ANCHOR_BYTES));
127    };
128};
129
130/**
131 * A txout script categorized into standard templates.
132 *  * CNoDestination: Optionally a script, no corresponding address.
133 *  * PubKeyDestination: TxoutType::PUBKEY (P2PK), no corresponding address
134 *  * PKHash: TxoutType::PUBKEYHASH destination (P2PKH address)
135 *  * ScriptHash: TxoutType::SCRIPTHASH destination (P2SH address)
136 *  * WitnessV0ScriptHash: TxoutType::WITNESS_V0_SCRIPTHASH destination (P2WSH address)
137 *  * WitnessV0KeyHash: TxoutType::WITNESS_V0_KEYHASH destination (P2WPKH address)
138 *  * WitnessV1Taproot: TxoutType::WITNESS_V1_TAPROOT destination (P2TR address)
139 *  * PayToAnchor: TxoutType::ANCHOR destination (P2A address)
140 *  * WitnessUnknown: TxoutType::WITNESS_UNKNOWN destination (P2W??? address)
141 *  A CTxDestination is the internal data type encoded in a bitcoin address
142 */
143using CTxDestination = std::variant<CNoDestination, PubKeyDestination, PKHash, ScriptHash, WitnessV0ScriptHash, WitnessV0KeyHash, WitnessV1Taproot, PayToAnchor, WitnessUnknown>;
144
145/** Check whether a CTxDestination corresponds to one with an address. */
146bool IsValidDestination(const CTxDestination& dest);
147
148/**
149 * Parse a scriptPubKey for the destination.
150 *
151 * For standard scripts that have addresses (and P2PK as an exception), a corresponding CTxDestination
152 * is assigned to addressRet.
153 * For all other scripts. addressRet is assigned as a CNoDestination containing the scriptPubKey.
154 *
155 * Returns true for standard destinations with addresses - P2PKH, P2SH, P2WPKH, P2WSH, P2TR and P2W??? scripts.
156 * Returns false for non-standard destinations and those without addresses - P2PK, bare multisig, null data, and nonstandard scripts.
157 */
158bool ExtractDestination(const CScript& scriptPubKey, CTxDestination& addressRet);
159
160/**
161 * Generate a Bitcoin scriptPubKey for the given CTxDestination. Returns a P2PKH
162 * script for a CKeyID destination, a P2SH script for a CScriptID, and an empty
163 * script for CNoDestination.
164 */
165CScript GetScriptForDestination(const CTxDestination& dest);
166
167#endif // BITCOIN_ADDRESSTYPE_H
168

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.