cmd/utils: add comment about overriding network id

lightclient · lightclient · commit 2adbe689a076 · 2025-10-22T09:50:30.000-06:00
diff --git a/cmd/utils/flags.go b/cmd/utils/flags.go
@@ -1911,6 +1911,9 @@ func SetEthConfig(ctx *cli.Context, stack *node.Node, cfg *ethconfig.Config) {
 		}
 	}
 	if ctx.IsSet(NetworkIdFlag.Name) {
+		// Typically it's best to automatically set the network id to the chain id,
+		// by not passing the network id flag at all. Emit a warning when set
+		// explicitly in case overriding the network id is not the user's intention.
 		id := ctx.Uint64(NetworkIdFlag.Name)
 		log.Warn("Setting network id with flag", "id", id)
 		cfg.NetworkId = id

Original file line number	Diff line number	Diff line change
`@@ -1911,6 +1911,9 @@ func SetEthConfig(ctx cli.Context, stack node.Node, cfg *ethconfig.Config) {`
`1911`	`1911`	`}`
`1912`	`1912`	`}`
`1913`	`1913`	`if ctx.IsSet(NetworkIdFlag.Name) {`
	`1914`	`+ // Typically it's best to automatically set the network id to the chain id,`
	`1915`	`+ // by not passing the network id flag at all. Emit a warning when set`
	`1916`	`+ // explicitly in case overriding the network id is not the user's intention.`
`1914`	`1917`	`id := ctx.Uint64(NetworkIdFlag.Name)`
`1915`	`1918`	`log.Warn("Setting network id with flag", "id", id)`
`1916`	`1919`	`cfg.NetworkId = id`