mirror of
https://github.com/sigp/lighthouse.git
synced 2026-03-15 19:02:42 +00:00
8c96739cab
* Improve handling of discovery IP address CLI config * Remove excess debug logging * Add reviewers suggestions
111 lines
3.7 KiB
Rust
111 lines
3.7 KiB
Rust
use crate::topics::GossipTopic;
|
|
use enr::Enr;
|
|
use libp2p::gossipsub::{GossipsubConfig, GossipsubConfigBuilder, GossipsubMessage, MessageId};
|
|
use libp2p::Multiaddr;
|
|
use serde_derive::{Deserialize, Serialize};
|
|
use sha2::{Digest, Sha256};
|
|
use std::path::PathBuf;
|
|
use std::time::Duration;
|
|
|
|
#[derive(Clone, Debug, Serialize, Deserialize)]
|
|
#[serde(default)]
|
|
/// Network configuration for lighthouse.
|
|
pub struct Config {
|
|
/// Data directory where node's keyfile is stored
|
|
pub network_dir: PathBuf,
|
|
|
|
/// IP address to listen on.
|
|
pub listen_address: std::net::IpAddr,
|
|
|
|
/// The TCP port that libp2p listens on.
|
|
pub libp2p_port: u16,
|
|
|
|
/// The address to broadcast to peers about which address we are listening on. None indicates
|
|
/// that no discovery address has been set in the CLI args.
|
|
pub discovery_address: Option<std::net::IpAddr>,
|
|
|
|
/// UDP port that discovery listens on.
|
|
pub discovery_port: u16,
|
|
|
|
/// Target number of connected peers.
|
|
pub max_peers: usize,
|
|
|
|
/// A secp256k1 secret key, as bytes in ASCII-encoded hex.
|
|
///
|
|
/// With or without `0x` prefix.
|
|
#[serde(skip)]
|
|
pub secret_key_hex: Option<String>,
|
|
|
|
/// Gossipsub configuration parameters.
|
|
#[serde(skip)]
|
|
pub gs_config: GossipsubConfig,
|
|
|
|
/// List of nodes to initially connect to.
|
|
pub boot_nodes: Vec<Enr>,
|
|
|
|
/// List of libp2p nodes to initially connect to.
|
|
pub libp2p_nodes: Vec<Multiaddr>,
|
|
|
|
/// Client version
|
|
pub client_version: String,
|
|
|
|
/// List of extra topics to initially subscribe to as strings.
|
|
pub topics: Vec<GossipTopic>,
|
|
|
|
/// Introduces randomization in network propagation of messages. This should only be set for
|
|
/// testing purposes and will likely be removed in future versions.
|
|
// TODO: Remove this functionality for mainnet
|
|
pub propagation_percentage: Option<u8>,
|
|
}
|
|
|
|
impl Default for Config {
|
|
/// Generate a default network configuration.
|
|
fn default() -> Self {
|
|
let mut network_dir = dirs::home_dir().unwrap_or_else(|| PathBuf::from("."));
|
|
network_dir.push(".lighthouse");
|
|
network_dir.push("network");
|
|
|
|
// The default topics that we will initially subscribe to
|
|
let topics = vec![
|
|
GossipTopic::BeaconBlock,
|
|
GossipTopic::BeaconAttestation,
|
|
GossipTopic::VoluntaryExit,
|
|
GossipTopic::ProposerSlashing,
|
|
GossipTopic::AttesterSlashing,
|
|
];
|
|
|
|
// The function used to generate a gossipsub message id
|
|
// We use base64(SHA256(data)) for content addressing
|
|
let gossip_message_id = |message: &GossipsubMessage| {
|
|
MessageId(base64::encode_config(
|
|
&Sha256::digest(&message.data),
|
|
base64::URL_SAFE,
|
|
))
|
|
};
|
|
|
|
Config {
|
|
network_dir,
|
|
listen_address: "127.0.0.1".parse().expect("valid ip address"),
|
|
libp2p_port: 9000,
|
|
discovery_address: None,
|
|
discovery_port: 9000,
|
|
max_peers: 10,
|
|
secret_key_hex: None,
|
|
// Note: The topics by default are sent as plain strings. Hashes are an optional
|
|
// parameter.
|
|
gs_config: GossipsubConfigBuilder::new()
|
|
.max_transmit_size(1_048_576)
|
|
.heartbeat_interval(Duration::from_secs(20)) // TODO: Reduce for mainnet
|
|
.manual_propagation() // require validation before propagation
|
|
.no_source_id()
|
|
.message_id_fn(gossip_message_id)
|
|
.build(),
|
|
boot_nodes: vec![],
|
|
libp2p_nodes: vec![],
|
|
client_version: version::version(),
|
|
topics,
|
|
propagation_percentage: None,
|
|
}
|
|
}
|
|
}
|