Added Health API

michielpost · Apr 9, 2024 · 4ab3617 · 4ab3617
1 parent 02e0ce1
commit 4ab3617
Show file tree

Hide file tree

Showing 6 changed files with 64 additions and 8 deletions.
diff --git a/Hathor.Tests/Hathor.Tests.csproj b/Hathor.Tests/Hathor.Tests.csproj
@@ -7,11 +7,11 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0" />
     <PackageReference Include="dotnetstandard-bip39" Version="1.0.2" />
-    <PackageReference Include="MSTest.TestAdapter" Version="3.1.1" />
-    <PackageReference Include="MSTest.TestFramework" Version="3.1.1" />
-    <PackageReference Include="coverlet.collector" Version="6.0.0">
+    <PackageReference Include="MSTest.TestAdapter" Version="3.3.1" />
+    <PackageReference Include="MSTest.TestFramework" Version="3.3.1" />
+    <PackageReference Include="coverlet.collector" Version="6.0.2">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>

diff --git a/Hathor.Wallet.Tests/Hathor.Wallet.Tests.csproj b/Hathor.Wallet.Tests/Hathor.Wallet.Tests.csproj
@@ -7,11 +7,11 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0" />
     <PackageReference Include="dotnetstandard-bip39" Version="1.0.2" />
-    <PackageReference Include="MSTest.TestAdapter" Version="3.1.1" />
-    <PackageReference Include="MSTest.TestFramework" Version="3.1.1" />
-    <PackageReference Include="coverlet.collector" Version="6.0.0">
+    <PackageReference Include="MSTest.TestAdapter" Version="3.3.1" />
+    <PackageReference Include="MSTest.TestFramework" Version="3.3.1" />
+    <PackageReference Include="coverlet.collector" Version="6.0.2">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>

diff --git a/Hathor/IHathorWalletApi.cs b/Hathor/IHathorWalletApi.cs
@@ -20,6 +20,9 @@ public interface IHathorWalletApi
         [Post("start")]
         Task<DefaultResponse> Start([Body]StartRequest startRequest);
 
+        [Get("health")]
+        Task<HealthResponse> GetHealth([Query]string? wallet_ids = null, [Query] bool? include_fullnode = null, [Query] bool? include_tx_mining = null);
+
         [Post("wallet/stop")]
         Task<DefaultResponse> Stop();
 

diff --git a/Hathor/Models/Responses/HealthResponse.cs b/Hathor/Models/Responses/HealthResponse.cs
@@ -0,0 +1,47 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Text.Json.Serialization;
+using System.Threading.Tasks;
+
+namespace Hathor.Models.Responses
+{
+    public class HealthResponse
+    {
+        [JsonPropertyName("status")]
+        public string? Status { get; set; }
+
+        [JsonPropertyName("description")]
+        public string? Description { get; set; }
+
+        [JsonPropertyName("checks")]
+        public Checks? Checks { get; set; }
+    }
+
+    public class Checks
+    {
+        [JsonPropertyName("fullnode")]
+        public List<FullnodeStatus> Fullnode { get; set; } = new();
+
+        [JsonPropertyName("txMining")]
+        public List<FullnodeStatus> TxMining { get; set; } = new();
+    }
+
+    public class FullnodeStatus
+    {
+        [JsonPropertyName("status")]
+        public string? Status { get; set; }
+
+        [JsonPropertyName("componentType")]
+        public string? ComponentType { get; set; }
+
+        [JsonPropertyName("componentName")]
+        public string? ComponentName { get; set; }
+
+        [JsonPropertyName("output")]
+        public string? Output { get; set; }
+    }
+
+
+}
diff --git a/Hathor/Models/Responses/StatusResponse.cs b/Hathor/Models/Responses/StatusResponse.cs
@@ -22,6 +22,9 @@ public class StatusResponse : DefaultResponse
         [JsonProperty(PropertyName = "serverUrl")]
         public string? ServerUrl { get; set; }
 
+        [JsonProperty(PropertyName = "statusMessage")]
+        public string? StatusMessage { get; set; }
+
         [JsonProperty(PropertyName = "state")]
         public int? State { get; set; }
     }

diff --git a/README.md b/README.md
@@ -105,3 +105,6 @@ var balanceInfo = await nodeClient.GetBalanceForAddress("ANY HATHOR ADDRESS")
 
 ## Acknowledgements
 Development has been made possible with a grant from [Hathor](https://hathor.network).
+
+## Hathor API Reference
+https://docs.hathor.network/references/headless-wallet/http-api/