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.

5,456 bytes · SHA-256 4258a2bf7fee5bbb… · View upstream ↗

1#!/usr/bin/env python3
2# Copyright (c) 2026 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"""Check that getopenrpcinfo RPC is callable and serializable as valid json."""
6
7import json
8
9from test_framework.test_framework import BitcoinTestFramework
10from test_framework.util import assert_equal
11
12
13def find_method(openrpc, name):
14    return next(method for method in openrpc["methods"] if method["name"] == name)
15
16
17def find_param(method, name):
18    return next(param for param in method["params"] if param["name"] == name)
19
20
21class OpenRPCDocTest(BitcoinTestFramework):
22    def set_test_params(self):
23        self.num_nodes = 1
24
25    def run_test(self):
26        self.log.info("Calling getopenrpcinfo")
27        openrpc = self.nodes[0].getopenrpcinfo()
28        json.dumps(openrpc)
29        assert_equal(openrpc["openrpc"], "1.4.1")
30        assert_equal(type(openrpc["openrpc"]).__name__, "str")
31        assert_equal(type(openrpc["info"]).__name__, "dict")
32        assert_equal(type(openrpc["methods"]).__name__, "list")
33
34        self.log.info("Calling rpc.discover")
35        if self.options.usecli:
36            discovered = self.nodes[0].cli("rpc.discover").send_cli()
37        else:
38            discovered = self.nodes[0].rpc.discover()
39        assert_equal(discovered, openrpc)
40        rpc_discover = find_method(discovered, "rpc.discover")
41        assert_equal(rpc_discover["params"], [])
42
43        stop = find_method(openrpc, "stop")
44        assert "wait" not in [param["name"] for param in stop["params"]]
45
46        self.log.info("Calling getopenrpcinfo with hidden commands")
47        openrpc_with_hidden = self.nodes[0].getopenrpcinfo(True)
48        stop_with_hidden = find_method(openrpc_with_hidden, "stop")
49        wait = find_param(stop_with_hidden, "wait")
50        assert_equal(wait["schema"]["type"], "number")
51
52        self.log.info("Checking type_str override schemas")
53        getblockstats = find_method(openrpc, "getblockstats")
54        hash_or_height = find_param(getblockstats, "hash_or_height")
55        assert_equal(hash_or_height["schema"], {"oneOf": [{"type": "integer"}, {"type": "string"}]})
56
57        self.log.info("Checking fixed-length array schemas")
58        deriveaddresses = find_method(openrpc, "deriveaddresses")
59        range_array = find_param(deriveaddresses, "range")["schema"]["oneOf"][1]
60        assert_equal(range_array, {
61            "type": "array",
62            "items": [{"type": "number"}, {"type": "number"}],
63            "additionalItems": False,
64            "minItems": 2,
65            "maxItems": 2,
66        })
67
68        feerate_percentiles = getblockstats["result"]["schema"]["properties"]["feerate_percentiles"]
69        assert_equal(feerate_percentiles["type"], "array")
70        assert_equal(feerate_percentiles["items"], [{"type": "number"}] * 5)
71        assert_equal(feerate_percentiles["additionalItems"], False)
72        assert_equal(feerate_percentiles["minItems"], 5)
73        assert_equal(feerate_percentiles["maxItems"], 5)
74
75        self.log.info("Checking relaxed schemas for unchecked RPC types")
76        createrawtransaction = find_method(openrpc, "createrawtransaction")
77        outputs = find_param(createrawtransaction, "outputs")
78        address_description = "A key-value pair. The key (string) is the bitcoin address, the value (float or string) is the amount in BTC"
79        address_obj = {"type": "object", "additionalProperties": {"oneOf": [{"type": "number"},{"type": "string"}]}, "description": address_description}
80        data_description = "A key-value pair. The key must be \"data\", the value is hex-encoded data that becomes a part of an OP_RETURN output"
81        data_obj = {"type": "object", "properties": { "data": {"type": "string", "pattern": "^([0-9a-fA-F]{2})*$", "description": data_description}}, "additionalProperties": False, "required": ["data"]}
82        assert_equal(outputs["schema"], {"oneOf": [{"type": "array", "items": {"anyOf": [address_obj, data_obj]}}, {"type": "object"}]})
83
84        getdescriptoractivity = find_method(openrpc, "getdescriptoractivity")
85        activity = getdescriptoractivity["result"]["schema"]["properties"]["activity"]
86        assert_equal(activity["type"], "array")
87
88        if "getwalletinfo" in [method["name"] for method in openrpc["methods"]]:
89            getwalletinfo = find_method(openrpc, "getwalletinfo")
90            scanning = getwalletinfo["result"]["schema"]["properties"]["scanning"]
91            assert_equal(scanning["oneOf"][0]["type"], "object")
92            assert_equal(scanning["oneOf"][1], {"const": False})
93
94        self.log.info("Checking argument fallback annotations")
95        getblock = find_method(openrpc, "getblock")
96        verbosity = find_param(getblock, "verbosity")
97        assert_equal(verbosity["schema"]["default"], 1)
98        stats = find_param(getblockstats, "stats")
99        assert_equal(stats["schema"]["x-bitcoin-default-hint"], "all values")
100
101        self.log.info("Checking numeric amount result annotations")
102        analyzepsbt = find_method(openrpc, "analyzepsbt")
103        result_schema = analyzepsbt["result"]["schema"]
104        estimated_feerate = result_schema["properties"]["estimated_feerate"]
105        assert_equal(estimated_feerate["type"], "number")
106        assert_equal(estimated_feerate["x-bitcoin-unit"], "amount")
107
108
109if __name__ == "__main__":
110    OpenRPCDocTest(__file__).main()
111

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.