feat: static enr (#372)

Author: nikhilkumar1612

packages/cli/src/cmds/node/handler.ts

@@ -95,6 +95,7 @@ export async function nodeHandler(args: IGlobalArgs): Promise<void> {
     peerId,
     metricsOptions: params.metrics,
     version,
+    retainPeerId: params.p2p.retainPeerId,
   });
 
   await node.start();
@@ -127,6 +128,7 @@ export async function getNodeConfigFromArgs(args: IGlobalArgs): Promise<{
       enrPort: entries.get("p2p.enrPort"),
       bootEnrs: entries.get("p2p.bootEnrs"),
       retainPeerId: entries.get("p2p.retainPeerId"),
+      enrSeq: entries.get("p2p.enrSeq"),
     },
     api: {
       address: entries.get("api.address"),

packages/cli/src/cmds/node/initPeerIdAndEnr.ts

@@ -19,10 +19,27 @@ export function overwriteEnrWithCliArgs(
   enr: SignableENR,
   args: IGlobalArgs
 ): void {
-  const [host, enrPort] = [args["p2p.enrHost"], args["p2p.enrPort"]];
-  enr.ip = host ?? defaultP2POptions.enrHost;
-  enr.tcp = enrPort ?? defaultP2POptions.enrPort;
-  enr.udp = enrPort ?? defaultP2POptions.enrPort;
+  const [host, enrPort, enrSeq] = [args["p2p.enrHost"], args["p2p.enrPort"], args["p2p.enrSeq"]];
+  
+  const newHost = host ?? defaultP2POptions.enrHost;
+  // Normalize port to a number to avoid accidental mismatches
+  const newPort =
+    enrPort !== undefined && enrPort !== null
+      ? Number(enrPort)
+      : defaultP2POptions.enrPort;
+
+  // Only update when a value actually changes to avoid bumping the ENR seq
+  if (enr.ip !== newHost) {
+    enr.ip = newHost;
+  }
+  if (enr.tcp !== newPort) {
+    enr.tcp = newPort;
+  }
+  if (enr.udp !== newPort) {
+    enr.udp = newPort;
+  }
+
+  enr.seq = enrSeq ? BigInt(enrSeq) : BigInt(defaultP2POptions.enrSeq)
 }
 
 export async function initPeerIdAndEnr(

packages/cli/src/options/bundlerOptions/network.ts

@@ -9,6 +9,7 @@ export interface INetworkArgs {
   "p2p.enrPort": number;
   "p2p.bootEnrs": string[];
   "p2p.retainPeerId": boolean;
+  "p2p.enrSeq": number;
 }
 
 export function parseArgs(args: INetworkArgs): IBundlerOptions["p2p"] {
@@ -19,6 +20,7 @@ export function parseArgs(args: INetworkArgs): IBundlerOptions["p2p"] {
     enrPort: args["p2p.enrPort"],
     bootEnrs: args["p2p.bootEnrs"],
     retainPeerId: args["p2p.retainPeerId"],
+    enrSeq: args["p2p.enrSeq"]
   };
 }
 
@@ -65,4 +67,11 @@ export const options: ICliCommandOptions<INetworkArgs> = {
     group: "p2p",
     demandOption: false,
   },
+  "p2p.enrSeq": {
+    type: "number",
+    description: "P2P sequence for enr",
+    default: defaultP2POptions.enrSeq,
+    group: "p2p",
+    demandOption: false,
+  }
 };

packages/node/src/index.ts

@@ -45,6 +45,7 @@ export interface BundlerNodeInitOptions {
   bundlingMode: BundlingMode;
   metricsOptions: MetricsOptions;
   version: SkandhaVersion;
+  retainPeerId?: boolean;
 }
 
 export class BundlerNode {
@@ -72,6 +73,7 @@ export class BundlerNode {
       bundlingMode,
       metricsOptions,
       version,
+      retainPeerId,
     } = opts;
     let { peerId } = opts;
 
@@ -121,6 +123,8 @@ export class BundlerNode {
       peerStoreDir: nodeOptions.network.dataDir,
       executor, // ok: is null at the moment
       metrics: metrics?.chains || null,
+      dataDir: nodeOptions.network.dataDir,
+      retainPeerId: retainPeerId,
     });
 
     const syncService = new SyncService({

packages/node/src/network/network.ts

@@ -25,6 +25,8 @@ import { getCoreTopics } from "./gossip/topic.js";
 import { Discv5Worker } from "./discv5/index.js";
 import { NetworkProcessor } from "./processor/index.js";
 import { pooledUserOpHashes, pooledUserOpsByHash } from "./reqresp/index.js";
+import fs from "node:fs";
+import path from "node:path";
 
 type NetworkModules = {
   libp2p: Libp2p;
@@ -47,6 +49,8 @@ export type NetworkInitOptions = {
   executor: Executor;
   peerStoreDir?: string;
   metrics: AllChainsMetrics | null;
+  dataDir?: string;
+  retainPeerId?: boolean;
 };
 
 export class Network implements INetwork {
@@ -66,6 +70,8 @@ export class Network implements INetwork {
 
   relayersConfig: Config;
   subscribedMempools = new Set<string>();
+  dataDir?: string;
+  retainPeerId?: boolean;
 
   constructor(opts: NetworkModules) {
     const {
@@ -97,7 +103,7 @@ export class Network implements INetwork {
   }
 
   static async init(options: NetworkInitOptions): Promise<Network> {
-    const { peerId, relayersConfig, executor, metrics } = options;
+    const { peerId, relayersConfig, executor, metrics, dataDir, retainPeerId } = options;
     const libp2p = await createNodeJsLibp2p(peerId, options.opts, {
       peerStoreDir: options.peerStoreDir,
     });
@@ -150,7 +156,7 @@ export class Network implements INetwork {
     };
     const peerManager = new PeerManager(peerManagerModules, options.opts);
 
-    return new Network({
+    const network = new Network({
       libp2p,
       gossip,
       reqResp,
@@ -163,6 +169,9 @@ export class Network implements INetwork {
       executor,
       metrics,
     });
+    network.dataDir = dataDir;
+    network.retainPeerId = retainPeerId;
+    return network;
   }
 
   /** Shutdown the bundler node */
@@ -185,6 +194,19 @@ export class Network implements INetwork {
     const setEnrValue = discv5?.setEnrValue.bind(discv5);
     this.metadata.start(setEnrValue);
 
+    // Save ENR after metadata updates if retainPeerId is enabled
+    if (this.retainPeerId && this.dataDir) {
+      try {
+        const enr = await this.getEnr();
+        if (enr) {
+          const enrFile = path.join(this.dataDir, "enr");
+          fs.writeFileSync(enrFile, enr.encodeTxt(), { mode: 0o600 });
+        }
+      } catch (error) {
+        this.logger.warn("Failed to save ENR after metadata update", error);
+      }
+    }
+
     await this.gossip.start();
 
     const multiaddresses = this.libp2p

packages/types/src/options/network.ts

@@ -5,6 +5,7 @@ export type P2POptions = {
   enrPort: number;
   bootEnrs: string[];
   retainPeerId: boolean;
+  enrSeq: number;
 };
 
 export const defaultP2POptions: P2POptions = {
@@ -14,4 +15,5 @@ export const defaultP2POptions: P2POptions = {
   enrPort: 4337,
   bootEnrs: [],
   retainPeerId: true,
+  enrSeq: 0,
 };