Expose relays and add connection status listener

Author: riccardobl

examples/ESP32TestNip01Filter/ESP32TestNip01Filter.cpp

@@ -47,7 +47,7 @@ void setup() {
     testNIP01Filter();
 }
 
-void loop() {    
+void loop() {
     for (nostr::NostrPool *pool : pools) {
         pool->loop();
     }
@@ -56,28 +56,28 @@ void loop() {
 nostr::Transport *transport;
 
 void testNIP01Filter() {
-    try{
+    try {
         String relay = RELAY;
         transport = nostr::esp32::ESP32Platform::getTransport();
         nostr::NostrPool *pool = new nostr::NostrPool(transport);
         pools.push_back(pool);
         String subId = pool->subscribeMany(
             {relay},
             {{
-                {"kinds", {"1"}},
-                {"since", {"1626023056"}},
-                {"until", {"1846947856"}},
+                {"kinds", {"1"}}, 
+                {"since", {"1626023056"}}, 
+                {"until", {"1846947856"}}, 
                 {"limit", {"10"}},
                 // Filters defined in NIP01 are automatically converted to the correct type
-                // however this library support non-NIP01 filters as well, but you might need to 
+                // however this library support non-NIP01 filters as well, but you might need to
                 // specify their type manually, if unspecified the code assumes string[]:
                 // eg. {"int newFilter", {"1"}}
                 // eg. {"int[] newFilter2", {"1", "2"}}
                 // eg. {"float newFilter3", {"1.1"}}
                 // eg. {"float[] newFilter4", {"1.1", "2.2"}}
                 // eg. {"string newFilter5", {"hello"}}
             }},
-            [&](const String &subId, nostr::SignedNostrEvent *event) {               
+            [&](const String &subId, nostr::SignedNostrEvent *event) {
                 JsonDocument doc;
                 JsonArray arr = doc["data"].to<JsonArray>();
                 event->toSendableEvent(arr);
@@ -86,6 +86,22 @@ void testNIP01Filter() {
                 Serial.println("Event received: " + json);
             },
             [&](const String &subId, const String &reason) { Serial.println("Subscription closed: " + reason); }, [&](const String &subId) { Serial.println("Subscription EOSE: " + subId); });
+
+        std::vector<nostr::NostrRelay *> *relays = pool->getConnectedRelays();
+        for (nostr::NostrRelay *relay : *relays) {
+            Serial.println("Registering to connection events of: " + relay->getUrl());
+            relay->getConnection()->addConnectionStatusListener([&](const nostr::ConnectionStatus &status) { 
+                String sstatus="UNKNOWN";
+                if(status==nostr::ConnectionStatus::CONNECTED){
+                    sstatus="CONNECTED";
+                }else if(status==nostr::ConnectionStatus::DISCONNECTED){
+                    sstatus="DISCONNECTED";
+                }else if(status==nostr::ConnectionStatus::ERROR){
+                    sstatus = "ERROR";
+                }
+                Serial.println("Connection status changed: " + sstatus); 
+            });
+        }
     } catch (const std::exception &e) {
         Serial.println("Error: " + String(e.what()));
     }

src/NostrPool.cpp

@@ -279,3 +279,7 @@ std::vector<NostrString> NostrPool::getRelays() {
     }
     return urls;
 }
+
+std::vector<NostrRelay *> *NostrPool::getConnectedRelays() {
+    return &this->relays;
+}

src/NostrPool.h

@@ -48,12 +48,15 @@ namespace nostr {
          */
         void send(NostrString message);
         NostrRelay(Connection *conn, NostrString url) : conn(conn), url(url){};
-
+        Connection *getConnection() const { return conn; }
+        NostrString getUrl() const{
+            return url;
+        }
        protected:
-        std::vector<NostrString> messageQueue;
-        Connection *conn;
-        NostrString url;
-        void processQueue();
+         NostrString url;
+         std::vector<NostrString> messageQueue;
+         Connection *conn;
+         void processQueue();
     };
 
     /**
@@ -138,6 +141,7 @@ namespace nostr {
         /**
          * Get all relays that the pool is connected to
          * @return A list of relay URLs
+         * @deprecated Use getConnectedRelays() instead  
          */
         std::vector<NostrString> getRelays();
 
@@ -152,6 +156,13 @@ namespace nostr {
          */
         void close();
 
+  
+        /**
+         * Get all relays that the pool is connected to
+         * @return A list of relays
+         */
+        std::vector<NostrRelay *> *getConnectedRelays();
+
       private:
         NostrNoticeCallback noticeCallback = nullptr;
         long long subs = 0;

src/Transport.h

@@ -5,6 +5,7 @@
 #include <functional>
 
 namespace nostr {
+enum class ConnectionStatus { CONNECTED, DISCONNECTED, ERROR };
 class Connection {
   public:
     virtual void addMessageListener(std::function<void(NostrString)> listener);
@@ -13,17 +14,18 @@ class Connection {
     virtual ~Connection() = default;
     virtual void loop() = 0;
     virtual bool isReady() = 0;
+    virtual void addConnectionStatusListener(std::function<void(ConnectionStatus status)> listener) {};
 };
 class Transport {
   public:
-    virtual void getInvoiceFromLNAddr(NostrString addr, unsigned long long amountMSats, NostrString comment , std::function<void(NostrString)> callback) = 0;
+    virtual void getInvoiceFromLNAddr(NostrString addr, unsigned long long amountMSats, NostrString comment, std::function<void(NostrString)> callback) = 0;
     virtual Connection *connect(NostrString url) = 0;
     virtual ~Transport() = default;
     Transport() = default;
     virtual void disconnect(Connection *conn) = 0;
     virtual bool isReady() = 0;
     virtual void close() = 0;
-    virtual void loop(){};
+    virtual void loop() {};
 };
-} 
+} // namespace nostr
 #endif

src/esp32/ESP32Transport.cpp

@@ -138,9 +138,23 @@ esp32::ESP32Connection::ESP32Connection(ESP32Transport *transport, NostrString u
         switch (type) {
         case WStype_DISCONNECTED:
             Utils::log("ESP32Connection disconnected.");
+            for (auto &listener : connectionListeners) {
+                try {
+                    listener(ConnectionStatus::DISCONNECTED);
+                } catch (std::exception &e) {
+                    Utils::log(e.what());
+                }
+            }
             break;
         case WStype_CONNECTED:
             Utils::log("ESP32Connection connected.");
+            for (auto &listener : connectionListeners) {
+                try {
+                    listener(ConnectionStatus::CONNECTED);
+                } catch (std::exception &e) {
+                    Utils::log(e.what());
+                }
+            }
             break;
         case WStype_TEXT: {
             NostrString message = NostrString_fromChars((char *)payload);
@@ -157,6 +171,13 @@ esp32::ESP32Connection::ESP32Connection(ESP32Transport *transport, NostrString u
         }
         case WStype_ERROR:
             Utils::log("ESP32Connection error.");
+            for (auto &listener : connectionListeners) {
+                try {
+                    listener(ConnectionStatus::ERROR);
+                } catch (std::exception &e) {
+                    Utils::log(e.what());
+                }
+            }
             break;
         default:
             break;
@@ -200,4 +221,8 @@ esp32::ESP32Connection::~ESP32Connection() {
 
 esp32::ESP32Transport::ESP32Transport() {}
 
+void esp32::ESP32Connection::addConnectionStatusListener(std::function<void(ConnectionStatus status)> listener) {
+    connectionListeners.push_back(listener);
+}
+
 #endif

src/esp32/ESP32Transport.h

@@ -24,6 +24,10 @@ class ESP32Connection : public Connection {
     void loop() override;
     bool isReady() override;
     void addMessageListener(std::function<void(NostrString)> listener) override;
+    void addConnectionStatusListener(std::function<void(ConnectionStatus status)> listener) override;
+    WebSocketsClient* getWebsocket(){
+        return &ws;
+    }
     ~ESP32Connection() override;
 
   protected:
@@ -33,6 +37,7 @@ class ESP32Connection : public Connection {
     ESP32Transport *transport;
     WebSocketsClient ws;
     std::vector<std::function<void(NostrString)>> messageListeners;
+    std::vector<std::function<void(ConnectionStatus status)>> connectionListeners;
 };
 class ESP32Transport : public Transport {
   public: