Add Nado documentation and examples, including new API endpoints, FAQs, and guides for using the TypeScript SDK. Update .env.example with additional configuration options.

2026-09-11 01:08:07 +00:00 · 2025-12-19 01:38:09 +08:00
parent 624fecfa70
commit c69ea72860
148 changed files with 17031 additions and 27 deletions
@@ -0,0 +1,60 @@
+# Status
+
+## Rate limits
+
+* 2400 requests/min or 40 requests/sec per IP address. (**weight = 1**)
+
+{% hint style="info" %}
+See more details in [API Rate limits](https://docs.nado.xyz/developer-resources/api/rate-limits)
+{% endhint %}
+
+## Request
+
+{% tabs %}
+{% tab title="Websocket" %}
+**Connect**
+
+<mark style="color:orange;">`WEBSOCKET [GATEWAY_WEBSOCKET_ENDPOINT]`</mark>
+
+**Message**
+
+```json
+{
+  "type": "status"
+}
+```
+
+{% endtab %}
+
+{% tab title="REST (GET)" %} <mark style="color:green;">**GET**</mark> `[GATEWAY_REST_ENDPOINT]/query?type=status`
+{% endtab %}
+
+{% tab title="REST (POST)" %} <mark style="color:orange;">`POST [GATEWAY_REST_ENDPOINT]/query`</mark>
+
+**Body**
+
+```json
+{
+  "type": "status"
+}
+```
+
+{% endtab %}
+{% endtabs %}
+
+## Response
+
+```json
+{
+  "status": "success",
+  "data": "active",
+  "request_type": "query_status",
+}
+```
+
+{% hint style="info" %}
+The offchain sequencer could be in any of the following statuses:
+
+* <mark style="color:red;">`active`</mark>: accepting incoming executes.
+* <mark style="color:red;">`failed`</mark>: sequencer is in a failed state.
+  {% endhint %}