refactor: add docs; polish up

maidsafe · Jan 22, 2025 · 8f7f7c2 · 8f7f7c2
1 parent 3a3446d
commit 8f7f7c2
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 13 deletions.
diff --git a/.github/workflows/merge.yml b/.github/workflows/merge.yml
@@ -727,12 +727,6 @@ jobs:
               echo "EVM_NETWORK has been set to $EVM_NETWORK"
           fi
 
-      # - name: Verify the routing tables of the nodes
-      #   run: cargo test --release -p ant-node --test verify_routing_table -- --nocapture
-      #   env:
-      #     CARGO_TARGET_DIR: ${{ matrix.os == 'windows-latest' && './test-target' || '.' }}
-      #   timeout-minutes: 5
-
       - name: Verify the location of the data on the network
         run: cargo test --release -p ant-node --test verify_data_location -- --nocapture
         env:

diff --git a/ant-bootstrap/src/config.rs b/ant-bootstrap/src/config.rs
@@ -50,6 +50,9 @@ pub struct BootstrapCacheConfig {
 
 impl BootstrapCacheConfig {
     /// Creates a new BootstrapConfig with default settings
+    ///
+    /// When `local` is set to true, a different cache file name is used.
+    /// I.e. the file name will include `_local_` in the name.
     pub fn default_config(local: bool) -> Result<Self> {
         let cache_file_path = if local {
             default_cache_path_local()?

diff --git a/ant-networking/src/event/swarm.rs b/ant-networking/src/event/swarm.rs
@@ -299,23 +299,18 @@ impl SwarmDriver {
                 if address.iter().last() != Some(Protocol::P2p(local_peer_id)) {
                     address.push(Protocol::P2p(local_peer_id));
                 }
-                tracing::info!("========> A");
 
                 // Trigger server mode if we're not a client and we should not add our own address if we're behind
                 // home network.
                 if !self.is_client && !self.is_behind_home_network {
-                    tracing::info!("========> B");
                     if self.local {
-                        tracing::info!("========> C");
                         // all addresses are effectively external here...
                         // this is needed for Kad Mode::Server
                         self.swarm.add_external_address(address.clone());
 
                         // If we are local, add our own address(es) to cache
                         if let Some(bootstrap_cache) = self.bootstrap_cache.as_mut() {
-                            tracing::info!(
-                                "Adding our own address to bootstrap cache for local network"
-                            );
+                            tracing::info!("Adding listen address to bootstrap cache");
 
                             let config = bootstrap_cache.config().clone();
                             let mut old_cache = bootstrap_cache.clone();
@@ -324,7 +319,7 @@ impl SwarmDriver {
                                 self.bootstrap_cache = Some(new);
                                 old_cache.add_addr(address.clone());
 
-                                // save the cache to disk
+                                // Save cache to disk.
                                 crate::time::spawn(async move {
                                     if let Err(err) = old_cache.sync_and_flush_to_disk(true) {
                                         error!("Failed to save bootstrap cache: {err}");