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.

7,277 bytes · SHA-256 f19122a3feb32a77… · 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://opensource.org/license/mit/.
4
5#include <private_broadcast.h>
6
7#include <util/check.h>
8
9#include <algorithm>
10#include <ranges>
11
12
13PrivateBroadcast::AddResult PrivateBroadcast::Add(const CTransactionRef& tx)
14    EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
15{
16    LOCK(m_mutex);
17    // Cleanup finished transactions
18    std::erase_if(m_transactions, [this](const auto& entry) {
19        const auto& state{entry.second};
20        return state.resolved && !IsPending(state) &&
21               std::ranges::all_of(state.send_statuses, [](const auto& status) { return status.disconnected; });
22    });
23
24    if (const auto it{m_transactions.find(tx)}; it != m_transactions.end()) {
25        if (it->second.send_statuses.size() < m_max_send_attempts) return AddResult::AlreadyPresent;
26
27        // A transaction that has reached m_max_send_attempts can be explicitly retried by adding it again.
28        it->second.time_added = NodeClock::now();
29        it->second.send_statuses.clear();
30        it->second.planned_sends = INITIAL_CONNECTION_COUNT;
31        it->second.resolved = false;
32        return AddResult::Added;
33    }
34
35    if (m_transactions.size() >= m_max_transactions) return AddResult::QueueFull;
36
37    m_transactions.try_emplace(tx);
38    return AddResult::Added;
39}
40
41std::optional<size_t> PrivateBroadcast::Remove(const CTransactionRef& tx)
42    EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
43{
44    LOCK(m_mutex);
45    const auto handle{m_transactions.extract(tx)};
46    if (handle) {
47        const auto& state{handle.mapped()};
48        const size_t planned{std::min(state.planned_sends, m_max_send_attempts)};
49        const size_t actual{state.send_statuses.size()};
50        return planned > actual ? planned - actual : 0;
51    }
52    return std::nullopt;
53}
54
55bool PrivateBroadcast::MarkResolved(const CTransactionRef& tx)
56{
57    LOCK(m_mutex);
58    const auto it{m_transactions.find(tx)};
59    if (it == m_transactions.end()) return false;
60    it->second.resolved = true;
61    return true;
62}
63
64void PrivateBroadcast::NodeDisconnected(NodeId nodeid)
65{
66    LOCK(m_mutex);
67    if (const auto entry{GetSendStatusByNode(nodeid)}) {
68        entry->send_status.disconnected = true;
69    }
70}
71
72bool PrivateBroadcast::TryGrantRetry(const CTransactionRef& tx)
73{
74    LOCK(m_mutex);
75    const auto it{m_transactions.find(tx)};
76    if (it == m_transactions.end() ||
77        it->second.resolved ||
78        IsPending(it->second) ||
79        it->second.planned_sends >= m_max_send_attempts) return false;
80    ++it->second.planned_sends;
81    return true;
82}
83
84std::optional<CTransactionRef> PrivateBroadcast::PickTxForSend(const NodeId& will_send_to_nodeid, const CService& will_send_to_address)
85    EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
86{
87    LOCK(m_mutex);
88
89    if (GetSendStatusByNode(will_send_to_nodeid).has_value()) { // nodeid reuse, shouldn't send >1 tx to a given node
90        Assume(false);
91        return std::nullopt;
92    }
93
94    auto pending_transactions{m_transactions | std::views::filter([this](const auto& entry) { return IsPending(entry.second); })};
95    const auto it{std::ranges::max_element(
96            pending_transactions,
97            [](const auto& a, const auto& b) { return a < b; },
98            [](const auto& el) { return DerivePriority(el.second.send_statuses); })};
99
100    if (it != pending_transactions.end()) {
101        auto& [tx, state]{*it};
102        state.send_statuses.emplace_back(will_send_to_nodeid, will_send_to_address, NodeClock::now());
103        return tx;
104    }
105
106    return std::nullopt;
107}
108
109std::optional<CTransactionRef> PrivateBroadcast::GetTxForNode(const NodeId& nodeid)
110    EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
111{
112    LOCK(m_mutex);
113    const auto tx_and_status{GetSendStatusByNode(nodeid)};
114    if (tx_and_status.has_value()) {
115        return tx_and_status.value().tx;
116    }
117    return std::nullopt;
118}
119
120void PrivateBroadcast::NodeConfirmedReception(const NodeId& nodeid)
121    EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
122{
123    LOCK(m_mutex);
124    const auto tx_and_status{GetSendStatusByNode(nodeid)};
125    if (tx_and_status.has_value()) {
126        tx_and_status.value().send_status.confirmed = NodeClock::now();
127    }
128}
129
130bool PrivateBroadcast::HavePendingTransactions()
131    EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
132{
133    LOCK(m_mutex);
134    return std::ranges::any_of(m_transactions, [this](const auto& entry) { return IsPending(entry.second); });
135}
136
137std::vector<CTransactionRef> PrivateBroadcast::GetStale() const
138    EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
139{
140    LOCK(m_mutex);
141    const auto now{NodeClock::now()};
142    std::vector<CTransactionRef> stale;
143    for (const auto& [tx, state] : m_transactions) {
144        if (state.resolved || state.planned_sends >= m_max_send_attempts) continue;
145        const Priority p{DerivePriority(state.send_statuses)};
146        if (p.num_confirmed == 0) {
147            if (state.time_added < now - INITIAL_STALE_DURATION) stale.push_back(tx);
148        } else {
149            if (p.last_confirmed < now - STALE_DURATION) stale.push_back(tx);
150        }
151    }
152    return stale;
153}
154
155std::vector<PrivateBroadcast::TxBroadcastInfo> PrivateBroadcast::GetBroadcastInfo() const
156    EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
157{
158    LOCK(m_mutex);
159    std::vector<TxBroadcastInfo> entries;
160    entries.reserve(m_transactions.size());
161
162    for (const auto& [tx, state] : m_transactions) {
163        if (state.resolved) continue;
164        std::vector<PeerSendInfo> peers;
165        peers.reserve(state.send_statuses.size());
166        for (const auto& status : state.send_statuses) {
167            peers.emplace_back(PeerSendInfo{.address = status.address, .sent = status.picked, .received = status.confirmed});
168        }
169        const size_t attempts_remaining{m_max_send_attempts - std::min(state.send_statuses.size(), m_max_send_attempts)};
170        entries.emplace_back(TxBroadcastInfo{.tx = tx, .time_added = state.time_added, .attempts_remaining = attempts_remaining, .peers = std::move(peers)});
171    }
172
173    return entries;
174}
175
176bool PrivateBroadcast::IsPending(const TxSendStatus& status) const
177{
178    // Deliberately ignore resolved so all initially scheduled connections can complete.
179    const size_t limit{std::min(status.planned_sends, m_max_send_attempts)};
180    return status.send_statuses.size() < limit;
181}
182
183PrivateBroadcast::Priority PrivateBroadcast::DerivePriority(const std::vector<SendStatus>& sent_to)
184{
185    Priority p;
186    p.num_picked = sent_to.size();
187    for (const auto& send_status : sent_to) {
188        p.last_picked = std::max(p.last_picked, send_status.picked);
189        if (send_status.confirmed.has_value()) {
190            ++p.num_confirmed;
191            p.last_confirmed = std::max(p.last_confirmed, send_status.confirmed.value());
192        }
193    }
194    return p;
195}
196
197std::optional<PrivateBroadcast::TxAndSendStatusForNode> PrivateBroadcast::GetSendStatusByNode(const NodeId& nodeid)
198    EXCLUSIVE_LOCKS_REQUIRED(m_mutex)
199{
200    AssertLockHeld(m_mutex);
201    for (auto& [tx, state] : m_transactions) {
202        for (auto& send_status : state.send_statuses) {
203            if (send_status.nodeid == nodeid) {
204                return TxAndSendStatusForNode{.tx = tx, .send_status = send_status};
205            }
206        }
207    }
208    return std::nullopt;
209}
210

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.