Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Discv5: Do not issue FINDNODES right after the start #3429

Merged
merged 3 commits into from
Nov 15, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions packages/cli/src/options/beaconNodeOptions/network.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ export interface INetworkArgs {
"network.localMultiaddrs": string[];
"network.subscribeAllSubnets": boolean;
"network.connectToDiscv5Bootnodes": boolean;
"network.firstHeartBeatDelayMs": number;
}

export function parseArgs(args: INetworkArgs): IBeaconNodeOptions["network"] {
Expand All @@ -28,6 +29,7 @@ export function parseArgs(args: INetworkArgs): IBeaconNodeOptions["network"] {
localMultiaddrs: args["network.localMultiaddrs"],
subscribeAllSubnets: args["network.subscribeAllSubnets"],
connectToDiscv5Bootnodes: args["network.connectToDiscv5Bootnodes"],
firstHeartBeatDelayMs: args["network.firstHeartBeatDelayMs"],
};
}

Expand Down Expand Up @@ -95,4 +97,11 @@ export const options: ICliCommandOptions<INetworkArgs> = {
defaultDescription: String(defaultOptions.network.connectToDiscv5Bootnodes === true),
group: "network",
},

"network.firstHeartBeatDelayMs": {
type: "number",
description: "Delay the 1st heart beat of Peer Manager after starting Discv5",
defaultDescription: String(defaultOptions.network.firstHeartBeatDelayMs),
group: "network",
},
};
2 changes: 2 additions & 0 deletions packages/cli/test/unit/options/beaconNodeOptions.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ describe("options / beaconNodeOptions", () => {
"network.localMultiaddrs": [],
"network.subscribeAllSubnets": true,
"network.connectToDiscv5Bootnodes": true,
"network.firstHeartBeatDelayMs": 1000,

"sync.isSingleNode": true,
"sync.disableProcessAsChainSegment": true,
Expand Down Expand Up @@ -100,6 +101,7 @@ describe("options / beaconNodeOptions", () => {
localMultiaddrs: [],
subscribeAllSubnets: true,
connectToDiscv5Bootnodes: true,
firstHeartBeatDelayMs: 1000,
},
sync: {
isSingleNode: true,
Expand Down
1 change: 1 addition & 0 deletions packages/lodestar/src/network/network.ts
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,7 @@ export class Network implements INetwork {
config,
peerMetadata,
peerRpcScores,
signal,
networkEventBus,
},
opts
Expand Down
1 change: 1 addition & 0 deletions packages/lodestar/src/network/options.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ export const defaultDiscv5Options: IDiscv5DiscoveryInputOptions = {
export const defaultNetworkOptions: INetworkOptions = {
maxPeers: 30, // Allow some room above targetPeers for new inbound peers
targetPeers: 25,
firstHeartBeatDelayMs: 1000,
localMultiaddrs: ["/ip4/0.0.0.0/tcp/9000"],
bootMultiaddrs: [],
discv5: defaultDiscv5Options,
Expand Down
12 changes: 11 additions & 1 deletion packages/lodestar/src/network/peers/peerManager.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
import LibP2p, {Connection} from "libp2p";
import {AbortSignal} from "@chainsafe/abort-controller";
import PeerId from "peer-id";
import {IDiscv5DiscoveryInputOptions} from "@chainsafe/discv5";
import {IBeaconConfig} from "@chainsafe/lodestar-config";
import {allForks, altair, phase0} from "@chainsafe/lodestar-types";
import {ILogger} from "@chainsafe/lodestar-utils";
import {ILogger, sleep} from "@chainsafe/lodestar-utils";
import {IBeaconChain} from "../../chain";
import {GoodByeReasonCode, GOODBYE_KNOWN_CODES, Libp2pEvent} from "../../constants";
import {IMetrics} from "../../metrics";
Expand Down Expand Up @@ -45,6 +46,11 @@ export type PeerManagerOpts = {
targetPeers: number;
/** The maximum number of peers we allow (exceptions for subnet peers) */
maxPeers: number;
/**
* Delay the 1st heartbeat after starting discv5
* See https://github.com/ChainSafe/lodestar/issues/3423
*/
firstHeartBeatDelayMs: number;
twoeths marked this conversation as resolved.
Show resolved Hide resolved
/**
* If null, Don't run discv5 queries, nor connect to cached peers in the peerStore
*/
Expand All @@ -62,6 +68,7 @@ export type PeerManagerModules = {
config: IBeaconConfig;
peerMetadata: Libp2pPeerMetadataStore;
peerRpcScores: IPeerRpcScoreStore;
signal?: AbortSignal;
networkEventBus: INetworkEventBus;
};

Expand Down Expand Up @@ -103,6 +110,7 @@ export class PeerManager {
private peerRpcScores: IPeerRpcScoreStore;
/** If null, discovery is disabled */
private discovery: PeerDiscovery | null;
private signal: AbortSignal | undefined;
private networkEventBus: INetworkEventBus;

// A single map of connected peers with all necessary data to handle PINGs, STATUS, and metrics
Expand All @@ -124,6 +132,7 @@ export class PeerManager {
this.config = modules.config;
this.peerMetadata = modules.peerMetadata;
this.peerRpcScores = modules.peerRpcScores;
this.signal = modules.signal;
this.networkEventBus = modules.networkEventBus;
this.opts = opts;

Expand All @@ -142,6 +151,7 @@ export class PeerManager {
this.libp2p.connectionManager.on(Libp2pEvent.peerDisconnect, this.onLibp2pPeerDisconnect);
this.networkEventBus.on(NetworkEvent.reqRespRequest, this.onRequest);

await sleep(this.opts.firstHeartBeatDelayMs, this.signal);
// On start-up will connected to existing peers in libp2p.peerStore, same as autoDial behaviour
this.heartbeat();
this.intervals = [
Expand Down
1 change: 1 addition & 0 deletions packages/lodestar/test/e2e/network/gossipsub.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ const opts: INetworkOptions = {
targetPeers: 1,
bootMultiaddrs: [],
localMultiaddrs: [],
firstHeartBeatDelayMs: 1,
discv5: null,
};

Expand Down
1 change: 1 addition & 0 deletions packages/lodestar/test/e2e/network/network.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ describe("network", function () {
targetPeers: 1,
bootMultiaddrs: [],
localMultiaddrs: [],
firstHeartBeatDelayMs: 1,
dapplion marked this conversation as resolved.
Show resolved Hide resolved
discv5: {
enr,
bindAddr: bindAddrUdp,
Expand Down
7 changes: 6 additions & 1 deletion packages/lodestar/test/e2e/network/peers/peerManager.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,12 @@ describe("network / peers / PeerManager", function () {
attnetsService: mockSubnetsService,
syncnetsService: mockSubnetsService,
},
{targetPeers: 30, maxPeers: 50, discv5: null}
{
targetPeers: 30,
maxPeers: 50,
discv5: null,
firstHeartBeatDelayMs: 1,
}
);
await peerManager.start();

Expand Down
1 change: 1 addition & 0 deletions packages/lodestar/test/e2e/network/reqresp.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ describe("network / ReqResp", function () {
targetPeers: 1,
bootMultiaddrs: [],
localMultiaddrs: [],
firstHeartBeatDelayMs: 1,
discv5: null,
};
const state = generateState();
Expand Down