diff --git a/waku/factory/waku_conf.nim b/waku/factory/waku_conf.nim index d528bf4f2..e5cbeac05 100644 --- a/waku/factory/waku_conf.nim +++ b/waku/factory/waku_conf.nim @@ -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 diff --git a/waku/factory/waku_conf_builder.nim b/waku/factory/waku_conf_builder.nim index 72f44290d..1550c8d2a 100644 --- a/waku/factory/waku_conf_builder.nim +++ b/waku/factory/waku_conf_builder.nim @@ -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]