feat(cbindings): first commit - waku relay (#1632) #1714
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -42,7 +42,6 @@ type | |
| defaultValue: newSeq[ProtectedTopic](0) | ||
| name: "protected-topic" .}: seq[ProtectedTopic] | ||
|
|
||
| ## Log configuration | ||
| logLevel* {. | ||
| desc: "Sets the log level for process. Supported levels: TRACE, DEBUG, INFO, NOTICE, WARN, ERROR or FATAL", | ||
|
|
@@ -54,7 +53,6 @@ type | |
| defaultValue: logging.LogFormat.TEXT, | ||
| name: "log-format" .}: logging.LogFormat | ||
|
|
||
| ## General node config | ||
| agentString* {. | ||
| defaultValue: "nwaku", | ||
|
|
@@ -570,14 +568,18 @@ proc readValue*(r: var EnvvarReader, value: var ProtectedTopic) {.raises: [Seria | |
|
|
||
| {.push warning[ProveInit]: off.} | ||
|
|
||
| proc load*(T: type WakuNodeConf, | ||
| version="", | ||
| configFile=""): ConfResult[T] = | ||
| try: | ||
| let conf = WakuNodeConf.load( | ||
| version=version, | ||
| secondarySources = proc (conf: WakuNodeConf, sources: auto) = | ||
| sources.addConfigFile(Envvar, InputFile("wakunode2")) | ||
|
|
||
| if configFile != "": | ||
| sources.addConfigFile(Toml, InputFile(configFile)) | ||
| elif conf.configFile.isSome(): | ||
| sources.addConfigFile(Toml, conf.configFile.get()) | ||
| ) | ||
| ok(conf) | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,6 +5,7 @@ else: | |
|
|
||
| import | ||
| std/[options, strutils, os], | ||
| stew/results, | ||
| stew/shims/net as stewNet, | ||
| chronicles, | ||
| chronos, | ||
|
|
@@ -13,30 +14,32 @@ import | |
| system/ansi_c, | ||
| libp2p/crypto/crypto | ||
| import | ||
| ../../waku/v2/waku_core/message/message, | ||
| ../../waku/common/logging, | ||
| ./config, | ||
| ./app | ||
|
|
||
| logScope: | ||
| topics = "wakunode main" | ||
|
|
||
| const wakuNode2VersionString* = "version / git commit hash: " & git_version | ||
|
|
||
| var wakunode2 {.threadvar.}: App | ||
| var confRes:ConfResult[WakuNodeConf] | ||
|
|
||
| {.pop.} # @TODO confutils.nim(775, 17) Error: can raise an unlisted exception: ref IOError | ||
| proc init*(configFilePath = "") = | ||
|
There was a problem hiding this comment. I see There was a problem hiding this comment. I don't think we should There was a problem hiding this comment.
IMO using a configuration is better. A config file should be used for a binary, a configuration object for a library. @jm-clius Where can I find the nim api documentation? Don't know if Im understanding correctly, but, does it mean that the There was a problem hiding this comment. The application simply provides a way to configure and instantiate the node, so I guess more similar to "embedded within the application". The Nim API documentation is sparse and outdated (since it's only used internally), but in theory lives here: https://github.com/waku-org/nwaku/blob/master/docs/api/v2/node.md There was a problem hiding this comment. Oh, it's very outdated, in fact. 😟 @Ivansete-status perhaps a good idea that we clean the Nim API doc up at some point during the development of the C bindings, since we're likely to expand/change it in any case. |
||
| let rng = crypto.newRng() | ||
|
|
||
| try: | ||
| confRes = WakuNodeConf.load(version=wakuNode2VersionString, | ||
| configFile=configFilePath) | ||
| if confRes.isErr(): | ||
| error "failure while loading the configuration", error=confRes.error | ||
| quit(QuitFailure) | ||
|
|
||
| except ValueError: | ||
| error "Exception loading the configuration", error=getCurrentExceptionMsg() | ||
| quit(QuitFailure) | ||
|
|
||
| let conf = confRes.get() | ||
|
|
@@ -50,8 +53,7 @@ when isMainModule: | |
| logging.setupLogLevel(conf.logLevel) | ||
| logging.setupLogFormat(conf.logFormat, color) | ||
|
|
||
| wakunode2 = App.new(rng, conf) | ||
|
|
||
| ############## | ||
| # Node setup # | ||
|
|
@@ -92,20 +94,19 @@ when isMainModule: | |
| error "4/7 Mounting protocols failed", error=res5.error | ||
| quit(QuitFailure) | ||
|
|
||
| proc startNode*() = | ||
|
There was a problem hiding this comment. Quite confused about this. Does this split the application's setup into an There was a problem hiding this comment. Exaclty, that is a simple split. However that might not be needed, and I will likely revert it back, when I wrap the |
||
| debug "5/7 Starting node and mounted protocols" | ||
|
|
||
| let res6 = waitFor wakunode2.startNode() | ||
| if res6.isErr(): | ||
| error "5/7 Starting node and protocols failed", error=res6.error | ||
| quit(QuitFailure) | ||
| debug "6/7 Starting monitoring and external interfaces" | ||
|
|
||
| let res7 = wakunode2.setupMonitoringAndExternalInterfaces() | ||
| if res7.isErr(): | ||
| error "6/7 Starting monitoring and external interfaces failed", error=res7.error | ||
| quit(QuitFailure) | ||
| debug "7/7 Setting up shutdown hooks" | ||
| ## Setup shutdown hooks for this process. | ||
| ## Stop node gracefully on shutdown. | ||
|
|
@@ -149,3 +150,30 @@ when isMainModule: | |
| info "Node setup complete" | ||
|
|
||
| runForever() | ||
|
|
||
| proc subscribeCallbackToTopic*(pubSubTopic: cstring, | ||
| callback: proc(pubsubTopic: string, data: seq[byte]): Future[void] {.gcsafe, raises: [Defect].}) = | ||
| wakunode2.subscribeCallbackToTopic(pubSubTopic, callback) | ||
|
|
||
| proc unsubscribeCallbackFromTopic*(pubSubTopic: cstring, | ||
| callback: proc(pubsubTopic: string, data: seq[byte]): Future[void] {.gcsafe, raises: [Defect].}) = | ||
| wakunode2.unsubscribeCallbackFromTopic(pubSubTopic, callback) | ||
|
|
||
| proc unsubscribeAllCallbacksFromTopic*(pubSubTopic: cstring) = | ||
| wakunode2.unsubscribeAllCallbackFromTopic(pubSubTopic) | ||
|
|
||
| proc publishMessage*(pubSubTopic: cstring, message: WakuMessage): Future[int] {.gcsafe, async.} = | ||
| return await wakunode2.publishMessage(pubSubTopic, message) | ||
|
There was a problem hiding this comment. The way I see it, these do not belong here. The C bindings should be a wrapper around the Nim API defined in |
||
|
|
||
|
|
||
| when isMainModule: | ||
| ## Node setup happens in 6 phases: | ||
| ## 1. Set up storage | ||
| ## 2. Initialize node | ||
| ## 3. Mount and initialize configured protocols | ||
| ## 4. Start node and mounted protocols | ||
| ## 5. Start monitoring tools and external interfaces | ||
| ## 6. Setup graceful shutdown hooks | ||
|
|
||
| init() | ||
| startNode() | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should move away from always having to specify
v2for Waku. Waku v1 is deprecated, in a sense, and not used anywhere. We even want to remove Waku v1 code from this repo, so it becomes simpler if we start referring to Waku v2 simply as the Waku. In other words, I think this can belibwaku(just replacing the name occupied by previous unused target).