feat: add node status

massalabs · Jun 23, 2023 · 82ade6e · 82ade6e
1 parent 3175620
commit 82ade6e
Show file tree

Hide file tree

Showing 7 changed files with 1,042 additions and 0 deletions.
diff --git a/doc/api.html b/doc/api.html
@@ -234,6 +234,14 @@ <h2>Table of Contents</h2>
                   <a href="#massa.api.v1.GetBootstrapWhitelistResponse"><span class="badge">M</span>GetBootstrapWhitelistResponse</a>
                 </li>
 
+                <li>
+                  <a href="#massa.api.v1.GetNodeStatusRequest"><span class="badge">M</span>GetNodeStatusRequest</a>
+                </li>
+
+                <li>
+                  <a href="#massa.api.v1.GetNodeStatusResponse"><span class="badge">M</span>GetNodeStatusResponse</a>
+                </li>
+
                 <li>
                   <a href="#massa.api.v1.GetPeersWhitelistRequest"><span class="badge">M</span>GetPeersWhitelistRequest</a>
                 </li>
@@ -851,6 +859,62 @@ <h3 id="massa.api.v1.GetBootstrapWhitelistResponse">GetBootstrapWhitelistRespons
 
 
 
+        <h3 id="massa.api.v1.GetNodeStatusRequest">GetNodeStatusRequest</h3>
+        <p>GetNodeStatusRequest holds the request for GetNodeStatus</p>
+
+
+          <table class="field-table">
+            <thead>
+              <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+            </thead>
+            <tbody>
+
+                <tr>
+                  <td>id</td>
+                  <td><a href="#string">string</a></td>
+                  <td></td>
+                  <td><p>Request id </p></td>
+                </tr>
+
+            </tbody>
+          </table>
+
+
+
+
+
+        <h3 id="massa.api.v1.GetNodeStatusResponse">GetNodeStatusResponse</h3>
+        <p>GetNodeStatusResponse holds the response from GetNodeStatus</p>
+
+
+          <table class="field-table">
+            <thead>
+              <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+            </thead>
+            <tbody>
+
+                <tr>
+                  <td>id</td>
+                  <td><a href="#string">string</a></td>
+                  <td></td>
+                  <td><p>Request id </p></td>
+                </tr>
+
+                <tr>
+                  <td>status</td>
+                  <td><a href="#string">string</a></td>
+                  <td></td>
+                  <td><p>TODO to be implemented
+Node status </p></td>
+                </tr>
+
+            </tbody>
+          </table>
+
+
+
+
+
         <h3 id="massa.api.v1.GetPeersWhitelistRequest">GetPeersWhitelistRequest</h3>
         <p>GetPeersWhitelistRequest holds the request for GetPeersWhitelist</p>
 
@@ -1177,6 +1241,13 @@ <h3 id="massa.api.v1.MassaPrivateService">MassaPrivateService</h3>
                 <td><p>Allow everyone to bootstrap from the node by removing bootstrap whitelist configuration file</p></td>
               </tr>
 
+              <tr>
+                <td>GetNodeStatus</td>
+                <td><a href="#massa.api.v1.GetNodeStatusRequest">GetNodeStatusRequest</a></td>
+                <td><a href="#massa.api.v1.GetNodeStatusResponse">GetNodeStatusResponse</a></td>
+                <td><p>Allow everyone to bootstrap from the node by removing bootstrap whitelist configuration file</p></td>
+              </tr>
+
               <tr>
                 <td>GetPeersWhitelist</td>
                 <td><a href="#massa.api.v1.GetPeersWhitelistRequest">GetPeersWhitelistRequest</a></td>
@@ -1316,6 +1387,16 @@ <h4>Methods with HTTP bindings</h4>
 
 
 
+              <tr>
+                <td>GetNodeStatus</td>
+                <td>POST</td>
+                <td>/v1/get_node_status</td>
+                <td>*</td>
+              </tr>
+
+
+
+
               <tr>
                 <td>GetPeersWhitelist</td>
                 <td>POST</td>

diff --git a/doc/api.md b/doc/api.md
@@ -18,6 +18,8 @@
     - [GetBootstrapWhitelistAllowAllResponse](#massa-api-v1-GetBootstrapWhitelistAllowAllResponse)
     - [GetBootstrapWhitelistRequest](#massa-api-v1-GetBootstrapWhitelistRequest)
     - [GetBootstrapWhitelistResponse](#massa-api-v1-GetBootstrapWhitelistResponse)
+    - [GetNodeStatusRequest](#massa-api-v1-GetNodeStatusRequest)
+    - [GetNodeStatusResponse](#massa-api-v1-GetNodeStatusResponse)
     - [GetPeersWhitelistRequest](#massa-api-v1-GetPeersWhitelistRequest)
     - [GetPeersWhitelistResponse](#massa-api-v1-GetPeersWhitelistResponse)
     - [RemoveFromBootstrapBlacklistRequest](#massa-api-v1-RemoveFromBootstrapBlacklistRequest)
@@ -302,6 +304,37 @@ GetBootstrapWhitelistResponse holds the response from GetBootstrapWhitelist
 
 
 
+<a name="massa-api-v1-GetNodeStatusRequest"></a>
+
+### GetNodeStatusRequest
+GetNodeStatusRequest holds the request for GetNodeStatus
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| id | [string](#string) |  | Request id |
+
+
+
+
+
+
+<a name="massa-api-v1-GetNodeStatusResponse"></a>
+
+### GetNodeStatusResponse
+GetNodeStatusResponse holds the response from GetNodeStatus
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| id | [string](#string) |  | Request id |
+| status | [string](#string) |  | TODO to be implemented Node status |
+
+
+
+
+
+
 <a name="massa-api-v1-GetPeersWhitelistRequest"></a>
 
 ### GetPeersWhitelistRequest
@@ -506,6 +539,7 @@ Massa private gRPC service
 | GetBootstrapBlacklist | [GetBootstrapBlacklistRequest](#massa-api-v1-GetBootstrapBlacklistRequest) | [GetBootstrapBlacklistResponse](#massa-api-v1-GetBootstrapBlacklistResponse) | Get node bootstrap blacklist IP addresses |
 | GetBootstrapWhitelist | [GetBootstrapWhitelistRequest](#massa-api-v1-GetBootstrapWhitelistRequest) | [GetBootstrapWhitelistResponse](#massa-api-v1-GetBootstrapWhitelistResponse) | Get node bootstrap whitelist IP addresses |
 | GetBootstrapWhitelistAllowAll | [GetBootstrapWhitelistAllowAllRequest](#massa-api-v1-GetBootstrapWhitelistAllowAllRequest) | [GetBootstrapWhitelistAllowAllResponse](#massa-api-v1-GetBootstrapWhitelistAllowAllResponse) | Allow everyone to bootstrap from the node by removing bootstrap whitelist configuration file |
+| GetNodeStatus | [GetNodeStatusRequest](#massa-api-v1-GetNodeStatusRequest) | [GetNodeStatusResponse](#massa-api-v1-GetNodeStatusResponse) | Allow everyone to bootstrap from the node by removing bootstrap whitelist configuration file |
 | GetPeersWhitelist | [GetPeersWhitelistRequest](#massa-api-v1-GetPeersWhitelistRequest) | [GetPeersWhitelistResponse](#massa-api-v1-GetPeersWhitelistResponse) | Get node peers whitelist IP addresses |
 | RemoveFromBootstrapBlacklist | [RemoveFromBootstrapBlacklistRequest](#massa-api-v1-RemoveFromBootstrapBlacklistRequest) | [RemoveFromBootstrapBlacklistResponse](#massa-api-v1-RemoveFromBootstrapBlacklistResponse) | Remove from bootstrap blacklist given IP addresses |
 | RemoveFromBootstrapWhitelist | [RemoveFromBootstrapWhitelistRequest](#massa-api-v1-RemoveFromBootstrapWhitelistRequest) | [RemoveFromBootstrapWhitelistResponse](#massa-api-v1-RemoveFromBootstrapWhitelistResponse) | Remove from bootstrap whitelist given IP addresses |