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.

31,523 bytes · SHA-256 6ab60ab98b44892b… · View upstream ↗

1// Copyright (c) 2009-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 <bitcoin-build-config.h> // IWYU pragma: keep
6
7#include <chainparamsbase.h>
8#include <clientversion.h>
9#include <coins.h>
10#include <common/args.h>
11#include <common/license_info.h>
12#include <common/system.h>
13#include <compat/compat.h>
14#include <consensus/amount.h>
15#include <consensus/consensus.h>
16#include <core_io.h>
17#include <crypto/sha256.h>
18#include <key_io.h>
19#include <policy/policy.h>
20#include <primitives/transaction.h>
21#include <script/script.h>
22#include <script/sign.h>
23#include <script/signingprovider.h>
24#include <univalue.h>
25#include <util/exception.h>
26#include <util/fs.h>
27#include <util/moneystr.h>
28#include <util/rbf.h>
29#include <util/strencodings.h>
30#include <util/string.h>
31#include <util/translation.h>
32
33#include <cstdio>
34#include <functional>
35#include <memory>
36
37using util::SplitString;
38using util::ToString;
39using util::TrimString;
40using util::TrimStringView;
41
42static bool fCreateBlank;
43static std::map<std::string,UniValue> registers;
44static const int CONTINUE_EXECUTION=-1;
45
46const TranslateFn G_TRANSLATION_FUN{nullptr};
47
48static void SetupBitcoinTxArgs(ArgsManager &argsman)
49{
50    SetupHelpOptions(argsman);
51
52    argsman.AddArg("-version", "Print version and exit", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
53    argsman.AddArg("-create", "Create new, empty TX.", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
54    argsman.AddArg("-json", "Select JSON output", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
55    argsman.AddArg("-txid", "Output only the hex-encoded transaction id of the resultant transaction.", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
56    SetupChainParamsBaseOptions(argsman);
57
58    argsman.AddArg("delin=N", "Delete input N from TX", ArgsManager::ALLOW_ANY, OptionsCategory::COMMANDS);
59    argsman.AddArg("delout=N", "Delete output N from TX", ArgsManager::ALLOW_ANY, OptionsCategory::COMMANDS);
60    argsman.AddArg("in=TXID:VOUT(:SEQUENCE_NUMBER)", "Add input to TX", ArgsManager::ALLOW_ANY, OptionsCategory::COMMANDS);
61    argsman.AddArg("locktime=N", "Set TX lock time to N", ArgsManager::ALLOW_ANY, OptionsCategory::COMMANDS);
62    argsman.AddArg("nversion=N", "Set TX version to N", ArgsManager::ALLOW_ANY, OptionsCategory::COMMANDS);
63    argsman.AddArg("outaddr=VALUE:ADDRESS", "Add address-based output to TX", ArgsManager::ALLOW_ANY, OptionsCategory::COMMANDS);
64    argsman.AddArg("outdata=[VALUE:]DATA", "Add data-based output to TX", ArgsManager::ALLOW_ANY, OptionsCategory::COMMANDS);
65    argsman.AddArg("outmultisig=VALUE:REQUIRED:PUBKEYS:PUBKEY1:PUBKEY2:....[:FLAGS]", "Add Pay To n-of-m Multi-sig output to TX. n = REQUIRED, m = PUBKEYS. "
66        "Optionally add the \"W\" flag to produce a pay-to-witness-script-hash output. "
67        "Optionally add the \"S\" flag to wrap the output in a pay-to-script-hash.", ArgsManager::ALLOW_ANY, OptionsCategory::COMMANDS);
68    argsman.AddArg("outpubkey=VALUE:PUBKEY[:FLAGS]", "Add pay-to-pubkey output to TX. "
69        "Optionally add the \"W\" flag to produce a pay-to-witness-pubkey-hash output. "
70        "Optionally add the \"S\" flag to wrap the output in a pay-to-script-hash.", ArgsManager::ALLOW_ANY, OptionsCategory::COMMANDS);
71    argsman.AddArg("outscript=VALUE:SCRIPT[:FLAGS]", "Add raw script output to TX. "
72        "Optionally add the \"W\" flag to produce a pay-to-witness-script-hash output. "
73        "Optionally add the \"S\" flag to wrap the output in a pay-to-script-hash.", ArgsManager::ALLOW_ANY, OptionsCategory::COMMANDS);
74    argsman.AddArg("replaceable(=N)", "Sets Replace-By-Fee (RBF) opt-in sequence number for input N. "
75        "If N is not provided, the command attempts to opt-in all available inputs for RBF. "
76        "If the transaction has no inputs, this option is ignored.", ArgsManager::ALLOW_ANY, OptionsCategory::COMMANDS);
77    argsman.AddArg("sign=SIGHASH-FLAGS", "Add zero or more signatures to transaction. "
78        "This command requires JSON registers:"
79        "prevtxs=JSON object, "
80        "privatekeys=JSON object. "
81        "See signrawtransactionwithkey docs for format of sighash flags, JSON objects.", ArgsManager::ALLOW_ANY, OptionsCategory::COMMANDS);
82
83    argsman.AddArg("load=NAME:FILENAME", "Load JSON file FILENAME into register NAME", ArgsManager::ALLOW_ANY, OptionsCategory::REGISTER_COMMANDS);
84    argsman.AddArg("set=NAME:JSON-STRING", "Set register NAME to given JSON-STRING", ArgsManager::ALLOW_ANY, OptionsCategory::REGISTER_COMMANDS);
85}
86
87//
88// This function returns either one of EXIT_ codes when it's expected to stop the process or
89// CONTINUE_EXECUTION when it's expected to continue further.
90//
91static int AppInitRawTx(int argc, char* argv[])
92{
93    SetupBitcoinTxArgs(gArgs);
94    std::string error;
95    if (!gArgs.ParseParameters(argc, argv, error)) {
96        tfm::format(std::cerr, "Error parsing command line arguments: %s\n", error);
97        return EXIT_FAILURE;
98    }
99
100    // Check for chain settings (Params() calls are only valid after this clause)
101    try {
102        SelectParams(gArgs.GetChainType());
103    } catch (const std::exception& e) {
104        tfm::format(std::cerr, "Error: %s\n", e.what());
105        return EXIT_FAILURE;
106    }
107
108    fCreateBlank = gArgs.GetBoolArg("-create", false);
109
110    if (argc < 2 || HelpRequested(gArgs) || gArgs.GetBoolArg("-version", false)) {
111        // First part of help message is specific to this utility
112        std::string strUsage = CLIENT_NAME " bitcoin-tx utility version " + FormatFullVersion() + "\n";
113
114        if (gArgs.GetBoolArg("-version", false)) {
115            strUsage += FormatParagraph(LicenseInfo());
116        } else {
117            strUsage += "\n"
118                "The bitcoin-tx tool is used for creating and modifying bitcoin transactions.\n\n"
119                "bitcoin-tx can be used with \"<hex-tx> [commands]\" to update a hex-encoded bitcoin transaction, or with \"-create [commands]\" to create a hex-encoded bitcoin transaction.\n"
120                "\n"
121                "Usage: bitcoin-tx [options] <hex-tx> [commands]\n"
122                "or:    bitcoin-tx [options] -create [commands]\n"
123                "\n";
124            strUsage += gArgs.GetHelpMessage();
125        }
126
127        tfm::format(std::cout, "%s", strUsage);
128
129        if (argc < 2) {
130            tfm::format(std::cerr, "Error: too few parameters\n");
131            return EXIT_FAILURE;
132        }
133        return EXIT_SUCCESS;
134    }
135    return CONTINUE_EXECUTION;
136}
137
138static void RegisterSetJson(const std::string& key, const std::string& rawJson)
139{
140    UniValue val;
141    if (!val.read(rawJson)) {
142        std::string strErr = "Cannot parse JSON for key " + key;
143        throw std::runtime_error(strErr);
144    }
145
146    registers[key] = val;
147}
148
149static void RegisterSet(const std::string& strInput)
150{
151    // separate NAME:VALUE in string
152    size_t pos = strInput.find(':');
153    if ((pos == std::string::npos) ||
154        (pos == 0) ||
155        (pos == (strInput.size() - 1)))
156        throw std::runtime_error("Register input requires NAME:VALUE");
157
158    std::string key = strInput.substr(0, pos);
159    std::string valStr = strInput.substr(pos + 1, std::string::npos);
160
161    RegisterSetJson(key, valStr);
162}
163
164static void RegisterLoad(const std::string& strInput)
165{
166    // separate NAME:FILENAME in string
167    size_t pos = strInput.find(':');
168    if ((pos == std::string::npos) ||
169        (pos == 0) ||
170        (pos == (strInput.size() - 1)))
171        throw std::runtime_error("Register load requires NAME:FILENAME");
172
173    std::string key = strInput.substr(0, pos);
174    std::string filename = strInput.substr(pos + 1, std::string::npos);
175
176    FILE *f = fsbridge::fopen(filename.c_str(), "r");
177    if (!f) {
178        std::string strErr = "Cannot open file " + filename;
179        throw std::runtime_error(strErr);
180    }
181
182    // load file chunks into one big buffer
183    std::string valStr;
184    while ((!feof(f)) && (!ferror(f))) {
185        char buf[4096];
186        int bread = fread(buf, 1, sizeof(buf), f);
187        if (bread <= 0)
188            break;
189
190        valStr.insert(valStr.size(), buf, bread);
191    }
192
193    int error = ferror(f);
194    fclose(f);
195
196    if (error) {
197        std::string strErr = "Error reading file " + filename;
198        throw std::runtime_error(strErr);
199    }
200
201    // evaluate as JSON buffer register
202    RegisterSetJson(key, valStr);
203}
204
205static CAmount ExtractAndValidateValue(const std::string& strValue)
206{
207    if (std::optional<CAmount> parsed = ParseMoney(strValue)) {
208        return parsed.value();
209    } else {
210        throw std::runtime_error("invalid TX output value");
211    }
212}
213
214static void MutateTxVersion(CMutableTransaction& tx, const std::string& cmdVal)
215{
216    const auto ver{ToIntegral<uint32_t>(cmdVal)};
217    if (!ver || *ver < 1 || *ver > TX_MAX_STANDARD_VERSION) {
218        throw std::runtime_error("Invalid TX version requested: '" + cmdVal + "'");
219    }
220    tx.version = *ver;
221}
222
223static void MutateTxLocktime(CMutableTransaction& tx, const std::string& cmdVal)
224{
225    const auto locktime{ToIntegral<uint32_t>(cmdVal)};
226    if (!locktime) {
227        throw std::runtime_error("Invalid TX locktime requested: '" + cmdVal + "'");
228    }
229    tx.nLockTime = *locktime;
230}
231
232static void MutateTxRBFOptIn(CMutableTransaction& tx, const std::string& strInIdx)
233{
234    const auto idx{ToIntegral<uint32_t>(strInIdx)};
235    if (strInIdx != "" && (!idx || *idx >= tx.vin.size())) {
236        throw std::runtime_error("Invalid TX input index '" + strInIdx + "'");
237    }
238
239    // set the nSequence to MAX_INT - 2 (= RBF opt in flag)
240    uint32_t cnt{0};
241    for (CTxIn& txin : tx.vin) {
242        if (strInIdx == "" || cnt == *idx) {
243            if (txin.nSequence > MAX_BIP125_RBF_SEQUENCE) {
244                txin.nSequence = MAX_BIP125_RBF_SEQUENCE;
245            }
246        }
247        ++cnt;
248    }
249}
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

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.