-
Notifications
You must be signed in to change notification settings - Fork 190
/
AccountingOracle.sol
883 lines (755 loc) · 34.8 KB
/
AccountingOracle.sol
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
// SPDX-FileCopyrightText: 2023 Lido <info@lido.fi>
// SPDX-License-Identifier: GPL-3.0
pragma solidity 0.8.9;
import { SafeCast } from "@openzeppelin/contracts-v4.4/utils/math/SafeCast.sol";
import { ILidoLocator } from "../../common/interfaces/ILidoLocator.sol";
import { UnstructuredStorage } from "../lib/UnstructuredStorage.sol";
import { BaseOracle, IConsensusContract } from "./BaseOracle.sol";
interface ILido {
function handleOracleReport(
// Oracle timings
uint256 _currentReportTimestamp,
uint256 _timeElapsedSeconds,
// CL values
uint256 _clValidators,
uint256 _clBalance,
// EL values
uint256 _withdrawalVaultBalance,
uint256 _elRewardsVaultBalance,
uint256 _sharesRequestedToBurn,
// Decision about withdrawals processing
uint256[] calldata _withdrawalFinalizationBatches,
uint256 _simulatedShareRate
) external;
}
interface ILegacyOracle {
// only called before the migration
function getBeaconSpec() external view returns (
uint64 epochsPerFrame,
uint64 slotsPerEpoch,
uint64 secondsPerSlot,
uint64 genesisTime
);
function getLastCompletedEpochId() external view returns (uint256);
// only called after the migration
function handleConsensusLayerReport(
uint256 refSlot,
uint256 clBalance,
uint256 clValidators
) external;
}
interface IOracleReportSanityChecker {
function checkExitedValidatorsRatePerDay(uint256 _exitedValidatorsCount) external view;
function checkAccountingExtraDataListItemsCount(uint256 _extraDataListItemsCount) external view;
function checkNodeOperatorsPerExtraDataItemCount(uint256 _itemIndex, uint256 _nodeOperatorsCount) external view;
}
interface IStakingRouter {
function updateExitedValidatorsCountByStakingModule(
uint256[] calldata moduleIds,
uint256[] calldata exitedValidatorsCounts
) external returns (uint256);
function reportStakingModuleExitedValidatorsCountByNodeOperator(
uint256 stakingModuleId,
bytes calldata nodeOperatorIds,
bytes calldata exitedValidatorsCounts
) external;
function reportStakingModuleStuckValidatorsCountByNodeOperator(
uint256 stakingModuleId,
bytes calldata nodeOperatorIds,
bytes calldata stuckValidatorsCounts
) external;
function onValidatorsCountsByNodeOperatorReportingFinished() external;
}
interface IWithdrawalQueue {
function onOracleReport(bool isBunkerMode, uint256 prevReportTimestamp, uint256 currentReportTimestamp) external;
}
contract AccountingOracle is BaseOracle {
using UnstructuredStorage for bytes32;
using SafeCast for uint256;
error LidoLocatorCannotBeZero();
error AdminCannotBeZero();
error LegacyOracleCannotBeZero();
error LidoCannotBeZero();
error IncorrectOracleMigration(uint256 code);
error SenderNotAllowed();
error InvalidExitedValidatorsData();
error UnsupportedExtraDataFormat(uint256 format);
error UnsupportedExtraDataType(uint256 itemIndex, uint256 dataType);
error CannotSubmitExtraDataBeforeMainData();
error ExtraDataAlreadyProcessed();
error ExtraDataListOnlySupportsSingleTx();
error UnexpectedExtraDataHash(bytes32 consensusHash, bytes32 receivedHash);
error UnexpectedExtraDataFormat(uint256 expectedFormat, uint256 receivedFormat);
error ExtraDataItemsCountCannotBeZeroForNonEmptyData();
error ExtraDataHashCannotBeZeroForNonEmptyData();
error UnexpectedExtraDataItemsCount(uint256 expectedCount, uint256 receivedCount);
error UnexpectedExtraDataIndex(uint256 expectedIndex, uint256 receivedIndex);
error InvalidExtraDataItem(uint256 itemIndex);
error InvalidExtraDataSortOrder(uint256 itemIndex);
event ExtraDataSubmitted(uint256 indexed refSlot, uint256 itemsProcessed, uint256 itemsCount);
event WarnExtraDataIncompleteProcessing(
uint256 indexed refSlot,
uint256 processedItemsCount,
uint256 itemsCount
);
struct ExtraDataProcessingState {
uint64 refSlot;
uint16 dataFormat;
bool submitted;
uint64 itemsCount;
uint64 itemsProcessed;
uint256 lastSortingKey;
bytes32 dataHash;
}
/// @notice An ACL role granting the permission to submit the data for a committee report.
bytes32 public constant SUBMIT_DATA_ROLE = keccak256("SUBMIT_DATA_ROLE");
/// @dev Storage slot: ExtraDataProcessingState state
bytes32 internal constant EXTRA_DATA_PROCESSING_STATE_POSITION =
keccak256("lido.AccountingOracle.extraDataProcessingState");
address public immutable LIDO;
ILidoLocator public immutable LOCATOR;
address public immutable LEGACY_ORACLE;
///
/// Initialization & admin functions
///
constructor(
address lidoLocator,
address lido,
address legacyOracle,
uint256 secondsPerSlot,
uint256 genesisTime
)
BaseOracle(secondsPerSlot, genesisTime)
{
if (lidoLocator == address(0)) revert LidoLocatorCannotBeZero();
if (legacyOracle == address(0)) revert LegacyOracleCannotBeZero();
if (lido == address(0)) revert LidoCannotBeZero();
LOCATOR = ILidoLocator(lidoLocator);
LIDO = lido;
LEGACY_ORACLE = legacyOracle;
}
function initialize(
address admin,
address consensusContract,
uint256 consensusVersion
) external {
if (admin == address(0)) revert AdminCannotBeZero();
uint256 lastProcessingRefSlot = _checkOracleMigration(LEGACY_ORACLE, consensusContract);
_initialize(admin, consensusContract, consensusVersion, lastProcessingRefSlot);
}
function initializeWithoutMigration(
address admin,
address consensusContract,
uint256 consensusVersion,
uint256 lastProcessingRefSlot
) external {
if (admin == address(0)) revert AdminCannotBeZero();
_initialize(admin, consensusContract, consensusVersion, lastProcessingRefSlot);
}
///
/// Data provider interface
///
struct ReportData {
///
/// Oracle consensus info
///
/// @dev Version of the oracle consensus rules. Current version expected
/// by the oracle can be obtained by calling getConsensusVersion().
uint256 consensusVersion;
/// @dev Reference slot for which the report was calculated. If the slot
/// contains a block, the state being reported should include all state
/// changes resulting from that block. The epoch containing the slot
/// should be finalized prior to calculating the report.
uint256 refSlot;
///
/// CL values
///
/// @dev The number of validators on consensus layer that were ever deposited
/// via Lido as observed at the reference slot.
uint256 numValidators;
/// @dev Cumulative balance of all Lido validators on the consensus layer
/// as observed at the reference slot.
uint256 clBalanceGwei;
/// @dev Ids of staking modules that have more exited validators than the number
/// stored in the respective staking module contract as observed at the reference
/// slot.
uint256[] stakingModuleIdsWithNewlyExitedValidators;
/// @dev Number of ever exited validators for each of the staking modules from
/// the stakingModuleIdsWithNewlyExitedValidators array as observed at the
/// reference slot.
uint256[] numExitedValidatorsByStakingModule;
///
/// EL values
///
/// @dev The ETH balance of the Lido withdrawal vault as observed at the reference slot.
uint256 withdrawalVaultBalance;
/// @dev The ETH balance of the Lido execution layer rewards vault as observed
/// at the reference slot.
uint256 elRewardsVaultBalance;
/// @dev The shares amount requested to burn through Burner as observed
/// at the reference slot. The value can be obtained in the following way:
/// `(coverSharesToBurn, nonCoverSharesToBurn) = IBurner(burner).getSharesRequestedToBurn()
/// sharesRequestedToBurn = coverSharesToBurn + nonCoverSharesToBurn`
uint256 sharesRequestedToBurn;
///
/// Decision
///
/// @dev The ascendingly-sorted array of withdrawal request IDs obtained by calling
/// WithdrawalQueue.calculateFinalizationBatches. Empty array means that no withdrawal
/// requests should be finalized.
uint256[] withdrawalFinalizationBatches;
/// @dev The share/ETH rate with the 10^27 precision (i.e. the price of one stETH share
/// in ETH where one ETH is denominated as 10^27) that would be effective as the result of
/// applying this oracle report at the reference slot, with withdrawalFinalizationBatches
/// set to empty array and simulatedShareRate set to 0.
uint256 simulatedShareRate;
/// @dev Whether, based on the state observed at the reference slot, the protocol should
/// be in the bunker mode.
bool isBunkerMode;
///
/// Extra data — the oracle information that allows asynchronous processing, potentially in
/// chunks, after the main data is processed. The oracle doesn't enforce that extra data
/// attached to some data report is processed in full before the processing deadline expires
/// or a new data report starts being processed, but enforces that no processing of extra
/// data for a report is possible after its processing deadline passes or a new data report
/// arrives.
///
/// Extra data is an array of items, each item being encoded as follows:
///
/// 3 bytes 2 bytes X bytes
/// | itemIndex | itemType | itemPayload |
///
/// itemIndex is a 0-based index into the extra data array;
/// itemType is the type of extra data item;
/// itemPayload is the item's data which interpretation depends on the item's type.
///
/// Items should be sorted ascendingly by the (itemType, ...itemSortingKey) compound key
/// where `itemSortingKey` calculation depends on the item's type (see below).
///
/// ----------------------------------------------------------------------------------------
///
/// itemType=0 (EXTRA_DATA_TYPE_STUCK_VALIDATORS): stuck validators by node operators.
/// itemPayload format:
///
/// | 3 bytes | 8 bytes | nodeOpsCount * 8 bytes | nodeOpsCount * 16 bytes |
/// | moduleId | nodeOpsCount | nodeOperatorIds | stuckValidatorsCounts |
///
/// moduleId is the staking module for which exited keys counts are being reported.
///
/// nodeOperatorIds contains an array of ids of node operators that have total stuck
/// validators counts changed compared to the staking module smart contract storage as
/// observed at the reference slot. Each id is a 8-byte uint, ids are packed tightly.
///
/// nodeOpsCount contains the number of node operator ids contained in the nodeOperatorIds
/// array. Thus, nodeOpsCount = byteLength(nodeOperatorIds) / 8.
///
/// stuckValidatorsCounts contains an array of stuck validators total counts, as observed at
/// the reference slot, for the node operators from the nodeOperatorIds array, in the same
/// order. Each count is a 16-byte uint, counts are packed tightly. Thus,
/// byteLength(stuckValidatorsCounts) = nodeOpsCount * 16.
///
/// nodeOpsCount must not be greater than maxAccountingExtraDataListItemsCount specified
/// in OracleReportSanityChecker contract. If a staking module has more node operators
/// with total stuck validators counts changed compared to the staking module smart contract
/// storage (as observed at the reference slot), reporting for that module should be split
/// into multiple items.
///
/// Item sorting key is a compound key consisting of the module id and the first reported
/// node operator's id:
///
/// itemSortingKey = (moduleId, nodeOperatorIds[0:8])
///
/// ----------------------------------------------------------------------------------------
///
/// itemType=1 (EXTRA_DATA_TYPE_EXITED_VALIDATORS): exited validators by node operators.
///
/// The payload format is exactly the same as for itemType=EXTRA_DATA_TYPE_STUCK_VALIDATORS,
/// except that, instead of stuck validators counts, exited validators counts are reported.
/// The `itemSortingKey` is calculated identically.
///
/// ----------------------------------------------------------------------------------------
///
/// The oracle daemon should report exited/stuck validators counts ONLY for those
/// (moduleId, nodeOperatorId) pairs that contain outdated counts in the staking
/// module smart contract as observed at the reference slot.
///
/// Extra data array can be passed in different formats, see below.
///
/// @dev Format of the extra data.
///
/// Currently, only the EXTRA_DATA_FORMAT_EMPTY=0 and EXTRA_DATA_FORMAT_LIST=1
/// formats are supported. See the constant defining a specific data format for
/// more info.
///
uint256 extraDataFormat;
/// @dev Hash of the extra data. See the constant defining a specific extra data
/// format for the info on how to calculate the hash.
///
/// Must be set to a zero hash if the oracle report contains no extra data.
///
bytes32 extraDataHash;
/// @dev Number of the extra data items.
///
/// Must be set to zero if the oracle report contains no extra data.
///
uint256 extraDataItemsCount;
}
uint256 public constant EXTRA_DATA_TYPE_STUCK_VALIDATORS = 1;
uint256 public constant EXTRA_DATA_TYPE_EXITED_VALIDATORS = 2;
/// @notice The extra data format used to signify that the oracle report contains no extra data.
///
uint256 public constant EXTRA_DATA_FORMAT_EMPTY = 0;
/// @notice The list format for the extra data array. Used when all extra data processing
/// fits into a single transaction.
///
/// Extra data is passed within a single transaction as a bytearray containing all data items
/// packed tightly.
///
/// Hash is a keccak256 hash calculated over the bytearray items. The Solidity equivalent of
/// the hash calculation code would be `keccak256(array)`, where `array` has the `bytes` type.
///
uint256 public constant EXTRA_DATA_FORMAT_LIST = 1;
/// @notice Submits report data for processing.
///
/// @param data The data. See the `ReportData` structure's docs for details.
/// @param contractVersion Expected version of the oracle contract.
///
/// Reverts if:
/// - The caller is not a member of the oracle committee and doesn't possess the
/// SUBMIT_DATA_ROLE.
/// - The provided contract version is different from the current one.
/// - The provided consensus version is different from the expected one.
/// - The provided reference slot differs from the current consensus frame's one.
/// - The processing deadline for the current consensus frame is missed.
/// - The keccak256 hash of the ABI-encoded data is different from the last hash
/// provided by the hash consensus contract.
/// - The provided data doesn't meet safety checks.
///
function submitReportData(ReportData calldata data, uint256 contractVersion) external {
_checkMsgSenderIsAllowedToSubmitData();
_checkContractVersion(contractVersion);
_checkConsensusData(data.refSlot, data.consensusVersion, keccak256(abi.encode(data)));
uint256 prevRefSlot = _startProcessing();
_handleConsensusReportData(data, prevRefSlot);
}
/// @notice Triggers the processing required when no extra data is present in the report,
/// i.e. when extra data format equals EXTRA_DATA_FORMAT_EMPTY.
///
function submitReportExtraDataEmpty() external {
_submitReportExtraDataEmpty();
}
/// @notice Submits report extra data in the EXTRA_DATA_FORMAT_LIST format for processing.
///
/// @param items The extra data items list. See docs for the `EXTRA_DATA_FORMAT_LIST`
/// constant for details.
///
function submitReportExtraDataList(bytes calldata items) external {
_submitReportExtraDataList(items);
}
struct ProcessingState {
/// @notice Reference slot for the current reporting frame.
uint256 currentFrameRefSlot;
/// @notice The last time at which a data can be submitted for the current reporting frame.
uint256 processingDeadlineTime;
/// @notice Hash of the main report data. Zero bytes if consensus on the hash hasn't been
/// reached yet for the current reporting frame.
bytes32 mainDataHash;
/// @notice Whether the main report data for the current reporting frame has already been
/// submitted.
bool mainDataSubmitted;
/// @notice Hash of the extra report data. Should be ignored unless `mainDataSubmitted`
/// is true.
bytes32 extraDataHash;
/// @notice Format of the extra report data for the current reporting frame. Should be
/// ignored unless `mainDataSubmitted` is true.
uint256 extraDataFormat;
/// @notice Whether any extra report data for the current reporting frame has been submitted.
bool extraDataSubmitted;
/// @notice Total number of extra report data items for the current reporting frame.
/// Should be ignored unless `mainDataSubmitted` is true.
uint256 extraDataItemsCount;
/// @notice How many extra report data items are already submitted for the current
/// reporting frame.
uint256 extraDataItemsSubmitted;
}
/// @notice Returns data processing state for the current reporting frame.
/// @return result See the docs for the `ProcessingState` struct.
///
function getProcessingState() external view returns (ProcessingState memory result) {
ConsensusReport memory report = _storageConsensusReport().value;
result.currentFrameRefSlot = _getCurrentRefSlot();
if (report.hash == bytes32(0) || result.currentFrameRefSlot != report.refSlot) {
return result;
}
result.processingDeadlineTime = report.processingDeadlineTime;
result.mainDataHash = report.hash;
uint256 processingRefSlot = LAST_PROCESSING_REF_SLOT_POSITION.getStorageUint256();
result.mainDataSubmitted = report.refSlot == processingRefSlot;
if (!result.mainDataSubmitted) {
return result;
}
ExtraDataProcessingState memory extraState = _storageExtraDataProcessingState().value;
result.extraDataHash = extraState.dataHash;
result.extraDataFormat = extraState.dataFormat;
result.extraDataSubmitted = extraState.submitted;
result.extraDataItemsCount = extraState.itemsCount;
result.extraDataItemsSubmitted = extraState.itemsProcessed;
}
///
/// Implementation & helpers
///
/// @dev Returns last processed reference slot of the legacy oracle.
///
/// Old oracle didn't specify what slot use as a reference one, but actually
/// used the first slot of the first frame's epoch. The new oracle uses the
/// last slot of the previous frame's last epoch as a reference one.
///
/// Oracle migration scheme:
///
/// last old frame <--------->
/// old frames |r . . |
/// new frames r| . . r| . . r|
/// first new frame <--------->
/// events 0 1 2 3 4
/// time ------------------------------------------------>
///
/// 0. last reference slot of legacy oracle
/// 1. last legacy oracle's consensus report arrives
/// 2. new oracle is deployed and enabled, legacy oracle is disabled and upgraded to
/// the compatibility implementation
/// 3. first reference slot of the new oracle
/// 4. first new oracle's consensus report arrives
///
function _checkOracleMigration(
address legacyOracle,
address consensusContract
)
internal view returns (uint256)
{
(uint256 initialEpoch,
uint256 epochsPerFrame) = IConsensusContract(consensusContract).getFrameConfig();
(uint256 slotsPerEpoch,
uint256 secondsPerSlot,
uint256 genesisTime) = IConsensusContract(consensusContract).getChainConfig();
{
// check chain spec to match the prev. one (a block is used to reduce stack allocation)
(uint256 legacyEpochsPerFrame,
uint256 legacySlotsPerEpoch,
uint256 legacySecondsPerSlot,
uint256 legacyGenesisTime) = ILegacyOracle(legacyOracle).getBeaconSpec();
if (slotsPerEpoch != legacySlotsPerEpoch ||
secondsPerSlot != legacySecondsPerSlot ||
genesisTime != legacyGenesisTime
) {
revert IncorrectOracleMigration(0);
}
if (epochsPerFrame != legacyEpochsPerFrame) {
revert IncorrectOracleMigration(1);
}
}
uint256 legacyProcessedEpoch = ILegacyOracle(legacyOracle).getLastCompletedEpochId();
if (initialEpoch != legacyProcessedEpoch + epochsPerFrame) {
revert IncorrectOracleMigration(2);
}
// last processing ref. slot of the new oracle should be set to the last processed
// ref. slot of the legacy oracle, i.e. the first slot of the last processed epoch
return legacyProcessedEpoch * slotsPerEpoch;
}
function _initialize(
address admin,
address consensusContract,
uint256 consensusVersion,
uint256 lastProcessingRefSlot
) internal {
_setupRole(DEFAULT_ADMIN_ROLE, admin);
BaseOracle._initialize(consensusContract, consensusVersion, lastProcessingRefSlot);
}
function _handleConsensusReport(
ConsensusReport memory /* report */,
uint256 /* prevSubmittedRefSlot */,
uint256 prevProcessingRefSlot
) internal override {
ExtraDataProcessingState memory state = _storageExtraDataProcessingState().value;
if (state.refSlot == prevProcessingRefSlot && (
!state.submitted || state.itemsProcessed < state.itemsCount
)) {
emit WarnExtraDataIncompleteProcessing(
prevProcessingRefSlot,
state.itemsProcessed,
state.itemsCount
);
}
}
function _checkMsgSenderIsAllowedToSubmitData() internal view {
address sender = _msgSender();
if (!hasRole(SUBMIT_DATA_ROLE, sender) && !_isConsensusMember(sender)) {
revert SenderNotAllowed();
}
}
function _handleConsensusReportData(ReportData calldata data, uint256 prevRefSlot) internal {
if (data.extraDataFormat == EXTRA_DATA_FORMAT_EMPTY) {
if (data.extraDataHash != bytes32(0)) {
revert UnexpectedExtraDataHash(bytes32(0), data.extraDataHash);
}
if (data.extraDataItemsCount != 0) {
revert UnexpectedExtraDataItemsCount(0, data.extraDataItemsCount);
}
} else {
if (data.extraDataFormat != EXTRA_DATA_FORMAT_LIST) {
revert UnsupportedExtraDataFormat(data.extraDataFormat);
}
if (data.extraDataItemsCount == 0) {
revert ExtraDataItemsCountCannotBeZeroForNonEmptyData();
}
if (data.extraDataHash == bytes32(0)) {
revert ExtraDataHashCannotBeZeroForNonEmptyData();
}
}
IOracleReportSanityChecker(LOCATOR.oracleReportSanityChecker())
.checkAccountingExtraDataListItemsCount(data.extraDataItemsCount);
ILegacyOracle(LEGACY_ORACLE).handleConsensusLayerReport(
data.refSlot,
data.clBalanceGwei * 1e9,
data.numValidators
);
uint256 slotsElapsed = data.refSlot - prevRefSlot;
IStakingRouter stakingRouter = IStakingRouter(LOCATOR.stakingRouter());
IWithdrawalQueue withdrawalQueue = IWithdrawalQueue(LOCATOR.withdrawalQueue());
_processStakingRouterExitedValidatorsByModule(
stakingRouter,
data.stakingModuleIdsWithNewlyExitedValidators,
data.numExitedValidatorsByStakingModule,
slotsElapsed
);
withdrawalQueue.onOracleReport(
data.isBunkerMode,
GENESIS_TIME + prevRefSlot * SECONDS_PER_SLOT,
GENESIS_TIME + data.refSlot * SECONDS_PER_SLOT
);
ILido(LIDO).handleOracleReport(
GENESIS_TIME + data.refSlot * SECONDS_PER_SLOT,
slotsElapsed * SECONDS_PER_SLOT,
data.numValidators,
data.clBalanceGwei * 1e9,
data.withdrawalVaultBalance,
data.elRewardsVaultBalance,
data.sharesRequestedToBurn,
data.withdrawalFinalizationBatches,
data.simulatedShareRate
);
_storageExtraDataProcessingState().value = ExtraDataProcessingState({
refSlot: data.refSlot.toUint64(),
dataFormat: data.extraDataFormat.toUint16(),
submitted: false,
dataHash: data.extraDataHash,
itemsCount: data.extraDataItemsCount.toUint16(),
itemsProcessed: 0,
lastSortingKey: 0
});
}
function _processStakingRouterExitedValidatorsByModule(
IStakingRouter stakingRouter,
uint256[] calldata stakingModuleIds,
uint256[] calldata numExitedValidatorsByStakingModule,
uint256 slotsElapsed
) internal {
if (stakingModuleIds.length != numExitedValidatorsByStakingModule.length) {
revert InvalidExitedValidatorsData();
}
if (stakingModuleIds.length == 0) {
return;
}
for (uint256 i = 1; i < stakingModuleIds.length;) {
if (stakingModuleIds[i] <= stakingModuleIds[i - 1]) {
revert InvalidExitedValidatorsData();
}
unchecked { ++i; }
}
for (uint256 i = 0; i < stakingModuleIds.length;) {
if (numExitedValidatorsByStakingModule[i] == 0) {
revert InvalidExitedValidatorsData();
}
unchecked { ++i; }
}
uint256 newlyExitedValidatorsCount = stakingRouter.updateExitedValidatorsCountByStakingModule(
stakingModuleIds,
numExitedValidatorsByStakingModule
);
uint256 exitedValidatorsRatePerDay =
newlyExitedValidatorsCount * (1 days) /
(SECONDS_PER_SLOT * slotsElapsed);
IOracleReportSanityChecker(LOCATOR.oracleReportSanityChecker())
.checkExitedValidatorsRatePerDay(exitedValidatorsRatePerDay);
}
function _submitReportExtraDataEmpty() internal {
ExtraDataProcessingState memory procState = _storageExtraDataProcessingState().value;
_checkCanSubmitExtraData(procState, EXTRA_DATA_FORMAT_EMPTY);
if (procState.submitted) revert ExtraDataAlreadyProcessed();
IStakingRouter(LOCATOR.stakingRouter()).onValidatorsCountsByNodeOperatorReportingFinished();
_storageExtraDataProcessingState().value.submitted = true;
emit ExtraDataSubmitted(procState.refSlot, 0, 0);
}
function _checkCanSubmitExtraData(ExtraDataProcessingState memory procState, uint256 format)
internal view
{
_checkMsgSenderIsAllowedToSubmitData();
ConsensusReport memory report = _storageConsensusReport().value;
if (report.hash == bytes32(0) || procState.refSlot != report.refSlot) {
revert CannotSubmitExtraDataBeforeMainData();
}
_checkProcessingDeadline();
if (procState.dataFormat != format) {
revert UnexpectedExtraDataFormat(procState.dataFormat, format);
}
}
struct ExtraDataIterState {
// volatile
uint256 index;
uint256 itemType;
uint256 dataOffset;
uint256 lastSortingKey;
// config
address stakingRouter;
}
function _submitReportExtraDataList(bytes calldata items) internal {
ExtraDataProcessingState memory procState = _storageExtraDataProcessingState().value;
_checkCanSubmitExtraData(procState, EXTRA_DATA_FORMAT_LIST);
if (procState.itemsProcessed == procState.itemsCount) {
revert ExtraDataAlreadyProcessed();
}
if (procState.itemsProcessed != 0) {
revert ExtraDataListOnlySupportsSingleTx();
}
bytes32 dataHash = keccak256(items);
if (dataHash != procState.dataHash) {
revert UnexpectedExtraDataHash(procState.dataHash, dataHash);
}
ExtraDataIterState memory iter = ExtraDataIterState({
index: 0,
itemType: 0,
dataOffset: 0,
lastSortingKey: 0,
stakingRouter: LOCATOR.stakingRouter()
});
_processExtraDataItems(items, iter);
uint256 itemsProcessed = iter.index + 1;
if (itemsProcessed != procState.itemsCount) {
revert UnexpectedExtraDataItemsCount(procState.itemsCount, itemsProcessed);
}
procState.submitted = true;
procState.itemsProcessed = uint64(itemsProcessed);
procState.lastSortingKey = iter.lastSortingKey;
_storageExtraDataProcessingState().value = procState;
IStakingRouter(iter.stakingRouter).onValidatorsCountsByNodeOperatorReportingFinished();
emit ExtraDataSubmitted(procState.refSlot, itemsProcessed, itemsProcessed);
}
function _processExtraDataItems(bytes calldata data, ExtraDataIterState memory iter) internal {
uint256 dataOffset = iter.dataOffset;
uint256 maxNodeOperatorsPerItem = 0;
uint256 maxNodeOperatorItemIndex = 0;
while (dataOffset < data.length) {
uint256 index;
uint256 itemType;
/// @solidity memory-safe-assembly
assembly {
// layout at the dataOffset:
// | 3 bytes | 2 bytes | X bytes |
// | itemIndex | itemType | itemPayload |
let header := calldataload(add(data.offset, dataOffset))
index := shr(232, header)
itemType := and(shr(216, header), 0xffff)
dataOffset := add(dataOffset, 5)
}
if (iter.itemType == 0) {
if (index != 0) {
revert UnexpectedExtraDataIndex(0, index);
}
} else if (index != iter.index + 1) {
revert UnexpectedExtraDataIndex(iter.index + 1, index);
}
iter.index = index;
iter.itemType = itemType;
iter.dataOffset = dataOffset;
if (itemType == EXTRA_DATA_TYPE_EXITED_VALIDATORS ||
itemType == EXTRA_DATA_TYPE_STUCK_VALIDATORS
) {
uint256 nodeOpsProcessed = _processExtraDataItem(data, iter);
if (nodeOpsProcessed > maxNodeOperatorsPerItem) {
maxNodeOperatorsPerItem = nodeOpsProcessed;
maxNodeOperatorItemIndex = index;
}
} else {
revert UnsupportedExtraDataType(index, itemType);
}
assert(iter.dataOffset > dataOffset);
dataOffset = iter.dataOffset;
}
assert(maxNodeOperatorsPerItem > 0);
IOracleReportSanityChecker(LOCATOR.oracleReportSanityChecker())
.checkNodeOperatorsPerExtraDataItemCount(maxNodeOperatorItemIndex, maxNodeOperatorsPerItem);
}
function _processExtraDataItem(bytes calldata data, ExtraDataIterState memory iter) internal returns (uint256) {
uint256 dataOffset = iter.dataOffset;
uint256 moduleId;
uint256 nodeOpsCount;
uint256 firstNodeOpId;
bytes calldata nodeOpIds;
bytes calldata valuesCounts;
if (dataOffset + 35 > data.length) {
// has to fit at least moduleId (3 bytes), nodeOpsCount (8 bytes),
// and data for one node operator (8 + 16 bytes), total 35 bytes
revert InvalidExtraDataItem(iter.index);
}
/// @solidity memory-safe-assembly
assembly {
// layout at the dataOffset:
// | 3 bytes | 8 bytes | nodeOpsCount * 8 bytes | nodeOpsCount * 16 bytes |
// | moduleId | nodeOpsCount | nodeOperatorIds | validatorsCounts |
let header := calldataload(add(data.offset, dataOffset))
moduleId := shr(232, header)
nodeOpsCount := and(shr(168, header), 0xffffffffffffffff)
nodeOpIds.offset := add(data.offset, add(dataOffset, 11))
nodeOpIds.length := mul(nodeOpsCount, 8)
firstNodeOpId := shr(192, calldataload(nodeOpIds.offset))
valuesCounts.offset := add(nodeOpIds.offset, nodeOpIds.length)
valuesCounts.length := mul(nodeOpsCount, 16)
dataOffset := sub(add(valuesCounts.offset, valuesCounts.length), data.offset)
}
if (moduleId == 0) {
revert InvalidExtraDataItem(iter.index);
}
unchecked {
// | 2 bytes | 19 bytes | 3 bytes | 8 bytes |
// | itemType | 00000000 | moduleId | firstNodeOpId |
uint256 sortingKey = (iter.itemType << 240) | (moduleId << 64) | firstNodeOpId;
if (sortingKey <= iter.lastSortingKey) {
revert InvalidExtraDataSortOrder(iter.index);
}
iter.lastSortingKey = sortingKey;
}
if (dataOffset > data.length || nodeOpsCount == 0) {
revert InvalidExtraDataItem(iter.index);
}
if (iter.itemType == EXTRA_DATA_TYPE_STUCK_VALIDATORS) {
IStakingRouter(iter.stakingRouter)
.reportStakingModuleStuckValidatorsCountByNodeOperator(moduleId, nodeOpIds, valuesCounts);
} else {
IStakingRouter(iter.stakingRouter)
.reportStakingModuleExitedValidatorsCountByNodeOperator(moduleId, nodeOpIds, valuesCounts);
}
iter.dataOffset = dataOffset;
return nodeOpsCount;
}
///
/// Storage helpers
///
struct StorageExtraDataProcessingState {
ExtraDataProcessingState value;
}
function _storageExtraDataProcessingState()
internal pure returns (StorageExtraDataProcessingState storage r)
{
bytes32 position = EXTRA_DATA_PROCESSING_STATE_POSITION;
assembly { r.slot := position }
}
}