From 896d10b510450c54a19c2db775dc9e2f0dabe2b6 Mon Sep 17 00:00:00 2001 From: Alex Kremer Date: Wed, 20 Sep 2023 01:09:15 +0100 Subject: [PATCH] Add missing fields to server_info doc --- content/concepts/networks-and-servers/amendments.md | 6 ++++++ .../public-api-methods/clio-methods/server_info-clio.md | 9 +++++++-- 2 files changed, 13 insertions(+), 2 deletions(-) diff --git a/content/concepts/networks-and-servers/amendments.md b/content/concepts/networks-and-servers/amendments.md index bd09e2880a..89a4835add 100644 --- a/content/concepts/networks-and-servers/amendments.md +++ b/content/concepts/networks-and-servers/amendments.md @@ -62,6 +62,12 @@ The voting configuration of a `rippled` server has no impact on it becoming amen You can unblock amendment blocked servers by upgrading to the newest version of `rippled`. +### Amendment Blocked in Clio Servers + + +In Clio, being amendment blocked means that Clio encountered an unknown field type during its ETL process. +This can happen because Clio was built with a version of `libxrpl` that does not know the field in question. +In order to unblock Clio one have to upgrade to a version that was built with a compatible `libxrpl`. ## Retiring Amendments diff --git a/content/references/http-websocket-apis/public-api-methods/clio-methods/server_info-clio.md b/content/references/http-websocket-apis/public-api-methods/clio-methods/server_info-clio.md index 1f24b776b4..2d0d0e038b 100644 --- a/content/references/http-websocket-apis/public-api-methods/clio-methods/server_info-clio.md +++ b/content/references/http-websocket-apis/public-api-methods/clio-methods/server_info-clio.md @@ -583,10 +583,15 @@ The `info` object may have some arrangement of the following fields: | `subscriptions.account` | | | | `subscriptions.accounts_proposed` | | | | `subscriptions.books` | | | -| `load_factor` | Number | The load-scaled open ledger transaction cost the server is currently enforcing, as a multiplier on the base transaction cost. For example, at `1000` load factor and a reference transaction cost of 10 drops of XRP, the load-scaled transaction cost is 10,000 drops (0.01 XRP). The load factor is determined by the highest of the [individual server's load factor](transaction-cost.html#local-load-cost), the cluster's load factor, the [open ledger cost](transaction-cost.html#open-ledger-cost) and the overall network's load factor. [Updated in: rippled 0.33.0][] | +| `time` | String | The current time in UTC, according to the server's clock. [New in: Clio v2.0](https://github.com/XRPLF/clio/releases/tag/2.0 "BADGE_BLUE") | +| `uptime` | Number | Number of consecutive seconds that the server has been operational. [New in: Clio v2.0](https://github.com/XRPLF/clio/releases/tag/2.0 "BADGE_BLUE") | +| `amendment_blocked` | Boolean | Whether the Clio server is [Amendment Blocked](amendments.html#amendment-blocked-in-clio-servers) [New in: Clio v2.0](https://github.com/XRPLF/clio/releases/tag/2.0 "BADGE_BLUE") | +| `load_factor` | Number | The load-scaled open ledger transaction cost the server is currently enforcing, as a multiplier on the base transaction cost. For example, at `1000` load factor and a reference transaction cost of 10 drops of XRP, the load-scaled transaction cost is 10,000 drops (0.01 XRP). The load factor is determined by the highest of the [individual server's load factor](transaction-cost.html#local-load-cost), the cluster's load factor, the [open ledger cost](transaction-cost.html#open-ledger-cost) and the overall network's load factor. | | `clio_version` | String | The version number of the running `Clio` server. | +| `libxrpl_version` | String | The version number of the libxrpl library this `Clio` server was built against. [New in: Clio v2.0](https://github.com/XRPLF/clio/releases/tag/2.0 "BADGE_BLUE") | | `validation_quorum` | Number | _(May be omitted)_ Minimum number of trusted validations required to validate a ledger version. Some circumstances may cause the server to require more validations. This value is obtained from `rippled`. This field may be omitted from the response if the `Clio` server is unable to connect to `rippled` for some reason. | | `rippled_version` | String | _(May be omitted)_ The version number of the running `rippled` server that the `Clio` server is connected to. This field may be omitted from the response if the `Clio` server is unable to connect to `rippled` for some reason. | +| `network_id` | String | _(May be omitted)_ The network ID of the network that the `rippled` this `Clio` server is connected to is operating on. This field may be omitted from the response if the `Clio` server is unable to connect to `rippled` for some reason. [New in: Clio v2.0](https://github.com/XRPLF/clio/releases/tag/2.0 "BADGE_BLUE") | | `validated_ledger` | Object | _(May be omitted)_ Information about the most recent fully-validated ledger. If the most recent validated ledger is not available, the response omits this field and includes `closed_ledger` instead. | | `validated_ledger.age` | Number | The time since the ledger was closed, in seconds. | | `validated_ledger.base_fee_xrp` | Number | Base fee, in XRP. This may be represented in scientific notation such as `1e-05` for 0.00001. | @@ -594,7 +599,7 @@ The `info` object may have some arrangement of the following fields: | `validated_ledger.reserve_base_xrp` | Number | Minimum amount of XRP (not drops) necessary for every account to keep in reserve. This may be represented in scientific notation such as `1e-05` for 0.00001. | | `validated_ledger.reserve_inc_xrp` | Number | Amount of XRP (not drops) added to the account reserve for each object an account owns in the ledger. This may be represented in scientific notation such as `1e-05` for 0.00001. | | `validated_ledger.seq` | Number | The [ledger index][] of the latest validated ledger. | -| `validator_list_expires` | String | _(Admin only)_ Either the human readable time, in UTC, when the current validator list expires, the string `unknown` if the server has yet to load a published validator list or the string `never` if the server uses a static validator list. [Updated in: rippled 1.5.0][] | +| `validator_list_expires` | String | _(Admin only)_ Either the human readable time, in UTC, when the current validator list expires, the string `unknown` if the server has yet to load a published validator list or the string `never` if the server uses a static validator list. | | `cache` | Object | Information on Clio's state data cache. | | `cache.size` | Number | Number of state data objects currently in the cache. | | `cache.is_full` | Boolean | True if cache contains all state data for a specific ledger, false otherwise. Some API calls, such as the [book_offers method][], process much faster when the cache is full. |