[EXC-1305] add auto re connection and re subscription logic to sockets (#77)

Author: NidaKarimAli

examples/10.sockets_read_only_client.py renamed to examples/10.1.socket_readonly.py

@@ -19,26 +19,36 @@ async def main():
   readOnlyclient = FireflyClient(True, Networks[TEST_NETWORK])
   await readOnlyclient.init(True,response)
 
+  
+  async def my_callback():
+      print("Subscribing To Rooms")
+       # subscribe to global event updates for BTC market 
+      status =  await readOnlyclient.socket.subscribe_global_updates_by_symbol(MARKET_SYMBOLS.BTC)
+      print("Subscribed to global BTC events: {}".format(status))
+
+      # subscribe to local user events
+      status =  await readOnlyclient.socket.subscribe_user_update_by_token()
+      print("Subscribed to user events: {}".format(status))
+    
+      # triggered when order book updates
+      print("Listening to exchange health updates")
+      await readOnlyclient.socket.listen(SOCKET_EVENTS.EXCHANGE_HEALTH.value, callback)
+
+      # triggered when status of any user order updates
+      print("Listening to user order updates")
+      await readOnlyclient.socket.listen(SOCKET_EVENTS.ORDER_UPDATE.value, callback)
+
+
+ 
+  await readOnlyclient.socket.listen("connect",my_callback)
+  
+ 
+
   # must open socket before subscribing
   print("Making socket connection to firefly exchange")
   await readOnlyclient.socket.open()
 
-  # subscribe to global event updates for BTC market 
-  status = await readOnlyclient.socket.subscribe_global_updates_by_symbol(MARKET_SYMBOLS.BTC)
-  print("Subscribed to global BTC events: {}".format(status))
-
-  # subscribe to local user events
-  status = await readOnlyclient.socket.subscribe_user_update_by_token()
-  print("Subscribed to user events: {}".format(status))
-
-  # triggered when order book updates
-  print("Listening to exchange health updates")
-  await readOnlyclient.socket.listen(SOCKET_EVENTS.EXCHANGE_HEALTH.value, callback)
-
-  # triggered when status of any user order updates
-  print("Listening to user order updates")
-  await readOnlyclient.socket.listen(SOCKET_EVENTS.ORDER_UPDATE.value, callback)
-
+ 
   # SOCKET_EVENTS contains all events that can be listened to
 
   # logs event name and data for all markets and users that are subscribed.
@@ -49,19 +59,20 @@ async def main():
   while not event_received and time.time() < end_time:
     time.sleep(1)
 
-  # unsubscribe from global events
+  # # unsubscribe from global events
   status = await readOnlyclient.socket.unsubscribe_global_updates_by_symbol(MARKET_SYMBOLS.BTC)
   print("Unsubscribed from global BTC events: {}".format(status))
 
   status = await readOnlyclient.socket.unsubscribe_user_update_by_token()
   print("Unsubscribed from user events: {}".format(status))
 
 
-  # close socket connection
+  # # close socket connection
   print("Closing sockets!")
   await readOnlyclient.socket.close()
 
-  await client.close_connections()
+  await readOnlyclient.apis.close_session() 
+
 
 
 if __name__ == "__main__":

examples/10.sockets.py

@@ -16,26 +16,36 @@ async def main():
   client = FireflyClient(True, Networks[TEST_NETWORK], TEST_ACCT_KEY)
   await client.init(True)
 
+  
+  async def my_callback():
+      print("Subscribing To Rooms")
+       # subscribe to global event updates for BTC market 
+      status =  await client.socket.subscribe_global_updates_by_symbol(MARKET_SYMBOLS.BTC)
+      print("Subscribed to global BTC events: {}".format(status))
+
+      # subscribe to local user events
+      status =  await client.socket.subscribe_user_update_by_token()
+      print("Subscribed to user events: {}".format(status))
+    
+      # triggered when order book updates
+      print("Listening to exchange health updates")
+      await client.socket.listen(SOCKET_EVENTS.EXCHANGE_HEALTH.value, callback)
+
+      # triggered when status of any user order updates
+      print("Listening to user order updates")
+      await client.socket.listen(SOCKET_EVENTS.ORDER_UPDATE.value, callback)
+
+
+ 
+  await client.socket.listen("connect",my_callback)
+  
+ 
+
   # must open socket before subscribing
   print("Making socket connection to firefly exchange")
   await client.socket.open()
 
-  # subscribe to global event updates for BTC market 
-  status = await client.socket.subscribe_global_updates_by_symbol(MARKET_SYMBOLS.BTC)
-  print("Subscribed to global BTC events: {}".format(status))
-
-  # subscribe to local user events
-  status = await client.socket.subscribe_user_update_by_token()
-  print("Subscribed to user events: {}".format(status))
-
-  # triggered when order book updates
-  print("Listening to exchange health updates")
-  await client.socket.listen(SOCKET_EVENTS.EXCHANGE_HEALTH.value, callback)
-
-  # triggered when status of any user order updates
-  print("Listening to user order updates")
-  await client.socket.listen(SOCKET_EVENTS.ORDER_UPDATE.value, callback)
-
+ 
   # SOCKET_EVENTS contains all events that can be listened to
 
   # logs event name and data for all markets and users that are subscribed.
@@ -46,19 +56,19 @@ async def main():
   while not event_received and time.time() < end_time:
     time.sleep(1)
 
-  # unsubscribe from global events
+  # # unsubscribe from global events
   status = await client.socket.unsubscribe_global_updates_by_symbol(MARKET_SYMBOLS.BTC)
   print("Unsubscribed from global BTC events: {}".format(status))
 
   status = await client.socket.unsubscribe_user_update_by_token()
   print("Unsubscribed from user events: {}".format(status))
 
 
-  # close socket connection
+  # # close socket connection
   print("Closing sockets!")
   await client.socket.close()
 
-  await client.close_connections()
+  await client.apis.close_session() 
 
 
 

examples/17.get_orders_readonly.py renamed to examples/17.1.get_orders_readonly.py

@@ -1,6 +1,6 @@
 [project]
 name = "firefly_exchange_client"
-version = "0.5.0"
+version = "0.6.0"
 description = "Library to interact with firefly exchange protocol including its off-chain api-gateway and on-chain contracts"
 readme = "README.md"
 requires-python = ">=3.8"

pyproject.toml

@@ -1,6 +1,7 @@
 import socketio
+import time
 from .enumerations import MARKET_SYMBOLS, SOCKET_EVENTS
-
+import asyncio
 sio = socketio.Client()
 
 
@@ -73,6 +74,24 @@ def listener(event, data):
         except:
             pass
         return
+        
+    @sio.event
+    def connect():
+        print("Connected To Socket Server")
+        # add 10 seconds sleep to allow connection to be established before callbacks for connections are executed
+        if 'connect' in Sockets.callbacks:
+            # Execute the callback using asyncio.run() if available
+            time.sleep(10)
+            asyncio.run(Sockets.callbacks['connect']())
+        
+
+    @sio.event
+    def disconnect():
+        print('Disconnected From Socket Server')
+        if 'disconnect' in Sockets.callbacks:
+            # Execute the callback using asyncio.run() if available
+            asyncio.run(Sockets.callbacks['disconnect']())
+
 
     async def listen(self, event, callback):
         """