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.

12,287 bytes · SHA-256 da34611d18101d9e… · View upstream ↗

1// Copyright (c) 2013-present The Bitcoin Core developers
2// Distributed under the MIT software license, see the accompanying
3// file COPYING or http://www.opensource.org/licenses/mit-license.php.
4
5#include <common/system.h>
6#include <consensus/tx_check.h>
7#include <consensus/validation.h>
8#include <hash.h>
9#include <script/interpreter.h>
10#include <script/script.h>
11#include <serialize.h>
12#include <streams.h>
13#include <test/data/sighash.json.h>
14#include <test/util/common.h>
15#include <test/util/json.h>
16#include <test/util/random.h>
17#include <test/util/setup_common.h>
18#include <util/strencodings.h>
19
20#include <iostream>
21
22#include <boost/test/unit_test.hpp>
23
24#include <univalue.h>
25
26// Old script.cpp SignatureHash function
27uint256 static SignatureHashOld(CScript scriptCode, const CTransaction& txTo, unsigned int nIn, int nHashType)
28{
29    if (nIn >= txTo.vin.size())
30    {
31        return uint256::ONE;
32    }
33    CMutableTransaction txTmp(txTo);
34
35    // In case concatenating two scripts ends up with two codeseparators,
36    // or an extra one at the end, this prevents all those possible incompatibilities.
37    FindAndDelete(scriptCode, CScript(OP_CODESEPARATOR));
38
39    // Blank out other inputs' signatures
40    for (unsigned int i = 0; i < txTmp.vin.size(); i++)
41        txTmp.vin[i].scriptSig = CScript();
42    txTmp.vin[nIn].scriptSig = scriptCode;
43
44    // Blank out some of the outputs
45    if ((nHashType & 0x1f) == SIGHASH_NONE)
46    {
47        // Wildcard payee
48        txTmp.vout.clear();
49
50        // Let the others update at will
51        for (unsigned int i = 0; i < txTmp.vin.size(); i++)
52            if (i != nIn)
53                txTmp.vin[i].nSequence = 0;
54    }
55    else if ((nHashType & 0x1f) == SIGHASH_SINGLE)
56    {
57        // Only lock-in the txout payee at same index as txin
58        unsigned int nOut = nIn;
59        if (nOut >= txTmp.vout.size())
60        {
61            return uint256::ONE;
62        }
63        txTmp.vout.resize(nOut+1);
64        for (unsigned int i = 0; i < nOut; i++)
65            txTmp.vout[i].SetNull();
66
67        // Let the others update at will
68        for (unsigned int i = 0; i < txTmp.vin.size(); i++)
69            if (i != nIn)
70                txTmp.vin[i].nSequence = 0;
71    }
72
73    // Blank out other inputs completely, not recommended for open transactions
74    if (nHashType & SIGHASH_ANYONECANPAY)
75    {
76        txTmp.vin[0] = txTmp.vin[nIn];
77        txTmp.vin.resize(1);
78    }
79
80    // Serialize and hash
81    HashWriter ss{};
82    ss << TX_NO_WITNESS(txTmp) << nHashType;
83    return ss.GetHash();
84}
85
86struct SigHashTest : BasicTestingSetup {
87void RandomScript(CScript &script) {
88    static const opcodetype oplist[] = {OP_FALSE, OP_1, OP_2, OP_3, OP_CHECKSIG, OP_IF, OP_VERIF, OP_RETURN, OP_CODESEPARATOR};
89    script = CScript();
90    int ops = (m_rng.randrange(10));
91    for (int i=0; i<ops; i++)
92        script << oplist[m_rng.randrange(std::size(oplist))];
93}
94
95void RandomTransaction(CMutableTransaction& tx, bool fSingle)
96{
97    tx.version = m_rng.rand32();
98    tx.vin.clear();
99    tx.vout.clear();
100    tx.nLockTime = (m_rng.randbool()) ? m_rng.rand32() : 0;
101    int ins = (m_rng.randbits(2)) + 1;
102    int outs = fSingle ? ins : (m_rng.randbits(2)) + 1;
103    for (int in = 0; in < ins; in++) {
104        tx.vin.emplace_back();
105        CTxIn &txin = tx.vin.back();
106        txin.prevout.hash = Txid::FromUint256(m_rng.rand256());
107        txin.prevout.n = m_rng.randbits(2);
108        RandomScript(txin.scriptSig);
109        txin.nSequence = (m_rng.randbool()) ? m_rng.rand32() : std::numeric_limits<uint32_t>::max();
110    }
111    for (int out = 0; out < outs; out++) {
112        tx.vout.emplace_back();
113        CTxOut &txout = tx.vout.back();
114        txout.nValue = RandMoney(m_rng);
115        RandomScript(txout.scriptPubKey);
116    }
117}
118}; // struct SigHashTest
119
120BOOST_FIXTURE_TEST_SUITE(sighash_tests, SigHashTest)
121
122BOOST_AUTO_TEST_CASE(sighash_test)
123{
124    #if defined(PRINT_SIGHASH_JSON)
125    std::cout << "[\n";
126    std::cout << "\t[\"raw_transaction, script, input_index, hashType, signature_hash (result)\"],\n";
127    int nRandomTests = 500;
128    #else
129    int nRandomTests = 50000;
130    #endif
131    for (int i=0; i<nRandomTests; i++) {
132        int nHashType{int(m_rng.rand32())};
133        CMutableTransaction txTo;
134        RandomTransaction(txTo, (nHashType & 0x1f) == SIGHASH_SINGLE);
135        CScript scriptCode;
136        RandomScript(scriptCode);
137        int nIn = m_rng.randrange(txTo.vin.size());
138
139        uint256 sh, sho;
140        sho = SignatureHashOld(scriptCode, CTransaction(txTo), nIn, nHashType);
141        sh = SignatureHash(scriptCode, txTo, nIn, nHashType, 0, SigVersion::BASE);
142        #if defined(PRINT_SIGHASH_JSON)
143        DataStream ss;
144        ss << TX_WITH_WITNESS(txTo);
145
146        std::cout << "\t[\"" ;
147        std::cout << HexStr(ss) << "\", \"";
148        std::cout << HexStr(scriptCode) << "\", ";
149        std::cout << nIn << ", ";
150        std::cout << nHashType << ", \"";
151        std::cout << sho.GetHex() << "\"]";
152        if (i+1 != nRandomTests) {
153          std::cout << ",";
154        }
155        std::cout << "\n";
156        #endif
157        BOOST_CHECK(sh == sho);
158    }
159    #if defined(PRINT_SIGHASH_JSON)
160    std::cout << "]\n";
161    #endif
162}
163
164// Goal: check that SignatureHash generates correct hash
165BOOST_AUTO_TEST_CASE(sighash_from_data)
166{
167    UniValue tests = read_json(json_tests::sighash);
168
169    for (unsigned int idx = 0; idx < tests.size(); idx++) {
170        const UniValue& test = tests[idx];
171        std::string strTest = test.write();
172        if (test.size() < 1) // Allow for extra stuff (useful for comments)
173        {
174            BOOST_ERROR("Bad test: " << strTest);
175            continue;
176        }
177        if (test.size() == 1) continue; // comment
178
179        std::string raw_tx, raw_script, sigHashHex;
180        int nIn, nHashType;
181        uint256 sh;
182        CTransactionRef tx;
183        CScript scriptCode = CScript();
184
185        try {
186          // deserialize test data
187          raw_tx = test[0].get_str();
188          raw_script = test[1].get_str();
189          nIn = test[2].getInt<int>();
190          nHashType = test[3].getInt<int>();
191          sigHashHex = test[4].get_str();
192
193          SpanReader{ParseHex(raw_tx)} >> TX_WITH_WITNESS(tx);
194
195          TxValidationState state;
196          BOOST_CHECK_MESSAGE(CheckTransaction(*tx, state), strTest);
197          BOOST_CHECK(state.IsValid());
198
199          std::vector<unsigned char> raw = ParseHex(raw_script);
200          scriptCode.insert(scriptCode.end(), raw.begin(), raw.end());
201        } catch (...) {
202          BOOST_ERROR("Bad test, couldn't deserialize data: " << strTest);
203          continue;
204        }
205
206        sh = SignatureHash(scriptCode, *tx, nIn, nHashType, 0, SigVersion::BASE);
207        BOOST_CHECK_MESSAGE(sh.GetHex() == sigHashHex, strTest);
208    }
209}
210
211BOOST_AUTO_TEST_CASE(sighash_caching)
212{
213    // Get a script, transaction and parameters as inputs to the sighash function.
214    CScript scriptcode;
215    RandomScript(scriptcode);
216    CScript diff_scriptcode{scriptcode};
217    diff_scriptcode << OP_1;
218    CMutableTransaction tx;
219    RandomTransaction(tx, /*fSingle=*/false);
220    const auto in_index{static_cast<uint32_t>(m_rng.randrange(tx.vin.size()))};
221    const auto amount{m_rng.rand<CAmount>()};
222
223    // Exercise the sighash function under both legacy and segwit v0.
224    for (const auto sigversion: {SigVersion::BASE, SigVersion::WITNESS_V0}) {
225        // For each, run it against all the 6 standard hash types and a few additional random ones.
226        std::vector<int32_t> hash_types{{SIGHASH_ALL, SIGHASH_SINGLE, SIGHASH_NONE, SIGHASH_ALL | SIGHASH_ANYONECANPAY,
227                                          SIGHASH_SINGLE | SIGHASH_ANYONECANPAY, SIGHASH_NONE | SIGHASH_ANYONECANPAY,
228                                          SIGHASH_ANYONECANPAY, 0, std::numeric_limits<int32_t>::max()}};
229        for (int i{0}; i < 10; ++i) {
230            hash_types.push_back(i % 2 == 0 ? m_rng.rand<int8_t>() : m_rng.rand<int32_t>());
231        }
232
233        // Reuse the same cache across script types. This must not cause any issue as the cached value for one hash type must never
234        // be confused for another (instantiating the cache within the loop instead would prevent testing this).
235        SigHashCache cache;
236        for (const auto hash_type: hash_types) {
237            const bool expect_one{sigversion == SigVersion::BASE && ((hash_type & 0x1f) == SIGHASH_SINGLE) && in_index >= tx.vout.size()};
238
239            // The result of computing the sighash should be the same with or without cache.
240            const auto sighash_with_cache{SignatureHash(scriptcode, tx, in_index, hash_type, amount, sigversion, nullptr, &cache)};
241            const auto sighash_no_cache{SignatureHash(scriptcode, tx, in_index, hash_type, amount, sigversion, nullptr, nullptr)};
242            BOOST_CHECK_EQUAL(sighash_with_cache, sighash_no_cache);
243
244            // Calling the cached version again should return the same value again.
245            BOOST_CHECK_EQUAL(sighash_with_cache, SignatureHash(scriptcode, tx, in_index, hash_type, amount, sigversion, nullptr, &cache));
246
247            // While here we might as well also check that the result for legacy is the same as for the old SignatureHash() function.
248            if (sigversion == SigVersion::BASE) {
249                BOOST_CHECK_EQUAL(sighash_with_cache, SignatureHashOld(scriptcode, CTransaction(tx), in_index, hash_type));
250            }

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.