import std/strutils, confutils, confutils/defs, confutils/std/net, confutils/toml/defs as confTomlDefs, confutils/toml/std/net as confTomlNet, chronicles, chronos, libp2p/crypto/crypto, libp2p/crypto/secp, nimcrypto/utils, eth/keys, ../protocol/waku_rln_relay/waku_rln_relay_types, ../protocol/waku_message export confTomlDefs, confTomlNet type WakuNodeConf* = object ## General node config configFile* {. desc: "Loads configuration from a TOML file (cmd-line parameters take precedence)" name: "config-file" }: Option[InputFile] logLevel* {. desc: "Sets the log level." defaultValue: LogLevel.INFO name: "log-level" }: LogLevel version* {. desc: "prints the version" defaultValue: false name: "version" }: bool nodekey* {. desc: "P2P node private key as 64 char hex string.", defaultValue: crypto.PrivateKey.random(Secp256k1, keys.newRng()[]).tryGet() name: "nodekey" }: crypto.PrivateKey listenAddress* {. defaultValue: defaultListenAddress(config) desc: "Listening address for LibP2P (and Discovery v5, if enabled) traffic." name: "listen-address"}: ValidIpAddress tcpPort* {. desc: "TCP listening port." defaultValue: 60000 name: "tcp-port" }: Port portsShift* {. desc: "Add a shift to all port numbers." defaultValue: 0 name: "ports-shift" }: uint16 nat* {. desc: "Specify method to use for determining public address. " & "Must be one of: any, none, upnp, pmp, extip:." defaultValue: "any" }: string maxConnections* {. desc: "Maximum allowed number of libp2p connections." defaultValue: 50 name: "max-connections" }: uint16 ## Persistence config dbPath* {. desc: "The database path for peristent storage", defaultValue: "" name: "db-path" }: string persistPeers* {. desc: "Enable peer persistence: true|false", defaultValue: false name: "persist-peers" }: bool persistMessages* {. desc: "Enable message persistence: true|false", defaultValue: false name: "persist-messages" }: bool ## DNS addrs config dnsAddrs* {. desc: "Enable resolution of `dnsaddr`, `dns4` or `dns6` multiaddrs" defaultValue: true name: "dns-addrs" }: bool dnsAddrsNameServers* {. desc: "DNS name server IPs to query for DNS multiaddrs resolution. Argument may be repeated." defaultValue: @[ValidIpAddress.init("1.1.1.1"), ValidIpAddress.init("1.0.0.1")] name: "dns-addrs-name-server" }: seq[ValidIpAddress] dns4DomainName* {. desc: "The domain name resolving to the node's public IPv4 address", defaultValue: "" name: "dns4-domain-name" }: string ## Relay config relay* {. desc: "Enable relay protocol: true|false", defaultValue: true name: "relay" }: bool relayPeerExchange* {. desc: "Enable gossipsub peer exchange in relay protocol: true|false", defaultValue: false name: "relay-peer-exchange" }: bool rlnRelay* {. desc: "Enable spam protection through rln-relay: true|false", defaultValue: false name: "rln-relay" }: bool rlnRelayMemIndex* {. desc: "(experimental) the index of node in the rln-relay group: a value between 0-99 inclusive", defaultValue: MembershipIndex(0) name: "rln-relay-membership-index" }: MembershipIndex rlnRelayPubsubTopic* {. desc: "the pubsub topic for which rln-relay gets enabled", defaultValue: "/waku/2/default-waku/proto" name: "rln-relay-pubsub-topic" }: string rlnRelayContentTopic* {. desc: "the pubsub topic for which rln-relay gets enabled", defaultValue: "/toy-chat/2/luzhou/proto" name: "rln-relay-content-topic" }: ContentTopic staticnodes* {. desc: "Peer multiaddr to directly connect with. Argument may be repeated." name: "staticnode" }: seq[string] keepAlive* {. desc: "Enable keep-alive for idle connections: true|false", defaultValue: false name: "keep-alive" }: bool topics* {. desc: "Default topics to subscribe to (space separated list)." defaultValue: "/waku/2/default-waku/proto" name: "topics" .}: string ## Store config store* {. desc: "Enable store protocol: true|false", defaultValue: true name: "store" }: bool storenode* {. desc: "Peer multiaddr to query for storage.", defaultValue: "" name: "storenode" }: string storeCapacity* {. desc: "Maximum number of messages to keep in store.", defaultValue: 50000 name: "store-capacity" }: int ## Filter config filter* {. desc: "Enable filter protocol: true|false", defaultValue: false name: "filter" }: bool filternode* {. desc: "Peer multiaddr to request content filtering of messages.", defaultValue: "" name: "filternode" }: string filterTimeout* {. desc: "Timeout for filter node in seconds.", defaultValue: 14400 # 4 hours name: "filter-timeout" }: int64 ## Swap config swap* {. desc: "Enable swap protocol: true|false", defaultValue: true name: "swap" }: bool ## Lightpush config lightpush* {. desc: "Enable lightpush protocol: true|false", defaultValue: false name: "lightpush" }: bool lightpushnode* {. desc: "Peer multiaddr to request lightpush of published messages.", defaultValue: "" name: "lightpushnode" }: string ## JSON-RPC config rpc* {. desc: "Enable Waku JSON-RPC server: true|false", defaultValue: true name: "rpc" }: bool rpcAddress* {. desc: "Listening address of the JSON-RPC server.", defaultValue: ValidIpAddress.init("127.0.0.1") name: "rpc-address" }: ValidIpAddress rpcPort* {. desc: "Listening port of the JSON-RPC server.", defaultValue: 8545 name: "rpc-port" }: uint16 rpcAdmin* {. desc: "Enable access to JSON-RPC Admin API: true|false", defaultValue: false name: "rpc-admin" }: bool rpcPrivate* {. desc: "Enable access to JSON-RPC Private API: true|false", defaultValue: false name: "rpc-private" }: bool ## Metrics config metricsServer* {. desc: "Enable the metrics server: true|false" defaultValue: false name: "metrics-server" }: bool metricsServerAddress* {. desc: "Listening address of the metrics server." defaultValue: ValidIpAddress.init("127.0.0.1") name: "metrics-server-address" }: ValidIpAddress metricsServerPort* {. desc: "Listening HTTP port of the metrics server." defaultValue: 8008 name: "metrics-server-port" }: uint16 metricsLogging* {. desc: "Enable metrics logging: true|false" defaultValue: false name: "metrics-logging" }: bool ## DNS discovery config dnsDiscovery* {. desc: "Enable discovering nodes via DNS" defaultValue: false name: "dns-discovery" }: bool dnsDiscoveryUrl* {. desc: "URL for DNS node list in format 'enrtree://@'", defaultValue: "" name: "dns-discovery-url" }: string dnsDiscoveryNameServers* {. desc: "DNS name server IPs to query. Argument may be repeated." defaultValue: @[ValidIpAddress.init("1.1.1.1"), ValidIpAddress.init("1.0.0.1")] name: "dns-discovery-name-server" }: seq[ValidIpAddress] ## Discovery v5 config discv5Discovery* {. desc: "Enable discovering nodes via Node Discovery v5" defaultValue: false name: "discv5-discovery" }: bool discv5UdpPort* {. desc: "Listening UDP port for Node Discovery v5." defaultValue: 9000 name: "discv5-udp-port" }: Port discv5BootstrapNodes* {. desc: "Text-encoded ENR for bootstrap node. Used when connecting to the network. Argument may be repeated." name: "discv5-bootstrap-node" }: seq[string] discv5EnrAutoUpdate* {. desc: "Discovery can automatically update its ENR with the IP address " & "and UDP port as seen by other nodes it communicates with. " & "This option allows to enable/disable this functionality" defaultValue: false name: "discv5-enr-auto-update" .}: bool discv5TableIpLimit* {. hidden desc: "Maximum amount of nodes with the same IP in discv5 routing tables" defaultValue: 10 name: "discv5-table-ip-limit" .}: uint discv5BucketIpLimit* {. hidden desc: "Maximum amount of nodes with the same IP in discv5 routing table buckets" defaultValue: 2 name: "discv5-bucket-ip-limit" .}: uint discv5BitsPerHop* {. hidden desc: "Kademlia's b variable, increase for less hops per lookup" defaultValue: 1 name: "discv5-bits-per-hop" .}: int ## websocket config websocketSupport* {. desc: "Enable websocket: true|false", defaultValue: false name: "websocket-support"}: bool websocketPort* {. desc: "WebSocket listening port." defaultValue: 8000 name: "websocket-port" }: Port websocketSecureSupport* {. desc: "Enable secure websocket: true|false", defaultValue: false name: "websocket-secure-support"}: bool websocketSecureKeyPath* {. desc: "Secure websocket key path: '/path/to/key.txt' ", defaultValue: "" name: "websocket-secure-key-path"}: string websocketSecureCertPath* {. desc: "Secure websocket Certificate path: '/path/to/cert.txt' ", defaultValue: "" name: "websocket-secure-cert-path"}: string # NOTE: Keys are different in nim-libp2p proc parseCmdArg*(T: type crypto.PrivateKey, p: TaintedString): T = try: let key = SkPrivateKey.init(utils.fromHex(p)).tryGet() # XXX: Here at the moment result = crypto.PrivateKey(scheme: Secp256k1, skkey: key) except CatchableError as e: raise newException(ConfigurationError, "Invalid private key") proc completeCmdArg*(T: type crypto.PrivateKey, val: TaintedString): seq[string] = return @[] proc parseCmdArg*(T: type ValidIpAddress, p: TaintedString): T = try: result = ValidIpAddress.init(p) except CatchableError as e: raise newException(ConfigurationError, "Invalid IP address") proc completeCmdArg*(T: type ValidIpAddress, val: TaintedString): seq[string] = return @[] proc parseCmdArg*(T: type Port, p: TaintedString): T = try: result = Port(parseInt(p)) except CatchableError as e: raise newException(ConfigurationError, "Invalid Port number") proc completeCmdArg*(T: type Port, val: TaintedString): seq[string] = return @[] func defaultListenAddress*(conf: WakuNodeConf): ValidIpAddress = # TODO: How should we select between IPv4 and IPv6 # Maybe there should be a config option for this. (static ValidIpAddress.init("0.0.0.0")) proc readValue*(r: var TomlReader, val: var crypto.PrivateKey) {.raises: [Defect, IOError, SerializationError].} = val = try: parseCmdArg(crypto.PrivateKey, r.readValue(string)) except CatchableError as err: raise newException(SerializationError, err.msg)