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.

45,310 bytes · SHA-256 3c318d03f07bf3c5… · 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#include <rest.h>
7
8#include <blockfilter.h>
9#include <chain.h>
10#include <coins.h>
11#include <consensus/params.h>
12#include <core_io.h>
13#include <crypto/hex_base.h>
14#include <flatfile.h>
15#include <httpserver.h>
16#include <index/blockfilterindex.h>
17#include <index/txindex.h>
18#include <node/blockstorage.h>
19#include <node/context.h>
20#include <node/transaction.h>
21#include <primitives/block.h>
22#include <primitives/transaction.h>
23#include <rpc/blockchain.h>
24#include <rpc/mempool.h>
25#include <rpc/protocol.h>
26#include <rpc/request.h>
27#include <rpc/server.h>
28#include <rpc/util.h>
29#include <serialize.h>
30#include <streams.h>
31#include <sync.h>
32#include <tinyformat.h>
33#include <txmempool.h>
34#include <uint256.h>
35#include <undo.h>
36#include <univalue.h>
37#include <util/any.h>
38#include <util/check.h>
39#include <util/overflow.h>
40#include <util/strencodings.h>
41#include <util/string.h>
42#include <validation.h>
43
44#include <any>
45#include <cstdint>
46#include <cstring>
47#include <ios>
48#include <memory>
49#include <optional>
50#include <span>
51#include <stdexcept>
52#include <string_view>
53#include <utility>
54#include <vector>
55
56using node::GetTransaction;
57using node::NodeContext;
58using util::SplitString;
59
60static const size_t MAX_GETUTXOS_OUTPOINTS = 15; //allow a max of 15 outpoints to be queried at once
61static constexpr unsigned int MAX_REST_HEADERS_RESULTS = 2000;
62
63// Cache-Control values for REST responses.
64/** Response bytes never change. One-day TTL limits staleness across software upgrades. */
65static constexpr const char* REST_CACHE_IMMUTABLE = "public, immutable, max-age=86400";
66/** Mutable, node-local, or error response; must not be cached. */
67static constexpr const char* REST_CACHE_NO_STORE = "no-store";
68
69static const struct {
70    RESTResponseFormat rf;
71    const char* name;
72} rf_names[] = {
73      {RESTResponseFormat::UNDEF, ""},
74      {RESTResponseFormat::BINARY, "bin"},
75      {RESTResponseFormat::HEX, "hex"},
76      {RESTResponseFormat::JSON, "json"},
77};
78
79struct CCoin {
80    uint32_t nHeight;
81    CTxOut out;
82
83    CCoin() : nHeight(0) {}
84    explicit CCoin(Coin&& in) : nHeight(in.nHeight), out(std::move(in.out)) {}
85
86    SERIALIZE_METHODS(CCoin, obj)
87    {
88        uint32_t nTxVerDummy = 0;
89        READWRITE(nTxVerDummy, obj.nHeight, obj.out);
90    }
91};
92
93static bool RESTERR(HTTPRequest* req, enum HTTPStatusCode status, std::string message)
94{
95    req->WriteHeader("Cache-Control", REST_CACHE_NO_STORE);
96    req->WriteHeader("Content-Type", "text/plain");
97    req->WriteReply(status, message + "\r\n");
98    return false;
99}
100
101/**
102 * Get the node context.
103 *
104 * @param[in]  req  The HTTP request, whose status code will be set if node
105 *                  context is not found.
106 * @returns         Pointer to the node context or nullptr if not found.
107 */
108static NodeContext* GetNodeContext(const std::any& context, HTTPRequest* req)
109{
110    auto node_context = util::AnyPtr<NodeContext>(context);
111    if (!node_context) {
112        RESTERR(req, HTTP_INTERNAL_SERVER_ERROR, STR_INTERNAL_BUG("Node context not found!"));
113        return nullptr;
114    }
115    return node_context;
116}
117
118/**
119 * Get the node context mempool.
120 *
121 * @param[in]  req The HTTP request, whose status code will be set if node
122 *                 context mempool is not found.
123 * @returns        Pointer to the mempool or nullptr if no mempool found.
124 */
125static CTxMemPool* GetMemPool(const std::any& context, HTTPRequest* req)
126{
127    auto node_context = util::AnyPtr<NodeContext>(context);
128    if (!node_context || !node_context->mempool) {
129        RESTERR(req, HTTP_NOT_FOUND, "Mempool disabled or instance not found");
130        return nullptr;
131    }
132    return node_context->mempool.get();
133}
134
135/**
136 * Get the node context chainstatemanager.
137 *
138 * @param[in]  req The HTTP request, whose status code will be set if node
139 *                 context chainstatemanager is not found.
140 * @returns        Pointer to the chainstatemanager or nullptr if none found.
141 */
142static ChainstateManager* GetChainman(const std::any& context, HTTPRequest* req)
143{
144    auto node_context = util::AnyPtr<NodeContext>(context);
145    if (!node_context || !node_context->chainman) {
146        RESTERR(req, HTTP_INTERNAL_SERVER_ERROR, STR_INTERNAL_BUG("Chainman disabled or instance not found!"));
147        return nullptr;
148    }
149    return node_context->chainman.get();
150}
151
152RESTResponseFormat ParseDataFormat(std::string& param, const std::string& strReq)
153{
154    // Remove query string (if any, separated with '?') as it should not interfere with
155    // parsing param and data format
156    param = strReq.substr(0, strReq.rfind('?'));
157    const std::string::size_type pos_format{param.rfind('.')};
158
159    // No format string is found
160    if (pos_format == std::string::npos) {
161        return RESTResponseFormat::UNDEF;
162    }
163
164    // Match format string to available formats
165    const std::string suffix(param, pos_format + 1);
166    for (const auto& rf_name : rf_names) {
167        if (suffix == rf_name.name) {
168            param.erase(pos_format);
169            return rf_name.rf;
170        }
171    }
172
173    // If no suffix is found, return RESTResponseFormat::UNDEF and original string without query string
174    return RESTResponseFormat::UNDEF;
175}
176
177static std::string AvailableDataFormatsString()
178{
179    std::string formats;
180    for (const auto& rf_name : rf_names) {
181        if (strlen(rf_name.name) > 0) {
182            formats.append(".");
183            formats.append(rf_name.name);
184            formats.append(", ");
185        }
186    }
187
188    if (formats.length() > 0)
189        return formats.substr(0, formats.length() - 2);
190
191    return formats;
192}
193
194static bool CheckWarmup(HTTPRequest* req)
195{
196    std::string statusmessage;
197    if (RPCIsInWarmup(&statusmessage))
198         return RESTERR(req, HTTP_SERVICE_UNAVAILABLE, "Service temporarily unavailable: " + statusmessage);
199    return true;
200}
201
202static bool rest_headers(const std::any& context,
203                         HTTPRequest* req,
204                         const std::string& uri_part)
205{
206    if (!CheckWarmup(req))
207        return false;
208    std::string param;
209    const RESTResponseFormat rf = ParseDataFormat(param, uri_part);
210    std::vector<std::string> path = SplitString(param, '/');
211
212    std::string raw_count;
213    std::string hashStr;
214    if (path.size() == 2) {
215        // deprecated path: /rest/headers/<count>/<hash>
216        hashStr = path[1];
217        raw_count = path[0];
218    } else if (path.size() == 1) {
219        // new path with query parameter: /rest/headers/<hash>?count=<count>
220        hashStr = path[0];
221        try {
222            raw_count = req->GetQueryParameter("count").value_or("5");
223        } catch (const std::runtime_error& e) {
224            return RESTERR(req, HTTP_BAD_REQUEST, e.what());
225        }
226    } else {
227        return RESTERR(req, HTTP_BAD_REQUEST, "Invalid URI format. Expected /rest/headers/<hash>.<ext>?count=<count>");
228    }
229
230    const auto parsed_count{ToIntegral<size_t>(raw_count)};
231    if (!parsed_count.has_value() || *parsed_count < 1 || *parsed_count > MAX_REST_HEADERS_RESULTS) {
232        return RESTERR(req, HTTP_BAD_REQUEST, strprintf("Header count is invalid or out of acceptable range (1-%u): %s", MAX_REST_HEADERS_RESULTS, raw_count));
233    }
234
235    auto hash{uint256::FromHex(hashStr)};
236    if (!hash) {
237        return RESTERR(req, HTTP_BAD_REQUEST, "Invalid hash: " + hashStr);
238    }
239
240    const CBlockIndex* tip = nullptr;
241    std::vector<const CBlockIndex*> headers;
242    headers.reserve(*parsed_count);
243    ChainstateManager* maybe_chainman = GetChainman(context, req);
244    if (!maybe_chainman) return false;
245    ChainstateManager& chainman = *maybe_chainman;
246    {
247        LOCK(cs_main);
248        CChain& active_chain = chainman.ActiveChain();
249        tip = active_chain.Tip();
250        const CBlockIndex* pindex{chainman.m_blockman.LookupBlockIndex(*hash)};

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.