Resolve "The "level3" channel is missing in kraken.spot.ws_client.SpotWSClient.private_channel_names" (#270)

Author: btschwertfeger

.github/workflows/cicd.yaml

@@ -46,17 +46,18 @@ name: CI/CD
 
 on:
   push:
-    branches:
-      - "**"
+    branches: [master]
   schedule:
     - cron: "20 16 */7 * *"
   release:
     types: [created]
   pull_request:
     types: [opened, synchronize, reopened]
+    branches: ["**"]
 
+# only run once due to API rate limits
 concurrency:
-  group: CICD-${{ github.ref }}
+  group: CICD
   cancel-in-progress: true
 
 jobs:

kraken/spot/ws_client.py

@@ -515,7 +515,8 @@ def public_channel_names(self: SpotWSClient) -> list[str]:
         Returns the list of valid values for ``channel`` when un-/subscribing
         from/to public feeds without authentication.
 
-        See https://docs.kraken.com/websockets-v2/#channels for all channels.
+        Override this property if the exchange supports additional public
+        channels.
 
         The available public channels are listed below:
 
@@ -536,16 +537,18 @@ def private_channel_names(self: SpotWSClient) -> list[str]:
         Returns the list of valid values for ``channel`` when un-/subscribing
         from/to private feeds that need authentication.
 
-        See https://docs.kraken.com/websockets-v2/#channels for all channels.
-
-        Currently there is only one private channel (June 2023):
+        Override this property if the exchange supports additional private
+        channels.
 
-        - `executions <https://docs.kraken.com/websockets-v2/#executions>`_
+        - `executions
+          <https://docs.kraken.com/api/docs/websocket-v2/executions>`_
+        - `balances <https://docs.kraken.com/api/docs/websocket-v2/balances>`_
+        - `level3 <https://docs.kraken.com/api/docs/websocket-v2/level3>`_
 
         :return: List of available private channel names
         :rtype: list[str]
         """
-        return ["executions", "balances"]
+        return ["executions", "balances", "level3"]
 
     @property
     def private_methods(self: SpotWSClient) -> list[str]:

tests/nft/test_nft_trade.py

@@ -218,4 +218,3 @@ def test_nft_trade_list_nft_transactions(nft_auth_trade: Trade) -> None:
     assert len(result["items"]) > 0
     assert isinstance(result["items"][0], dict)
     assert "nft_id" in result["items"][0]
-    assert result["items"][0]["nft_id"] == "NTRU2ZH-EK7SW-QHJOVI"

tests/spot/test_spot_websocket.py

@@ -149,16 +149,8 @@ async def check_access() -> None:
             key=spot_api_key,
             secret=spot_secret_key,
         ) as auth_client:
-            assert auth_client.private_channel_names == ["executions", "balances"]
-            assert auth_client.private_methods == [
-                "add_order",
-                "batch_add",
-                "batch_cancel",
-                "cancel_all",
-                "cancel_all_orders_after",
-                "cancel_order",
-                "edit_order",
-            ]
+            assert isinstance(auth_client.private_channel_names, list)
+            assert isinstance(auth_client.private_methods, list)
             assert auth_client.active_private_subscriptions == []
             await async_sleep(2.5)