refactor: remove intermediary not-started state from peer discovery

[dapplion]

Motivation

Noted that our node takes longer than necessary to start the first discv5 query. This is because there's a race condition between calling the first heartbeat loop and discv5 worker being ready.

The race condition is silenced here, where consumers do not realize underlying worker is not ready yet

lodestar/packages/beacon-node/src/network/discv5/index.ts

Lines 117 to 123 in c775ad7

	async findRandomNode(): Promise<ENR[]> {
	if (this.status.status === "started") {
	return this.decodeEnrs(await this.status.workerApi.findRandomNode());
	} else {
	return [];
	}
	}

This is not ideal and can lead to issues, this hidden intermediary state can be avoided by either:

• throw error if not started
• await for worker to be initialized
• remove the state where worker is not ready yet completely

Description

remove intermediary not-started state from peer discovery, by adopting the static async init + close pattern. IMO is the solution most simple to reason about with less gotchas downstream

[github-actions]

Performance Report

✔️ no performance regression detected

Full benchmark results

Benchmark suite	Current: 4286eb6	Previous: 7eec2e5	Ratio
getPubkeys - index2pubkey - req 1000 vs - 250000 vc	912.71 us/op	541.61 us/op	1.69
getPubkeys - validatorsArr - req 1000 vs - 250000 vc	47.723 us/op	46.730 us/op	1.02
BLS verify - blst-native	1.2276 ms/op	1.2284 ms/op	1.00
BLS verifyMultipleSignatures 3 - blst-native	2.4806 ms/op	2.4845 ms/op	1.00
BLS verifyMultipleSignatures 8 - blst-native	5.3527 ms/op	5.3425 ms/op	1.00
BLS verifyMultipleSignatures 32 - blst-native	19.432 ms/op	19.458 ms/op	1.00
BLS aggregatePubkeys 32 - blst-native	25.988 us/op	25.712 us/op	1.01
BLS aggregatePubkeys 128 - blst-native	100.72 us/op	100.80 us/op	1.00
getAttestationsForBlock	54.582 ms/op	60.640 ms/op	0.90
isKnown best case - 1 super set check	258.00 ns/op	275.00 ns/op	0.94
isKnown normal case - 2 super set checks	247.00 ns/op	262.00 ns/op	0.94
isKnown worse case - 16 super set checks	246.00 ns/op	260.00 ns/op	0.95
CheckpointStateCache - add get delete	5.1040 us/op	5.4510 us/op	0.94
validate gossip signedAggregateAndProof - struct	2.7755 ms/op	2.8030 ms/op	0.99
validate gossip attestation - struct	1.3357 ms/op	1.3352 ms/op	1.00
pickEth1Vote - no votes	1.2690 ms/op	1.3450 ms/op	0.94
pickEth1Vote - max votes	9.7242 ms/op	9.3730 ms/op	1.04
pickEth1Vote - Eth1Data hashTreeRoot value x2048	8.8493 ms/op	9.1454 ms/op	0.97
pickEth1Vote - Eth1Data hashTreeRoot tree x2048	14.371 ms/op	17.678 ms/op	0.81
pickEth1Vote - Eth1Data fastSerialize value x2048	711.30 us/op	761.73 us/op	0.93
pickEth1Vote - Eth1Data fastSerialize tree x2048	8.8392 ms/op	7.8819 ms/op	1.12
bytes32 toHexString	549.00 ns/op	551.00 ns/op	1.00
bytes32 Buffer.toString(hex)	407.00 ns/op	406.00 ns/op	1.00
bytes32 Buffer.toString(hex) from Uint8Array	575.00 ns/op	579.00 ns/op	0.99
bytes32 Buffer.toString(hex) + 0x	361.00 ns/op	406.00 ns/op	0.89
Object access 1 prop	0.16900 ns/op	0.18900 ns/op	0.89
Map access 1 prop	0.16500 ns/op	0.16400 ns/op	1.01
Object get x1000	6.7700 ns/op	6.9270 ns/op	0.98
Map get x1000	0.60900 ns/op	0.67500 ns/op	0.90
Object set x1000	54.178 ns/op	62.486 ns/op	0.87
Map set x1000	46.794 ns/op	50.944 ns/op	0.92
Return object 10000 times	0.24320 ns/op	0.24910 ns/op	0.98
Throw Error 10000 times	4.3188 us/op	4.3644 us/op	0.99
fastMsgIdFn sha256 / 200 bytes	3.4460 us/op	3.5270 us/op	0.98
fastMsgIdFn h32 xxhash / 200 bytes	286.00 ns/op	318.00 ns/op	0.90
fastMsgIdFn h64 xxhash / 200 bytes	394.00 ns/op	479.00 ns/op	0.82
fastMsgIdFn sha256 / 1000 bytes	11.656 us/op	12.154 us/op	0.96
fastMsgIdFn h32 xxhash / 1000 bytes	417.00 ns/op	441.00 ns/op	0.95
fastMsgIdFn h64 xxhash / 1000 bytes	483.00 ns/op	507.00 ns/op	0.95
fastMsgIdFn sha256 / 10000 bytes	103.29 us/op	105.31 us/op	0.98
fastMsgIdFn h32 xxhash / 10000 bytes	1.9060 us/op	1.9710 us/op	0.97
fastMsgIdFn h64 xxhash / 10000 bytes	1.3580 us/op	1.4190 us/op	0.96
enrSubnets - fastDeserialize 64 bits	1.2940 us/op	1.3520 us/op	0.96
enrSubnets - ssz BitVector 64 bits	497.00 ns/op	508.00 ns/op	0.98
enrSubnets - fastDeserialize 4 bits	171.00 ns/op	169.00 ns/op	1.01
enrSubnets - ssz BitVector 4 bits	523.00 ns/op	497.00 ns/op	1.05
prioritizePeers score -10:0 att 32-0.1 sync 2-0	107.26 us/op	108.47 us/op	0.99
prioritizePeers score 0:0 att 32-0.25 sync 2-0.25	151.51 us/op	152.07 us/op	1.00
prioritizePeers score 0:0 att 32-0.5 sync 2-0.5	178.98 us/op	199.60 us/op	0.90
prioritizePeers score 0:0 att 64-0.75 sync 4-0.75	330.96 us/op	334.12 us/op	0.99
prioritizePeers score 0:0 att 64-1 sync 4-1	390.95 us/op	390.14 us/op	1.00
array of 16000 items push then shift	1.6648 us/op	1.6580 us/op	1.00
LinkedList of 16000 items push then shift	8.9410 ns/op	8.9710 ns/op	1.00
array of 16000 items push then pop	97.791 ns/op	75.069 ns/op	1.30
LinkedList of 16000 items push then pop	8.6590 ns/op	8.6400 ns/op	1.00
array of 24000 items push then shift	2.3970 us/op	2.4056 us/op	1.00
LinkedList of 24000 items push then shift	8.9660 ns/op	9.1210 ns/op	0.98
array of 24000 items push then pop	73.792 ns/op	72.481 ns/op	1.02
LinkedList of 24000 items push then pop	8.5480 ns/op	8.8770 ns/op	0.96
intersect bitArray bitLen 8	13.354 ns/op	13.304 ns/op	1.00
intersect array and set length 8	79.715 ns/op	74.980 ns/op	1.06
intersect bitArray bitLen 128	44.699 ns/op	44.622 ns/op	1.00
intersect array and set length 128	1.0668 us/op	1.0437 us/op	1.02
Buffer.concat 32 items	2.6710 us/op	2.6490 us/op	1.01
Uint8Array.set 32 items	2.2110 us/op	2.4630 us/op	0.90
transfer serialized Status (84 B)	2.0320 us/op	2.0380 us/op	1.00
copy serialized Status (84 B)	1.6810 us/op	1.7400 us/op	0.97
transfer serialized SignedVoluntaryExit (112 B)	2.1190 us/op	2.1580 us/op	0.98
copy serialized SignedVoluntaryExit (112 B)	1.7170 us/op	1.8020 us/op	0.95
transfer serialized ProposerSlashing (416 B)	2.2970 us/op	2.2490 us/op	1.02
copy serialized ProposerSlashing (416 B)	2.0190 us/op	2.0230 us/op	1.00
transfer serialized Attestation (485 B)	2.3860 us/op	2.2460 us/op	1.06
copy serialized Attestation (485 B)	2.0720 us/op	2.0380 us/op	1.02
transfer serialized AttesterSlashing (33232 B)	2.3950 us/op	2.2690 us/op	1.06
copy serialized AttesterSlashing (33232 B)	5.4230 us/op	5.2310 us/op	1.04
transfer serialized Small SignedBeaconBlock (128000 B)	2.7310 us/op	2.5990 us/op	1.05
copy serialized Small SignedBeaconBlock (128000 B)	40.677 us/op	20.675 us/op	1.97
transfer serialized Avg SignedBeaconBlock (200000 B)	3.1450 us/op	2.9510 us/op	1.07
copy serialized Avg SignedBeaconBlock (200000 B)	22.158 us/op	28.772 us/op	0.77
transfer serialized BlobsSidecar (524380 B)	3.2240 us/op	3.2460 us/op	0.99
copy serialized BlobsSidecar (524380 B)	148.17 us/op	138.64 us/op	1.07
transfer serialized Big SignedBeaconBlock (1000000 B)	3.2810 us/op	3.3060 us/op	0.99
copy serialized Big SignedBeaconBlock (1000000 B)	312.89 us/op	349.58 us/op	0.90
pass gossip attestations to forkchoice per slot	2.7467 ms/op	2.6709 ms/op	1.03
forkChoice updateHead vc 100000 bc 64 eq 0	2.1587 ms/op	2.0901 ms/op	1.03
forkChoice updateHead vc 600000 bc 64 eq 0	12.981 ms/op	12.554 ms/op	1.03
forkChoice updateHead vc 1000000 bc 64 eq 0	19.773 ms/op	19.619 ms/op	1.01
forkChoice updateHead vc 600000 bc 320 eq 0	17.359 ms/op	16.894 ms/op	1.03
forkChoice updateHead vc 600000 bc 1200 eq 0	85.109 ms/op	83.166 ms/op	1.02
forkChoice updateHead vc 600000 bc 64 eq 1000	21.331 ms/op	21.701 ms/op	0.98
forkChoice updateHead vc 600000 bc 64 eq 10000	23.313 ms/op	23.382 ms/op	1.00
forkChoice updateHead vc 600000 bc 64 eq 300000	32.328 ms/op	30.958 ms/op	1.04
computeDeltas	3.5289 ms/op	3.8775 ms/op	0.91
computeProposerBoostScoreFromBalances	1.7952 ms/op	1.7650 ms/op	1.02
altair processAttestation - 250000 vs - 7PWei normalcase	2.6194 ms/op	2.1229 ms/op	1.23
altair processAttestation - 250000 vs - 7PWei worstcase	4.0928 ms/op	3.3091 ms/op	1.24
altair processAttestation - setStatus - 1/6 committees join	151.95 us/op	141.65 us/op	1.07
altair processAttestation - setStatus - 1/3 committees join	293.44 us/op	278.87 us/op	1.05
altair processAttestation - setStatus - 1/2 committees join	381.21 us/op	372.11 us/op	1.02
altair processAttestation - setStatus - 2/3 committees join	475.97 us/op	475.47 us/op	1.00
altair processAttestation - setStatus - 4/5 committees join	683.61 us/op	662.37 us/op	1.03
altair processAttestation - setStatus - 100% committees join	810.82 us/op	777.80 us/op	1.04
altair processBlock - 250000 vs - 7PWei normalcase	19.459 ms/op	16.781 ms/op	1.16
altair processBlock - 250000 vs - 7PWei normalcase hashState	28.926 ms/op	25.084 ms/op	1.15
altair processBlock - 250000 vs - 7PWei worstcase	50.292 ms/op	62.623 ms/op	0.80
altair processBlock - 250000 vs - 7PWei worstcase hashState	70.428 ms/op	78.008 ms/op	0.90
phase0 processBlock - 250000 vs - 7PWei normalcase	2.4169 ms/op	1.9620 ms/op	1.23
phase0 processBlock - 250000 vs - 7PWei worstcase	29.714 ms/op	28.405 ms/op	1.05
altair processEth1Data - 250000 vs - 7PWei normalcase	517.88 us/op	472.99 us/op	1.09
getExpectedWithdrawals 250000 eb:1,eth1:1,we:0,wn:0,smpl:15	7.7730 us/op	11.276 us/op	0.69
getExpectedWithdrawals 250000 eb:0.95,eth1:0.1,we:0.05,wn:0,smpl:219	24.350 us/op	32.191 us/op	0.76
getExpectedWithdrawals 250000 eb:0.95,eth1:0.3,we:0.05,wn:0,smpl:42	9.3730 us/op	13.732 us/op	0.68
getExpectedWithdrawals 250000 eb:0.95,eth1:0.7,we:0.05,wn:0,smpl:18	7.0460 us/op	10.271 us/op	0.69
getExpectedWithdrawals 250000 eb:0.1,eth1:0.1,we:0,wn:0,smpl:1020	92.661 us/op	72.566 us/op	1.28
getExpectedWithdrawals 250000 eb:0.03,eth1:0.03,we:0,wn:0,smpl:11777	650.18 us/op	936.01 us/op	0.69
getExpectedWithdrawals 250000 eb:0.01,eth1:0.01,we:0,wn:0,smpl:16384	911.35 us/op	1.6129 ms/op	0.57
getExpectedWithdrawals 250000 eb:0,eth1:0,we:0,wn:0,smpl:16384	886.01 us/op	987.42 us/op	0.90
getExpectedWithdrawals 250000 eb:0,eth1:0,we:0,wn:0,nocache,smpl:16384	2.3597 ms/op	2.2941 ms/op	1.03
getExpectedWithdrawals 250000 eb:0,eth1:1,we:0,wn:0,smpl:16384	1.7201 ms/op	2.9343 ms/op	0.59
getExpectedWithdrawals 250000 eb:0,eth1:1,we:0,wn:0,nocache,smpl:16384	4.1638 ms/op	3.8857 ms/op	1.07
Tree 40 250000 create	325.73 ms/op	340.97 ms/op	0.96
Tree 40 250000 get(125000)	194.38 ns/op	186.17 ns/op	1.04
Tree 40 250000 set(125000)	1.0303 us/op	943.43 ns/op	1.09
Tree 40 250000 toArray()	22.111 ms/op	19.543 ms/op	1.13
Tree 40 250000 iterate all - toArray() + loop	22.205 ms/op	20.416 ms/op	1.09
Tree 40 250000 iterate all - get(i)	72.974 ms/op	75.870 ms/op	0.96
MutableVector 250000 create	11.958 ms/op	14.603 ms/op	0.82
MutableVector 250000 get(125000)	6.5900 ns/op	6.5410 ns/op	1.01
MutableVector 250000 set(125000)	255.90 ns/op	270.94 ns/op	0.94
MutableVector 250000 toArray()	3.2598 ms/op	3.1906 ms/op	1.02
MutableVector 250000 iterate all - toArray() + loop	3.3613 ms/op	3.6113 ms/op	0.93
MutableVector 250000 iterate all - get(i)	1.5275 ms/op	1.5522 ms/op	0.98
Array 250000 create	2.8716 ms/op	2.7008 ms/op	1.06
Array 250000 clone - spread	1.1513 ms/op	1.1678 ms/op	0.99
Array 250000 get(125000)	0.56500 ns/op	0.56500 ns/op	1.00
Array 250000 set(125000)	0.64400 ns/op	0.61000 ns/op	1.06
Array 250000 iterate all - loop	107.78 us/op	110.14 us/op	0.98
effectiveBalanceIncrements clone Uint8Array 300000	44.170 us/op	34.456 us/op	1.28
effectiveBalanceIncrements clone MutableVector 300000	351.00 ns/op	329.00 ns/op	1.07
effectiveBalanceIncrements rw all Uint8Array 300000	171.62 us/op	172.94 us/op	0.99
effectiveBalanceIncrements rw all MutableVector 300000	89.311 ms/op	85.443 ms/op	1.05
phase0 afterProcessEpoch - 250000 vs - 7PWei	115.94 ms/op	117.44 ms/op	0.99
phase0 beforeProcessEpoch - 250000 vs - 7PWei	43.885 ms/op	47.159 ms/op	0.93
altair processEpoch - mainnet_e81889	311.52 ms/op	354.32 ms/op	0.88
mainnet_e81889 - altair beforeProcessEpoch	50.082 ms/op	58.304 ms/op	0.86
mainnet_e81889 - altair processJustificationAndFinalization	16.560 us/op	20.020 us/op	0.83
mainnet_e81889 - altair processInactivityUpdates	6.1598 ms/op	6.8536 ms/op	0.90
mainnet_e81889 - altair processRewardsAndPenalties	70.231 ms/op	77.012 ms/op	0.91
mainnet_e81889 - altair processRegistryUpdates	2.8260 us/op	3.1900 us/op	0.89
mainnet_e81889 - altair processSlashings	556.00 ns/op	555.00 ns/op	1.00
mainnet_e81889 - altair processEth1DataReset	615.00 ns/op	669.00 ns/op	0.92
mainnet_e81889 - altair processEffectiveBalanceUpdates	1.2870 ms/op	1.5383 ms/op	0.84
mainnet_e81889 - altair processSlashingsReset	6.6750 us/op	6.4040 us/op	1.04
mainnet_e81889 - altair processRandaoMixesReset	4.4340 us/op	4.9620 us/op	0.89
mainnet_e81889 - altair processHistoricalRootsUpdate	739.00 ns/op	903.00 ns/op	0.82
mainnet_e81889 - altair processParticipationFlagUpdates	4.9240 us/op	2.8650 us/op	1.72
mainnet_e81889 - altair processSyncCommitteeUpdates	880.00 ns/op	938.00 ns/op	0.94
mainnet_e81889 - altair afterProcessEpoch	130.23 ms/op	137.39 ms/op	0.95
phase0 processEpoch - mainnet_e58758	369.15 ms/op	402.05 ms/op	0.92
mainnet_e58758 - phase0 beforeProcessEpoch	146.27 ms/op	177.13 ms/op	0.83
mainnet_e58758 - phase0 processJustificationAndFinalization	19.013 us/op	23.017 us/op	0.83
mainnet_e58758 - phase0 processRewardsAndPenalties	64.658 ms/op	69.833 ms/op	0.93
mainnet_e58758 - phase0 processRegistryUpdates	8.2040 us/op	12.398 us/op	0.66
mainnet_e58758 - phase0 processSlashings	557.00 ns/op	1.0990 us/op	0.51
mainnet_e58758 - phase0 processEth1DataReset	784.00 ns/op	853.00 ns/op	0.92
mainnet_e58758 - phase0 processEffectiveBalanceUpdates	1.0263 ms/op	1.3381 ms/op	0.77
mainnet_e58758 - phase0 processSlashingsReset	3.8010 us/op	9.2120 us/op	0.41
mainnet_e58758 - phase0 processRandaoMixesReset	4.5630 us/op	7.8230 us/op	0.58
mainnet_e58758 - phase0 processHistoricalRootsUpdate	718.00 ns/op	2.1780 us/op	0.33
mainnet_e58758 - phase0 processParticipationRecordUpdates	4.2480 us/op	6.9830 us/op	0.61
mainnet_e58758 - phase0 afterProcessEpoch	99.983 ms/op	107.39 ms/op	0.93
phase0 processEffectiveBalanceUpdates - 250000 normalcase	1.2665 ms/op	1.5478 ms/op	0.82
phase0 processEffectiveBalanceUpdates - 250000 worstcase 0.5	1.6057 ms/op	1.9396 ms/op	0.83
altair processInactivityUpdates - 250000 normalcase	22.320 ms/op	27.542 ms/op	0.81
altair processInactivityUpdates - 250000 worstcase	26.464 ms/op	24.109 ms/op	1.10
phase0 processRegistryUpdates - 250000 normalcase	7.2140 us/op	8.8070 us/op	0.82
phase0 processRegistryUpdates - 250000 badcase_full_deposits	266.30 us/op	346.88 us/op	0.77
phase0 processRegistryUpdates - 250000 worstcase 0.5	128.06 ms/op	137.69 ms/op	0.93
altair processRewardsAndPenalties - 250000 normalcase	63.098 ms/op	67.811 ms/op	0.93
altair processRewardsAndPenalties - 250000 worstcase	64.921 ms/op	76.588 ms/op	0.85
phase0 getAttestationDeltas - 250000 normalcase	7.1623 ms/op	8.2684 ms/op	0.87
phase0 getAttestationDeltas - 250000 worstcase	6.7759 ms/op	7.8575 ms/op	0.86
phase0 processSlashings - 250000 worstcase	3.7446 ms/op	3.5610 ms/op	1.05
altair processSyncCommitteeUpdates - 250000	190.02 ms/op	196.82 ms/op	0.97
BeaconState.hashTreeRoot - No change	362.00 ns/op	270.00 ns/op	1.34
BeaconState.hashTreeRoot - 1 full validator	52.714 us/op	57.852 us/op	0.91
BeaconState.hashTreeRoot - 32 full validator	523.13 us/op	597.76 us/op	0.88
BeaconState.hashTreeRoot - 512 full validator	5.5709 ms/op	7.2633 ms/op	0.77
BeaconState.hashTreeRoot - 1 validator.effectiveBalance	65.581 us/op	74.992 us/op	0.87
BeaconState.hashTreeRoot - 32 validator.effectiveBalance	983.70 us/op	1.0321 ms/op	0.95
BeaconState.hashTreeRoot - 512 validator.effectiveBalance	12.152 ms/op	15.425 ms/op	0.79
BeaconState.hashTreeRoot - 1 balances	51.409 us/op	54.502 us/op	0.94
BeaconState.hashTreeRoot - 32 balances	443.63 us/op	569.74 us/op	0.78
BeaconState.hashTreeRoot - 512 balances	4.6668 ms/op	5.8586 ms/op	0.80
BeaconState.hashTreeRoot - 250000 balances	76.827 ms/op	85.103 ms/op	0.90
aggregationBits - 2048 els - zipIndexesInBitList	16.889 us/op	26.064 us/op	0.65
regular array get 100000 times	44.648 us/op	46.348 us/op	0.96
wrappedArray get 100000 times	33.899 us/op	46.868 us/op	0.72
arrayWithProxy get 100000 times	17.001 ms/op	17.987 ms/op	0.95
ssz.Root.equals	566.00 ns/op	637.00 ns/op	0.89
byteArrayEquals	562.00 ns/op	627.00 ns/op	0.90
shuffle list - 16384 els	7.0984 ms/op	8.0758 ms/op	0.88
shuffle list - 250000 els	102.70 ms/op	117.53 ms/op	0.87
processSlot - 1 slots	9.4730 us/op	10.621 us/op	0.89
processSlot - 32 slots	1.3876 ms/op	1.5368 ms/op	0.90
getEffectiveBalanceIncrementsZeroInactive - 250000 vs - 7PWei	36.158 ms/op	41.039 ms/op	0.88
getCommitteeAssignments - req 1 vs - 250000 vc	2.9178 ms/op	3.1012 ms/op	0.94
getCommitteeAssignments - req 100 vs - 250000 vc	4.2378 ms/op	4.4012 ms/op	0.96
getCommitteeAssignments - req 1000 vs - 250000 vc	4.6890 ms/op	4.7927 ms/op	0.98
RootCache.getBlockRootAtSlot - 250000 vs - 7PWei	4.9400 ns/op	5.3700 ns/op	0.92
state getBlockRootAtSlot - 250000 vs - 7PWei	622.41 ns/op	718.14 ns/op	0.87
computeProposers - vc 250000	10.837 ms/op	11.627 ms/op	0.93
computeEpochShuffling - vc 250000	111.81 ms/op	112.66 ms/op	0.99
getNextSyncCommittee - vc 250000	187.94 ms/op	191.58 ms/op	0.98
computeSigningRoot for AttestationData	14.112 us/op	14.669 us/op	0.96
hash AttestationData serialized data then Buffer.toString(base64)	2.5776 us/op	2.6242 us/op	0.98
toHexString serialized data	1.1563 us/op	1.3971 us/op	0.83
Buffer.toString(base64)	334.84 ns/op	370.99 ns/op	0.90

by benchmarkbot/action

[wemeetagain]

🎉 This PR is included in v1.9.0 🎉