reth_provider/providers/static_file/manager.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 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699
use super::{
metrics::StaticFileProviderMetrics, writer::StaticFileWriters, LoadedJar,
StaticFileJarProvider, StaticFileProviderRW, StaticFileProviderRWRefMut,
};
use crate::{
to_range, BlockHashReader, BlockNumReader, BlockReader, BlockSource, HeaderProvider,
ReceiptProvider, StageCheckpointReader, StatsReader, TransactionVariant, TransactionsProvider,
TransactionsProviderExt, WithdrawalsProvider,
};
use alloy_consensus::Header;
use alloy_eips::{
eip4895::{Withdrawal, Withdrawals},
BlockHashOrNumber,
};
use alloy_primitives::{keccak256, Address, BlockHash, BlockNumber, TxHash, TxNumber, B256, U256};
use dashmap::DashMap;
use notify::{RecommendedWatcher, RecursiveMode, Watcher};
use parking_lot::RwLock;
use reth_chainspec::{ChainInfo, ChainSpecProvider};
use reth_db::{
lockfile::StorageLock,
static_file::{iter_static_files, HeaderMask, ReceiptMask, StaticFileCursor, TransactionMask},
tables,
};
use reth_db_api::{
cursor::DbCursorRO,
models::{CompactU256, StoredBlockBodyIndices},
table::Table,
transaction::DbTx,
};
use reth_nippy_jar::{NippyJar, NippyJarChecker, CONFIG_FILE_EXTENSION};
use reth_node_types::NodePrimitives;
use reth_primitives::{
static_file::{
find_fixed_range, HighestStaticFiles, SegmentHeader, SegmentRangeInclusive,
DEFAULT_BLOCKS_PER_STATIC_FILE,
},
Block, BlockWithSenders, Receipt, SealedBlock, SealedBlockWithSenders, SealedHeader,
StaticFileSegment, TransactionMeta, TransactionSigned, TransactionSignedNoHash,
};
use reth_stages_types::{PipelineTarget, StageId};
use reth_storage_api::DBProvider;
use reth_storage_errors::provider::{ProviderError, ProviderResult};
use std::{
collections::{hash_map::Entry, BTreeMap, HashMap},
fmt::Debug,
marker::PhantomData,
ops::{Deref, Range, RangeBounds, RangeInclusive},
path::{Path, PathBuf},
sync::{mpsc, Arc},
};
use strum::IntoEnumIterator;
use tracing::{info, trace, warn};
/// Alias type for a map that can be queried for block ranges from a transaction
/// segment respectively. It uses `TxNumber` to represent the transaction end of a static file
/// range.
type SegmentRanges = HashMap<StaticFileSegment, BTreeMap<TxNumber, SegmentRangeInclusive>>;
/// Access mode on a static file provider. RO/RW.
#[derive(Debug, Default, PartialEq, Eq)]
pub enum StaticFileAccess {
/// Read-only access.
#[default]
RO,
/// Read-write access.
RW,
}
impl StaticFileAccess {
/// Returns `true` if read-only access.
pub const fn is_read_only(&self) -> bool {
matches!(self, Self::RO)
}
/// Returns `true` if read-write access.
pub const fn is_read_write(&self) -> bool {
matches!(self, Self::RW)
}
}
/// [`StaticFileProvider`] manages all existing [`StaticFileJarProvider`].
#[derive(Debug)]
pub struct StaticFileProvider<N>(pub(crate) Arc<StaticFileProviderInner<N>>);
impl<N> Clone for StaticFileProvider<N> {
fn clone(&self) -> Self {
Self(self.0.clone())
}
}
impl<N: NodePrimitives> StaticFileProvider<N> {
/// Creates a new [`StaticFileProvider`].
fn new(path: impl AsRef<Path>, access: StaticFileAccess) -> ProviderResult<Self> {
let provider = Self(Arc::new(StaticFileProviderInner::new(path, access)?));
provider.initialize_index()?;
Ok(provider)
}
/// Creates a new [`StaticFileProvider`] with read-only access.
///
/// Set `watch_directory` to `true` to track the most recent changes in static files. Otherwise,
/// new data won't be detected or queryable.
pub fn read_only(path: impl AsRef<Path>, watch_directory: bool) -> ProviderResult<Self> {
let provider = Self::new(path, StaticFileAccess::RO)?;
if watch_directory {
provider.watch_directory();
}
Ok(provider)
}
/// Creates a new [`StaticFileProvider`] with read-write access.
pub fn read_write(path: impl AsRef<Path>) -> ProviderResult<Self> {
Self::new(path, StaticFileAccess::RW)
}
/// Watches the directory for changes and updates the in-memory index when modifications
/// are detected.
///
/// This may be necessary, since a non-node process that owns a [`StaticFileProvider`] does not
/// receive `update_index` notifications from a node that appends/truncates data.
pub fn watch_directory(&self) {
let provider = self.clone();
std::thread::spawn(move || {
let (tx, rx) = std::sync::mpsc::channel();
let mut watcher = RecommendedWatcher::new(
move |res| tx.send(res).unwrap(),
notify::Config::default(),
)
.expect("failed to create watcher");
watcher
.watch(&provider.path, RecursiveMode::NonRecursive)
.expect("failed to watch path");
// Some backends send repeated modified events
let mut last_event_timestamp = None;
while let Ok(res) = rx.recv() {
match res {
Ok(event) => {
// We only care about modified data events
if !matches!(
event.kind,
notify::EventKind::Modify(notify::event::ModifyKind::Data(_))
) {
continue
}
// We only trigger a re-initialization if a configuration file was
// modified. This means that a
// static_file_provider.commit() was called on the node after
// appending/truncating rows
for segment in event.paths {
// Ensure it's a file with the .conf extension
#[allow(clippy::nonminimal_bool)]
if !segment
.extension()
.is_some_and(|s| s.to_str() == Some(CONFIG_FILE_EXTENSION))
{
continue
}
// Ensure it's well formatted static file name
if StaticFileSegment::parse_filename(
&segment.file_stem().expect("qed").to_string_lossy(),
)
.is_none()
{
continue
}
// If we can read the metadata and modified timestamp, ensure this is
// not an old or repeated event.
if let Ok(current_modified_timestamp) =
std::fs::metadata(&segment).and_then(|m| m.modified())
{
if last_event_timestamp.is_some_and(|last_timestamp| {
last_timestamp >= current_modified_timestamp
}) {
continue
}
last_event_timestamp = Some(current_modified_timestamp);
}
info!(target: "providers::static_file", updated_file = ?segment.file_stem(), "re-initializing static file provider index");
if let Err(err) = provider.initialize_index() {
warn!(target: "providers::static_file", "failed to re-initialize index: {err}");
}
break
}
}
Err(err) => warn!(target: "providers::watcher", "watch error: {err:?}"),
}
}
});
}
}
impl<N: NodePrimitives> Deref for StaticFileProvider<N> {
type Target = StaticFileProviderInner<N>;
fn deref(&self) -> &Self::Target {
&self.0
}
}
/// [`StaticFileProviderInner`] manages all existing [`StaticFileJarProvider`].
#[derive(Debug)]
pub struct StaticFileProviderInner<N> {
/// Maintains a map which allows for concurrent access to different `NippyJars`, over different
/// segments and ranges.
map: DashMap<(BlockNumber, StaticFileSegment), LoadedJar>,
/// Max static file block for each segment
static_files_max_block: RwLock<HashMap<StaticFileSegment, u64>>,
/// Available static file block ranges on disk indexed by max transactions.
static_files_tx_index: RwLock<SegmentRanges>,
/// Directory where `static_files` are located
path: PathBuf,
/// Maintains a writer set of [`StaticFileSegment`].
writers: StaticFileWriters<N>,
/// Metrics for the static files.
metrics: Option<Arc<StaticFileProviderMetrics>>,
/// Access rights of the provider.
access: StaticFileAccess,
/// Number of blocks per file.
blocks_per_file: u64,
/// Write lock for when access is [`StaticFileAccess::RW`].
_lock_file: Option<StorageLock>,
/// Node primitives
_pd: PhantomData<N>,
}
impl<N: NodePrimitives> StaticFileProviderInner<N> {
/// Creates a new [`StaticFileProviderInner`].
fn new(path: impl AsRef<Path>, access: StaticFileAccess) -> ProviderResult<Self> {
let _lock_file = if access.is_read_write() {
StorageLock::try_acquire(path.as_ref())?.into()
} else {
None
};
let provider = Self {
map: Default::default(),
writers: Default::default(),
static_files_max_block: Default::default(),
static_files_tx_index: Default::default(),
path: path.as_ref().to_path_buf(),
metrics: None,
access,
blocks_per_file: DEFAULT_BLOCKS_PER_STATIC_FILE,
_lock_file,
_pd: Default::default(),
};
Ok(provider)
}
pub const fn is_read_only(&self) -> bool {
self.access.is_read_only()
}
/// Each static file has a fixed number of blocks. This gives out the range where the requested
/// block is positioned.
pub const fn find_fixed_range(&self, block: BlockNumber) -> SegmentRangeInclusive {
find_fixed_range(block, self.blocks_per_file)
}
}
impl<N: NodePrimitives> StaticFileProvider<N> {
/// Set a custom number of blocks per file.
#[cfg(any(test, feature = "test-utils"))]
pub fn with_custom_blocks_per_file(self, blocks_per_file: u64) -> Self {
let mut provider =
Arc::try_unwrap(self.0).expect("should be called when initializing only");
provider.blocks_per_file = blocks_per_file;
Self(Arc::new(provider))
}
/// Enables metrics on the [`StaticFileProvider`].
pub fn with_metrics(self) -> Self {
let mut provider =
Arc::try_unwrap(self.0).expect("should be called when initializing only");
provider.metrics = Some(Arc::new(StaticFileProviderMetrics::default()));
Self(Arc::new(provider))
}
/// Reports metrics for the static files.
pub fn report_metrics(&self) -> ProviderResult<()> {
let Some(metrics) = &self.metrics else { return Ok(()) };
let static_files =
iter_static_files(&self.path).map_err(|e| ProviderError::NippyJar(e.to_string()))?;
for (segment, ranges) in static_files {
let mut entries = 0;
let mut size = 0;
for (block_range, _) in &ranges {
let fixed_block_range = self.find_fixed_range(block_range.start());
let jar_provider = self
.get_segment_provider(segment, || Some(fixed_block_range), None)?
.ok_or_else(|| {
ProviderError::MissingStaticFileBlock(segment, block_range.start())
})?;
entries += jar_provider.rows();
let data_size = reth_fs_util::metadata(jar_provider.data_path())
.map(|metadata| metadata.len())
.unwrap_or_default();
let index_size = reth_fs_util::metadata(jar_provider.index_path())
.map(|metadata| metadata.len())
.unwrap_or_default();
let offsets_size = reth_fs_util::metadata(jar_provider.offsets_path())
.map(|metadata| metadata.len())
.unwrap_or_default();
let config_size = reth_fs_util::metadata(jar_provider.config_path())
.map(|metadata| metadata.len())
.unwrap_or_default();
size += data_size + index_size + offsets_size + config_size;
}
metrics.record_segment(segment, size, ranges.len(), entries);
}
Ok(())
}
/// Gets the [`StaticFileJarProvider`] of the requested segment and block.
pub fn get_segment_provider_from_block(
&self,
segment: StaticFileSegment,
block: BlockNumber,
path: Option<&Path>,
) -> ProviderResult<StaticFileJarProvider<'_, N>> {
self.get_segment_provider(
segment,
|| self.get_segment_ranges_from_block(segment, block),
path,
)?
.ok_or(ProviderError::MissingStaticFileBlock(segment, block))
}
/// Gets the [`StaticFileJarProvider`] of the requested segment and transaction.
pub fn get_segment_provider_from_transaction(
&self,
segment: StaticFileSegment,
tx: TxNumber,
path: Option<&Path>,
) -> ProviderResult<StaticFileJarProvider<'_, N>> {
self.get_segment_provider(
segment,
|| self.get_segment_ranges_from_transaction(segment, tx),
path,
)?
.ok_or(ProviderError::MissingStaticFileTx(segment, tx))
}
/// Gets the [`StaticFileJarProvider`] of the requested segment and block or transaction.
///
/// `fn_range` should make sure the range goes through `find_fixed_range`.
pub fn get_segment_provider(
&self,
segment: StaticFileSegment,
fn_range: impl Fn() -> Option<SegmentRangeInclusive>,
path: Option<&Path>,
) -> ProviderResult<Option<StaticFileJarProvider<'_, N>>> {
// If we have a path, then get the block range from its name.
// Otherwise, check `self.available_static_files`
let block_range = match path {
Some(path) => StaticFileSegment::parse_filename(
&path
.file_name()
.ok_or_else(|| {
ProviderError::MissingStaticFilePath(segment, path.to_path_buf())
})?
.to_string_lossy(),
)
.and_then(|(parsed_segment, block_range)| {
if parsed_segment == segment {
return Some(block_range)
}
None
}),
None => fn_range(),
};
// Return cached `LoadedJar` or insert it for the first time, and then, return it.
if let Some(block_range) = block_range {
return Ok(Some(self.get_or_create_jar_provider(segment, &block_range)?))
}
Ok(None)
}
/// Given a segment and block range it removes the cached provider from the map.
///
/// CAUTION: cached provider should be dropped before calling this or IT WILL deadlock.
pub fn remove_cached_provider(
&self,
segment: StaticFileSegment,
fixed_block_range_end: BlockNumber,
) {
self.map.remove(&(fixed_block_range_end, segment));
}
/// Given a segment and block, it deletes the jar and all files from the respective block range.
///
/// CAUTION: destructive. Deletes files on disk.
pub fn delete_jar(&self, segment: StaticFileSegment, block: BlockNumber) -> ProviderResult<()> {
let fixed_block_range = self.find_fixed_range(block);
let key = (fixed_block_range.end(), segment);
let jar = if let Some((_, jar)) = self.map.remove(&key) {
jar.jar
} else {
NippyJar::<SegmentHeader>::load(&self.path.join(segment.filename(&fixed_block_range)))
.map_err(|e| ProviderError::NippyJar(e.to_string()))?
};
jar.delete().map_err(|e| ProviderError::NippyJar(e.to_string()))?;
let mut segment_max_block = None;
if fixed_block_range.start() > 0 {
segment_max_block = Some(fixed_block_range.start() - 1)
};
self.update_index(segment, segment_max_block)?;
Ok(())
}
/// Given a segment and block range it returns a cached
/// [`StaticFileJarProvider`]. TODO(joshie): we should check the size and pop N if there's too
/// many.
fn get_or_create_jar_provider(
&self,
segment: StaticFileSegment,
fixed_block_range: &SegmentRangeInclusive,
) -> ProviderResult<StaticFileJarProvider<'_, N>> {
let key = (fixed_block_range.end(), segment);
// Avoid using `entry` directly to avoid a write lock in the common case.
trace!(target: "provider::static_file", ?segment, ?fixed_block_range, "Getting provider");
let mut provider: StaticFileJarProvider<'_, N> = if let Some(jar) = self.map.get(&key) {
trace!(target: "provider::static_file", ?segment, ?fixed_block_range, "Jar found in cache");
jar.into()
} else {
trace!(target: "provider::static_file", ?segment, ?fixed_block_range, "Creating jar from scratch");
let path = self.path.join(segment.filename(fixed_block_range));
let jar = NippyJar::load(&path).map_err(|e| ProviderError::NippyJar(e.to_string()))?;
self.map.entry(key).insert(LoadedJar::new(jar)?).downgrade().into()
};
if let Some(metrics) = &self.metrics {
provider = provider.with_metrics(metrics.clone());
}
Ok(provider)
}
/// Gets a static file segment's block range from the provider inner block
/// index.
fn get_segment_ranges_from_block(
&self,
segment: StaticFileSegment,
block: u64,
) -> Option<SegmentRangeInclusive> {
self.static_files_max_block
.read()
.get(&segment)
.filter(|max| **max >= block)
.map(|_| self.find_fixed_range(block))
}
/// Gets a static file segment's fixed block range from the provider inner
/// transaction index.
fn get_segment_ranges_from_transaction(
&self,
segment: StaticFileSegment,
tx: u64,
) -> Option<SegmentRangeInclusive> {
let static_files = self.static_files_tx_index.read();
let segment_static_files = static_files.get(&segment)?;
// It's more probable that the request comes from a newer tx height, so we iterate
// the static_files in reverse.
let mut static_files_rev_iter = segment_static_files.iter().rev().peekable();
while let Some((tx_end, block_range)) = static_files_rev_iter.next() {
if tx > *tx_end {
// request tx is higher than highest static file tx
return None
}
let tx_start = static_files_rev_iter.peek().map(|(tx_end, _)| *tx_end + 1).unwrap_or(0);
if tx_start <= tx {
return Some(self.find_fixed_range(block_range.end()))
}
}
None
}
/// Updates the inner transaction and block indexes alongside the internal cached providers in
/// `self.map`.
///
/// Any entry higher than `segment_max_block` will be deleted from the previous structures.
///
/// If `segment_max_block` is None it means there's no static file for this segment.
pub fn update_index(
&self,
segment: StaticFileSegment,
segment_max_block: Option<BlockNumber>,
) -> ProviderResult<()> {
let mut max_block = self.static_files_max_block.write();
let mut tx_index = self.static_files_tx_index.write();
match segment_max_block {
Some(segment_max_block) => {
// Update the max block for the segment
max_block.insert(segment, segment_max_block);
let fixed_range = self.find_fixed_range(segment_max_block);
let jar = NippyJar::<SegmentHeader>::load(
&self.path.join(segment.filename(&fixed_range)),
)
.map_err(|e| ProviderError::NippyJar(e.to_string()))?;
// Updates the tx index by first removing all entries which have a higher
// block_start than our current static file.
if let Some(tx_range) = jar.user_header().tx_range() {
let tx_end = tx_range.end();
// Current block range has the same block start as `fixed_range``, but block end
// might be different if we are still filling this static file.
if let Some(current_block_range) = jar.user_header().block_range().copied() {
// Considering that `update_index` is called when we either append/truncate,
// we are sure that we are handling the latest data
// points.
//
// Here we remove every entry of the index that has a block start higher or
// equal than our current one. This is important in the case
// that we prune a lot of rows resulting in a file (and thus
// a higher block range) deletion.
tx_index
.entry(segment)
.and_modify(|index| {
index.retain(|_, block_range| {
block_range.start() < fixed_range.start()
});
index.insert(tx_end, current_block_range);
})
.or_insert_with(|| BTreeMap::from([(tx_end, current_block_range)]));
}
} else if segment.is_tx_based() {
// The unwinded file has no more transactions/receipts. However, the highest
// block is within this files' block range. We only retain
// entries with block ranges before the current one.
tx_index.entry(segment).and_modify(|index| {
index.retain(|_, block_range| block_range.start() < fixed_range.start());
});
// If the index is empty, just remove it.
if tx_index.get(&segment).is_some_and(|index| index.is_empty()) {
tx_index.remove(&segment);
}
}
// Update the cached provider.
self.map.insert((fixed_range.end(), segment), LoadedJar::new(jar)?);
// Delete any cached provider that no longer has an associated jar.
self.map.retain(|(end, seg), _| !(*seg == segment && *end > fixed_range.end()));
}
None => {
tx_index.remove(&segment);
max_block.remove(&segment);
}
};
Ok(())
}
/// Initializes the inner transaction and block index
pub fn initialize_index(&self) -> ProviderResult<()> {
let mut max_block = self.static_files_max_block.write();
let mut tx_index = self.static_files_tx_index.write();
max_block.clear();
tx_index.clear();
for (segment, ranges) in
iter_static_files(&self.path).map_err(|e| ProviderError::NippyJar(e.to_string()))?
{
// Update last block for each segment
if let Some((block_range, _)) = ranges.last() {
max_block.insert(segment, block_range.end());
}
// Update tx -> block_range index
for (block_range, tx_range) in ranges {
if let Some(tx_range) = tx_range {
let tx_end = tx_range.end();
match tx_index.entry(segment) {
Entry::Occupied(mut index) => {
index.get_mut().insert(tx_end, block_range);
}
Entry::Vacant(index) => {
index.insert(BTreeMap::from([(tx_end, block_range)]));
}
};
}
}
}
// If this is a re-initialization, we need to clear this as well
self.map.clear();
Ok(())
}
/// Ensures that any broken invariants which cannot be healed on the spot return a pipeline
/// target to unwind to.
///
/// Two types of consistency checks are done for:
///
/// 1) When a static file fails to commit but the underlying data was changed.
/// 2) When a static file was committed, but the required database transaction was not.
///
/// For 1) it can self-heal if `self.access.is_read_only()` is set to `false`. Otherwise, it
/// will return an error.
/// For 2) the invariants below are checked, and if broken, might require a pipeline unwind
/// to heal.
///
/// For each static file segment:
/// * the corresponding database table should overlap or have continuity in their keys
/// ([`TxNumber`] or [`BlockNumber`]).
/// * its highest block should match the stage checkpoint block number if it's equal or higher
/// than the corresponding database table last entry.
///
/// Returns a [`Option`] of [`PipelineTarget::Unwind`] if any healing is further required.
///
/// WARNING: No static file writer should be held before calling this function, otherwise it
/// will deadlock.
#[allow(clippy::while_let_loop)]
pub fn check_consistency<Provider>(
&self,
provider: &Provider,
has_receipt_pruning: bool,
) -> ProviderResult<Option<PipelineTarget>>
where
Provider: DBProvider + BlockReader + StageCheckpointReader + ChainSpecProvider,
{
// OVM historical import is broken and does not work with this check. It's importing
// duplicated receipts resulting in having more receipts than the expected transaction
// range.
//
// If we detect an OVM import was done (block #1 <https://optimistic.etherscan.io/block/1>), skip it.
// More on [#11099](https://github.com/paradigmxyz/reth/pull/11099).
#[cfg(feature = "optimism")]
if reth_chainspec::EthChainSpec::chain(&provider.chain_spec()) ==
reth_chainspec::Chain::optimism_mainnet() &&
provider
.block_number(reth_optimism_primitives::bedrock::OVM_HEADER_1_HASH)?
.is_some()
{
info!(target: "reth::cli",
"Skipping storage verification for OP mainnet, expected inconsistency in OVM chain"
);
return Ok(None)
}
info!(target: "reth::cli", "Verifying storage consistency.");
let mut unwind_target: Option<BlockNumber> = None;
let mut update_unwind_target = |new_target: BlockNumber| {
if let Some(target) = unwind_target.as_mut() {
*target = (*target).min(new_target);
} else {
unwind_target = Some(new_target);
}
};
for segment in StaticFileSegment::iter() {
if has_receipt_pruning && segment.is_receipts() {
// Pruned nodes (including full node) do not store receipts as static files.
continue
}
let initial_highest_block = self.get_highest_static_file_block(segment);
// File consistency is broken if:
//
// * appending data was interrupted before a config commit, then data file will be
// truncated according to the config.
//
// * pruning data was interrupted before a config commit, then we have deleted data that
// we are expected to still have. We need to check the Database and unwind everything
// accordingly.
if self.access.is_read_only() {
self.check_segment_consistency(segment)?;
} else {
// Fetching the writer will attempt to heal any file level inconsistency.
self.latest_writer(segment)?;
}
// Only applies to block-based static files. (Headers)
//
// The updated `highest_block` may have decreased if we healed from a pruning
// interruption.
let mut highest_block = self.get_highest_static_file_block(segment);
if initial_highest_block != highest_block {
info!(
target: "reth::providers::static_file",
?initial_highest_block,
unwind_target = highest_block,
?segment,
"Setting unwind target."
);
update_unwind_target(highest_block.unwrap_or_default());
}
// Only applies to transaction-based static files. (Receipts & Transactions)
//
// Make sure the last transaction matches the last block from its indices, since a heal
// from a pruning interruption might have decreased the number of transactions without
// being able to update the last block of the static file segment.
let highest_tx = self.get_highest_static_file_tx(segment);
if let Some(highest_tx) = highest_tx {
let mut last_block = highest_block.unwrap_or_default();
loop {
if let Some(indices) = provider.block_body_indices(last_block)? {
if indices.last_tx_num() <= highest_tx {
break
}
} else {
// If the block body indices can not be found, then it means that static
// files is ahead of database, and the `ensure_invariants` check will fix
// it by comparing with stage checkpoints.
break
}
if last_block == 0 {
break
}
last_block -= 1;
info!(
target: "reth::providers::static_file",
highest_block = self.get_highest_static_file_block(segment),
unwind_target = last_block,
?segment,
"Setting unwind target."
);
highest_block = Some(last_block);
update_unwind_target(last_block);
}
}
if let Some(unwind) = match segment {
StaticFileSegment::Headers => self.ensure_invariants::<_, tables::Headers>(
provider,
segment,
highest_block,
highest_block,
)?,
StaticFileSegment::Transactions => self
.ensure_invariants::<_, tables::Transactions>(
provider,
segment,
highest_tx,
highest_block,
)?,
StaticFileSegment::Receipts => self.ensure_invariants::<_, tables::Receipts>(
provider,
segment,
highest_tx,
highest_block,
)?,
} {
update_unwind_target(unwind);
}
}
Ok(unwind_target.map(PipelineTarget::Unwind))
}
/// Checks consistency of the latest static file segment and throws an error if at fault.
/// Read-only.
pub fn check_segment_consistency(&self, segment: StaticFileSegment) -> ProviderResult<()> {
if let Some(latest_block) = self.get_highest_static_file_block(segment) {
let file_path =
self.directory().join(segment.filename(&self.find_fixed_range(latest_block)));
let jar = NippyJar::<SegmentHeader>::load(&file_path)
.map_err(|e| ProviderError::NippyJar(e.to_string()))?;
NippyJarChecker::new(jar)
.check_consistency()
.map_err(|e| ProviderError::NippyJar(e.to_string()))?;
}
Ok(())
}
/// Check invariants for each corresponding table and static file segment:
///
/// * the corresponding database table should overlap or have continuity in their keys
/// ([`TxNumber`] or [`BlockNumber`]).
/// * its highest block should match the stage checkpoint block number if it's equal or higher
/// than the corresponding database table last entry.
/// * If the checkpoint block is higher, then request a pipeline unwind to the static file
/// block. This is expressed by returning [`Some`] with the requested pipeline unwind
/// target.
/// * If the checkpoint block is lower, then heal by removing rows from the static file. In
/// this case, the rows will be removed and [`None`] will be returned.
///
/// * If the database tables overlap with static files and have contiguous keys, or the
/// checkpoint block matches the highest static files block, then [`None`] will be returned.
fn ensure_invariants<Provider, T: Table<Key = u64>>(
&self,
provider: &Provider,
segment: StaticFileSegment,
highest_static_file_entry: Option<u64>,
highest_static_file_block: Option<BlockNumber>,
) -> ProviderResult<Option<BlockNumber>>
where
Provider: DBProvider + BlockReader + StageCheckpointReader,
{
let highest_static_file_entry = highest_static_file_entry.unwrap_or_default();
let highest_static_file_block = highest_static_file_block.unwrap_or_default();
let mut db_cursor = provider.tx_ref().cursor_read::<T>()?;
if let Some((db_first_entry, _)) = db_cursor.first()? {
// If there is a gap between the entry found in static file and
// database, then we have most likely lost static file data and need to unwind so we can
// load it again
if !(db_first_entry <= highest_static_file_entry ||
highest_static_file_entry + 1 == db_first_entry)
{
info!(
target: "reth::providers::static_file",
?db_first_entry,
?highest_static_file_entry,
unwind_target = highest_static_file_block,
?segment,
"Setting unwind target."
);
return Ok(Some(highest_static_file_block))
}
if let Some((db_last_entry, _)) = db_cursor.last()? {
if db_last_entry > highest_static_file_entry {
return Ok(None)
}
}
}
// If static file entry is ahead of the database entries, then ensure the checkpoint block
// number matches.
let checkpoint_block_number = provider
.get_stage_checkpoint(match segment {
StaticFileSegment::Headers => StageId::Headers,
StaticFileSegment::Transactions => StageId::Bodies,
StaticFileSegment::Receipts => StageId::Execution,
})?
.unwrap_or_default()
.block_number;
// If the checkpoint is ahead, then we lost static file data. May be data corruption.
if checkpoint_block_number > highest_static_file_block {
info!(
target: "reth::providers::static_file",
checkpoint_block_number,
unwind_target = highest_static_file_block,
?segment,
"Setting unwind target."
);
return Ok(Some(highest_static_file_block))
}
// If the checkpoint is behind, then we failed to do a database commit **but committed** to
// static files on executing a stage, or the reverse on unwinding a stage.
// All we need to do is to prune the extra static file rows.
if checkpoint_block_number < highest_static_file_block {
info!(
target: "reth::providers",
?segment,
from = highest_static_file_block,
to = checkpoint_block_number,
"Unwinding static file segment."
);
let mut writer = self.latest_writer(segment)?;
if segment.is_headers() {
writer.prune_headers(highest_static_file_block - checkpoint_block_number)?;
} else if let Some(block) = provider.block_body_indices(checkpoint_block_number)? {
let number = highest_static_file_entry - block.last_tx_num();
if segment.is_receipts() {
writer.prune_receipts(number, checkpoint_block_number)?;
} else {
writer.prune_transactions(number, checkpoint_block_number)?;
}
}
writer.commit()?;
}
Ok(None)
}
/// Gets the highest static file block if it exists for a static file segment.
///
/// If there is nothing on disk for the given segment, this will return [`None`].
pub fn get_highest_static_file_block(&self, segment: StaticFileSegment) -> Option<BlockNumber> {
self.static_files_max_block.read().get(&segment).copied()
}
/// Gets the highest static file transaction.
///
/// If there is nothing on disk for the given segment, this will return [`None`].
pub fn get_highest_static_file_tx(&self, segment: StaticFileSegment) -> Option<TxNumber> {
self.static_files_tx_index
.read()
.get(&segment)
.and_then(|index| index.last_key_value().map(|(last_tx, _)| *last_tx))
}
/// Gets the highest static file block for all segments.
pub fn get_highest_static_files(&self) -> HighestStaticFiles {
HighestStaticFiles {
headers: self.get_highest_static_file_block(StaticFileSegment::Headers),
receipts: self.get_highest_static_file_block(StaticFileSegment::Receipts),
transactions: self.get_highest_static_file_block(StaticFileSegment::Transactions),
}
}
/// Iterates through segment `static_files` in reverse order, executing a function until it
/// returns some object. Useful for finding objects by [`TxHash`] or [`BlockHash`].
pub fn find_static_file<T>(
&self,
segment: StaticFileSegment,
func: impl Fn(StaticFileJarProvider<'_, N>) -> ProviderResult<Option<T>>,
) -> ProviderResult<Option<T>> {
if let Some(highest_block) = self.get_highest_static_file_block(segment) {
let mut range = self.find_fixed_range(highest_block);
while range.end() > 0 {
if let Some(res) = func(self.get_or_create_jar_provider(segment, &range)?)? {
return Ok(Some(res))
}
range = SegmentRangeInclusive::new(
range.start().saturating_sub(self.blocks_per_file),
range.end().saturating_sub(self.blocks_per_file),
);
}
}
Ok(None)
}
/// Fetches data within a specified range across multiple static files.
///
/// This function iteratively retrieves data using `get_fn` for each item in the given range.
/// It continues fetching until the end of the range is reached or the provided `predicate`
/// returns false.
pub fn fetch_range_with_predicate<T, F, P>(
&self,
segment: StaticFileSegment,
range: Range<u64>,
mut get_fn: F,
mut predicate: P,
) -> ProviderResult<Vec<T>>
where
F: FnMut(&mut StaticFileCursor<'_>, u64) -> ProviderResult<Option<T>>,
P: FnMut(&T) -> bool,
{
let get_provider = |start: u64| match segment {
StaticFileSegment::Headers => {
self.get_segment_provider_from_block(segment, start, None)
}
StaticFileSegment::Transactions | StaticFileSegment::Receipts => {
self.get_segment_provider_from_transaction(segment, start, None)
}
};
let mut result = Vec::with_capacity((range.end - range.start).min(100) as usize);
let mut provider = get_provider(range.start)?;
let mut cursor = provider.cursor()?;
// advances number in range
'outer: for number in range {
// The `retrying` flag ensures a single retry attempt per `number`. If `get_fn` fails to
// access data in two different static files, it halts further attempts by returning
// an error, effectively preventing infinite retry loops.
let mut retrying = false;
// advances static files if `get_fn` returns None
'inner: loop {
match get_fn(&mut cursor, number)? {
Some(res) => {
if !predicate(&res) {
break 'outer
}
result.push(res);
break 'inner
}
None => {
if retrying {
warn!(
target: "provider::static_file",
?segment,
?number,
"Could not find block or tx number on a range request"
);
let err = if segment.is_headers() {
ProviderError::MissingStaticFileBlock(segment, number)
} else {
ProviderError::MissingStaticFileTx(segment, number)
};
return Err(err)
}
// There is a very small chance of hitting a deadlock if two consecutive
// static files share the same bucket in the
// internal dashmap and we don't drop the current provider
// before requesting the next one.
drop(cursor);
drop(provider);
provider = get_provider(number)?;
cursor = provider.cursor()?;
retrying = true;
}
}
}
}
Ok(result)
}
/// Fetches data within a specified range across multiple static files.
///
/// Returns an iterator over the data
pub fn fetch_range_iter<'a, T, F>(
&'a self,
segment: StaticFileSegment,
range: Range<u64>,
get_fn: F,
) -> ProviderResult<impl Iterator<Item = ProviderResult<T>> + 'a>
where
F: Fn(&mut StaticFileCursor<'_>, u64) -> ProviderResult<Option<T>> + 'a,
T: std::fmt::Debug,
{
let get_provider = move |start: u64| match segment {
StaticFileSegment::Headers => {
self.get_segment_provider_from_block(segment, start, None)
}
StaticFileSegment::Transactions | StaticFileSegment::Receipts => {
self.get_segment_provider_from_transaction(segment, start, None)
}
};
let mut provider = Some(get_provider(range.start)?);
Ok(range.filter_map(move |number| {
match get_fn(&mut provider.as_ref().expect("qed").cursor().ok()?, number).transpose() {
Some(result) => Some(result),
None => {
// There is a very small chance of hitting a deadlock if two consecutive static
// files share the same bucket in the internal dashmap and
// we don't drop the current provider before requesting the
// next one.
provider.take();
provider = Some(get_provider(number).ok()?);
get_fn(&mut provider.as_ref().expect("qed").cursor().ok()?, number).transpose()
}
}
}))
}
/// Returns directory where `static_files` are located.
pub fn directory(&self) -> &Path {
&self.path
}
/// Retrieves data from the database or static file, wherever it's available.
///
/// # Arguments
/// * `segment` - The segment of the static file to check against.
/// * `index_key` - Requested index key, usually a block or transaction number.
/// * `fetch_from_static_file` - A closure that defines how to fetch the data from the static
/// file provider.
/// * `fetch_from_database` - A closure that defines how to fetch the data from the database
/// when the static file doesn't contain the required data or is not available.
pub fn get_with_static_file_or_database<T, FS, FD>(
&self,
segment: StaticFileSegment,
number: u64,
fetch_from_static_file: FS,
fetch_from_database: FD,
) -> ProviderResult<Option<T>>
where
FS: Fn(&Self) -> ProviderResult<Option<T>>,
FD: Fn() -> ProviderResult<Option<T>>,
{
// If there is, check the maximum block or transaction number of the segment.
let static_file_upper_bound = match segment {
StaticFileSegment::Headers => self.get_highest_static_file_block(segment),
StaticFileSegment::Transactions | StaticFileSegment::Receipts => {
self.get_highest_static_file_tx(segment)
}
};
if static_file_upper_bound
.is_some_and(|static_file_upper_bound| static_file_upper_bound >= number)
{
return fetch_from_static_file(self)
}
fetch_from_database()
}
/// Gets data within a specified range, potentially spanning different `static_files` and
/// database.
///
/// # Arguments
/// * `segment` - The segment of the static file to query.
/// * `block_range` - The range of data to fetch.
/// * `fetch_from_static_file` - A function to fetch data from the `static_file`.
/// * `fetch_from_database` - A function to fetch data from the database.
/// * `predicate` - A function used to evaluate each item in the fetched data. Fetching is
/// terminated when this function returns false, thereby filtering the data based on the
/// provided condition.
pub fn get_range_with_static_file_or_database<T, P, FS, FD>(
&self,
segment: StaticFileSegment,
mut block_or_tx_range: Range<u64>,
fetch_from_static_file: FS,
mut fetch_from_database: FD,
mut predicate: P,
) -> ProviderResult<Vec<T>>
where
FS: Fn(&Self, Range<u64>, &mut P) -> ProviderResult<Vec<T>>,
FD: FnMut(Range<u64>, P) -> ProviderResult<Vec<T>>,
P: FnMut(&T) -> bool,
{
let mut data = Vec::new();
// If there is, check the maximum block or transaction number of the segment.
if let Some(static_file_upper_bound) = match segment {
StaticFileSegment::Headers => self.get_highest_static_file_block(segment),
StaticFileSegment::Transactions | StaticFileSegment::Receipts => {
self.get_highest_static_file_tx(segment)
}
} {
if block_or_tx_range.start <= static_file_upper_bound {
let end = block_or_tx_range.end.min(static_file_upper_bound + 1);
data.extend(fetch_from_static_file(
self,
block_or_tx_range.start..end,
&mut predicate,
)?);
block_or_tx_range.start = end;
}
}
if block_or_tx_range.end > block_or_tx_range.start {
data.extend(fetch_from_database(block_or_tx_range, predicate)?)
}
Ok(data)
}
/// Returns `static_files` directory
#[cfg(any(test, feature = "test-utils"))]
pub fn path(&self) -> &Path {
&self.path
}
/// Returns `static_files` transaction index
#[cfg(any(test, feature = "test-utils"))]
pub fn tx_index(&self) -> &RwLock<SegmentRanges> {
&self.static_files_tx_index
}
}
/// Helper trait to manage different [`StaticFileProviderRW`] of an `Arc<StaticFileProvider`
pub trait StaticFileWriter {
/// The primitives type used by the static file provider.
type Primitives: Send + Sync + 'static;
/// Returns a mutable reference to a [`StaticFileProviderRW`] of a [`StaticFileSegment`].
fn get_writer(
&self,
block: BlockNumber,
segment: StaticFileSegment,
) -> ProviderResult<StaticFileProviderRWRefMut<'_, Self::Primitives>>;
/// Returns a mutable reference to a [`StaticFileProviderRW`] of the latest
/// [`StaticFileSegment`].
fn latest_writer(
&self,
segment: StaticFileSegment,
) -> ProviderResult<StaticFileProviderRWRefMut<'_, Self::Primitives>>;
/// Commits all changes of all [`StaticFileProviderRW`] of all [`StaticFileSegment`].
fn commit(&self) -> ProviderResult<()>;
}
impl<N: NodePrimitives> StaticFileWriter for StaticFileProvider<N> {
type Primitives = N;
fn get_writer(
&self,
block: BlockNumber,
segment: StaticFileSegment,
) -> ProviderResult<StaticFileProviderRWRefMut<'_, Self::Primitives>> {
if self.access.is_read_only() {
return Err(ProviderError::ReadOnlyStaticFileAccess)
}
trace!(target: "provider::static_file", ?block, ?segment, "Getting static file writer.");
self.writers.get_or_create(segment, || {
StaticFileProviderRW::new(segment, block, Arc::downgrade(&self.0), self.metrics.clone())
})
}
fn latest_writer(
&self,
segment: StaticFileSegment,
) -> ProviderResult<StaticFileProviderRWRefMut<'_, Self::Primitives>> {
self.get_writer(self.get_highest_static_file_block(segment).unwrap_or_default(), segment)
}
fn commit(&self) -> ProviderResult<()> {
self.writers.commit()
}
}
impl<N: NodePrimitives> HeaderProvider for StaticFileProvider<N> {
fn header(&self, block_hash: &BlockHash) -> ProviderResult<Option<Header>> {
self.find_static_file(StaticFileSegment::Headers, |jar_provider| {
Ok(jar_provider
.cursor()?
.get_two::<HeaderMask<Header, BlockHash>>(block_hash.into())?
.and_then(|(header, hash)| {
if &hash == block_hash {
return Some(header)
}
None
}))
})
}
fn header_by_number(&self, num: BlockNumber) -> ProviderResult<Option<Header>> {
self.get_segment_provider_from_block(StaticFileSegment::Headers, num, None)
.and_then(|provider| provider.header_by_number(num))
.or_else(|err| {
if let ProviderError::MissingStaticFileBlock(_, _) = err {
Ok(None)
} else {
Err(err)
}
})
}
fn header_td(&self, block_hash: &BlockHash) -> ProviderResult<Option<U256>> {
self.find_static_file(StaticFileSegment::Headers, |jar_provider| {
Ok(jar_provider
.cursor()?
.get_two::<HeaderMask<CompactU256, BlockHash>>(block_hash.into())?
.and_then(|(td, hash)| (&hash == block_hash).then_some(td.0)))
})
}
fn header_td_by_number(&self, num: BlockNumber) -> ProviderResult<Option<U256>> {
self.get_segment_provider_from_block(StaticFileSegment::Headers, num, None)
.and_then(|provider| provider.header_td_by_number(num))
.or_else(|err| {
if let ProviderError::MissingStaticFileBlock(_, _) = err {
Ok(None)
} else {
Err(err)
}
})
}
fn headers_range(&self, range: impl RangeBounds<BlockNumber>) -> ProviderResult<Vec<Header>> {
self.fetch_range_with_predicate(
StaticFileSegment::Headers,
to_range(range),
|cursor, number| cursor.get_one::<HeaderMask<Header>>(number.into()),
|_| true,
)
}
fn sealed_header(&self, num: BlockNumber) -> ProviderResult<Option<SealedHeader>> {
self.get_segment_provider_from_block(StaticFileSegment::Headers, num, None)
.and_then(|provider| provider.sealed_header(num))
.or_else(|err| {
if let ProviderError::MissingStaticFileBlock(_, _) = err {
Ok(None)
} else {
Err(err)
}
})
}
fn sealed_headers_while(
&self,
range: impl RangeBounds<BlockNumber>,
predicate: impl FnMut(&SealedHeader) -> bool,
) -> ProviderResult<Vec<SealedHeader>> {
self.fetch_range_with_predicate(
StaticFileSegment::Headers,
to_range(range),
|cursor, number| {
Ok(cursor
.get_two::<HeaderMask<Header, BlockHash>>(number.into())?
.map(|(header, hash)| SealedHeader::new(header, hash)))
},
predicate,
)
}
}
impl<N: NodePrimitives> BlockHashReader for StaticFileProvider<N> {
fn block_hash(&self, num: u64) -> ProviderResult<Option<B256>> {
self.get_segment_provider_from_block(StaticFileSegment::Headers, num, None)?.block_hash(num)
}
fn canonical_hashes_range(
&self,
start: BlockNumber,
end: BlockNumber,
) -> ProviderResult<Vec<B256>> {
self.fetch_range_with_predicate(
StaticFileSegment::Headers,
start..end,
|cursor, number| cursor.get_one::<HeaderMask<BlockHash>>(number.into()),
|_| true,
)
}
}
impl<N: NodePrimitives> ReceiptProvider for StaticFileProvider<N> {
fn receipt(&self, num: TxNumber) -> ProviderResult<Option<Receipt>> {
self.get_segment_provider_from_transaction(StaticFileSegment::Receipts, num, None)
.and_then(|provider| provider.receipt(num))
.or_else(|err| {
if let ProviderError::MissingStaticFileTx(_, _) = err {
Ok(None)
} else {
Err(err)
}
})
}
fn receipt_by_hash(&self, hash: TxHash) -> ProviderResult<Option<Receipt>> {
if let Some(num) = self.transaction_id(hash)? {
return self.receipt(num)
}
Ok(None)
}
fn receipts_by_block(&self, _block: BlockHashOrNumber) -> ProviderResult<Option<Vec<Receipt>>> {
unreachable!()
}
fn receipts_by_tx_range(
&self,
range: impl RangeBounds<TxNumber>,
) -> ProviderResult<Vec<Receipt>> {
self.fetch_range_with_predicate(
StaticFileSegment::Receipts,
to_range(range),
|cursor, number| cursor.get_one::<ReceiptMask<Receipt>>(number.into()),
|_| true,
)
}
}
impl<N: NodePrimitives> TransactionsProviderExt for StaticFileProvider<N> {
fn transaction_hashes_by_range(
&self,
tx_range: Range<TxNumber>,
) -> ProviderResult<Vec<(TxHash, TxNumber)>> {
let tx_range_size = (tx_range.end - tx_range.start) as usize;
// Transactions are different size, so chunks will not all take the same processing time. If
// chunks are too big, there will be idle threads waiting for work. Choosing an
// arbitrary smaller value to make sure it doesn't happen.
let chunk_size = 100;
// iterator over the chunks
let chunks = tx_range
.clone()
.step_by(chunk_size)
.map(|start| start..std::cmp::min(start + chunk_size as u64, tx_range.end));
let mut channels = Vec::with_capacity(tx_range_size.div_ceil(chunk_size));
for chunk_range in chunks {
let (channel_tx, channel_rx) = mpsc::channel();
channels.push(channel_rx);
let manager = self.clone();
// Spawn the task onto the global rayon pool
// This task will send the results through the channel after it has calculated
// the hash.
rayon::spawn(move || {
let mut rlp_buf = Vec::with_capacity(128);
let _ = manager.fetch_range_with_predicate(
StaticFileSegment::Transactions,
chunk_range,
|cursor, number| {
Ok(cursor
.get_one::<TransactionMask<TransactionSignedNoHash>>(number.into())?
.map(|transaction| {
rlp_buf.clear();
let _ = channel_tx
.send(calculate_hash((number, transaction), &mut rlp_buf));
}))
},
|_| true,
);
});
}
let mut tx_list = Vec::with_capacity(tx_range_size);
// Iterate over channels and append the tx hashes unsorted
for channel in channels {
while let Ok(tx) = channel.recv() {
let (tx_hash, tx_id) = tx.map_err(|boxed| *boxed)?;
tx_list.push((tx_hash, tx_id));
}
}
Ok(tx_list)
}
}
impl<N: NodePrimitives> TransactionsProvider for StaticFileProvider<N> {
fn transaction_id(&self, tx_hash: TxHash) -> ProviderResult<Option<TxNumber>> {
self.find_static_file(StaticFileSegment::Transactions, |jar_provider| {
let mut cursor = jar_provider.cursor()?;
if cursor
.get_one::<TransactionMask<TransactionSignedNoHash>>((&tx_hash).into())?
.and_then(|tx| (tx.hash() == tx_hash).then_some(tx))
.is_some()
{
Ok(cursor.number())
} else {
Ok(None)
}
})
}
fn transaction_by_id(&self, num: TxNumber) -> ProviderResult<Option<TransactionSigned>> {
self.get_segment_provider_from_transaction(StaticFileSegment::Transactions, num, None)
.and_then(|provider| provider.transaction_by_id(num))
.or_else(|err| {
if let ProviderError::MissingStaticFileTx(_, _) = err {
Ok(None)
} else {
Err(err)
}
})
}
fn transaction_by_id_no_hash(
&self,
num: TxNumber,
) -> ProviderResult<Option<TransactionSignedNoHash>> {
self.get_segment_provider_from_transaction(StaticFileSegment::Transactions, num, None)
.and_then(|provider| provider.transaction_by_id_no_hash(num))
.or_else(|err| {
if let ProviderError::MissingStaticFileTx(_, _) = err {
Ok(None)
} else {
Err(err)
}
})
}
fn transaction_by_hash(&self, hash: TxHash) -> ProviderResult<Option<TransactionSigned>> {
self.find_static_file(StaticFileSegment::Transactions, |jar_provider| {
Ok(jar_provider
.cursor()?
.get_one::<TransactionMask<TransactionSignedNoHash>>((&hash).into())?
.map(|tx| tx.with_hash())
.and_then(|tx| (tx.hash_ref() == &hash).then_some(tx)))
})
}
fn transaction_by_hash_with_meta(
&self,
_hash: TxHash,
) -> ProviderResult<Option<(TransactionSigned, TransactionMeta)>> {
// Required data not present in static_files
Err(ProviderError::UnsupportedProvider)
}
fn transaction_block(&self, _id: TxNumber) -> ProviderResult<Option<BlockNumber>> {
// Required data not present in static_files
Err(ProviderError::UnsupportedProvider)
}
fn transactions_by_block(
&self,
_block_id: BlockHashOrNumber,
) -> ProviderResult<Option<Vec<TransactionSigned>>> {
// Required data not present in static_files
Err(ProviderError::UnsupportedProvider)
}
fn transactions_by_block_range(
&self,
_range: impl RangeBounds<BlockNumber>,
) -> ProviderResult<Vec<Vec<TransactionSigned>>> {
// Required data not present in static_files
Err(ProviderError::UnsupportedProvider)
}
fn transactions_by_tx_range(
&self,
range: impl RangeBounds<TxNumber>,
) -> ProviderResult<Vec<TransactionSignedNoHash>> {
self.fetch_range_with_predicate(
StaticFileSegment::Transactions,
to_range(range),
|cursor, number| {
cursor.get_one::<TransactionMask<TransactionSignedNoHash>>(number.into())
},
|_| true,
)
}
fn senders_by_tx_range(
&self,
range: impl RangeBounds<TxNumber>,
) -> ProviderResult<Vec<Address>> {
let txes = self.transactions_by_tx_range(range)?;
TransactionSignedNoHash::recover_signers(&txes, txes.len())
.ok_or(ProviderError::SenderRecoveryError)
}
fn transaction_sender(&self, id: TxNumber) -> ProviderResult<Option<Address>> {
Ok(self.transaction_by_id_no_hash(id)?.and_then(|tx| tx.recover_signer()))
}
}
/* Cannot be successfully implemented but must exist for trait requirements */
impl<N: NodePrimitives> BlockNumReader for StaticFileProvider<N> {
fn chain_info(&self) -> ProviderResult<ChainInfo> {
// Required data not present in static_files
Err(ProviderError::UnsupportedProvider)
}
fn best_block_number(&self) -> ProviderResult<BlockNumber> {
// Required data not present in static_files
Err(ProviderError::UnsupportedProvider)
}
fn last_block_number(&self) -> ProviderResult<BlockNumber> {
// Required data not present in static_files
Err(ProviderError::UnsupportedProvider)
}
fn block_number(&self, _hash: B256) -> ProviderResult<Option<BlockNumber>> {
// Required data not present in static_files
Err(ProviderError::UnsupportedProvider)
}
}
impl<N: NodePrimitives> BlockReader for StaticFileProvider<N> {
fn find_block_by_hash(
&self,
_hash: B256,
_source: BlockSource,
) -> ProviderResult<Option<Block>> {
// Required data not present in static_files
Err(ProviderError::UnsupportedProvider)
}
fn block(&self, _id: BlockHashOrNumber) -> ProviderResult<Option<Block>> {
// Required data not present in static_files
Err(ProviderError::UnsupportedProvider)
}
fn pending_block(&self) -> ProviderResult<Option<SealedBlock>> {
// Required data not present in static_files
Err(ProviderError::UnsupportedProvider)
}
fn pending_block_with_senders(&self) -> ProviderResult<Option<SealedBlockWithSenders>> {
// Required data not present in static_files
Err(ProviderError::UnsupportedProvider)
}
fn pending_block_and_receipts(&self) -> ProviderResult<Option<(SealedBlock, Vec<Receipt>)>> {
// Required data not present in static_files
Err(ProviderError::UnsupportedProvider)
}
fn ommers(&self, _id: BlockHashOrNumber) -> ProviderResult<Option<Vec<Header>>> {
// Required data not present in static_files
Err(ProviderError::UnsupportedProvider)
}
fn block_body_indices(&self, _num: u64) -> ProviderResult<Option<StoredBlockBodyIndices>> {
// Required data not present in static_files
Err(ProviderError::UnsupportedProvider)
}
fn block_with_senders(
&self,
_id: BlockHashOrNumber,
_transaction_kind: TransactionVariant,
) -> ProviderResult<Option<BlockWithSenders>> {
// Required data not present in static_files
Err(ProviderError::UnsupportedProvider)
}
fn sealed_block_with_senders(
&self,
_id: BlockHashOrNumber,
_transaction_kind: TransactionVariant,
) -> ProviderResult<Option<SealedBlockWithSenders>> {
// Required data not present in static_files
Err(ProviderError::UnsupportedProvider)
}
fn block_range(&self, _range: RangeInclusive<BlockNumber>) -> ProviderResult<Vec<Block>> {
// Required data not present in static_files
Err(ProviderError::UnsupportedProvider)
}
fn block_with_senders_range(
&self,
_range: RangeInclusive<BlockNumber>,
) -> ProviderResult<Vec<BlockWithSenders>> {
Err(ProviderError::UnsupportedProvider)
}
fn sealed_block_with_senders_range(
&self,
_range: RangeInclusive<BlockNumber>,
) -> ProviderResult<Vec<SealedBlockWithSenders>> {
Err(ProviderError::UnsupportedProvider)
}
}
impl<N: NodePrimitives> WithdrawalsProvider for StaticFileProvider<N> {
fn withdrawals_by_block(
&self,
_id: BlockHashOrNumber,
_timestamp: u64,
) -> ProviderResult<Option<Withdrawals>> {
// Required data not present in static_files
Err(ProviderError::UnsupportedProvider)
}
fn latest_withdrawal(&self) -> ProviderResult<Option<Withdrawal>> {
// Required data not present in static_files
Err(ProviderError::UnsupportedProvider)
}
}
impl<N: NodePrimitives> StatsReader for StaticFileProvider<N> {
fn count_entries<T: Table>(&self) -> ProviderResult<usize> {
match T::NAME {
tables::CanonicalHeaders::NAME |
tables::Headers::<Header>::NAME |
tables::HeaderTerminalDifficulties::NAME => Ok(self
.get_highest_static_file_block(StaticFileSegment::Headers)
.map(|block| block + 1)
.unwrap_or_default()
as usize),
tables::Receipts::NAME => Ok(self
.get_highest_static_file_tx(StaticFileSegment::Receipts)
.map(|receipts| receipts + 1)
.unwrap_or_default() as usize),
tables::Transactions::<TransactionSignedNoHash>::NAME => Ok(self
.get_highest_static_file_tx(StaticFileSegment::Transactions)
.map(|txs| txs + 1)
.unwrap_or_default()
as usize),
_ => Err(ProviderError::UnsupportedProvider),
}
}
}
/// Calculates the tx hash for the given transaction and its id.
#[inline]
fn calculate_hash(
entry: (TxNumber, TransactionSignedNoHash),
rlp_buf: &mut Vec<u8>,
) -> Result<(B256, TxNumber), Box<ProviderError>> {
let (tx_id, tx) = entry;
tx.transaction.eip2718_encode(&tx.signature, rlp_buf);
Ok((keccak256(rlp_buf), tx_id))
}