@lodestar/beacon-node 1.45.0-dev.d7859e978b → 1.45.0-dev.e10fb5e991

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);
-      }
-    }
-  }
-}