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: fix formatting of examples in PR naming section #5431

Merged
merged 1 commit into from
Apr 28, 2023
Merged

docs: fix formatting of examples in PR naming section #5431

merged 1 commit into from
Apr 28, 2023

Conversation

nflaig
Copy link
Member

@nflaig nflaig commented Apr 28, 2023

Motivation

Current formatting of examples
image

Description

Fix formatting, add fix: example

cc @philknows

@nflaig nflaig requested a review from a team as a code owner April 28, 2023 10:06
nflaig
nflaig commented Apr 28, 2023
View reviewed changes
CONTRIBUTING.md
@@ -103,8 +103,9 @@ Pull request titles must be:

For example:

> feat: add lodestar prover for execution api
> refactor(reqresp)!: support byte based handlers
- feat: add lodestar prover for execution api
Copy link
Member Author

Choose a reason for hiding this comment

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

Not sure if we should apply some highlighting via `` or similar. Decided it is best to just have bullet points with normal text

@github-actions
Copy link
Contributor

Performance Report

✔️ no performance regression detected

Full benchmark results
Benchmark suite Current: 4a85478 Previous: 34c2a2a Ratio
getPubkeys - index2pubkey - req 1000 vs - 250000 vc 840.96 us/op 934.87 us/op 0.90
getPubkeys - validatorsArr - req 1000 vs - 250000 vc 48.652 us/op 47.700 us/op 1.02
BLS verify - blst-native 1.3188 ms/op 1.2337 ms/op 1.07
BLS verifyMultipleSignatures 3 - blst-native 2.6764 ms/op 2.5253 ms/op 1.06
BLS verifyMultipleSignatures 8 - blst-native 5.7829 ms/op 5.4519 ms/op 1.06
BLS verifyMultipleSignatures 32 - blst-native 21.114 ms/op 19.364 ms/op 1.09
BLS aggregatePubkeys 32 - blst-native 27.411 us/op 26.558 us/op 1.03
BLS aggregatePubkeys 128 - blst-native 109.68 us/op 101.80 us/op 1.08
getAttestationsForBlock 63.823 ms/op 63.086 ms/op 1.01
isKnown best case - 1 super set check 297.00 ns/op 254.00 ns/op 1.17
isKnown normal case - 2 super set checks 288.00 ns/op 254.00 ns/op 1.13
isKnown worse case - 16 super set checks 313.00 ns/op 300.00 ns/op 1.04
CheckpointStateCache - add get delete 5.9310 us/op 5.4030 us/op 1.10
validate gossip signedAggregateAndProof - struct 3.3159 ms/op 2.7847 ms/op 1.19
validate gossip attestation - struct 1.5919 ms/op 1.3285 ms/op 1.20
pickEth1Vote - no votes 1.4090 ms/op 1.3223 ms/op 1.07
pickEth1Vote - max votes 9.8589 ms/op 9.1944 ms/op 1.07
pickEth1Vote - Eth1Data hashTreeRoot value x2048 9.3431 ms/op 9.1240 ms/op 1.02
pickEth1Vote - Eth1Data hashTreeRoot tree x2048 15.126 ms/op 19.567 ms/op 0.77
pickEth1Vote - Eth1Data fastSerialize value x2048 779.54 us/op 667.75 us/op 1.17
pickEth1Vote - Eth1Data fastSerialize tree x2048 8.7449 ms/op 7.5350 ms/op 1.16
bytes32 toHexString 603.00 ns/op 514.00 ns/op 1.17
bytes32 Buffer.toString(hex) 433.00 ns/op 372.00 ns/op 1.16
bytes32 Buffer.toString(hex) from Uint8Array 678.00 ns/op 587.00 ns/op 1.16
bytes32 Buffer.toString(hex) + 0x 454.00 ns/op 360.00 ns/op 1.26
Object access 1 prop 0.19000 ns/op 0.18300 ns/op 1.04
Map access 1 prop 0.18800 ns/op 0.18300 ns/op 1.03
Object get x1000 7.5400 ns/op 6.8170 ns/op 1.11
Map get x1000 0.70700 ns/op 0.56100 ns/op 1.26
Object set x1000 58.797 ns/op 54.912 ns/op 1.07
Map set x1000 49.022 ns/op 43.928 ns/op 1.12
Return object 10000 times 0.27400 ns/op 0.23820 ns/op 1.15
Throw Error 10000 times 4.7681 us/op 4.2645 us/op 1.12
fastMsgIdFn sha256 / 200 bytes 3.9460 us/op 3.5300 us/op 1.12
fastMsgIdFn h32 xxhash / 200 bytes 329.00 ns/op 290.00 ns/op 1.13
fastMsgIdFn h64 xxhash / 200 bytes 454.00 ns/op 419.00 ns/op 1.08
fastMsgIdFn sha256 / 1000 bytes 13.195 us/op 12.073 us/op 1.09
fastMsgIdFn h32 xxhash / 1000 bytes 464.00 ns/op 439.00 ns/op 1.06
fastMsgIdFn h64 xxhash / 1000 bytes 526.00 ns/op 520.00 ns/op 1.01
fastMsgIdFn sha256 / 10000 bytes 115.47 us/op 105.36 us/op 1.10
fastMsgIdFn h32 xxhash / 10000 bytes 2.1850 us/op 1.9830 us/op 1.10
fastMsgIdFn h64 xxhash / 10000 bytes 1.5240 us/op 1.4380 us/op 1.06
enrSubnets - fastDeserialize 64 bits 1.4110 us/op 1.3650 us/op 1.03
enrSubnets - ssz BitVector 64 bits 525.00 ns/op 582.00 ns/op 0.90
enrSubnets - fastDeserialize 4 bits 185.00 ns/op 187.00 ns/op 0.99
enrSubnets - ssz BitVector 4 bits 523.00 ns/op 566.00 ns/op 0.92
prioritizePeers score -10:0 att 32-0.1 sync 2-0 111.33 us/op 115.74 us/op 0.96
prioritizePeers score 0:0 att 32-0.25 sync 2-0.25 154.42 us/op 145.52 us/op 1.06
prioritizePeers score 0:0 att 32-0.5 sync 2-0.5 199.60 us/op 183.66 us/op 1.09
prioritizePeers score 0:0 att 64-0.75 sync 4-0.75 393.62 us/op 341.19 us/op 1.15
prioritizePeers score 0:0 att 64-1 sync 4-1 467.60 us/op 418.09 us/op 1.12
array of 16000 items push then shift 1.8747 us/op 1.6805 us/op 1.12
LinkedList of 16000 items push then shift 10.186 ns/op 9.1140 ns/op 1.12
array of 16000 items push then pop 128.48 ns/op 110.16 ns/op 1.17
LinkedList of 16000 items push then pop 10.213 ns/op 8.8470 ns/op 1.15
array of 24000 items push then shift 2.7584 us/op 2.4811 us/op 1.11
LinkedList of 24000 items push then shift 10.658 ns/op 10.902 ns/op 0.98
array of 24000 items push then pop 98.755 ns/op 82.851 ns/op 1.19
LinkedList of 24000 items push then pop 11.066 ns/op 8.7340 ns/op 1.27
intersect bitArray bitLen 8 16.873 ns/op 13.617 ns/op 1.24
intersect array and set length 8 126.76 ns/op 78.728 ns/op 1.61
intersect bitArray bitLen 128 57.436 ns/op 44.755 ns/op 1.28
intersect array and set length 128 1.5738 us/op 1.1009 us/op 1.43
Buffer.concat 32 items 3.9050 us/op 2.7390 us/op 1.43
Uint8Array.set 32 items 2.8640 us/op 3.2660 us/op 0.88
pass gossip attestations to forkchoice per slot 3.8057 ms/op 3.2985 ms/op 1.15
computeDeltas 3.5954 ms/op 3.0148 ms/op 1.19
computeProposerBoostScoreFromBalances 2.1124 ms/op 1.7954 ms/op 1.18
altair processAttestation - 250000 vs - 7PWei normalcase 2.7931 ms/op 2.4066 ms/op 1.16
altair processAttestation - 250000 vs - 7PWei worstcase 4.9346 ms/op 3.3506 ms/op 1.47
altair processAttestation - setStatus - 1/6 committees join 184.52 us/op 140.81 us/op 1.31
altair processAttestation - setStatus - 1/3 committees join 368.56 us/op 277.68 us/op 1.33
altair processAttestation - setStatus - 1/2 committees join 486.79 us/op 380.75 us/op 1.28
altair processAttestation - setStatus - 2/3 committees join 597.87 us/op 486.94 us/op 1.23
altair processAttestation - setStatus - 4/5 committees join 883.15 us/op 663.49 us/op 1.33
altair processAttestation - setStatus - 100% committees join 992.30 us/op 786.08 us/op 1.26
altair processBlock - 250000 vs - 7PWei normalcase 19.978 ms/op 21.781 ms/op 0.92
altair processBlock - 250000 vs - 7PWei normalcase hashState 31.737 ms/op 28.232 ms/op 1.12
altair processBlock - 250000 vs - 7PWei worstcase 60.131 ms/op 60.893 ms/op 0.99
altair processBlock - 250000 vs - 7PWei worstcase hashState 86.912 ms/op 80.593 ms/op 1.08
phase0 processBlock - 250000 vs - 7PWei normalcase 2.7245 ms/op 2.1725 ms/op 1.25
phase0 processBlock - 250000 vs - 7PWei worstcase 35.985 ms/op 31.197 ms/op 1.15
altair processEth1Data - 250000 vs - 7PWei normalcase 564.42 us/op 609.84 us/op 0.93
vc - 250000 eb 1 eth1 1 we 0 wn 0 - smpl 15 7.6870 us/op 9.0780 us/op 0.85
vc - 250000 eb 0.95 eth1 0.1 we 0.05 wn 0 - smpl 219 22.409 us/op 28.704 us/op 0.78
vc - 250000 eb 0.95 eth1 0.3 we 0.05 wn 0 - smpl 42 9.3800 us/op 11.447 us/op 0.82
vc - 250000 eb 0.95 eth1 0.7 we 0.05 wn 0 - smpl 18 7.1230 us/op 10.077 us/op 0.71
vc - 250000 eb 0.1 eth1 0.1 we 0 wn 0 - smpl 1020 111.15 us/op 106.10 us/op 1.05
vc - 250000 eb 0.03 eth1 0.03 we 0 wn 0 - smpl 11777 719.52 us/op 774.06 us/op 0.93
vc - 250000 eb 0.01 eth1 0.01 we 0 wn 0 - smpl 16384 937.55 us/op 1.0454 ms/op 0.90
vc - 250000 eb 0 eth1 0 we 0 wn 0 - smpl 16384 941.52 us/op 1.0474 ms/op 0.90
vc - 250000 eb 0 eth1 0 we 0 wn 0 nocache - smpl 16384 2.6806 ms/op 2.4149 ms/op 1.11
vc - 250000 eb 0 eth1 1 we 0 wn 0 - smpl 16384 1.7243 ms/op 1.7121 ms/op 1.01
vc - 250000 eb 0 eth1 1 we 0 wn 0 nocache - smpl 16384 4.5252 ms/op 4.1768 ms/op 1.08
Tree 40 250000 create 337.54 ms/op 357.01 ms/op 0.95
Tree 40 250000 get(125000) 212.73 ns/op 202.03 ns/op 1.05
Tree 40 250000 set(125000) 1.1016 us/op 1.1114 us/op 0.99
Tree 40 250000 toArray() 19.275 ms/op 23.487 ms/op 0.82
Tree 40 250000 iterate all - toArray() + loop 20.003 ms/op 24.506 ms/op 0.82
Tree 40 250000 iterate all - get(i) 82.465 ms/op 82.453 ms/op 1.00
MutableVector 250000 create 11.996 ms/op 14.577 ms/op 0.82
MutableVector 250000 get(125000) 8.0270 ns/op 6.7570 ns/op 1.19
MutableVector 250000 set(125000) 295.87 ns/op 291.42 ns/op 1.02
MutableVector 250000 toArray() 3.3521 ms/op 3.7932 ms/op 0.88
MutableVector 250000 iterate all - toArray() + loop 3.3648 ms/op 3.8637 ms/op 0.87
MutableVector 250000 iterate all - get(i) 1.9124 ms/op 1.5550 ms/op 1.23
Array 250000 create 3.1707 ms/op 2.6175 ms/op 1.21
Array 250000 clone - spread 1.3218 ms/op 1.1729 ms/op 1.13
Array 250000 get(125000) 0.69000 ns/op 0.60600 ns/op 1.14
Array 250000 set(125000) 0.78200 ns/op 0.68700 ns/op 1.14
Array 250000 iterate all - loop 106.23 us/op 84.290 us/op 1.26
effectiveBalanceIncrements clone Uint8Array 300000 33.625 us/op 42.907 us/op 0.78
effectiveBalanceIncrements clone MutableVector 300000 430.00 ns/op 374.00 ns/op 1.15
effectiveBalanceIncrements rw all Uint8Array 300000 217.29 us/op 172.96 us/op 1.26
effectiveBalanceIncrements rw all MutableVector 300000 103.55 ms/op 89.811 ms/op 1.15
phase0 afterProcessEpoch - 250000 vs - 7PWei 134.59 ms/op 122.10 ms/op 1.10
phase0 beforeProcessEpoch - 250000 vs - 7PWei 43.113 ms/op 49.081 ms/op 0.88
altair processEpoch - mainnet_e81889 362.01 ms/op 363.49 ms/op 1.00
mainnet_e81889 - altair beforeProcessEpoch 77.354 ms/op 66.685 ms/op 1.16
mainnet_e81889 - altair processJustificationAndFinalization 32.002 us/op 19.976 us/op 1.60
mainnet_e81889 - altair processInactivityUpdates 7.0623 ms/op 6.2323 ms/op 1.13
mainnet_e81889 - altair processRewardsAndPenalties 53.127 ms/op 63.987 ms/op 0.83
mainnet_e81889 - altair processRegistryUpdates 4.0040 us/op 2.9610 us/op 1.35
mainnet_e81889 - altair processSlashings 757.00 ns/op 630.00 ns/op 1.20
mainnet_e81889 - altair processEth1DataReset 519.00 ns/op 650.00 ns/op 0.80
mainnet_e81889 - altair processEffectiveBalanceUpdates 1.4590 ms/op 1.2780 ms/op 1.14
mainnet_e81889 - altair processSlashingsReset 5.7460 us/op 4.1560 us/op 1.38
mainnet_e81889 - altair processRandaoMixesReset 8.4830 us/op 4.8490 us/op 1.75
mainnet_e81889 - altair processHistoricalRootsUpdate 1.3050 us/op 1.2630 us/op 1.03
mainnet_e81889 - altair processParticipationFlagUpdates 4.3340 us/op 5.7470 us/op 0.75
mainnet_e81889 - altair processSyncCommitteeUpdates 1.0750 us/op 1.8570 us/op 0.58
mainnet_e81889 - altair afterProcessEpoch 168.66 ms/op 143.12 ms/op 1.18
phase0 processEpoch - mainnet_e58758 478.26 ms/op 399.19 ms/op 1.20
mainnet_e58758 - phase0 beforeProcessEpoch 162.16 ms/op 157.47 ms/op 1.03
mainnet_e58758 - phase0 processJustificationAndFinalization 18.260 us/op 28.031 us/op 0.65
mainnet_e58758 - phase0 processRewardsAndPenalties 51.226 ms/op 71.674 ms/op 0.71
mainnet_e58758 - phase0 processRegistryUpdates 9.4220 us/op 10.358 us/op 0.91
mainnet_e58758 - phase0 processSlashings 941.00 ns/op 510.00 ns/op 1.85
mainnet_e58758 - phase0 processEth1DataReset 614.00 ns/op 599.00 ns/op 1.03
mainnet_e58758 - phase0 processEffectiveBalanceUpdates 1.2445 ms/op 1.2391 ms/op 1.00
mainnet_e58758 - phase0 processSlashingsReset 5.2790 us/op 4.3950 us/op 1.20
mainnet_e58758 - phase0 processRandaoMixesReset 8.1140 us/op 5.3650 us/op 1.51
mainnet_e58758 - phase0 processHistoricalRootsUpdate 1.0550 us/op 827.00 ns/op 1.28
mainnet_e58758 - phase0 processParticipationRecordUpdates 11.385 us/op 8.3390 us/op 1.37
mainnet_e58758 - phase0 afterProcessEpoch 155.46 ms/op 105.22 ms/op 1.48
phase0 processEffectiveBalanceUpdates - 250000 normalcase 1.6478 ms/op 1.5190 ms/op 1.08
phase0 processEffectiveBalanceUpdates - 250000 worstcase 0.5 2.0063 ms/op 2.1079 ms/op 0.95
altair processInactivityUpdates - 250000 normalcase 25.770 ms/op 34.695 ms/op 0.74
altair processInactivityUpdates - 250000 worstcase 31.129 ms/op 33.263 ms/op 0.94
phase0 processRegistryUpdates - 250000 normalcase 7.7210 us/op 11.549 us/op 0.67
phase0 processRegistryUpdates - 250000 badcase_full_deposits 285.03 us/op 347.54 us/op 0.82
phase0 processRegistryUpdates - 250000 worstcase 0.5 148.62 ms/op 156.56 ms/op 0.95
altair processRewardsAndPenalties - 250000 normalcase 76.324 ms/op 72.236 ms/op 1.06
altair processRewardsAndPenalties - 250000 worstcase 77.740 ms/op 80.860 ms/op 0.96
phase0 getAttestationDeltas - 250000 normalcase 8.1137 ms/op 9.8725 ms/op 0.82
phase0 getAttestationDeltas - 250000 worstcase 8.3901 ms/op 7.5045 ms/op 1.12
phase0 processSlashings - 250000 worstcase 4.1732 ms/op 4.0339 ms/op 1.03
altair processSyncCommitteeUpdates - 250000 218.54 ms/op 187.56 ms/op 1.17
BeaconState.hashTreeRoot - No change 420.00 ns/op 298.00 ns/op 1.41
BeaconState.hashTreeRoot - 1 full validator 63.101 us/op 55.230 us/op 1.14
BeaconState.hashTreeRoot - 32 full validator 607.36 us/op 614.56 us/op 0.99
BeaconState.hashTreeRoot - 512 full validator 6.3463 ms/op 6.7517 ms/op 0.94
BeaconState.hashTreeRoot - 1 validator.effectiveBalance 71.670 us/op 72.271 us/op 0.99
BeaconState.hashTreeRoot - 32 validator.effectiveBalance 1.0499 ms/op 983.43 us/op 1.07
BeaconState.hashTreeRoot - 512 validator.effectiveBalance 14.215 ms/op 14.049 ms/op 1.01
BeaconState.hashTreeRoot - 1 balances 56.281 us/op 55.107 us/op 1.02
BeaconState.hashTreeRoot - 32 balances 558.38 us/op 502.38 us/op 1.11
BeaconState.hashTreeRoot - 512 balances 5.0391 ms/op 5.0172 ms/op 1.00
BeaconState.hashTreeRoot - 250000 balances 84.540 ms/op 80.212 ms/op 1.05
aggregationBits - 2048 els - zipIndexesInBitList 19.246 us/op 23.349 us/op 0.82
regular array get 100000 times 50.092 us/op 34.810 us/op 1.44
wrappedArray get 100000 times 47.094 us/op 34.027 us/op 1.38
arrayWithProxy get 100000 times 18.845 ms/op 16.432 ms/op 1.15
ssz.Root.equals 652.00 ns/op 593.00 ns/op 1.10
byteArrayEquals 639.00 ns/op 595.00 ns/op 1.07
shuffle list - 16384 els 8.1102 ms/op 7.3528 ms/op 1.10
shuffle list - 250000 els 119.44 ms/op 105.90 ms/op 1.13
processSlot - 1 slots 9.8240 us/op 9.9600 us/op 0.99
processSlot - 32 slots 1.6122 ms/op 1.4660 ms/op 1.10
getEffectiveBalanceIncrementsZeroInactive - 250000 vs - 7PWei 40.053 ms/op 39.161 ms/op 1.02
getCommitteeAssignments - req 1 vs - 250000 vc 3.4697 ms/op 3.0049 ms/op 1.15
getCommitteeAssignments - req 100 vs - 250000 vc 4.9558 ms/op 4.2678 ms/op 1.16
getCommitteeAssignments - req 1000 vs - 250000 vc 5.8830 ms/op 4.7250 ms/op 1.25
RootCache.getBlockRootAtSlot - 250000 vs - 7PWei 6.0000 ns/op 5.2300 ns/op 1.15
state getBlockRootAtSlot - 250000 vs - 7PWei 769.87 ns/op 964.41 ns/op 0.80
computeProposers - vc 250000 13.312 ms/op 11.784 ms/op 1.13
computeEpochShuffling - vc 250000 130.88 ms/op 109.76 ms/op 1.19
getNextSyncCommittee - vc 250000 217.58 ms/op 192.11 ms/op 1.13
computeSigningRoot for AttestationData 16.680 us/op 14.069 us/op 1.19
hash AttestationData serialized data then Buffer.toString(base64) 3.5667 us/op 2.5801 us/op 1.38
toHexString serialized data 1.7337 us/op 1.2089 us/op 1.43
Buffer.toString(base64) 531.75 ns/op 361.38 ns/op 1.47

by benchmarkbot/action

@nflaig nflaig merged commit b60b43c into unstable Apr 28, 2023
@nflaig nflaig deleted the nflaig/conv-commit-contrib branch April 28, 2023 21:16
@wemeetagain
Copy link
Member

🎉 This PR is included in v1.8.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.
2 participants
@nflaig @wemeetagain