@lodestar/beacon-node 1.45.0-dev.b94232ff23 → 1.45.0-dev.bdb9aa149d

package/src/chain/blocks/payloadEnvelopeProcessor.ts

@@ -8,28 +8,24 @@ import {ImportPayloadOpts} from "./types.js";
 // TODO GLOAS: Set to be equal to DEFAULT_MAX_PENDING_UNFINALIZED_PAYLOAD_ENVELOPE_WRITES for now
 const QUEUE_MAX_LENGTH = 16;
 
-enum PayloadEnvelopeImportStatus {
-  queued = "queued",
-  importing = "importing",
-  imported = "imported",
-}
-
 /**
  * PayloadEnvelopeProcessor processes payload envelope jobs in a queued fashion, one after the other.
  *
  * Jobs are enqueued only on envelope arrival (gossip or API). The envelope may reach us before
  * the sampled data columns; importExecutionPayload awaits `verifyPayloadsDataAvailability`
  * internally, so a queued job can pend for up to `PAYLOAD_DATA_AVAILABILITY_TIMEOUT` while
- * waiting for columns. Duplicate triggers for the same payloadInput are deduped via `importStatus`.
+ * waiting for columns. Duplicate triggers for the same payloadInput are deduped by sharing the
+ * in-flight import promise: every caller observes the real import outcome. Resolving duplicates
+ * early instead would let BlockInputSync mark a still-pending payload as processed, re-queue it,
+ * and spin re-processing the same root until OOM while the import is blocked (e.g. EL syncing).
  */
 export class PayloadEnvelopeProcessor {
   readonly jobQueue: JobItemQueue<[PayloadEnvelopeInput, ImportPayloadOpts], void>;
-  private readonly importStatus = new WeakMap<PayloadEnvelopeInput, PayloadEnvelopeImportStatus>();
+  private readonly imports = new WeakMap<PayloadEnvelopeInput, Promise<void>>();
 
   constructor(chain: BeaconChain, metrics: Metrics | null, signal: AbortSignal) {
     this.jobQueue = new JobItemQueue<[PayloadEnvelopeInput, ImportPayloadOpts], void>(
       (payloadInput, opts) => {
-        this.importStatus.set(payloadInput, PayloadEnvelopeImportStatus.importing);
         return processExecutionPayload.call(chain, payloadInput, signal, opts);
       },
       {maxLength: QUEUE_MAX_LENGTH, noYieldIfOneItem: true, signal},
@@ -38,24 +34,28 @@ export class PayloadEnvelopeProcessor {
   }
 
   async processPayloadEnvelopeJob(payloadInput: PayloadEnvelopeInput, opts: ImportPayloadOpts = {}): Promise<void> {
-    if (this.importStatus.get(payloadInput) !== undefined) {
-      return;
+    const existing = this.imports.get(payloadInput);
+    if (existing) {
+      return existing;
     }
 
     await this.jobQueue.waitForSpace();
 
     // Re-check after await, as another call may have queued this payload.
-    if (this.importStatus.get(payloadInput) !== undefined) {
-      return;
+    const queued = this.imports.get(payloadInput);
+    if (queued) {
+      return queued;
     }
 
-    this.importStatus.set(payloadInput, PayloadEnvelopeImportStatus.queued);
+    const importPromise = this.jobQueue.push(payloadInput, opts);
+    this.imports.set(payloadInput, importPromise);
 
     try {
-      await this.jobQueue.push(payloadInput, opts);
-      this.importStatus.set(payloadInput, PayloadEnvelopeImportStatus.imported);
+      await importPromise;
     } catch (e) {
-      this.importStatus.delete(payloadInput);
+      // Drop the failed import so a later attempt can retry once the failure cause is resolved
+      // (e.g. BLOCK_NOT_IN_FORK_CHOICE after the block lands in fork choice)
+      this.imports.delete(payloadInput);
       throw e;
     }
   }

package/src/chain/chain.ts

@@ -107,7 +107,6 @@ import {
   SeenExecutionPayloadBids,
   SeenPayloadAttesters,
   SeenPayloadEnvelopeInput,
-  SeenProposerPreferences,
   SeenSyncCommitteeMessages,
 } from "./seenCache/index.js";
 import {SeenAggregatedAttestations} from "./seenCache/seenAggregateAndProof.js";
@@ -189,7 +188,6 @@ export class BeaconChain implements IBeaconChain {
   readonly seenPayloadAttesters = new SeenPayloadAttesters();
   readonly seenAggregatedAttestations: SeenAggregatedAttestations;
   readonly seenExecutionPayloadBids = new SeenExecutionPayloadBids();
-  readonly seenProposerPreferences = new SeenProposerPreferences();
   readonly seenBlockProposers = new SeenBlockProposers();
   readonly seenSyncCommitteeMessages = new SeenSyncCommitteeMessages();
   readonly seenContributionAndProof: SeenContributionAndProof;
@@ -1473,7 +1471,6 @@ export class BeaconChain implements IBeaconChain {
     this.payloadAttestationPool.prune(slot);
     this.executionPayloadBidPool.prune(slot);
     this.seenExecutionPayloadBids.prune(slot);
-    this.seenProposerPreferences.prune(slot);
     this.proposerPreferencesPool.prune(slot);
     this.seenAttestationDatas.onSlot(slot);
     this.reprocessController.onSlot(slot);

package/src/chain/interface.ts

@@ -61,7 +61,6 @@ import {
   SeenContributionAndProof,
   SeenExecutionPayloadBids,
   SeenPayloadAttesters,
-  SeenProposerPreferences,
   SeenSyncCommitteeMessages,
 } from "./seenCache/index.js";
 import {SeenAggregatedAttestations} from "./seenCache/seenAggregateAndProof.js";
@@ -133,7 +132,6 @@ export interface IBeaconChain {
   readonly seenPayloadAttesters: SeenPayloadAttesters;
   readonly seenAggregatedAttestations: SeenAggregatedAttestations;
   readonly seenExecutionPayloadBids: SeenExecutionPayloadBids;
-  readonly seenProposerPreferences: SeenProposerPreferences;
   readonly seenBlockProposers: SeenBlockProposers;
   readonly seenSyncCommitteeMessages: SeenSyncCommitteeMessages;
   readonly seenContributionAndProof: SeenContributionAndProof;

package/src/chain/opPools/proposerPreferencesPool.ts

@@ -1,4 +1,4 @@
-import {RootHex, Slot, gloas} from "@lodestar/types";
+import {RootHex, Slot, ValidatorIndex, gloas} from "@lodestar/types";
 import {toRootHex} from "@lodestar/utils";
 
 /**
@@ -22,6 +22,10 @@ export class ProposerPreferencesPool {
     return this.bySlot.get(slot)?.get(dependentRootHex) ?? null;
   }
 
+  isKnown(proposalSlot: Slot, dependentRoot: RootHex, validatorIndex: ValidatorIndex): boolean {
+    return this.get(proposalSlot, dependentRoot)?.message.validatorIndex === validatorIndex;
+  }
+
   add(signed: gloas.SignedProposerPreferences): void {
     const {proposalSlot, dependentRoot} = signed.message;
     const rootHex = toRootHex(dependentRoot);

package/src/chain/options.ts

@@ -35,6 +35,7 @@ export type IChainOptions = BlockProcessOpts &
     persistOrphanedBlocksDir?: string;
     skipCreateStateCacheIfAvailable?: boolean;
     suggestedFeeRecipient: string;
+    graffitiAppend?: boolean;
     maxSkipSlots?: number;
     /** Ensure blobs returned by the execution engine are valid */
     sanityCheckExecutionEngineBlobs?: boolean;
@@ -107,6 +108,7 @@ export const defaultChainOptions: IChainOptions = {
   computeUnrealized: true,
   fastConfirmation: false,
   suggestedFeeRecipient: defaultValidatorOptions.suggestedFeeRecipient,
+  graffitiAppend: true,
   serveHistoricalState: false,
   assertCorrectProgressiveBalances: false,
   archiveStateEpochFrequency: 1024,

package/src/chain/seenCache/index.ts

@@ -5,4 +5,3 @@ export {SeenContributionAndProof} from "./seenCommitteeContribution.js";
 export {SeenExecutionPayloadBids} from "./seenExecutionPayloadBids.js";
 export {SeenBlockInput} from "./seenGossipBlockInput.js";
 export {PayloadEnvelopeInput, SeenPayloadEnvelopeInput} from "./seenPayloadEnvelopeInput.js";
-export {SeenProposerPreferences} from "./seenProposerPreferences.js";

package/src/chain/stateCache/persistentCheckpointsCache.ts

@@ -331,8 +331,9 @@ export class PersistentCheckpointStateCache implements CheckpointStateCache {
     const key = toCacheKey(cpHex);
     const cacheItem = this.cache.get(key);
     this.metrics?.cpStateCache.adds.inc();
-    if (cacheItem !== undefined && isPersistedCacheItem(cacheItem)) {
-      const persistedKey = cacheItem.value;
+    // keep an existing persistedKey (persisted or reloaded-in-memory); dropping it orphans the on-disk file
+    const persistedKey = cacheItem && (isPersistedCacheItem(cacheItem) ? cacheItem.value : cacheItem.persistedKey);
+    if (persistedKey !== undefined) {
       // was persisted to disk, set back to memory
       this.cache.set(key, {type: CacheItemType.inMemory, state, persistedKey});
       this.logger.verbose("Added checkpoint state to memory but a persisted key existed", {

package/src/chain/validation/proposerPreferences.ts

@@ -81,7 +81,7 @@ export async function validateGossipProposerPreferences(
   }
 
   // [IGNORE] First valid message for (dependent_root, proposal_slot, validator_index).
-  if (chain.seenProposerPreferences.isKnown(dependentRootHex, proposalSlot, validatorIndex)) {
+  if (chain.proposerPreferencesPool.isKnown(proposalSlot, dependentRootHex, validatorIndex)) {
     throw new ProposerPreferencesError(GossipAction.IGNORE, {
       code: ProposerPreferencesErrorCode.ALREADY_KNOWN,
       proposalSlot,
@@ -105,6 +105,15 @@ export async function validateGossipProposerPreferences(
     });
   }
 
-  // Valid
-  chain.seenProposerPreferences.add(dependentRootHex, proposalSlot, validatorIndex);
+  // Repeated check - deals with race-condition between preferences submissions
+  if (chain.proposerPreferencesPool.isKnown(proposalSlot, dependentRootHex, validatorIndex)) {
+    throw new ProposerPreferencesError(GossipAction.IGNORE, {
+      code: ProposerPreferencesErrorCode.ALREADY_KNOWN,
+      proposalSlot,
+      validatorIndex,
+      dependentRoot: dependentRootHex,
+    });
+  }
+
+  chain.proposerPreferencesPool.add(signedProposerPreferences);
 }

package/src/network/processor/gossipHandlers.ts

@@ -1273,7 +1273,6 @@ function getSequentialHandlers(modules: ValidatorFnsModules, options: GossipHand
       const signedProposerPreferences = sszDeserialize(topic, serializedData);
       await validateGossipProposerPreferences(chain, signedProposerPreferences);
 
-      chain.proposerPreferencesPool.add(signedProposerPreferences);
       chain.emitter.emit(routes.events.EventType.proposerPreferences, {
         version: ForkName.gloas,
         data: signedProposerPreferences,

package/src/sync/range/chain.ts

@@ -186,10 +186,6 @@ export class SyncChain {
     this.logger = logger;
     this.logId = `${syncType}-${nextChainId++}`;
 
-    if (metrics) {
-      metrics.syncRange.headSyncPeers.addCollect(() => this.scrapeMetrics(metrics));
-    }
-
     // Trigger event on parent class
     this.sync().then(
       () => fns.onEnd(null, this.target),
@@ -775,7 +771,10 @@ export class SyncChain {
     });
   }
 
-  private scrapeMetrics(metrics: Metrics): void {
+  /**
+   * Called by `RangeSync`'s to avoid collecting metrics of removed chains.
+   */
+  scrapeMetrics(metrics: Metrics): void {
     const syncPeersMetric =
       this.syncType === RangeSyncType.Finalized
         ? metrics.syncRange.finalizedSyncPeers

package/src/sync/range/range.ts

@@ -105,6 +105,16 @@ export class RangeSync extends (EventEmitter as {new (): RangeSyncEmitter}) {
 
     if (metrics) {
       metrics.syncStatus.addCollect(() => this.scrapeMetrics(metrics));
+      metrics.syncRange.headSyncPeers.addCollect(() => {
+        // Gauges retain their last set value, so a removed chain would keep reporting stale
+        // per-column peer counts (finalizedSyncPeers especially, as it is rarely recreated once
+        // synced)
+        metrics.syncRange.headSyncPeers.reset();
+        metrics.syncRange.finalizedSyncPeers.reset();
+        for (const syncChain of this.chains.values()) {
+          syncChain.scrapeMetrics(metrics);
+        }
+      });
     }
   }
 

package/src/util/graffiti.ts

@@ -37,3 +37,81 @@ export function getDefaultGraffiti(
   // No EL client info available. We still want to include CL info albeit not spec compliant
   return `${consensusClientVersion.code}${consensusClientVersion.commit.slice(0, 4)}`;
 }
+
+function appendLongestFittingSuffix(userGraffiti: string, suffixes: string[]): string {
+  const userGraffitiBytes = Buffer.byteLength(userGraffiti, "utf8");
+  if (userGraffitiBytes >= GRAFFITI_SIZE) {
+    return userGraffiti;
+  }
+
+  const availableBytes = GRAFFITI_SIZE - userGraffitiBytes;
+
+  for (const suffix of suffixes) {
+    if (Buffer.byteLength(suffix, "utf8") <= availableBytes) {
+      return `${userGraffiti}${suffix}`;
+    }
+  }
+
+  return userGraffiti;
+}
+
+/**
+ * Appends the richest available client watermark that fits after user graffiti.
+ *
+ * Tiers are:
+ * - full EL/CL watermark, e.g. " BU9b0eLS80c2"
+ * - EL/CL client codes, e.g. " BULS"
+ * - CL client code, e.g. " LS"
+ */
+export function appendClientInfoToGraffiti(
+  userGraffiti: string,
+  consensusClientVersion: ClientVersion,
+  executionClientVersion: ClientVersion | null | undefined,
+  opts: {private?: boolean} = {}
+): string {
+  if (opts.private) {
+    return userGraffiti;
+  }
+
+  // Graffiti supplied via the beacon API is decoded from a fixed 32-byte field (see
+  // fromGraffitiHex) and arrives right-padded with NUL bytes. Trim only trailing padding
+  // NULs; a NUL that appears in the middle of the string is data, not padding.
+  let end = userGraffiti.length;
+  while (end > 0 && userGraffiti.charCodeAt(end - 1) === 0) {
+    end--;
+  }
+  const graffiti = userGraffiti.slice(0, end);
+
+  const fullClientInfo = getDefaultGraffiti(consensusClientVersion, executionClientVersion, {private: false});
+  if (graffiti.length === 0) {
+    return fullClientInfo;
+  }
+
+  const suffixes =
+    executionClientVersion != null
+      ? [
+          ` ${fullClientInfo}`,
+          ` ${executionClientVersion.code}${consensusClientVersion.code}`,
+          ` ${consensusClientVersion.code}`,
+        ]
+      : [` ${fullClientInfo}`, ` ${consensusClientVersion.code}`];
+
+  return appendLongestFittingSuffix(graffiti, suffixes);
+}
+
+export function getBlockGraffiti(
+  userGraffiti: string | undefined,
+  consensusClientVersion: ClientVersion,
+  executionClientVersion: ClientVersion | null | undefined,
+  opts: {private?: boolean; graffitiAppend?: boolean}
+): string {
+  if (userGraffiti === undefined) {
+    return getDefaultGraffiti(consensusClientVersion, executionClientVersion, opts);
+  }
+
+  if (opts.graffitiAppend === false) {
+    return userGraffiti;
+  }
+
+  return appendClientInfoToGraffiti(userGraffiti, consensusClientVersion, executionClientVersion, opts);
+}

package/lib/chain/seenCache/seenProposerPreferences.d.ts

@@ -1,16 +0,0 @@
-import { RootHex, Slot, ValidatorIndex } from "@lodestar/types";
-/**
- * Tracks signed proposer preferences we've already seen per (dependent_root, proposal_slot, validator_index).
- */
-export declare class SeenProposerPreferences {
-    private readonly validatorByDependentRootBySlot;
-    isKnown(dependentRoot: RootHex, proposalSlot: Slot, validatorIndex: ValidatorIndex): boolean;
-    add(dependentRoot: RootHex, proposalSlot: Slot, validatorIndex: ValidatorIndex): void;
-    /**
-     * Entries are only load-bearing while `proposal_slot > current_slot`. Once the slot has
-     * passed the `[IGNORE] proposal_slot > current_slot` gossip rule takes over, so drop them
-     * on each slot tick.
-     */
-    prune(currentSlot: Slot): void;
-}
-//# sourceMappingURL=seenProposerPreferences.d.ts.map

package/lib/chain/seenCache/seenProposerPreferences.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"seenProposerPreferences.d.ts","sourceRoot":"","sources":["../../../src/chain/seenCache/seenProposerPreferences.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,OAAO,EAAE,IAAI,EAAE,cAAc,EAAC,MAAM,iBAAiB,CAAC;AAG9D;;GAEG;AACH,qBAAa,uBAAuB;IAClC,OAAO,CAAC,QAAQ,CAAC,8BAA8B,CAE7C;IAEF,OAAO,CAAC,aAAa,EAAE,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,cAAc,GAAG,OAAO,CAE3F;IAED,GAAG,CAAC,aAAa,EAAE,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,cAAc,GAAG,IAAI,CAEpF;IAED;;;;OAIG;IACH,KAAK,CAAC,WAAW,EAAE,IAAI,GAAG,IAAI,CAM7B;CACF"}

package/lib/chain/seenCache/seenProposerPreferences.js

@@ -1,26 +0,0 @@
-import { MapDef } from "@lodestar/utils";
-/**
- * Tracks signed proposer preferences we've already seen per (dependent_root, proposal_slot, validator_index).
- */
-export class SeenProposerPreferences {
-    validatorByDependentRootBySlot = new MapDef(() => new Map());
-    isKnown(dependentRoot, proposalSlot, validatorIndex) {
-        return this.validatorByDependentRootBySlot.get(proposalSlot)?.get(dependentRoot) === validatorIndex;
-    }
-    add(dependentRoot, proposalSlot, validatorIndex) {
-        this.validatorByDependentRootBySlot.getOrDefault(proposalSlot).set(dependentRoot, validatorIndex);
-    }
-    /**
-     * Entries are only load-bearing while `proposal_slot > current_slot`. Once the slot has
-     * passed the `[IGNORE] proposal_slot > current_slot` gossip rule takes over, so drop them
-     * on each slot tick.
-     */
-    prune(currentSlot) {
-        for (const slot of this.validatorByDependentRootBySlot.keys()) {
-            if (slot < currentSlot) {
-                this.validatorByDependentRootBySlot.delete(slot);
-            }
-        }
-    }
-}
-//# sourceMappingURL=seenProposerPreferences.js.map

package/lib/chain/seenCache/seenProposerPreferences.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"seenProposerPreferences.js","sourceRoot":"","sources":["../../../src/chain/seenCache/seenProposerPreferences.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,MAAM,EAAC,MAAM,iBAAiB,CAAC;AAEvC;;GAEG;AACH,MAAM,OAAO,uBAAuB;IACjB,8BAA8B,GAAG,IAAI,MAAM,CAC1D,GAAG,EAAE,CAAC,IAAI,GAAG,EAA2B,CACzC,CAAC;IAEF,OAAO,CAAC,aAAsB,EAAE,YAAkB,EAAE,cAA8B,EAAW;QAC3F,OAAO,IAAI,CAAC,8BAA8B,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,GAAG,CAAC,aAAa,CAAC,KAAK,cAAc,CAAC;IAAA,CACrG;IAED,GAAG,CAAC,aAAsB,EAAE,YAAkB,EAAE,cAA8B,EAAQ;QACpF,IAAI,CAAC,8BAA8B,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,aAAa,EAAE,cAAc,CAAC,CAAC;IAAA,CACnG;IAED;;;;OAIG;IACH,KAAK,CAAC,WAAiB,EAAQ;QAC7B,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,8BAA8B,CAAC,IAAI,EAAE,EAAE,CAAC;YAC9D,IAAI,IAAI,GAAG,WAAW,EAAE,CAAC;gBACvB,IAAI,CAAC,8BAA8B,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YACnD,CAAC;QACH,CAAC;IAAA,CACF;CACF"}

package/src/chain/seenCache/seenProposerPreferences.ts

@@ -1,32 +0,0 @@
-import {RootHex, Slot, ValidatorIndex} from "@lodestar/types";
-import {MapDef} from "@lodestar/utils";
-
-/**
- * Tracks signed proposer preferences we've already seen per (dependent_root, proposal_slot, validator_index).
- */
-export class SeenProposerPreferences {
-  private readonly validatorByDependentRootBySlot = new MapDef<Slot, Map<RootHex, ValidatorIndex>>(
-    () => new Map<RootHex, ValidatorIndex>()
-  );
-
-  isKnown(dependentRoot: RootHex, proposalSlot: Slot, validatorIndex: ValidatorIndex): boolean {
-    return this.validatorByDependentRootBySlot.get(proposalSlot)?.get(dependentRoot) === validatorIndex;
-  }
-
-  add(dependentRoot: RootHex, proposalSlot: Slot, validatorIndex: ValidatorIndex): void {
-    this.validatorByDependentRootBySlot.getOrDefault(proposalSlot).set(dependentRoot, validatorIndex);
-  }
-
-  /**
-   * Entries are only load-bearing while `proposal_slot > current_slot`. Once the slot has
-   * passed the `[IGNORE] proposal_slot > current_slot` gossip rule takes over, so drop them
-   * on each slot tick.
-   */
-  prune(currentSlot: Slot): void {
-    for (const slot of this.validatorByDependentRootBySlot.keys()) {
-      if (slot < currentSlot) {
-        this.validatorByDependentRootBySlot.delete(slot);
-      }
-    }
-  }
-}