Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Removing eth2 mentions in documentation and fix links #3848

Merged
merged 8 commits into from
Mar 13, 2022

Conversation

philknows
Copy link
Member

Motivation

This PR is to update the documentation with Eth Consensus nomenclature and update minor non-engineering mentions of eth2. Fixes reference links to the old ethereum/eth2.0-specs to ethereum/consensus-specs and ethereum/beacon-APIs. Some are left behind due to the naming of certain functions and variables which is not covered with this PR. Also updates some documentation such as updating badges, including our minimum requirement of node 16.x

Description

Addresses issue and resolves #3626.

@codecov
Copy link

codecov bot commented Mar 11, 2022

Codecov Report

Merging #3848 (f449b7a) into master (e30eca0) will not change coverage.
The diff coverage is n/a.

❗ Current head f449b7a differs from pull request most recent head 49dcdde. Consider uploading reports for the commit 49dcdde to get more accurate results

@@           Coverage Diff           @@
##           master    #3848   +/-   ##
=======================================
  Coverage   36.12%   36.12%           
=======================================
  Files         325      325           
  Lines        9041     9041           
  Branches     1419     1419           
=======================================
  Hits         3266     3266           
  Misses       5632     5632           
  Partials      143      143           

@github-actions
Copy link
Contributor

Performance Report

✔️ no performance regression detected

Full benchmark results
Benchmark suite Current: f449b7a Previous: e30eca0 Ratio
BeaconState.hashTreeRoot - No change 630.00 ns/op 580.00 ns/op 1.09
BeaconState.hashTreeRoot - 1 full validator 149.15 us/op 124.84 us/op 1.19
BeaconState.hashTreeRoot - 32 full validator 2.1266 ms/op 1.9078 ms/op 1.11
BeaconState.hashTreeRoot - 512 full validator 28.509 ms/op 24.711 ms/op 1.15
BeaconState.hashTreeRoot - 1 validator.effectiveBalance 142.17 us/op 125.99 us/op 1.13
BeaconState.hashTreeRoot - 32 validator.effectiveBalance 2.6580 ms/op 1.7884 ms/op 1.49
BeaconState.hashTreeRoot - 512 validator.effectiveBalance 31.302 ms/op 29.933 ms/op 1.05
BeaconState.hashTreeRoot - 1 balances 99.892 us/op 88.203 us/op 1.13
BeaconState.hashTreeRoot - 32 balances 893.47 us/op 768.85 us/op 1.16
BeaconState.hashTreeRoot - 512 balances 8.3073 ms/op 7.2453 ms/op 1.15
BeaconState.hashTreeRoot - 250000 balances 150.94 ms/op 132.18 ms/op 1.14
processSlot - 1 slots 53.285 us/op 47.398 us/op 1.12
processSlot - 32 slots 3.4226 ms/op 2.8504 ms/op 1.20
getCommitteeAssignments - req 1 vs - 250000 vc 6.0370 ms/op 5.2358 ms/op 1.15
getCommitteeAssignments - req 100 vs - 250000 vc 8.2578 ms/op 7.2420 ms/op 1.14
getCommitteeAssignments - req 1000 vs - 250000 vc 8.8956 ms/op 7.7570 ms/op 1.15
computeProposers - vc 250000 24.139 ms/op 20.256 ms/op 1.19
computeEpochShuffling - vc 250000 214.99 ms/op 188.15 ms/op 1.14
getNextSyncCommittee - vc 250000 393.77 ms/op 331.87 ms/op 1.19
altair processAttestation - 250000 vs - 7PWei normalcase 69.907 ms/op 34.783 ms/op 2.01
altair processAttestation - 250000 vs - 7PWei worstcase 36.795 ms/op 37.411 ms/op 0.98
altair processAttestation - setStatus - 1/6 committees join 11.235 ms/op 10.269 ms/op 1.09
altair processAttestation - setStatus - 1/3 committees join 23.511 ms/op 21.308 ms/op 1.10
altair processAttestation - setStatus - 1/2 committees join 34.024 ms/op 32.636 ms/op 1.04
altair processAttestation - setStatus - 2/3 committees join 49.270 ms/op 43.445 ms/op 1.13
altair processAttestation - setStatus - 4/5 committees join 58.742 ms/op 51.426 ms/op 1.14
altair processAttestation - setStatus - 100% committees join 74.106 ms/op 64.962 ms/op 1.14
altair processAttestation - updateEpochParticipants - 1/6 committees join 12.110 ms/op 10.896 ms/op 1.11
altair processAttestation - updateEpochParticipants - 1/3 committees join 25.336 ms/op 23.707 ms/op 1.07
altair processAttestation - updateEpochParticipants - 1/2 committees join 22.521 ms/op 19.421 ms/op 1.16
altair processAttestation - updateEpochParticipants - 2/3 committees join 27.280 ms/op 20.881 ms/op 1.31
altair processAttestation - updateEpochParticipants - 4/5 committees join 25.241 ms/op 22.000 ms/op 1.15
altair processAttestation - updateEpochParticipants - 100% committees join 26.197 ms/op 26.084 ms/op 1.00
altair processAttestation - updateAllStatus 21.114 ms/op 18.145 ms/op 1.16
altair processBlock - 250000 vs - 7PWei normalcase 35.694 ms/op 31.895 ms/op 1.12
altair processBlock - 250000 vs - 7PWei worstcase 128.50 ms/op 99.641 ms/op 1.29
altair processEpoch - mainnet_e81889 901.70 ms/op 795.64 ms/op 1.13
mainnet_e81889 - altair beforeProcessEpoch 360.77 ms/op 342.43 ms/op 1.05
mainnet_e81889 - altair processJustificationAndFinalization 76.767 us/op 123.04 us/op 0.62
mainnet_e81889 - altair processInactivityUpdates 21.037 ms/op 17.904 ms/op 1.18
mainnet_e81889 - altair processRewardsAndPenalties 112.20 ms/op 96.145 ms/op 1.17
mainnet_e81889 - altair processRegistryUpdates 11.026 us/op 13.452 us/op 0.82
mainnet_e81889 - altair processSlashings 3.0310 us/op 2.3620 us/op 1.28
mainnet_e81889 - altair processEth1DataReset 2.8790 us/op 2.3040 us/op 1.25
mainnet_e81889 - altair processEffectiveBalanceUpdates 7.5554 ms/op 6.6334 ms/op 1.14
mainnet_e81889 - altair processSlashingsReset 16.215 us/op 19.131 us/op 0.85
mainnet_e81889 - altair processRandaoMixesReset 21.020 us/op 26.298 us/op 0.80
mainnet_e81889 - altair processHistoricalRootsUpdate 4.2470 us/op 2.8340 us/op 1.50
mainnet_e81889 - altair processParticipationFlagUpdates 95.431 ms/op 67.996 ms/op 1.40
mainnet_e81889 - altair processSyncCommitteeUpdates 2.7980 us/op 2.4020 us/op 1.16
mainnet_e81889 - altair afterProcessEpoch 268.39 ms/op 218.37 ms/op 1.23
altair processInactivityUpdates - 250000 normalcase 82.051 ms/op 70.031 ms/op 1.17
altair processInactivityUpdates - 250000 worstcase 85.918 ms/op 66.217 ms/op 1.30
altair processParticipationFlagUpdates - 250000 anycase 75.777 ms/op 59.385 ms/op 1.28
altair processRewardsAndPenalties - 250000 normalcase 90.852 ms/op 101.71 ms/op 0.89
altair processRewardsAndPenalties - 250000 worstcase 121.37 ms/op 100.70 ms/op 1.21
altair processSyncCommitteeUpdates - 250000 411.95 ms/op 336.87 ms/op 1.22
Tree 40 250000 create 684.03 ms/op 574.75 ms/op 1.19
Tree 40 250000 get(125000) 388.44 ns/op 326.42 ns/op 1.19
Tree 40 250000 set(125000) 2.1492 us/op 1.8886 us/op 1.14
Tree 40 250000 toArray() 46.200 ms/op 38.383 ms/op 1.20
Tree 40 250000 iterate all - toArray() + loop 46.546 ms/op 38.473 ms/op 1.21
Tree 40 250000 iterate all - get(i) 144.17 ms/op 117.91 ms/op 1.22
MutableVector 250000 create 24.361 ms/op 20.349 ms/op 1.20
MutableVector 250000 get(125000) 14.862 ns/op 12.520 ns/op 1.19
MutableVector 250000 set(125000) 602.92 ns/op 494.14 ns/op 1.22
MutableVector 250000 toArray() 10.399 ms/op 8.2532 ms/op 1.26
MutableVector 250000 iterate all - toArray() + loop 10.645 ms/op 8.1219 ms/op 1.31
MutableVector 250000 iterate all - get(i) 4.0085 ms/op 3.8691 ms/op 1.04
Array 250000 create 6.9547 ms/op 4.7698 ms/op 1.46
Array 250000 clone - spread 2.6362 ms/op 2.1142 ms/op 1.25
Array 250000 get(125000) 1.2750 ns/op 1.0230 ns/op 1.25
Array 250000 set(125000) 1.2650 ns/op 1.0160 ns/op 1.25
Array 250000 iterate all - loop 201.43 us/op 167.81 us/op 1.20
effectiveBalanceIncrements clone Uint8Array 300000 98.865 us/op 492.05 us/op 0.20
effectiveBalanceIncrements clone MutableVector 300000 578.00 ns/op 556.00 ns/op 1.04
effectiveBalanceIncrements rw all Uint8Array 300000 354.97 us/op 302.85 us/op 1.17
effectiveBalanceIncrements rw all MutableVector 300000 184.97 ms/op 166.88 ms/op 1.11
aggregationBits - 2048 els - readonlyValues 203.35 us/op 174.49 us/op 1.17
aggregationBits - 2048 els - zipIndexesInBitList 35.826 us/op 31.441 us/op 1.14
regular array get 100000 times 79.998 us/op 67.419 us/op 1.19
wrappedArray get 100000 times 80.269 us/op 67.406 us/op 1.19
arrayWithProxy get 100000 times 44.182 ms/op 36.047 ms/op 1.23
ssz.Root.equals 1.2730 us/op 1.0730 us/op 1.19
ssz.Root.equals with valueOf() 1.5010 us/op 1.2280 us/op 1.22
byteArrayEquals with valueOf() 1.4310 us/op 1.1850 us/op 1.21
phase0 processBlock - 250000 vs - 7PWei normalcase 9.0966 ms/op 7.4581 ms/op 1.22
phase0 processBlock - 250000 vs - 7PWei worstcase 84.524 ms/op 69.169 ms/op 1.22
phase0 afterProcessEpoch - 250000 vs - 7PWei 246.08 ms/op 204.16 ms/op 1.21
phase0 beforeProcessEpoch - 250000 vs - 7PWei 626.51 ms/op 527.89 ms/op 1.19
phase0 processEpoch - mainnet_e58758 889.14 ms/op 761.63 ms/op 1.17
mainnet_e58758 - phase0 beforeProcessEpoch 478.73 ms/op 420.03 ms/op 1.14
mainnet_e58758 - phase0 processJustificationAndFinalization 67.831 us/op 124.71 us/op 0.54
mainnet_e58758 - phase0 processRewardsAndPenalties 105.16 ms/op 111.89 ms/op 0.94
mainnet_e58758 - phase0 processRegistryUpdates 49.440 us/op 74.492 us/op 0.66
mainnet_e58758 - phase0 processSlashings 3.1110 us/op 2.0140 us/op 1.54
mainnet_e58758 - phase0 processEth1DataReset 2.8230 us/op 2.5350 us/op 1.11
mainnet_e58758 - phase0 processEffectiveBalanceUpdates 6.1932 ms/op 5.5049 ms/op 1.13
mainnet_e58758 - phase0 processSlashingsReset 14.588 us/op 15.865 us/op 0.92
mainnet_e58758 - phase0 processRandaoMixesReset 19.291 us/op 21.555 us/op 0.89
mainnet_e58758 - phase0 processHistoricalRootsUpdate 3.9920 us/op 2.7330 us/op 1.46
mainnet_e58758 - phase0 processParticipationRecordUpdates 15.032 us/op 16.762 us/op 0.90
mainnet_e58758 - phase0 afterProcessEpoch 215.47 ms/op 178.67 ms/op 1.21
phase0 processEffectiveBalanceUpdates - 250000 normalcase 7.4504 ms/op 6.0837 ms/op 1.22
phase0 processEffectiveBalanceUpdates - 250000 worstcase 0.5 7.4831 ms/op 6.6389 ms/op 1.13
phase0 processRegistryUpdates - 250000 normalcase 48.011 us/op 69.196 us/op 0.69
phase0 processRegistryUpdates - 250000 badcase_full_deposits 3.3398 ms/op 2.9855 ms/op 1.12
phase0 processRegistryUpdates - 250000 worstcase 0.5 1.8948 s/op 1.5197 s/op 1.25
phase0 getAttestationDeltas - 250000 normalcase 15.273 ms/op 12.985 ms/op 1.18
phase0 getAttestationDeltas - 250000 worstcase 15.397 ms/op 13.036 ms/op 1.18
phase0 processSlashings - 250000 worstcase 41.524 ms/op 33.782 ms/op 1.23
shuffle list - 16384 els 15.536 ms/op 12.973 ms/op 1.20
shuffle list - 250000 els 222.62 ms/op 184.23 ms/op 1.21
getEffectiveBalanceIncrementsZeroInactive - 250000 vs - 7PWei 539.99 us/op 494.17 us/op 1.09
pass gossip attestations to forkchoice per slot 17.343 ms/op 18.109 ms/op 0.96
computeDeltas 3.8133 ms/op 3.4700 ms/op 1.10
computeProposerBoostScoreFromBalances 599.39 us/op 502.89 us/op 1.19
getPubkeys - index2pubkey - req 1000 vs - 250000 vc 2.4673 ms/op 2.0078 ms/op 1.23
getPubkeys - validatorsArr - req 1000 vs - 250000 vc 912.49 us/op 672.40 us/op 1.36
BLS verify - blst-native 2.2285 ms/op 1.8593 ms/op 1.20
BLS verifyMultipleSignatures 3 - blst-native 4.5851 ms/op 3.8183 ms/op 1.20
BLS verifyMultipleSignatures 8 - blst-native 9.8887 ms/op 8.2317 ms/op 1.20
BLS verifyMultipleSignatures 32 - blst-native 35.870 ms/op 29.871 ms/op 1.20
BLS aggregatePubkeys 32 - blst-native 48.205 us/op 39.775 us/op 1.21
BLS aggregatePubkeys 128 - blst-native 182.73 us/op 153.35 us/op 1.19
getAttestationsForBlock 70.207 ms/op 59.991 ms/op 1.17
CheckpointStateCache - add get delete 22.099 us/op 17.062 us/op 1.30
validate gossip signedAggregateAndProof - struct 5.3541 ms/op 4.4510 ms/op 1.20
validate gossip signedAggregateAndProof - treeBacked 5.2592 ms/op 4.4064 ms/op 1.19
validate gossip attestation - struct 2.4905 ms/op 2.0856 ms/op 1.19
validate gossip attestation - treeBacked 2.5083 ms/op 2.1140 ms/op 1.19
pickEth1Vote - no votes 11.325 ms/op 8.2489 ms/op 1.37
pickEth1Vote - max votes 59.802 ms/op 46.206 ms/op 1.29
pickEth1Vote - Eth1Data hashTreeRoot value x2048 29.563 ms/op 23.895 ms/op 1.24
pickEth1Vote - Eth1Data hashTreeRoot tree x2048 11.227 ms/op 8.9645 ms/op 1.25
pickEth1Vote - Eth1Data fastSerialize value x2048 5.7843 ms/op 4.8812 ms/op 1.19
pickEth1Vote - Eth1Data fastSerialize tree x2048 27.853 ms/op 21.005 ms/op 1.33
bytes32 toHexString 1.9920 us/op 1.5820 us/op 1.26
bytes32 Buffer.toString(hex) 841.00 ns/op 659.00 ns/op 1.28
bytes32 Buffer.toString(hex) from Uint8Array 1.1470 us/op 897.00 ns/op 1.28
bytes32 Buffer.toString(hex) + 0x 857.00 ns/op 664.00 ns/op 1.29
Object access 1 prop 0.41600 ns/op 0.30300 ns/op 1.37
Map access 1 prop 0.35100 ns/op 0.28500 ns/op 1.23
Object get x1000 21.582 ns/op 17.199 ns/op 1.25
Map get x1000 1.1780 ns/op 1.0040 ns/op 1.17
Object set x1000 124.99 ns/op 96.047 ns/op 1.30
Map set x1000 78.221 ns/op 59.432 ns/op 1.32
Return object 10000 times 0.44740 ns/op 0.37370 ns/op 1.20
Throw Error 10000 times 7.0075 us/op 5.8946 us/op 1.19
enrSubnets - fastDeserialize 64 bits 1.5010 us/op 1.1610 us/op 1.29
enrSubnets - ssz BitVector 64 bits 19.534 us/op 16.223 us/op 1.20
enrSubnets - fastDeserialize 4 bits 548.00 ns/op 413.00 ns/op 1.33
enrSubnets - ssz BitVector 4 bits 3.4520 us/op 2.7990 us/op 1.23
RateTracker 1000000 limit, 1 obj count per request 211.92 ns/op 170.21 ns/op 1.25
RateTracker 1000000 limit, 2 obj count per request 159.04 ns/op 126.05 ns/op 1.26
RateTracker 1000000 limit, 4 obj count per request 131.37 ns/op 104.74 ns/op 1.25
RateTracker 1000000 limit, 8 obj count per request 117.00 ns/op 93.749 ns/op 1.25
RateTracker with prune 4.2820 us/op 3.5650 us/op 1.20
array of 16000 items push then shift 3.7571 us/op 3.0783 us/op 1.22
LinkedList of 16000 items push then shift 18.858 ns/op 16.505 ns/op 1.14
array of 16000 items push then pop 237.56 ns/op 178.46 ns/op 1.33
LinkedList of 16000 items push then pop 17.828 ns/op 16.602 ns/op 1.07
array of 24000 items push then shift 5.4651 us/op 4.5444 us/op 1.20
LinkedList of 24000 items push then shift 21.542 ns/op 17.899 ns/op 1.20
array of 24000 items push then pop 232.57 ns/op 174.52 ns/op 1.33
LinkedList of 24000 items push then pop 19.686 ns/op 17.790 ns/op 1.11

by benchmarkbot/action

@wemeetagain wemeetagain merged commit 6bd0310 into master Mar 13, 2022
@wemeetagain wemeetagain deleted the philknows-removeeth2 branch March 13, 2022 22:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rename "eth2" mentions to consensus
3 participants