Add update getHealth response (#171)

kommitters · Jul 24, 2024 · 62074f8 · 62074f8
1 parent a352507
commit 62074f8
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -405,7 +405,13 @@ General node health check.
 server = Soroban.RPC.Server.testnet()
 Soroban.RPC.get_health(server)
 
-{:ok, %Soroban.RPC.GetHealthResponse{status: "healthy"}}
+{:ok,
+ %Soroban.RPC.GetHealthResponse{
+   status: "healthy",
+   latest_ledger: 706073,
+   oldest_ledger: 688794,
+   ledger_retention_window: 17280
+ }}
 
 ```
 

diff --git a/lib/rpc/responses/get_health_response.ex b/lib/rpc/responses/get_health_response.ex
@@ -5,11 +5,18 @@ defmodule Soroban.RPC.GetHealthResponse do
   @behaviour Soroban.RPC.Response.Spec
 
   @type status :: String.t()
+  @type latest_ledger :: non_neg_integer()
+  @type oldest_ledger :: non_neg_integer()
+  @type ledger_retention_window :: non_neg_integer()
+
   @type t :: %__MODULE__{
-          status: status()
+          status: status(),
+          latest_ledger: latest_ledger(),
+          oldest_ledger: oldest_ledger(),
+          ledger_retention_window: ledger_retention_window()
         }
 
-  defstruct [:status]
+  defstruct [:status, :latest_ledger, :oldest_ledger, :ledger_retention_window]
 
   @impl true
   def new(attrs), do: struct(%__MODULE__{}, attrs)

diff --git a/test/rpc/responses/get_health_response_test.exs b/test/rpc/responses/get_health_response_test.exs
@@ -6,7 +6,10 @@ defmodule Soroban.RPC.GetHealthResponseTest do
   setup do
     %{
       result: %{
-        status: "healthy"
+        status: "healthy",
+        latest_ledger: 706_073,
+        oldest_ledger: 688_794,
+        ledger_retention_window: 17_280
       }
     }
   end

diff --git a/test/rpc_test.exs b/test/rpc_test.exs
@@ -100,7 +100,10 @@ defmodule Soroban.RPC.CannedRPCGetHealthClientImpl do
 
     {:ok,
      %{
-       status: "healthy"
+       status: "healthy",
+       latest_ledger: 706_073,
+       oldest_ledger: 688_794,
+       ledger_retention_window: 17_280
      }}
   end
 end