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,139 @@
+# Cancel Orders
+
+## Rate limits
+
+* When no **digests** are provided: 600 cancellations/min or 10 cancellations/sec per wallet. (**weight=1**)
+* When **digests** are provided: 600/(total digests) cancellations per minute per wallet. (**weight=total digests**)
+
+{% 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
+
+{
+  "cancel_orders": {
+    "tx": {
+      "sender": "0x7a5ec2748e9065794491a8d29dcf3f9edb8d7c43746573743000000000000000",
+      "productIds": [2],
+      "digests": ["0x"],
+      "nonce": "1"
+    },
+    "signature": "0x"
+  }
+}
+```
+
+{% endtab %}
+
+{% tab title="REST" %} <mark style="color:orange;">`POST [GATEWAY_REST_ENDPOINT]/execute`</mark>
+
+**Body**
+
+```json
+
+{
+  "cancel_orders": {
+    "tx": {
+      "sender": "0x7a5ec2748e9065794491a8d29dcf3f9edb8d7c43746573743000000000000000",
+      "productIds": [0],
+      "digests": ["0x"],
+      "nonce": "1"
+    },
+    "signature": "0x"
+  }
+}
+```
+
+{% endtab %}
+{% endtabs %}
+
+## Request Parameters
+
+<table><thead><tr><th width="156" align="center">Parameter</th><th width="128" align="center">Type</th><th width="104" align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td align="center">tx</td><td align="center">object</td><td align="center">Yes</td><td>Cancel order transaction object. See <a href="#signing">Signing</a> section for details on the transaction fields.</td></tr><tr><td align="center">tx.sender</td><td align="center">string</td><td align="center">Yes</td><td>Hex string representing the subaccount's 32 bytes (address + subaccount name) of the tx sender.</td></tr><tr><td align="center">tx.productIds</td><td align="center">number[]</td><td align="center">Yes</td><td>A list of product IDs, corresponding to the product ids of the orders in <mark style="color:red;"><code>digests</code></mark></td></tr><tr><td align="center">tx.digests</td><td align="center">string[]</td><td align="center">Yes</td><td>A list of order digests, represented as hex strings.</td></tr><tr><td align="center">tx.nonce</td><td align="center">string</td><td align="center">Yes</td><td>Used to differentiate between the same cancellation multiple times. See <a href="#signing">Signing</a> section for more details.</td></tr><tr><td align="center">signature</td><td align="center">string</td><td align="center">Yes</td><td>Signed transaction. See <a href="#signing">Signing</a> section for more details.</td></tr></tbody></table>
+
+## Signing
+
+{% hint style="info" %}
+See more details and examples in our [signing](https://docs.nado.xyz/developer-resources/api/gateway/signing) page.
+{% endhint %}
+
+The solidity typed data struct that needs to be signed is:
+
+```solidity
+struct Cancellation {
+    bytes32 sender;
+    uint32[] productIds;
+    bytes32[] digests;
+    uint64 nonce;
+}
+```
+
+<mark style="color:red;">`sender`</mark>: a <mark style="color:red;">`bytes32`</mark> sent as a hex string; includes the address and the subaccount identifier
+
+<mark style="color:red;">`productIds`</mark>: a list of product IDs, corresponding to the product ids of the orders in <mark style="color:red;">`digests`</mark>
+
+<mark style="color:red;">`digests`</mark>: a list of order digests, represented as hex strings, for the orders you want to cancel.
+
+<mark style="color:red;">`nonce`</mark>: used to differentiate between the same cancellation multiple times, and a user trying to place a cancellation with the same parameters twice. Sent as a string. Encodes two bit of information:
+
+* Most significant <mark style="color:red;">`44`</mark> bits encoding the <mark style="color:red;">`recv_time`</mark> in milliseconds after which the cancellation should be ignored by the matching engine; the engine will accept cancellations where <mark style="color:red;">`current_time < recv_time <= current_time + 100000`</mark>
+* Least significant <mark style="color:red;">`20`</mark> bits are a random integer used to avoid hash collisions
+
+  For example, to place a cancellation with a random integer of <mark style="color:red;">`1000`</mark>, and a discard time 50 ms from now, we would send a nonce of <mark style="color:red;">`(timestamp_ms() + 50) << 20 + 1000`</mark>
+
+{% hint style="warning" %}
+**Note**: for signing you should always use the data type specified in the solidity struct which might be different from the type sent in the request e.g: <mark style="color:red;">`nonce`</mark> should be an <mark style="color:red;">`uint64`</mark> for **Signing** but should be sent as a <mark style="color:red;">`string`</mark> in the final payload.
+{% endhint %}
+
+## Response
+
+#### Success
+
+```json
+{
+  "status": "success",
+  "signature": {signature},
+  "data": {
+    "cancelled_orders": [
+      {
+        "product_id": 2,
+        "sender": "0x7a5ec2748e9065794491a8d29dcf3f9edb8d7c43746573743000000000000000",
+        "price_x18": "20000000000000000000000",
+        "amount": "-100000000000000000",
+        "expiration": "1686332748",
+        "order_type": "post_only",
+        "nonce": "1768248100142339392",
+        "unfilled_amount": "-100000000000000000",
+        "digest": "0x3195a7929feb8307edecf9c045j5ced68925108f0aa305f0ee5773854159377c",
+        "appendix": "1537",
+        "placed_at": 1686332708
+      },
+      ...
+    ]
+  },
+  "request_type": "execute_cancel_orders"
+}
+```
+
+#### Failure
+
+```json
+{
+  "status": "failure",
+  "signature": {signature},
+  "error": "{error_msg}",
+  "error_code": {error_code},
+  "request_type": "execute_cancel_orders"
+}
+```