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.

6,565 bytes · SHA-256 241f24302c59b44f… · View upstream ↗

1// Copyright 2014 BitPay Inc.
2// Copyright (c) 2015-present The Bitcoin Core developers
3// Distributed under the MIT software license, see the accompanying
4// file COPYING or https://opensource.org/licenses/mit-license.php.
5
6#ifndef BITCOIN_UNIVALUE_INCLUDE_UNIVALUE_H
7#define BITCOIN_UNIVALUE_INCLUDE_UNIVALUE_H
8
9#include <charconv>
10#include <cstddef>
11#include <cstdint>
12#include <map>
13#include <stdexcept>
14#include <string>
15#include <string_view>
16#include <system_error>
17#include <type_traits>
18#include <utility>
19#include <vector>
20
21// NOLINTNEXTLINE(misc-no-recursion)
22class UniValue {
23public:
24    enum VType { VNULL, VOBJ, VARR, VSTR, VNUM, VBOOL, };
25
26    class type_error : public std::runtime_error
27    {
28        using std::runtime_error::runtime_error;
29    };
30
31    UniValue() { typ = VNULL; }
32    UniValue(UniValue::VType type, std::string str = {}) : typ{type}, val{std::move(str)} {}
33    template <typename Ref, typename T = std::remove_cv_t<std::remove_reference_t<Ref>>,
34              std::enable_if_t<std::is_floating_point_v<T> ||                      // setFloat
35                                   std::is_same_v<bool, T> ||                      // setBool
36                                   std::is_signed_v<T> || std::is_unsigned_v<T> || // setInt
37                                   std::is_constructible_v<std::string, T>,        // setStr
38                               bool> = true>
39    UniValue(Ref&& val)
40    {
41        if constexpr (std::is_floating_point_v<T>) {
42            setFloat(val);
43        } else if constexpr (std::is_same_v<bool, T>) {
44            setBool(val);
45        } else if constexpr (std::is_signed_v<T>) {
46            setInt(int64_t{val});
47        } else if constexpr (std::is_unsigned_v<T>) {
48            setInt(uint64_t{val});
49        } else {
50            setStr(std::string{std::forward<Ref>(val)});
51        }
52    }
53
54    void clear();
55
56    void setNull();
57    void setBool(bool val);
58    void setNumStr(std::string str);
59    void setInt(uint64_t val);
60    void setInt(int64_t val);
61    void setInt(int val_) { return setInt(int64_t{val_}); }
62    void setFloat(double val);
63    void setStr(std::string str);
64    void setArray();
65    void setObject();
66
67    enum VType getType() const { return typ; }
68    const std::string& getValStr() const { return val; }
69    bool empty() const { return (values.size() == 0); }
70
71    size_t size() const { return values.size(); }
72
73    void reserve(size_t new_cap);
74
75    void getObjMap(std::map<std::string,UniValue>& kv) const;
76    bool checkObject(const std::map<std::string,UniValue::VType>& memberTypes) const;
77    const UniValue& operator[](const std::string& key) const;
78    const UniValue& operator[](size_t index) const;
79    bool exists(const std::string& key) const { size_t i; return findKey(key, i); }
80
81    bool isNull() const { return (typ == VNULL); }
82    bool isTrue() const { return (typ == VBOOL) && (val == "1"); }
83    bool isFalse() const { return (typ == VBOOL) && (val != "1"); }
84    bool isBool() const { return (typ == VBOOL); }
85    bool isStr() const { return (typ == VSTR); }
86    bool isNum() const { return (typ == VNUM); }
87    bool isArray() const { return (typ == VARR); }
88    bool isObject() const { return (typ == VOBJ); }
89
90    void push_back(UniValue val);
91    void push_backV(const std::vector<UniValue>& vec);
92    template <class It>
93    void push_backV(It first, It last);
94
95    void pushKVEnd(std::string key, UniValue val);
96    void pushKV(std::string key, UniValue val);
97    void pushKVs(UniValue obj);
98
99    std::string write(unsigned int prettyIndent = 0,
100                      unsigned int indentLevel = 0) const;
101
102    /// Parse JSON; set value to null on failure.
103    [[nodiscard]] bool read(std::string_view json);
104
105private:
106    UniValue::VType typ;
107    std::string val;                       // numbers are stored as C++ strings
108    std::vector<std::string> keys;
109    std::vector<UniValue> values;
110
111    void checkType(const VType& expected) const;
112    bool findKey(const std::string& key, size_t& retIdx) const;
113    void writeArray(unsigned int prettyIndent, unsigned int indentLevel, std::string& s) const;
114    void writeObject(unsigned int prettyIndent, unsigned int indentLevel, std::string& s) const;
115    /// Internal parser: May leave this value in an invalid state on failure.
116    [[nodiscard]] bool read_impl(std::string_view str_in);
117
118public:
119    // Strict type-specific getters, these throw std::runtime_error if the
120    // value is of unexpected type
121    const std::vector<std::string>& getKeys() const;
122    const std::vector<UniValue>& getValues() const;
123    template <typename Int>
124    Int getInt() const;
125    bool get_bool() const;
126    const std::string& get_str() const;
127    double get_real() const;
128    const UniValue& get_obj() const;
129    const UniValue& get_array() const;
130
131    enum VType type() const { return getType(); }
132    const UniValue& find_value(std::string_view key) const;
133};
134
135template <class It>
136void UniValue::push_backV(It first, It last)
137{
138    checkType(VARR);
139    values.insert(values.end(), first, last);
140}
141
142template <typename Int>
143Int UniValue::getInt() const
144{
145    static_assert(std::is_integral_v<Int>);
146    checkType(VNUM);
147    Int result;
148    const auto [first_nonmatching, error_condition] = std::from_chars(val.data(), val.data() + val.size(), result);
149    if (first_nonmatching != val.data() + val.size() || error_condition != std::errc{}) {
150        throw std::runtime_error("JSON integer out of range");
151    }
152    return result;
153}
154
155enum jtokentype {
156    JTOK_ERR        = -1,
157    JTOK_NONE       = 0,                           // eof
158    JTOK_OBJ_OPEN,
159    JTOK_OBJ_CLOSE,
160    JTOK_ARR_OPEN,
161    JTOK_ARR_CLOSE,
162    JTOK_COLON,
163    JTOK_COMMA,
164    JTOK_KW_NULL,
165    JTOK_KW_TRUE,
166    JTOK_KW_FALSE,
167    JTOK_NUMBER,
168    JTOK_STRING,
169};
170
171extern enum jtokentype getJsonToken(std::string& tokenVal,
172                                    unsigned int& consumed, const char *raw, const char *end);
173extern const char *uvTypeName(UniValue::VType t);
174
175static inline bool jsonTokenIsValue(enum jtokentype jtt)
176{
177    switch (jtt) {
178    case JTOK_KW_NULL:
179    case JTOK_KW_TRUE:
180    case JTOK_KW_FALSE:
181    case JTOK_NUMBER:
182    case JTOK_STRING:
183        return true;
184
185    default:
186        return false;
187    }
188
189    // not reached
190}
191
192static inline bool json_isspace(int ch)
193{
194    switch (ch) {
195    case 0x20:
196    case 0x09:
197    case 0x0a:
198    case 0x0d:
199        return true;
200
201    default:
202        return false;
203    }
204
205    // not reached
206}
207
208extern const UniValue NullUniValue;
209
210#endif // BITCOIN_UNIVALUE_INCLUDE_UNIVALUE_H
211

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.