From ea542c8f2dee769827b373b9456fdbfb96cdce43 Mon Sep 17 00:00:00 2001
From: adz <adzialocha@users.noreply.github.com>
Date: Wed, 26 Jun 2024 22:50:20 +0200
Subject: [PATCH] Expose NodeEvent to public API (#643)

* Expose NodeEvent to public API

* Add entry to CHANGELOG.md
---
 CHANGELOG.md             | 4 ++++
 aquadoggo/src/api/api.rs | 4 ++++
 aquadoggo/src/lib.rs     | 2 +-
 3 files changed, 9 insertions(+), 1 deletion(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 959287223..9dabaf22f 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+
+- Expose NodeEvent to public API [#643](https://github.com/p2panda/aquadoggo/pull/643)
+
 ## [0.8.0]
 
 ### Added
diff --git a/aquadoggo/src/api/api.rs b/aquadoggo/src/api/api.rs
index 5e697ac2a..d5bced544 100644
--- a/aquadoggo/src/api/api.rs
+++ b/aquadoggo/src/api/api.rs
@@ -7,9 +7,13 @@ use crate::api::{migrate, LockFile};
 use crate::bus::{ServiceMessage, ServiceSender};
 use crate::context::Context;
 
+/// Node events which can be interesting for clients, for example when peers connect or disconnect.
 #[derive(Debug, Clone)]
 pub enum NodeEvent {
+    /// A peer connected to our node. This can be a direct or relayed connection.
     PeerConnected,
+
+    /// A peer disconnected from our node.
     PeerDisconnected,
 }
 
diff --git a/aquadoggo/src/lib.rs b/aquadoggo/src/lib.rs
index 8452e926b..969123de6 100644
--- a/aquadoggo/src/lib.rs
+++ b/aquadoggo/src/lib.rs
@@ -34,7 +34,7 @@ mod tests;
 
 use log::{info, log_enabled, Level};
 
-pub use crate::api::{ConfigFile, LockFile};
+pub use crate::api::{ConfigFile, LockFile, NodeEvent};
 pub use crate::config::{AllowList, Configuration};
 pub use crate::network::{NetworkConfiguration, Transport};
 pub use node::Node;