@lodestar/beacon-node 1.49.0-dev.c9061c6942 → 1.49.0-dev.c9d60c8080

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 (128) hide show
  1. package/lib/api/impl/beacon/blocks/index.js +2 -2
  2. package/lib/api/impl/beacon/blocks/index.js.map +1 -1
  3. package/lib/api/impl/validator/index.d.ts.map +1 -1
  4. package/lib/api/impl/validator/index.js +9 -7
  5. package/lib/api/impl/validator/index.js.map +1 -1
  6. package/lib/chain/archiveStore/historicalState/metrics.d.ts.map +1 -1
  7. package/lib/chain/archiveStore/historicalState/metrics.js +4 -0
  8. package/lib/chain/archiveStore/historicalState/metrics.js.map +1 -1
  9. package/lib/chain/archiveStore/utils/pruneHistory.d.ts.map +1 -1
  10. package/lib/chain/archiveStore/utils/pruneHistory.js +14 -3
  11. package/lib/chain/archiveStore/utils/pruneHistory.js.map +1 -1
  12. package/lib/chain/blocks/index.js +2 -2
  13. package/lib/chain/blocks/index.js.map +1 -1
  14. package/lib/chain/blocks/payloadEnvelopeInput/types.d.ts +1 -1
  15. package/lib/chain/blocks/payloadEnvelopeInput/types.d.ts.map +1 -1
  16. package/lib/chain/emitter.d.ts +10 -0
  17. package/lib/chain/emitter.d.ts.map +1 -1
  18. package/lib/chain/emitter.js +4 -0
  19. package/lib/chain/emitter.js.map +1 -1
  20. package/lib/chain/errors/attesterSlashingError.d.ts +4 -1
  21. package/lib/chain/errors/attesterSlashingError.d.ts.map +1 -1
  22. package/lib/chain/errors/attesterSlashingError.js +1 -0
  23. package/lib/chain/errors/attesterSlashingError.js.map +1 -1
  24. package/lib/chain/errors/payloadAttestation.d.ts +4 -0
  25. package/lib/chain/errors/payloadAttestation.d.ts.map +1 -1
  26. package/lib/chain/errors/payloadAttestation.js +1 -0
  27. package/lib/chain/errors/payloadAttestation.js.map +1 -1
  28. package/lib/chain/errors/proposerSlashingError.d.ts +4 -1
  29. package/lib/chain/errors/proposerSlashingError.d.ts.map +1 -1
  30. package/lib/chain/errors/proposerSlashingError.js +1 -0
  31. package/lib/chain/errors/proposerSlashingError.js.map +1 -1
  32. package/lib/chain/options.d.ts +0 -4
  33. package/lib/chain/options.d.ts.map +1 -1
  34. package/lib/chain/options.js +0 -1
  35. package/lib/chain/options.js.map +1 -1
  36. package/lib/chain/produceBlock/produceBlockBody.d.ts.map +1 -1
  37. package/lib/chain/produceBlock/produceBlockBody.js +6 -6
  38. package/lib/chain/produceBlock/produceBlockBody.js.map +1 -1
  39. package/lib/chain/seenCache/seenPayloadEnvelopeInput.d.ts +2 -1
  40. package/lib/chain/seenCache/seenPayloadEnvelopeInput.d.ts.map +1 -1
  41. package/lib/chain/seenCache/seenPayloadEnvelopeInput.js +3 -2
  42. package/lib/chain/seenCache/seenPayloadEnvelopeInput.js.map +1 -1
  43. package/lib/chain/validation/attesterSlashing.d.ts.map +1 -1
  44. package/lib/chain/validation/attesterSlashing.js +1 -2
  45. package/lib/chain/validation/attesterSlashing.js.map +1 -1
  46. package/lib/chain/validation/payloadAttestationMessage.d.ts.map +1 -1
  47. package/lib/chain/validation/payloadAttestationMessage.js +8 -1
  48. package/lib/chain/validation/payloadAttestationMessage.js.map +1 -1
  49. package/lib/chain/validation/proposerSlashing.js +1 -2
  50. package/lib/chain/validation/proposerSlashing.js.map +1 -1
  51. package/lib/chain/validatorMonitor.d.ts.map +1 -1
  52. package/lib/chain/validatorMonitor.js +2 -2
  53. package/lib/chain/validatorMonitor.js.map +1 -1
  54. package/lib/db/repositories/blockArchive.d.ts +5 -0
  55. package/lib/db/repositories/blockArchive.d.ts.map +1 -1
  56. package/lib/db/repositories/blockArchive.js +36 -1
  57. package/lib/db/repositories/blockArchive.js.map +1 -1
  58. package/lib/metrics/metrics/lodestar.d.ts +5 -1
  59. package/lib/metrics/metrics/lodestar.d.ts.map +1 -1
  60. package/lib/metrics/metrics/lodestar.js +10 -0
  61. package/lib/metrics/metrics/lodestar.js.map +1 -1
  62. package/lib/network/gossip/encoding.d.ts +1 -2
  63. package/lib/network/gossip/encoding.d.ts.map +1 -1
  64. package/lib/network/gossip/encoding.js +5 -10
  65. package/lib/network/gossip/encoding.js.map +1 -1
  66. package/lib/network/gossip/gossipsub.d.ts.map +1 -1
  67. package/lib/network/gossip/gossipsub.js +16 -1
  68. package/lib/network/gossip/gossipsub.js.map +1 -1
  69. package/lib/network/gossip/topic.d.ts +9 -6
  70. package/lib/network/gossip/topic.d.ts.map +1 -1
  71. package/lib/network/gossip/topic.js +23 -8
  72. package/lib/network/gossip/topic.js.map +1 -1
  73. package/lib/network/processor/gossipHandlers.d.ts.map +1 -1
  74. package/lib/network/processor/gossipHandlers.js +16 -5
  75. package/lib/network/processor/gossipHandlers.js.map +1 -1
  76. package/lib/network/processor/gossipValidatorFn.d.ts +2 -0
  77. package/lib/network/processor/gossipValidatorFn.d.ts.map +1 -1
  78. package/lib/network/processor/gossipValidatorFn.js +88 -7
  79. package/lib/network/processor/gossipValidatorFn.js.map +1 -1
  80. package/lib/network/processor/index.d.ts +6 -2
  81. package/lib/network/processor/index.d.ts.map +1 -1
  82. package/lib/network/processor/index.js +62 -24
  83. package/lib/network/processor/index.js.map +1 -1
  84. package/lib/network/reqresp/protocols.d.ts.map +1 -1
  85. package/lib/network/reqresp/protocols.js +19 -5
  86. package/lib/network/reqresp/protocols.js.map +1 -1
  87. package/lib/sync/types.d.ts +21 -0
  88. package/lib/sync/types.d.ts.map +1 -1
  89. package/lib/sync/types.js +22 -0
  90. package/lib/sync/types.js.map +1 -1
  91. package/lib/sync/unknownBlock.d.ts +20 -0
  92. package/lib/sync/unknownBlock.d.ts.map +1 -1
  93. package/lib/sync/unknownBlock.js +158 -2
  94. package/lib/sync/unknownBlock.js.map +1 -1
  95. package/lib/util/sszBytes.d.ts +5 -0
  96. package/lib/util/sszBytes.d.ts.map +1 -1
  97. package/lib/util/sszBytes.js +13 -1
  98. package/lib/util/sszBytes.js.map +1 -1
  99. package/package.json +14 -14
  100. package/src/api/impl/beacon/blocks/index.ts +2 -2
  101. package/src/api/impl/validator/index.ts +9 -7
  102. package/src/chain/archiveStore/historicalState/metrics.ts +4 -0
  103. package/src/chain/archiveStore/utils/pruneHistory.ts +14 -4
  104. package/src/chain/blocks/index.ts +2 -2
  105. package/src/chain/blocks/payloadEnvelopeInput/types.ts +1 -1
  106. package/src/chain/emitter.ts +7 -2
  107. package/src/chain/errors/attesterSlashingError.ts +3 -1
  108. package/src/chain/errors/payloadAttestation.ts +2 -0
  109. package/src/chain/errors/proposerSlashingError.ts +3 -1
  110. package/src/chain/options.ts +0 -5
  111. package/src/chain/produceBlock/produceBlockBody.ts +17 -6
  112. package/src/chain/seenCache/seenPayloadEnvelopeInput.ts +3 -2
  113. package/src/chain/validation/attesterSlashing.ts +1 -2
  114. package/src/chain/validation/payloadAttestationMessage.ts +9 -0
  115. package/src/chain/validation/proposerSlashing.ts +1 -2
  116. package/src/chain/validatorMonitor.ts +12 -2
  117. package/src/db/repositories/blockArchive.ts +38 -1
  118. package/src/metrics/metrics/lodestar.ts +17 -1
  119. package/src/network/gossip/encoding.ts +5 -8
  120. package/src/network/gossip/gossipsub.ts +19 -2
  121. package/src/network/gossip/topic.ts +25 -7
  122. package/src/network/processor/gossipHandlers.ts +18 -5
  123. package/src/network/processor/gossipValidatorFn.ts +111 -7
  124. package/src/network/processor/index.ts +81 -24
  125. package/src/network/reqresp/protocols.ts +31 -6
  126. package/src/sync/types.ts +24 -3
  127. package/src/sync/unknownBlock.ts +166 -1
  128. package/src/util/sszBytes.ts +18 -0
@@ -26,7 +26,13 @@ import {ExecutionPayloadStatus} from "../../execution/index.js";
26
26
  import {GossipType} from "../../network/index.js";
27
27
  import {CannotAcceptWorkReason, ReprocessRejectReason} from "../../network/processor/index.js";
28
28
  import {BackfillSyncMethod} from "../../sync/backfill/backfill.js";
29
- import {DownloadResult, DroppedItemReason, FetchResult, PendingBlockType} from "../../sync/types.js";
29
+ import {
30
+ DeferredPayloadResult,
31
+ DownloadResult,
32
+ DroppedItemReason,
33
+ FetchResult,
34
+ PendingBlockType,
35
+ } from "../../sync/types.js";
30
36
  import {PeerSyncType, RangeSyncType} from "../../sync/utils/remoteSyncType.js";
31
37
  import {AllocSource} from "../../util/bufferPool.js";
32
38
  import {DataColumnReconstructionCode} from "../../util/dataColumns.js";
@@ -655,6 +661,16 @@ export function createLodestarMetrics(
655
661
  help: "Count of payload (execution payload envelope) sync triggers, labeled by their source",
656
662
  labelNames: ["source"],
657
663
  }),
664
+ deferredPayloadResult: register.counter<{result: DeferredPayloadResult}>({
665
+ name: "lodestar_sync_deferred_payload_result_total",
666
+ help: "Outcome of a slot's deferred optimistic payload searches, by result",
667
+ labelNames: ["result"],
668
+ }),
669
+ deferredPayloadPolls: register.histogram({
670
+ name: "lodestar_sync_deferred_payload_polls_count",
671
+ help: "Poll ticks after PAYLOAD_DUE until a searched payload was imported",
672
+ buckets: [0, 1, 2, 3, 6],
673
+ }),
658
674
  pendingBlocks: register.gauge({
659
675
  name: "lodestar_sync_unknown_block_pending_blocks_size",
660
676
  help: "Current size of UnknownBlockSync pending blocks cache",
@@ -8,7 +8,7 @@ import {ForkName} from "@lodestar/params";
8
8
  import {intToBytes} from "@lodestar/utils";
9
9
  import {MESSAGE_DOMAIN_VALID_SNAPPY} from "./constants.js";
10
10
  import {Eth2GossipsubMetrics} from "./metrics.js";
11
- import {GossipTopicCache, getGossipSSZMaxSize, getGossipSSZType} from "./topic.js";
11
+ import {GossipTopicCache} from "./topic.js";
12
12
 
13
13
  // Load WASM
14
14
  const xxhash = await xxhashFactory();
@@ -97,7 +97,6 @@ export function msgIdFn(gossipTopicCache: GossipTopicCache, msg: Message): Uint8
97
97
  export class DataTransformSnappy implements DataTransform {
98
98
  constructor(
99
99
  private readonly gossipTopicCache: GossipTopicCache,
100
- private readonly maxPayloadSize: number,
101
100
  private readonly metrics: Eth2GossipsubMetrics | null
102
101
  ) {}
103
102
 
@@ -112,12 +111,11 @@ export class DataTransformSnappy implements DataTransform {
112
111
  const uncompressedDataLength = snappyWasm.decompress_len(data);
113
112
 
114
113
  const topic = this.gossipTopicCache.getTopic(topicStr);
115
- const sszType = getGossipSSZType(topic);
116
- const maxSize = getGossipSSZMaxSize(topic, this.maxPayloadSize, sszType);
114
+ const {minSize, maxSize} = this.gossipTopicCache.getTypeSizes(topicStr);
117
115
  this.metrics?.dataTransform.inbound.inc({type: topic.type});
118
116
 
119
- if (uncompressedDataLength < sszType.minSize) {
120
- throw Error(`ssz_snappy decoded data length ${uncompressedDataLength} < ${sszType.minSize}`);
117
+ if (uncompressedDataLength < minSize) {
118
+ throw Error(`ssz_snappy decoded data length ${uncompressedDataLength} < ${minSize}`);
121
119
  }
122
120
  if (uncompressedDataLength > maxSize) {
123
121
  throw Error(`ssz_snappy decoded data length ${uncompressedDataLength} > ${maxSize}`);
@@ -136,8 +134,7 @@ export class DataTransformSnappy implements DataTransform {
136
134
  */
137
135
  outboundTransform(topicStr: string, data: Uint8Array): Uint8Array {
138
136
  const topic = this.gossipTopicCache.getTopic(topicStr);
139
- const sszType = getGossipSSZType(topic);
140
- const maxSize = getGossipSSZMaxSize(topic, this.maxPayloadSize, sszType);
137
+ const {maxSize} = this.gossipTopicCache.getTypeSizes(topicStr);
141
138
  this.metrics?.dataTransform.outbound.inc({type: topic.type});
142
139
  if (data.length > maxSize) {
143
140
  throw Error(`ssz_snappy encoded data length ${data.length} > ${maxSize}`);
@@ -14,7 +14,7 @@ import {peerIdFromString} from "@libp2p/peer-id";
14
14
  import {type Multiaddr, multiaddr} from "@multiformats/multiaddr";
15
15
  import {ENR} from "@chainsafe/enr";
16
16
  import {routes} from "@lodestar/api";
17
- import {BeaconConfig, ForkBoundary} from "@lodestar/config";
17
+ import {BeaconConfig, ChainConfig, ForkBoundary} from "@lodestar/config";
18
18
  import {
19
19
  ATTESTATION_SUBNET_COUNT,
20
20
  MAX_SIGNED_AGGREGATE_AND_PROOF_SIZE,
@@ -47,6 +47,22 @@ const GOSSIPSUB_HEARTBEAT_INTERVAL = 0.7 * 1000;
47
47
 
48
48
  const MAX_OUTBOUND_BUFFER_SIZE = 2 ** 24; // 16MB
49
49
 
50
+ /**
51
+ * Snappy worst-case compressed length for a payload of `n` bytes
52
+ * https://github.com/ethereum/consensus-specs/blob/v1.7.0-beta.0/specs/phase0/p2p-interface.md#max_compressed_len
53
+ */
54
+ function maxCompressedLen(n: number): number {
55
+ return 32 + n + Math.floor(n / 6);
56
+ }
57
+
58
+ /**
59
+ * Max size of an inbound gossipsub RPC frame, including all bundled messages and control
60
+ * https://github.com/ethereum/consensus-specs/blob/v1.7.0-beta.0/specs/phase0/p2p-interface.md#max_message_size
61
+ */
62
+ function getMaxInboundDataLength(config: Pick<ChainConfig, "MAX_PAYLOAD_SIZE">): number {
63
+ return Math.max(maxCompressedLen(config.MAX_PAYLOAD_SIZE) + 1024, 1024 * 1024);
64
+ }
65
+
50
66
  export type Eth2Context = {
51
67
  activeValidatorCount: number;
52
68
  currentSlot: number;
@@ -168,7 +184,7 @@ export class Eth2Gossipsub {
168
184
  fastMsgIdFn: fastMsgIdFn,
169
185
  msgIdFn: msgIdFn.bind(msgIdFn, gossipTopicCache),
170
186
  msgIdToStrFn: msgIdToStrFn,
171
- dataTransform: new DataTransformSnappy(gossipTopicCache, config.MAX_PAYLOAD_SIZE, metrics),
187
+ dataTransform: new DataTransformSnappy(gossipTopicCache, metrics),
172
188
  metricsRegister: metricsRegister as MetricsRegister | null,
173
189
  metricsTopicStrToLabel: metricsRegister
174
190
  ? getMetricsTopicStrToLabel(networkConfig, {disableLightClientServer: opts.disableLightClientServer ?? false})
@@ -176,6 +192,7 @@ export class Eth2Gossipsub {
176
192
  asyncValidation: true,
177
193
 
178
194
  maxOutboundBufferSize: MAX_OUTBOUND_BUFFER_SIZE,
195
+ maxInboundDataLength: getMaxInboundDataLength(config),
179
196
  // serialize message once and send to all peers when publishing
180
197
  batchPublish: true,
181
198
  // if this is false, only publish to mesh peers. If there is not enough GOSSIP_D mesh peers,
@@ -1,5 +1,5 @@
1
1
  import {type CompositeTypeAny} from "@chainsafe/ssz";
2
- import {ForkDigestContext} from "@lodestar/config";
2
+ import {BeaconConfig, ChainForkConfig, ForkDigestContext} from "@lodestar/config";
3
3
  import {
4
4
  ATTESTATION_SUBNET_COUNT,
5
5
  ForkName,
@@ -10,32 +10,47 @@ import {
10
10
  isForkPostFulu,
11
11
  isForkPostGloas,
12
12
  } from "@lodestar/params";
13
+ import {TypeSizes} from "@lodestar/reqresp";
13
14
  import {Attestation, SingleAttestation, ssz, sszTypesFor} from "@lodestar/types";
14
15
  import {GossipAction, GossipActionError, GossipErrorCode} from "../../chain/errors/gossipValidation.js";
16
+ import {computeMaxGloasDataColumnSidecarSize} from "../../util/sszBytes.js";
15
17
  import {NetworkConfig} from "../networkConfig.js";
16
18
  import {DEFAULT_ENCODING} from "./constants.js";
17
19
  import {GossipEncoding, GossipTopic, GossipTopicTypeMap, GossipType, SSZTypeOfGossipTopic} from "./interface.js";
18
20
 
19
21
  export interface IGossipTopicCache {
20
22
  getTopic(topicStr: string): GossipTopic;
23
+ getTypeSizes(topicStr: string): TypeSizes;
21
24
  }
22
25
 
23
26
  export class GossipTopicCache implements IGossipTopicCache {
24
27
  private topicsByTopicStr = new Map<string, Required<GossipTopic>>();
28
+ private typeSizesByTopicStr = new Map<string, TypeSizes>();
25
29
 
26
- constructor(private readonly forkDigestContext: ForkDigestContext) {}
30
+ constructor(private readonly config: BeaconConfig) {}
27
31
 
28
32
  /** Returns cached GossipTopic, otherwise attempts to parse it from the str */
29
33
  getTopic(topicStr: string): GossipTopic {
30
34
  let topic = this.topicsByTopicStr.get(topicStr);
31
35
  if (topic === undefined) {
32
- topic = parseGossipTopic(this.forkDigestContext, topicStr);
36
+ topic = parseGossipTopic(this.config, topicStr);
33
37
  // TODO: Consider just throwing here. We should only receive messages from known subscribed topics
34
38
  this.topicsByTopicStr.set(topicStr, topic);
35
39
  }
36
40
  return topic;
37
41
  }
38
42
 
43
+ getTypeSizes(topicStr: string): TypeSizes {
44
+ let typeSizes = this.typeSizesByTopicStr.get(topicStr);
45
+ if (typeSizes === undefined) {
46
+ const topic = this.getTopic(topicStr);
47
+ const sszType = getGossipSSZType(topic);
48
+ typeSizes = {minSize: sszType.minSize, maxSize: getGossipSSZMaxSize(topic, this.config, sszType)};
49
+ this.typeSizesByTopicStr.set(topicStr, typeSizes);
50
+ }
51
+ return typeSizes;
52
+ }
53
+
39
54
  /** Returns cached GossipTopic, otherwise returns undefined */
40
55
  getKnownTopic(topicStr: string): GossipTopic | undefined {
41
56
  return this.topicsByTopicStr.get(topicStr);
@@ -133,11 +148,14 @@ export function getGossipSSZType(topic: GossipTopic) {
133
148
  }
134
149
 
135
150
  /**
136
- * Return the maximum uncompressed SSZ byte length accepted for a gossip object, the SSZ type max size
137
- * or MAX_PAYLOAD_SIZE, whichever is smaller.
151
+ * Return the maximum uncompressed SSZ byte length allowed by the type and configured network bounds.
138
152
  */
139
- export function getGossipSSZMaxSize(topic: GossipTopic, maxPayloadSize: number, sszType?: CompositeTypeAny): number {
140
- return Math.min((sszType ?? getGossipSSZType(topic)).maxSize, maxPayloadSize);
153
+ export function getGossipSSZMaxSize(topic: GossipTopic, config: ChainForkConfig, sszType: CompositeTypeAny): number {
154
+ const maxSize = Math.min(sszType.maxSize, config.MAX_PAYLOAD_SIZE);
155
+ if (isForkPostGloas(topic.boundary.fork) && topic.type === GossipType.data_column_sidecar) {
156
+ return Math.min(maxSize, computeMaxGloasDataColumnSidecarSize(config));
157
+ }
158
+ return maxSize;
141
159
  }
142
160
 
143
161
  /**
@@ -244,8 +244,20 @@ function getSequentialHandlers(modules: ValidatorFnsModules, options: GossipHand
244
244
 
245
245
  // IGNORE means the block is acceptable (e.g. FUTURE_SLOT, ALREADY_KNOWN), just not propagated.
246
246
  // Keep the optimistically-added cache entries; they are pruned on finalization. Only REJECT
247
- // (provably invalid) and unexpected errors prune below.
247
+ // (provably invalid), unexpected errors and repeat proposals that are not imported prune.
248
248
  if (e.action === GossipAction.IGNORE) {
249
+ // Only a signature-verified sibling is imported by the beacon_block handler, any other repeat proposal
250
+ // is dropped from the caches and re-downloaded by sync if it ever becomes relevant. Its signature was not
251
+ // verified, so only its own entry is removed, never its claimed ancestors
252
+ if (
253
+ e.type.code === BlockErrorCode.REPEAT_PROPOSAL &&
254
+ !chain.seenBlockProposers.hasBlockRoot(slot, signedBlock.message.proposerIndex, blockRootHex)
255
+ ) {
256
+ chain.seenBlockInputCache.remove(blockRootHex);
257
+ if (isForkPostGloas(fork)) {
258
+ chain.seenPayloadEnvelopeInputCache.remove(blockRootHex);
259
+ }
260
+ }
249
261
  throw e;
250
262
  }
251
263
 
@@ -258,10 +270,10 @@ function getSequentialHandlers(modules: ValidatorFnsModules, options: GossipHand
258
270
  }
259
271
 
260
272
  // REJECT or unexpected (non-BlockGossipError) error: drop the optimistically-added entries from
261
- // both caches, keeping them consistent.
262
- chain.seenBlockInputCache.prune(blockRootHex);
273
+ // both caches, keeping them consistent. The block may carry any parent root, so only its own entry is removed
274
+ chain.seenBlockInputCache.remove(blockRootHex);
263
275
  if (isForkPostGloas(fork)) {
264
- chain.seenPayloadEnvelopeInputCache.prune(blockRootHex);
276
+ chain.seenPayloadEnvelopeInputCache.remove(blockRootHex);
265
277
  }
266
278
  throw e;
267
279
  } finally {
@@ -738,7 +750,8 @@ function getSequentialHandlers(modules: ValidatorFnsModules, options: GossipHand
738
750
  if (
739
751
  e instanceof BlockGossipError &&
740
752
  e.type.code === BlockErrorCode.REPEAT_PROPOSAL &&
741
- // this is make sure the block's proposer signature was verified, it should be true anyway
753
+ // Only a signature-verified sibling recorded in the seen cache is imported. The cache holds at most two
754
+ // roots per proposer and slot, which bounds full imports over gossip to one alternate
742
755
  chain.seenBlockProposers.hasBlockRoot(signedBlock.message.slot, e.type.proposerIndex, e.type.root)
743
756
  ) {
744
757
  // blockInput was optimistically seeded in validateBeaconBlock and retained on IGNORE
@@ -1,24 +1,122 @@
1
1
  import {TopicValidatorResult} from "@libp2p/gossipsub";
2
2
  import {ChainForkConfig} from "@lodestar/config";
3
3
  import {Logger} from "@lodestar/utils";
4
- import {AttestationError, GossipAction, GossipActionError} from "../../chain/errors/index.js";
4
+ import {
5
+ AttestationError,
6
+ AttestationErrorCode,
7
+ AttesterSlashingErrorCode,
8
+ BlobSidecarErrorCode,
9
+ BlockErrorCode,
10
+ BlsToExecutionChangeErrorCode,
11
+ DataColumnSidecarErrorCode,
12
+ ExecutionPayloadBidErrorCode,
13
+ ExecutionPayloadEnvelopeErrorCode,
14
+ GossipAction,
15
+ GossipActionError,
16
+ PayloadAttestationErrorCode,
17
+ ProposerPreferencesErrorCode,
18
+ ProposerSlashingErrorCode,
19
+ SyncCommitteeErrorCode,
20
+ VoluntaryExitErrorCode,
21
+ } from "../../chain/errors/index.js";
5
22
  import {Metrics} from "../../metrics/index.js";
23
+ import {INetworkCore} from "../core/index.js";
6
24
  import {
7
25
  BatchGossipHandlerFn,
8
26
  GossipHandlerFn,
9
27
  GossipHandlers,
10
28
  GossipMessageInfo,
29
+ GossipType,
11
30
  GossipValidatorBatchFn,
12
31
  GossipValidatorFn,
13
32
  } from "../gossip/interface.js";
33
+ import {PeerAction} from "../peers/index.js";
14
34
  import {prettyPrintPeerIdStr} from "../util.js";
15
35
 
16
36
  export type ValidatorFnModules = {
17
37
  config: ChainForkConfig;
18
38
  logger: Logger;
19
39
  metrics: Metrics | null;
40
+ core: INetworkCore;
41
+ };
42
+
43
+ type RejectPeerActionRule = {default: PeerAction; byCode?: Record<string, PeerAction>};
44
+
45
+ /**
46
+ * PeerAction mapping based on the topic and specific codes.
47
+ * Invalid signatures are Fatal on every topic.
48
+ */
49
+ const gossipRejectPeerAction: Record<GossipType, RejectPeerActionRule> = {
50
+ [GossipType.beacon_block]: {
51
+ default: PeerAction.LowToleranceError,
52
+ byCode: {[BlockErrorCode.PROPOSAL_SIGNATURE_INVALID]: PeerAction.Fatal},
53
+ },
54
+ [GossipType.blob_sidecar]: {
55
+ default: PeerAction.LowToleranceError,
56
+ byCode: {[BlobSidecarErrorCode.PROPOSAL_SIGNATURE_INVALID]: PeerAction.Fatal},
57
+ },
58
+ [GossipType.data_column_sidecar]: {
59
+ default: PeerAction.LowToleranceError,
60
+ byCode: {[DataColumnSidecarErrorCode.PROPOSAL_SIGNATURE_INVALID]: PeerAction.Fatal},
61
+ },
62
+ [GossipType.execution_payload]: {
63
+ default: PeerAction.LowToleranceError,
64
+ byCode: {[ExecutionPayloadEnvelopeErrorCode.INVALID_SIGNATURE]: PeerAction.Fatal},
65
+ },
66
+ [GossipType.beacon_aggregate_and_proof]: {
67
+ default: PeerAction.MidToleranceError,
68
+ byCode: {[AttestationErrorCode.INVALID_SIGNATURE]: PeerAction.Fatal},
69
+ },
70
+ [GossipType.beacon_attestation]: {
71
+ default: PeerAction.MidToleranceError,
72
+ byCode: {[AttestationErrorCode.INVALID_SIGNATURE]: PeerAction.Fatal},
73
+ },
74
+ [GossipType.sync_committee_contribution_and_proof]: {
75
+ default: PeerAction.MidToleranceError,
76
+ byCode: {[SyncCommitteeErrorCode.INVALID_SIGNATURE]: PeerAction.Fatal},
77
+ },
78
+ [GossipType.sync_committee]: {
79
+ default: PeerAction.MidToleranceError,
80
+ byCode: {[SyncCommitteeErrorCode.INVALID_SIGNATURE]: PeerAction.Fatal},
81
+ },
82
+ [GossipType.payload_attestation_message]: {
83
+ default: PeerAction.MidToleranceError,
84
+ byCode: {[PayloadAttestationErrorCode.INVALID_SIGNATURE]: PeerAction.Fatal},
85
+ },
86
+ [GossipType.execution_payload_bid]: {
87
+ default: PeerAction.HighToleranceError,
88
+ byCode: {[ExecutionPayloadBidErrorCode.INVALID_SIGNATURE]: PeerAction.Fatal},
89
+ },
90
+ [GossipType.proposer_preferences]: {
91
+ default: PeerAction.HighToleranceError,
92
+ byCode: {[ProposerPreferencesErrorCode.INVALID_SIGNATURE]: PeerAction.Fatal},
93
+ },
94
+ [GossipType.voluntary_exit]: {
95
+ default: PeerAction.HighToleranceError,
96
+ byCode: {[VoluntaryExitErrorCode.INVALID_SIGNATURE]: PeerAction.Fatal},
97
+ },
98
+ [GossipType.bls_to_execution_change]: {
99
+ default: PeerAction.HighToleranceError,
100
+ byCode: {[BlsToExecutionChangeErrorCode.INVALID_SIGNATURE]: PeerAction.Fatal},
101
+ },
102
+ [GossipType.proposer_slashing]: {
103
+ default: PeerAction.HighToleranceError,
104
+ byCode: {[ProposerSlashingErrorCode.INVALID_SIGNATURE]: PeerAction.Fatal},
105
+ },
106
+ [GossipType.attester_slashing]: {
107
+ default: PeerAction.HighToleranceError,
108
+ byCode: {[AttesterSlashingErrorCode.INVALID_SIGNATURE]: PeerAction.Fatal},
109
+ },
110
+ // light client validators only throw IGNORE
111
+ [GossipType.light_client_finality_update]: {default: PeerAction.HighToleranceError},
112
+ [GossipType.light_client_optimistic_update]: {default: PeerAction.HighToleranceError},
20
113
  };
21
114
 
115
+ function rejectPeerAction(type: GossipType, code: string): PeerAction {
116
+ const rule = gossipRejectPeerAction[type];
117
+ return rule.byCode?.[code] ?? rule.default;
118
+ }
119
+
22
120
  /**
23
121
  * Similar to getGossipValidatorFn but return a function to accept a batch of beacon_attestation messages
24
122
  * with the same attestation data
@@ -27,7 +125,7 @@ export function getGossipValidatorBatchFn(
27
125
  gossipHandlers: GossipHandlers,
28
126
  modules: ValidatorFnModules
29
127
  ): GossipValidatorBatchFn {
30
- const {logger, metrics} = modules;
128
+ const {logger, metrics, core} = modules;
31
129
 
32
130
  return async function gossipValidatorBatchFn(messageInfos: GossipMessageInfo[]) {
33
131
  // all messageInfos have same topic type
@@ -69,16 +167,19 @@ export function getGossipValidatorBatchFn(
69
167
  // only beacon_attestation topic is validated in batch
70
168
  metrics?.networkProcessor.gossipAttestationIgnoreByReason.inc({reason: e.type.code});
71
169
  return TopicValidatorResult.Ignore;
72
- case GossipAction.REJECT:
170
+ case GossipAction.REJECT: {
73
171
  metrics?.networkProcessor.gossipValidationReject.inc({topic: type});
74
172
  // only beacon_attestation topic is validated in batch
75
173
  metrics?.networkProcessor.gossipAttestationRejectByReason.inc({reason: e.type.code});
174
+ const peerAction = rejectPeerAction(type, e.type.code);
175
+ core.reportPeer(propagationSource, peerAction, e.type.code);
76
176
  logger.debug(
77
177
  `Gossip validation ${type} rejected`,
78
- {peerId: prettyPrintPeerIdStr(propagationSource), clientAgent, clientVersion},
178
+ {peer: propagationSource, clientAgent, clientVersion, peerAction},
79
179
  e
80
180
  );
81
181
  return TopicValidatorResult.Reject;
182
+ }
82
183
  }
83
184
  });
84
185
  } catch (e) {
@@ -108,7 +209,7 @@ export function getGossipValidatorBatchFn(
108
209
  * @see getGossipHandlers for reasoning on why GossipHandlerFn are used for gossip validation.
109
210
  */
110
211
  export function getGossipValidatorFn(gossipHandlers: GossipHandlers, modules: ValidatorFnModules): GossipValidatorFn {
111
- const {logger, metrics} = modules;
212
+ const {logger, metrics, core} = modules;
112
213
 
113
214
  return async function gossipValidatorFn({
114
215
  topic,
@@ -155,14 +256,17 @@ export function getGossipValidatorFn(gossipHandlers: GossipHandlers, modules: Va
155
256
  metrics?.networkProcessor.gossipValidationIgnore.inc({topic: type});
156
257
  return TopicValidatorResult.Ignore;
157
258
 
158
- case GossipAction.REJECT:
259
+ case GossipAction.REJECT: {
159
260
  metrics?.networkProcessor.gossipValidationReject.inc({topic: type});
261
+ const peerAction = rejectPeerAction(type, e.type.code);
262
+ core.reportPeer(propagationSource, peerAction, e.type.code);
160
263
  logger.debug(
161
264
  `Gossip validation ${type} rejected`,
162
- {peerId: prettyPrintPeerIdStr(propagationSource), clientAgent, clientVersion},
265
+ {peer: propagationSource, clientAgent, clientVersion, peerAction},
163
266
  e
164
267
  );
165
268
  return TopicValidatorResult.Reject;
269
+ }
166
270
  }
167
271
  }
168
272
  };
@@ -86,8 +86,13 @@ export const MAX_AWAITING_MESSAGES_PER_ROOT: Partial<Record<GossipType, number>>
86
86
 
87
87
  /**
88
88
  * Track the forwarded peers we already emit to UnknownBlockInput sync.
89
+ * envelopeSlotEmitted: whether the unknownEnvelopeBlockRootSlot event was already emitted for this root.
89
90
  */
90
- type SearchedRootEntry = {blockPeerIds?: Set<PeerIdStr>; envelopePeerIds?: Set<PeerIdStr>};
91
+ type SearchedRootEntry = {
92
+ blockPeerIds?: Set<PeerIdStr>;
93
+ envelopePeerIds?: Set<PeerIdStr>;
94
+ envelopeSlotEmitted?: boolean;
95
+ };
91
96
 
92
97
  /**
93
98
  * This is respective to gossipsub seenTTL (which is 550 * 0.7 = 385s), also it's respective
@@ -192,6 +197,19 @@ type PreprocessResult =
192
197
  | {action: PreprocessAction.AwaitBlock; root: RootHex}
193
198
  | {action: PreprocessAction.AwaitEnvelope; root: RootHex};
194
199
 
200
+ enum SearchTarget {
201
+ Block,
202
+ PayloadEnvelope,
203
+ }
204
+
205
+ type SearchUnknownRootTarget =
206
+ | {target: SearchTarget.Block}
207
+ | {
208
+ target: SearchTarget.PayloadEnvelope;
209
+ /** The message slot is the payload's slot, so it can be used for UnknownBlockInput search */
210
+ slotIsPayloadSlot: boolean;
211
+ };
212
+
195
213
  /**
196
214
  * Network processor handles the gossip queues and throtles processing to not overload the main thread
197
215
  * - Decides when to process work and what to process
@@ -347,12 +365,17 @@ export class NetworkProcessor {
347
365
  }
348
366
 
349
367
  /**
350
- * Search envelope via `ChainEvent.unknownEnvelopeBlockRoot` event
368
+ * Search envelope via `ChainEvent.unknownEnvelopeBlockRoot` / `ChainEvent.unknownEnvelopeBlockRootSlot` event
351
369
  * Slot is the message slot, which is not necessarily the same as the envelope's slot, but it can be used for a good prune strategy.
352
370
  * In the rare case, if 2 messages on 2 slots search for the same root (for example beacon_attestation) we may emit the same root twice but BlockInputSync should handle it well.
353
371
  * Same peer-forwarding + dedup behavior as searchUnknownBlock.
354
372
  */
355
- searchUnknownEnvelope({slot, root}: SlotRootHex, source: BlockInputSource, peer?: PeerIdStr): void {
373
+ searchUnknownEnvelope(
374
+ {slot, root}: SlotRootHex,
375
+ source: BlockInputSource,
376
+ peer?: PeerIdStr,
377
+ slotIsPayloadSlot = false
378
+ ): void {
356
379
  if (this.chain.seenPayloadEnvelope(root)) {
357
380
  return;
358
381
  }
@@ -369,8 +392,17 @@ export class NetworkProcessor {
369
392
  forwardedPeers.add(peer);
370
393
  shouldEmit = true;
371
394
  }
395
+ // the payload-slot seed must reach the sync once, even if a slot-less trigger started the search first
396
+ if (slotIsPayloadSlot && !entry.envelopeSlotEmitted) {
397
+ shouldEmit = true;
398
+ }
372
399
  if (shouldEmit) {
373
- this.chain.emitter.emit(ChainEvent.unknownEnvelopeBlockRoot, {rootHex: root, slot, peer, source});
400
+ if (slotIsPayloadSlot) {
401
+ entry.envelopeSlotEmitted = true;
402
+ this.chain.emitter.emit(ChainEvent.unknownEnvelopeBlockRootSlot, {rootHex: root, slot, peer, source});
403
+ } else {
404
+ this.chain.emitter.emit(ChainEvent.unknownEnvelopeBlockRoot, {rootHex: root, peer, source});
405
+ }
374
406
  }
375
407
  }
376
408
 
@@ -431,7 +463,7 @@ export class NetworkProcessor {
431
463
  // no need to check if root is a descendant of the current finalized block, it will be checked once we validate the message if needed
432
464
  if (root && !this.chain.forkChoice.hasBlockHexUnsafe(root)) {
433
465
  // starting from GLOAS, unknown root from data_column_sidecar also falls into this case
434
- this.searchUnknownRoot({slot, root}, true, false, peerId);
466
+ this.searchUnknownRoot({slot, root}, peerId, {target: SearchTarget.Block});
435
467
  // for beacon_attestation and beacon_aggregate_and_proof messages, this is only temporary.
436
468
  // if "index = 1" we need to await for the Envelope instead
437
469
  preprocessResult = {action: PreprocessAction.AwaitBlock, root};
@@ -446,27 +478,28 @@ export class NetworkProcessor {
446
478
  if (topicType === GossipType.beacon_block) {
447
479
  const parentRoot = getParentRootFromSignedBeaconBlockSerialized(message.msg.data);
448
480
  if (parentRoot) {
449
- let searchParentBlock = false;
450
- let searchParentEnvelope = false;
481
+ let search: SearchUnknownRootTarget | null = null;
451
482
  if (ForkSeq[fork] >= ForkSeq.gloas) {
452
483
  // GLOAS: also check parent envelope, same logic as execution_payload_bid
453
484
  const parentBlockHash = getParentBlockHashFromGloasSignedBeaconBlockSerialized(message.msg.data);
454
485
  if (parentBlockHash && !this.chain.forkChoice.getBlockHexAndBlockHash(parentRoot, parentBlockHash)) {
455
486
  const protoBlock = this.chain.forkChoice.getBlockHexDefaultStatus(parentRoot);
456
487
  if (protoBlock === null) {
457
- searchParentBlock = true;
488
+ search = {target: SearchTarget.Block};
458
489
  } else if (
459
490
  protoBlock.executionPayloadBlockHash &&
460
491
  protoBlock.executionPayloadBlockHash !== parentBlockHash
461
492
  ) {
462
493
  // only search for the envelope by block root if we're sure there is one. Otherwise UnknownBlockSync will penalize the peer.
463
- searchParentEnvelope = true;
494
+ search = {target: SearchTarget.PayloadEnvelope, slotIsPayloadSlot: false};
464
495
  }
465
496
  }
466
497
  } else if (!this.chain.forkChoice.hasBlockHexUnsafe(parentRoot)) {
467
- searchParentBlock = true;
498
+ search = {target: SearchTarget.Block};
499
+ }
500
+ if (search !== null) {
501
+ this.searchUnknownRoot({slot, root: parentRoot}, peerId, search);
468
502
  }
469
- this.searchUnknownRoot({slot, root: parentRoot}, searchParentBlock, searchParentEnvelope, peerId);
470
503
  }
471
504
  preprocessResult = {action: PreprocessAction.PushToQueue};
472
505
  }
@@ -485,7 +518,10 @@ export class NetworkProcessor {
485
518
  : getDataIndexFromSignedAggregateAndProofSerialized(message.msg.data);
486
519
  if (attIndex === 1 && !this.chain.forkChoice.hasPayloadHexUnsafe(root)) {
487
520
  // attestation votes that the payload is available but it is not yet known
488
- this.searchUnknownRoot({slot, root}, false, true, peerId);
521
+ this.searchUnknownRoot({slot, root}, peerId, {
522
+ target: SearchTarget.PayloadEnvelope,
523
+ slotIsPayloadSlot: false,
524
+ });
489
525
  preprocessResult = {action: PreprocessAction.AwaitEnvelope, root};
490
526
  }
491
527
  break;
@@ -494,8 +530,13 @@ export class NetworkProcessor {
494
530
  if (root == null) break;
495
531
  const payloadPresent = getPayloadPresentFromPayloadAttestationMessageSerialized(message.msg.data);
496
532
  if (payloadPresent && !this.chain.forkChoice.hasPayloadHexUnsafe(root)) {
497
- // payload attestation votes that the payload is available but it is not yet known
498
- this.searchUnknownRoot({slot, root}, false, true, peerId);
533
+ // payload attestation votes that the payload is available but it is not yet known.
534
+ // this is optimistic search, the peer may not have the payload (only the ptc committee had).
535
+ // the PTC vote's slot is the payload's slot
536
+ this.searchUnknownRoot({slot, root}, undefined, {
537
+ target: SearchTarget.PayloadEnvelope,
538
+ slotIsPayloadSlot: true,
539
+ });
499
540
  // do not await the envelope, payload attestation processing only requires that the block is known
500
541
  // also do not reset preprocessResult, we may already await for the block
501
542
  }
@@ -504,7 +545,12 @@ export class NetworkProcessor {
504
545
  case GossipType.data_column_sidecar: {
505
546
  if (root == null) break;
506
547
  if (!this.chain.forkChoice.hasPayloadHexUnsafe(root)) {
507
- this.searchUnknownRoot({slot, root}, false, true, peerId);
548
+ // this is optimistic search, the peer may not have the payload.
549
+ // the sidecar's slot is the block's (and so the payload's) slot
550
+ this.searchUnknownRoot({slot, root}, undefined, {
551
+ target: SearchTarget.PayloadEnvelope,
552
+ slotIsPayloadSlot: true,
553
+ });
508
554
  // do not await the envelope, we can do gossip validation
509
555
  // also do not reset preprocessResult, we may already await for the block
510
556
  }
@@ -515,7 +561,7 @@ export class NetworkProcessor {
515
561
  // Extract beacon_block_root directly
516
562
  const blockRoot = getBeaconBlockRootFromExecutionPayloadEnvelopeSerialized(message.msg.data);
517
563
  if (blockRoot && !this.chain.forkChoice.hasBlockHexUnsafe(blockRoot)) {
518
- this.searchUnknownRoot({slot, root: blockRoot}, true, false, peerId);
564
+ this.searchUnknownRoot({slot, root: blockRoot}, peerId, {target: SearchTarget.Block});
519
565
  // We always want to await the block
520
566
  // This allows us to properly forward the payload envelope
521
567
  preprocessResult = {action: PreprocessAction.AwaitBlock, root: blockRoot};
@@ -534,13 +580,16 @@ export class NetworkProcessor {
534
580
  ) {
535
581
  const protoBlock = this.chain.forkChoice.getBlockHexDefaultStatus(parentBlockRoot);
536
582
  if (protoBlock === null) {
537
- this.searchUnknownRoot({slot, root: parentBlockRoot}, true, false, peerId);
583
+ this.searchUnknownRoot({slot, root: parentBlockRoot}, peerId, {target: SearchTarget.Block});
538
584
  preprocessResult = {action: PreprocessAction.AwaitBlock, root: parentBlockRoot};
539
585
  } else if (
540
586
  protoBlock.executionPayloadBlockHash &&
541
587
  protoBlock.executionPayloadBlockHash !== parentBlockHash
542
588
  ) {
543
- this.searchUnknownRoot({slot, root: parentBlockRoot}, false, true, peerId);
589
+ this.searchUnknownRoot({slot, root: parentBlockRoot}, peerId, {
590
+ target: SearchTarget.PayloadEnvelope,
591
+ slotIsPayloadSlot: false,
592
+ });
544
593
  preprocessResult = {action: PreprocessAction.AwaitEnvelope, root: parentBlockRoot};
545
594
  }
546
595
  }
@@ -641,16 +690,24 @@ export class NetworkProcessor {
641
690
  return true;
642
691
  }
643
692
 
693
+ /**
694
+ * Search block/envelope given a SlotRootHex
695
+ * undefined peer id means optimistic search
696
+ */
644
697
  private searchUnknownRoot(
645
698
  slotRoot: SlotRootHex,
646
- searchBlock: boolean,
647
- searchEnvelope: boolean,
648
- peerId: PeerIdStr
699
+ peerId: PeerIdStr | undefined,
700
+ search: SearchUnknownRootTarget
649
701
  ): void {
650
- if (!searchBlock && !searchEnvelope) return;
651
702
  if (this.tooManySearchedRoots(slotRoot.slot, slotRoot.root)) return;
652
- if (searchBlock) this.searchUnknownBlock(slotRoot, BlockInputSource.network_processor, peerId);
653
- if (searchEnvelope) this.searchUnknownEnvelope(slotRoot, BlockInputSource.network_processor, peerId);
703
+ switch (search.target) {
704
+ case SearchTarget.Block:
705
+ this.searchUnknownBlock(slotRoot, BlockInputSource.network_processor, peerId);
706
+ break;
707
+ case SearchTarget.PayloadEnvelope:
708
+ this.searchUnknownEnvelope(slotRoot, BlockInputSource.network_processor, peerId, search.slotIsPayloadSlot);
709
+ break;
710
+ }
654
711
  }
655
712
 
656
713
  private pushPendingGossipsubMessageToQueue(message: PendingGossipsubMessage): void {