Add websockets support

.github/workflows/main.yml

@@ -70,6 +70,7 @@ jobs:
             'integration/test_async_token_client.py',
             'integration/test_http_client.py',
             'integration/test_token_client.py',
+            'integration/test_websockets.py',
             'unit'
           ]
 

.vscode/settings.json

@@ -16,4 +16,5 @@
   "python.linting.pydocstyleEnabled": true,
   "editor.formatOnSave": true,
   "python.languageServer": "Jedi",
+  "autoDocstring.docstringFormat": "sphinx",
 }

README.md

@@ -59,6 +59,36 @@ async def main():
 asyncio.run(main())
 ```
 
+### Websockets Client
+
+```py
+    import asyncio
+    from asyncstdlib import enumerate
+    from solana.rpc.websocket_api import connect
+
+    async def main():
+        async with connect("ws://api.devnet.solana.com") as websocket:
+            await websocket.logs_subscribe()
+            first_resp = await websocket.recv()
+            subscription_id = first_resp.result
+            next_resp = await websocket.recv()
+            print(next_resp)
+            await websocket.logs_unsubscribe(subscription_id)
+
+        # Alternatively, use the client as an infinite asynchronous iterator:
+        async with connect("ws://api.devnet.solana.com") as websocket:
+            await websocket.logs_subscribe()
+            first_resp = await websocket.recv()
+            subscription_id = first_resp.result
+            async for idx, msg in enumerate(websocket):
+                if idx == 3:
+                    break
+                print(msg)
+            await websocket.logs_unsubscribe(subscription_id)
+
+    asyncio.run(main())
+```
+
 ## Development
 
 ### Setup

docs/api.rst

@@ -15,6 +15,12 @@ Async API Client
    .. autoclass:: solana.rpc.async_api.AsyncClient
         :members:
 
+Websockets Client
+=================
+
+.. automodule:: solana.rpc.websocket_api
+    :members:
+
 Commitment
 ==========
 

pyproject.toml

@@ -31,6 +31,10 @@ requests = "^2.24"
 typing-extensions = "^3.10.0"
 cachetools = "^4.2.2"
 types-cachetools = "^4.2.4"
+jsonrpcclient = "^4.0.1"
+websockets = "^10.1"
+jsonrpcserver = "^5.0.4"
+apischema = "^0.16.1"
 
 [tool.poetry.dev-dependencies]
 black = "^21.9b0"
@@ -47,6 +51,7 @@ types-requests = "^2.25.11"
 pytest-asyncio = "^0.16.0"
 pytest-cov = "^3.0.0"
 sphinx-rtd-theme = "^1.0.0"
+asyncstdlib = "^3.10.2"
 
 
 [build-system]

src/solana/__init__.py

@@ -48,11 +48,47 @@ async def main():
 
     asyncio.run(main())
 
+
+Websockets Client:
+
+.. note::
+    The websockets code in solana-py is mostly just wrapping around the `websockets <https://websockets.readthedocs.io/en/stable/index.html>`_ library.
+
+.. highlight:: py
+.. code-block:: py
+
+    import asyncio
+    from asyncstdlib import enumerate
+    from solana.rpc.websocket_api import connect
+
+    async def main():
+        async with connect("ws://api.devnet.solana.com") as websocket:
+            await websocket.logs_subscribe()
+            first_resp = await websocket.recv()
+            subscription_id = first_resp.result
+            next_resp = await websocket.recv()
+            print(next_resp)
+            await websocket.logs_unsubscribe(subscription_id)
+
+        # Alternatively, use the client as an infinite asynchronous iterator:
+        async with connect("ws://api.devnet.solana.com") as websocket:
+            await websocket.logs_subscribe()
+            first_resp = await websocket.recv()
+            subscription_id = first_resp.result
+            async for idx, msg in enumerate(websocket):
+                if idx == 3:
+                    break
+                print(msg)
+            await websocket.logs_unsubscribe(subscription_id)
+
+    asyncio.run(main())
+
 Additional Resources:
 
 Check out `anchorpy <https://kevinheavey.github.io/anchorpy/>`_, a Python client for `Anchor
 <https://project-serum.github.io/anchor/getting-started/introduction.html>`_ based programs on Solana.
 
+
 """  # pylint: disable=line-too-long # noqa: E501
 import sys
 

src/solana/publickey.py

@@ -27,7 +27,7 @@ class PublicKey:
     LENGTH = 32
     """Constant for standard length of a public key."""
 
-    def __init__(self, value: Union[bytearray, bytes, int, str, List[int]]) -> None:
+    def __init__(self, value: Union[bytearray, bytes, int, str, List[int]]):
         """Init PublicKey object."""
         self._key: Optional[bytes] = None
         if isinstance(value, str):