feat(kad): add refresh_interval config used to poll bootstrap

Cargo.toml

@@ -82,7 +82,7 @@ libp2p-floodsub = { version = "0.44.0", path = "protocols/floodsub" }
 libp2p-gossipsub = { version = "0.46.0", path = "protocols/gossipsub" }
 libp2p-identify = { version = "0.44.0", path = "protocols/identify" }
 libp2p-identity = { version = "0.2.7" }
-libp2p-kad = { version = "0.45.1", path = "protocols/kad" }
+libp2p-kad = { version = "0.45.2", path = "protocols/kad" }
 libp2p-mdns = { version = "0.45.0", path = "protocols/mdns" }
 libp2p-memory-connection-limits = { version = "0.2.0", path = "misc/memory-connection-limits" }
 libp2p-metrics = { version = "0.14.1", path = "misc/metrics" }
@@ -97,7 +97,7 @@ libp2p-quic = { version = "0.10.1", path = "transports/quic" }
 libp2p-relay = { version = "0.17.0", path = "protocols/relay" }
 libp2p-rendezvous = { version = "0.14.0", path = "protocols/rendezvous" }
 libp2p-request-response = { version = "0.26.0", path = "protocols/request-response" }
-libp2p-server = { version = "0.12.4", path = "misc/server" }
+libp2p-server = { version = "0.12.5", path = "misc/server" }
 libp2p-swarm = { version = "0.44.0", path = "swarm" }
 libp2p-swarm-derive = { version = "=0.34.0", path = "swarm-derive" } # `libp2p-swarm-derive` may not be compatible with different `libp2p-swarm` non-breaking releases. E.g. `libp2p-swarm` might introduce a new enum variant `FromSwarm` (which is `#[non-exhaustive]`) in a non-breaking release. Older versions of `libp2p-swarm-derive` would not forward this enum variant within the `NetworkBehaviour` hierarchy. Thus the version pinning is required.
 libp2p-swarm-test = { version = "0.3.0", path = "swarm-test" }

misc/server/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.12.5
+### Changed
+
+- Use `Behaviour::poll` to call `Behaviour::bootstrap` for Kademlia protocol.
+  See [PR 4838](https://github.com/libp2p/rust-libp2p/pull/4838).
+
 ## 0.12.4
 
 ### Added

misc/server/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "libp2p-server"
-version = "0.12.4"
+version = "0.12.5"
 authors = ["Max Inden <mail@max-inden.de>"]
 edition = "2021"
 repository = "https://github.com/libp2p/rust-libp2p"

misc/server/src/main.rs

@@ -1,7 +1,6 @@
 use base64::Engine;
 use clap::Parser;
 use futures::stream::StreamExt;
-use futures_timer::Delay;
 use libp2p::identity;
 use libp2p::identity::PeerId;
 use libp2p::kad;
@@ -14,17 +13,13 @@ use prometheus_client::registry::Registry;
 use std::error::Error;
 use std::path::PathBuf;
 use std::str::FromStr;
-use std::task::Poll;
-use std::time::Duration;
 use tracing_subscriber::EnvFilter;
 use zeroize::Zeroizing;
 
 mod behaviour;
 mod config;
 mod http_service;
 
-const BOOTSTRAP_INTERVAL: Duration = Duration::from_secs(5 * 60);
-
 #[derive(Debug, Parser)]
 #[clap(name = "libp2p server", about = "A rust-libp2p server binary.")]
 struct Opts {
@@ -125,17 +120,8 @@ async fn main() -> Result<(), Box<dyn Error>> {
         }
     });
 
-    let mut bootstrap_timer = Delay::new(BOOTSTRAP_INTERVAL);
-
     loop {
-        if let Poll::Ready(()) = futures::poll!(&mut bootstrap_timer) {
-            bootstrap_timer.reset(BOOTSTRAP_INTERVAL);
-            let _ = swarm
-                .behaviour_mut()
-                .kademlia
-                .as_mut()
-                .map(|k| k.bootstrap());
-        }
+        let _ = swarm.behaviour_mut().kademlia.as_mut().map(|k| k.poll());
 
         let event = swarm.next().await.expect("Swarm not to terminate.");
         metrics.record(&event);

protocols/kad/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.45.2
+
+- Add `refresh_interval` config and `Behaviour::poll` function used to poll `Behaviour::boostrap`
+  See [PR 4838](https://github.com/libp2p/rust-libp2p/pull/4838)
+
 ## 0.45.1
 
 - Fix a bug where calling `Behaviour::remove_address` with an address not in the peer's bucket would remove the peer from the routing table if the bucket has only one address left.

protocols/kad/Cargo.toml

@@ -3,7 +3,7 @@ name = "libp2p-kad"
 edition = "2021"
 rust-version = { workspace = true }
 description = "Kademlia protocol for libp2p"
-version = "0.45.1"
+version = "0.45.2"
 authors = ["Parity Technologies <admin@parity.io>"]
 license = "MIT"
 repository = "https://github.com/libp2p/rust-libp2p"

protocols/kad/src/behaviour.rs

@@ -35,6 +35,7 @@ use crate::record::{
 };
 use crate::K_VALUE;
 use fnv::{FnvHashMap, FnvHashSet};
+use futures_timer::Delay;
 use instant::Instant;
 use libp2p_core::{ConnectedPoint, Endpoint, Multiaddr};
 use libp2p_identity::PeerId;
@@ -116,6 +117,9 @@ pub struct Behaviour<TStore> {
 
     /// The record storage.
     store: TStore,
+
+    /// The interval used by [`Behaviour::poll`] to call [`Behaviour::bootstrap`].
+    refresh_interval: Option<Duration>,
 }
 
 /// The configurable strategies for the insertion of peers
@@ -181,6 +185,7 @@ pub struct Config {
     provider_publication_interval: Option<Duration>,
     kbucket_inserts: BucketInserts,
     caching: Caching,
+    refresh_interval: Option<Duration>,
 }
 
 impl Default for Config {
@@ -197,6 +202,7 @@ impl Default for Config {
             provider_record_ttl: Some(Duration::from_secs(24 * 60 * 60)),
             kbucket_inserts: BucketInserts::OnConnected,
             caching: Caching::Enabled { max_peers: 1 },
+            refresh_interval: Some(Duration::from_secs(5 * 60)),
         }
     }
 }
@@ -391,6 +397,14 @@ impl Config {
         self.caching = c;
         self
     }
+
+    /// Sets the interval on which [`Behaviour::bootstrap`] is called from [`Behaviour::poll`]
+    ///
+    /// `None` means that [`Behaviour::bootstrap`] is not called from [`Behaviour::poll`]
+    pub fn set_refresh_interval(&mut self, interval: Option<Duration>) -> &mut Self {
+        self.refresh_interval = interval;
+        self
+    }
 }
 
 impl<TStore> Behaviour<TStore>
@@ -448,6 +462,7 @@ where
             mode: Mode::Client,
             auto_mode: true,
             no_events_waker: None,
+            refresh_interval: config.refresh_interval,
         }
     }
 
@@ -1005,6 +1020,24 @@ where
         }
     }
 
+    /// Asynchronously polls the Kademlia behavior, triggering [`Behaviour::bootstrap`] if necessary.
+    ///
+    /// This function checks the refresh interval and, if ready, resets the timer and
+    /// triggers the bootstrap operation. It returns a `Result<(), NoKnownPeers>` where
+    /// Ok(()) indicates success, and Err(NoKnownPeers) is returned if there are no known peers
+    /// during the bootstrap operation. See [`Behaviour::bootstrap`] for more details.
+    pub async fn poll(&mut self) -> Result<(), NoKnownPeers> {
+        if let Some(refresh_interval) = &mut self.refresh_interval {
+            let mut bootstrap_timer = Delay::new(*refresh_interval);
+            if let Poll::Ready(()) = futures::poll!(&mut bootstrap_timer) {
+                bootstrap_timer.reset(*refresh_interval);
+                self.bootstrap()?;
+            };
+        }
+
+        Ok(())
+    }
+
     fn reconfigure_mode(&mut self) {
         if self.connections.is_empty() {
             return;