Bitcoin ABC
0.26.3
P2P Digital Currency
Loading...
Searching...
No Matches
src
headerssync.h
Go to the documentation of this file.
1
// Copyright (c) 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
#ifndef BITCOIN_HEADERSSYNC_H
6
#define BITCOIN_HEADERSSYNC_H
7
8
#include <
arith_uint256.h
>
9
#include <
chain.h
>
10
#include <
consensus/params.h
>
11
#include <
net.h
>
// For NodeId
12
#include <
primitives/block.h
>
13
#include <
uint256.h
>
14
#include <
util/bitdeque.h
>
15
#include <
util/hasher.h
>
16
17
#include <deque>
18
#include <vector>
19
20
// A compressed CBlockHeader, which leaves out the prevhash
21
struct
CompressedHeader
{
22
// header
23
int32_t
nVersion
{0};
24
uint256
hashMerkleRoot
;
25
uint32_t
nTime
{0};
26
uint32_t
nBits
{0};
27
uint32_t
nNonce
{0};
28
29
CompressedHeader
() {
hashMerkleRoot
.
SetNull
(); }
30
31
CompressedHeader
(
const
CBlockHeader
&header) {
32
nVersion
= header.
nVersion
;
33
hashMerkleRoot
= header.
hashMerkleRoot
;
34
nTime
= header.
nTime
;
35
nBits
= header.
nBits
;
36
nNonce
= header.
nNonce
;
37
}
38
39
CBlockHeader
GetFullHeader
(
const
BlockHash
&
hash_prev_block
) {
40
CBlockHeader
ret
;
41
ret
.
nVersion
=
nVersion
;
42
ret
.hashPrevBlock =
hash_prev_block
;
43
ret
.hashMerkleRoot =
hashMerkleRoot
;
44
ret
.nTime =
nTime
;
45
ret
.nBits =
nBits
;
46
ret
.nNonce =
nNonce
;
47
return
ret
;
48
};
49
};
50
98
class
HeadersSyncState
{
99
public
:
100
~HeadersSyncState
() {}
101
102
enum class
State
{
108
PRESYNC
,
114
REDOWNLOAD
,
119
FINAL
120
};
121
123
State
GetState
()
const
{
return
m_download_state
; }
124
126
int64_t
GetPresyncHeight
()
const
{
return
m_current_height
; }
127
132
uint32_t
GetPresyncTime
()
const
{
return
m_last_header_received
.
nTime
; }
133
138
arith_uint256
GetPresyncWork
()
const
{
return
m_current_chain_work
; }
139
149
HeadersSyncState
(
NodeId
id
,
const
Consensus::Params
&
consensus_params
,
150
const
CBlockIndex
*
chain_start
,
151
const
arith_uint256
&
minimum_required_work
);
152
154
struct
ProcessingResult
{
155
std::vector<CBlockHeader>
pow_validated_headers
;
156
bool
success
{
false
};
157
bool
request_more
{
false
};
158
};
159
183
ProcessingResult
184
ProcessNextHeaders
(
const
std::vector<CBlockHeader> &
received_headers
,
185
bool
full_headers_message
);
186
193
CBlockLocator
NextHeadersRequestLocator
()
const
;
194
195
private
:
200
void
Finalize
();
201
209
bool
ValidateAndStoreHeadersCommitments
(
210
const
std::vector<CBlockHeader> &
headers
);
211
213
bool
ValidateAndProcessSingleHeader
(
const
CBlockHeader
&
current
);
214
219
bool
ValidateAndStoreRedownloadedHeader
(
const
CBlockHeader
&header);
220
222
std::vector<CBlockHeader>
PopHeadersReadyForAcceptance
();
223
224
private
:
226
const
NodeId
m_id
;
227
229
const
Consensus::Params
&
m_consensus_params
;
230
235
const
CBlockIndex
*
m_chain_start
{
nullptr
};
236
238
const
arith_uint256
m_minimum_required_work
;
239
241
arith_uint256
m_current_chain_work
;
242
247
const
SaltedBlockHashHasher
m_hasher
;
248
253
bitdeque<>
m_header_commitments
;
254
261
const
unsigned
m_commit_offset
;
262
270
uint64_t
m_max_commitments
{0};
271
276
CBlockHeader
m_last_header_received
;
277
279
int64_t
m_current_height
{0};
280
286
std::deque<CompressedHeader>
m_redownloaded_headers
;
287
289
int64_t
m_redownload_buffer_last_height
{0};
290
296
BlockHash
m_redownload_buffer_last_hash
;
297
303
BlockHash
m_redownload_buffer_first_prev_hash
;
304
306
arith_uint256
m_redownload_chain_work
;
307
313
bool
m_process_all_remaining_headers
{
false
};
314
316
State
m_download_state
{
State::PRESYNC
};
317
};
318
319
#endif
// BITCOIN_HEADERSSYNC_H
arith_uint256.h
bitdeque.h
block.h
CBlockHeader
Nodes collect new transactions into a block, hash them into a hash tree, and scan through nonce value...
Definition
block.h:23
CBlockHeader::nNonce
uint32_t nNonce
Definition
block.h:31
CBlockHeader::nBits
uint32_t nBits
Definition
block.h:30
CBlockHeader::nTime
uint32_t nTime
Definition
block.h:29
CBlockHeader::nVersion
int32_t nVersion
Definition
block.h:26
CBlockHeader::hashMerkleRoot
uint256 hashMerkleRoot
Definition
block.h:28
CBlockIndex
The block chain is a tree shaped structure starting with the genesis block at the root,...
Definition
blockindex.h:25
HeadersSyncState
HeadersSyncState:
Definition
headerssync.h:98
HeadersSyncState::GetPresyncWork
arith_uint256 GetPresyncWork() const
Return the amount of work in the chain received during the PRESYNC phase.
Definition
headerssync.h:138
HeadersSyncState::m_max_commitments
uint64_t m_max_commitments
m_max_commitments is a bound we calculate on how long an honest peer's chain could be,...
Definition
headerssync.h:270
HeadersSyncState::m_redownload_chain_work
arith_uint256 m_redownload_chain_work
The accumulated work on the redownloaded chain.
Definition
headerssync.h:306
HeadersSyncState::State
State
Definition
headerssync.h:102
HeadersSyncState::State::FINAL
@ FINAL
We're done syncing with this peer and can discard any remaining state.
HeadersSyncState::State::PRESYNC
@ PRESYNC
PRESYNC means the peer has not yet demonstrated their chain has sufficient work and we're only buildi...
HeadersSyncState::State::REDOWNLOAD
@ REDOWNLOAD
REDOWNLOAD means the peer has given us a high-enough-work chain, and now we're redownloading the head...
HeadersSyncState::m_last_header_received
CBlockHeader m_last_header_received
Store the latest header received while in PRESYNC (initialized to m_chain_start)
Definition
headerssync.h:276
HeadersSyncState::m_redownload_buffer_last_hash
BlockHash m_redownload_buffer_last_hash
Hash of last header in m_redownloaded_headers (initialized to m_chain_start).
Definition
headerssync.h:296
HeadersSyncState::m_current_chain_work
arith_uint256 m_current_chain_work
Work that we've seen so far on the peer's chain.
Definition
headerssync.h:241
HeadersSyncState::m_current_height
int64_t m_current_height
Height of m_last_header_received.
Definition
headerssync.h:279
HeadersSyncState::m_commit_offset
const unsigned m_commit_offset
The (secret) offset on the heights for which to create commitments.
Definition
headerssync.h:261
HeadersSyncState::GetPresyncTime
uint32_t GetPresyncTime() const
Return the block timestamp of the last header received during the PRESYNC phase.
Definition
headerssync.h:132
HeadersSyncState::m_minimum_required_work
const arith_uint256 m_minimum_required_work
Minimum work that we're looking for on this chain.
Definition
headerssync.h:238
HeadersSyncState::PopHeadersReadyForAcceptance
std::vector< CBlockHeader > PopHeadersReadyForAcceptance()
Return a set of headers that satisfy our proof-of-work threshold.
Definition
headerssync.cpp:346
HeadersSyncState::ValidateAndStoreHeadersCommitments
bool ValidateAndStoreHeadersCommitments(const std::vector< CBlockHeader > &headers)
Only called in PRESYNC.
Definition
headerssync.cpp:173
HeadersSyncState::m_consensus_params
const Consensus::Params & m_consensus_params
We use the consensus params in our anti-DoS calculations.
Definition
headerssync.h:229
HeadersSyncState::ValidateAndProcessSingleHeader
bool ValidateAndProcessSingleHeader(const CBlockHeader ¤t)
In PRESYNC, process and update state for a single header.
Definition
headerssync.cpp:221
HeadersSyncState::m_download_state
State m_download_state
Current state of our headers sync.
Definition
headerssync.h:316
HeadersSyncState::ValidateAndStoreRedownloadedHeader
bool ValidateAndStoreRedownloadedHeader(const CBlockHeader &header)
In REDOWNLOAD, check a header's commitment (if applicable) and add to buffer for later processing.
Definition
headerssync.cpp:266
HeadersSyncState::m_header_commitments
bitdeque m_header_commitments
A queue of commitment bits, created during the 1st phase, and verified during the 2nd.
Definition
headerssync.h:253
HeadersSyncState::m_redownload_buffer_first_prev_hash
BlockHash m_redownload_buffer_first_prev_hash
The hashPrevBlock entry for the first header in m_redownloaded_headers We need this to reconstruct th...
Definition
headerssync.h:303
HeadersSyncState::m_id
const NodeId m_id
NodeId of the peer (used for log messages)
Definition
headerssync.h:226
HeadersSyncState::m_redownload_buffer_last_height
int64_t m_redownload_buffer_last_height
Height of last header in m_redownloaded_headers.
Definition
headerssync.h:289
HeadersSyncState::m_redownloaded_headers
std::deque< CompressedHeader > m_redownloaded_headers
During phase 2 (REDOWNLOAD), we buffer redownloaded headers in memory until enough commitments have b...
Definition
headerssync.h:286
HeadersSyncState::m_hasher
const SaltedBlockHashHasher m_hasher
m_hasher is a salted hasher for making our 1-bit commitments to headers we've seen.
Definition
headerssync.h:247
HeadersSyncState::ProcessNextHeaders
ProcessingResult ProcessNextHeaders(const std::vector< CBlockHeader > &received_headers, bool full_headers_message)
Process a batch of headers, once a sync via this mechanism has started.
Definition
headerssync.cpp:84
HeadersSyncState::GetState
State GetState() const
Return the current state of our download.
Definition
headerssync.h:123
HeadersSyncState::~HeadersSyncState
~HeadersSyncState()
Definition
headerssync.h:100
HeadersSyncState::m_process_all_remaining_headers
bool m_process_all_remaining_headers
Set this to true once we encounter the target blockheader during phase 2 (REDOWNLOAD).
Definition
headerssync.h:313
HeadersSyncState::Finalize
void Finalize()
Clear out all download state that might be in progress (freeing any used memory), and mark this objec...
Definition
headerssync.cpp:66
HeadersSyncState::m_chain_start
const CBlockIndex * m_chain_start
Store the last block in our block index that the peer's chain builds from.
Definition
headerssync.h:235
HeadersSyncState::GetPresyncHeight
int64_t GetPresyncHeight() const
Return the height reached during the PRESYNC phase.
Definition
headerssync.h:126
HeadersSyncState::NextHeadersRequestLocator
CBlockLocator NextHeadersRequestLocator() const
Issue the next GETHEADERS message to our peer.
Definition
headerssync.cpp:365
SaltedBlockHashHasher
Definition
hasher.h:34
arith_uint256
256-bit unsigned big integer.
Definition
arith_uint256.h:285
base_blob::SetNull
void SetNull()
Definition
uint256.h:41
bitdeque
Class that mimics std::deque<bool>, but with std::vector<bool>'s bit packing.
Definition
bitdeque.h:22
uint256
256-bit opaque blob.
Definition
uint256.h:129
hasher.h
chain.h
net.h
NodeId
int64_t NodeId
Definition
nodeid.h:10
params.h
GetRand
T GetRand(T nMax=std::numeric_limits< T >::max()) noexcept
Generate a uniform random integer of type T in the range [0..nMax) nMax defaults to std::numeric_limi...
Definition
random.h:85
BlockHash
A BlockHash is a unqiue identifier for a block.
Definition
blockhash.h:13
CBlockLocator
Describes a place in the block chain to another node such that if the other node doesn't have the sam...
Definition
block.h:105
CompressedHeader
Definition
headerssync.h:21
CompressedHeader::nBits
uint32_t nBits
Definition
headerssync.h:26
CompressedHeader::nTime
uint32_t nTime
Definition
headerssync.h:25
CompressedHeader::nNonce
uint32_t nNonce
Definition
headerssync.h:27
CompressedHeader::hashMerkleRoot
uint256 hashMerkleRoot
Definition
headerssync.h:24
CompressedHeader::GetFullHeader
CBlockHeader GetFullHeader(const BlockHash &hash_prev_block)
Definition
headerssync.h:39
CompressedHeader::nVersion
int32_t nVersion
Definition
headerssync.h:23
CompressedHeader::CompressedHeader
CompressedHeader(const CBlockHeader &header)
Definition
headerssync.h:31
CompressedHeader::CompressedHeader
CompressedHeader()
Definition
headerssync.h:29
Consensus::Params
Parameters that influence chain consensus.
Definition
params.h:34
HeadersSyncState::ProcessingResult
Result data structure for ProcessNextHeaders.
Definition
headerssync.h:154
HeadersSyncState::ProcessingResult::request_more
bool request_more
Definition
headerssync.h:157
HeadersSyncState::ProcessingResult::pow_validated_headers
std::vector< CBlockHeader > pow_validated_headers
Definition
headerssync.h:155
HeadersSyncState::ProcessingResult::success
bool success
Definition
headerssync.h:156
uint256.h
Generated on Sun Oct 13 2024 02:39:35 for Bitcoin ABC by
1.9.8