[WIP] PubSub and FloodSub development (#133)

* Add notifee interface * Add notify function to network interface * Implement notify feature * Add tests for notify * Make notifee functions all async * Fix linting issue * Fix linting issue * Scaffold pubsub router interface * Scaffold pubsub directory * Store peer_id in muxed connection * Implement pubsub notifee * Remove outdated files * Implement pubsub first attempt * Prepare pubsub for floodsub * Add mplex conn to net stream and add conn in notify tests * Implement floodsub * Use NetStream in generic protocol handler * Debugging async issues * Modify test to perform proper assert. Test passes * Remove callbacks. Reduce sleep time * Add simple three node test * Clean up code. Add message classes * Add test for two topics * Add conn to net stream and conn tests * Refactor test setup to remove duplicate code * Fix linting issues * Fix linting issue * Fix linting issue * Fix outstanding unrelated lint issue in multiselect_client * Add connect function * Remove debug prints * Remove debug prints from floodsub * Use MessageTalk in place of direct message breakdown * Remove extra prints * Remove outdated function * Add message to queues for all topics in message * Debugging * Add message self delivery * Increase read timeout to 5 to get pubsub tests passing * Refactor testing helper func. Add tests * Add tests and increase timeout to get tests passing * Add dummy account demo scaffolding * Attempt to use threads. Test fails * Implement basic dummy node tests using threads * Add generic testing function * Add simple seven node tree test * Add more complex seven node tree tests * Add five node ring tests * Remove unnecessary get_message_type func * Add documentation to classes * Add message id to messages * Add documentation to test helper func * Add docs to dummy account node helper func * Add more docs to dummy account node test helper func * fixed linting errors in floodsub * small notify bugfix * move pubsub into libp2p * fixed pubsub linting * fixing pubsub test failures * linting
2025-12-31 20:36:24 +00:00 · 2019-03-23 13:52:02 -04:00
parent 6c4bbd1e85
commit 57077cd3b4
14 changed files with 1474 additions and 11 deletions
--- a/libp2p/pubsub/pubsub_router_interface.py
+++ b/libp2p/pubsub/pubsub_router_interface.py
@ -0,0 +1,64 @@
+from abc import ABC, abstractmethod
+
+class IPubsubRouter(ABC):
+
+    @abstractmethod
+    def get_protocols(self):
+        """
+        :return: the list of protocols supported by the router
+        """
+
+    @abstractmethod
+    def attach(self, pubsub):
+        """
+        Attach is invoked by the PubSub constructor to attach the router to a
+        freshly initialized PubSub instance.
+        :param pubsub: pubsub instance to attach to
+        """
+
+    @abstractmethod
+    def add_peer(self, peer_id, protocol_id):
+        """
+        Notifies the router that a new peer has been connected
+        :param peer_id: id of peer to add
+        """
+
+    @abstractmethod
+    def remove_peer(self, peer_id):
+        """
+        Notifies the router that a peer has been disconnected
+        :param peer_id: id of peer to remove
+        """
+
+    @abstractmethod
+    def handle_rpc(self, rpc):
+        """
+        Invoked to process control messages in the RPC envelope.
+        It is invoked after subscriptions and payload messages have been processed
+        :param rpc: rpc message
+        """
+
+    @abstractmethod
+    def publish(self, sender_peer_id, message):
+        """
+        Invoked to forward a new message that has been validated
+        :param sender_peer_id: peer_id of message sender
+        :param message: message to forward
+        """
+
+    @abstractmethod
+    def join(self, topic):
+        """
+        Join notifies the router that we want to receive and
+        forward messages in a topic. It is invoked after the
+        subscription announcement
+        :param topic: topic to join
+        """
+
+    @abstractmethod
+    def leave(self, topic):
+        """
+        Leave notifies the router that we are no longer interested in a topic.
+        It is invoked after the unsubscription announcement.
+        :param topic: topic to leave
+        """