ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-11-05 04:15:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2319 from XRPLF/server_state-Clio

Browse Source 
Update server_state docs for Clio
This commit is contained in:
Rome Reginelli
2024-01-22 17:54:03 -08:00
committed by GitHub
parent e400baf60e a17ff9aa07
commit cc064db648
2 changed files with 7 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
assets/js/apitool-methods-ws.js
View File

@@ -604,7 +604,8 @@ Request('server_state', {
link: "server_state.html",
body: {
"id": 1,
"command": "server_state"
"command": "server_state",
"ledger_index": "current"
}
})

7
content/references/http-websocket-apis/public-api-methods/server-info-methods/server_state.md
View File

@@ -11,6 +11,8 @@ labels:
The `server_state` command asks the server for various machine-readable information about the `rippled` server's current state. The response is almost the same as the [server_info method][], but uses units that are easier to process instead of easier to read. (For example, XRP values are given in integer drops instead of scientific notation or decimal values, and time is given in milliseconds instead of seconds.)
The [Clio server](the-clio-server.html) does not support `server_state` directly, but you can ask for the `server_state` of the `rippled` server that Clio is connected to. Specify `"ledger_index": "current"` (WebSocket) or `"params": [{"ledger_index": "current"}]` (JSON-RPC).
## Request Format
An example of the request format:
@@ -21,7 +23,8 @@ An example of the request format:
```json
{
"id": 2,
"command": "server_state"
"command": "server_state",
"ledger_index": "current"
}
```
@@ -31,7 +34,7 @@ An example of the request format:
{
"method": "server_state",
"params": [
{}
{"ledger_index": "current"}
]
}
```