reth_downloaders/headers/reverse_headers.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527
//! A headers downloader that can handle multiple requests concurrently.
use super::task::TaskDownloader;
use crate::metrics::HeaderDownloaderMetrics;
use alloy_consensus::BlockHeader;
use alloy_eips::BlockHashOrNumber;
use alloy_primitives::{BlockNumber, B256};
use futures::{stream::Stream, FutureExt};
use futures_util::{stream::FuturesUnordered, StreamExt};
use rayon::prelude::*;
use reth_config::config::HeadersConfig;
use reth_consensus::HeaderValidator;
use reth_network_p2p::{
error::{DownloadError, DownloadResult, PeerRequestResult},
headers::{
client::{HeadersClient, HeadersRequest},
downloader::{validate_header_download, HeaderDownloader, SyncTarget},
error::{HeadersDownloaderError, HeadersDownloaderResult},
},
priority::Priority,
};
use reth_network_peers::PeerId;
use reth_primitives::{GotExpected, SealedHeader};
use reth_tasks::{TaskSpawner, TokioTaskExecutor};
use std::{
cmp::{Ordering, Reverse},
collections::{binary_heap::PeekMut, BinaryHeap},
future::Future,
pin::Pin,
sync::Arc,
task::{ready, Context, Poll},
};
use thiserror::Error;
use tracing::{error, trace};
/// A heuristic that is used to determine the number of requests that should be prepared for a peer.
/// This should ensure that there are always requests lined up for peers to handle while the
/// downloader is yielding a next batch of headers that is being committed to the database.
const REQUESTS_PER_PEER_MULTIPLIER: usize = 5;
/// Wrapper for internal downloader errors.
#[derive(Error, Debug)]
enum ReverseHeadersDownloaderError<H> {
#[error(transparent)]
Downloader(#[from] HeadersDownloaderError<H>),
#[error(transparent)]
Response(#[from] Box<HeadersResponseError>),
}
impl<H> From<HeadersResponseError> for ReverseHeadersDownloaderError<H> {
fn from(value: HeadersResponseError) -> Self {
Self::Response(Box::new(value))
}
}
/// Downloads headers concurrently.
///
/// This [`HeaderDownloader`] downloads headers using the configured [`HeadersClient`].
/// Headers can be requested by hash or block number and take a `limit` parameter. This downloader
/// tries to fill the gap between the local head of the node and the chain tip by issuing multiple
/// requests at a time but yielding them in batches on [`Stream::poll_next`].
///
/// **Note:** This downloader downloads in reverse, see also
/// [`reth_network_p2p::headers::client::HeadersDirection`], this means the batches of headers that
/// this downloader yields will start at the chain tip and move towards the local head: falling
/// block numbers.
#[must_use = "Stream does nothing unless polled"]
#[derive(Debug)]
pub struct ReverseHeadersDownloader<H: HeadersClient> {
/// Consensus client used to validate headers
consensus: Arc<dyn HeaderValidator<H::Header>>,
/// Client used to download headers.
client: Arc<H>,
/// The local head of the chain.
local_head: Option<SealedHeader<H::Header>>,
/// Block we want to close the gap to.
sync_target: Option<SyncTargetBlock>,
/// The block number to use for requests.
next_request_block_number: u64,
/// Keeps track of the block we need to validate next.
lowest_validated_header: Option<SealedHeader<H::Header>>,
/// Tip block number to start validating from (in reverse)
next_chain_tip_block_number: u64,
/// The batch size per one request
request_limit: u64,
/// Minimum amount of requests to handle concurrently.
min_concurrent_requests: usize,
/// Maximum amount of requests to handle concurrently.
max_concurrent_requests: usize,
/// The number of block headers to return at once
stream_batch_size: usize,
/// Maximum amount of received headers to buffer internally.
max_buffered_responses: usize,
/// Contains the request to retrieve the headers for the sync target
///
/// This will give us the block number of the `sync_target`, after which we can send multiple
/// requests at a time.
sync_target_request: Option<HeadersRequestFuture<H::Output>>,
/// requests in progress
in_progress_queue: FuturesUnordered<HeadersRequestFuture<H::Output>>,
/// Buffered, unvalidated responses
buffered_responses: BinaryHeap<OrderedHeadersResponse<H::Header>>,
/// Buffered, _sorted_ and validated headers ready to be returned.
///
/// Note: headers are sorted from high to low
queued_validated_headers: Vec<SealedHeader<H::Header>>,
/// Header downloader metrics.
metrics: HeaderDownloaderMetrics,
}
// === impl ReverseHeadersDownloader ===
impl<H> ReverseHeadersDownloader<H>
where
H: HeadersClient<Header: reth_primitives_traits::BlockHeader> + 'static,
{
/// Convenience method to create a [`ReverseHeadersDownloaderBuilder`] without importing it
pub fn builder() -> ReverseHeadersDownloaderBuilder {
ReverseHeadersDownloaderBuilder::default()
}
/// Returns the block number the local node is at.
#[inline]
fn local_block_number(&self) -> Option<BlockNumber> {
self.local_head.as_ref().map(|h| h.number())
}
/// Returns the existing local head block number
///
/// # Panics
///
/// If the local head has not been set.
#[inline]
fn existing_local_block_number(&self) -> BlockNumber {
self.local_head.as_ref().expect("is initialized").number()
}
/// Returns the existing sync target.
///
/// # Panics
///
/// If the sync target has never been set.
#[inline]
fn existing_sync_target(&self) -> SyncTargetBlock {
self.sync_target.as_ref().expect("is initialized").clone()
}
/// Max requests to handle at the same time
///
/// This depends on the number of active peers but will always be
/// [`min_concurrent_requests`..`max_concurrent_requests`]
#[inline]
fn concurrent_request_limit(&self) -> usize {
let num_peers = self.client.num_connected_peers();
// we try to keep more requests than available peers active so that there's always a
// followup request available for a peer
let dynamic_target = num_peers * REQUESTS_PER_PEER_MULTIPLIER;
let max_dynamic = dynamic_target.max(self.min_concurrent_requests);
// If only a few peers are connected we keep it low
if num_peers < self.min_concurrent_requests {
return max_dynamic
}
max_dynamic.min(self.max_concurrent_requests)
}
/// Returns the next header request
///
/// This will advance the current block towards the local head.
///
/// Returns `None` if no more requests are required.
fn next_request(&mut self) -> Option<HeadersRequest> {
if let Some(local_head) = self.local_block_number() {
if self.next_request_block_number > local_head {
let request = calc_next_request(
local_head,
self.next_request_block_number,
self.request_limit,
);
// need to shift the tracked request block number based on the number of requested
// headers so follow-up requests will use that as start.
self.next_request_block_number -= request.limit;
return Some(request)
}
}
None
}
/// Returns the next header to use for validation.
///
/// Since this downloader downloads blocks with falling block number, this will return the
/// lowest (in terms of block number) validated header.
///
/// This is either the last `queued_validated_headers`, or if has been drained entirely the
/// `lowest_validated_header`.
///
/// This only returns `None` if we haven't fetched the initial chain tip yet.
fn lowest_validated_header(&self) -> Option<&SealedHeader<H::Header>> {
self.queued_validated_headers.last().or(self.lowest_validated_header.as_ref())
}
/// Validate that the received header matches the expected sync target.
fn validate_sync_target(
&self,
header: &SealedHeader<H::Header>,
request: HeadersRequest,
peer_id: PeerId,
) -> Result<(), Box<HeadersResponseError>> {
match self.existing_sync_target() {
SyncTargetBlock::Hash(hash) | SyncTargetBlock::HashAndNumber { hash, .. }
if header.hash() != hash =>
{
Err(Box::new(HeadersResponseError {
request,
peer_id: Some(peer_id),
error: DownloadError::InvalidTip(
GotExpected { got: header.hash(), expected: hash }.into(),
),
}))
}
SyncTargetBlock::Number(number) if header.number() != number => {
Err(Box::new(HeadersResponseError {
request,
peer_id: Some(peer_id),
error: DownloadError::InvalidTipNumber(GotExpected {
got: header.number(),
expected: number,
}),
}))
}
_ => Ok(()),
}
}
/// Processes the next headers in line.
///
/// This will validate all headers and insert them into the validated buffer.
///
/// Returns an error if the given headers are invalid.
///
/// Caution: this expects the `headers` to be sorted with _falling_ block numbers
fn process_next_headers(
&mut self,
request: HeadersRequest,
headers: Vec<H::Header>,
peer_id: PeerId,
) -> Result<(), ReverseHeadersDownloaderError<H::Header>> {
let mut validated = Vec::with_capacity(headers.len());
let sealed_headers = headers.into_par_iter().map(SealedHeader::seal).collect::<Vec<_>>();
for parent in sealed_headers {
// Validate that the header is the parent header of the last validated header.
if let Some(validated_header) =
validated.last().or_else(|| self.lowest_validated_header())
{
if let Err(error) = self.validate(validated_header, &parent) {
trace!(target: "downloaders::headers", %error ,"Failed to validate header");
return Err(
HeadersResponseError { request, peer_id: Some(peer_id), error }.into()
)
}
} else {
self.validate_sync_target(&parent, request.clone(), peer_id)?;
}
validated.push(parent);
}
// If the last (smallest) validated header attaches to the local head, validate it.
if let Some((last_header, head)) = validated
.last_mut()
.zip(self.local_head.as_ref())
.filter(|(last, head)| last.number() == head.number() + 1)
{
// Every header must be valid on its own
if let Err(error) = self.consensus.validate_header(&*last_header) {
trace!(target: "downloaders::headers", %error, "Failed to validate header");
return Err(HeadersResponseError {
request,
peer_id: Some(peer_id),
error: DownloadError::HeaderValidation {
hash: head.hash(),
number: head.number(),
error: Box::new(error),
},
}
.into())
}
// If the header is valid on its own, but not against its parent, we return it as
// detached head error.
if let Err(error) = self.consensus.validate_header_against_parent(&*last_header, head) {
// Replace the last header with a detached variant
error!(target: "downloaders::headers", %error, number = last_header.number(), hash = ?last_header.hash(), "Header cannot be attached to known canonical chain");
return Err(HeadersDownloaderError::DetachedHead {
local_head: Box::new(head.clone()),
header: Box::new(last_header.clone()),
error: Box::new(error),
}
.into())
}
}
// update tracked block info (falling block number)
self.next_chain_tip_block_number =
validated.last().expect("exists").number().saturating_sub(1);
self.queued_validated_headers.extend(validated);
Ok(())
}
/// Updates the state based on the given `target_block_number`
///
/// There are three different outcomes:
/// * This is the first time this is called: current `sync_target` block is still `None`. In
/// which case we're initializing the request trackers to `next_block`
/// * The `target_block_number` is _higher_ than the current target. In which case we start
/// over with a new range
/// * The `target_block_number` is _lower_ than the current target or the _same_. In which case
/// we don't need to update the request trackers but need to ensure already buffered headers
/// are _not_ higher than the new `target_block_number`.
fn on_block_number_update(&mut self, target_block_number: u64, next_block: u64) {
// Update the trackers
if let Some(old_target) =
self.sync_target.as_mut().and_then(|t| t.replace_number(target_block_number))
{
if target_block_number > old_target {
// the new target is higher than the old target we need to update the
// request tracker and reset everything
self.next_request_block_number = next_block;
self.next_chain_tip_block_number = next_block;
self.clear();
} else {
// ensure already validated headers are in range
let skip = self
.queued_validated_headers
.iter()
.take_while(|last| last.number() > target_block_number)
.count();
// removes all headers that are higher than current target
self.queued_validated_headers.drain(..skip);
}
} else {
// this occurs on the initial sync target request
self.next_request_block_number = next_block;
self.next_chain_tip_block_number = next_block;
}
}
/// Handles the response for the request for the sync target
fn on_sync_target_outcome(
&mut self,
response: HeadersRequestOutcome<H::Header>,
) -> Result<(), ReverseHeadersDownloaderError<H::Header>> {
let sync_target = self.existing_sync_target();
let HeadersRequestOutcome { request, outcome } = response;
match outcome {
Ok(res) => {
let (peer_id, mut headers) = res.split();
// update total downloaded metric
self.metrics.total_downloaded.increment(headers.len() as u64);
// sort headers from highest to lowest block number
headers.sort_unstable_by_key(|h| Reverse(h.number()));
if headers.is_empty() {
return Err(HeadersResponseError {
request,
peer_id: Some(peer_id),
error: DownloadError::EmptyResponse,
}
.into())
}
let header = headers.swap_remove(0);
let target = SealedHeader::seal(header);
match sync_target {
SyncTargetBlock::Hash(hash) | SyncTargetBlock::HashAndNumber { hash, .. } => {
if target.hash() != hash {
return Err(HeadersResponseError {
request,
peer_id: Some(peer_id),
error: DownloadError::InvalidTip(
GotExpected { got: target.hash(), expected: hash }.into(),
),
}
.into())
}
}
SyncTargetBlock::Number(number) => {
if target.number() != number {
return Err(HeadersResponseError {
request,
peer_id: Some(peer_id),
error: DownloadError::InvalidTipNumber(GotExpected {
got: target.number(),
expected: number,
}),
}
.into())
}
}
}
trace!(target: "downloaders::headers", head=?self.local_block_number(), hash=?target.hash(), number=%target.number(), "Received sync target");
// This is the next block we need to start issuing requests from
let parent_block_number = target.number().saturating_sub(1);
self.on_block_number_update(target.number(), parent_block_number);
self.queued_validated_headers.push(target);
// try to validate all buffered responses blocked by this successful response
self.try_validate_buffered()
.map(Err::<(), ReverseHeadersDownloaderError<H::Header>>)
.transpose()?;
Ok(())
}
Err(err) => {
Err(HeadersResponseError { request, peer_id: None, error: err.into() }.into())
}
}
}
/// Invoked when we received a response
fn on_headers_outcome(
&mut self,
response: HeadersRequestOutcome<H::Header>,
) -> Result<(), ReverseHeadersDownloaderError<H::Header>> {
let requested_block_number = response.block_number();
let HeadersRequestOutcome { request, outcome } = response;
match outcome {
Ok(res) => {
let (peer_id, mut headers) = res.split();
// update total downloaded metric
self.metrics.total_downloaded.increment(headers.len() as u64);
trace!(target: "downloaders::headers", len=%headers.len(), "Received headers response");
if headers.is_empty() {
return Err(HeadersResponseError {
request,
peer_id: Some(peer_id),
error: DownloadError::EmptyResponse,
}
.into())
}
if (headers.len() as u64) != request.limit {
return Err(HeadersResponseError {
peer_id: Some(peer_id),
error: DownloadError::HeadersResponseTooShort(GotExpected {
got: headers.len() as u64,
expected: request.limit,
}),
request,
}
.into())
}
// sort headers from highest to lowest block number
headers.sort_unstable_by_key(|h| Reverse(h.number()));
// validate the response
let highest = &headers[0];
trace!(target: "downloaders::headers", requested_block_number, highest=?highest.number(), "Validating non-empty headers response");
if highest.number() != requested_block_number {
return Err(HeadersResponseError {
request,
peer_id: Some(peer_id),
error: DownloadError::HeadersResponseStartBlockMismatch(GotExpected {
got: highest.number(),
expected: requested_block_number,
}),
}
.into())
}
// check if the response is the next expected
if highest.number() == self.next_chain_tip_block_number {
// is next response, validate it
self.process_next_headers(request, headers, peer_id)?;
// try to validate all buffered responses blocked by this successful response
self.try_validate_buffered()
.map(Err::<(), ReverseHeadersDownloaderError<H::Header>>)
.transpose()?;
} else if highest.number() > self.existing_local_block_number() {
self.metrics.buffered_responses.increment(1.);
// can't validate yet
self.buffered_responses.push(OrderedHeadersResponse {
headers,
request,
peer_id,
})
}
Ok(())
}
// most likely a noop, because this error
// would've been handled by the fetcher internally
Err(err) => {
trace!(target: "downloaders::headers", %err, "Response error");
Err(HeadersResponseError { request, peer_id: None, error: err.into() }.into())
}
}
}
fn penalize_peer(&self, peer_id: Option<PeerId>, error: &DownloadError) {
// Penalize the peer for bad response
if let Some(peer_id) = peer_id {
trace!(target: "downloaders::headers", ?peer_id, %error, "Penalizing peer");
self.client.report_bad_message(peer_id);
}
}
/// Handles the error of a bad response
///
/// This will re-submit the request.
fn on_headers_error(&self, err: Box<HeadersResponseError>) {
let HeadersResponseError { request, peer_id, error } = *err;
self.penalize_peer(peer_id, &error);
// Update error metric
self.metrics.increment_errors(&error);
// Re-submit the request
self.submit_request(request, Priority::High);
}
/// Attempts to validate the buffered responses
///
/// Returns an error if the next expected response was popped, but failed validation.
fn try_validate_buffered(&mut self) -> Option<ReverseHeadersDownloaderError<H::Header>> {
loop {
// Check to see if we've already received the next value
let next_response = self.buffered_responses.peek_mut()?;
let next_block_number = next_response.block_number();
match next_block_number.cmp(&self.next_chain_tip_block_number) {
Ordering::Less => return None,
Ordering::Equal => {
let OrderedHeadersResponse { headers, request, peer_id } =
PeekMut::pop(next_response);
self.metrics.buffered_responses.decrement(1.);
if let Err(err) = self.process_next_headers(request, headers, peer_id) {
return Some(err)
}
}
Ordering::Greater => {
self.metrics.buffered_responses.decrement(1.);
PeekMut::pop(next_response);
}
}
}
}
/// Returns the request for the `sync_target` header.
const fn get_sync_target_request(&self, start: BlockHashOrNumber) -> HeadersRequest {
HeadersRequest::falling(start, 1)
}
/// Starts a request future
fn submit_request(&self, request: HeadersRequest, priority: Priority) {
trace!(target: "downloaders::headers", ?request, "Submitting headers request");
self.in_progress_queue.push(self.request_fut(request, priority));
self.metrics.in_flight_requests.increment(1.);
}
fn request_fut(
&self,
request: HeadersRequest,
priority: Priority,
) -> HeadersRequestFuture<H::Output> {
let client = Arc::clone(&self.client);
HeadersRequestFuture {
request: Some(request.clone()),
fut: client.get_headers_with_priority(request, priority),
}
}
/// Validate whether the header is valid in relation to it's parent
fn validate(
&self,
header: &SealedHeader<H::Header>,
parent: &SealedHeader<H::Header>,
) -> DownloadResult<()> {
validate_header_download(&self.consensus, header, parent)
}
/// Clears all requests/responses.
fn clear(&mut self) {
self.lowest_validated_header.take();
self.queued_validated_headers = Vec::new();
self.buffered_responses = BinaryHeap::new();
self.in_progress_queue.clear();
self.metrics.in_flight_requests.set(0.);
self.metrics.buffered_responses.set(0.);
}
/// Splits off the next batch of headers
fn split_next_batch(&mut self) -> Vec<SealedHeader<H::Header>> {
let batch_size = self.stream_batch_size.min(self.queued_validated_headers.len());
let mut rem = self.queued_validated_headers.split_off(batch_size);
std::mem::swap(&mut rem, &mut self.queued_validated_headers);
// If the downloader consumer does not flush headers at the same rate that the downloader
// queues them, then the `queued_validated_headers` buffer can grow unbounded.
//
// The semantics of `split_off` state that the capacity of the original buffer is
// unchanged, so queued_validated_headers will then have only `batch_size` elements, and
// its original capacity. Because `rem` is initially populated with elements `[batch_size,
// len)` of `queued_validated_headers`, it will have a capacity of at least `len -
// batch_size`, and the total memory allocated by the two buffers will be around double the
// original size of `queued_validated_headers`.
//
// These are then mem::swapped, leaving `rem` with a large capacity, but small length.
//
// To prevent these allocations from leaking to the consumer, we shrink the capacity of the
// new buffer. The total memory allocated should then be not much more than the original
// size of `queued_validated_headers`.
rem.shrink_to_fit();
rem
}
}
impl<H> ReverseHeadersDownloader<H>
where
H: HeadersClient,
Self: HeaderDownloader + 'static,
{
/// Spawns the downloader task via [`tokio::task::spawn`]
pub fn into_task(self) -> TaskDownloader<<Self as HeaderDownloader>::Header> {
self.into_task_with(&TokioTaskExecutor::default())
}
/// Convert the downloader into a [`TaskDownloader`] by spawning it via the given `spawner`.
pub fn into_task_with<S>(
self,
spawner: &S,
) -> TaskDownloader<<Self as HeaderDownloader>::Header>
where
S: TaskSpawner,
{
TaskDownloader::spawn_with(self, spawner)
}
}
impl<H> HeaderDownloader for ReverseHeadersDownloader<H>
where
H: HeadersClient<Header: reth_primitives_traits::BlockHeader> + 'static,
{
type Header = H::Header;
fn update_local_head(&mut self, head: SealedHeader<H::Header>) {
// ensure we're only yielding headers that are in range and follow the current local head.
while self
.queued_validated_headers
.last()
.is_some_and(|last| last.number() <= head.number())
{
// headers are sorted high to low
self.queued_validated_headers.pop();
}
// update the local head
self.local_head = Some(head);
}
/// If the given target is different from the current target, we need to update the sync target
fn update_sync_target(&mut self, target: SyncTarget) {
let current_tip = self.sync_target.as_ref().and_then(|t| t.hash());
match target {
SyncTarget::Tip(tip) => {
if Some(tip) != current_tip {
trace!(target: "downloaders::headers", current=?current_tip, new=?tip, "Update sync target");
let new_sync_target = SyncTargetBlock::from_hash(tip);
// if the new sync target is the next queued request we don't need to re-start
// the target update
if let Some(target_number) = self
.queued_validated_headers
.first()
.filter(|h| h.hash() == tip)
.map(|h| h.number())
{
self.sync_target = Some(new_sync_target.with_number(target_number));
return
}
trace!(target: "downloaders::headers", new=?target, "Request new sync target");
self.metrics.out_of_order_requests.increment(1);
self.sync_target = Some(new_sync_target);
self.sync_target_request = Some(
self.request_fut(self.get_sync_target_request(tip.into()), Priority::High),
);
}
}
SyncTarget::Gap(existing) => {
let target = existing.parent;
if Some(target) != current_tip {
// there could be a sync target request in progress
self.sync_target_request.take();
// If the target has changed, update the request pointers based on the new
// targeted block number
let parent_block_number = existing.block.number.saturating_sub(1);
trace!(target: "downloaders::headers", current=?current_tip, new=?target, %parent_block_number, "Updated sync target");
// Update the sync target hash
self.sync_target = match self.sync_target.take() {
Some(sync_target) => Some(sync_target.with_hash(target)),
None => Some(SyncTargetBlock::from_hash(target)),
};
self.on_block_number_update(parent_block_number, parent_block_number);
}
}
SyncTarget::TipNum(num) => {
let current_tip_num = self.sync_target.as_ref().and_then(|t| t.number());
if Some(num) != current_tip_num {
trace!(target: "downloaders::headers", %num, "Updating sync target based on num");
// just update the sync target
self.sync_target = Some(SyncTargetBlock::from_number(num));
self.sync_target_request = Some(
self.request_fut(self.get_sync_target_request(num.into()), Priority::High),
);
}
}
}
}
fn set_batch_size(&mut self, batch_size: usize) {
self.stream_batch_size = batch_size;
}
}
impl<H> Stream for ReverseHeadersDownloader<H>
where
H: HeadersClient<Header: reth_primitives_traits::BlockHeader> + 'static,
{
type Item = HeadersDownloaderResult<Vec<SealedHeader<H::Header>>, H::Header>;
fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
let this = self.get_mut();
// The downloader boundaries (local head and sync target) have to be set in order
// to start downloading data.
if this.local_head.is_none() || this.sync_target.is_none() {
trace!(
target: "downloaders::headers",
head=?this.local_block_number(),
sync_target=?this.sync_target,
"The downloader sync boundaries have not been set"
);
return Poll::Pending
}
// If we have a new tip request we need to complete that first before we send batched
// requests
while let Some(mut req) = this.sync_target_request.take() {
match req.poll_unpin(cx) {
Poll::Ready(outcome) => {
match this.on_sync_target_outcome(outcome) {
Ok(()) => break,
Err(ReverseHeadersDownloaderError::Response(error)) => {
trace!(target: "downloaders::headers", %error, "invalid sync target response");
if error.is_channel_closed() {
// download channel closed which means the network was dropped
return Poll::Ready(None)
}
this.penalize_peer(error.peer_id, &error.error);
this.metrics.increment_errors(&error.error);
this.sync_target_request =
Some(this.request_fut(error.request, Priority::High));
}
Err(ReverseHeadersDownloaderError::Downloader(error)) => {
this.clear();
return Poll::Ready(Some(Err(error)))
}
};
}
Poll::Pending => {
this.sync_target_request = Some(req);
return Poll::Pending
}
}
}
// shrink the buffer after handling sync target outcomes
this.buffered_responses.shrink_to_fit();
// this loop will submit new requests and poll them, if a new batch is ready it is returned
// The actual work is done by the receiver of the request channel, this means, polling the
// request future is just reading from a `oneshot::Receiver`. Hence, this loop tries to keep
// the downloader at capacity at all times The order of loops is as follows:
// 1. poll futures to make room for followup requests (this will also prepare validated
// headers for 3.) 2. exhaust all capacity by sending requests
// 3. return batch, if enough validated
// 4. return Pending if 2.) did not submit a new request, else continue
loop {
// poll requests
while let Poll::Ready(Some(outcome)) = this.in_progress_queue.poll_next_unpin(cx) {
this.metrics.in_flight_requests.decrement(1.);
// handle response
match this.on_headers_outcome(outcome) {
Ok(()) => (),
Err(ReverseHeadersDownloaderError::Response(error)) => {
if error.is_channel_closed() {
// download channel closed which means the network was dropped
return Poll::Ready(None)
}
this.on_headers_error(error);
}
Err(ReverseHeadersDownloaderError::Downloader(error)) => {
this.clear();
return Poll::Ready(Some(Err(error)))
}
};
}
// shrink the buffer after handling headers outcomes
this.buffered_responses.shrink_to_fit();
// marks the loop's exit condition: exit if no requests submitted
let mut progress = false;
let concurrent_request_limit = this.concurrent_request_limit();
// populate requests
while this.in_progress_queue.len() < concurrent_request_limit &&
this.buffered_responses.len() < this.max_buffered_responses
{
if let Some(request) = this.next_request() {
trace!(
target: "downloaders::headers",
"Requesting headers {request:?}"
);
progress = true;
this.submit_request(request, Priority::Normal);
} else {
// no more requests
break
}
}
// yield next batch
if this.queued_validated_headers.len() >= this.stream_batch_size {
let next_batch = this.split_next_batch();
// Note: if this would drain all headers, we need to keep the lowest (last index)
// around so we can continue validating headers responses.
if this.queued_validated_headers.is_empty() {
this.lowest_validated_header = next_batch.last().cloned();
}
trace!(target: "downloaders::headers", batch=%next_batch.len(), "Returning validated batch");
this.metrics.total_flushed.increment(next_batch.len() as u64);
return Poll::Ready(Some(Ok(next_batch)))
}
if !progress {
break
}
}
// all requests are handled, stream is finished
if this.in_progress_queue.is_empty() {
let next_batch = this.split_next_batch();
if next_batch.is_empty() {
this.clear();
return Poll::Ready(None)
}
this.metrics.total_flushed.increment(next_batch.len() as u64);
return Poll::Ready(Some(Ok(next_batch)))
}
Poll::Pending
}
}
/// A future that returns a list of headers on success.
#[derive(Debug)]
struct HeadersRequestFuture<F> {
request: Option<HeadersRequest>,
fut: F,
}
impl<F, H> Future for HeadersRequestFuture<F>
where
F: Future<Output = PeerRequestResult<Vec<H>>> + Sync + Send + Unpin,
{
type Output = HeadersRequestOutcome<H>;
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
let this = self.get_mut();
let outcome = ready!(this.fut.poll_unpin(cx));
let request = this.request.take().unwrap();
Poll::Ready(HeadersRequestOutcome { request, outcome })
}
}
/// The outcome of the [`HeadersRequestFuture`]
struct HeadersRequestOutcome<H> {
request: HeadersRequest,
outcome: PeerRequestResult<Vec<H>>,
}
// === impl OrderedHeadersResponse ===
impl<H> HeadersRequestOutcome<H> {
fn block_number(&self) -> u64 {
self.request.start.as_number().expect("is number")
}
}
/// Wrapper type to order responses
#[derive(Debug)]
struct OrderedHeadersResponse<H> {
headers: Vec<H>,
request: HeadersRequest,
peer_id: PeerId,
}
// === impl OrderedHeadersResponse ===
impl<H> OrderedHeadersResponse<H> {
fn block_number(&self) -> u64 {
self.request.start.as_number().expect("is number")
}
}
impl<H> PartialEq for OrderedHeadersResponse<H> {
fn eq(&self, other: &Self) -> bool {
self.block_number() == other.block_number()
}
}
impl<H> Eq for OrderedHeadersResponse<H> {}
impl<H> PartialOrd for OrderedHeadersResponse<H> {
fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
Some(self.cmp(other))
}
}
impl<H> Ord for OrderedHeadersResponse<H> {
fn cmp(&self, other: &Self) -> Ordering {
self.block_number().cmp(&other.block_number())
}
}
/// Type returned if a bad response was processed
#[derive(Debug, Error)]
#[error("error requesting headers from peer {peer_id:?}: {error}; request: {request:?}")]
struct HeadersResponseError {
request: HeadersRequest,
peer_id: Option<PeerId>,
#[source]
error: DownloadError,
}
impl HeadersResponseError {
/// Returns true if the error was caused by a closed channel to the network.
const fn is_channel_closed(&self) -> bool {
if let DownloadError::RequestError(ref err) = self.error {
return err.is_channel_closed()
}
false
}
}
/// The block to which we want to close the gap: (local head...sync target]
/// This tracks the sync target block, so this could be either a block number or hash.
#[derive(Clone, Debug)]
pub enum SyncTargetBlock {
/// Block hash of the targeted block
Hash(B256),
/// Block number of the targeted block
Number(u64),
/// Both the block hash and number of the targeted block
HashAndNumber {
/// Block hash of the targeted block
hash: B256,
/// Block number of the targeted block
number: u64,
},
}
impl SyncTargetBlock {
/// Create new instance from hash.
const fn from_hash(hash: B256) -> Self {
Self::Hash(hash)
}
/// Create new instance from number.
const fn from_number(num: u64) -> Self {
Self::Number(num)
}
/// Set the hash for the sync target.
const fn with_hash(self, hash: B256) -> Self {
match self {
Self::Hash(_) => Self::Hash(hash),
Self::Number(number) | Self::HashAndNumber { number, .. } => {
Self::HashAndNumber { hash, number }
}
}
}
/// Set a number on the instance.
const fn with_number(self, number: u64) -> Self {
match self {
Self::Hash(hash) | Self::HashAndNumber { hash, .. } => {
Self::HashAndNumber { hash, number }
}
Self::Number(_) => Self::Number(number),
}
}
/// Replace the target block number, and return the old block number, if it was set.
///
/// If the target block is a hash, this be converted into a `HashAndNumber`, but return `None`.
/// The semantics should be equivalent to that of `Option::replace`.
fn replace_number(&mut self, number: u64) -> Option<u64> {
match self {
Self::Hash(hash) => {
*self = Self::HashAndNumber { hash: *hash, number };
None
}
Self::Number(old_number) => {
let res = Some(*old_number);
*self = Self::Number(number);
res
}
Self::HashAndNumber { number: old_number, hash } => {
let res = Some(*old_number);
*self = Self::HashAndNumber { hash: *hash, number };
res
}
}
}
/// Return the hash of the target block, if it is set.
const fn hash(&self) -> Option<B256> {
match self {
Self::Hash(hash) | Self::HashAndNumber { hash, .. } => Some(*hash),
Self::Number(_) => None,
}
}
/// Return the block number of the sync target, if it is set.
const fn number(&self) -> Option<u64> {
match self {
Self::Hash(_) => None,
Self::Number(number) | Self::HashAndNumber { number, .. } => Some(*number),
}
}
}
/// The builder for [`ReverseHeadersDownloader`] with
/// some default settings
#[derive(Debug)]
pub struct ReverseHeadersDownloaderBuilder {
/// The batch size per one request
request_limit: u64,
/// Batch size for headers
stream_batch_size: usize,
/// Batch size for headers
min_concurrent_requests: usize,
/// Batch size for headers
max_concurrent_requests: usize,
/// How many responses to buffer
max_buffered_responses: usize,
}
impl ReverseHeadersDownloaderBuilder {
/// Creates a new [`ReverseHeadersDownloaderBuilder`] with configurations based on the provided
/// [`HeadersConfig`].
pub fn new(config: HeadersConfig) -> Self {
Self::default()
.request_limit(config.downloader_request_limit)
.min_concurrent_requests(config.downloader_min_concurrent_requests)
.max_concurrent_requests(config.downloader_max_concurrent_requests)
.max_buffered_responses(config.downloader_max_buffered_responses)
.stream_batch_size(config.commit_threshold as usize)
}
}
impl Default for ReverseHeadersDownloaderBuilder {
fn default() -> Self {
Self {
stream_batch_size: 10_000,
// This is just below the max number of headers commonly in a headers response (1024), see also <https://github.com/ethereum/go-ethereum/blob/b0d44338bbcefee044f1f635a84487cbbd8f0538/eth/protocols/eth/handler.go#L38-L40>
// with ~500bytes per header this around 0.5MB per request max
request_limit: 1_000,
max_concurrent_requests: 100,
min_concurrent_requests: 5,
max_buffered_responses: 100,
}
}
}
impl ReverseHeadersDownloaderBuilder {
/// Set the request batch size.
///
/// This determines the `limit` for a `GetBlockHeaders` requests, the number of headers we ask
/// for.
pub const fn request_limit(mut self, limit: u64) -> Self {
self.request_limit = limit;
self
}
/// Set the stream batch size
///
/// This determines the number of headers the [`ReverseHeadersDownloader`] will yield on
/// `Stream::next`. This will be the amount of headers the headers stage will commit at a
/// time.
pub const fn stream_batch_size(mut self, size: usize) -> Self {
self.stream_batch_size = size;
self
}
/// Set the min amount of concurrent requests.
///
/// If there's capacity the [`ReverseHeadersDownloader`] will keep at least this many requests
/// active at a time.
pub const fn min_concurrent_requests(mut self, min_concurrent_requests: usize) -> Self {
self.min_concurrent_requests = min_concurrent_requests;
self
}
/// Set the max amount of concurrent requests.
///
/// The downloader's concurrent requests won't exceed the given amount.
pub const fn max_concurrent_requests(mut self, max_concurrent_requests: usize) -> Self {
self.max_concurrent_requests = max_concurrent_requests;
self
}
/// How many responses to buffer internally.
///
/// This essentially determines how much memory the downloader can use for buffering responses
/// that arrive out of order. The total number of buffered headers is `request_limit *
/// max_buffered_responses`. If the [`ReverseHeadersDownloader`]'s buffered responses exceeds
/// this threshold it waits until there's capacity again before sending new requests.
pub const fn max_buffered_responses(mut self, max_buffered_responses: usize) -> Self {
self.max_buffered_responses = max_buffered_responses;
self
}
/// Build [`ReverseHeadersDownloader`] with provided consensus
/// and header client implementations
pub fn build<H>(
self,
client: H,
consensus: Arc<dyn HeaderValidator<H::Header>>,
) -> ReverseHeadersDownloader<H>
where
H: HeadersClient + 'static,
{
let Self {
request_limit,
stream_batch_size,
min_concurrent_requests,
max_concurrent_requests,
max_buffered_responses,
} = self;
ReverseHeadersDownloader {
consensus,
client: Arc::new(client),
local_head: None,
sync_target: None,
// Note: we set these to `0` first, they'll be updated once the sync target response is
// handled and only used afterwards
next_request_block_number: 0,
next_chain_tip_block_number: 0,
lowest_validated_header: None,
request_limit,
min_concurrent_requests,
max_concurrent_requests,
stream_batch_size,
max_buffered_responses,
sync_target_request: None,
in_progress_queue: Default::default(),
buffered_responses: Default::default(),
queued_validated_headers: Default::default(),
metrics: Default::default(),
}
}
}
/// Configures and returns the next [`HeadersRequest`] based on the given parameters
///
/// The request will start at the given `next_request_block_number` block.
/// The `limit` of the request will either be the targeted `request_limit` or the difference of
/// `next_request_block_number` and the `local_head` in case this is smaller than the targeted
/// `request_limit`.
#[inline]
fn calc_next_request(
local_head: u64,
next_request_block_number: u64,
request_limit: u64,
) -> HeadersRequest {
// downloading is in reverse
let diff = next_request_block_number - local_head;
let limit = diff.min(request_limit);
let start = next_request_block_number;
HeadersRequest::falling(start.into(), limit)
}
#[cfg(test)]
mod tests {
use super::*;
use crate::headers::test_utils::child_header;
use alloy_consensus::Header;
use alloy_eips::{eip1898::BlockWithParent, BlockNumHash};
use assert_matches::assert_matches;
use reth_consensus::test_utils::TestConsensus;
use reth_network_p2p::test_utils::TestHeadersClient;
/// Tests that `replace_number` works the same way as `Option::replace`
#[test]
fn test_replace_number_semantics() {
struct Fixture {
// input fields (both SyncTargetBlock and Option<u64>)
sync_target_block: SyncTargetBlock,
sync_target_option: Option<u64>,
// option to replace
replace_number: u64,
// expected method result
expected_result: Option<u64>,
// output state
new_number: u64,
}
let fixtures = vec![
Fixture {
sync_target_block: SyncTargetBlock::Hash(B256::random()),
// Hash maps to None here, all other variants map to Some
sync_target_option: None,
replace_number: 1,
expected_result: None,
new_number: 1,
},
Fixture {
sync_target_block: SyncTargetBlock::Number(1),
sync_target_option: Some(1),
replace_number: 2,
expected_result: Some(1),
new_number: 2,
},
Fixture {
sync_target_block: SyncTargetBlock::HashAndNumber {
hash: B256::random(),
number: 1,
},
sync_target_option: Some(1),
replace_number: 2,
expected_result: Some(1),
new_number: 2,
},
];
for fixture in fixtures {
let mut sync_target_block = fixture.sync_target_block;
let result = sync_target_block.replace_number(fixture.replace_number);
assert_eq!(result, fixture.expected_result);
assert_eq!(sync_target_block.number(), Some(fixture.new_number));
let mut sync_target_option = fixture.sync_target_option;
let option_result = sync_target_option.replace(fixture.replace_number);
assert_eq!(option_result, fixture.expected_result);
assert_eq!(sync_target_option, Some(fixture.new_number));
}
}
/// Tests that request calc works
#[test]
fn test_sync_target_update() {
let client = Arc::new(TestHeadersClient::default());
let genesis = SealedHeader::default();
let mut downloader = ReverseHeadersDownloaderBuilder::default()
.build(Arc::clone(&client), Arc::new(TestConsensus::default()));
downloader.update_local_head(genesis);
downloader.update_sync_target(SyncTarget::Tip(B256::random()));
downloader.sync_target_request.take();
let target = SyncTarget::Tip(B256::random());
downloader.update_sync_target(target);
assert!(downloader.sync_target_request.is_some());
downloader.sync_target_request.take();
let target = SyncTarget::Gap(BlockWithParent {
block: BlockNumHash::new(0, B256::random()),
parent: Default::default(),
});
downloader.update_sync_target(target);
assert!(downloader.sync_target_request.is_none());
assert_matches!(
downloader.sync_target,
Some(target) => target.number().is_some()
);
}
/// Tests that request calc works
#[test]
fn test_head_update() {
let client = Arc::new(TestHeadersClient::default());
let header: SealedHeader = SealedHeader::default();
let mut downloader = ReverseHeadersDownloaderBuilder::default()
.build(Arc::clone(&client), Arc::new(TestConsensus::default()));
downloader.update_local_head(header.clone());
downloader.update_sync_target(SyncTarget::Tip(B256::random()));
downloader.queued_validated_headers.push(header.clone());
let mut next = header.as_ref().clone();
next.number += 1;
downloader.update_local_head(SealedHeader::new(next, B256::random()));
assert!(downloader.queued_validated_headers.is_empty());
}
#[test]
fn test_request_calc() {
// request an entire batch
let local = 0;
let next = 1000;
let batch_size = 2;
let request = calc_next_request(local, next, batch_size);
assert_eq!(request.start, next.into());
assert_eq!(request.limit, batch_size);
// only request 1
let local = 999;
let next = 1000;
let batch_size = 2;
let request = calc_next_request(local, next, batch_size);
assert_eq!(request.start, next.into());
assert_eq!(request.limit, 1);
}
/// Tests that request calc works
#[test]
fn test_next_request() {
let client = Arc::new(TestHeadersClient::default());
let genesis = SealedHeader::default();
let batch_size = 99;
let start = 1000;
let mut downloader = ReverseHeadersDownloaderBuilder::default()
.request_limit(batch_size)
.build(Arc::clone(&client), Arc::new(TestConsensus::default()));
downloader.update_local_head(genesis);
downloader.update_sync_target(SyncTarget::Tip(B256::random()));
downloader.next_request_block_number = start;
let mut total = 0;
while let Some(req) = downloader.next_request() {
assert_eq!(req.start, (start - total).into());
total += req.limit;
}
assert_eq!(total, start);
assert_eq!(Some(downloader.next_request_block_number), downloader.local_block_number());
}
#[test]
fn test_resp_order() {
let mut heap = BinaryHeap::new();
let hi = 1u64;
heap.push(OrderedHeadersResponse::<Header> {
headers: vec![],
request: HeadersRequest { start: hi.into(), limit: 0, direction: Default::default() },
peer_id: Default::default(),
});
let lo = 0u64;
heap.push(OrderedHeadersResponse {
headers: vec![],
request: HeadersRequest { start: lo.into(), limit: 0, direction: Default::default() },
peer_id: Default::default(),
});
assert_eq!(heap.pop().unwrap().block_number(), hi);
assert_eq!(heap.pop().unwrap().block_number(), lo);
}
#[tokio::test]
async fn download_at_fork_head() {
reth_tracing::init_test_tracing();
let client = Arc::new(TestHeadersClient::default());
let p3 = SealedHeader::default();
let p2 = child_header(&p3);
let p1 = child_header(&p2);
let p0 = child_header(&p1);
let mut downloader = ReverseHeadersDownloaderBuilder::default()
.stream_batch_size(3)
.request_limit(3)
.build(Arc::clone(&client), Arc::new(TestConsensus::default()));
downloader.update_local_head(p3.clone());
downloader.update_sync_target(SyncTarget::Tip(p0.hash()));
client
.extend(vec![
p0.as_ref().clone(),
p1.as_ref().clone(),
p2.as_ref().clone(),
p3.as_ref().clone(),
])
.await;
let headers = downloader.next().await.unwrap();
assert_eq!(headers, Ok(vec![p0, p1, p2,]));
assert!(downloader.buffered_responses.is_empty());
assert!(downloader.next().await.is_none());
assert!(downloader.next().await.is_none());
}
#[tokio::test]
async fn download_one_by_one() {
reth_tracing::init_test_tracing();
let p3 = SealedHeader::default();
let p2 = child_header(&p3);
let p1 = child_header(&p2);
let p0 = child_header(&p1);
let client = Arc::new(TestHeadersClient::default());
let mut downloader = ReverseHeadersDownloaderBuilder::default()
.stream_batch_size(1)
.request_limit(1)
.build(Arc::clone(&client), Arc::new(TestConsensus::default()));
downloader.update_local_head(p3.clone());
downloader.update_sync_target(SyncTarget::Tip(p0.hash()));
client
.extend(vec![
p0.as_ref().clone(),
p1.as_ref().clone(),
p2.as_ref().clone(),
p3.as_ref().clone(),
])
.await;
let headers = downloader.next().await.unwrap();
assert_eq!(headers, Ok(vec![p0]));
let headers = headers.unwrap();
assert_eq!(headers.capacity(), headers.len());
let headers = downloader.next().await.unwrap();
assert_eq!(headers, Ok(vec![p1]));
let headers = headers.unwrap();
assert_eq!(headers.capacity(), headers.len());
let headers = downloader.next().await.unwrap();
assert_eq!(headers, Ok(vec![p2]));
let headers = headers.unwrap();
assert_eq!(headers.capacity(), headers.len());
assert!(downloader.next().await.is_none());
}
#[tokio::test]
async fn download_one_by_one_larger_request_limit() {
reth_tracing::init_test_tracing();
let p3 = SealedHeader::default();
let p2 = child_header(&p3);
let p1 = child_header(&p2);
let p0 = child_header(&p1);
let client = Arc::new(TestHeadersClient::default());
let mut downloader = ReverseHeadersDownloaderBuilder::default()
.stream_batch_size(1)
.request_limit(3)
.build(Arc::clone(&client), Arc::new(TestConsensus::default()));
downloader.update_local_head(p3.clone());
downloader.update_sync_target(SyncTarget::Tip(p0.hash()));
client
.extend(vec![
p0.as_ref().clone(),
p1.as_ref().clone(),
p2.as_ref().clone(),
p3.as_ref().clone(),
])
.await;
let headers = downloader.next().await.unwrap();
assert_eq!(headers, Ok(vec![p0]));
let headers = headers.unwrap();
assert_eq!(headers.capacity(), headers.len());
let headers = downloader.next().await.unwrap();
assert_eq!(headers, Ok(vec![p1]));
let headers = headers.unwrap();
assert_eq!(headers.capacity(), headers.len());
let headers = downloader.next().await.unwrap();
assert_eq!(headers, Ok(vec![p2]));
let headers = headers.unwrap();
assert_eq!(headers.capacity(), headers.len());
assert!(downloader.next().await.is_none());
}
}