feat: Add Ipfs::{add,remove}_external_address.

CHANGELOG.md

@@ -1,3 +1,6 @@
+# 0.11.20
+- feat: Add Ipfs::{add,remove}_external_address.
+
 # 0.11.19
 - chore: Pin getrandom to 0.2.14 due to libc 0.2.154 being yanked. 
 

Cargo.toml

@@ -7,7 +7,7 @@ name = "rust-ipfs"
 readme = "README.md"
 repository = "https://github.com/dariusc93/rust-ipfs"
 description = "IPFS node implementation"
-version = "0.11.19"
+version = "0.11.20"
 
 [features]
 

src/lib.rs

@@ -380,6 +380,8 @@ enum IpfsEvent {
     PubsubSubscribed(Channel<Vec<String>>),
     AddListeningAddress(Multiaddr, Channel<Multiaddr>),
     RemoveListeningAddress(Multiaddr, Channel<()>),
+    AddExternalAddress(Multiaddr, Channel<()>),
+    RemoveExternalAddress(Multiaddr, Channel<()>),
     Bootstrap(Channel<ReceiverChannel<KadResult>>),
     AddPeer(PeerId, Multiaddr, Channel<()>),
     RemovePeer(PeerId, Option<Multiaddr>, Channel<bool>),
@@ -1786,6 +1788,39 @@ impl Ipfs {
         .await
     }
 
+    /// Add a given multiaddr as a external address to indenticate how our node can be reached.
+    /// Note: We will not perform checks
+    pub async fn add_external_address(&self, addr: Multiaddr) -> Result<(), Error> {
+        async move {
+            let (tx, rx) = oneshot_channel();
+
+            self.to_task
+                .clone()
+                .send(IpfsEvent::AddExternalAddress(addr, tx))
+                .await?;
+
+            rx.await?
+        }
+        .instrument(self.span.clone())
+        .await
+    }
+
+    /// Removes a previously added external address.
+    pub async fn remove_external_address(&self, addr: Multiaddr) -> Result<(), Error> {
+        async move {
+            let (tx, rx) = oneshot_channel();
+
+            self.to_task
+                .clone()
+                .send(IpfsEvent::RemoveExternalAddress(addr, tx))
+                .await?;
+
+            rx.await?
+        }
+        .instrument(self.span.clone())
+        .await
+    }
+
     /// Obtain the addresses associated with the given `PeerId`; they are first searched for locally
     /// and the DHT is used as a fallback: a `Kademlia::get_closest_peers(peer_id)` query is run and
     /// when it's finished, the newly added DHT records are checked for the existence of the desired

src/task.rs

@@ -1241,6 +1241,14 @@ impl<C: NetworkBehaviour<ToSwarm = void::Void>> IpfsTask<C> {
                     }
                 }
             }
+            IpfsEvent::AddExternalAddress(addr, ret) => {
+                self.swarm.add_external_address(addr);
+                _ = ret.send(Ok(()))
+            }
+            IpfsEvent::RemoveExternalAddress(addr, ret) => {
+                self.swarm.remove_external_address(&addr);
+                _ = ret.send(Ok(()))
+            }
             IpfsEvent::Bootstrap(ret) => {
                 let Some(kad) = self.swarm.behaviour_mut().kademlia.as_mut() else {
                     let _ = ret.send(Err(anyhow!("kad protocol is disabled")));