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: update instructions on how to contribute to dashboards #5581

Merged
merged 2 commits into from
May 30, 2023
Merged

docs: update instructions on how to contribute to dashboards #5581

merged 2 commits into from
May 30, 2023

Conversation

nflaig
Copy link
Member

@nflaig nflaig commented May 30, 2023

Motivation

Closes #5534

Description

Update CONTRIBUTING.md to reflect new workflow on how to contribute to dashboards.

Follow up to

@nflaig nflaig requested a review from a team as a code owner May 30, 2023 11:00
@nflaig nflaig force-pushed the nflaig/document-new-dashboard-workflow branch from ebc9edb to 5197f69 Compare May 30, 2023 11:09
@github-actions
Copy link
Contributor

Performance Report

✔️ no performance regression detected

Full benchmark results
Benchmark suite Current: 19a25d3 Previous: 8490369 Ratio
getPubkeys - index2pubkey - req 1000 vs - 250000 vc 611.02 us/op 497.32 us/op 1.23
getPubkeys - validatorsArr - req 1000 vs - 250000 vc 63.177 us/op 45.225 us/op 1.40
BLS verify - blst-native 1.2982 ms/op 1.1990 ms/op 1.08
BLS verifyMultipleSignatures 3 - blst-native 2.6244 ms/op 2.4431 ms/op 1.07
BLS verifyMultipleSignatures 8 - blst-native 5.6652 ms/op 5.2412 ms/op 1.08
BLS verifyMultipleSignatures 32 - blst-native 20.696 ms/op 19.026 ms/op 1.09
BLS aggregatePubkeys 32 - blst-native 27.351 us/op 25.494 us/op 1.07
BLS aggregatePubkeys 128 - blst-native 107.35 us/op 99.038 us/op 1.08
getAttestationsForBlock 77.977 ms/op 60.243 ms/op 1.29
isKnown best case - 1 super set check 278.00 ns/op 263.00 ns/op 1.06
isKnown normal case - 2 super set checks 266.00 ns/op 263.00 ns/op 1.01
isKnown worse case - 16 super set checks 277.00 ns/op 260.00 ns/op 1.07
CheckpointStateCache - add get delete 6.2330 us/op 5.7350 us/op 1.09
validate gossip signedAggregateAndProof - struct 2.9312 ms/op 2.7782 ms/op 1.06
validate gossip attestation - struct 1.3977 ms/op 1.3178 ms/op 1.06
pickEth1Vote - no votes 1.4660 ms/op 1.3828 ms/op 1.06
pickEth1Vote - max votes 14.773 ms/op 10.783 ms/op 1.37
pickEth1Vote - Eth1Data hashTreeRoot value x2048 10.995 ms/op 9.8935 ms/op 1.11
pickEth1Vote - Eth1Data hashTreeRoot tree x2048 19.209 ms/op 16.273 ms/op 1.18
pickEth1Vote - Eth1Data fastSerialize value x2048 837.42 us/op 741.19 us/op 1.13
pickEth1Vote - Eth1Data fastSerialize tree x2048 8.8673 ms/op 5.7572 ms/op 1.54
bytes32 toHexString 802.00 ns/op 703.00 ns/op 1.14
bytes32 Buffer.toString(hex) 489.00 ns/op 429.00 ns/op 1.14
bytes32 Buffer.toString(hex) from Uint8Array 691.00 ns/op 613.00 ns/op 1.13
bytes32 Buffer.toString(hex) + 0x 415.00 ns/op 427.00 ns/op 0.97
Object access 1 prop 0.18500 ns/op 0.20400 ns/op 0.91
Map access 1 prop 0.17400 ns/op 0.16600 ns/op 1.05
Object get x1000 6.9300 ns/op 6.7580 ns/op 1.03
Map get x1000 0.61200 ns/op 0.61500 ns/op 1.00
Object set x1000 61.725 ns/op 68.331 ns/op 0.90
Map set x1000 54.217 ns/op 54.340 ns/op 1.00
Return object 10000 times 0.26070 ns/op 0.24640 ns/op 1.06
Throw Error 10000 times 4.5067 us/op 4.3296 us/op 1.04
fastMsgIdFn sha256 / 200 bytes 3.6710 us/op 3.5840 us/op 1.02
fastMsgIdFn h32 xxhash / 200 bytes 330.00 ns/op 328.00 ns/op 1.01
fastMsgIdFn h64 xxhash / 200 bytes 492.00 ns/op 479.00 ns/op 1.03
fastMsgIdFn sha256 / 1000 bytes 12.676 us/op 11.847 us/op 1.07
fastMsgIdFn h32 xxhash / 1000 bytes 472.00 ns/op 465.00 ns/op 1.02
fastMsgIdFn h64 xxhash / 1000 bytes 580.00 ns/op 570.00 ns/op 1.02
fastMsgIdFn sha256 / 10000 bytes 108.59 us/op 104.38 us/op 1.04
fastMsgIdFn h32 xxhash / 10000 bytes 2.0580 us/op 1.9990 us/op 1.03
fastMsgIdFn h64 xxhash / 10000 bytes 1.5290 us/op 1.4680 us/op 1.04
enrSubnets - fastDeserialize 64 bits 1.7590 us/op 1.7630 us/op 1.00
enrSubnets - ssz BitVector 64 bits 653.00 ns/op 640.00 ns/op 1.02
enrSubnets - fastDeserialize 4 bits 210.00 ns/op 215.00 ns/op 0.98
enrSubnets - ssz BitVector 4 bits 645.00 ns/op 641.00 ns/op 1.01
prioritizePeers score -10:0 att 32-0.1 sync 2-0 135.33 us/op 116.91 us/op 1.16
prioritizePeers score 0:0 att 32-0.25 sync 2-0.25 164.50 us/op 164.50 us/op 1.00
prioritizePeers score 0:0 att 32-0.5 sync 2-0.5 207.22 us/op 197.32 us/op 1.05
prioritizePeers score 0:0 att 64-0.75 sync 4-0.75 381.33 us/op 375.24 us/op 1.02
prioritizePeers score 0:0 att 64-1 sync 4-1 441.40 us/op 454.58 us/op 0.97
array of 16000 items push then shift 1.7970 us/op 1.6856 us/op 1.07
LinkedList of 16000 items push then shift 9.5830 ns/op 9.5600 ns/op 1.00
array of 16000 items push then pop 119.31 ns/op 120.49 ns/op 0.99
LinkedList of 16000 items push then pop 9.7350 ns/op 9.1090 ns/op 1.07
array of 24000 items push then shift 2.5000 us/op 2.3736 us/op 1.05
LinkedList of 24000 items push then shift 9.7690 ns/op 9.5760 ns/op 1.02
array of 24000 items push then pop 104.58 ns/op 94.468 ns/op 1.11
LinkedList of 24000 items push then pop 10.107 ns/op 9.0590 ns/op 1.12
intersect bitArray bitLen 8 17.726 ns/op 13.504 ns/op 1.31
intersect array and set length 8 115.65 ns/op 105.85 ns/op 1.09
intersect bitArray bitLen 128 49.936 ns/op 45.217 ns/op 1.10
intersect array and set length 128 1.3161 us/op 1.3050 us/op 1.01
Buffer.concat 32 items 3.2420 us/op 3.0030 us/op 1.08
Uint8Array.set 32 items 3.2290 us/op 2.4150 us/op 1.34
transfer serialized Status (84 B) 2.3150 us/op 2.2580 us/op 1.03
copy serialized Status (84 B) 1.8570 us/op 1.9210 us/op 0.97
transfer serialized SignedVoluntaryExit (112 B) 2.2470 us/op 2.4960 us/op 0.90
copy serialized SignedVoluntaryExit (112 B) 1.9920 us/op 1.9640 us/op 1.01
transfer serialized ProposerSlashing (416 B) 2.6450 us/op 2.9260 us/op 0.90
copy serialized ProposerSlashing (416 B) 2.9650 us/op 3.2060 us/op 0.92
transfer serialized Attestation (485 B) 2.8220 us/op 3.3390 us/op 0.85
copy serialized Attestation (485 B) 2.7680 us/op 3.1090 us/op 0.89
transfer serialized AttesterSlashing (33232 B) 2.9170 us/op 2.8370 us/op 1.03
copy serialized AttesterSlashing (33232 B) 7.7810 us/op 8.9810 us/op 0.87
transfer serialized Small SignedBeaconBlock (128000 B) 3.0790 us/op 3.6780 us/op 0.84
copy serialized Small SignedBeaconBlock (128000 B) 17.657 us/op 32.235 us/op 0.55
transfer serialized Avg SignedBeaconBlock (200000 B) 3.7630 us/op 3.6390 us/op 1.03
copy serialized Avg SignedBeaconBlock (200000 B) 70.210 us/op 32.741 us/op 2.14
transfer serialized BlobsSidecar (524380 B) 3.5510 us/op 3.9790 us/op 0.89
copy serialized BlobsSidecar (524380 B) 180.51 us/op 213.59 us/op 0.85
transfer serialized Big SignedBeaconBlock (1000000 B) 4.5370 us/op 3.9490 us/op 1.15
copy serialized Big SignedBeaconBlock (1000000 B) 293.51 us/op 366.68 us/op 0.80
pass gossip attestations to forkchoice per slot 2.3689 ms/op 2.4138 ms/op 0.98
computeDeltas 3.0894 ms/op 3.1568 ms/op 0.98
computeProposerBoostScoreFromBalances 1.8246 ms/op 1.7702 ms/op 1.03
altair processAttestation - 250000 vs - 7PWei normalcase 2.7632 ms/op 2.3706 ms/op 1.17
altair processAttestation - 250000 vs - 7PWei worstcase 4.3681 ms/op 3.3652 ms/op 1.30
altair processAttestation - setStatus - 1/6 committees join 144.59 us/op 140.85 us/op 1.03
altair processAttestation - setStatus - 1/3 committees join 284.97 us/op 284.81 us/op 1.00
altair processAttestation - setStatus - 1/2 committees join 382.97 us/op 369.74 us/op 1.04
altair processAttestation - setStatus - 2/3 committees join 491.38 us/op 458.18 us/op 1.07
altair processAttestation - setStatus - 4/5 committees join 692.45 us/op 661.12 us/op 1.05
altair processAttestation - setStatus - 100% committees join 798.81 us/op 745.14 us/op 1.07
altair processBlock - 250000 vs - 7PWei normalcase 17.700 ms/op 14.458 ms/op 1.22
altair processBlock - 250000 vs - 7PWei normalcase hashState 29.157 ms/op 25.233 ms/op 1.16
altair processBlock - 250000 vs - 7PWei worstcase 54.765 ms/op 46.349 ms/op 1.18
altair processBlock - 250000 vs - 7PWei worstcase hashState 76.673 ms/op 68.550 ms/op 1.12
phase0 processBlock - 250000 vs - 7PWei normalcase 2.2495 ms/op 2.3659 ms/op 0.95
phase0 processBlock - 250000 vs - 7PWei worstcase 30.184 ms/op 29.189 ms/op 1.03
altair processEth1Data - 250000 vs - 7PWei normalcase 505.44 us/op 487.47 us/op 1.04
getExpectedWithdrawals 250000 eb:1,eth1:1,we:0,wn:0,smpl:15 9.2470 us/op 7.7250 us/op 1.20
getExpectedWithdrawals 250000 eb:0.95,eth1:0.1,we:0.05,wn:0,smpl:219 30.338 us/op 22.694 us/op 1.34
getExpectedWithdrawals 250000 eb:0.95,eth1:0.3,we:0.05,wn:0,smpl:42 11.633 us/op 9.0060 us/op 1.29
getExpectedWithdrawals 250000 eb:0.95,eth1:0.7,we:0.05,wn:0,smpl:18 10.887 us/op 6.9600 us/op 1.56
getExpectedWithdrawals 250000 eb:0.1,eth1:0.1,we:0,wn:0,smpl:1020 119.05 us/op 90.176 us/op 1.32
getExpectedWithdrawals 250000 eb:0.03,eth1:0.03,we:0,wn:0,smpl:11777 670.25 us/op 626.61 us/op 1.07
getExpectedWithdrawals 250000 eb:0.01,eth1:0.01,we:0,wn:0,smpl:16384 991.37 us/op 896.49 us/op 1.11
getExpectedWithdrawals 250000 eb:0,eth1:0,we:0,wn:0,smpl:16384 937.61 us/op 868.37 us/op 1.08
getExpectedWithdrawals 250000 eb:0,eth1:0,we:0,wn:0,nocache,smpl:16384 2.3869 ms/op 2.1902 ms/op 1.09
getExpectedWithdrawals 250000 eb:0,eth1:1,we:0,wn:0,smpl:16384 1.6761 ms/op 1.4941 ms/op 1.12
getExpectedWithdrawals 250000 eb:0,eth1:1,we:0,wn:0,nocache,smpl:16384 3.9256 ms/op 4.1218 ms/op 0.95
Tree 40 250000 create 361.70 ms/op 309.05 ms/op 1.17
Tree 40 250000 get(125000) 195.66 ns/op 176.44 ns/op 1.11
Tree 40 250000 set(125000) 951.45 ns/op 892.00 ns/op 1.07
Tree 40 250000 toArray() 21.644 ms/op 17.256 ms/op 1.25
Tree 40 250000 iterate all - toArray() + loop 22.253 ms/op 17.051 ms/op 1.31
Tree 40 250000 iterate all - get(i) 76.531 ms/op 65.847 ms/op 1.16
MutableVector 250000 create 12.204 ms/op 10.563 ms/op 1.16
MutableVector 250000 get(125000) 6.9200 ns/op 6.2540 ns/op 1.11
MutableVector 250000 set(125000) 259.57 ns/op 278.05 ns/op 0.93
MutableVector 250000 toArray() 3.7052 ms/op 3.0332 ms/op 1.22
MutableVector 250000 iterate all - toArray() + loop 3.8946 ms/op 2.8428 ms/op 1.37
MutableVector 250000 iterate all - get(i) 1.7382 ms/op 1.5162 ms/op 1.15
Array 250000 create 3.4777 ms/op 2.5604 ms/op 1.36
Array 250000 clone - spread 1.1687 ms/op 1.1122 ms/op 1.05
Array 250000 get(125000) 0.60800 ns/op 0.56100 ns/op 1.08
Array 250000 set(125000) 0.68600 ns/op 0.63000 ns/op 1.09
Array 250000 iterate all - loop 91.759 us/op 110.25 us/op 0.83
effectiveBalanceIncrements clone Uint8Array 300000 46.256 us/op 27.056 us/op 1.71
effectiveBalanceIncrements clone MutableVector 300000 372.00 ns/op 345.00 ns/op 1.08
effectiveBalanceIncrements rw all Uint8Array 300000 177.02 us/op 168.05 us/op 1.05
effectiveBalanceIncrements rw all MutableVector 300000 91.152 ms/op 81.407 ms/op 1.12
phase0 afterProcessEpoch - 250000 vs - 7PWei 118.32 ms/op 114.35 ms/op 1.03
phase0 beforeProcessEpoch - 250000 vs - 7PWei 44.025 ms/op 41.838 ms/op 1.05
altair processEpoch - mainnet_e81889 339.58 ms/op 305.75 ms/op 1.11
mainnet_e81889 - altair beforeProcessEpoch 65.610 ms/op 69.173 ms/op 0.95
mainnet_e81889 - altair processJustificationAndFinalization 15.992 us/op 18.213 us/op 0.88
mainnet_e81889 - altair processInactivityUpdates 6.3487 ms/op 6.3750 ms/op 1.00
mainnet_e81889 - altair processRewardsAndPenalties 54.458 ms/op 52.945 ms/op 1.03
mainnet_e81889 - altair processRegistryUpdates 2.4250 us/op 3.6140 us/op 0.67
mainnet_e81889 - altair processSlashings 481.00 ns/op 498.00 ns/op 0.97
mainnet_e81889 - altair processEth1DataReset 591.00 ns/op 548.00 ns/op 1.08
mainnet_e81889 - altair processEffectiveBalanceUpdates 1.2716 ms/op 1.2494 ms/op 1.02
mainnet_e81889 - altair processSlashingsReset 4.4510 us/op 4.7570 us/op 0.94
mainnet_e81889 - altair processRandaoMixesReset 4.3640 us/op 4.5270 us/op 0.96
mainnet_e81889 - altair processHistoricalRootsUpdate 694.00 ns/op 613.00 ns/op 1.13
mainnet_e81889 - altair processParticipationFlagUpdates 4.4350 us/op 2.4380 us/op 1.82
mainnet_e81889 - altair processSyncCommitteeUpdates 497.00 ns/op 880.00 ns/op 0.56
mainnet_e81889 - altair afterProcessEpoch 129.78 ms/op 126.56 ms/op 1.03
phase0 processEpoch - mainnet_e58758 376.13 ms/op 357.97 ms/op 1.05
mainnet_e58758 - phase0 beforeProcessEpoch 144.90 ms/op 140.42 ms/op 1.03
mainnet_e58758 - phase0 processJustificationAndFinalization 17.266 us/op 17.104 us/op 1.01
mainnet_e58758 - phase0 processRewardsAndPenalties 64.012 ms/op 65.821 ms/op 0.97
mainnet_e58758 - phase0 processRegistryUpdates 8.2300 us/op 8.0200 us/op 1.03
mainnet_e58758 - phase0 processSlashings 617.00 ns/op 489.00 ns/op 1.26
mainnet_e58758 - phase0 processEth1DataReset 676.00 ns/op 494.00 ns/op 1.37
mainnet_e58758 - phase0 processEffectiveBalanceUpdates 1.0494 ms/op 1.0617 ms/op 0.99
mainnet_e58758 - phase0 processSlashingsReset 4.4990 us/op 3.3670 us/op 1.34
mainnet_e58758 - phase0 processRandaoMixesReset 4.0090 us/op 4.4460 us/op 0.90
mainnet_e58758 - phase0 processHistoricalRootsUpdate 736.00 ns/op 588.00 ns/op 1.25
mainnet_e58758 - phase0 processParticipationRecordUpdates 4.5100 us/op 3.8130 us/op 1.18
mainnet_e58758 - phase0 afterProcessEpoch 102.43 ms/op 97.858 ms/op 1.05
phase0 processEffectiveBalanceUpdates - 250000 normalcase 1.2819 ms/op 1.2303 ms/op 1.04
phase0 processEffectiveBalanceUpdates - 250000 worstcase 0.5 1.6546 ms/op 1.5625 ms/op 1.06
altair processInactivityUpdates - 250000 normalcase 27.104 ms/op 28.439 ms/op 0.95
altair processInactivityUpdates - 250000 worstcase 28.369 ms/op 29.266 ms/op 0.97
phase0 processRegistryUpdates - 250000 normalcase 7.7840 us/op 6.8990 us/op 1.13
phase0 processRegistryUpdates - 250000 badcase_full_deposits 272.17 us/op 268.72 us/op 1.01
phase0 processRegistryUpdates - 250000 worstcase 0.5 133.85 ms/op 130.13 ms/op 1.03
altair processRewardsAndPenalties - 250000 normalcase 69.806 ms/op 68.495 ms/op 1.02
altair processRewardsAndPenalties - 250000 worstcase 74.588 ms/op 72.642 ms/op 1.03
phase0 getAttestationDeltas - 250000 normalcase 7.1406 ms/op 6.8962 ms/op 1.04
phase0 getAttestationDeltas - 250000 worstcase 7.0650 ms/op 6.8561 ms/op 1.03
phase0 processSlashings - 250000 worstcase 3.6466 ms/op 3.5053 ms/op 1.04
altair processSyncCommitteeUpdates - 250000 194.78 ms/op 180.48 ms/op 1.08
BeaconState.hashTreeRoot - No change 279.00 ns/op 261.00 ns/op 1.07
BeaconState.hashTreeRoot - 1 full validator 54.540 us/op 52.156 us/op 1.05
BeaconState.hashTreeRoot - 32 full validator 519.38 us/op 474.31 us/op 1.10
BeaconState.hashTreeRoot - 512 full validator 5.9805 ms/op 5.7647 ms/op 1.04
BeaconState.hashTreeRoot - 1 validator.effectiveBalance 63.970 us/op 61.876 us/op 1.03
BeaconState.hashTreeRoot - 32 validator.effectiveBalance 983.91 us/op 899.15 us/op 1.09
BeaconState.hashTreeRoot - 512 validator.effectiveBalance 12.392 ms/op 11.172 ms/op 1.11
BeaconState.hashTreeRoot - 1 balances 51.985 us/op 50.700 us/op 1.03
BeaconState.hashTreeRoot - 32 balances 453.92 us/op 463.54 us/op 0.98
BeaconState.hashTreeRoot - 512 balances 4.7349 ms/op 4.1975 ms/op 1.13
BeaconState.hashTreeRoot - 250000 balances 77.910 ms/op 70.520 ms/op 1.10
aggregationBits - 2048 els - zipIndexesInBitList 18.222 us/op 16.839 us/op 1.08
regular array get 100000 times 33.631 us/op 32.601 us/op 1.03
wrappedArray get 100000 times 33.567 us/op 32.552 us/op 1.03
arrayWithProxy get 100000 times 17.501 ms/op 16.305 ms/op 1.07
ssz.Root.equals 576.00 ns/op 569.00 ns/op 1.01
byteArrayEquals 570.00 ns/op 546.00 ns/op 1.04
shuffle list - 16384 els 7.0975 ms/op 7.0448 ms/op 1.01
shuffle list - 250000 els 104.63 ms/op 99.512 ms/op 1.05
processSlot - 1 slots 9.9680 us/op 8.8070 us/op 1.13
processSlot - 32 slots 1.4440 ms/op 1.3720 ms/op 1.05
getEffectiveBalanceIncrementsZeroInactive - 250000 vs - 7PWei 37.136 ms/op 36.527 ms/op 1.02
getCommitteeAssignments - req 1 vs - 250000 vc 2.9841 ms/op 2.8883 ms/op 1.03
getCommitteeAssignments - req 100 vs - 250000 vc 4.2280 ms/op 4.0972 ms/op 1.03
getCommitteeAssignments - req 1000 vs - 250000 vc 4.6612 ms/op 4.3645 ms/op 1.07
RootCache.getBlockRootAtSlot - 250000 vs - 7PWei 5.1400 ns/op 4.7900 ns/op 1.07
state getBlockRootAtSlot - 250000 vs - 7PWei 708.91 ns/op 797.70 ns/op 0.89
computeProposers - vc 250000 11.170 ms/op 10.567 ms/op 1.06
computeEpochShuffling - vc 250000 106.22 ms/op 103.35 ms/op 1.03
getNextSyncCommittee - vc 250000 176.15 ms/op 172.99 ms/op 1.02
computeSigningRoot for AttestationData 12.904 us/op 12.757 us/op 1.01
hash AttestationData serialized data then Buffer.toString(base64) 2.5133 us/op 2.4535 us/op 1.02
toHexString serialized data 1.1246 us/op 1.0696 us/op 1.05
Buffer.toString(base64) 352.32 ns/op 319.15 ns/op 1.10

by benchmarkbot/action

@wemeetagain wemeetagain merged commit 0833757 into unstable May 30, 2023
@wemeetagain wemeetagain deleted the nflaig/document-new-dashboard-workflow branch May 30, 2023 14:26
@wemeetagain
Copy link
Member

🎉 This PR is included in v1.9.0 🎉

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

@wemeetagain wemeetagain wemeetagain 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.

Update CONTRIBUTING.md to reflect dashboard edit workflow
2 participants
@nflaig @wemeetagain