Update data directory defaults to include namespace, network (#3596)

status-im/nimbus-eth2#7418

Align with eth2 to enable the safe use of a shared data directory
between eth1/2 and other nimbus, when using defaults

In particular, this enforces permissions on the data directory

Author: arnetheduck

execution_chain/common/chain_config.nim

@@ -414,13 +414,9 @@ proc parseGenesis*(data: string): Genesis
      {.gcsafe.} =
   try:
     result = JGenesis.decode(data, Genesis, allowUnknownFields = true)
-  except JsonReaderError as e:
+  except SerializationError as e:
     error "Invalid genesis config file format", msg=e.formatMsg("")
     return nil
-  except CatchableError as e:
-    error "Error loading genesis data",
-      exception = e.name, msg = e.msg
-    return nil
 
 proc parseGenesisFile*(fileName: string): Genesis
      {.gcsafe.} =
@@ -429,13 +425,9 @@ proc parseGenesisFile*(fileName: string): Genesis
   except IOError as e:
     error "Genesis I/O error", fileName, msg=e.msg
     return nil
-  except JsonReaderError as e:
+  except SerializationError as e:
     error "Invalid genesis config file format", msg=e.formatMsg("")
     return nil
-  except CatchableError as e:
-    error "Error loading genesis file",
-      fileName, exception = e.name, msg = e.msg
-    return nil
 
 proc validateNetworkParams(params: var NetworkParams, input: string, inputIsFile: bool): bool =
   if params.genesis.isNil:
@@ -460,39 +452,21 @@ proc loadNetworkParams*(fileName: string, params: var NetworkParams):
   except IOError as e:
     error "Network params I/O error", fileName, msg=e.msg
     return false
-  except JsonReaderError as e:
+  except SerializationError as e:
     error "Invalid network params file format", fileName, msg=e.formatMsg("")
     return false
-  except CatchableError as e:
-    error "Error loading network params file",
-      fileName, exception = e.name, msg = e.msg
-    return false
 
   validateNetworkParams(params, fileName, true)
 
 proc decodeNetworkParams*(jsonString: string, params: var NetworkParams): bool =
   try:
     params = JGenesis.decode(jsonString, NetworkParams, allowUnknownFields = true)
-  except JsonReaderError as e:
+  except SerializationError as e:
     error "Invalid network params format", msg=e.formatMsg("")
     return false
-  except CatchableError:
-    var msg = getCurrentExceptionMsg()
-    error "Error decoding network params", msg
-    return false
 
   validateNetworkParams(params, jsonString, false)
 
-proc parseGenesisAlloc*(data: string, ga: var GenesisAlloc): bool
-    {.gcsafe, raises: [CatchableError].} =
-  try:
-    ga = JGenesis.decode(data, GenesisAlloc, allowUnknownFields = true)
-  except JsonReaderError as e:
-    error "Invalid genesis config file format", msg=e.formatMsg("")
-    return false
-
-  return true
-
 func defaultBlobSchedule*(): array[Cancun..HardFork.high, Opt[BlobSchedule]] =
   [
     Cancun: Opt.some(BlobSchedule(target: 3'u64, max: 6'u64, baseFeeUpdateFraction: 3_338_477'u64)),
@@ -664,6 +638,18 @@ func genesisBlockForNetwork*(id: NetworkId): Genesis
   else:
     Genesis()
 
+func name*(id: NetworkId): string =
+  if id == MainNet:
+    "mainnet"
+  elif id == SepoliaNet:
+    "sepolia"
+  elif id == HoleskyNet:
+    "holesky"
+  elif id == HoodiNet:
+    "hoodi"
+  else:
+    $id
+
 func networkParams*(id: NetworkId): NetworkParams =
   try:
     NetworkParams(

execution_chain/common/context.nim

@@ -1,5 +1,5 @@
 # Nimbus
-# Copyright (c) 2021-2024 Status Research & Development GmbH
+# Copyright (c) 2021-2025 Status Research & Development GmbH
 # Licensed under either of
 #  * Apache License, version 2.0, ([LICENSE-APACHE](LICENSE-APACHE))
 #  * MIT license ([LICENSE-MIT](LICENSE-MIT))
@@ -43,7 +43,7 @@ proc containsOnlyHexDigits(hex: string): bool =
       return false
   true
 
-proc getNetKeys*(ctx: EthContext, netKey, dataDir: string): Result[KeyPair, string]
+proc getNetKeys*(ctx: EthContext, netKey: string): Result[KeyPair, string]
     {.gcsafe, raises: [OSError]} =
   if netKey.len == 0 or netKey == "random":
     let privateKey = ctx.randomPrivateKey()

execution_chain/common/logging.nim

@@ -10,28 +10,16 @@
 {.used.}
 
 import
-  std/[typetraits, net],
-  json_serialization,
-  web3/primitives,
+  std/typetraits,
+  json_serialization/std/net as jsnet,
+  web3/conversions,
   confutils/defs,
   eth/common/eth_types_json_serialization
 
-# nim-eth
-proc writeValue*(
-    w: var JsonWriter, v: EthTime
-) {.inline, raises: [IOError].} =
-  w.writeValue distinctBase(v)
-
-# nim-web3
-proc writeValue*(w: var JsonWriter, v: Quantity) {.inline, raises: [IOError].} =
-  w.writeValue distinctBase(v)
+export conversions.writeValue, jsnet.writeValue, eth_types_json_serialization.writeValue
 
 # nim-confutils
 proc writeValue*(
     w: var JsonWriter, v: InputFile | OutDir | OutFile | RestOfCmdLine | OutPath
 ) {.inline, raises: [IOError].} =
   w.writeValue distinctBase(v)
-
-# build-system
-proc writeValue*(w: var JsonWriter, v: Port) {.inline, raises: [IOError].} =
-  w.writeValue distinctBase(v)

execution_chain/config.nim

@@ -21,49 +21,34 @@ import
     chronicles,
     confutils,
     confutils/defs,
-    confutils/std/net,
-    results
+    confutils/std/net as confnet,
+    json_serialization/std/net as jsnet,
+    results,
+    beacon_chain/buildinfo,
+    beacon_chain/nimbus_binary_common,
   ],
   eth/[common, net/nat],
   ./networking/[bootnodes, eth1_enr as enr],
   ./[constants, compile_info, version],
   ./common/chain_config,
   ./db/opts
 
-from beacon_chain/nimbus_binary_common import setupLogging, StdoutLogKind
-
-export net, defs, StdoutLogKind
-
+export net, defs, jsnet, nimbus_binary_common
 const
-  # e.g.: Copyright (c) 2018-2025 Status Research & Development GmbH
-  NimbusCopyright* = "Copyright (c) 2018-" &
-    CompileDate.split('-')[0] &
-    " Status Research & Development GmbH"
 
   # e.g.:
   # nimbus_execution_client/v0.1.0-abcdef/os-cpu/nim-a.b.c/emvc
   # Copyright (c) 2018-2025 Status Research & Development GmbH
   NimbusBuild* = "$#\p$#" % [
     ClientId,
-    NimbusCopyright,
+    copyrights,
   ]
 
   NimbusHeader* = "$#\p\pNim version $#" % [
     NimbusBuild,
-    NimVersion
+    nimBanner()
   ]
 
-func defaultDataDir*(): string =
-  when defined(windows):
-    getHomeDir() / "AppData" / "Roaming" / "Nimbus"
-  elif defined(macosx):
-    getHomeDir() / "Library" / "Application Support" / "Nimbus"
-  else:
-    getHomeDir() / ".cache" / "nimbus"
-
-func defaultKeystoreDir*(): string =
-  defaultDataDir() / "keystore"
-
 func getLogLevels(): string =
   var logLevels: seq[string]
   for level in LogLevel:
@@ -73,7 +58,6 @@ func getLogLevels(): string =
   join(logLevels, ", ")
 
 const
-  defaultDataDirDesc = defaultDataDir()
   defaultPort              = 30303
   defaultMetricsServerPort = 9093
   defaultHttpPort          = 8545
@@ -106,30 +90,27 @@ type
   NimbusConf* = object of RootObj
     ## Main Nimbus configuration object
 
-    dataDir* {.
+    dataDirFlag* {.
       separator: "ETHEREUM OPTIONS:"
       desc: "The directory where nimbus will store all blockchain data"
-      defaultValue: defaultDataDir()
-      defaultValueDesc: $defaultDataDirDesc
       abbr: "d"
-      name: "data-dir" }: OutDir
+      name: "data-dir" }: Option[OutDir]
 
-    era1DirOpt* {.
+    era1DirFlag* {.
       desc: "Directory where era1 (pre-merge) archive can be found"
       defaultValueDesc: "<data-dir>/era1"
       name: "era1-dir" }: Option[OutDir]
 
-    eraDirOpt* {.
+    eraDirFlag* {.
       desc: "Directory where era (post-merge) archive can be found"
       defaultValueDesc: "<data-dir>/era"
       name: "era-dir" }: Option[OutDir]
 
-    keyStore* {.
+    keyStoreDirFlag* {.
       desc: "Load one or more keystore files from this directory"
-      defaultValue: defaultKeystoreDir()
       defaultValueDesc: "inside datadir"
       abbr: "k"
-      name: "key-store" }: OutDir
+      name: "key-store" }: Option[OutDir]
 
     importKey* {.
       desc: "Import unencrypted 32 bytes hex private key from a file"
@@ -528,7 +509,7 @@ type
               " CL which will result in a smaller memory footprint"
         name: "debug-beacon-sync-target-is-final".}: bool
 
-    of `import`:
+    of NimbusCmd.`import`:
       maxBlocks* {.
         desc: "Maximum number of blocks to import"
         defaultValue: uint64.high()
@@ -579,7 +560,7 @@ type
         defaultValue: false
         name: "debug-store-slot-hashes".}: bool
 
-    of `import-rlp`:
+    of NimbusCmd.`import-rlp`:
       blocksFile* {.
         argument
         desc: "One or more RLP encoded block(s) files"
@@ -591,6 +572,13 @@ func parseHexOrDec256(p: string): UInt256 {.raises: [ValueError].} =
   else:
     parse(p, UInt256, 10)
 
+proc dataDir*(config: NimbusConf): string =
+  # TODO load network name from directory, when using custom network?
+  string config.dataDirFlag.get(OutDir defaultDataDir("", config.networkId.name()))
+
+proc keyStoreDir*(config: NimbusConf): string =
+  string config.keyStoreDirFlag.get(OutDir config.dataDir() / "keystore")
+
 func parseCmdArg(T: type NetworkId, p: string): T
     {.gcsafe, raises: [ValueError].} =
   parseHexOrDec256(p)
@@ -867,11 +855,11 @@ func shareServerWithEngineApi*(conf: NimbusConf): bool =
 func httpServerEnabled*(conf: NimbusConf): bool =
   conf.wsEnabled or conf.rpcEnabled
 
-func era1Dir*(conf: NimbusConf): OutDir =
-  conf.era1DirOpt.get(OutDir(conf.dataDir.string & "/era1"))
+proc era1Dir*(conf: NimbusConf): string =
+  string conf.era1DirFlag.get(OutDir conf.dataDir / "era1")
 
-func eraDir*(conf: NimbusConf): OutDir =
-  conf.eraDirOpt.get(OutDir(conf.dataDir.string & "/era"))
+proc eraDir*(conf: NimbusConf): string =
+  string conf.eraDirFlag.get(OutDir conf.dataDir / "era")
 
 func dbOptions*(conf: NimbusConf, noKeyCache = false): DbOptions =
   DbOptions.init(
@@ -897,20 +885,11 @@ func dbOptions*(conf: NimbusConf, noKeyCache = false): DbOptions =
 proc makeConfig*(cmdLine = commandLineParams()): NimbusConf
     {.raises: [CatchableError].} =
   ## Note: this function is not gc-safe
-
-  # The try/catch clause can go away when `load()` is clean
-  try:
-    {.push warning[ProveInit]: off.}
-    result = NimbusConf.load(
-      cmdLine,
-      version = NimbusBuild,
-      copyrightBanner = NimbusHeader
-    )
-    {.pop.}
-  except CatchableError as e:
-    raise e
-
-  setupLogging(result.logLevel, result.logStdout, none(OutFile))
+  result = NimbusConf.load(
+    cmdLine,
+    version = NimbusBuild,
+    copyrightBanner = NimbusHeader
+  )
 
   processNetworkParamsAndNetworkId(result)
 
@@ -919,11 +898,6 @@ proc makeConfig*(cmdLine = commandLineParams()): NimbusConf
       # if udpPort not set in cli, then
       result.udpPort = result.tcpPort
 
-  # see issue #1346
-  if result.keyStore.string == defaultKeystoreDir() and
-     result.dataDir.string != defaultDataDir():
-    result.keyStore = OutDir(result.dataDir.string / "keystore")
-
 when isMainModule:
   # for testing purpose
   discard makeConfig()