=
RwLock::new(crate::PermitBanList::default());
}
-mod test;
+pub(crate) mod test;
/// Events that can be produced by the `Discv5` event stream.
#[derive(Debug)]
-pub enum Discv5Event {
+pub enum Event {
/// A node has been discovered from a FINDNODES request.
///
/// The ENR of the node is returned. Various properties can be derived from the ENR.
@@ -71,8 +77,11 @@ pub enum Discv5Event {
/// The main Discv5 Service struct. This provides the user-level API for performing queries and
/// interacting with the underlying service.
-pub struct Discv5 {
- config: Discv5Config,
+pub struct Discv5
+where
+ P: ProtocolIdentity,
+{
+ config: Config,
/// The channel to make requests from the main service.
service_channel: Option>,
/// The exit channel to shutdown the underlying service.
@@ -83,13 +92,17 @@ pub struct Discv5 {
local_enr: Arc>,
/// The key associated with the local ENR, required for updating the local ENR.
enr_key: Arc>,
+ // Type of socket we are using
+ ip_mode: IpMode,
+ /// Phantom for the protocol id.
+ _phantom: PhantomData,
}
-impl Discv5 {
+impl Discv5 {
pub fn new(
local_enr: Enr,
enr_key: CombinedKey,
- mut config: Discv5Config,
+ mut config: Config,
) -> Result {
// ensure the keypair matches the one that signed the enr.
if local_enr.public_key() != enr_key.public() {
@@ -126,6 +139,8 @@ impl Discv5 {
// Update the PermitBan list based on initial configuration
*PERMIT_BAN_LIST.write() = config.permit_ban_list.clone();
+ let ip_mode = IpMode::new_from_listen_config(&config.listen_config);
+
Ok(Discv5 {
config,
service_channel: None,
@@ -133,23 +148,24 @@ impl Discv5 {
kbuckets,
local_enr,
enr_key,
+ ip_mode,
+ _phantom: Default::default(),
})
}
/// Starts the required tasks and begins listening on a given UDP SocketAddr.
- pub async fn start(&mut self, listen_socket: SocketAddr) -> Result<(), Discv5Error> {
+ pub async fn start(&mut self) -> Result<(), Error> {
if self.service_channel.is_some() {
warn!("Service is already started");
- return Err(Discv5Error::ServiceAlreadyStarted);
+ return Err(Error::ServiceAlreadyStarted);
}
// create the main service
- let (service_exit, service_channel) = Service::spawn(
+ let (service_exit, service_channel) = Service::spawn::(
self.local_enr.clone(),
self.enr_key.clone(),
self.kbuckets.clone(),
self.config.clone(),
- listen_socket,
)
.await?;
self.service_exit = Some(service_exit);
@@ -178,7 +194,7 @@ impl Discv5 {
/// them upfront.
pub fn add_enr(&self, enr: Enr) -> Result<(), &'static str> {
// only add ENR's that have a valid udp socket.
- if self.config.ip_mode.get_contactable_addr(&enr).is_none() {
+ if self.ip_mode.get_contactable_addr(&enr).is_none() {
warn!("ENR attempted to be added without an UDP socket compatible with configured IpMode has been ignored.");
return Err("ENR has no compatible UDP socket to connect to");
}
@@ -285,6 +301,13 @@ impl Discv5 {
self.local_enr.read().clone()
}
+ /// Identical to `Discv5::local_enr` except that this exposes the `Arc` itself.
+ ///
+ /// This is useful for synchronising views of the local ENR outside of `Discv5`.
+ pub fn external_enr(&self) -> Arc> {
+ self.local_enr.clone()
+ }
+
/// Returns the routing table of the discv5 service
pub fn kbuckets(&self) -> KBucketsTable {
self.kbuckets.read().clone()
@@ -300,6 +323,31 @@ impl Discv5 {
None
}
+ /// Sends a PING request to a node.
+ pub fn send_ping(
+ &self,
+ enr: Enr,
+ ) -> impl Future