feat: Waku API create node (#3580)

* introduce createNode

# Conflicts:
#	apps/wakunode2/cli_args.nim

* remove confutils dependency on the library

* test: remove websocket in default test config

* update to latest specs

* test: cli_args

* align to spec changes (sovereign, message conf, entrypoints

* accept enr, entree and multiaddr as entry points

* post rebase

* format

* change from "sovereign" to "core"

* add example

* get example to continue running

* nitpicks

* idiomatic constructors

* fix enum naming

* replace procs with consts

* remove messageConfirmation

* use pure enum

* rename example file

Author: fryorcraken

apps/liteprotocoltester/diagnose_connections.nim

@@ -14,8 +14,8 @@ import
   libp2p/wire
 
 import
+  ../../tools/confutils/cli_args,
   waku/[
-    factory/external_config,
     node/peer_manager,
     waku_lightpush/common,
     waku_relay,

apps/liteprotocoltester/liteprotocoltester.nim

@@ -11,11 +11,11 @@ import
   confutils
 
 import
+  ../../tools/confutils/cli_args,
   waku/[
     common/enr,
     common/logging,
     factory/waku as waku_factory,
-    factory/external_config,
     waku_node,
     node/waku_metrics,
     node/peer_manager,

apps/liteprotocoltester/service_peer_management.nim

@@ -11,8 +11,8 @@ import
   libp2p/wire
 
 import
+  ../wakunode2/cli_args,
   waku/[
-    factory/external_config,
     common/enr,
     waku_node,
     node/peer_manager,

apps/liteprotocoltester/tester_config.nim

@@ -12,14 +12,9 @@ import
   secp256k1
 
 import
-  waku/[
-    common/confutils/envvar/defs as confEnvvarDefs,
-    common/confutils/envvar/std/net as confEnvvarNet,
-    common/logging,
-    factory/external_config,
-    waku_core,
-    waku_core/topics/pubsub_topic,
-  ]
+  ../../tools/confutils/
+    [cli_args, envvar as confEnvvarDefs, envvar_net as confEnvvarNet],
+  waku/[common/logging, waku_core, waku_core/topics/pubsub_topic]
 
 export confTomlDefs, confTomlNet, confEnvvarDefs, confEnvvarNet
 

apps/liteprotocoltester/v3_publisher.nim

@@ -1,5 +1,5 @@
 import results, options, chronos
-import waku/[waku_node, waku_core, waku_lightpush]
+import waku/[waku_node, waku_core, waku_lightpush, waku_lightpush/common]
 import publisher_base
 
 type V3Publisher* = ref object of PublisherBase

apps/wakunode2/wakunode2.nim

@@ -9,13 +9,13 @@ import
   system/ansi_c,
   libp2p/crypto/crypto
 import
-  ../../tools/rln_keystore_generator/rln_keystore_generator,
+  ../../tools/[rln_keystore_generator/rln_keystore_generator, confutils/cli_args],
   waku/[
     common/logging,
-    factory/external_config,
     factory/waku,
     node/health_monitor,
     waku_api/rest/builder as rest_server_builder,
+    waku_core/message/default_values,
   ]
 
 logScope:

examples/README.md

@@ -7,9 +7,21 @@ Make all examples.
 make example2
 ```
 
-## basic2
+## Waku API
 
-TODO
+Uses the simplified Waku API to create and start a node,
+you need an RPC endpoint for Linea Sepolia for RLN:
+
+```console
+./build/waku_api --ethRpcEndpoint=https://linea-sepolia.infura.io/v3/<your key>
+```
+
+If you can't be bothered but still want to see some action,
+just run the binary and it will use a non-RLN network:
+
+```console
+./build/waku_api
+```
 
 ## publisher/subscriber
 

examples/waku_example.nim

@@ -0,0 +1,38 @@
+import std/options
+import chronos, results, confutils, confutils/defs
+import waku
+
+type CliArgs = object
+  ethRpcEndpoint* {.
+    defaultValue: "", desc: "ETH RPC Endpoint, if passed, RLN is enabled"
+  .}: string
+
+when isMainModule:
+  let args = CliArgs.load()
+
+  echo "Starting Waku node..."
+
+  let config =
+    if (args.ethRpcEndpoint == ""):
+      # Create a basic configuration for the Waku node
+      # No RLN as we don't have an ETH RPC Endpoint
+      NodeConfig.init(wakuConfig = WakuConfig.init(entryNodes = @[], clusterId = 42))
+    else:
+      # Connect to TWN, use ETH RPC Endpoint for RLN
+      NodeConfig.init(ethRpcEndpoints = @[args.ethRpcEndpoint])
+
+  # Create the node using the library API's createNode function
+  let node = (waitFor createNode(config)).valueOr:
+    echo "Failed to create node: ", error
+    quit(QuitFailure)
+
+  echo("Waku node created successfully!")
+
+  # Start the node
+  (waitFor startWaku(addr node)).isOkOr:
+    echo "Failed to start node: ", error
+    quit(QuitFailure)
+
+  echo "Node started successfully!"
+
+  runForever()

examples/wakustealthcommitments/node_spec.nim

@@ -1,6 +1,7 @@
 {.push raises: [].}
 
-import waku/[common/logging, factory/[waku, networks_config, external_config]]
+import ../../apps/wakunode2/cli_args
+import waku/[common/logging, factory/[waku, networks_config]]
 import
   std/[options, strutils, os, sequtils],
   chronicles,

library/waku_thread_requests/requests/node_lifecycle_request.nim

@@ -3,7 +3,7 @@ import chronos, chronicles, results, confutils, confutils/std/net
 
 import
   ../../../waku/node/peer_manager/peer_manager,
-  ../../../waku/factory/external_config,
+  ../../../tools/confutils/cli_args,
   ../../../waku/factory/waku,
   ../../../waku/factory/node_factory,
   ../../../waku/factory/networks_config,