chore!: separate internal and CLI configurations

Split `WakuNodeConfig` object for better separation of concerns and to introduce a tree-like structure to configuration.

Author: fryorcraken

apps/chat2/chat2.nim

@@ -553,14 +553,19 @@ proc processInput(rfd: AsyncFD, rng: ref HmacDrbgContext) {.async.} =
       echo "rln-relay preparation is in progress..."
 
       let rlnConf = WakuRlnConfig(
-        rlnRelayDynamic: conf.rlnRelayDynamic,
-        rlnRelayCredIndex: conf.rlnRelayCredIndex,
-        rlnRelayEthContractAddress: conf.rlnRelayEthContractAddress,
-        rlnRelayEthClientAddress: string(conf.rlnRelayethClientAddress),
-        rlnRelayCredPath: conf.rlnRelayCredPath,
-        rlnRelayCredPassword: conf.rlnRelayCredPassword,
-        rlnRelayUserMessageLimit: conf.rlnRelayUserMessageLimit,
-        rlnEpochSizeSec: conf.rlnEpochSizeSec,
+        dynamic: conf.rlnRelayDynamic,
+        credIndex: conf.rlnRelayCredIndex,
+        chainId: conf.rlnRelayChainId,
+        ethContractAddress: conf.rlnRelayEthContractAddress,
+        ethClientAddress: string(conf.rlnRelayethClientAddress),
+        creds: some(
+          RlnRelayCreds(
+            path: conf.rlnRelayCredPath, password: conf.rlnRelayCredPassword
+          )
+        ),
+        userMessageLimit: conf.rlnRelayUserMessageLimit,
+        epochSizeSec: conf.rlnEpochSizeSec,
+        treePath: conf.rlnRelayTreePath,
       )
 
       waitFor node.mountRlnRelay(rlnConf, spamHandler = some(spamHandler))

apps/chat2/config_chat2.nim

@@ -213,6 +213,13 @@ type
       name: "rln-relay"
     .}: bool
 
+    rlnRelayChainId* {.
+      desc:
+        "Chain ID of the provided contract (optional, will fetch from RPC provider if not used)",
+      defaultValue: 0,
+      name: "rln-relay-chain-id"
+    .}: uint
+
     rlnRelayCredPath* {.
       desc: "The path for peristing rln-relay credential",
       defaultValue: "",
@@ -273,6 +280,12 @@ type
       name: "rln-relay-epoch-sec"
     .}: uint64
 
+    rlnRelayTreePath* {.
+      desc: "Path to the RLN merkle tree sled db (https://github.com/spacejam/sled)",
+      defaultValue: "",
+      name: "rln-relay-tree-path"
+    .}: string
+
 # NOTE: Keys are different in nim-libp2p
 proc parseCmdArg*(T: type crypto.PrivateKey, p: string): T =
   try:

apps/liteprotocoltester/liteprotocoltester.nim

@@ -126,7 +126,7 @@ when isMainModule:
   nodeHealthMonitor = WakuNodeHealthMonitor()
   nodeHealthMonitor.setOverallHealth(HealthStatus.INITIALIZING)
 
-  let restServer = rest_server_builder.startRestServerEsentials(
+  let restServer = rest_server_builder.startRestServerEssentials(
     nodeHealthMonitor, wakuConf
   ).valueOr:
     error "Starting esential REST server failed.", error = $error

apps/networkmonitor/networkmonitor.nim

@@ -462,7 +462,7 @@ proc initAndStartApp(
 
   nodeBuilder.withNodeKey(key)
   nodeBuilder.withRecord(record)
-  nodeBUilder.withSwitchConfiguration(maxConnections = some(MaxConnectedPeers))
+  nodeBuilder.withSwitchConfiguration(maxConnections = some(MaxConnectedPeers))
 
   nodeBuilder.withPeerManagerConfig(
     maxConnections = MaxConnectedPeers,
@@ -630,14 +630,13 @@ when isMainModule:
 
   if conf.rlnRelay and conf.rlnRelayEthContractAddress != "":
     let rlnConf = WakuRlnConfig(
-      rlnRelayDynamic: conf.rlnRelayDynamic,
-      rlnRelayCredIndex: some(uint(0)),
-      rlnRelayEthContractAddress: conf.rlnRelayEthContractAddress,
-      rlnRelayEthClientAddress: string(conf.rlnRelayethClientAddress),
-      rlnRelayCredPath: "",
-      rlnRelayCredPassword: "",
-      rlnRelayTreePath: conf.rlnRelayTreePath,
-      rlnEpochSizeSec: conf.rlnEpochSizeSec,
+      dynamic: conf.rlnRelayDynamic,
+      credIndex: some(uint(0)),
+      ethContractAddress: conf.rlnRelayEthContractAddress,
+      ethClientAddress: string(conf.rlnRelayethClientAddress),
+      treePath: conf.rlnRelayTreePath,
+      epochSizeSec: conf.rlnEpochSizeSec,
+      creds: none(RlnRelayCreds),
       onFatalErrorAction: onFatalErrorAction,
     )
 

apps/wakunode2/wakunode2.nim

@@ -38,17 +38,23 @@ when isMainModule:
 
   const versionString = "version / git commit hash: " & waku.git_version
 
-  var conf = WakuNodeConf.load(version = versionString).valueOr:
+  var wakuNodeConf = WakuNodeConf.load(version = versionString).valueOr:
     error "failure while loading the configuration", error = error
     quit(QuitFailure)
 
-  ## Also called within Waku.new. The call to startRestServerEsentials needs the following line
-  logging.setupLog(conf.logLevel, conf.logFormat)
+  ## Also called within Waku.new. The call to startRestServerEssentials needs the following line
+  logging.setupLog(wakuNodeConf.logLevel, wakuNodeConf.logFormat)
 
-  case conf.cmd
+  case wakuNodeConf.cmd
   of generateRlnKeystore:
+    let conf = wakuNodeConf.toKeystoreGeneratorConf().valueOr:
+      error "Configuration failed", error = error
+      quit(QuitFailure)
     doRlnKeystoreGenerator(conf)
   of inspectRlnDb:
+    let conf = wakuNodeConf.toInspectRlnDbConf().valueOr:
+      error "Configuration failed", error = error
+      quit(QuitFailure)
     doInspectRlnDb(conf)
   of noCommand:
     # NOTE: {.threadvar.} is used to make the global variable GC safe for the closure uses it
@@ -58,15 +64,20 @@ when isMainModule:
     nodeHealthMonitor = WakuNodeHealthMonitor()
     nodeHealthMonitor.setOverallHealth(HealthStatus.INITIALIZING)
 
-    var confCopy = conf
-
-    let restServer = rest_server_builder.startRestServerEsentials(
-      nodeHealthMonitor, confCopy
-    ).valueOr:
-      error "Starting esential REST server failed.", error = $error
+    let conf = wakuNodeConf.toWakuConf().valueOr:
+      error "Waku configuration failed", error = error
       quit(QuitFailure)
 
-    var waku = Waku.new(confCopy).valueOr:
+    var restServer: WakuRestServerRef = nil
+
+    if conf.restServerConf.isSome:
+      restServer = rest_server_builder.startRestServerEssentials(
+        nodeHealthMonitor, conf.restServerConf.get(), conf.portsShift
+      ).valueOr:
+        error "Starting essential REST server failed.", error = $error
+        quit(QuitFailure)
+
+    var waku = Waku.new(conf).valueOr:
       error "Waku initialization failed", error = error
       quit(QuitFailure)
 
@@ -78,15 +89,27 @@ when isMainModule:
       error "Starting waku failed", error = error
       quit(QuitFailure)
 
-    rest_server_builder.startRestServerProtocolSupport(
-      restServer, waku.node, waku.wakuDiscv5, confCopy
-    ).isOkOr:
-      error "Starting protocols support REST server failed.", error = $error
-      quit(QuitFailure)
+    if conf.restServerConf.isSome:
+      rest_server_builder.startRestServerProtocolSupport(
+        restServer,
+        waku.node,
+        waku.wakuDiscv5,
+        conf.restServerConf.get(),
+        conf.relay,
+        conf.lightPush,
+        conf.clusterId,
+        conf.shards,
+        conf.contentTopics,
+      ).isOkOr:
+        error "Starting protocols support REST server failed.", error = $error
+        quit(QuitFailure)
 
-    waku.metricsServer = waku_metrics.startMetricsServerAndLogging(confCopy).valueOr:
-      error "Starting monitoring and external interfaces failed", error = error
-      quit(QuitFailure)
+    if conf.metricsServerConf.isSome:
+      waku.metricsServer = waku_metrics.startMetricsServerAndLogging(
+        conf.metricsServerConf.get(), conf.portsShift
+      ).valueOr:
+        error "Starting monitoring and external interfaces failed", error = error
+        quit(QuitFailure)
 
     nodeHealthMonitor.setOverallHealth(HealthStatus.READY)
 

examples/wakustealthcommitments/node_spec.nim

@@ -36,7 +36,6 @@ proc setup*(): Waku =
   conf.clusterId = twnClusterConf.clusterId
   conf.rlnRelayEthContractAddress = twnClusterConf.rlnRelayEthContractAddress
   conf.rlnRelayDynamic = twnClusterConf.rlnRelayDynamic
-  conf.rlnRelayBandwidthThreshold = twnClusterConf.rlnRelayBandwidthThreshold
   conf.discv5Discovery = twnClusterConf.discv5Discovery
   conf.discv5BootstrapNodes =
     conf.discv5BootstrapNodes & twnClusterConf.discv5BootstrapNodes

tests/all_tests_waku.nim

@@ -107,4 +107,4 @@ import
 import ./waku_rln_relay/test_all
 
 # Node Factory
-import ./factory/test_config
+import ./factory/test_external_config

tests/factory/test_config.nim renamed to tests/factory/test_external_config.nim

@@ -11,35 +11,47 @@ import
   confutils
 import
   ../../waku/factory/external_config,
-  ../../waku/factory/internal_config,
   ../../waku/factory/networks_config,
-  ../../waku/common/logging
+  ../../waku/factory/waku_conf,
+  ../../waku/common/logging,
+  ../../waku/common/utils/parse_size_units
 
 suite "Waku config - apply preset":
   test "Default preset is TWN":
     ## Setup
     let expectedConf = ClusterConf.TheWakuNetworkConf()
 
     ## Given
-    let preConfig = WakuNodeConf(cmd: noCommand, preset: "twn")
+    let preConfig = WakuNodeConf(
+      cmd: noCommand,
+      preset: "twn",
+      relay: true,
+      rlnRelayEthClientAddress: "http://someaddress".EthRpcUrl,
+      rlnRelayTreePath: "/tmp/sometreepath",
+    )
 
     ## When
-    let res = applyPresetConfiguration(preConfig)
+    let res = preConfig.toWakuConf()
     assert res.isOk(), $res.error
 
     ## Then
     let conf = res.get()
-    assert conf.maxMessageSize == expectedConf.maxMessageSize
-    assert conf.clusterId == expectedConf.clusterId
-    assert conf.rlnRelay == expectedConf.rlnRelay
-    assert conf.rlnRelayEthContractAddress == expectedConf.rlnRelayEthContractAddress
-    assert conf.rlnRelayDynamic == expectedConf.rlnRelayDynamic
-    assert conf.rlnRelayChainId == expectedConf.rlnRelayChainId
-    assert conf.rlnRelayBandwidthThreshold == expectedConf.rlnRelayBandwidthThreshold
-    assert conf.rlnEpochSizeSec == expectedConf.rlnEpochSizeSec
-    assert conf.rlnRelayUserMessageLimit == expectedConf.rlnRelayUserMessageLimit
-    assert conf.numShardsInNetwork == expectedConf.numShardsInNetwork
-    assert conf.discv5BootstrapNodes == expectedConf.discv5BootstrapNodes
+    check conf.maxMessageSizeBytes ==
+      uint64(parseCorrectMsgSize(expectedConf.maxMessageSize))
+    check conf.clusterId == expectedConf.clusterId
+    check conf.rlnRelayConf.isSome() == expectedConf.rlnRelay
+    if conf.rlnRelayConf.isSome():
+      let rlnRelayConf = conf.rlnRelayConf.get()
+      check rlnRelayConf.ethContractAddress == expectedConf.rlnRelayEthContractAddress
+      check rlnRelayConf.dynamic == expectedConf.rlnRelayDynamic
+      check rlnRelayConf.chainId == expectedConf.rlnRelayChainId
+      check rlnRelayConf.epochSizeSec == expectedConf.rlnEpochSizeSec
+      check rlnRelayConf.userMessageLimit == expectedConf.rlnRelayUserMessageLimit
+    check conf.numShardsInNetwork == expectedConf.numShardsInNetwork
+    check conf.discv5Conf.isSome() == expectedConf.discv5Discovery
+    if expectedConf.discv5Discovery:
+      let discv5Conf = conf.discv5Conf.get()
+      check discv5Conf.bootstrapNodes == expectedConf.discv5BootstrapNodes
 
   test "Subscribes to all valid shards in twn":
     ## Setup
@@ -50,12 +62,12 @@ suite "Waku config - apply preset":
     let preConfig = WakuNodeConf(cmd: noCommand, preset: "twn", shards: shards)
 
     ## When
-    let res = applyPresetConfiguration(preConfig)
+    let res = preConfig.toWakuConf()
     assert res.isOk(), $res.error
 
     ## Then
     let conf = res.get()
-    assert conf.shards.len == expectedConf.numShardsInNetwork.int
+    check conf.shards.len == expectedConf.numShardsInNetwork.int
 
   test "Subscribes to some valid shards in twn":
     ## Setup
@@ -66,9 +78,8 @@ suite "Waku config - apply preset":
     let preConfig = WakuNodeConf(cmd: noCommand, preset: "twn", shards: shards)
 
     ## When
-    let resConf = applyPresetConfiguration(preConfig)
-    let res = validateShards(resConf.get())
-    assert res.isOk(), $res.error
+    let resConf = preConfig.toWakuConf()
+    assert resConf.isOk(), $resConf.error
 
     ## Then
     let conf = resConf.get()
@@ -82,10 +93,9 @@ suite "Waku config - apply preset":
     ## Given
     let shards: seq[uint16] = @[0, 4, 7, 10]
     let preConfig = WakuNodeConf(cmd: noCommand, preset: "twn", shards: shards)
-    let postConfig = applyPresetConfiguration(preConfig)
 
     ## When
-    let res = validateShards(postConfig.get())
+    let res = preConfig.toWakuConf()
 
     ## Then
     assert res.isErr(), "Invalid shard was accepted"
@@ -103,11 +113,11 @@ suite "Waku config - node key":
     let config = WakuNodeConf.load(version = "", cmdLine = @["--nodekey=" & nodeKeyStr])
 
     ## When
-    let res = getNodeKey(config)
+    let res = config.toWakuConf()
     assert res.isOk(), $res.error
 
     ## Then
-    let resKey = res.get()
+    let resKey = res.get().nodeKey
     assert utils.toHex(resKey.getRawBytes().get()) ==
       utils.toHex(nodekey.getRawBytes().get())
 
@@ -118,28 +128,31 @@ suite "Waku config - Shards":
     ## Given
     let shards: seq[uint16] = @[0, 2, 4]
     let numShardsInNetwork = 5.uint32
-    let config = WakuNodeConf(
+    let wakuNodeConf = WakuNodeConf(
       cmd: noCommand, shards: shards, numShardsInNetwork: numShardsInNetwork
     )
 
     ## When
-    let res = validateShards(config)
+    let res = wakuNodeConf.toWakuConf()
+    assert res.isOk(), $res.error
 
     ## Then
-    assert res.isOk(), $res.error
+    let wakuConf = res.get()
+    let vRes = wakuConf.validate()
+    assert vRes.isOk(), $vRes.error
 
   test "Shards are not in range":
     ## Setup
 
     ## Given
     let shards: seq[uint16] = @[0, 2, 5]
     let numShardsInNetwork = 5.uint32
-    let config = WakuNodeConf(
+    let wakuNodeConf = WakuNodeConf(
       cmd: noCommand, shards: shards, numShardsInNetwork: numShardsInNetwork
     )
 
     ## When
-    let res = validateShards(config)
+    let res = wakuNodeConf.toWakuConf()
 
     ## Then
     assert res.isErr(), "Invalid shard was accepted"
@@ -148,10 +161,12 @@ suite "Waku config - Shards":
     ## Setup
 
     ## Given
-    let config = WakuNodeConf.load(version = "", cmdLine = @["--shard=32"])
+    let wakuNodeConf = WakuNodeConf.load(version = "", cmdLine = @["--shard=32"])
 
     ## When
-    let res = validateShards(config)
+    let res = wakuNodeConf.toWakuConf()
 
     ## Then
-    assert res.isOk(), $res.error
+    let wakuConf = res.get()
+    let vRes = wakuConf.validate()
+    assert vRes.isOk(), $vRes.error