From fda492162d48bd907ae1e84be0714ec41ef4fa41 Mon Sep 17 00:00:00 2001 From: GuticaStefan Date: Tue, 29 Sep 2026 14:55:09 +0300 Subject: [PATCH 1/3] document pool status on websocket subscriptions --- .../rest-api/ws-subscriptions.md | 23 ++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/docs/sdk-and-tools/rest-api/ws-subscriptions.md b/docs/sdk-and-tools/rest-api/ws-subscriptions.md index d89e5070b..59997477d 100644 --- a/docs/sdk-and-tools/rest-api/ws-subscriptions.md +++ b/docs/sdk-and-tools/rest-api/ws-subscriptions.md @@ -248,6 +248,7 @@ main().catch(console.error); ```json { + "status": "success", "pool": [ { "txHash": "0b0cd3932689c6853e50ccc0f49feeb9c5f2a68858cbd213fd0825dd4bc0632b", @@ -258,7 +259,27 @@ main().catch(console.error); "type": "Transaction" } ], - "poolCount": 1902 + "poolCount": 1902 +} +``` + +#### Update fields + +| Field | Type | Description | +|-----------|----------------------------|------------------------------------------------------------------------------------------------------------------------------| +| status | `"success" \| "tooLarge"` | `success` when `pool` holds the transactions, `tooLarge` when the pool is too large to be sent. | +| pool | array \| null | The transactions in the pool for the requested page and type. `null` when `status` is `tooLarge`. | +| poolCount | number | The number of transactions in the pool for the requested type. When `status` is `tooLarge`, the total count of the pool, regardless of `type`. | + +#### Pool too large + +When the pool is too large to be read, the update carries no transactions, only the total count of the pool. Clients should show that the pool is too large to be displayed instead of the list. + +```json +{ + "status": "tooLarge", + "pool": null, + "poolCount": 58213 } ``` From 1e53da2096a118878ac811b069af299e39b0c296 Mon Sep 17 00:00:00 2001 From: GuticaStefan Date: Wed, 30 Sep 2026 12:09:03 +0300 Subject: [PATCH 2/3] document internal server error status on pool websocket --- .../rest-api/ws-subscriptions.md | 22 ++++++++++++++----- 1 file changed, 17 insertions(+), 5 deletions(-) diff --git a/docs/sdk-and-tools/rest-api/ws-subscriptions.md b/docs/sdk-and-tools/rest-api/ws-subscriptions.md index 59997477d..539ad9aba 100644 --- a/docs/sdk-and-tools/rest-api/ws-subscriptions.md +++ b/docs/sdk-and-tools/rest-api/ws-subscriptions.md @@ -265,11 +265,11 @@ main().catch(console.error); #### Update fields -| Field | Type | Description | -|-----------|----------------------------|------------------------------------------------------------------------------------------------------------------------------| -| status | `"success" \| "tooLarge"` | `success` when `pool` holds the transactions, `tooLarge` when the pool is too large to be sent. | -| pool | array \| null | The transactions in the pool for the requested page and type. `null` when `status` is `tooLarge`. | -| poolCount | number | The number of transactions in the pool for the requested type. When `status` is `tooLarge`, the total count of the pool, regardless of `type`. | +| Field | Type | Description | +|-----------|-----------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------| +| status | `"success" \| "tooLarge" \| "internalServerError"` | `success` when `pool` holds the transactions, `tooLarge` when the pool is too large to be sent, `internalServerError` when the pool could not be read. | +| pool | array \| null | The transactions in the pool for the requested page and type. `null` when `status` is not `success`. | +| poolCount | number \| null | The number of transactions in the pool for the requested type. When `status` is `tooLarge`, the total count of the pool, regardless of `type`. `null` when `status` is `internalServerError`. | #### Pool too large @@ -283,6 +283,18 @@ When the pool is too large to be read, the update carries no transactions, only } ``` +#### Pool unavailable + +When the pool could not be read for any other reason, the update carries neither the transactions nor their count. + +```json +{ + "status": "internalServerError", + "pool": null, + "poolCount": null +} +``` + --- ### Events (Pulse) From 7d885fd38eb3ea59e2f254998eaea5d35f14a031 Mon Sep 17 00:00:00 2001 From: GuticaStefan Date: Wed, 30 Sep 2026 12:11:02 +0300 Subject: [PATCH 3/3] document pool count on internal server error status --- docs/sdk-and-tools/rest-api/ws-subscriptions.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/sdk-and-tools/rest-api/ws-subscriptions.md b/docs/sdk-and-tools/rest-api/ws-subscriptions.md index 539ad9aba..bd0f1d44b 100644 --- a/docs/sdk-and-tools/rest-api/ws-subscriptions.md +++ b/docs/sdk-and-tools/rest-api/ws-subscriptions.md @@ -269,7 +269,7 @@ main().catch(console.error); |-----------|-----------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------| | status | `"success" \| "tooLarge" \| "internalServerError"` | `success` when `pool` holds the transactions, `tooLarge` when the pool is too large to be sent, `internalServerError` when the pool could not be read. | | pool | array \| null | The transactions in the pool for the requested page and type. `null` when `status` is not `success`. | -| poolCount | number \| null | The number of transactions in the pool for the requested type. When `status` is `tooLarge`, the total count of the pool, regardless of `type`. `null` when `status` is `internalServerError`. | +| poolCount | number \| null | The number of transactions in the pool for the requested type. When `status` is not `success`, the total count of the pool, regardless of `type`, or `null` when it could not be counted either. | #### Pool too large @@ -285,13 +285,13 @@ When the pool is too large to be read, the update carries no transactions, only #### Pool unavailable -When the pool could not be read for any other reason, the update carries neither the transactions nor their count. +When the pool could not be read for any other reason, the update carries no transactions, only the total count of the pool, or `null` when it could not be counted either. ```json { "status": "internalServerError", "pool": null, - "poolCount": null + "poolCount": 58213 } ```