logos-messaging/logos-messaging-rust-bindings
1
0
Fork 0
mirror of https://github.com/logos-messaging/logos-messaging-rust-bindings.git synced 2026-01-08 00:43:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added config docs

Browse Source
This commit is contained in:
Daniel Sanchez Quiros 2022-09-29 18:55:45 +02:00
parent 03187ccb6c
commit 4f094b4ed7
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
waku/src/node_management/config.rs
View File

@ -5,17 +5,28 @@ use multiaddr::Multiaddr;
use serde::{Deserialize, Serialize};
// internal
/// Waku node configuration
#[derive(Clone, Default, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct NodeConfig {
/// Listening IP address. Default `0.0.0.0`
host: Option<std::net::IpAddr>,
/// Libp2p TCP listening port. Default `60000`. Use `0` for **random**
port: Option<usize>,
/// External address to advertise to other nodes. Can be ip4, ip6 or dns4, dns6.
/// If null, the multiaddress(es) generated from the ip and port specified in the config (or default ones) will be used.
/// Default: null
advertise_addr: Option<Multiaddr>,
/// Secp256k1 private key in Hex format (`0x123...abc`). Default random
#[serde(with = "secret_key_serde")]
node_key: Option<SecretKey>,
/// Interval in seconds for pinging peers to keep the connection alive. Default `20`
keep_alive_interval: Option<usize>,
/// Enable relay protocol. Default `true`
relay: Option<bool>,
/// The minimum number of peers required on a topic to allow broadcasting a message. Default `0`
min_peers_to_publish: Option<usize>,
/// Enable filter protocol. Default `false`
filter: Option<bool>,
}