feat: add network.targetColumnSubnetPeers cli flag

ChainSafe · Dec 3, 2024 · 64aeadb · 64aeadb
1 parent a7423f6
commit 64aeadb
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 11 deletions.
diff --git a/packages/beacon-node/src/network/options.ts b/packages/beacon-node/src/network/options.ts
@@ -44,4 +44,6 @@ export const defaultNetworkOptions: NetworkOptions = {
   beaconAttestationBatchValidation: true,
   // This will enable the light client server by default
   disableLightClientServer: false,
+  // for PeerDAS, this is the same to TARGET_SUBNET_PEERS, should reavaluate after devnets
+  targetColumnSubnetPeers: 6,
 };
diff --git a/packages/beacon-node/src/network/peers/peerManager.ts b/packages/beacon-node/src/network/peers/peerManager.ts
@@ -27,6 +27,7 @@ import {
   assertPeerRelevance,
   prioritizePeers,
   renderIrrelevantPeerType,
+  PrioritizePeersOpts,
 } from "./utils/index.js";
 import {IPeerRpcScoreStore, PeerAction, PeerScoreStats, ScoreState, updateGossipsubScores} from "./score/index.js";
 
@@ -65,10 +66,6 @@ const ALLOWED_NEGATIVE_GOSSIPSUB_FACTOR = 0.1;
 // to terminal if it deviates significantly from the user's settings
 
 export type PeerManagerOpts = {
-  /** The target number of peers we would like to connect to. */
-  targetPeers: number;
-  /** The maximum number of peers we allow (exceptions for subnet peers) */
-  maxPeers: number;
   /**
    * Delay the 1st query after starting discv5
    * See https://github.com/ChainSafe/lodestar/issues/3423
@@ -82,7 +79,7 @@ export type PeerManagerOpts = {
    * If set to true, connect to Discv5 bootnodes. If not set or false, do not connect
    */
   connectToDiscv5Bootnodes?: boolean;
-};
+} & PrioritizePeersOpts;
 
 /**
  * ReqResp methods used only be PeerManager, so the main thread never has to call them

diff --git a/packages/beacon-node/src/network/peers/utils/prioritizePeers.ts b/packages/beacon-node/src/network/peers/utils/prioritizePeers.ts
@@ -57,12 +57,13 @@ type PeerInfo = {
   score: number;
 };
 
-export interface PrioritizePeersOpts {
+export type PrioritizePeersOpts = {
   targetPeers: number;
   maxPeers: number;
+  targetColumnSubnetPeers: number;
   outboundPeersRatio?: number;
   targetSubnetPeers?: number;
-}
+};
 
 export enum ExcessPeerDisconnectReason {
   LOW_SCORE = "low_score",
@@ -118,7 +119,7 @@ export function prioritizePeers(
     })
   );
 
-  const {attnetQueries, syncnetQueries, columnSubnetQueries, dutiesByPeer} = requestAttnetPeers(
+  const {attnetQueries, syncnetQueries, columnSubnetQueries, dutiesByPeer} = requestSubnetPeers(
     connectedPeers,
     activeAttnets,
     activeSyncnets,
@@ -155,7 +156,7 @@ export function prioritizePeers(
 /**
  * If more peers are needed in attnets and syncnets and column subnets, create SubnetDiscvQuery for each subnet
  */
-function requestAttnetPeers(
+function requestSubnetPeers(
   connectedPeers: PeerInfo[],
   activeAttnets: RequestedSubnet[],
   activeSyncnets: RequestedSubnet[],
@@ -231,6 +232,7 @@ function requestAttnetPeers(
   }
 
   // column subnets, do we need queries for more peers
+  const targetColumnSubnetPeers = opts.targetColumnSubnetPeers;
   const columnSubnetQueries: ColumnSubnetQueries = new Map();
   const peersPerColumnSubnet = new Map<ColumnSubnetId, number>();
   for (const peer of connectedPeers) {
@@ -242,9 +244,9 @@ function requestAttnetPeers(
 
   for (const columnSubnet of samplingSubnets) {
     const peersInColumnSubnet = peersPerColumnSubnet.get(columnSubnet) ?? 0;
-    if (peersInColumnSubnet < targetSubnetPeers) {
+    if (peersInColumnSubnet < targetColumnSubnetPeers) {
       // We need more peers
-      columnSubnetQueries.set(columnSubnet, targetSubnetPeers - peersInColumnSubnet);
+      columnSubnetQueries.set(columnSubnet, targetColumnSubnetPeers - peersInColumnSubnet);
     }
   }
 

diff --git a/packages/cli/src/options/beaconNodeOptions/network.ts b/packages/cli/src/options/beaconNodeOptions/network.ts
@@ -37,6 +37,7 @@ export type NetworkArgs = {
   "network.maxGossipTopicConcurrency"?: number;
   "network.useWorker"?: boolean;
   "network.maxYoungGenerationSizeMb"?: number;
+  "network.targetColumnSubnetPeers"?: number;
 
   /** @deprecated This option is deprecated and should be removed in next major release. */
   "network.requestCountPeerLimit"?: number;
@@ -156,6 +157,7 @@ export function parseArgs(args: NetworkArgs): IBeaconNodeOptions["network"] {
     maxGossipTopicConcurrency: args["network.maxGossipTopicConcurrency"],
     useWorker: args["network.useWorker"],
     maxYoungGenerationSizeMb: args["network.maxYoungGenerationSizeMb"],
+    targetColumnSubnetPeers: args["network.targetColumnSubnetPeers"] ?? defaultOptions.network.targetColumnSubnetPeers,
   };
 }
 
@@ -396,4 +398,12 @@ export const options: CliCommandOptions<NetworkArgs> = {
     description: "Max size of young generation in megabytes. Defaults to 152mb",
     defaultDescription: String(defaultOptions.network.maxYoungGenerationSizeMb),
   },
+
+  "network.targetColumnSubnetPeers": {
+    type: "number",
+    hidden: true,
+    group: "network",
+    description: "Target number of peers per sampling column subnet",
+    defaultDescription: String(defaultOptions.network.targetColumnSubnetPeers),
+  },
 };
diff --git a/packages/cli/test/unit/options/beaconNodeOptions.test.ts b/packages/cli/test/unit/options/beaconNodeOptions.test.ts
@@ -104,6 +104,7 @@ describe("options / beaconNodeOptions", () => {
       "network.maxGossipTopicConcurrency": 64,
       "network.useWorker": true,
       "network.maxYoungGenerationSizeMb": 152,
+      "network.targetColumnSubnetPeers": 12,
 
       "sync.isSingleNode": true,
       "sync.disableProcessAsChainSegment": true,
@@ -215,6 +216,7 @@ describe("options / beaconNodeOptions", () => {
         maxGossipTopicConcurrency: 64,
         useWorker: true,
         maxYoungGenerationSizeMb: 152,
+        targetColumnSubnetPeers: 12,
       },
       sync: {
         isSingleNode: true,