@lodestar/beacon-node 1.45.0-dev.fadf0fbb1f → 1.45.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (132) hide show
  1. package/lib/api/impl/beacon/index.d.ts +1 -1
  2. package/lib/api/impl/beacon/index.d.ts.map +1 -1
  3. package/lib/api/impl/beacon/index.js.map +1 -1
  4. package/lib/api/impl/beacon/pool/index.d.ts.map +1 -1
  5. package/lib/api/impl/beacon/pool/index.js +4 -0
  6. package/lib/api/impl/beacon/pool/index.js.map +1 -1
  7. package/lib/api/impl/beacon/state/index.d.ts +1 -1
  8. package/lib/api/impl/beacon/state/index.d.ts.map +1 -1
  9. package/lib/api/impl/beacon/state/index.js +2 -2
  10. package/lib/api/impl/beacon/state/index.js.map +1 -1
  11. package/lib/api/impl/beacon/state/utils.d.ts +2 -1
  12. package/lib/api/impl/beacon/state/utils.d.ts.map +1 -1
  13. package/lib/api/impl/beacon/state/utils.js +9 -1
  14. package/lib/api/impl/beacon/state/utils.js.map +1 -1
  15. package/lib/api/impl/debug/index.d.ts +1 -1
  16. package/lib/api/impl/debug/index.d.ts.map +1 -1
  17. package/lib/api/impl/debug/index.js +2 -2
  18. package/lib/api/impl/debug/index.js.map +1 -1
  19. package/lib/api/impl/lodestar/index.js +2 -2
  20. package/lib/api/impl/lodestar/index.js.map +1 -1
  21. package/lib/api/impl/proof/index.d.ts +1 -1
  22. package/lib/api/impl/proof/index.d.ts.map +1 -1
  23. package/lib/api/impl/proof/index.js +2 -2
  24. package/lib/api/impl/proof/index.js.map +1 -1
  25. package/lib/api/impl/utils.d.ts +23 -0
  26. package/lib/api/impl/utils.d.ts.map +1 -1
  27. package/lib/api/impl/utils.js +44 -1
  28. package/lib/api/impl/utils.js.map +1 -1
  29. package/lib/api/impl/validator/index.d.ts +0 -14
  30. package/lib/api/impl/validator/index.d.ts.map +1 -1
  31. package/lib/api/impl/validator/index.js +21 -56
  32. package/lib/api/impl/validator/index.js.map +1 -1
  33. package/lib/api/rest/base.d.ts.map +1 -1
  34. package/lib/api/rest/base.js +8 -0
  35. package/lib/api/rest/base.js.map +1 -1
  36. package/lib/chain/blocks/importBlock.d.ts.map +1 -1
  37. package/lib/chain/blocks/importBlock.js +1 -4
  38. package/lib/chain/blocks/importBlock.js.map +1 -1
  39. package/lib/chain/builderCircuitBreaker.d.ts +31 -0
  40. package/lib/chain/builderCircuitBreaker.d.ts.map +1 -0
  41. package/lib/chain/builderCircuitBreaker.js +59 -0
  42. package/lib/chain/builderCircuitBreaker.js.map +1 -0
  43. package/lib/chain/chain.d.ts +2 -0
  44. package/lib/chain/chain.d.ts.map +1 -1
  45. package/lib/chain/chain.js +3 -0
  46. package/lib/chain/chain.js.map +1 -1
  47. package/lib/chain/interface.d.ts +2 -0
  48. package/lib/chain/interface.d.ts.map +1 -1
  49. package/lib/chain/interface.js.map +1 -1
  50. package/lib/chain/options.d.ts +4 -0
  51. package/lib/chain/options.d.ts.map +1 -1
  52. package/lib/chain/options.js.map +1 -1
  53. package/lib/chain/prepareNextSlot.d.ts.map +1 -1
  54. package/lib/chain/prepareNextSlot.js +12 -7
  55. package/lib/chain/prepareNextSlot.js.map +1 -1
  56. package/lib/chain/validation/executionPayloadBid.js +11 -10
  57. package/lib/chain/validation/executionPayloadBid.js.map +1 -1
  58. package/lib/chain/validation/proposerPreferences.d.ts.map +1 -1
  59. package/lib/chain/validation/proposerPreferences.js +3 -2
  60. package/lib/chain/validation/proposerPreferences.js.map +1 -1
  61. package/lib/execution/builder/http.d.ts +18 -0
  62. package/lib/execution/builder/http.d.ts.map +1 -1
  63. package/lib/execution/builder/http.js +20 -11
  64. package/lib/execution/builder/http.js.map +1 -1
  65. package/lib/metrics/metrics/beacon.d.ts +6 -0
  66. package/lib/metrics/metrics/beacon.d.ts.map +1 -1
  67. package/lib/metrics/metrics/beacon.js +18 -0
  68. package/lib/metrics/metrics/beacon.js.map +1 -1
  69. package/lib/network/core/metrics.d.ts +65 -0
  70. package/lib/network/core/metrics.d.ts.map +1 -1
  71. package/lib/network/core/metrics.js +94 -0
  72. package/lib/network/core/metrics.js.map +1 -1
  73. package/lib/network/discv5/utils.d.ts.map +1 -1
  74. package/lib/network/discv5/utils.js +12 -3
  75. package/lib/network/discv5/utils.js.map +1 -1
  76. package/lib/network/gossip/encoding.d.ts.map +1 -1
  77. package/lib/network/gossip/encoding.js +7 -0
  78. package/lib/network/gossip/encoding.js.map +1 -1
  79. package/lib/network/gossip/gossipsub.d.ts.map +1 -1
  80. package/lib/network/gossip/gossipsub.js +2 -1
  81. package/lib/network/gossip/gossipsub.js.map +1 -1
  82. package/lib/network/gossip/topic.d.ts +6 -1
  83. package/lib/network/gossip/topic.d.ts.map +1 -1
  84. package/lib/network/gossip/topic.js +23 -3
  85. package/lib/network/gossip/topic.js.map +1 -1
  86. package/lib/network/peers/peerManager.d.ts.map +1 -1
  87. package/lib/network/peers/peerManager.js +10 -0
  88. package/lib/network/peers/peerManager.js.map +1 -1
  89. package/lib/network/peers/score/score.d.ts +3 -1
  90. package/lib/network/peers/score/score.d.ts.map +1 -1
  91. package/lib/network/peers/score/score.js +6 -1
  92. package/lib/network/peers/score/score.js.map +1 -1
  93. package/lib/network/peers/score/store.d.ts.map +1 -1
  94. package/lib/network/peers/score/store.js +6 -1
  95. package/lib/network/peers/score/store.js.map +1 -1
  96. package/lib/network/peers/utils/prioritizePeers.d.ts.map +1 -1
  97. package/lib/network/peers/utils/prioritizePeers.js +14 -0
  98. package/lib/network/peers/utils/prioritizePeers.js.map +1 -1
  99. package/lib/network/processor/gossipHandlers.d.ts.map +1 -1
  100. package/lib/network/processor/gossipHandlers.js +4 -0
  101. package/lib/network/processor/gossipHandlers.js.map +1 -1
  102. package/package.json +19 -19
  103. package/src/api/impl/beacon/index.ts +1 -1
  104. package/src/api/impl/beacon/pool/index.ts +5 -0
  105. package/src/api/impl/beacon/state/index.ts +3 -2
  106. package/src/api/impl/beacon/state/utils.ts +11 -0
  107. package/src/api/impl/debug/index.ts +3 -2
  108. package/src/api/impl/lodestar/index.ts +2 -2
  109. package/src/api/impl/proof/index.ts +2 -2
  110. package/src/api/impl/utils.ts +51 -1
  111. package/src/api/impl/validator/index.ts +21 -62
  112. package/src/api/rest/base.ts +9 -0
  113. package/src/chain/blocks/importBlock.ts +1 -6
  114. package/src/chain/builderCircuitBreaker.ts +84 -0
  115. package/src/chain/chain.ts +7 -0
  116. package/src/chain/interface.ts +2 -0
  117. package/src/chain/options.ts +4 -0
  118. package/src/chain/prepareNextSlot.ts +11 -7
  119. package/src/chain/validation/executionPayloadBid.ts +14 -9
  120. package/src/chain/validation/proposerPreferences.ts +3 -2
  121. package/src/execution/builder/http.ts +30 -17
  122. package/src/metrics/metrics/beacon.ts +19 -0
  123. package/src/network/core/metrics.ts +94 -0
  124. package/src/network/discv5/utils.ts +11 -3
  125. package/src/network/gossip/encoding.ts +7 -0
  126. package/src/network/gossip/gossipsub.ts +2 -1
  127. package/src/network/gossip/topic.ts +28 -4
  128. package/src/network/peers/peerManager.ts +11 -0
  129. package/src/network/peers/score/score.ts +8 -1
  130. package/src/network/peers/score/store.ts +8 -1
  131. package/src/network/peers/utils/prioritizePeers.ts +15 -0
  132. package/src/network/processor/gossipHandlers.ts +5 -0
@@ -49,6 +49,10 @@ export type IChainOptions = BlockProcessOpts &
49
49
  archiveDateEpochs?: number;
50
50
  nHistoricalStatesFileDataStore?: boolean;
51
51
  nativeStateView?: boolean;
52
+ /** Builder circuit breaker fault inspection window in slots */
53
+ faultInspectionWindow?: number;
54
+ /** Allowed unrevealed payloads within the fault inspection window */
55
+ allowedFaults?: number;
52
56
  };
53
57
 
54
58
  export type BlockProcessOpts = {
@@ -1,7 +1,7 @@
1
1
  import {routes} from "@lodestar/api";
2
2
  import {ChainForkConfig} from "@lodestar/config";
3
3
  import {getSafeExecutionBlockHash} from "@lodestar/fork-choice";
4
- import {ForkPostBellatrix, ForkSeq, SLOTS_PER_EPOCH, isForkPostBellatrix} from "@lodestar/params";
4
+ import {ForkPostBellatrix, ForkSeq, SLOTS_PER_EPOCH, isForkPostBellatrix, isForkPostGloas} from "@lodestar/params";
5
5
  import {
6
6
  IBeaconStateView,
7
7
  IBeaconStateViewBellatrix,
@@ -152,12 +152,16 @@ export class PrepareNextSlotScheduler {
152
152
  updatedHead = proposerHead;
153
153
  }
154
154
 
155
- // Update the builder status, if enabled shoot an api call to check status
156
- this.chain.updateBuilderStatus(clockSlot);
157
- if (this.chain.executionBuilder?.status === BuilderStatus.enabled) {
158
- this.chain.executionBuilder.checkStatus().catch((e) => {
159
- this.logger.error("Builder disabled as the check status api failed", {prepareSlot}, e as Error);
160
- });
155
+ if (isForkPostGloas(fork)) {
156
+ this.chain.builderCircuitBreaker.update(clockSlot);
157
+ } else {
158
+ // Update the builder status, if enabled shoot an api call to check status
159
+ this.chain.updateBuilderStatus(clockSlot);
160
+ if (this.chain.executionBuilder?.status === BuilderStatus.enabled) {
161
+ this.chain.executionBuilder.checkStatus().catch((e) => {
162
+ this.logger.error("Builder disabled as the check status api failed", {prepareSlot}, e as Error);
163
+ });
164
+ }
161
165
  }
162
166
  }
163
167
 
@@ -37,9 +37,11 @@ async function validateExecutionPayloadBid(
37
37
  const parentBlockRootHex = toRootHex(bid.parentBlockRoot);
38
38
  const parentBlockHashHex = toRootHex(bid.parentBlockHash);
39
39
 
40
- // [IGNORE] `bid.slot` is the current slot or the next slot.
41
- const currentSlot = chain.clock.currentSlot;
42
- if (bid.slot !== currentSlot && bid.slot !== currentSlot + 1) {
40
+ // [IGNORE] `bid.slot` is the current slot, or the next slot (`bid.slot - 1` is current), allowing for `MAXIMUM_GOSSIP_CLOCK_DISPARITY`.
41
+ if (
42
+ !chain.clock.isCurrentSlotGivenGossipDisparity(bid.slot) &&
43
+ !chain.clock.isCurrentSlotGivenGossipDisparity(bid.slot - 1)
44
+ ) {
43
45
  throw new ExecutionPayloadBidError(GossipAction.IGNORE, {
44
46
  code: ExecutionPayloadBidErrorCode.INVALID_SLOT,
45
47
  builderIndex: bid.builderIndex,
@@ -122,17 +124,20 @@ async function validateExecutionPayloadBid(
122
124
  throw new Error(`Expected gloas+ state for execution payload bid validation, got fork=${state.forkName}`);
123
125
  }
124
126
 
125
- // [REJECT] `bid.builder_index` is a valid/active builder index -- i.e.
126
- // `is_active_builder(state, bid.builder_index)` returns `True`.
127
- let builder: gloas.Builder;
128
- try {
129
- builder = state.getBuilder(bid.builderIndex);
130
- } catch {
127
+ // [REJECT] `bid.builder_index` is within bounds -- i.e. `bid.builder_index < len(state.builders)`.
128
+ // `state.getBuilder` returns a lazy SSZ `getReadonly` view that is not bounds-checked eagerly; an
129
+ // out-of-range index only throws (`LeafNode has no right node`) on deferred field access (e.g. inside
130
+ // `isActiveBuilder`), escaping a try/catch around `getBuilder`. Check the length explicitly instead.
131
+ if (bid.builderIndex >= state.getBuildersLength()) {
131
132
  throw new ExecutionPayloadBidError(GossipAction.REJECT, {
132
133
  code: ExecutionPayloadBidErrorCode.BUILDER_NOT_ELIGIBLE,
133
134
  builderIndex: bid.builderIndex,
134
135
  });
135
136
  }
137
+
138
+ // [REJECT] `bid.builder_index` is a valid/active builder index -- i.e.
139
+ // `is_active_builder(state, bid.builder_index)` returns `True`.
140
+ const builder = state.getBuilder(bid.builderIndex);
136
141
  if (!isActiveBuilder(builder, state.finalizedCheckpoint.epoch)) {
137
142
  throw new ExecutionPayloadBidError(GossipAction.REJECT, {
138
143
  code: ExecutionPayloadBidErrorCode.BUILDER_NOT_ELIGIBLE,
@@ -32,8 +32,9 @@ export async function validateGossipProposerPreferences(
32
32
  });
33
33
  }
34
34
 
35
- // [IGNORE] `preferences.proposal_slot` has not already passed.
36
- const currentSlot = chain.clock.currentSlot;
35
+ // [IGNORE] `preferences.proposal_slot` has not already passed, i.e. `proposal_slot > current_slot`,
36
+ // allowing for `MAXIMUM_GOSSIP_CLOCK_DISPARITY`.
37
+ const currentSlot = chain.clock.currentSlotWithGossipDisparity;
37
38
  if (proposalSlot <= currentSlot) {
38
39
  throw new ProposerPreferencesError(GossipAction.IGNORE, {
39
40
  code: ProposerPreferencesErrorCode.PROPOSAL_SLOT_PASSED,
@@ -70,6 +70,33 @@ export class NoBidReceived extends Error {
70
70
  }
71
71
  }
72
72
 
73
+ /**
74
+ * Beacon clients select randomized values from the following ranges when initializing
75
+ * the circuit breaker (so at boot time and once for each unique boot).
76
+ *
77
+ * ALLOWED_FAULTS: between 1 and SLOTS_PER_EPOCH // 4
78
+ * FAULT_INSPECTION_WINDOW: between SLOTS_PER_EPOCH and 2 * SLOTS_PER_EPOCH
79
+ *
80
+ * The values are randomized per node so builders cannot predict when a given proposer will
81
+ * fall back to local blocks. With fixed thresholds a builder could withhold payloads right up
82
+ * to the limit without ever tripping the breaker.
83
+ */
84
+ export function getFaultInspectionParams(opts: {faultInspectionWindow?: number; allowedFaults?: number}): {
85
+ faultInspectionWindow: number;
86
+ allowedFaults: number;
87
+ } {
88
+ const faultInspectionWindow = Math.max(
89
+ opts.faultInspectionWindow ?? SLOTS_PER_EPOCH + Math.floor(Math.random() * SLOTS_PER_EPOCH),
90
+ SLOTS_PER_EPOCH
91
+ );
92
+ // allowedFaults should be < faultInspectionWindow, limiting them to faultInspectionWindow/4
93
+ const allowedFaults = Math.min(
94
+ opts.allowedFaults ?? Math.floor(faultInspectionWindow / 4),
95
+ Math.floor(faultInspectionWindow / 4)
96
+ );
97
+ return {faultInspectionWindow, allowedFaults};
98
+ }
99
+
73
100
  /**
74
101
  * Additional duration to account for potential event loop lag which causes
75
102
  * builder blocks to be rejected even though the response was sent in time.
@@ -122,23 +149,9 @@ export class ExecutionBuilderHttp implements IExecutionBuilder {
122
149
  this.registrations = new ValidatorRegistrationCache();
123
150
  this.issueLocalFcUWithFeeRecipient = opts.issueLocalFcUWithFeeRecipient;
124
151
 
125
- /**
126
- * Beacon clients select randomized values from the following ranges when initializing
127
- * the circuit breaker (so at boot time and once for each unique boot).
128
- *
129
- * ALLOWED_FAULTS: between 1 and SLOTS_PER_EPOCH // 4
130
- * FAULT_INSPECTION_WINDOW: between SLOTS_PER_EPOCH and 2 * SLOTS_PER_EPOCH
131
- *
132
- */
133
- this.faultInspectionWindow = Math.max(
134
- opts.faultInspectionWindow ?? SLOTS_PER_EPOCH + Math.floor(Math.random() * SLOTS_PER_EPOCH),
135
- SLOTS_PER_EPOCH
136
- );
137
- // allowedFaults should be < faultInspectionWindow, limiting them to faultInspectionWindow/4
138
- this.allowedFaults = Math.min(
139
- opts.allowedFaults ?? Math.floor(this.faultInspectionWindow / 4),
140
- Math.floor(this.faultInspectionWindow / 4)
141
- );
152
+ const {faultInspectionWindow, allowedFaults} = getFaultInspectionParams(opts);
153
+ this.faultInspectionWindow = faultInspectionWindow;
154
+ this.allowedFaults = allowedFaults;
142
155
  }
143
156
 
144
157
  updateStatus(status: BuilderStatus): void {
@@ -138,6 +138,25 @@ export function createBeaconMetrics(register: RegistryMetricCreator) {
138
138
  help: "Count of cached produced results",
139
139
  }),
140
140
 
141
+ builderCircuitBreaker: {
142
+ active: register.gauge({
143
+ name: "beacon_builder_circuit_breaker_active",
144
+ help: "Whether the builder circuit breaker is active (1) causing builder bids to be ignored",
145
+ }),
146
+ faults: register.gauge({
147
+ name: "beacon_builder_circuit_breaker_faults",
148
+ help: "Count of blocks with unrevealed payloads in the fault inspection window",
149
+ }),
150
+ blocksPresent: register.gauge({
151
+ name: "beacon_builder_circuit_breaker_blocks_present",
152
+ help: "Count of blocks present in the fault inspection window",
153
+ }),
154
+ payloadsRevealed: register.gauge({
155
+ name: "beacon_builder_circuit_breaker_payloads_revealed",
156
+ help: "Count of blocks with revealed payloads in the fault inspection window",
157
+ }),
158
+ },
159
+
141
160
  blockPayload: {
142
161
  payloadAdvancePrepTime: register.histogram({
143
162
  name: "beacon_block_payload_prepare_time",
@@ -127,6 +127,100 @@ export function createNetworkCoreMetrics(register: RegistryMetricCreator) {
127
127
  name: "lodestar_peer_manager_starved_bool",
128
128
  help: "Whether lodestar is starved of data while syncing",
129
129
  }),
130
+ /**
131
+ * Core selection/pruning phase of the heartbeat, split out of heartbeatDuration so it
132
+ * can be attributed on its own. Divide by peersEvaluated for time-per-peer.
133
+ */
134
+ prioritizePeersDuration: register.histogram({
135
+ name: "lodestar_peer_manager_prioritize_peers_seconds",
136
+ help: "prioritizePeers function duration in seconds, the core peer selection/pruning algorithm",
137
+ buckets: [0.0005, 0.001, 0.005, 0.01, 0.05, 0.1],
138
+ }),
139
+ /**
140
+ * Score decay + map prune over every tracked peer, split out of heartbeatDuration.
141
+ * This loop iterates the whole score store, so divide by scoreMapSize (not
142
+ * peersEvaluated) for time-per-peer.
143
+ */
144
+ scoreUpdateDuration: register.histogram({
145
+ name: "lodestar_peer_score_update_seconds",
146
+ help: "Peer score store update (decay + prune over all peers) duration in seconds",
147
+ buckets: [0.0005, 0.001, 0.005, 0.01, 0.05, 0.1],
148
+ }),
149
+ /**
150
+ * Denominator for prioritizePeersDuration: it scales with the number of connected
151
+ * healthy peers, so time-per-peer (prioritizePeersDuration / this) is the comparable
152
+ * figure. For scoreUpdateDuration use scoreMapSize instead.
153
+ */
154
+ peersEvaluated: register.histogram({
155
+ name: "lodestar_peer_manager_peers_evaluated_count",
156
+ help: "Number of connected healthy peers evaluated by prioritizePeers per heartbeat, denominator for prioritize_peers_seconds",
157
+ buckets: [0, 25, 50, 75, 100, 150, 200],
158
+ }),
159
+ /**
160
+ * Every peer the manager intends to disconnect. Covers both the top-of-heartbeat
161
+ * bad-score disconnects ("banned"/"score_too_low") and the prioritization reasons;
162
+ * the older peersRequestedToDisconnect gauge only recorded the latter. Counts intent,
163
+ * not completion (goodbye is fire-and-forget).
164
+ */
165
+ peersPruned: register.counter<{reason: string}>({
166
+ name: "lodestar_peer_manager_peers_pruned_total",
167
+ help: "Total peers the peer manager intends to disconnect, labeled by reason (incl. bad-score and prioritization reasons)",
168
+ labelNames: ["reason"],
169
+ }),
170
+ /**
171
+ * Actual peer count per active subnet, to check the min-peers-per-subnet invariant.
172
+ * Buckets straddle the target (TARGET_SUBNET_PEERS = 6).
173
+ */
174
+ peersPerActiveSubnet: register.histogram<{type: SubnetType}>({
175
+ name: "lodestar_peer_manager_peers_per_active_subnet",
176
+ help: "Histogram of connected peer count per active subnet, labeled by subnet type",
177
+ labelNames: ["type"],
178
+ buckets: [0, 2, 4, 6, 8, 12],
179
+ }),
180
+ /**
181
+ * Live outbound ratio, to check the OUTBOUND_PEERS_RATIO (10%) invariant (issue #2215).
182
+ * Denominator is connected healthy peers (banned/disconnected already removed).
183
+ */
184
+ outboundPeersRatio: register.gauge({
185
+ name: "lodestar_peer_manager_outbound_peers_ratio",
186
+ help: "Ratio of outbound peers to total connected healthy peers, verifies the outbound peers invariant",
187
+ }),
188
+ /**
189
+ * Score state crossings (Healthy/Disconnected/Banned). Sensitive to the decay formula,
190
+ * thresholds, and gossip-score weighting.
191
+ */
192
+ scoreStateTransitions: register.counter<{from: string; to: string}>({
193
+ name: "lodestar_peer_score_state_transitions_total",
194
+ help: "Total peer score state transitions, labeled by from and to state (Healthy/Disconnected/Banned)",
195
+ labelNames: ["from", "to"],
196
+ }),
197
+ /**
198
+ * Entry count of the score store (not bytes). Reflects the prune-to-MAX_ENTRIES /
199
+ * SCORE_THRESHOLD retention logic. Also the denominator for scoreUpdateDuration
200
+ * time-per-peer (that loop iterates the whole store, not just connected peers).
201
+ */
202
+ scoreMapSize: register.gauge({
203
+ name: "lodestar_peer_manager_score_map_size",
204
+ help: "Current number of entries in the peer score store",
205
+ }),
206
+ /**
207
+ * Entry count of the connectedPeers map (not bytes). Should track libp2p_peers; a
208
+ * persistent gap indicates the connection leak guarded by leakedConnectionsCount.
209
+ */
210
+ connectedPeersMapSize: register.gauge({
211
+ name: "lodestar_peer_manager_connected_peers_map_size",
212
+ help: "Current number of entries in the peer manager connectedPeers map",
213
+ }),
214
+ /**
215
+ * assertPeerRelevance outcome per Status exchange: "relevant", an irrelevant reason
216
+ * code, or "error". Fires on every status evaluation (inbound requests and our own
217
+ * requestStatus responses both route through onStatus).
218
+ */
219
+ relevanceCheck: register.counter<{result: string}>({
220
+ name: "lodestar_peer_relevance_check_total",
221
+ help: "Total peer relevance checks on Status, labeled by result (relevant or irrelevant reason code)",
222
+ labelNames: ["result"],
223
+ }),
130
224
  },
131
225
  leakedConnectionsCount: register.gauge({
132
226
  name: "lodestar_peer_manager_leaked_connections_count",
@@ -13,9 +13,17 @@ export enum ENRRelevance {
13
13
  }
14
14
 
15
15
  export function enrRelevance(enr: ENR, config: BeaconConfig, clock: IClock): ENRRelevance {
16
- // We are not interested in peers that don't advertise at least one transport (tcp or quic)
17
- const multiaddrTCP = enr.getLocationMultiaddr(ENRKey.tcp);
18
- const multiaddrQUIC = enr.getLocationMultiaddr(ENRKey.quic);
16
+ // We are not interested in peers that don't advertise at least one transport (tcp or quic).
17
+ let multiaddrTCP: ReturnType<ENR["getLocationMultiaddr"]>;
18
+ let multiaddrQUIC: ReturnType<ENR["getLocationMultiaddr"]>;
19
+ // Malformed ENR endpoint fields can make multiaddr conversion throw.
20
+ // Treat endpoints that cannot be converted as unusable.
21
+ try {
22
+ multiaddrTCP = enr.getLocationMultiaddr(ENRKey.tcp);
23
+ multiaddrQUIC = enr.getLocationMultiaddr(ENRKey.quic);
24
+ } catch {
25
+ return ENRRelevance.no_transport;
26
+ }
19
27
  if (!multiaddrTCP && !multiaddrQUIC) {
20
28
  return ENRRelevance.no_transport;
21
29
  }
@@ -52,6 +52,13 @@ export function fastMsgIdFn(rpcMsg: RPC.Message): string {
52
52
  }
53
53
 
54
54
  export function msgIdToStrFn(msgId: Uint8Array): string {
55
+ // Spec mandates a 20-byte gossipsub message-id, but control-message IDs from peers
56
+ // can be any length. Reject non-20-byte IDs to avoid a Buffer.set() RangeError on
57
+ // longer IDs and stale shared-buffer bytes on shorter ones.
58
+ // Ref: https://github.com/ethereum/consensus-specs/blob/v1.7.0-alpha.10/specs/phase0/p2p-interface.md?plain=1#L486
59
+ if (msgId.length !== 20) {
60
+ throw Error(`Expect msgId to be 20 bytes, got ${msgId.length}`);
61
+ }
55
62
  // this is the same logic to `toHex(msgId)` with better performance
56
63
  sharedMsgIdBuf.set(msgId);
57
64
  return `0x${sharedMsgIdBuf.toString("hex")}`;
@@ -35,7 +35,7 @@ import {
35
35
  computeGossipPeerScoreParams,
36
36
  gossipScoreThresholds,
37
37
  } from "./scoringParameters.js";
38
- import {GossipTopicCache, getCoreTopicsAtFork, stringifyGossipTopic} from "./topic.js";
38
+ import {GossipTopicCache, getAllowedTopics, getCoreTopicsAtFork, stringifyGossipTopic} from "./topic.js";
39
39
 
40
40
  /** As specified in https://github.com/ethereum/consensus-specs/blob/v1.1.10/specs/phase0/p2p-interface.md */
41
41
  const GOSSIPSUB_HEARTBEAT_INTERVAL = 0.7 * 1000;
@@ -140,6 +140,7 @@ export class Eth2Gossipsub {
140
140
  const gossipsubInstance = gossipsub({
141
141
  globalSignaturePolicy: StrictNoSign,
142
142
  allowPublishToZeroTopicPeers: allowPublishToZeroPeers,
143
+ allowedTopics: getAllowedTopics(networkConfig),
143
144
  D: gossipsubD ?? GOSSIP_D,
144
145
  Dlo: gossipsubDLow ?? GOSSIP_D_LOW,
145
146
  Dhi: gossipsubDHigh ?? GOSSIP_D_HIGH,
@@ -246,7 +246,7 @@ export function parseGossipTopic(forkDigestContext: ForkDigestContext, topicStr:
246
246
  export function getCoreTopicsAtFork(
247
247
  networkConfig: NetworkConfig,
248
248
  fork: ForkName,
249
- opts: {subscribeAllSubnets?: boolean; disableLightClientServer?: boolean}
249
+ opts: {subscribeAllSubnets?: boolean; subscribeAllColumnSubnets?: boolean; disableLightClientServer?: boolean}
250
250
  ): GossipTopicTypeMap[keyof GossipTopicTypeMap][] {
251
251
  // Common topics for all forks
252
252
  const topics: GossipTopicTypeMap[keyof GossipTopicTypeMap][] = [
@@ -266,7 +266,7 @@ export function getCoreTopicsAtFork(
266
266
 
267
267
  // After fulu also track data_column_sidecar_{index}
268
268
  if (ForkSeq[fork] >= ForkSeq.fulu) {
269
- topics.push(...getDataColumnSidecarTopics(networkConfig));
269
+ topics.push(...getDataColumnSidecarTopics(networkConfig, opts.subscribeAllColumnSubnets));
270
270
  }
271
271
 
272
272
  // After Deneb and before Fulu also track blob_sidecar_{subnet_id}
@@ -309,15 +309,39 @@ export function getCoreTopicsAtFork(
309
309
  return topics;
310
310
  }
311
311
 
312
+ /**
313
+ * Build the complete set of valid gossip topic strings across every fork boundary.
314
+ */
315
+ export function getAllowedTopics(networkConfig: NetworkConfig): Set<string> {
316
+ const {config} = networkConfig;
317
+ const allowedTopics = new Set<string>();
318
+
319
+ for (const boundary of config.forkBoundariesAscendingEpochOrder) {
320
+ const topics = getCoreTopicsAtFork(networkConfig, boundary.fork, {
321
+ subscribeAllSubnets: true,
322
+ subscribeAllColumnSubnets: true,
323
+ disableLightClientServer: false,
324
+ });
325
+ for (const topic of topics) {
326
+ allowedTopics.add(stringifyGossipTopic(config, {...topic, boundary}));
327
+ }
328
+ }
329
+
330
+ return allowedTopics;
331
+ }
332
+
312
333
  /**
313
334
  * Pick data column subnets to subscribe to post-fulu.
314
335
  */
315
336
  export function getDataColumnSidecarTopics(
316
- networkConfig: NetworkConfig
337
+ networkConfig: NetworkConfig,
338
+ subscribeAllColumnSubnets = false
317
339
  ): GossipTopicTypeMap[keyof GossipTopicTypeMap][] {
318
340
  const topics: GossipTopicTypeMap[keyof GossipTopicTypeMap][] = [];
319
341
 
320
- const subnets = networkConfig.custodyConfig.sampledSubnets;
342
+ const subnets = subscribeAllColumnSubnets
343
+ ? Array.from({length: networkConfig.config.DATA_COLUMN_SIDECAR_SUBNET_COUNT}, (_, i) => i)
344
+ : networkConfig.custodyConfig.sampledSubnets;
321
345
  for (const subnet of subnets) {
322
346
  topics.push({type: GossipType.data_column_sidecar, subnet});
323
347
  }
@@ -415,8 +415,10 @@ export class PeerManager {
415
415
  );
416
416
  if (irrelevantReasonType === null) {
417
417
  isIrrelevant = false;
418
+ this.metrics?.peerManager.relevanceCheck.inc({result: "relevant"});
418
419
  } else {
419
420
  isIrrelevant = true;
421
+ this.metrics?.peerManager.relevanceCheck.inc({result: irrelevantReasonType.code});
420
422
  this.logger.debug("Irrelevant peer", {
421
423
  peer: prettyPrintPeerId(peer),
422
424
  reason: renderIrrelevantPeerType(irrelevantReasonType),
@@ -424,6 +426,7 @@ export class PeerManager {
424
426
  }
425
427
  } catch (e) {
426
428
  this.logger.error("Irrelevant peer - unexpected error", {peer: prettyPrintPeerId(peer)}, e as Error);
429
+ this.metrics?.peerManager.relevanceCheck.inc({result: "error"});
427
430
  isIrrelevant = true;
428
431
  }
429
432
 
@@ -552,15 +555,18 @@ export class PeerManager {
552
555
  for (const peer of connectedPeers) {
553
556
  switch (this.peerRpcScores.getScoreState(peer)) {
554
557
  case ScoreState.Banned:
558
+ this.metrics?.peerManager.peersPruned.inc({reason: "banned"});
555
559
  void this.goodbyeAndDisconnect(peer, GoodByeReasonCode.BANNED);
556
560
  break;
557
561
  case ScoreState.Disconnected:
562
+ this.metrics?.peerManager.peersPruned.inc({reason: "score_too_low"});
558
563
  void this.goodbyeAndDisconnect(peer, GoodByeReasonCode.SCORE_TOO_LOW);
559
564
  break;
560
565
  case ScoreState.Healthy:
561
566
  connectedHealthyPeers.push(peer);
562
567
  }
563
568
  }
569
+ this.metrics?.peerManager.peersEvaluated.observe(connectedHealthyPeers.length);
564
570
 
565
571
  const status = this.statusCache.get();
566
572
  const starved =
@@ -572,6 +578,7 @@ export class PeerManager {
572
578
  this.metrics?.peerManager.starved.set(starved ? 1 : 0);
573
579
  const forkSeq = this.config.getForkSeq(this.clock.currentSlot);
574
580
 
581
+ const prioritizeTimer = this.metrics?.peerManager.prioritizePeersDuration.startTimer();
575
582
  const {peersToDisconnect, peersToConnect, attnetQueries, syncnetQueries, custodyGroupQueries} = prioritizePeers(
576
583
  connectedHealthyPeers.map((peer) => {
577
584
  const peerData = this.connectedPeers.get(peer.toString());
@@ -601,6 +608,7 @@ export class PeerManager {
601
608
  this.config,
602
609
  this.metrics
603
610
  );
611
+ prioritizeTimer?.();
604
612
 
605
613
  const queriesMerged: SubnetDiscvQueryMs[] = [];
606
614
  for (const {type, queries} of [
@@ -632,6 +640,7 @@ export class PeerManager {
632
640
  // disconnect first to have more slots before we dial new peers
633
641
  for (const [reason, peers] of peersToDisconnect) {
634
642
  this.metrics?.peersRequestedToDisconnect.inc({reason}, peers.length);
643
+ this.metrics?.peerManager.peersPruned.inc({reason}, peers.length);
635
644
  for (const peer of peers) {
636
645
  void this.goodbyeAndDisconnect(peer, GoodByeReasonCode.TOO_MANY_PEERS);
637
646
  }
@@ -659,6 +668,8 @@ export class PeerManager {
659
668
  }
660
669
  }
661
670
 
671
+ this.metrics?.peerManager.connectedPeersMapSize.set(this.connectedPeers.size);
672
+
662
673
  timer?.();
663
674
 
664
675
  this.logger.debug("peerManager heartbeat result", {
@@ -1,4 +1,5 @@
1
1
  import {GoodByeReasonCode} from "../../../constants/network.js";
2
+ import {NetworkCoreMetrics} from "../../core/metrics.js";
2
3
  import {
3
4
  COOL_DOWN_BEFORE_DECAY_MS,
4
5
  DEFAULT_SCORE,
@@ -23,13 +24,15 @@ export class RealScore implements IPeerScore {
23
24
  /** The final score, computed from the above */
24
25
  private score: number;
25
26
  private lastUpdate: number;
27
+ private readonly metrics: NetworkCoreMetrics | null;
26
28
 
27
- constructor() {
29
+ constructor(metrics: NetworkCoreMetrics | null = null) {
28
30
  this.lodestarScore = DEFAULT_SCORE;
29
31
  this.gossipScore = DEFAULT_SCORE;
30
32
  this.score = DEFAULT_SCORE;
31
33
  this.ignoreNegativeGossipScore = false;
32
34
  this.lastUpdate = Date.now();
35
+ this.metrics = metrics;
33
36
  }
34
37
 
35
38
  isCoolingDown(): boolean {
@@ -136,6 +139,10 @@ export class RealScore implements IPeerScore {
136
139
  this.recomputeScore();
137
140
  const newState = scoreToState(this.score);
138
141
 
142
+ if (prevState !== newState) {
143
+ this.metrics?.peerManager.scoreStateTransitions.inc({from: prevState, to: newState});
144
+ }
145
+
139
146
  if (prevState !== ScoreState.Banned && newState === ScoreState.Banned) {
140
147
  // ban this peer for at least BANNED_BEFORE_DECAY_MS seconds
141
148
  this.lastUpdate = Date.now() + COOL_DOWN_BEFORE_DECAY_MS;
@@ -32,7 +32,9 @@ export class PeerRpcScoreStore implements IPeerRpcScoreStore {
32
32
  constructor(opts: PeerRpcScoreOpts = {}, metrics: NetworkCoreMetrics | null = null, logger: Logger | null = null) {
33
33
  this.metrics = metrics;
34
34
  this.logger = logger;
35
- this.scores = opts.disablePeerScoring ? new MapDef(() => new MaxScore()) : new MapDef(() => new RealScore());
35
+ this.scores = opts.disablePeerScoring
36
+ ? new MapDef(() => new MaxScore())
37
+ : new MapDef(() => new RealScore(this.metrics));
36
38
  }
37
39
 
38
40
  getScore(peer: PeerId): number {
@@ -75,6 +77,8 @@ export class PeerRpcScoreStore implements IPeerRpcScoreStore {
75
77
  }
76
78
 
77
79
  update(): void {
80
+ const timer = this.metrics?.peerManager.scoreUpdateDuration.startTimer();
81
+
78
82
  // Bound size of data structures
79
83
  pruneSetToMax(this.scores, MAX_ENTRIES);
80
84
 
@@ -86,6 +90,9 @@ export class PeerRpcScoreStore implements IPeerRpcScoreStore {
86
90
  this.scores.delete(peerIdStr);
87
91
  }
88
92
  }
93
+
94
+ this.metrics?.peerManager.scoreMapSize.set(this.scores.size);
95
+ timer?.();
89
96
  }
90
97
 
91
98
  updateGossipsubScore(peerId: PeerIdStr, newScore: number, ignore: boolean): void {
@@ -7,6 +7,7 @@ import {MapDef} from "@lodestar/utils";
7
7
  import {shuffle} from "../../../util/shuffle.js";
8
8
  import {sortBy} from "../../../util/sortBy.js";
9
9
  import {NetworkCoreMetrics} from "../../core/metrics.js";
10
+ import {SubnetType} from "../../metadata.js";
10
11
  import {RequestedSubnet} from "./subnetMap.js";
11
12
 
12
13
  /** Target number of peers we'd like to have connected to a given long-lived subnet */
@@ -189,6 +190,18 @@ export function prioritizePeers(
189
190
 
190
191
  const connectedPeerCount = connectedPeers.length;
191
192
 
193
+ // Track the outbound peers invariant (we keep at least OUTBOUND_PEERS_RATIO outbound peers).
194
+ // Report 0 when there are no peers so the gauge doesn't go stale at its last value.
195
+ if (metrics) {
196
+ let outboundPeerCount = 0;
197
+ for (const peer of connectedPeers) {
198
+ if (peer.direction === "outbound") {
199
+ outboundPeerCount++;
200
+ }
201
+ }
202
+ metrics.peerManager.outboundPeersRatio.set(connectedPeerCount > 0 ? outboundPeerCount / connectedPeerCount : 0);
203
+ }
204
+
192
205
  if (connectedPeerCount < targetPeers) {
193
206
  // Need more peers.
194
207
  // Instead of attempting to connect the exact amount necessary this will overshoot a little since the success
@@ -256,6 +269,7 @@ function requestSubnetPeers(
256
269
 
257
270
  for (const {subnet, toSlot} of activeAttnets) {
258
271
  const peersInSubnet = peersPerSubnet.get(subnet) ?? 0;
272
+ metrics?.peerManager.peersPerActiveSubnet.observe({type: SubnetType.attnets}, peersInSubnet);
259
273
  if (peersInSubnet < targetSubnetPeers) {
260
274
  // We need more peers
261
275
  attnetQueries.push({subnet, toSlot, maxPeersToDiscover: targetSubnetPeers - peersInSubnet});
@@ -282,6 +296,7 @@ function requestSubnetPeers(
282
296
 
283
297
  for (const {subnet, toSlot} of activeSyncnets) {
284
298
  const peersInSubnet = peersPerSubnet.get(subnet) ?? 0;
299
+ metrics?.peerManager.peersPerActiveSubnet.observe({type: SubnetType.syncnets}, peersInSubnet);
285
300
  if (peersInSubnet < targetSubnetPeers) {
286
301
  // We need more peers
287
302
  syncnetQueries.push({subnet, toSlot, maxPeersToDiscover: targetSubnetPeers - peersInSubnet});
@@ -1241,6 +1241,11 @@ function getSequentialHandlers(modules: ValidatorFnsModules, options: GossipHand
1241
1241
  payloadAttestationMessage.data.payloadPresent,
1242
1242
  payloadAttestationMessage.data.blobDataAvailable
1243
1243
  );
1244
+
1245
+ chain.emitter.emit(routes.events.EventType.payloadAttestationMessage, {
1246
+ version: config.getForkName(payloadAttestationMessage.data.slot),
1247
+ data: payloadAttestationMessage,
1248
+ });
1244
1249
  },
1245
1250
  [GossipType.execution_payload_bid]: async ({
1246
1251
  gossipData,