Fix ci / add docs about websocket (#165)

* update ci

* readme changes

* try to fix tests

* fix dialyzer

* fix

* fix dialyzer

* fix dialyzer

* fix test

Author: ayrat555

.github/workflows/ci.yml

@@ -15,17 +15,27 @@ jobs:
       matrix:
         include:
           - pair:
-              elixir: 1.14
-              otp: 24.3
-            lint: lint
+              elixir: 1.14.5
+              otp: 25.3.2
           - pair:
-              elixir: 1.14
-              otp: 25.0
-            lint: lint
+              elixir: 1.15.7
+              otp: 25.3.2
+          - pair:
+              elixir: 1.16.1
+              otp: 25.3.2
           - pair:
-              elixir: 1.15
-              otp: 26.0
+              elixir: 1.14.5
+              otp: 26.2.2
+          - pair:
+              elixir: 1.15.7
+              otp: 26.2.2
+          - pair:
+              elixir: 1.16.1
+              otp: 26.2.2
             lint: lint
+          - pair:
+              elixir: 1.17.3
+              otp: 27.2
 
     runs-on: ubuntu-latest
 

README.md

@@ -36,6 +36,8 @@ end
 
 ## Configuration
 
+### HTTP
+
 In `config/config.exs`, add Ethereum protocol host params to your config file
 
 ```elixir
@@ -55,6 +57,8 @@ config :ethereumex,
 `:pool_timeout` - This timeout is applied when we check out a connection from the pool. Default value is `5_000`.
 `:receive_timeout` - The maximum time to wait for a response before returning an error. Default value is `15_000`
 
+### IPC
+
 If you want to use IPC you will need to set a few things in your config.
 
 First, specify the `:client_type`:
@@ -73,6 +77,15 @@ config :ethereumex,
   ipc_path: "/path/to/ipc"
 ```
 
+### Websocket
+
+For websocket connection, please set `:websocket_url` and `:client_type` as `:webscoket`:
+```elixir
+config :ethereumex,
+  websocket_url: "ws://localhost:8545",
+  client_type: :websocket
+```
+
 If you want to count the number of RPC calls per RPC method or overall,
 you can attach yourself to executed telemetry events.
 There are two events you can attach yourself to:

lib/ethereumex/client/websocket_server.ex

@@ -79,12 +79,12 @@ defmodule Ethereumex.WebsocketServer do
   Starts the WebSocket connection.
 
   ## Options
-    - :url - WebSocket endpoint URL (defaults to Config.rpc_url())
+    - :url - WebSocket endpoint URL (defaults to Config.websocket_url())
     - :name - Process name (defaults to __MODULE__)
   """
   @spec start_link(keyword()) :: {:ok, pid()} | {:error, term()}
   def start_link(opts \\ []) do
-    url = Keyword.get(opts, :url, Config.rpc_url())
+    url = Keyword.get(opts, :url, Config.websocket_url())
     name = Keyword.get(opts, :name, __MODULE__)
 
     WebSockex.start_link(
@@ -102,7 +102,8 @@ defmodule Ethereumex.WebsocketServer do
   Returns `{:ok, result}` on success or `{:error, reason}` on failure.
   Times out after #{@request_timeout}ms.
   """
-  @spec post(String.t()) :: {:ok, term()} | {:error, term()}
+  @spec post(binary()) ::
+          {:ok, term()} | {:error, :invalid_request_format | :timeout | :decoded_error}
   def post(encoded_request) when is_binary(encoded_request) do
     with {:ok, decoded} <- decode_request(encoded_request),
          id <- get_request_id(decoded),
@@ -157,7 +158,7 @@ defmodule Ethereumex.WebsocketServer do
       {:ok, %{"id" => _id} = decoded} -> {:ok, decoded}
       {:ok, decoded} when is_list(decoded) -> {:ok, decoded}
       {:ok, _} -> {:error, :invalid_request_format}
-      error -> error
+      _error -> {:error, :decode_error}
     end
   end
 

lib/ethereumex/config.ex

@@ -43,6 +43,19 @@ defmodule Ethereumex.Config do
     end
   end
 
+  @spec websocket_url() :: binary()
+  def websocket_url() do
+    case Application.get_env(:ethereumex, :websocket_url, "") do
+      url when is_binary(url) and url != "" ->
+        url
+
+      not_a_url ->
+        raise ArgumentError,
+          message:
+            "Please set config variable `config :ethereumex, :websocket_url, \"ws://...\", got `#{not_a_url}`."
+    end
+  end
+
   @spec ipc_path() :: binary()
   def ipc_path() do
     case Application.get_env(:ethereumex, :ipc_path, "") do

test/ethereumex/websocket_client_test.exs

@@ -9,7 +9,7 @@ defmodule Ethereumex.WebsocketClientTest do
 
   setup_all do
     _ = Application.put_env(:ethereumex, :client_type, :websocket)
-    _ = Application.put_env(:ethereumex, :url, @default_url)
+    _ = Application.put_env(:ethereumex, :websocket_url, @default_url)
 
     on_exit(fn ->
       _ = Application.put_env(:ethereumex, :client_type, :http)

test/ethereumex/websocket_server_test.exs

@@ -13,7 +13,7 @@ defmodule Ethereumex.WebsocketServerTest do
 
   setup_all do
     _ = Application.put_env(:ethereumex, :client_type, :websocket)
-    _ = Application.put_env(:ethereumex, :url, @default_url)
+    _ = Application.put_env(:ethereumex, :websocket_url, @default_url)
 
     on_exit(fn ->
       _ = Application.put_env(:ethereumex, :client_type, :http)
@@ -133,7 +133,7 @@ defmodule Ethereumex.WebsocketServerTest do
     end
 
     test "handles invalid JSON request" do
-      assert {:error, %Jason.DecodeError{}} = WebsocketServer.post("invalid json")
+      assert {:error, :decode_error} = WebsocketServer.post("invalid json")
     end
 
     test "handles request without id" do