Branch data Line data Source code
1 : : // Copyright (c) 2009-2022 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 <arith_uint256.h>
8 : : #include <chain.h>
9 : : #include <chainparams.h>
10 : : #include <chainparamsbase.h>
11 : : #include <clientversion.h>
12 : : #include <common/args.h>
13 : : #include <common/system.h>
14 : : #include <compat/compat.h>
15 : : #include <core_io.h>
16 : : #include <streams.h>
17 : : #include <util/exception.h>
18 : : #include <util/strencodings.h>
19 : : #include <util/translation.h>
20 : :
21 : : #include <atomic>
22 : : #include <cstdio>
23 : : #include <functional>
24 : : #include <memory>
25 : : #include <thread>
26 : :
27 : : static const int CONTINUE_EXECUTION=-1;
28 : :
29 : : const std::function<std::string(const char*)> G_TRANSLATION_FUN = nullptr;
30 : :
31 : 5 : static void SetupBitcoinUtilArgs(ArgsManager &argsman)
32 : : {
33 : 5 : SetupHelpOptions(argsman);
34 : :
35 [ + - + - ]: 10 : argsman.AddArg("-version", "Print version and exit", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
36 : :
37 [ + - + - ]: 10 : argsman.AddCommand("grind", "Perform proof of work on hex header string");
38 : :
39 : 5 : SetupChainParamsBaseOptions(argsman);
40 : 5 : }
41 : :
42 : : // This function returns either one of EXIT_ codes when it's expected to stop the process or
43 : : // CONTINUE_EXECUTION when it's expected to continue further.
44 : 5 : static int AppInitUtil(ArgsManager& args, int argc, char* argv[])
45 : : {
46 : 5 : SetupBitcoinUtilArgs(args);
47 [ + - ]: 5 : std::string error;
48 [ + - + + ]: 5 : if (!args.ParseParameters(argc, argv, error)) {
49 [ + - ]: 2 : tfm::format(std::cerr, "Error parsing command line arguments: %s\n", error);
50 : : return EXIT_FAILURE;
51 : : }
52 : :
53 [ + - + - : 6 : if (HelpRequested(args) || args.IsArgSet("-version")) {
+ - + - +
- - + ]
54 : : // First part of help message is specific to this utility
55 [ # # # # ]: 0 : std::string strUsage = CLIENT_NAME " bitcoin-util utility version " + FormatFullVersion() + "\n";
56 : :
57 [ # # # # : 0 : if (args.IsArgSet("-version")) {
# # ]
58 [ # # # # ]: 0 : strUsage += FormatParagraph(LicenseInfo());
59 : : } else {
60 [ # # ]: 0 : strUsage += "\n"
61 : 0 : "Usage: bitcoin-util [options] [commands] Do stuff\n";
62 [ # # # # ]: 0 : strUsage += "\n" + args.GetHelpMessage();
63 : : }
64 : :
65 [ # # ]: 0 : tfm::format(std::cout, "%s", strUsage);
66 : :
67 [ # # ]: 0 : if (argc < 2) {
68 [ # # ]: 0 : tfm::format(std::cerr, "Error: too few parameters\n");
69 : : return EXIT_FAILURE;
70 : : }
71 : : return EXIT_SUCCESS;
72 : 0 : }
73 : :
74 : : // Check for chain settings (Params() calls are only valid after this clause)
75 : 3 : try {
76 [ + - + - ]: 3 : SelectParams(args.GetChainType());
77 [ - - ]: 0 : } catch (const std::exception& e) {
78 [ - - ]: 0 : tfm::format(std::cerr, "Error: %s\n", e.what());
79 : 0 : return EXIT_FAILURE;
80 : 0 : }
81 : :
82 : : return CONTINUE_EXECUTION;
83 : 5 : }
84 : :
85 : 0 : static void grind_task(uint32_t nBits, CBlockHeader header, uint32_t offset, uint32_t step, std::atomic<bool>& found, uint32_t& proposed_nonce)
86 : : {
87 : 0 : arith_uint256 target;
88 : 0 : bool neg, over;
89 : 0 : target.SetCompact(nBits, &neg, &over);
90 [ # # # # : 0 : if (target == 0 || neg || over) return;
# # ]
91 : 0 : header.nNonce = offset;
92 : :
93 : 0 : uint32_t finish = std::numeric_limits<uint32_t>::max() - step;
94 : 0 : finish = finish - (finish % step) + offset;
95 : :
96 [ # # # # ]: 0 : while (!found && header.nNonce < finish) {
97 [ # # ]: 0 : const uint32_t next = (finish - header.nNonce < 5000*step) ? finish : header.nNonce + 5000*step;
98 : 0 : do {
99 [ # # ]: 0 : if (UintToArith256(header.GetHash()) <= target) {
100 [ # # ]: 0 : if (!found.exchange(true)) {
101 : 0 : proposed_nonce = header.nNonce;
102 : : }
103 : 0 : return;
104 : : }
105 : 0 : header.nNonce += step;
106 [ # # ]: 0 : } while(header.nNonce != next);
107 : : }
108 : : }
109 : :
110 : 3 : static int Grind(const std::vector<std::string>& args, std::string& strPrint)
111 : : {
112 [ + + ]: 3 : if (args.size() != 1) {
113 : 2 : strPrint = "Must specify block header to grind";
114 : 2 : return EXIT_FAILURE;
115 : : }
116 : :
117 : 1 : CBlockHeader header;
118 [ + - ]: 1 : if (!DecodeHexBlockHeader(header, args[0])) {
119 : 1 : strPrint = "Could not decode block header";
120 : 1 : return EXIT_FAILURE;
121 : : }
122 : :
123 : 0 : uint32_t nBits = header.nBits;
124 : 0 : std::atomic<bool> found{false};
125 : 0 : uint32_t proposed_nonce{};
126 : :
127 : 0 : std::vector<std::thread> threads;
128 [ # # ]: 0 : int n_tasks = std::max(1u, std::thread::hardware_concurrency());
129 [ # # ]: 0 : threads.reserve(n_tasks);
130 [ # # ]: 0 : for (int i = 0; i < n_tasks; ++i) {
131 [ # # ]: 0 : threads.emplace_back(grind_task, nBits, header, i, n_tasks, std::ref(found), std::ref(proposed_nonce));
132 : : }
133 [ # # ]: 0 : for (auto& t : threads) {
134 [ # # ]: 0 : t.join();
135 : : }
136 [ # # ]: 0 : if (found) {
137 : 0 : header.nNonce = proposed_nonce;
138 : : } else {
139 [ # # ]: 0 : strPrint = "Could not satisfy difficulty target";
140 : : return EXIT_FAILURE;
141 : : }
142 : :
143 : 0 : DataStream ss{};
144 [ # # ]: 0 : ss << header;
145 [ # # ]: 0 : strPrint = HexStr(ss);
146 : 0 : return EXIT_SUCCESS;
147 : 0 : }
148 : :
149 : 5 : MAIN_FUNCTION
150 : : {
151 : 5 : ArgsManager& args = gArgs;
152 : 5 : SetupEnvironment();
153 : :
154 : 5 : try {
155 [ + - ]: 5 : int ret = AppInitUtil(args, argc, argv);
156 [ + + ]: 5 : if (ret != CONTINUE_EXECUTION) {
157 : : return ret;
158 : : }
159 [ - - ]: 0 : } catch (const std::exception& e) {
160 [ - - ]: 0 : PrintExceptionContinue(&e, "AppInitUtil()");
161 : 0 : return EXIT_FAILURE;
162 : 0 : } catch (...) {
163 [ - - ]: 0 : PrintExceptionContinue(nullptr, "AppInitUtil()");
164 : 0 : return EXIT_FAILURE;
165 : 0 : }
166 : :
167 : 3 : const auto cmd = args.GetCommand();
168 [ - + ]: 3 : if (!cmd) {
169 [ # # ]: 0 : tfm::format(std::cerr, "Error: must specify a command\n");
170 : : return EXIT_FAILURE;
171 : : }
172 : :
173 : 3 : int ret = EXIT_FAILURE;
174 [ + - ]: 3 : std::string strPrint;
175 : 3 : try {
176 [ + - ]: 3 : if (cmd->command == "grind") {
177 [ + - ]: 3 : ret = Grind(cmd->args, strPrint);
178 : : } else {
179 : 0 : assert(false); // unknown command should be caught earlier
180 : : }
181 [ - - ]: 0 : } catch (const std::exception& e) {
182 [ - - ]: 0 : strPrint = std::string("error: ") + e.what();
183 : 0 : } catch (...) {
184 [ - - ]: 0 : strPrint = "unknown error";
185 [ - - ]: 0 : }
186 : :
187 [ + - ]: 3 : if (strPrint != "") {
188 [ + - + - ]: 6 : tfm::format(ret == 0 ? std::cout : std::cerr, "%s\n", strPrint);
189 : : }
190 : :
191 : 3 : return ret;
192 : 6 : }
|
