logos-messaging/logos-messaging-nim
1
0
Fork 0
mirror of https://github.com/logos-messaging/logos-messaging-nim.git synced 2026-01-10 18:03:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

add some comments

Browse Source
This commit is contained in:
fryorcraken 2025-04-07 15:45:52 +10:00
parent 98114bde20
commit 5bd5b72706
2 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
waku/factory/waku_conf.nim
View File

@ -32,6 +32,10 @@ type RlnRelayConf* = ref object
userMessageLimit*: uint64
ethClientAddress*: EthRpcUrl
## `WakuConf` is a valid configuration for a Waku node
## All information needed by a waku node should be contained
## In this object. A convenient `validate` method enables doing
## sanity checks beyond type enforcement.
type WakuConf* = ref object
nodeKey*: PrivateKey

7
waku/factory/waku_conf_builder.nim
View File

@ -158,9 +158,10 @@ proc build(builder: Discv5ConfBuilder): Result[Option[Discv5Conf], string] =
return ok(some(Discv5Conf(bootstrapNodes: bootstrapNodes, udpPort: udpPort)))
#########################
## Waku Config Builder ##
#########################
## `WakuConfBuilder` is a convenient tool to accumulate
## Config parameters to build a `WakuConfig`.
## It provides some type conversion, as well as applying
## defaults in an agnostic manner (for any usage of Waku node)
type WakuConfBuilder* = ref object
nodeKey*: Option[PrivateKey]