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.

Sign up for GitHub

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

Jump to bottom

docs: Remove comprehensive guide and add quickstart info #5267

Merged
merged 1 commit into from
Mar 14, 2023
Merged

docs: Remove comprehensive guide and add quickstart info #5267

merged 1 commit into from
Mar 14, 2023

Conversation

philknows
Copy link
Member

Motivation

Comprehensive guide is outdated.

Description

Removing the comprehensive guide links in our docs and pushing users to use the Lodestar quickscripts repo with its own instructions to more easily launch Lodestar + EL client in anticipation of incentive program launch.

@philknows philknows requested a review from a team as a code owner March 14, 2023 17:40
g11tech
g11tech approved these changes Mar 14, 2023
View reviewed changes
Copy link
Contributor

@g11tech g11tech left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm! 👍

@g11tech g11tech enabled auto-merge (squash) March 14, 2023 17:43
@github-actions
Copy link
Contributor

Performance Report

✔️ no performance regression detected

Full benchmark results
Benchmark suite Current: acfbf75 Previous: 15a9035 Ratio
getPubkeys - index2pubkey - req 1000 vs - 250000 vc 578.16 us/op 786.23 us/op 0.74
getPubkeys - validatorsArr - req 1000 vs - 250000 vc 52.010 us/op 69.772 us/op 0.75
BLS verify - blst-native 1.2152 ms/op 1.5141 ms/op 0.80
BLS verifyMultipleSignatures 3 - blst-native 2.4977 ms/op 3.0276 ms/op 0.82
BLS verifyMultipleSignatures 8 - blst-native 5.3672 ms/op 6.4360 ms/op 0.83
BLS verifyMultipleSignatures 32 - blst-native 19.428 ms/op 23.438 ms/op 0.83
BLS aggregatePubkeys 32 - blst-native 25.825 us/op 32.727 us/op 0.79
BLS aggregatePubkeys 128 - blst-native 100.36 us/op 127.49 us/op 0.79
getAttestationsForBlock 56.530 ms/op 96.457 ms/op 0.59
isKnown best case - 1 super set check 250.00 ns/op 412.00 ns/op 0.61
isKnown normal case - 2 super set checks 244.00 ns/op 325.00 ns/op 0.75
isKnown worse case - 16 super set checks 247.00 ns/op 310.00 ns/op 0.80
CheckpointStateCache - add get delete 5.2410 us/op 6.8810 us/op 0.76
validate gossip signedAggregateAndProof - struct 2.6901 ms/op 3.6173 ms/op 0.74
validate gossip attestation - struct 1.2738 ms/op 1.6369 ms/op 0.78
pickEth1Vote - no votes 1.2046 ms/op 1.7113 ms/op 0.70
pickEth1Vote - max votes 10.303 ms/op 14.455 ms/op 0.71
pickEth1Vote - Eth1Data hashTreeRoot value x2048 8.7425 ms/op 12.369 ms/op 0.71
pickEth1Vote - Eth1Data hashTreeRoot tree x2048 14.352 ms/op 20.970 ms/op 0.68
pickEth1Vote - Eth1Data fastSerialize value x2048 650.44 us/op 896.24 us/op 0.73
pickEth1Vote - Eth1Data fastSerialize tree x2048 7.4226 ms/op 8.5621 ms/op 0.87
bytes32 toHexString 492.00 ns/op 875.00 ns/op 0.56
bytes32 Buffer.toString(hex) 348.00 ns/op 544.00 ns/op 0.64
bytes32 Buffer.toString(hex) from Uint8Array 562.00 ns/op 804.00 ns/op 0.70
bytes32 Buffer.toString(hex) + 0x 348.00 ns/op 540.00 ns/op 0.64
Object access 1 prop 0.17500 ns/op 0.23900 ns/op 0.73
Map access 1 prop 0.16600 ns/op 0.19600 ns/op 0.85
Object get x1000 7.4470 ns/op 9.7560 ns/op 0.76
Map get x1000 0.64700 ns/op 0.82500 ns/op 0.78
Object set x1000 52.572 ns/op 93.655 ns/op 0.56
Map set x1000 44.021 ns/op 67.701 ns/op 0.65
Return object 10000 times 0.23560 ns/op 0.35730 ns/op 0.66
Throw Error 10000 times 4.1189 us/op 5.3407 us/op 0.77
fastMsgIdFn sha256 / 200 bytes 3.4190 us/op 4.2640 us/op 0.80
fastMsgIdFn h32 xxhash / 200 bytes 297.00 ns/op 370.00 ns/op 0.80
fastMsgIdFn h64 xxhash / 200 bytes 406.00 ns/op 573.00 ns/op 0.71
fastMsgIdFn sha256 / 1000 bytes 11.460 us/op 14.438 us/op 0.79
fastMsgIdFn h32 xxhash / 1000 bytes 420.00 ns/op 536.00 ns/op 0.78
fastMsgIdFn h64 xxhash / 1000 bytes 485.00 ns/op 624.00 ns/op 0.78
fastMsgIdFn sha256 / 10000 bytes 102.94 us/op 123.47 us/op 0.83
fastMsgIdFn h32 xxhash / 10000 bytes 1.9250 us/op 2.3350 us/op 0.82
fastMsgIdFn h64 xxhash / 10000 bytes 1.3590 us/op 1.7370 us/op 0.78
enrSubnets - fastDeserialize 64 bits 1.3020 us/op 2.1690 us/op 0.60
enrSubnets - ssz BitVector 64 bits 538.00 ns/op 743.00 ns/op 0.72
enrSubnets - fastDeserialize 4 bits 204.00 ns/op 303.00 ns/op 0.67
enrSubnets - ssz BitVector 4 bits 544.00 ns/op 748.00 ns/op 0.73
prioritizePeers score -10:0 att 32-0.1 sync 2-0 109.73 us/op 172.24 us/op 0.64
prioritizePeers score 0:0 att 32-0.25 sync 2-0.25 138.33 us/op 195.33 us/op 0.71
prioritizePeers score 0:0 att 32-0.5 sync 2-0.5 181.95 us/op 270.79 us/op 0.67
prioritizePeers score 0:0 att 64-0.75 sync 4-0.75 334.17 us/op 450.33 us/op 0.74
prioritizePeers score 0:0 att 64-1 sync 4-1 400.11 us/op 533.13 us/op 0.75
array of 16000 items push then shift 1.7091 us/op 2.0507 us/op 0.83
LinkedList of 16000 items push then shift 9.0820 ns/op 11.399 ns/op 0.80
array of 16000 items push then pop 116.85 ns/op 151.83 ns/op 0.77
LinkedList of 16000 items push then pop 8.8630 ns/op 10.924 ns/op 0.81
array of 24000 items push then shift 2.4026 us/op 2.9843 us/op 0.81
LinkedList of 24000 items push then shift 9.1810 ns/op 12.233 ns/op 0.75
array of 24000 items push then pop 75.872 ns/op 108.83 ns/op 0.70
LinkedList of 24000 items push then pop 8.6130 ns/op 10.954 ns/op 0.79
intersect bitArray bitLen 8 13.307 ns/op 16.176 ns/op 0.82
intersect array and set length 8 79.491 ns/op 134.98 ns/op 0.59
intersect bitArray bitLen 128 44.225 ns/op 58.049 ns/op 0.76
intersect array and set length 128 1.0906 us/op 1.5862 us/op 0.69
Buffer.concat 32 items 2.6420 us/op 3.8910 us/op 0.68
Uint8Array.set 32 items 2.1210 us/op 2.8090 us/op 0.76
pass gossip attestations to forkchoice per slot 2.3232 ms/op 2.7248 ms/op 0.85
computeDeltas 2.9883 ms/op 3.6714 ms/op 0.81
computeProposerBoostScoreFromBalances 1.8166 ms/op 2.1276 ms/op 0.85
altair processAttestation - 250000 vs - 7PWei normalcase 2.6327 ms/op 3.9938 ms/op 0.66
altair processAttestation - 250000 vs - 7PWei worstcase 3.4349 ms/op 5.2470 ms/op 0.65
altair processAttestation - setStatus - 1/6 committees join 144.04 us/op 179.34 us/op 0.80
altair processAttestation - setStatus - 1/3 committees join 297.91 us/op 398.57 us/op 0.75
altair processAttestation - setStatus - 1/2 committees join 377.76 us/op 450.41 us/op 0.84
altair processAttestation - setStatus - 2/3 committees join 477.70 us/op 578.47 us/op 0.83
altair processAttestation - setStatus - 4/5 committees join 681.80 us/op 808.57 us/op 0.84
altair processAttestation - setStatus - 100% committees join 772.58 us/op 917.01 us/op 0.84
altair processBlock - 250000 vs - 7PWei normalcase 15.817 ms/op 24.276 ms/op 0.65
altair processBlock - 250000 vs - 7PWei normalcase hashState 26.135 ms/op 33.777 ms/op 0.77
altair processBlock - 250000 vs - 7PWei worstcase 48.775 ms/op 69.976 ms/op 0.70
altair processBlock - 250000 vs - 7PWei worstcase hashState 71.170 ms/op 89.135 ms/op 0.80
phase0 processBlock - 250000 vs - 7PWei normalcase 2.0754 ms/op 3.1415 ms/op 0.66
phase0 processBlock - 250000 vs - 7PWei worstcase 28.426 ms/op 37.818 ms/op 0.75
altair processEth1Data - 250000 vs - 7PWei normalcase 516.73 us/op 764.14 us/op 0.68
vc - 250000 eb 1 eth1 1 we 0 wn 0 - smpl 15 8.1130 us/op 14.945 us/op 0.54
vc - 250000 eb 0.95 eth1 0.1 we 0.05 wn 0 - smpl 219 27.287 us/op 35.768 us/op 0.76
vc - 250000 eb 0.95 eth1 0.3 we 0.05 wn 0 - smpl 42 9.7930 us/op 16.093 us/op 0.61
vc - 250000 eb 0.95 eth1 0.7 we 0.05 wn 0 - smpl 18 9.7990 us/op 15.072 us/op 0.65
vc - 250000 eb 0.1 eth1 0.1 we 0 wn 0 - smpl 1020 114.39 us/op 121.80 us/op 0.94
vc - 250000 eb 0.03 eth1 0.03 we 0 wn 0 - smpl 11777 658.76 us/op 957.87 us/op 0.69
vc - 250000 eb 0.01 eth1 0.01 we 0 wn 0 - smpl 16384 918.12 us/op 1.3409 ms/op 0.68
vc - 250000 eb 0 eth1 0 we 0 wn 0 - smpl 16384 906.83 us/op 1.4323 ms/op 0.63
vc - 250000 eb 0 eth1 0 we 0 wn 0 nocache - smpl 16384 2.3788 ms/op 5.6513 ms/op 0.42
vc - 250000 eb 0 eth1 1 we 0 wn 0 - smpl 16384 1.5314 ms/op 2.6128 ms/op 0.59
vc - 250000 eb 0 eth1 1 we 0 wn 0 nocache - smpl 16384 4.3396 ms/op 6.0212 ms/op 0.72
Tree 40 250000 create 338.98 ms/op 673.22 ms/op 0.50
Tree 40 250000 get(125000) 196.29 ns/op 224.16 ns/op 0.88
Tree 40 250000 set(125000) 1.0229 us/op 2.0276 us/op 0.50
Tree 40 250000 toArray() 20.966 ms/op 28.761 ms/op 0.73
Tree 40 250000 iterate all - toArray() + loop 23.396 ms/op 29.040 ms/op 0.81
Tree 40 250000 iterate all - get(i) 77.478 ms/op 92.254 ms/op 0.84
MutableVector 250000 create 10.856 ms/op 15.534 ms/op 0.70
MutableVector 250000 get(125000) 6.4650 ns/op 8.2150 ns/op 0.79
MutableVector 250000 set(125000) 264.73 ns/op 448.91 ns/op 0.59
MutableVector 250000 toArray() 2.7722 ms/op 4.3719 ms/op 0.63
MutableVector 250000 iterate all - toArray() + loop 2.8420 ms/op 4.7981 ms/op 0.59
MutableVector 250000 iterate all - get(i) 1.5129 ms/op 1.9329 ms/op 0.78
Array 250000 create 2.6549 ms/op 4.0928 ms/op 0.65
Array 250000 clone - spread 1.2081 ms/op 1.7571 ms/op 0.69
Array 250000 get(125000) 0.60400 ns/op 1.1270 ns/op 0.54
Array 250000 set(125000) 0.69900 ns/op 1.1710 ns/op 0.60
Array 250000 iterate all - loop 84.196 us/op 105.17 us/op 0.80
effectiveBalanceIncrements clone Uint8Array 300000 36.448 us/op 54.873 us/op 0.66
effectiveBalanceIncrements clone MutableVector 300000 413.00 ns/op 607.00 ns/op 0.68
effectiveBalanceIncrements rw all Uint8Array 300000 170.47 us/op 215.14 us/op 0.79
effectiveBalanceIncrements rw all MutableVector 300000 89.740 ms/op 162.26 ms/op 0.55
phase0 afterProcessEpoch - 250000 vs - 7PWei 121.48 ms/op 142.08 ms/op 0.85
phase0 beforeProcessEpoch - 250000 vs - 7PWei 38.219 ms/op 53.120 ms/op 0.72
altair processEpoch - mainnet_e81889 313.10 ms/op 411.03 ms/op 0.76
mainnet_e81889 - altair beforeProcessEpoch 49.668 ms/op 78.300 ms/op 0.63
mainnet_e81889 - altair processJustificationAndFinalization 19.447 us/op 40.498 us/op 0.48
mainnet_e81889 - altair processInactivityUpdates 5.1825 ms/op 7.4149 ms/op 0.70
mainnet_e81889 - altair processRewardsAndPenalties 55.924 ms/op 63.105 ms/op 0.89
mainnet_e81889 - altair processRegistryUpdates 2.7520 us/op 9.3600 us/op 0.29
mainnet_e81889 - altair processSlashings 606.00 ns/op 1.3800 us/op 0.44
mainnet_e81889 - altair processEth1DataReset 719.00 ns/op 1.4980 us/op 0.48
mainnet_e81889 - altair processEffectiveBalanceUpdates 1.2716 ms/op 1.6237 ms/op 0.78
mainnet_e81889 - altair processSlashingsReset 4.4540 us/op 9.9720 us/op 0.45
mainnet_e81889 - altair processRandaoMixesReset 9.3580 us/op 16.576 us/op 0.56
mainnet_e81889 - altair processHistoricalRootsUpdate 1.1230 us/op 2.3290 us/op 0.48
mainnet_e81889 - altair processParticipationFlagUpdates 4.2960 us/op 8.0780 us/op 0.53
mainnet_e81889 - altair processSyncCommitteeUpdates 1.1080 us/op 1.5780 us/op 0.70
mainnet_e81889 - altair afterProcessEpoch 133.95 ms/op 160.24 ms/op 0.84
phase0 processEpoch - mainnet_e58758 427.43 ms/op 460.68 ms/op 0.93
mainnet_e58758 - phase0 beforeProcessEpoch 170.17 ms/op 173.44 ms/op 0.98
mainnet_e58758 - phase0 processJustificationAndFinalization 26.233 us/op 30.920 us/op 0.85
mainnet_e58758 - phase0 processRewardsAndPenalties 74.701 ms/op 85.326 ms/op 0.88
mainnet_e58758 - phase0 processRegistryUpdates 14.455 us/op 19.683 us/op 0.73
mainnet_e58758 - phase0 processSlashings 1.1340 us/op 1.6680 us/op 0.68
mainnet_e58758 - phase0 processEth1DataReset 1.3350 us/op 1.5570 us/op 0.86
mainnet_e58758 - phase0 processEffectiveBalanceUpdates 1.7732 ms/op 1.9082 ms/op 0.93
mainnet_e58758 - phase0 processSlashingsReset 5.4190 us/op 10.700 us/op 0.51
mainnet_e58758 - phase0 processRandaoMixesReset 7.3900 us/op 14.635 us/op 0.50
mainnet_e58758 - phase0 processHistoricalRootsUpdate 1.1690 us/op 2.3390 us/op 0.50
mainnet_e58758 - phase0 processParticipationRecordUpdates 4.7620 us/op 13.162 us/op 0.36
mainnet_e58758 - phase0 afterProcessEpoch 105.97 ms/op 125.46 ms/op 0.84
phase0 processEffectiveBalanceUpdates - 250000 normalcase 1.3629 ms/op 1.4674 ms/op 0.93
phase0 processEffectiveBalanceUpdates - 250000 worstcase 0.5 1.5548 ms/op 1.8685 ms/op 0.83
altair processInactivityUpdates - 250000 normalcase 25.580 ms/op 38.433 ms/op 0.67
altair processInactivityUpdates - 250000 worstcase 26.499 ms/op 33.540 ms/op 0.79
phase0 processRegistryUpdates - 250000 normalcase 9.9640 us/op 17.513 us/op 0.57
phase0 processRegistryUpdates - 250000 badcase_full_deposits 284.58 us/op 460.76 us/op 0.62
phase0 processRegistryUpdates - 250000 worstcase 0.5 126.45 ms/op 189.19 ms/op 0.67
altair processRewardsAndPenalties - 250000 normalcase 68.618 ms/op 86.895 ms/op 0.79
altair processRewardsAndPenalties - 250000 worstcase 73.467 ms/op 94.281 ms/op 0.78
phase0 getAttestationDeltas - 250000 normalcase 6.9904 ms/op 10.286 ms/op 0.68
phase0 getAttestationDeltas - 250000 worstcase 7.1291 ms/op 10.931 ms/op 0.65
phase0 processSlashings - 250000 worstcase 3.7179 ms/op 5.0217 ms/op 0.74
altair processSyncCommitteeUpdates - 250000 190.32 ms/op 248.62 ms/op 0.77
BeaconState.hashTreeRoot - No change 324.00 ns/op 553.00 ns/op 0.59
BeaconState.hashTreeRoot - 1 full validator 53.504 us/op 69.871 us/op 0.77
BeaconState.hashTreeRoot - 32 full validator 537.53 us/op 724.42 us/op 0.74
BeaconState.hashTreeRoot - 512 full validator 5.9219 ms/op 8.1222 ms/op 0.73
BeaconState.hashTreeRoot - 1 validator.effectiveBalance 64.260 us/op 83.010 us/op 0.77
BeaconState.hashTreeRoot - 32 validator.effectiveBalance 1.0182 ms/op 1.3106 ms/op 0.78
BeaconState.hashTreeRoot - 512 validator.effectiveBalance 12.177 ms/op 19.339 ms/op 0.63
BeaconState.hashTreeRoot - 1 balances 51.891 us/op 64.210 us/op 0.81
BeaconState.hashTreeRoot - 32 balances 493.62 us/op 589.52 us/op 0.84
BeaconState.hashTreeRoot - 512 balances 4.5528 ms/op 6.6093 ms/op 0.69
BeaconState.hashTreeRoot - 250000 balances 77.576 ms/op 99.784 ms/op 0.78
aggregationBits - 2048 els - zipIndexesInBitList 21.964 us/op 28.983 us/op 0.76
regular array get 100000 times 33.963 us/op 51.271 us/op 0.66
wrappedArray get 100000 times 33.907 us/op 42.717 us/op 0.79
arrayWithProxy get 100000 times 17.005 ms/op 21.611 ms/op 0.79
ssz.Root.equals 606.00 ns/op 746.00 ns/op 0.81
byteArrayEquals 607.00 ns/op 686.00 ns/op 0.88
shuffle list - 16384 els 7.1062 ms/op 8.5471 ms/op 0.83
shuffle list - 250000 els 104.54 ms/op 131.87 ms/op 0.79
processSlot - 1 slots 9.9050 us/op 14.063 us/op 0.70
processSlot - 32 slots 1.5016 ms/op 2.0534 ms/op 0.73
getEffectiveBalanceIncrementsZeroInactive - 250000 vs - 7PWei 224.07 us/op 256.13 us/op 0.87
getCommitteeAssignments - req 1 vs - 250000 vc 3.1628 ms/op 3.5672 ms/op 0.89
getCommitteeAssignments - req 100 vs - 250000 vc 4.1909 ms/op 5.1490 ms/op 0.81
getCommitteeAssignments - req 1000 vs - 250000 vc 4.5609 ms/op 5.5448 ms/op 0.82
RootCache.getBlockRootAtSlot - 250000 vs - 7PWei 5.2800 ns/op 5.9100 ns/op 0.89
state getBlockRootAtSlot - 250000 vs - 7PWei 1.2033 us/op 891.75 ns/op 1.35
computeProposers - vc 250000 11.552 ms/op 17.145 ms/op 0.67
computeEpochShuffling - vc 250000 107.08 ms/op 135.28 ms/op 0.79
getNextSyncCommittee - vc 250000 174.59 ms/op 235.70 ms/op 0.74

by benchmarkbot/action

@g11tech g11tech merged commit acf3d98 into unstable Mar 14, 2023
@g11tech g11tech deleted the philknows/docs-quickstart branch March 14, 2023 18:04
@wemeetagain
Copy link
Member

🎉 This PR is included in v1.7.0 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@g11tech g11tech g11tech approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@philknows @wemeetagain @g11tech