Merge pull request #26 from wowica/publish-v0.3.0

Publish v0.3.0

README.md

@@ -25,19 +25,22 @@ Add the dependency to `mix.exs`:
 ```elixir
 defp deps do
   [
-    {:xogmios, "~> 0.2.0"}
+    {:xogmios, "~> 0.3.0"}
   ]
 end
 ```
 
-Add your client module(s) to your application's supervision tree as such:
+Add your client modules to your application's supervision tree as such:
 
 ```elixir
 # file: application.ex
 def start(_type, _args) do
+  ogmios_url = System.fetch_env!("OGMIOS_URL")
+
   children = [
-    {ChainSyncClient, url: "ws://..."},
-    {StateQueryClient, url: "ws://..."},
+    {ChainSyncClient, url: ogmios_url},
+    {StateQueryClient, url: ogmios_url},
+    {TxSubmissionClient, url: ogmios_url}
   ]
   #...
 end
@@ -51,7 +54,7 @@ See section below for examples of client modules.
 
 ### Chain Sync
 
-The following is an example of a module that implement the **Chain Sync** behaviour. This module syncs with the tip of the chain, reads the next 3 blocks and then closes the connection with the server.
+The following is an example of a module that implement the **Chain Sync** behaviour. In this example, the client syncs with the tip of the chain, reads the next 3 blocks and then closes the connection with the server.
 
 ```elixir
 defmodule ChainSyncClient do
@@ -91,12 +94,26 @@ defmodule StateQueryClient do
   end
 
   def get_current_epoch(pid \\ __MODULE__) do
+    # Defaults to Ledger-state queries.
+    # The following call is the same as calling
+    # `StateQuery.send_query(pid, "queryLedgerState/epoch")`
     StateQuery.send_query(pid, "epoch")
   end
 
-  def send_query(pid \\ __MODULE__, query_name) do
+  def get_network_height(pid \\ __MODULE__) do
+    # For network queries, scope must be explicitly used.
+    StateQuery.send_query(pid, "queryNetwork/blockHeight")`
+  end
+
+  def send_query_no_params(pid \\ __MODULE__, query_name) do
     StateQuery.send_query(pid, query_name)
   end
+
+  def send_query(pid \\ __MODULE__, query_name, query_params) do
+    # Optional query params are sent as the third argument
+    # to StateQuery.send_query/3
+    StateQuery.send_query(pid, query_name, query_params)
+  end
 end
 ```
 

lib/xogmios/state_query.ex

@@ -29,13 +29,32 @@ defmodule Xogmios.StateQuery do
   Support for all [Ledger-state](https://ogmios.dev/mini-protocols/local-state-query/#ledger-state)
   and [Network](https://ogmios.dev/mini-protocols/local-state-query/#network) queries.
 
-  For Ledger-state queries, only the name of the query is needed. For example:
+  For Ledger-state queries, only the name of the query is needed. For example, the following
+  function call
 
-  `StateQuery.send_query(pid, "epoch")` will send the query for ""queryLedgerState/epoch".
+  ```
+  StateQuery.send_query(pid, "epoch")
+  ```
+
+  is the same as calling
+
+  ```
+  StateQuery.send_query(pid, "queryLedgerState/epoch")
+  ```
 
   For Network queries, the prefix "queryNetwork/" is needed. For example:
 
-  `StateQueryClient.send_query("queryNetwork/blockHeight")` will send the query for "queryNetwork/blockHeight"
+  ```
+  StateQuery.send_query(pid, "queryNetwork/blockHeight")
+  ```
+
+  Optional parameters are passed as the third argument:
+
+  ```
+  query_name = "utxo"
+  query_params = %{addresses: [address_1, address_2]}
+  StateQuery.send_query(pid, query_name, query_params)
+  ```
   """
   @spec send_query(pid() | atom(), String.t(), map()) :: {:ok, any()} | {:error, any()}
 

mix.exs

@@ -3,7 +3,7 @@ defmodule Xogmios.MixProject do
 
   @description "An Elixir client for Ogmios"
   @source_url "https://github.com/wowica/xogmios"
-  @version "0.2.0"
+  @version "0.3.0"
 
   def project do
     [