move gossipsub into a separate crate

Author: jxs

Cargo.lock

@@ -8,6 +8,7 @@ members = [
     "beacon_node/builder_client",
     "beacon_node/client",
     "beacon_node/eth1",
+    "beacon_node/gossipsub",
     "beacon_node/lighthouse_network",
     "beacon_node/execution_layer",
     "beacon_node/http_api",

Cargo.toml

@@ -0,0 +1,53 @@
+[package]
+name = "gossipsub"
+edition = "2021"
+description = "Sigma prime's version of Gossipsub protocol for libp2p"
+version = "0.5.0"
+authors = ["Age Manning <[email protected]>"]
+license = "MIT"
+repository = "https://github.com/sigp/lighthouse/"
+keywords = ["peer-to-peer", "libp2p", "networking"]
+categories = ["network-programming", "asynchronous"]
+
+[features]
+wasm-bindgen = ["getrandom/js", "instant/wasm-bindgen"]
+
+[dependencies]
+async-channel = { workspace = true }
+asynchronous-codec = "0.7.0"
+base64 = "0.21.7"
+byteorder = "1.5.0"
+bytes = "1.5"
+either = "1.9"
+fnv = "1.0.7"
+futures = "0.3.30"
+futures-ticker = "0.0.3"
+futures-timer = "3.0.2"
+getrandom = "0.2.12"
+hex_fmt = "0.3.0"
+instant = "0.1.12"
+libp2p = { version = "0.53", default-features = false, features = ["identify", "yamux", "noise", "dns", "tcp", "tokio", "plaintext", "secp256k1", "macros", "ecdsa", "metrics", "quic", "upnp"]}
+quick-protobuf = "0.8"
+quick-protobuf-codec = "0.3"
+rand = "0.8"
+regex = "1.10.3"
+serde = { version = "1", optional = true, features = ["derive"] }
+sha2 = "0.10.8"
+smallvec = "1.13.1"
+tracing = "0.1.37"
+void = "1.0.2"
+
+prometheus-client = "0.22.0"
+
+[dev-dependencies]
+async-std = { version = "1.6.3", features = ["unstable"] }
+hex = "0.4.2"
+quickcheck = { workspace = true }
+tracing-subscriber = { version = "0.3", features = ["env-filter"] }
+
+# Passing arguments to the docsrs builder in order to properly document cfg's.
+# More information: https://docs.rs/about/builds#cross-compiling
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+rustc-args = ["--cfg", "docsrs"]

beacon_node/gossipsub/Cargo.toml

@@ -19,7 +19,7 @@
 // DEALINGS IN THE SOFTWARE.
 
 //! Data structure for efficiently storing known back-off's when pruning peers.
-use crate::gossipsub::topic::TopicHash;
+use crate::topic::TopicHash;
 use instant::Instant;
 use libp2p::identity::PeerId;
 use std::collections::{

beacon_node/lighthouse_network/src/gossipsub/backoff.rs renamed to beacon_node/gossipsub/src/backoff.rs

@@ -57,16 +57,16 @@ use super::time_cache::DuplicateCache;
 use super::topic::{Hasher, Topic, TopicHash};
 use super::transform::{DataTransform, IdentityTransform};
 use super::types::{
-    ControlAction, Message, MessageAcceptance, MessageId, PeerInfo, RawMessage, Subscription,
-    SubscriptionAction,
+    ControlAction, FailedMessages, Message, MessageAcceptance, MessageId, PeerInfo, RawMessage,
+    Subscription, SubscriptionAction,
 };
 use super::types::{Graft, IHave, IWant, PeerConnections, PeerKind, Prune};
 use super::{backoff::BackoffStorage, types::RpcSender};
 use super::{
     config::{Config, ValidationMode},
     types::RpcOut,
 };
-use super::{FailedMessages, PublishError, SubscriptionError, TopicScoreParams, ValidationError};
+use super::{PublishError, SubscriptionError, TopicScoreParams, ValidationError};
 use instant::SystemTime;
 use quick_protobuf::{MessageWrite, Writer};
 use std::{cmp::Ordering::Equal, fmt::Debug};

beacon_node/lighthouse_network/src/gossipsub/behaviour.rs renamed to beacon_node/gossipsub/src/behaviour.rs

@@ -21,11 +21,11 @@
 // Collection of tests for the gossipsub network behaviour
 
 use super::*;
-use crate::gossipsub::subscription_filter::WhitelistSubscriptionFilter;
-use crate::gossipsub::transform::{DataTransform, IdentityTransform};
-use crate::gossipsub::types::{RpcOut, RpcReceiver};
-use crate::gossipsub::ValidationError;
-use crate::gossipsub::{
+use crate::subscription_filter::WhitelistSubscriptionFilter;
+use crate::transform::{DataTransform, IdentityTransform};
+use crate::types::{RpcOut, RpcReceiver};
+use crate::ValidationError;
+use crate::{
     config::Config, config::ConfigBuilder, types::Rpc, IdentTopic as Topic, TopicScoreParams,
 };
 use async_std::net::Ipv4Addr;

beacon_node/lighthouse_network/src/gossipsub/behaviour/tests.rs renamed to beacon_node/gossipsub/src/behaviour/tests.rs

@@ -36,7 +36,7 @@ pub enum ValidationMode {
     /// be present as well as the sequence number. All messages must have valid signatures.
     ///
     /// NOTE: This setting will reject messages from nodes using
-    /// [`crate::gossipsub::behaviour::MessageAuthenticity::Anonymous`] and all messages that do not have
+    /// [`crate::behaviour::MessageAuthenticity::Anonymous`] and all messages that do not have
     /// signatures.
     Strict,
     /// This setting permits messages that have no author, sequence number or signature. If any of
@@ -195,7 +195,7 @@ impl Config {
 
     /// When set to `true`, prevents automatic forwarding of all received messages. This setting
     /// allows a user to validate the messages before propagating them to their peers. If set to
-    /// true, the user must manually call [`crate::gossipsub::Behaviour::report_message_validation_result()`]
+    /// true, the user must manually call [`crate::Behaviour::report_message_validation_result()`]
     /// on the behaviour to forward message once validated (default is `false`).
     /// The default is `false`.
     pub fn validate_messages(&self) -> bool {
@@ -611,7 +611,7 @@ impl ConfigBuilder {
 
     /// When set, prevents automatic forwarding of all received messages. This setting
     /// allows a user to validate the messages before propagating them to their peers. If set,
-    /// the user must manually call [`crate::gossipsub::Behaviour::report_message_validation_result()`] on the
+    /// the user must manually call [`crate::Behaviour::report_message_validation_result()`] on the
     /// behaviour to forward a message once validated.
     pub fn validate_messages(&mut self) -> &mut Self {
         self.config.validate_messages = true;
@@ -902,9 +902,9 @@ impl std::fmt::Debug for Config {
 #[cfg(test)]
 mod test {
     use super::*;
-    use crate::gossipsub::topic::IdentityHash;
-    use crate::gossipsub::types::PeerKind;
-    use crate::gossipsub::Topic;
+    use crate::topic::IdentityHash;
+    use crate::types::PeerKind;
+    use crate::Topic;
     use libp2p::core::UpgradeInfo;
     use libp2p::swarm::StreamProtocol;
     use std::collections::hash_map::DefaultHasher;