Bitcoin Core 32.99.0
P2P Digital Currency
miner.cpp
Go to the documentation of this file.
1// Copyright (c) 2009-2010 Satoshi Nakamoto
2// Copyright (c) 2009-present 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
6#include <node/miner.h>
7
8#include <chain.h>
9#include <chainparams.h>
10#include <common/args.h>
11#include <consensus/amount.h>
12#include <consensus/consensus.h>
13#include <consensus/merkle.h>
14#include <consensus/params.h>
15#include <consensus/tx_verify.h>
17#include <interfaces/types.h>
18#include <node/blockstorage.h>
20#include <node/mining_args.h>
21#include <node/mining_types.h>
22#include <policy/feerate.h>
23#include <policy/policy.h>
24#include <pow.h>
25#include <primitives/block.h>
27#include <script/script.h>
28#include <sync.h>
29#include <tinyformat.h>
30#include <txgraph.h>
31#include <txmempool.h>
32#include <uint256.h>
33#include <util/check.h>
34#include <util/feefrac.h>
35#include <util/log.h>
36#include <util/result.h>
38#include <util/time.h>
39#include <util/translation.h>
40#include <validation.h>
41#include <validationinterface.h>
42#include <versionbits.h>
43
44#include <algorithm>
45#include <compare>
46#include <condition_variable>
47#include <cstddef>
48#include <functional>
49#include <numeric>
50#include <span>
51#include <stdexcept>
52#include <string>
53#include <utility>
54
55namespace node {
56
57int64_t GetMinimumTime(const CBlockIndex* pindexPrev, const int64_t difficulty_adjustment_interval)
58{
59 int64_t min_time{pindexPrev->GetMedianTimePast() + 1};
60 // Height of block to be mined.
61 const int height{pindexPrev->nHeight + 1};
62 // Account for BIP94 timewarp rule on all networks. This makes future
63 // activation safer.
64 if (height % difficulty_adjustment_interval == 0) {
65 min_time = std::max<int64_t>(min_time, pindexPrev->GetBlockTime() - MAX_TIMEWARP);
66 }
67 // Account for the BIP54 Murch-Zawy rule on all networks: the last block of
68 // a difficulty adjustment period may not be earlier than its first block.
69 if (height % difficulty_adjustment_interval == difficulty_adjustment_interval - 1) {
70 const int first_height{height - static_cast<int>(difficulty_adjustment_interval) + 1};
71 const CBlockIndex* first_block{Assert(pindexPrev->GetAncestor(first_height))};
72 min_time = std::max<int64_t>(min_time, first_block->GetBlockTime());
73 }
74 return min_time;
75}
76
77int64_t UpdateTime(CBlockHeader* pblock, const Consensus::Params& consensusParams, const CBlockIndex* pindexPrev)
78{
79 int64_t nOldTime = pblock->nTime;
80 int64_t nNewTime{std::max<int64_t>(GetMinimumTime(pindexPrev, consensusParams.DifficultyAdjustmentInterval()),
81 TicksSinceEpoch<std::chrono::seconds>(NodeClock::now()))};
82
83 if (nOldTime < nNewTime) {
84 pblock->nTime = nNewTime;
85 }
86
87 // Updating time can change work required on testnet:
88 if (consensusParams.fPowAllowMinDifficultyBlocks) {
89 pblock->nBits = GetNextWorkRequired(pindexPrev, pblock, consensusParams);
90 }
91
92 return nNewTime - nOldTime;
93}
94
96{
97 CMutableTransaction tx{*block.vtx.at(0)};
98 tx.vout.erase(tx.vout.begin() + GetWitnessCommitmentIndex(block));
99 block.vtx.at(0) = MakeTransactionRef(tx);
100
101 const CBlockIndex* prev_block = WITH_LOCK(::cs_main, return chainman.m_blockman.LookupBlockIndex(block.hashPrevBlock));
102 chainman.GenerateCoinbaseCommitment(block, prev_block);
103
104 block.hashMerkleRoot = BlockMerkleRoot(block);
105}
106
108 const CTxMemPool* mempool,
109 BlockCreateOptions options)
110 : chainparams{chainstate.m_chainman.GetParams()},
111 m_mempool{options.use_mempool ? mempool : nullptr},
112 m_chainstate{chainstate},
113 m_options{[&] {
114 if (auto result{CheckMiningOptions(options, /*use_argnames=*/false)}; !result) {
115 throw std::runtime_error(util::ErrorString(result).original);
116 }
117 return FlattenMiningOptions(std::move(options));
118 }()}
119{
120}
121
122void BlockAssembler::resetBlock()
123{
124 // Reserve space for fixed-size block header, txs count, and coinbase tx.
125 nBlockWeight = *Assert(m_options.block_reserved_weight);
126 nBlockSigOpsCost = m_options.coinbase_output_max_additional_sigops;
127
128 // These counters do not include coinbase tx
129 nBlockTx = 0;
130 nFees = 0;
131}
132
133std::unique_ptr<CBlockTemplate> BlockAssembler::CreateNewBlock()
134{
135 const auto time_start{SteadyClock::now()};
136
137 resetBlock();
138
139 pblocktemplate.reset(new CBlockTemplate());
140 CBlock* const pblock = &pblocktemplate->block; // pointer for convenience
141
142 // Add dummy coinbase tx as first transaction. It is skipped by the
143 // getblocktemplate RPC and mining interface consumers must not use it.
144 pblock->vtx.emplace_back();
145
147 CBlockIndex* pindexPrev = m_chainstate.m_chain.Tip();
148 assert(pindexPrev != nullptr);
149 nHeight = pindexPrev->nHeight + 1;
150
151 pblock->nVersion = m_chainstate.m_chainman.m_versionbitscache.ComputeBlockVersion(pindexPrev, chainparams.GetConsensus());
152 // -regtest only: allow overriding block.nVersion with
153 // -blockversion=N to test forking scenarios
154 if (chainparams.MineBlocksOnDemand()) {
155 pblock->nVersion = gArgs.GetIntArg("-blockversion", pblock->nVersion);
156 }
157
158 pblock->nTime = TicksSinceEpoch<std::chrono::seconds>(NodeClock::now());
159 m_lock_time_cutoff = pindexPrev->GetMedianTimePast();
160
161 if (m_mempool) {
162 LOCK(m_mempool->cs);
163 m_mempool->StartBlockBuilding();
164 addChunks();
165 m_mempool->StopBlockBuilding();
166 }
167
168 const auto time_1{SteadyClock::now()};
169
170 m_last_block_num_txs = nBlockTx;
171 m_last_block_weight = nBlockWeight;
172
173 // Create coinbase transaction.
174 CMutableTransaction coinbaseTx;
175
176 // Construct coinbase transaction struct in parallel
177 CoinbaseTx& coinbase_tx{pblocktemplate->m_coinbase_tx};
178 coinbase_tx.version = coinbaseTx.version;
179
180 coinbaseTx.vin.resize(1);
181 coinbaseTx.vin[0].prevout.SetNull();
182 coinbaseTx.vin[0].nSequence = CTxIn::MAX_SEQUENCE_NONFINAL; // Make sure timelock is enforced.
183 coinbase_tx.sequence = coinbaseTx.vin[0].nSequence;
184
185 // Add an output that spends the full coinbase reward.
186 coinbaseTx.vout.resize(1);
187 coinbaseTx.vout[0].scriptPubKey = m_options.coinbase_output_script;
188 // Block subsidy + fees
189 const CAmount block_reward{nFees + GetBlockSubsidy(nHeight, chainparams.GetConsensus())};
190 coinbaseTx.vout[0].nValue = block_reward;
191 coinbase_tx.block_reward_remaining = block_reward;
192
193 // Start the coinbase scriptSig with the block height as required by BIP34.
194 // Mining clients are expected to append extra data to this prefix, so
195 // increasing its length would reduce the space they can use and may break
196 // existing clients.
197 coinbaseTx.vin[0].scriptSig = CScript() << nHeight;
198 // Set script_sig_prefix here, so IPC mining clients are not affected by
199 // the optional scriptSig padding below. They provide their own extraNonce,
200 // and in a typical setup a pool name or realistic extraNonce already makes
201 // the scriptSig long enough.
202 coinbase_tx.script_sig_prefix = coinbaseTx.vin[0].scriptSig;
203 if (nHeight <= 16) {
204 // For blocks at heights <= 16, the BIP34-encoded height alone is only
205 // one byte. Consensus requires coinbase scriptSigs to be at least two
206 // bytes long (bad-cb-length), so an OP_0 is always appended at those
207 // heights.
208 coinbaseTx.vin[0].scriptSig << OP_0;
209 }
210 Assert(nHeight > 0);
211 coinbaseTx.nLockTime = static_cast<uint32_t>(nHeight - 1);
212 coinbase_tx.lock_time = coinbaseTx.nLockTime;
213
214 pblock->vtx[0] = MakeTransactionRef(std::move(coinbaseTx));
215 m_chainstate.m_chainman.GenerateCoinbaseCommitment(*pblock, pindexPrev);
216
217 const CTransactionRef& final_coinbase{pblock->vtx[0]};
218 if (final_coinbase->HasWitness()) {
219 const auto& witness_stack{final_coinbase->vin[0].scriptWitness.stack};
220 // Consensus requires the coinbase witness stack to have exactly one
221 // element of 32 bytes.
222 Assert(witness_stack.size() == 1 && witness_stack[0].size() == 32);
223 coinbase_tx.witness = uint256(witness_stack[0]);
224 }
225 if (const int witness_index = GetWitnessCommitmentIndex(*pblock); witness_index != NO_WITNESS_COMMITMENT) {
226 Assert(witness_index >= 0 && static_cast<size_t>(witness_index) < final_coinbase->vout.size());
227 coinbase_tx.required_outputs.push_back(final_coinbase->vout[witness_index]);
228 }
229
230 LogInfo("CreateNewBlock(): block weight: %u txs: %u fees: %ld sigops %d\n", GetBlockWeight(*pblock), nBlockTx, nFees, nBlockSigOpsCost);
231
232 // Fill in header
233 pblock->hashPrevBlock = pindexPrev->GetBlockHash();
234 UpdateTime(pblock, chainparams.GetConsensus(), pindexPrev);
235 pblock->nBits = GetNextWorkRequired(pindexPrev, pblock, chainparams.GetConsensus());
236 pblock->nNonce = 0;
237
238 if (m_options.test_block_validity) {
239 if (BlockValidationState state{TestBlockValidity(m_chainstate, *pblock, /*check_pow=*/false, /*check_merkle_root=*/false)}; !state.IsValid()) {
240 throw std::runtime_error(strprintf("TestBlockValidity failed: %s", state.ToString()));
241 }
242 }
243 const auto time_2{SteadyClock::now()};
244
245 LogDebug(BCLog::BENCH, "CreateNewBlock() chunks: %.2fms, validity: %.2fms (total %.2fms)\n",
246 Ticks<MillisecondsDouble>(time_1 - time_start),
247 Ticks<MillisecondsDouble>(time_2 - time_1),
248 Ticks<MillisecondsDouble>(time_2 - time_start));
249
250 return std::move(pblocktemplate);
251}
252
253bool BlockAssembler::TestChunkBlockLimits(int64_t chunk_weight, int64_t chunk_sigops_cost) const
254{
255 // block_max_weight has been flattened before block assembly limit checks.
256 Assert(m_options.block_max_weight);
257 if (nBlockWeight + chunk_weight >= m_options.block_max_weight) {
258 return false;
259 }
260 if (nBlockSigOpsCost + chunk_sigops_cost >= MAX_BLOCK_SIGOPS_COST) {
261 return false;
262 }
263 return true;
264}
265
266// Perform transaction-level checks before adding to block:
267// - transaction finality (locktime)
268bool BlockAssembler::TestChunkTransactions(const std::vector<CTxMemPoolEntryRef>& txs) const
269{
270 for (const auto tx : txs) {
271 if (!IsFinalTx(tx.get().GetTx(), nHeight, m_lock_time_cutoff)) {
272 return false;
273 }
274 }
275 return true;
276}
277
278void BlockAssembler::AddToBlock(const CTxMemPoolEntry& entry)
279{
280 pblocktemplate->block.vtx.emplace_back(entry.GetSharedTx());
281 pblocktemplate->vTxFees.push_back(entry.GetFee());
282 pblocktemplate->vTxSigOpsCost.push_back(entry.GetSigOpCost());
283 nBlockWeight += entry.GetTxWeight();
284 ++nBlockTx;
285 nBlockSigOpsCost += entry.GetSigOpCost();
286 nFees += entry.GetFee();
287
288 if (*m_options.print_modified_fee) {
289 LogInfo("fee rate %s txid %s\n",
290 CFeeRate(entry.GetModifiedFee(), entry.GetTxSize()).ToString(),
291 entry.GetTx().GetHash().ToString());
292 }
293}
294
295void BlockAssembler::addChunks()
296{
297 // Limit the number of attempts to add transactions to the block when it is
298 // close to full; this is just a simple heuristic to finish quickly if the
299 // mempool has a lot of entries.
300 const int64_t MAX_CONSECUTIVE_FAILURES = 1000;
301 constexpr int32_t BLOCK_FULL_ENOUGH_WEIGHT_DELTA = 4000;
302 int64_t nConsecutiveFailed = 0;
303
304 std::vector<CTxMemPoolEntry::CTxMemPoolEntryRef> selected_transactions;
305 selected_transactions.reserve(MAX_CLUSTER_COUNT_LIMIT);
306 FeePerWeight chunk_feerate;
307
308 // This fills selected_transactions
309 chunk_feerate = m_mempool->GetBlockBuilderChunk(selected_transactions);
310 FeePerVSize chunk_feerate_vsize = ToFeePerVSize(chunk_feerate);
311
312 while (selected_transactions.size() > 0) {
313 // Check to see if min fee rate is still respected.
314 if (ByRatio{chunk_feerate_vsize} < ByRatio{m_options.block_min_fee_rate->GetFeePerVSize()}) {
315 // Everything else we might consider has a lower feerate
316 return;
317 }
318
319 int64_t chunk_sig_ops = 0;
320 int64_t chunk_weight = 0;
321 for (const auto& tx : selected_transactions) {
322 chunk_sig_ops += tx.get().GetSigOpCost();
323 chunk_weight += tx.get().GetTxWeight();
324 }
325
326 // Check to see if this chunk will fit.
327 if (!TestChunkBlockLimits(chunk_weight, chunk_sig_ops) || !TestChunkTransactions(selected_transactions)) {
328 // This chunk won't fit, so we skip it and will try the next best one.
329 m_mempool->SkipBuilderChunk();
330 ++nConsecutiveFailed;
331
332 // block_max_weight has been flattened before block assembly limit checks.
333 Assert(m_options.block_max_weight);
334 if (nConsecutiveFailed > MAX_CONSECUTIVE_FAILURES && nBlockWeight +
335 BLOCK_FULL_ENOUGH_WEIGHT_DELTA > *m_options.block_max_weight) {
336 // Give up if we're close to full and haven't succeeded in a while
337 return;
338 }
339 } else {
340 m_mempool->IncludeBuilderChunk();
341
342 // This chunk will fit, so add it to the block.
343 nConsecutiveFailed = 0;
344 for (const auto& tx : selected_transactions) {
345 AddToBlock(tx);
346 }
347 pblocktemplate->m_package_feerates.emplace_back(chunk_feerate_vsize);
348 }
349
350 selected_transactions.clear();
351 chunk_feerate = m_mempool->GetBlockBuilderChunk(selected_transactions);
352 chunk_feerate_vsize = ToFeePerVSize(chunk_feerate);
353 }
354}
355
356void AddMerkleRootAndCoinbase(CBlock& block, CTransactionRef coinbase, uint32_t version, uint32_t timestamp, uint32_t nonce)
357{
358 if (block.vtx.size() == 0) {
359 block.vtx.emplace_back(coinbase);
360 } else {
361 block.vtx[0] = coinbase;
362 }
363 block.nVersion = version;
364 block.nTime = timestamp;
365 block.nNonce = nonce;
366 block.hashMerkleRoot = BlockMerkleRoot(block);
367
368 // Reset cached checks
369 block.m_checked_witness_commitment = false;
370 block.m_checked_merkle_root = false;
371 block.fChecked = false;
372}
373
374namespace {
375class SubmitBlockStateCatcher final : public CValidationInterface
376{
377public:
379 bool m_found{false};
381
382 explicit SubmitBlockStateCatcher(const uint256& hash) : m_hash{hash} {}
383
384protected:
385 void BlockChecked(const std::shared_ptr<const CBlock>& block, const BlockValidationState& state) override
386 {
387 if (block->GetHash() != m_hash) return;
388 // ProcessNewBlock emits BlockChecked synchronously while holding cs_main,
389 // so SubmitBlock can read these fields after ProcessNewBlock returns
390 // without extra synchronization.
391 m_found = true;
392 m_state = state;
393 }
394};
395} // namespace
396
397bool SubmitBlock(ChainstateManager& chainman, const std::shared_ptr<const CBlock>& block, std::string& reason, std::string& debug)
398{
399 reason.clear();
400 debug.clear();
401
402 // This follows the submitblock RPC's validation-state capture pattern, but
403 // is intentionally kept separate from the RPC implementation. The RPC entry
404 // point decodes hex, formats BIP22/JSONRPC results, and calls
405 // UpdateUncommittedBlockStructures() for legacy witness handling. IPC
406 // callers submit already-formed blocks and need bool + reason/debug
407 // results.
408 auto sc = std::make_shared<SubmitBlockStateCatcher>(block->GetHash());
409 CHECK_NONFATAL(chainman.m_options.signals)->RegisterSharedValidationInterface(sc);
410 bool new_block;
411 bool accepted = chainman.ProcessNewBlock(block, /*force_processing=*/true, /*min_pow_checked=*/true, /*new_block=*/&new_block);
412 // No queue drain is needed. The BlockChecked notification used above is
413 // emitted synchronously by ProcessNewBlock, unlike most validation signals.
414 CHECK_NONFATAL(chainman.m_options.signals)->UnregisterSharedValidationInterface(sc);
415
416 if (!new_block && accepted) {
417 reason = "duplicate";
418 } else if (!accepted && (!sc->m_found || sc->m_state.IsValid())) {
419 // ProcessNewBlock can fail without a validation result, for example
420 // from an activation or system error. It can also fail after a valid
421 // BlockChecked result. In these cases the validation result is
422 // inconclusive.
423 reason = "inconclusive";
424 } else if (!sc->m_found) {
425 // The block was accepted but not connected, for example if it does not
426 // have more work than the current tip.
427 reason = "inconclusive";
428 } else if (!sc->m_state.IsValid()) {
429 reason = sc->m_state.GetRejectReason();
430 debug = sc->m_state.GetDebugMessage();
431 }
432 const bool result{accepted && new_block && reason.empty()};
433 CHECK_NONFATAL(result == reason.empty());
434 return result;
435}
436
437void InterruptWait(KernelNotifications& kernel_notifications, bool& interrupt_wait)
438{
439 LOCK(kernel_notifications.m_tip_block_mutex);
440 interrupt_wait = true;
441 kernel_notifications.m_tip_block_cv.notify_all();
442}
443
444std::unique_ptr<CBlockTemplate> WaitAndCreateNewBlock(ChainstateManager& chainman,
445 KernelNotifications& kernel_notifications,
446 CTxMemPool* mempool,
447 const std::unique_ptr<CBlockTemplate>& block_template,
448 const BlockWaitOptions& wait_options,
449 const BlockCreateOptions& create_options,
450 bool& interrupt_wait)
451{
452 // Delay calculating the current template fees, just in case a new block
453 // comes in before the next tick.
454 CAmount current_fees = -1;
455
456 // Alternate waiting for a new tip and checking if fees have risen.
457 // The latter check is expensive so we only run it once per second.
458 auto now{NodeClock::now()};
459 const auto deadline = now + wait_options.timeout;
460 const MillisecondsDouble tick{1000};
461 const bool allow_min_difficulty{chainman.GetParams().GetConsensus().fPowAllowMinDifficultyBlocks};
462
463 do {
464 bool tip_changed{false};
465 {
466 WAIT_LOCK(kernel_notifications.m_tip_block_mutex, lock);
467 // Note that wait_until() checks the predicate before waiting
468 kernel_notifications.m_tip_block_cv.wait_until(lock, std::min(now + tick, deadline), [&]() EXCLUSIVE_LOCKS_REQUIRED(kernel_notifications.m_tip_block_mutex) {
469 AssertLockHeld(kernel_notifications.m_tip_block_mutex);
470 const auto tip_block{kernel_notifications.TipBlock()};
471 // We assume tip_block is set, because this is an instance
472 // method on BlockTemplate and no template could have been
473 // generated before a tip exists.
474 tip_changed = Assume(tip_block) && tip_block != block_template->block.hashPrevBlock;
475 return tip_changed || chainman.m_interrupt || interrupt_wait;
476 });
477 if (interrupt_wait) {
478 interrupt_wait = false;
479 return nullptr;
480 }
481 }
482
483 if (chainman.m_interrupt) return nullptr;
484 // At this point the tip changed, a full tick went by or we reached
485 // the deadline.
486
487 // Must release m_tip_block_mutex before locking cs_main, to avoid deadlocks.
489
490 // On test networks return a minimum difficulty block after 20 minutes
491 if (!tip_changed && allow_min_difficulty) {
492 const NodeClock::time_point tip_time{std::chrono::seconds{chainman.ActiveChain().Tip()->GetBlockTime()}};
493 if (now > tip_time + 20min) {
494 tip_changed = true;
495 }
496 }
497
506 if (wait_options.fee_threshold < MAX_MONEY || tip_changed) {
507 auto new_tmpl{BlockAssembler{
508 chainman.ActiveChainstate(),
509 mempool,
510 create_options
511 }.CreateNewBlock()};
512
513 // If the tip changed, return the new template regardless of its fees.
514 if (tip_changed) return new_tmpl;
515
516 // Calculate the original template total fees if we haven't already
517 if (current_fees == -1) {
518 current_fees = std::accumulate(block_template->vTxFees.begin(), block_template->vTxFees.end(), CAmount{0});
519 }
520
521 // Check if fees increased enough to return the new template
522 const CAmount new_fees = std::accumulate(new_tmpl->vTxFees.begin(), new_tmpl->vTxFees.end(), CAmount{0});
523 Assume(wait_options.fee_threshold != MAX_MONEY);
524 if (new_fees >= current_fees + wait_options.fee_threshold) return new_tmpl;
525 }
526
527 now = NodeClock::now();
528 } while (now < deadline);
529
530 return nullptr;
531}
532
533std::optional<BlockRef> GetTip(ChainstateManager& chainman)
534{
536 CBlockIndex* tip{chainman.ActiveChain().Tip()};
537 if (!tip) return {};
538 return BlockRef{tip->GetBlockHash(), tip->nHeight};
539}
540
541bool CooldownIfHeadersAhead(ChainstateManager& chainman, KernelNotifications& kernel_notifications, const BlockRef& last_tip, bool& interrupt_mining)
542{
543 uint256 last_tip_hash{last_tip.hash};
544
545 while (const std::optional<int> remaining = chainman.BlocksAheadOfTip()) {
546 const int cooldown_seconds = std::clamp(*remaining, 3, 20);
547 const auto cooldown_deadline{MockableSteadyClock::now() + std::chrono::seconds{cooldown_seconds}};
548
549 {
550 WAIT_LOCK(kernel_notifications.m_tip_block_mutex, lock);
551 kernel_notifications.m_tip_block_cv.wait_until(lock, cooldown_deadline, [&]() EXCLUSIVE_LOCKS_REQUIRED(kernel_notifications.m_tip_block_mutex) {
552 const auto tip_block = kernel_notifications.TipBlock();
553 return chainman.m_interrupt || interrupt_mining || (tip_block && *tip_block != last_tip_hash);
554 });
555 if (chainman.m_interrupt || interrupt_mining) {
556 interrupt_mining = false;
557 return false;
558 }
559
560 // If the tip changed during the wait, extend the deadline
561 const auto tip_block = kernel_notifications.TipBlock();
562 if (tip_block && *tip_block != last_tip_hash) {
563 last_tip_hash = *tip_block;
564 continue;
565 }
566 }
567
568 // No tip change and the cooldown window has expired.
569 if (MockableSteadyClock::now() >= cooldown_deadline) break;
570 }
571
572 return true;
573}
574
575std::optional<BlockRef> WaitTipChanged(ChainstateManager& chainman, KernelNotifications& kernel_notifications, const uint256& current_tip, MillisecondsDouble& timeout, bool& interrupt)
576{
577 Assume(timeout >= 0ms); // No internal callers should use a negative timeout
578 if (timeout < 0ms) timeout = 0ms;
579 if (timeout > std::chrono::years{100}) timeout = std::chrono::years{100}; // Upper bound to avoid UB in std::chrono
580 auto deadline{std::chrono::steady_clock::now() + timeout};
581 {
582 WAIT_LOCK(kernel_notifications.m_tip_block_mutex, lock);
583 // For callers convenience, wait longer than the provided timeout
584 // during startup for the tip to be non-null. That way this function
585 // always returns valid tip information when possible and only
586 // returns null when shutting down, not when timing out.
587 kernel_notifications.m_tip_block_cv.wait(lock, [&]() EXCLUSIVE_LOCKS_REQUIRED(kernel_notifications.m_tip_block_mutex) {
588 return kernel_notifications.TipBlock() || chainman.m_interrupt || interrupt;
589 });
590 if (chainman.m_interrupt || interrupt) {
591 interrupt = false;
592 return {};
593 }
594 // At this point TipBlock is set, so continue to wait until it is
595 // different then `current_tip` provided by caller.
596 kernel_notifications.m_tip_block_cv.wait_until(lock, deadline, [&]() EXCLUSIVE_LOCKS_REQUIRED(kernel_notifications.m_tip_block_mutex) {
597 return Assume(kernel_notifications.TipBlock()) != current_tip || chainman.m_interrupt || interrupt;
598 });
599 if (chainman.m_interrupt || interrupt) {
600 interrupt = false;
601 return {};
602 }
603 }
604
605 // Must release m_tip_block_mutex before getTip() locks cs_main, to
606 // avoid deadlocks.
607 return GetTip(chainman);
608}
609
610} // namespace node
constexpr CAmount MAX_MONEY
No amount larger than this (in satoshi) is valid.
Definition: amount.h:26
int64_t CAmount
Amount in satoshis (Can be negative)
Definition: amount.h:12
ArgsManager gArgs
Definition: args.cpp:38
#define CHECK_NONFATAL(condition)
Identity function.
Definition: check.h:112
#define Assert(val)
Identity function.
Definition: check.h:116
#define Assume(val)
Assume is the identity function.
Definition: check.h:128
int64_t GetIntArg(const std::string &strArg, int64_t nDefault) const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
Definition: args.h:323
Wrapper around FeeFrac & derived types, which adds a feerate-based ordering which treats equal-feerat...
Definition: feefrac.h:218
Nodes collect new transactions into a block, hash them into a hash tree, and scan through nonce value...
Definition: block.h:27
uint32_t nNonce
Definition: block.h:35
uint32_t nBits
Definition: block.h:34
uint32_t nTime
Definition: block.h:33
int32_t nVersion
Definition: block.h:30
uint256 hashPrevBlock
Definition: block.h:31
uint256 hashMerkleRoot
Definition: block.h:32
Definition: block.h:74
bool m_checked_merkle_root
Definition: block.h:82
std::vector< CTransactionRef > vtx
Definition: block.h:77
bool m_checked_witness_commitment
Definition: block.h:81
bool fChecked
Definition: block.h:80
The block chain is a tree shaped structure starting with the genesis block at the root,...
Definition: chain.h:94
uint256 GetBlockHash() const
Definition: chain.h:198
int64_t GetBlockTime() const
Definition: chain.h:221
int64_t GetMedianTimePast() const
Definition: chain.h:233
CBlockIndex * GetAncestor(int height)
Efficiently find an ancestor of this block.
Definition: chain.cpp:109
int nHeight
height of the entry in the chain. The genesis block has height 0
Definition: chain.h:106
CBlockIndex * Tip() const
Returns the index entry for the tip of this chain, or nullptr if none.
Definition: chain.h:396
const Consensus::Params & GetConsensus() const
Definition: chainparams.h:89
Fee rate in satoshis per virtualbyte: CAmount / vB the feerate is represented internally as FeeFrac.
Definition: feerate.h:32
std::string ToString(FeeRateFormat fee_rate_format=FeeRateFormat::BTC_KVB) const
Definition: feerate.cpp:30
Serialized script, used inside transaction inputs and outputs.
Definition: script.h:406
const Txid & GetHash() const LIFETIMEBOUND
Definition: transaction.h:328
static constexpr uint32_t MAX_SEQUENCE_NONFINAL
This is the maximum sequence number that enables both nLockTime and OP_CHECKLOCKTIMEVERIFY (BIP 65).
Definition: transaction.h:82
CTxMemPoolEntry stores data about the corresponding transaction, as well as data about all in-mempool...
Definition: mempool_entry.h:66
const CTransaction & GetTx() const
int32_t GetTxWeight() const
int64_t GetSigOpCost() const
CTransactionRef GetSharedTx() const
int32_t GetTxSize() const
const CAmount & GetFee() const
CAmount GetModifiedFee() const
CTxMemPool stores valid-according-to-the-current-best-chain transactions that may be included in the ...
Definition: txmempool.h:187
Implement this to subscribe to events generated in validation and mempool.
virtual void BlockChecked(const std::shared_ptr< const CBlock > &, const BlockValidationState &)
Notifies listeners of a block validation result.
Chainstate stores and provides an API to update our local knowledge of the current best chain.
Definition: validation.h:550
Interface for managing multiple Chainstate objects, where each chainstate is associated with chainsta...
Definition: validation.h:950
Chainstate & ActiveChainstate() const
Alternatives to CurrentChainstate() used by older code to query latest chainstate information without...
bool ProcessNewBlock(const std::shared_ptr< const CBlock > &block, bool force_processing, bool min_pow_checked, bool *new_block) LOCKS_EXCLUDED(cs_main)
Process an incoming block.
const util::SignalInterrupt & m_interrupt
Definition: validation.h:1044
const CChainParams & GetParams() const
Definition: validation.h:1017
void GenerateCoinbaseCommitment(CBlock &block, const CBlockIndex *pindexPrev) const
Produce the necessary coinbase commitment for a block (modifies the hash, don't call for mined blocks...
const Options m_options
Definition: validation.h:1045
CChain & ActiveChain() const EXCLUSIVE_LOCKS_REQUIRED(GetMutex())
Definition: validation.h:1178
node::BlockManager m_blockman
A single BlockManager instance is shared across each constructed chainstate to avoid duplicating bloc...
Definition: validation.h:1048
bool IsValid() const
Definition: validation.h:112
Generate a new block, without valid proof-of-work.
Definition: miner.h:61
BlockAssembler(Chainstate &chainstate, const CTxMemPool *mempool, BlockCreateOptions create_options)
Definition: miner.cpp:107
CBlockIndex * LookupBlockIndex(const uint256 &hash) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
std::optional< uint256 > TipBlock() EXCLUSIVE_LOCKS_REQUIRED(m_tip_block_mutex)
The block for which the last blockTip notification was received.
std::string ToString() const
256-bit opaque blob.
Definition: uint256.h:196
uint256 BlockMerkleRoot(const CBlock &block, bool *mutated)
Definition: merkle.cpp:76
constexpr int NO_WITNESS_COMMITMENT
Index marker for when no witness commitment is present in a coinbase transaction.
Definition: validation.h:22
static int64_t GetBlockWeight(const CBlock &block)
Definition: validation.h:143
int GetWitnessCommitmentIndex(const CBlock &block)
Compute at which vout of the block's coinbase transaction the witness commitment occurs,...
Definition: validation.h:154
constexpr int64_t MAX_BLOCK_SIGOPS_COST
The maximum allowed number of signature check operations in a block (network rule)
Definition: consensus.h:17
constexpr int64_t MAX_TIMEWARP
Maximum number of seconds that the timestamp of the first block of a difficulty adjustment period is ...
Definition: consensus.h:35
RecursiveMutex cs_main
Mutex to guard access to validation specific variables, such as reading or changing the chainstate.
Definition: cs_main.cpp:8
#define LogInfo(...)
Definition: log.h:125
#define LogDebug(category,...)
Definition: log.h:143
unsigned int nHeight
BlockValidationState m_state
Definition: miner.cpp:380
uint256 m_hash
Definition: miner.cpp:378
bool m_found
Definition: miner.cpp:379
unsigned int nonce
is used externally by mining IPC clients, so it should only declare simple data definitions.
@ BENCH
Definition: categories.h:20
Definition: messages.h:21
void RegenerateCommitments(CBlock &block, ChainstateManager &chainman)
Update an old GenerateCoinbaseCommitment from CreateNewBlock after the block txs have changed.
Definition: miner.cpp:95
std::optional< BlockRef > WaitTipChanged(ChainstateManager &chainman, KernelNotifications &kernel_notifications, const uint256 &current_tip, MillisecondsDouble &timeout, bool &interrupt)
Definition: miner.cpp:575
int64_t UpdateTime(CBlockHeader *pblock, const Consensus::Params &consensusParams, const CBlockIndex *pindexPrev)
Definition: miner.cpp:77
BlockCreateOptions FlattenMiningOptions(BlockCreateOptions options)
Replace null optional values with their hardcoded defaults.
Definition: mining_args.cpp:81
int64_t GetMinimumTime(const CBlockIndex *pindexPrev, const int64_t difficulty_adjustment_interval)
Get the minimum time a miner should use in the next block.
Definition: miner.cpp:57
void InterruptWait(KernelNotifications &kernel_notifications, bool &interrupt_wait)
Definition: miner.cpp:437
std::unique_ptr< CBlockTemplate > WaitAndCreateNewBlock(ChainstateManager &chainman, KernelNotifications &kernel_notifications, CTxMemPool *mempool, const std::unique_ptr< CBlockTemplate > &block_template, const BlockWaitOptions &wait_options, const BlockCreateOptions &create_options, bool &interrupt_wait)
Return a new block template when fees rise to a certain threshold or after a new tip; return nullopt ...
Definition: miner.cpp:444
void AddMerkleRootAndCoinbase(CBlock &block, CTransactionRef coinbase, uint32_t version, uint32_t timestamp, uint32_t nonce)
Definition: miner.cpp:356
Result< void > CheckMiningOptions(BlockCreateOptions options, bool use_argnames)
Check option values for validity.
Definition: mining_args.cpp:30
bool CooldownIfHeadersAhead(ChainstateManager &chainman, KernelNotifications &kernel_notifications, const BlockRef &last_tip, bool &interrupt_mining)
Wait while the best known header extends the current chain tip AND at least one block is being added ...
Definition: miner.cpp:541
std::optional< BlockRef > GetTip(ChainstateManager &chainman)
Definition: miner.cpp:533
bool SubmitBlock(ChainstateManager &chainman, const std::shared_ptr< const CBlock > &block, std::string &reason, std::string &debug)
Submit a block and capture the validation state via the BlockChecked callback.
Definition: miner.cpp:397
bilingual_str ErrorString(const Result< T > &result)
Definition: result.h:93
static FeePerVSize ToFeePerVSize(FeePerWeight feerate)
Definition: policy.h:197
unsigned int GetNextWorkRequired(const CBlockIndex *pindexLast, const CBlockHeader *pblock, const Consensus::Params &params)
Definition: pow.cpp:14
static CTransactionRef MakeTransactionRef(Tx &&txIn)
Definition: transaction.h:404
std::shared_ptr< const CTransaction > CTransactionRef
Definition: transaction.h:403
@ OP_0
Definition: script.h:77
A mutable version of CTransaction.
Definition: transaction.h:358
std::vector< CTxOut > vout
Definition: transaction.h:360
std::vector< CTxIn > vin
Definition: transaction.h:359
Parameters that influence chain consensus.
Definition: params.h:88
int64_t DifficultyAdjustmentInterval() const
Definition: params.h:130
bool fPowAllowMinDifficultyBlocks
Definition: params.h:117
Tagged wrapper around FeeFrac to avoid unit confusion.
Definition: feefrac.h:191
static time_point now() noexcept
Return current system time or mocked time, if set.
Definition: time.cpp:64
static time_point now() noexcept
Return current system time or mocked time, if set.
Definition: time.cpp:38
std::chrono::time_point< NodeClock > time_point
Definition: time.h:28
Hash/height pair to help track and identify blocks.
Definition: types.h:13
uint256 hash
Definition: types.h:14
Block template creation options.
Definition: mining_types.h:33
MillisecondsDouble timeout
How long to wait before returning nullptr instead of a new template.
Definition: mining_types.h:99
CAmount fee_threshold
The wait method will not return a new template unless it has fees at least fee_threshold sats higher ...
Definition: mining_types.h:112
Template containing all coinbase transaction fields that are set by our miner code.
Definition: mining_types.h:132
#define WAIT_LOCK(cs, name)
Definition: sync.h:274
#define LOCK(cs)
Definition: sync.h:268
#define WITH_LOCK(cs, code)
Run code while locking a mutex.
Definition: sync.h:299
#define EXCLUSIVE_LOCKS_REQUIRED(...)
Definition: threadsafety.h:49
#define strprintf
Format arguments and return the string or write to given std::ostream (see tinyformat::format doc for...
Definition: tinyformat.h:1172
bool IsFinalTx(const CTransaction &tx, int nBlockHeight, int64_t nBlockTime)
Check if transaction is final and can be included in a block with the specified height and time.
Definition: tx_verify.cpp:23
constexpr unsigned MAX_CLUSTER_COUNT_LIMIT
Definition: txgraph.h:18
std::chrono::duration< double, std::chrono::milliseconds::period > MillisecondsDouble
Definition: time.h:103
CAmount GetBlockSubsidy(int nHeight, const Consensus::Params &consensusParams)
BlockValidationState TestBlockValidity(Chainstate &chainstate, const CBlock &block, const bool check_pow, const bool check_merkle_root)
Verify a block, including transactions.
assert(!tx.IsCoinBase())